WOOSH-ROBOT-API
    WOOSH-ROBOT-API
    • 相关资料
    • 日志下载
    • WOOSH ROBOT API
    • 机器人信息
      • 获取机器人信息
        POST
      • 获取常规信息
        POST
      • 获取配置信息
        POST
      • 获取机器人状态
        POST
      • 获取模式信息
        POST
      • 获取位姿速度
        POST
      • 获取电池信息
        POST
      • 获取网络信息
        POST
      • 获取场景信息
        POST
      • 获取任务进度
        POST
      • 获取设备状态
        POST
      • 获取硬件状态
        POST
      • 获取运行状态
        POST
      • 获取机器人模型
        POST
      • 获取历史任务
        POST
      • 获取状态码信息
        POST
      • 获取异常码信息
        POST
      • 请求导航路径
        POST
      • 请求全局规划路径
        POST
    • 机器人配置
      • 设置机器人标识
        POST
      • 设置连接服务器配置
        POST
      • 开关自主回充
        POST
      • 开关自主泊车
        POST
      • 开关货物检测
        POST
      • 机器人电量配置
        POST
      • 机器人声音设置
        POST
    • 场景地图
      • 储位编辑
        • 添加储位
        • 添加停车位
        • 添加充电桩
        • 删除点位
        • 更新点位
        • 查找储位
      • 获取场景列表
      • 获取场景数据
      • 获取场景数据(Easy)
      • 下载地图
      • 上传地图
      • 修改地图或场景名
      • 删除场景或地图
      • 场景文件MD5请求
      • 场景同步
      • 获取任务信息(预定义的)
      • 获取循环任务(预定义的)
      • 获取呼叫任务(预定义的)
    • 机器人请求
      • ROS Action
        • 充电执行
        • 充电退出
        • 举升机构上升
        • 举升机构下降
        • 升降机构2
        • 升降机构3
        • 步进直行
        • 步进旋转
        • 步进平移
        • 步进斜移
        • 连续步进
        • 基础导航
        • 导航模式
        • Feedback
      • 初始化机器人
      • 设置机器人位姿
      • 设置机器人占用
      • 设置屏蔽呼叫
      • 设置程序静音
      • 切换控制模式
      • 切换工作模式
      • 切换模型类型
      • 切换地图
      • 构图请求
      • 雷达数据请求
      • 部署请求
      • 执行预定义任务
      • 执行任务
      • 循环任务
      • 动作指令
      • 规划导航路径
      • 改变导航路径
      • 改变导航模式
      • 语音播报
      • LED灯带控制
      • 速度控制
      • 跟随
      • WIFi请求
      • 运营统计数据
    • 调度请求
      • 看板
        • 任务路线平均耗时
        • 任务统计(所有的)
        • 机器人任务统计集
        • 异常信息集合
        • 机器人运行统计
        • 机器人运行统计集
        • 每日任务统计集(内部)
      • 地图
        • 储位状态
        • 储位状态集
        • 域状态
        • 域状态集
        • 虫洞状态
        • 虫洞状态集
      • 任务
        • 查找任务
        • 任务指令
        • 置顶任务
        • 添加任务集
        • 插入任务
        • 添加预定义任务
        • 当前执行预定义任务集
      • 获取调度机器人列表
      • 获取调度机器人信息
      • 切换场景
      • 获取当前场景
      • 充电配置
      • 获取当前充电配置
      • 指定机器人充电
      • 泊车充电记录表
      • 修改泊车充电记录
      • 设置日志等级
      • PacAccountList
      • PacAccount
    • 设备请求
      • callbox
        • 呼叫器配置
        • 上线
        • 下线
        • 呼叫
        • 获取指定呼叫盒
        • 获取呼叫盒列表
        • 获取呼叫器列表
    • ws
      • 位姿速度订阅
      • 机器人信息请求
      • 订阅任务集状态
      • 看板订阅
      • Feedbacks

    WOOSH ROBOT API

    版本编辑时间编辑人编辑内容
    v1.0.52023-3-24HuiMin初稿
    v1.0.92023-4-26修改通信协议
    v1.1.12023-6-26添加websocket协议说明
    v1.1.22023-7-3添加Basic认证
    v1.1.382024-4-23补充运营统计相关接口
    v1.1.622024-8-23添加callAction相关接口

    文档说明#

    本文中的数据字典为woosh_robot_data_dictionary.html.

    URL#

    http: http://{机器人或调度IP}:5480
    websocket: ws://{机器人或调度IP}:5480

    协议说明#

    目前支持http和websocket, 请求和和应答都是application/json.

    woosh.Request#

    {
        "type": "",   // 请求消息类型
        "body": {},   // 请求消息内容
        "sn": number  // 消息序号, 可用于确定消息次序
    }
    http请求时直接传body对象即可.
    sn字段仅对websocket请求有效.
    sn为可选字段

    woosh.Response#

    {
        "type": "",    // 应答消息类型
        "body": {},    // 应答消息内容
        "ok": boolean, // 应答结果, TRUE: 成功, FALSE: 失败
        "msg": "",     // 应答状态消息, e.g. "REQUEST SUCCESS"
        "sn": number   // 消息序号, 由请求端赋值, 原样返回
    }

    woosh.Subscription#

    {
        "type": "woosh.Subscription",
        "body": {
            "sub": boolean, // TRUE: subscribe, FALSE: unsubscribe
            "topics": [
                "" // 订阅话题, e.g. "woosh.robot.PoseSpeed"
            ]
        }
    }
    订阅/发布仅对websocket有效.

    woosh.Notify#

    {
        "type": "",  // 发布消息类型
        "body": {}   // 发布消息内容
    }

    woosh.Topic#

    名称topic机器人调度
    配置信息woosh.robot.Setting✔️✔️
    机器人状态woosh.robot.RobotState✔️✔️
    机器人模式woosh.robot.Mode✔️✔️
    位姿速度woosh.robot.PoseSpeed✔️✔️
    电量信息woosh.robot.Battery✔️✔️
    网络信息woosh.robot.Network✔️✔️
    场景信息woosh.robot.Scene✔️✔️
    任务进度woosh.robot.TaskProc✔️✔️
    设备状态woosh.robot.DeviceState✔️✔️
    硬件状态woosh.robot.HardwareState✔️✔️
    运行状态woosh.robot.OperationState✔️✔️
    机器人模型woosh.robot.Model✔️✔️
    导航路径woosh.robot.NavPath✔️✔️
    状态码robot.count.StatusCode✔️✔️
    未恢复的异常码woosh.robot.count.AbnormalCode✔️✔️
    构图数据woosh.robot.BuildMapData✔️
    雷达点云数据woosh.robot.ScannerData✔️
    运行统计运作woosh.robot.count.Operation✔️
    运行统计任务woosh.robot.count.Task✔️
    运行统计状态woosh.robot.count.Status✔️
    ros.Feedbackswoosh.ros.Feedbacks✔️
    机器人调度信息woosh.dispatch.robot.Robot✔️
    调度场景配置信息woosh.dispatch.system.SceneSettings✔️
    调度充电配置信息woosh.dispatch.system.ChargeSettings✔️
    任务集状态更新woosh.dispatch.task.TaskSetState✔️
    机器人运行统计woosh.dispatch.kanban.RobotOperation✔️
    路线平均耗时woosh.dispatch.kanban.RouteAvg✔️
    任务统计(总的)woosh.dispatch.kanban.TaskCount✔️
    机器人任务统计woosh.dispatch.kanban.RobotTaskCount✔️

    示例#

    websocket 请求示例#

    请求机器人信息
    {
        "type": "woosh.robot.RobotInfo",
        "body": {
            "robotId": 30001
        }
    }

    websocket 订阅示例#

    订阅机器人位姿速度和电量
    {
        "type": "woosh.Subscription",
        "body": {
            "sub": true,
            "topics": [
                "woosh.robot.PoseSpeed",
                "woosh.robot.Battery"
            ]
        }
    }

    认证说明#

    http 和 websocket 均采用 Basic Auth 加密认证, 用户名密码依项目而定(无特殊说明默认是不需要认证).
    websocket 仅需要连接时认证即可, 需要认证但未认证的连接, 服务端会主动断开连接.
    Basic Auth 认证说明:
    在 Header 添加参数 Authorization,
    其值为在 Basic 之后拼接空格, 以及经过 Base64 编码的 Username:Password.
    示例: Authorization: Basic YWRtaW46MTIzNDU2
    websocket认证示例:
    1.
    Authorization Header
    2.
    Sec-WebSocket-Protocol Header
    修改于 2025-09-01 08:50:16
    上一页
    日志下载
    下一页
    获取机器人信息
    Built with