获取机器人状态
获取指定机器人的运行、定位、电量和传感器状态。
接口基础信息
Section titled “接口基础信息”- 接口名称: 获取狗状态
- 接口说明: 用于获取狗的状态
- 请求方式:
POST - 请求路径:
remoteApi/getDogStateData - 是否需要登录: 否
- 是否需要权限: 是
| 参数名 | 类型 | 是否必填 | 示例 | 说明 |
|---|---|---|---|---|
| dogCode | String | 是 | 001 | 狗编码 |
样例:
{ "dogCode": "001"}| 字段 | 类型 | 说明 |
|---|---|---|
| dogCode | String | 狗编码 |
| dogModel | String | 狗型号 |
| groupName | String | 组名 |
| status | String | 属性名称 |
| value | String | 属性值 |
| remark | String | 属性备注 |
| alarmCondition | String | 告警阈值条件 |
| alarm | Boolean | 是否异常 |
| unit | String | 单位 |
样例:
{ "success": true, "code": 200, "msg": "操作成功", "data": { "dogCode": "2044338926658785280", "dogModel": "X30", "props": [ { "groupName": "batteryData.title", "list": [ { "status": "batteryData.electricity.title", "value": "100.0", "remark": "batteryData.electricity.remark", "alarmCondition": "v<33", "alarm": false, "unit": "%" }, { "status": "batteryData.chargeState.title", "value": "1", "remark": "batteryData.chargeState.remark", "alarmCondition": "", "alarm": null, "unit": null }, { "status": "batteryData.electricityIsLow.title", "value": "batteryData.electricityIsLow.0", "remark": "batteryData.electricityIsLow.remark", "alarmCondition": "v==1", "alarm": false, "unit": null } ] }, { "groupName": "locationData.title", "list": [ { "status": "locationData.location.title", "value": "locationData.location.0", "remark": "locationData.location.remark", "alarmCondition": "v==1", "alarm": false, "unit": null }, { "status": "locationData.obsState.title", "value": "locationData.obsState.0", "remark": "locationData.obsState.remark", "alarmCondition": "v==1", "alarm": false, "unit": null }, { "status": "locationData.floor.title", "value": "A29", "remark": "locationData.floor.remark", "alarmCondition": null, "alarm": null, "unit": null }, { "status": "locationData.posX.title", "value": "8.75", "remark": "locationData.posX.remark", "alarmCondition": null, "alarm": null, "unit": "m" }, { "status": "locationData.posY.title", "value": "-0.72", "remark": "locationData.posY.remark", "alarmCondition": null, "alarm": null, "unit": "m" }, { "status": "locationData.posZ.title", "value": "-0.50", "remark": "locationData.posZ.remark", "alarmCondition": null, "alarm": null, "unit": "m" }, { "status": "locationData.roll.title", "value": "0.00", "remark": "locationData.roll.remark", "alarmCondition": null, "alarm": null, "unit": "rad" }, { "status": "locationData.pitch.title", "value": "0.00", "remark": "locationData.pitch.remark", "alarmCondition": null, "alarm": null, "unit": "rad" }, { "status": "locationData.yaw.title", "value": "3.03", "remark": "locationData.yaw.remark", "alarmCondition": null, "alarm": null, "unit": "rad" } ] }, { "groupName": "basicData.title", "list": [ { "status": "basicData.connectState.title", "value": "basicData.connectState.0", "remark": "basicData.connectState.remark", "alarmCondition": "v==1", "alarm": false, "unit": null }, { "status": "basicData.patrolState.title", "value": "basicData.patrolState.3", "remark": "basicData.patrolState.remark", "alarmCondition": null, "alarm": null, "unit": null }, { "status": "basicData.webCtrlMode.title", "value": "basicData.webCtrlMode.1", "remark": "basicData.webCtrlMode.remark", "alarmCondition": null, "alarm": null, "unit": null }, { "status": "basicData.motionState.title", "value": "basicData.motionState.X30_3", "remark": "basicData.motionState.remark", "alarmCondition": "v=='X30_7'", "alarm": false, "unit": null }, { "status": "basicData.gaitState.title", "value": "basicData.gaitState.X30_0", "remark": "basicData.gaitState.remark", "alarmCondition": null, "alarm": null, "unit": null }, { "status": "basicData.controlUsageMode.title", "value": "basicData.controlUsageMode.X30_1", "remark": "basicData.controlUsageMode.remark", "alarmCondition": null, "alarm": null, "unit": null } ] } ] }}状态属性与枚举
Section titled “状态属性与枚举”返回数据按 data.props[] 分组:groupName 表示分组,list[] 中的 status 表示属性名称,value 表示属性值。以下按分组说明各属性;枚举表中的
value 均为完整返回值。
分组名称:batteryData.title。
属性名称:batteryData.electricity.title。value 为具体电量值。
属性名称:batteryData.chargeState.title。
value | 含义 |
|---|---|
"0" | 未充电 |
"1" | 充电中 |
属性名称:batteryData.electricityIsLow.title。
value | 含义 |
|---|---|
batteryData.electricityIsLow.0 | 正常 |
batteryData.electricityIsLow.1 | 低 |
分组名称:locationData.title。
属性名称:locationData.location.title。
value | 含义 |
|---|---|
locationData.location.0 | 定位正常 |
locationData.location.1 | 定位丢失 |
属性名称:locationData.obsState.title。
value | 含义 |
|---|---|
locationData.obsState.0 | 无障碍物 |
locationData.obsState.1 | 有障碍物 |
地图、坐标与姿态
Section titled “地图、坐标与姿态”以下属性的 value 均为具体值。
属性名称(status) | 含义 |
|---|---|
locationData.floor.title | 地图楼层 |
locationData.posX.title | x 坐标 |
locationData.posY.title | Y 坐标 |
locationData.posZ.title | z 坐标 |
locationData.roll.title | 滚动角 |
locationData.pitch.title | 俯仰角 |
locationData.yaw.title | 航向角 |
基础状态数据
Section titled “基础状态数据”分组名称:basicData.title。
属性名称:basicData.connectState.title。
value | 含义 |
|---|---|
basicData.connectState.0 | 正常 |
basicData.connectState.1 | 离线 |
basicData.connectState.2 | robotServer 断连 |
basicData.connectState.3 | custom 断连 |
属性名称:basicData.patrolState.title。
value | 含义 |
|---|---|
basicData.patrolState.1 | 空闲 |
basicData.patrolState.2 | 巡视 |
basicData.patrolState.3 | 充电 |
basicData.patrolState.4 | 检修 |
属性名称:basicData.webCtrlMode.title。
value | 含义 |
|---|---|
basicData.webCtrlMode.0 | 半自动导航 |
basicData.webCtrlMode.1 | 任务模式 |
basicData.webCtrlMode.2 | 遥控模式 |
属性名称:basicData.motionState.title。枚举值按机器人型号区分。
X30
value | 含义 |
|---|---|
basicData.motionState.X30_0 | 趴下 |
basicData.motionState.X30_1 | 正在起立 |
basicData.motionState.X30_2 | 初始站立 |
basicData.motionState.X30_3 | 力控站立 |
basicData.motionState.X30_4 | 踏步 |
basicData.motionState.X30_5 | 正在趴下 |
basicData.motionState.X30_6 | 软急停 |
basicData.motionState.X30_7 | 摔倒 |
basicData.motionState.X30_16 | RL |
M20
value | 含义 |
|---|---|
basicData.motionState.M20_0 | 空闲 |
basicData.motionState.M20_1 | 站立 |
basicData.motionState.M20_2 | 关节阻尼/软急停 |
basicData.motionState.M20_3 | 开机阻尼 |
basicData.motionState.M20_4 | 趴下 |
basicData.motionState.M20_6 | 标准运动模式 |
basicData.motionState.M20_8 | 敏捷运动模式 |
basicData.motionState.M20_17 | RL控制 |
属性名称:basicData.gaitState.title。枚举值按机器人型号区分。
X30
value | 含义 |
|---|---|
basicData.gaitState.X30_0 | 行走步态 |
basicData.gaitState.X30_1 | 复杂路面越障步态 |
basicData.gaitState.X30_2 | 斜坡/防滑步态 |
basicData.gaitState.X30_6 | 感知楼梯步态 |
basicData.gaitState.X30_7 | 累积帧楼梯步态 |
basicData.gaitState.X30_8 | 累积帧45°楼梯步态 |
basicData.gaitState.X30_32 | L行走步态 |
basicData.gaitState.X30_33 | 山地步态 |
M20
value | 含义 |
|---|---|
basicData.gaitState.M20_4097 | 基础模式-平地 |
basicData.gaitState.M20_4098 | 基础模式-高台 |
basicData.gaitState.M20_4099 | 基础模式-楼梯 |
basicData.gaitState.M20_4100 | 基础模式-后膝 |
basicData.gaitState.M20_4101 | 基础模式-站立 |
basicData.gaitState.M20_8193 | 极限模式-移动 |
basicData.gaitState.M20_8194 | 极限模式-双足正立 |
basicData.gaitState.M20_8195 | 极限模式-双足倒立 |
basicData.gaitState.M20_8196 | 极限模式-跳跃 |
basicData.gaitState.M20_12289 | 导航模式-自主充电 |
basicData.gaitState.M20_12290 | 导航模式-平地 |
basicData.gaitState.M20_12291 | 导航模式-楼梯 |
basicData.gaitState.M20_12292 | 自主充电步态 |
basicData.gaitState.M20_12293 | 导航模式-越野 |
basicData.gaitState.M20_20481 | 智能模式-高度图跨沟 |
basicData.gaitState.M20_20482 | 智能模式-高度图楼梯 |
basicData.gaitState.M20_20483 | 智能模式-深度图跨沟 |
basicData.gaitState.M20_61441 | 6轴可控站立 |
basicData.gaitState.M20_61442 | 踏步移动 |
属性名称:basicData.controlUsageMode.title。枚举值按机器人型号区分。
X30
value | 含义 |
|---|---|
basicData.controlUsageMode.X30_0 | 遥控模式 |
basicData.controlUsageMode.X30_1 | 自动模式 |
M20
value | 含义 |
|---|---|
basicData.controlUsageMode.M20_0 | 常规模式 |
basicData.controlUsageMode.M20_1 | 导航模式 |
basicData.controlUsageMode.M20_2 | 辅助模式 |
| 错误码 | 描述 |
|---|---|
| 400 | 参数错误 |
| 401 | 未授权 |
| 403 | 没有访问权限 |
| 404 | 找不到资源 |
| 500 | 服务器内部错误 |