| 版本 | 编辑时间 | 编辑人 | 编辑内容 |
|---|---|---|---|
| v1.0.5 | 2023-3-24 | HuiMin | 初稿 |
| v1.0.9 | 2023-4-26 | 修改通信协议 | |
| v1.1.1 | 2023-6-26 | 添加websocket协议说明 | |
| v1.1.2 | 2023-7-3 | 添加Basic认证 | |
| v1.1.38 | 2024-4-23 | 补充运营统计相关接口 | |
| v1.1.62 | 2024-8-23 | 添加callAction相关接口 | |
| v1.1.70 | 2024-11-22 | 添加切换机器人模型请求 | |
| v1.2.6 | 2026-2-3 | 添加关机请求 添加驻车模式请求 添加相机数据订阅等接口 |
数据字典为woosh_robot_data_dictionary.html.http: http://{机器人或调度IP}:5480websocket: ws://{机器人或调度IP}:5480http和websocket, 请求和和应答都是application/json.{
"type": "", // 请求消息类型
"body": {}, // 请求消息内容
"sn": number // 消息序号, 可用于确定消息次序
}http请求时直接传body对象即可.sn字段仅对websocket请求有效.sn为可选字段{
"type": "", // 应答消息类型
"body": {}, // 应答消息内容
"ok": boolean, // 应答结果, TRUE: 成功, FALSE: 失败
"msg": "", // 应答状态消息, e.g. "REQUEST SUCCESS"
"sn": number // 消息序号, 由请求端赋值, 原样返回
}{
"type": "woosh.Subscription",
"body": {
"sub": boolean, // TRUE: subscribe, FALSE: unsubscribe
"topics": [
"" // 订阅话题, e.g. "woosh.robot.PoseSpeed"
]
}
}websocket有效.{
"type": "", // 发布消息类型
"body": {} // 发布消息内容
}| 名称 | 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.CameraData | ✔️ | |
| 超声波数据 | woosh.robot.SonarData | ✔️ | |
| 代价地图数据 | woosh.robot.CostmapData | ✔️ | |
| 运行统计运作 | woosh.robot.count.Operation | ✔️ | |