Skip to main content

Robot Mode On

The ROBOT_MODE_ON command enables robot mode for the lobby, giving the robot exclusive control over the lobby operations. This command must be sent before issuing any other lobby control commands.

warning

Always disable robot mode using ROBOT_MODE_OFF when the robot workflow is complete to ensure the lobby becomes available for other users.


WebSocket API

Command

  • Command: ROBOT_MODE_ON

Parameters

ParameterTypeRequiredDescription
commandStringYesROBOT_MODE_ON
requestIdStringYesRandomly generated unique identifier.
parameters.reservedLiftIdStringYesThe ID of the lift to reserve for robot mode.

Response

Field NameTypeDescription
requestIdStringUnique identifier of the request
statusStringStatus of the request (success or error).
codeStringResponse code indicating the result
messageStringDescriptive message about the response
infoObjectOptional additional information (if applicable)

Example Request

{
"requestId": "a1b2c3d7",
"command": "ROBOT_MODE_ON",
"parameters": {
"reservedLiftId": "lift1"
}
}

Expected Response

  • Immediate Acknowledgment:
{
"requestId": "a1b2c3d7",
"code": "ROBOT_MODE_ON_OK",
"message": "Starting Robot Mode."
}
  • Robot Mode Ready (sent automatically when ready):
{
"requestId": "a1b2c3d7",
"status": "success",
"code": "ROBOT_MODE_ENABLED",
"message": "Robot mode has been enabled."
}
info

The ROBOT_MODE_ON_OK response is sent immediately to acknowledge the request. Wait for the ROBOT_MODE_ENABLED response before sending additional commands, as this indicates robot mode is fully active and ready. A successful activation should take no more than a few minutes.

  • On Error (Robot mode already enabled):
{
"requestId": "a1b2c3d7",
"status": "error",
"code": "ROBOT_MODE_ALREADY_ACTIVE",
"message": "Robot mode is already active or activating/deactivating"
}