Update Robot Status

You can use this method to update the robot status.

When the robot adapter is running, it keeps tracking the robot’s status. Once there is a change to the status, the robot adapter should be notified within two seconds.

Then the robot adapter calls this method to notify the warehouse robot controller.

Note that if there is no status change, the robot adapter shouldn't call this method.

Request

URI: /robots/{robotId}/robotStatus/

HTTP Method: PUT

Request Parameters

Parameter Required Data Type Description
robotId Yes String Robot ID
status Yes String (maximum 20 characters) Status
Possible values:

  • AVAILABLE (The robot is available.)

  • UNAVAILABLE (The robot is unavailable.)

  • ERROR (There is an error for the robot (in the system) that needs to be checked manually.)

  • EMERGENCY_STOP (The physical robot is in an emergency stop. )
batteryPercentage Yes Integer

Battery level

Value range is from 0 to 100.
connected Yes Boolean

Indicator to show whether the robot is connected to an edge node.

The values can be "Yes" or "No".
message No String Additional message to explain status.

Response

Code Description
200 The request is processed successfully.
400 The server can't process the request.
404 Robot task doesn't exist.

Examples

Response