Narnia's Psychedelic Mushrooms

    @yogorobot/robot
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.0 • Public • Published

    robot.js

    基于wsutil.js,提供robot的相关信息及一些控制方法,进而给yogo robot app开发者提供帮助

    NPM version travis ci

    功能特性

    • 获取机器人信息

    • 操作机器人开关门

    • 订单:创建/放入/完成/取消

    • 灯光设置

    使用者指南

    快速开始

    npm install --save-dev @yogorobot/robot.js
    
    import {YogoRobot} from '@yogorobot/robot';
    const robot = new YogoRobot(addr); addr可以不传,默认为'ws://127.0.0.1:40001/ws'
    

    使用文档

    API

    运行环境

    linux系统,electron(chromium浏览器)

    mock服务

    开发环境可根据需要mock robot

    import {Mock} from '@yogorobot/robot/lib/service';
    const server = new Mock();  // 默认开启
    
    // 可根据需要自定义addr和cabinets
    const server = new Mock({
      // addr可以不传,默认为'ws://127.0.0.1:40001/ws'
      addr: 'ws://127.0.0.1:40001/ws',
      // cabinets可以不传,默认有1,2,3,4四个门,如需要,可参照以下格式自行定制
      cabinets: [
        {id: 1, is_open: false, is_load: false, is_lock: false},  // id必传,其他字段如果不传则默认false
        ...
      ]
    });
    

    建议

    由于Yogo App 特定的运行环境,可以使用es6开发;

    Keywords

    Install

    npm i @yogorobot/robot

    DownloadsWeekly Downloads

    22

    Version

    0.2.0

    License

    ISC

    Unpacked Size

    124 kB

    Total Files

    37

    Last publish

    Collaborators

    • gucheen
    • rachel-hya11