Skip to main content

Robot Mode Off

The ROBOT_MODE_OFF command disables robot mode for the lobby, releasing exclusive control back to the normal lobby operations. This command should be sent when the robot workflow is complete.

info

After disabling robot mode, the lobby will return to normal operations and other users can interact with the lobby system.


WebSocket API

Command

  • Command: ROBOT_MODE_OFF

Parameters

ParameterTypeRequiredDescription
commandStringYesROBOT_MODE_OFF
requestIdStringYesRandomly generated unique identifier.

Response

Field NameTypeDescription
requestIdStringUnique identifier of the request
statusStringStatus of the request (success or error).
codeStringResponse code (e.g., ROBOT_MODE_OFF_OK)
messageStringDescriptive message about the response

Example Request

{"requestId": "a1b2c3d8", "command": "ROBOT_MODE_OFF"}

Expected Response

  • Immediate Acknowledgment:
{"requestId": "a1b2c3d8", "code": "ROBOT_MODE_OFF_OK", "message": "Deactivating Robot Mode."}
  • Robot Mode Disabled (sent automatically when ready):
{"requestId": "a1b2c3d8", "status": "success", "code": "ROBOT_MODE_DISABLED", "message": "Robot mode has been disabled."}
info

The ROBOT_MODE_OFF_OK response is sent immediately to acknowledge the request. Wait for the ROBOT_MODE_DISABLED response to confirm robot mode is fully deactivated and the lobby has returned to normal operations.

  • On Error (Robot mode not enabled):
{"requestId": "a1b2c3d8", "status": "error", "code": "ROBOT_MODE_NOT_ENABLED", "message": "Robot mode is not active or is currently activating/deactivating"}