Robot Management¶

APIs for monitoring and controlling AMR (Autonomous Mobile Robot) operations.

GetOnlineRobots¶

Returns all currently online robots with their states, positions, battery levels, and active task information.

GET /amr/onlineAmr

Request¶

(No fields defined)

JSON Request Example¶

JSON

{}

Response¶

Field	Message Type	Description
`robots`	repeated `OnlineAMRInfo`	List of online robots with their current states.

JSON Response Example¶

JSON

  {
    "robots": [
      {
        "amrException": {
          "exception": [],
          "exceptionCodes": [],
          "level": 0
        },
        "loadStatus": "EMPTY",
        "taskState": 0,
        "areaId": 1,
        "batteryPercentile": 85.5,
        "coordinate": {
          "x": 12.34,
          "y": 56.78,
          "theta": 1.57
        },
        "materials": [],
        "id": "AMR-001",
        "ip": "192.168.1.100",
        "mapId": 1,
        "name": "Robot-A",
        "mapName": "Warehouse-1F",
        "state": "Idle",
        "stateId": "ROBOT_STATE_IDLE",
        "unFinishRoute": {
          "unFinishedVertexes": [],
          "processRate": 0.0
        },
        "taskChainId": 0,
        "taskId": 0,
        "pos": "HOME_01"
      }
    ]
  }

PauseRobot¶

Pauses a robot's current task execution. The robot will stop either immediately or at the next waypoint depending on the stop_now parameter.

POST /amr/taskCommand/pause/{amr_id}

Request¶

Field	Message Type	Description
`amr_id`	`int32`	Vehicle ID to pause. Passed as a path parameter.
`stop_now`	`bool`	If `true`, the robot stops immediately. If `false`, the robot stops at the next waypoint.

JSON Request Example¶

JSON

  {
    "amrId": 5,
    "stopNow": true
  }

Response¶

(Empty response on success)

JSON Response Example¶

JSON

{}

ResumeRobot¶

Resumes a paused robot's task execution. The robot will continue executing its current task chain from where it was paused.

POST /amr/taskCommand/resume/{amr_id}

Request¶

Field	Message Type	Description
`amr_id`	`int32`	Vehicle ID to resume. Passed as a path parameter.

JSON Request Example¶

JSON

  {
    "amrId": 5
  }

Response¶

(Empty response on success)

JSON Response Example¶

JSON

{}