Yugong API v1.0¶
监控API¶
查询机器人相机状态¶
简要描述:
- 查询机器人当前的相机状态是否正常
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_cam_ready_status
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_cam_ready_status
请求参数说明:
无
成功返回示例: json
{
"data": {
"camReady": false,
"serial": "yg00b10018112315000n00"
},
"errmsg": "Query_OK",
"errno": "0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| camReady | bool | 机器人相机状态 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人速度¶
简要描述:
- 查询机器人当前的速度是多少
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_speed
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_speed
请求参数说明:
无
成功返回示例: json
{
"data": {
"angular_x": 0.0,
"angular_y": 0.0,
"angular_z": 0.0,
"linear_x": 0.0,
"linear_y": 0.0,
"linear_z": 0.0,
"serial": "yg00b10018112315000n00"
},
"errmsg": "Query_OK",
"errno": "0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| angular_x | float | 机器人x方向角速度 |
| angular_y | float | 机器人y方向角速度 |
| angular_z | float | 机器人z方向角速度 |
| linear_x | float | 机器人x方向线速度 |
| linear_y | float | 机器人y方向线速度 |
| linear_z | float | 机器人z方向线速度 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人电量¶
简要描述:
- 查询机器人当前的电池电量是多少
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_battery
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_battery
请求参数说明:
无
成功返回示例: json
{
"data": {
"batteryPercent": 70.5,
"serial": "yg00b10018112315000n00"
},
"errmsg": "Query_OK",
"errno": "0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| batteryPercent | float | 机器人剩余电量 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人位置¶
简要描述:
- 查询机器人当前的位置是多少
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_position
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_position
请求参数说明:
无
成功返回示例: json
{
"data": {
"orientation_w": 0.0,
"orientation_x": 0.0,
"orientation_y": 0.0,
"orientation_z": 0.0,
"position_x": -24.123377017082703,
"position_y": -8.633512043738312,
"position_z": 0.0,
"serial": "yg00b10018112315000n00"
},
"errmsg": "Query_OK",
"errno": "0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| orientation_x | float | 机器人x方向角度 |
| orientation_y | float | 机器人y方向角度 |
| orientation_z | float | 机器人z方向角度 |
| orientation_w | float | 机器人w方向角度 |
| position_x | float | 机器人x方向位置 |
| position_y | float | 机器人y方向位置 |
| position_z | float | 机器人z方向位置 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人最近节点¶
简要描述:
- 查询机器人最近节点信息
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_nearest_node
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_nearest_node
请求参数说明:
无
成功返回示例: json
返回参数说明:
|参数名|类型|说明| |:—– |:—–|—– |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人手柄信息¶
简要描述:
- 查询机器人当前的手柄信息(只有操作手柄时才会获取到数据)
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_joy
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_joy
请求参数说明:
无
成功返回示例: json
{
"data":{
"joy_info":{
"axes":[
1,
0,
0,
0,
0,
0
],
"buttons":[
0,
0,
0,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"header":{
"frame_id":"",
"seq":5294,
"stamp":{
"nsecs":866203661,
"secs":1545132883
}
}
},
"serial":"yg00b10018112315000n00"
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| joy_info | dict | 手柄信息 |
| axes | list | 轴列表信息 |
| buttons | list | 按钮列表信息 |
| header | float | |
| frame_id | float | |
| seq | float | |
| stamp | float | |
| nsecs | float | |
| secs | float | |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人序列号¶
简要描述:
- 查询机器人的序列号
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_serial
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_serial
请求参数说明:
无
成功返回示例: json
{
"errmsg":"Query_OK",
"errno":"0",
"serial":"yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人dtc信息¶
简要描述:
- 查询机器人当前的执行状态数据
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_dtc
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_dtc
请求参数说明:
无
成功返回示例: json
{
"dtc_info":{
"data":[
{
"Current_Condition":"未连接1号相机",
"DTC":"B0CA030100",
"Symptom":"请检查相机连线,重新插拔",
"id":53
},
{
"Current_Condition":"未连接1号雷达",
"DTC":"B0LD030100",
"Symptom":"请重新插拔雷达线",
"id":296
},
{
"Current_Condition":"内存溢出",
"DTC":"B0PC030000",
"Symptom":"请重启机器人,若问题仍发生,请联系客服",
"id":665
},
{
"Current_Condition":"IB异常",
"DTC":"B0IB020001",
"Symptom":"请检查IB连线,重新插拔",
"id":818
},
{
"Current_Condition":"插取货架节点异常",
"DTC":"B0PL020000",
"Symptom":"请重启机器人,若问题仍发生,请联系客服",
"id":923
},
{
"Current_Condition":"长时间二维码丢失",
"DTC":"B0LZ010000",
"Symptom":"请检查摄像头是否被遮盖、环境光照等,重新启动机器人,若问题仍发生,请联系客服",
"id":1004
},
{
"Current_Condition":"定位丢失",
"DTC":"B0LZ010003",
"Symptom":"暂停任务,重启机器人,若问题仍发生,请联系客服",
"id":1007
},
{
"Current_Condition":"控制计算正常",
"DTC":"B0CT000001",
"Symptom":"",
"id":1101
},
{
"Current_Condition":"",
"DTC":"B0CT000002",
"Symptom":"",
"id":1102
},
{
"Current_Condition":"无障碍物",
"DTC":"B0LP000001",
"Symptom":"",
"id":1200
},
{
"Current_Condition":"跟随当前轨迹",
"DTC":"B0LP000004",
"Symptom":"",
"id":1203
},
{
"Current_Condition":"正常",
"DTC":"B0AG000000",
"Symptom":"正常",
"id":1300
},
{
"Current_Condition":"轨迹到达",
"DTC":"B0AG000009",
"Symptom":"",
"id":1309
}
],
"errors":[
{
"Current_Condition":"未连接1号相机",
"DTC":"B0CA030100",
"Symptom":"请检查相机连线,重新插拔",
"id":53
},
{
"Current_Condition":"未连接1号雷达",
"DTC":"B0LD030100",
"Symptom":"请重新插拔雷达线",
"id":296
},
{
"Current_Condition":"内存溢出",
"DTC":"B0PC030000",
"Symptom":"请重启机器人,若问题仍发生,请联系客服",
"id":665
},
{
"Current_Condition":"IB异常",
"DTC":"B0IB020001",
"Symptom":"请检查IB连线,重新插拔",
"id":818
},
{
"Current_Condition":"插取货架节点异常",
"DTC":"B0PL020000",
"Symptom":"请重启机器人,若问题仍发生,请联系客服",
"id":923
},
{
"Current_Condition":"长时间二维码丢失",
"DTC":"B0LZ010000",
"Symptom":"请检查摄像头是否被遮盖、环境光照等,重新启动机器人,若问题仍发生,请联系客服",
"id":1004
},
{
"Current_Condition":"定位丢失",
"DTC":"B0LZ010003",
"Symptom":"暂停任务,重启机器人,若问题仍发生,请联系客服",
"id":1007
}
],
"status":{
"Current_Condition":"轨迹到达",
"DTC":"B0AG000009",
"Symptom":"",
"id":1309
}
},
"errmsg":"Query_OK",
"errno":"0",
"serial":"yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| data | list | 所有dtc信息 |
| errors | list | 所有dtc错误状态信息 |
| status | dict | 当前机器人的状态 |
| Current_Condition | string | 当前状态信息 |
| DTC | string | DTC编码 |
| Symptom | string | 错误状态解决方法 |
| id | int | 状态信息id |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人信息¶
简要描述:
- 查询机器人当前的详细信息
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_info
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_info
请求参数说明:
无
成功返回示例: json
{
"data":{
"info":{
"agentStatus":{
"data":0
},
"batteryPercent":{
"data":31.5
},
"camReady":{
"data":false
},
"computationTimeStatus":{
"data":false
},
"cpuUsagePercent":{
"data":18.421052932739258
},
"execStatus":{
"data":0
},
"execTrajectoryStatus":{
"data":0
},
"ibReady":{
"data":false
},
"ipaddr":{
"data":"192.168.124.145"
},
"locaStatus":{
"data":3
},
"odomCov":{
"data":0
},
"plocaStatus":{
"data":0
},
"poseErrorStatus":{
"data":false
},
"ramUsagePercent":{
"data":62.424461364746094
},
"robotNodeId":{
"data":0
},
"scanReady":{
"data":false
},
"tagReady":{
"data":false
}
},
"serial":"yg00b10018112315000n00"
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| agentStatus | int | 机器人状态 |
| batteryPercent | float | 机器人电池容量百分比 |
| camReady | bool | 机器人相机状态 |
| computationTimeStatus | bool | 机器人z方向位置 |
| cpuUsagePercent | float | 机器人z方向位置 |
| execStatus | int | 机器人z方向位置 |
| execTrajectoryStatus | int | 机器人z方向位置 |
| ibReady | bool | 机器人z方向位置 |
| ipaddr | strings | 机器人z方向位置 |
| locaStatus | int | 机器人z方向位置 |
| odomCov | int | 机器人z方向位置 |
| plocaStatus | int | 机器人z方向位置 |
| poseErrorStatus | bool | 机器人z方向位置 |
| ramUsagePercent | float | 机器人z方向位置 |
| robotNodeId | int | 机器人z方向位置 |
| scanReady | bool | 机器人z方向位置 |
| tagReady | bool | 机器人z方向位置 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询轨迹执行状态¶
简要描述:
- 查询机器人当前的轨迹执行状态
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_exec_trajectory_status
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_exec_trajectory_status
请求参数说明:
无
成功返回示例: json
{
"data":{
"execTrajectoryStatus":0,
"serial":"yg00b10018112315000n00"
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| execTrajectoryStatus | int | 机器人轨迹执行状态 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询内存使用百分比¶
简要描述:
- 查询机器人当前的内存使用百分比
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_ram_usage_percent
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_ram_usage_percent
请求参数说明:
无
成功返回示例: json
{
"data":{
"ramUsagePercent":46.27063751220703,
"serial":"yg00b10018112315000n00"
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| ramUsagePercent | float | 内存使用百分比 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询执行器状态¶
简要描述:
- 查询机器人当前执行器状态
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_ib_ready_status
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_ib_ready_status
请求参数说明:
无
成功返回示例: json
{
"data":{
"ibReady":false,
"serial":"yg00b10018112315000n00"
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| ibReady | bool | 执行器状态 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询cpu使用百分比¶
简要描述:
- 查询机器人当前的CUP的使用情况
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_cup_usage_percent
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_cup_usage_percent
请求参数说明:
无
成功返回示例: json
{
"data":{
"cpuUsagePercent":51.92307662963867,
"serial":"yg00b10018112315000n00"
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| cpuUsagePercent | float | 机器人CPU使用百分比 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
查询机器人IP¶
简要描述:
- 查询机器人的IP是多少
请求URL:
http://<IP>:<PORT>/api/v1/monitor/get_robot_IP
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/monitor/get_robot_IP
请求参数说明:
无
成功返回示例: json
{
"data": {
"IP": "192.168.124.145",
"serial": "yg00b10018112315000n00"
},
"errmsg": "Query_OK",
"errno": "0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| IP | string | 机器人ip地址 |
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4002",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
控制API¶
恢复机器人¶
简要描述:
- 恢复机器人
请求URL:
http://<IP>:<PORT>/api/v1/controller/resume_robot
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/controller/resume_robot
请求参数说明:
无
成功返回示例: json
{
"errmsg": "Resume_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Failure to resume robot trajectory motion",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
暂停机器人¶
简要描述:
- 暂停机器人
请求URL:
http://<IP>:<PORT>/api/v1/controller/pause_robot
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/controller/pause_robot
请求参数说明:
无
成功返回示例: json
{
"errmsg": "Pause_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Failure to pause robot trajectory motion",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
重置定位¶
简要描述:
- 重置机器人定位
请求URL:
http://<IP>:<PORT>/api/v1/controller/reset_localizer
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/controller/reset_localizer
请求参数说明:
无
成功返回示例: json
{
"errmsg": "Reset_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Reset localizer fail",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
重置轨迹¶
简要描述:
- 重置机器人轨迹
请求URL:
http://<IP>:<PORT>/api/v1/controller/reset_navigator
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/controller/reset_navigator
请求参数说明:
无
成功返回示例: json
{
"errmsg": "Reset_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Reset navigator fail",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
重置伺服¶
简要描述:
- 重置机器人伺服
请求URL:
http://<IP>:<PORT>/api/v1/controller/reset_performer
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/controller/reset_performer
请求参数说明:
无
成功返回示例: json
{
"errmsg": "Reset_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Reset performer fail",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
重置机器人¶
简要描述:
- 重置机器人
请求URL:
http://<IP>:<PORT>/api/v1/controller/reset_agent_all
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/controller/reset_agent_all
请求参数说明:
无
成功返回示例: json
{
"errmsg": "Reset_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Reset all fail",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
任务API¶
添加任务¶
简要描述:
- 添加任务
请求URL:
http://<IP>:<PORT>/api/v1/task/add_task_simplex
请求方式:
- POST
请求示例:
http://192.168.124.225:7777/api/v1/task/add_task_simplex
请求参数:
{
"id": 0,
"seq": 0,
"type": 0,
"task_status": 0,
"priority": 0,
"destination": {
"header": {
"seq": 0,
"stamp": {"secs": 0, "nsecs": 0},
"frame_id": ""
},
"timestamp": 0,
"x": 0.0,
"y": 0.0,
"theta": 0.0,
"x_dot": 0.0,
"theta_dot": 0.0
},
"task_trajectory": {
"id": 0,
"points": [
{
"header": {"seq": 0,
"stamp": {"secs": 0, "nsecs": 0},
"frame_id": ""
},
"timestamp": 0,
"x": 0.0,
"y": 0.0,
"theta": 0.0,
"x_dot": 0.0,
"theta_dot": 0.0
}
]
},
"trajectory_continue": "False"
}
请求参数说明:
| 参数名 | 必须 | 类型 | 说明 |
|---|---|---|---|
| id | 是 | int | 任务id |
成功返回示例: json
{
"errmsg": "Query_OK",
"errno": "0",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
获取机器人任务反馈¶
简要描述:
- 获取机器人当前任务反馈信息
请求URL:
http://<IP>:<PORT>/api/v1/task/get_task_feedback
请求方式:
- GET
请求示例:
http://192.168.124.225:7777/api/v1/task/get_task_feedback
请求参数说明:
无
成功返回示例: json
{
"data":{
"msg":{
"agent_pose":{
"theta":2.5804784297943115,
"theta_dot":0,
"x":9.086386680603027,
"x_dot":0,
"y":5.641540050506592,
"y_dot":0
},
"agent_serial":"yg00b10018112315000n00",
"agent_status":0,
"agent_status_name":"",
"name":"",
"task_simplex_id":0,
"task_simplex_seq":0,
"task_status":7,
"trajectory":{
"id":0,
"points":[
]
},
"trajectory_index":0,
"type":0
}
},
"errmsg":"Query_OK",
"errno":"0"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| agent_pose | dict | 机器人位置 |
| x_dot | float | |
| y_dot | float | |
| theta_dot | float | |
| x | float | |
| y | float | |
| theta | float | |
| agent_serial | string | |
| agent_status | int | |
| agent_status_name | string | |
| name | string | |
| task_simplex_id | int | |
| task_simplex_seq | int | |
| task_status | int | |
| trajectory | dict | |
| id | int | |
| points | list | |
| trajectory_index | int | |
| type | int | |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |
错误返回示例: json
{
"errmsg": "Query_Fail",
"errno": "4005",
"serial": "yg00b10018112315000n00"
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| serial | string | 机器人序列号 |
| errno | string | API错误码 |
| errmsg | string | 错误信息 |