v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB

reel-movement

Wind reel motor

Initiates reel motor wind operation to retract cable at the specified speed percentage.

Wind operations pull cable back onto the reel drum and are subject to safeguard limits including zero point protection and emergency stop status. The motor maintains the specified speed until stopped, interrupted by safeguards, or superseded by another command.

Safety considerations include ensuring the operational area is clear of personnel and verifying that the zero point gutter setting provides adequate safety margin for automatic stopping.

put/api/v1/reel/wind

Request body

speedinteger required

Motor speed as percentage of maximum rated speed.

Valid range is 0-100 where 0 stops the motor and 100 provides maximum speed. Speed settings are applied immediately for active operations or stored for subsequent movement commands.

Example request

{
  "description": "Full speed motor operation",
  "name": "High Speed Operation",
  "value": {
    "speed": 100
  }
}

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": "Reel motor wind operation initiated successfully",
  "name": "Wind Operation Started",
  "value": {
    "action": "WIND",
    "error": false,
    "error_msgs": [],
    "result": {
      "speed": 75
    }
  }
}