1. SPG-HTTP
SEER-SPG-HTTP
  • 🦊一分钟,了解 Apifox !
  • SPG-HTTP
    • 查询modbus数据
      GET
    • 查询机器人数据
      GET
    • 查询机器人载入的地图以及存储的地图
      GET
    • 查询机器人当前载入地图中的站点消息
      GET
    • 查询任意两点之间的路径
      GET
    • 查询机器人文件列表
      GET
    • 查询机器人任务状态
      GET
    • 设置 DO
      POST
    • 路径导航
      POST
    • 停止开环运动
      POST
    • 重定位
      POST
    • 清除外置编码器数值
      POST
    • 开环运动
      POST
    • 脚本控制
      POST
    • 设置继电器
      POST
    • 软急停
      POST
    • 设置虚拟 DI
      POST
    • 暂停当前导航
      POST
    • 继续当前导航
      POST
    • 取消当前导航
      POST
    • 指定路径导航
      POST
    • 根据任务id清除指定导航路径
      POST
    • 抢占控制权
      POST
    • 释放控制权
      POST
    • 清除机器人当前异常
      POST
    • 文件上传
      POST
    • 文件下载
      GET
    • 删除机器人文件
      POST
    • 切换地图项目
      POST
    • 上传并切换地图项目
      POST
    • 重命名机器人文件
      POST
    • 配置机器人地图工作区
      POST
    • 配置 DI
      POST
    • 插入动态障碍物
      POST
    • 移除动态障碍物
      POST
    • 运行信息清除
      POST
    • 通知文件修改
      POST
    • 写入modbus数据
      POST
    • 操作货物和货架
      POST
    • 通用状态 API
      POST
    • 通用控制 API
      POST
    • 任务运行器(taskRunner)
      POST
  • 数据模型
    • 示例数据模型
      • JSON 响应体
  1. SPG-HTTP

查询机器人数据

测试中
GET
/getSpecifiedFieldsAIO
批量获取机器人大部分状态数据。包括设备状态、统计信息、控制器信息、位置信息、底盘移动状态、电机数据、障碍物信息、电池信息、IO配置、数字输入信息、数字输出信息、导航任务信息、建图状态、地图信息、网络信息、机器人信息、控制权、历史控制权、TCP客户端连接信息、机器人形状、手柄、音频信息、机器人区域信息、惯性传感器数据、功能安全信息、货物形状、传感器点云数据、用户添加的障碍物信息、标定状态、卫星信息、射频识别标签、二维码识别数据、任务管理器信息、2D激光数据、3D激光数据。
支持通过 includedFields/excludedFields 筛选返回字段。

