Skip to main content

V1 获取机器人状态

备注
接口功能:
本接口用于查询单个机器人的实时状态,返回数据包括机器人当前的在线状态、运行模式、任务执行状态等关键信息。

适用场景:
本接口适用于需要实时获取某个机器人运行状态的场景,尤其适用于监控机器人任务执行情况、运行是否正常等需求。

限制与注意事项:
实时性:本接口提供的状态为查询时刻的实时信息,若机器人状态频繁变化,需结合轮询或订阅机制获取连续状态更新。
权限要求:用户需具备访问指定机器人数据的权限,系统可能会根据用户角色限制可查询的机器人。
响应时间:若系统负载较高,可能导致查询响应时间延迟,建议在批量监控时使用异步请求以减少影响。
调用频率:请注意API调用的频率限制,以避免频繁请求引发的限流或封锁。
接口说明
URL
请求方式
/v1alpha1/robots/{robot}/status
GET
路径参数
名称
备注
示例
robot
机器人序列号
请求头
名称
参数值
是否必须
示例
备注
Authorization
Bearer {{token}}
返回数据
名称
类型
备注
battery
object
电池
cleanModes
array
清洁模式
device
object
设备
emergencyStop
object
急停
executableTasks
array
可执行任务列表
executingTask
object
当前任务
localizationInfo
object
定位信息
name
string
robots/{serial_number}
online
boolean
是否在线
position
object
位置
serialNumber
string
机器人序列号
speedKilometerPerHour
number
速度,单位:公里/小时
taskState
string
任务状态,枚举值:OTHER, IDLE, RUNNING, PAUSED
请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/status'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {token}'
输出

{
"serialNumber": "TEST00-0000-000-S003",
"name": "robots/TEST00-0000-000-S003",
"position": {
"latitude": 0,
"longitude": 0,
"angle": 0
},
"taskState": "IDLE",
"online": true,
"speedKilometerPerHour": 0,
"battery": {
"charging": false,
"powerPercentage": 37
},
"emergencyStop": {
"enabled": false
},
"localizationInfo": {
"localizationState": "NORMAL",
"map": {
"id": "51839a5c-61a4-46eb-8c9a-5cce50c6845c",
"name": "9-2"
},
"mapPosition": {
"x": 1927,
"y": 278,
"angle": -167.02457485469768
}
},
"executableTasks": [
{
"id": "f6372049-f1ff-4d72-b432-e48edcaeb612",
"name": "execute_task_q",
"map": {
"id": "51839a5c-61a4-46eb-8c9a-5cce50c6845c",
"name": "9-2"
}
},
{
"id": "03e6756c-f3d0-4ed1-82cb-8db319483fc9",
"name": "execute_task_a_a_path0",
"map": {
"id": "51839a5c-61a4-46eb-8c9a-5cce50c6845c",
"name": "9-2"
}
},
{
"id": "5cbf5f19-ad9a-4968-82cf-e3b89bb6c47d",
"name": "execute_task_Z",
"map": {
"id": "51839a5c-61a4-46eb-8c9a-5cce50c6845c",
"name": "9-2"
}
}
],
"cleanModes": [
{
"name": "__middle_cleaning"
},
{
"name": "__heavy_cleaning"
},
{
"name": "轻度"
},
{
"name": "__suction_cleaning"
}
],
"device": {
"vacuum": {
"enabled": false
},
"cleanWaterTank": {
"level": 40
},
"recoveryWaterTank": {
"level": 0
},
"rollingBrush": {
"enabled": false,
"ifPutDown": false
},
"spray": {
"isRunning": false,
"waterLevel": 0
}
},
"workModes": []
}