v1

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

reel-movement

Unwind reel motor

Initiates reel motor unwind operation to extend cable at the specified speed percentage.

Unwind operations deploy cable from the reel drum and are subject to safeguard limits including maximum cable length protection and emergency stop status. The motor maintains the specified speed until stopped, interrupted by safeguards, or superseded by another command.

Safety considerations include monitoring cable tension and ensuring the maximum cable length setting prevents over-extension beyond operational limits.

put/api/v1/reel/unwind

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 unwind operation initiated successfully",
  "name": "Unwind Operation Started",
  "value": {
    "action": "UNWIND",
    "error": false,
    "error_msgs": [],
    "result": {
      "speed": 50
    }
  }
}