请求参数

Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/getSpecifiedFieldsAIO?includedFields=&excludedFields=undefined&language=undefined&timeout=undefined'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "createOn": "2019-08-24T14:15:22.123Z",
    "errMsg": "",
    "retCode": 0,
    "data": {
        "deviceStatus": {},
        "stats": {
            "odometer": 0,
            "todayOdometer": 0,
            "uptime": 0,
            "todayTime": 0,
            "totalTime": 0
        },
        "controller": {
            "temperature": 0,
            "humidity": 0,
            "voltage": 0,
            "emergency": true,
            "driverEmc": true,
            "electric": true,
            "softEmc": true
        },
        "location": {
            "x": 0,
            "y": 0,
            "angle": 0,
            "confidence": 0,
            "method": 0,
            "currentStation": "string",
            "lastStation": "string",
            "areaIds": [
                "string"
            ],
            "relocStatus": 0,
            "localTag": {
                "x": 0,
                "y": 0,
                "angle": 0,
                "confidence": 0,
                "groupName": "string",
                "header": {},
                "distanceNotFindTag": 0
            },
            "locNotify": "string"
        },
        "chassis": {
            "vx": 0,
            "vy": 0,
            "w": 0,
            "vxCommand": 0,
            "vyCommand": 0,
            "wCommand": 0,
            "isStop": true
        },
        "motor": {
            "motorMotion": {
                "spinAngle": 0,
                "spinVelocityCommand": 0,
                "steerAngle": 0,
                "steerAngleCommand": 0,
                "steerAngles": [
                    0
                ],
                "steerAnglesCommand": [
                    0
                ],
                "motorSteerAngles": [
                    {
                        "motorName": "string",
                        "value": 0
                    }
                ],
                "isStop": true
            },
            "motorInfo": [
                {
                    "header": {},
                    "name": "string",
                    "canRouter": 0,
                    "canId": 0,
                    "position": 0,
                    "speed": 0,
                    "current": 0,
                    "voltage": 0,
                    "stop": true,
                    "errorCode": 0,
                    "err": true,
                    "emc": true,
                    "temperature": 0,
                    "encoder": 0,
                    "type": 0,
                    "passive": true,
                    "calib": 0,
                    "followErr": true,
                    "rawPosition": 0,
                    "torque": 0
                }
            ]
        },
        "obstacle": {
            "blocked": true,
            "blockReason": 0,
            "blockX": 0,
            "blockY": 0,
            "blockDevice": "string",
            "slowed": true,
            "slowReason": 0,
            "slowX": 0,
            "slowY": 0,
            "slowDevice": "string",
            "nearestObstacles": [
                {}
            ],
            "detectSkid": true,
            "manualBlock": true,
            "dynamicObstacle": [
                {
                    "header": {},
                    "name": "string",
                    "points": [
                        {
                            "x": 0,
                            "y": 0
                        }
                    ]
                }
            ]
        },
        "battery": {
            "level": 0,
            "temperature": 0,
            "charging": true,
            "voltage": 0,
            "current": 0,
            "maxChargeVoltage": 0,
            "maxChargeCurrent": 0,
            "manualCharge": true,
            "autoCharge": true,
            "cycle": 0,
            "userData": "string",
            "extra": "string",
            "SOH": 0,
            "needFullCharge": true,
            "lastFullChargeStamp": 0
        },
        "ioConfig": [
            {
                "dir": 0,
                "ioType": 0,
                "maxNode": 0,
                "pair": [
                    {
                        "first": 0,
                        "second": 0
                    }
                ]
            }
        ],
        "di": {
            "diMaxNode": 0,
            "node": [
                {
                    "id": 0,
                    "key": "string",
                    "name": "string",
                    "status": true,
                    "forbidden": true,
                    "source": "string",
                    "ioType": 0
                }
            ]
        },
        "do": {
            "doMaxNode": 0,
            "node": [
                {
                    "id": 0,
                    "key": "string",
                    "name": "string",
                    "status": true,
                    "source": "string",
                    "ioType": 0,
                    "lock": true
                }
            ]
        },
        "navigation": {
            "taskId": "string",
            "taskStatus": 0,
            "runningStatus": 0,
            "targetDist": 0,
            "moveStatusInfo": "string",
            "type": 0,
            "targetId": "string",
            "targetLabel": "string",
            "targetPoint": [
                0
            ],
            "multiPath": [
                {}
            ],
            "finishedPath": [
                "string"
            ],
            "unfinishedPath": [
                "string"
            ],
            "mates": "string",
            "taskStatusPackage": {}
        },
        "mapping": {
            "status": 0
        },
        "map": {
            "loadMapStatus": 0,
            "currentMap": "string",
            "currentMapMd5": "string",
            "currentTopoMd5": "string",
            "currentMapEntries": [
                {
                    "relativePath": "string",
                    "md5": "string"
                }
            ],
            "userData": {},
            "subMap": {
                "centerM": 0,
                "centerN": 0
            }
        },
        "network": {
            "ssid": "string",
            "rssi": 0,
            "ip": "string",
            "mac": "string",
            "wlanMac": "string",
            "apAddr": "string",
            "dispatchMode": 0
        },
        "robot": {
            "id": "string",
            "codeId": "string",
            "echoidType": "string",
            "echoId": "string",
            "features": [
                {}
            ],
            "vehicleId": "string",
            "robotNote": "string",
            "version": "string",
            "product": "string",
            "model": "string",
            "modelName": "string",
            "deviceParamMd5": "string",
            "appMd5": "string",
            "chassisType": "string",
            "dspVersion": "string",
            "gyroVersion": "string",
            "simulation": true,
            "pyideVersion": "string",
            "versionList": {},
            "deviceParamVersion": "string",
            "mapVersion": "string",
            "roboshopMinVersionRequired": "string",
            "netprotocolVersion": "string",
            "dnnModelVersion": "string",
            "modbusVersion": "string",
            "srcName": "string",
            "architecture": "string",
            "connectFleet": true
        },
        "control": {
            "locked": true,
            "ip": "string",
            "port": 0,
            "type": 0,
            "nickname": "string",
            "timeT": 0,
            "desc": "string",
            "srcRelease": true
        },
        "controlHistory": [
            {
                "ip": "string",
                "port": 0,
                "type": 0,
                "nickname": "string",
                "timeT": 0,
                "desc": "string",
                "timeTUnlock": 0
            }
        ],
        "tcpClient": {
            "19204Ip": "string",
            "19205Ip": "string",
            "19206Ip": "string",
            "19207Ip": "string",
            "19210Ip": "string",
            "19301Ip": "string",
            "19204Number": 0,
            "19205Number": 0,
            "19206Number": 0,
            "19207Number": 0,
            "19210Number": 0
        },
        "robotShape": {
            "shape": 0,
            "head": 0,
            "tail": 0,
            "width": 0,
            "radius": 0
        },
        "sound": {
            "status": 0,
            "name": "string",
            "loop": true,
            "count": 0
        },
        "movePolygon": {
            "robotRegion": {
                "name": "string",
                "point": [
                    {
                        "x": 0,
                        "y": 0
                    }
                ]
            },
            "removedRegions": [
                {}
            ],
            "stopPath": {},
            "slowPath": {},
            "advanceRegions": [
                {}
            ]
        },
        "imu": {
            "imuHeader": {},
            "yaw": 0,
            "roll": 0,
            "pitch": 0,
            "accX": 0,
            "accY": 0,
            "accZ": 0,
            "rotX": 0,
            "rotY": 0,
            "rotZ": 0,
            "rotOffX": 0,
            "rotOffY": 0,
            "rotOffZ": 0,
            "qx": 0,
            "qy": 0,
            "qz": 0,
            "qw": 0
        },
        "functionalSafety": {
            "safeCuttingsId": 0,
            "ossdRegion": 0
        },
        "goodsRegion": {
            "name": "string",
            "point": [
                {
                    "x": 0,
                    "y": 0
                }
            ]
        },
        "sensorPointCloud": [
            {
                "key": "string",
                "type": 0,
                "point": [
                    {
                        "x": 0,
                        "y": 0,
                        "z": 0,
                        "isObstacle": true,
                        "rssi": 0,
                        "tag": "string"
                    }
                ]
            }
        ],
        "calibStatus": {
            "status": 0,
            "desc": "string",
            "calibTypes": [
                {
                    "calibType": "string",
                    "deviceType": "string",
                    "deviceName": "string",
                    "isAutoCalib": true,
                    "hasPlot": true,
                    "status": 0
                }
            ]
        },
        "gnss": {
            "header": {},
            "status": 0,
            "x": 0,
            "y": 0,
            "z": 0,
            "ubx2DAccH": 0,
            "ubx2DAccV": 0,
            "ubx3DAcc": 0,
            "longitude": 0,
            "latitude": 0,
            "altitude": 0,
            "installInfo": {
                "x": 0,
                "y": 0,
                "z": 0,
                "yaw": 0
            },
            "refInfo": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
            },
            "enuX": 0,
            "enuY": 0,
            "heading": 0
        },
        "rfids": [
            0
        ],
        "laser2d": [
            {
                "deviceInfo": {},
                "installInfo": {},
                "header": {},
                "beams": {},
                "useForLoc": true,
                "beamsNotUse": {},
                "is3DLocalization": true,
                "useForBinDetection": true,
                "refPos": [
                    {}
                ]
            }
        ],
        "laser3d": [
            {
                "deviceInfo": {},
                "installInfo": {},
                "header": {},
                "beams3D": [
                    {}
                ],
                "useForLoc": true,
                "beamsNotUse": [
                    {}
                ],
                "is3DLocalization": true,
                "laserType": 0,
                "factor": 0,
                "azimuthCorrection": [
                    0
                ],
                "verticalCorrection": [
                    0
                ]
            }
        ],
        "codeScanners": [
            {
                "tagDiffX": 0,
                "tagDiffY": 0,
                "tagDiffAngle": 0,
                "tagValue": 0,
                "warningCode": 0,
                "isDMTDetected": true,
                "errorCode": 0,
                "header": {},
                "codeScannerInfo": {
                    "name": "string",
                    "x": 0,
                    "y": 0,
                    "z": 0,
                    "yaw": 0,
                    "pitch": 0,
                    "roll": 0,
                    "func": "string",
                    "coordinate": "string",
                    "isUpside": true,
                    "isBarCode": true
                }
            }
        ],
        "taskRunner": {
            "taskName": "string",
            "tasks": [
                {
                    "id": "string",
                    "status": 0,
                    "message": "string"
                }
            ]
        }
    }
}
修改于 2026-05-14 13:38:54
上一页
查询modbus数据
下一页
查询机器人载入的地图以及存储的地图
Built with