Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB
v1
reel-movement

Set command lockout status

Enables or disables the command lockout feature to prevent user-initiated movement operations.

When command lockout is enabled, all movement commands (wind, unwind, go-to-position, jog, and speed updates) are blocked and return error responses. Safety features including emergency stop and active braking continue to function normally.

Command lockout provides an additional safety layer during maintenance operations or when the system must remain stationary while other processes are active.

put/api/v1/reel/command-lockout

Request body

lockout_enabledboolean required

Enable or disable movement command restrictions.

When True, blocks all user movement commands (wind, unwind, go-to, jog, speed) while preserving safety features. When False, allows normal movement command processing.

Example request

{
  "description": "Block all movement commands",
  "name": "Enable Lockout",
  "value": {
    "lockout_enabled": true
  }
}

Response

Successful Response

actionstring required

The action that was requested or performed by the endpoint

errorboolean required

Indicates whether the operation encountered an error

error_msgsstring[]

List of error messages if the operation failed

Example response

{
  "description": "Movement commands now blocked",
  "name": "Lockout Enabled",
  "value": {
    "action": "set_command_lockout",
    "error": false,
    "error_msgs": [],
    "result": {
      "lockout_enabled": true
    }
  }
}