v1

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

reel-movement

Update reel motor speed

Updates the motor speed percentage for ongoing wind or unwind operations while maintaining current direction.

Speed updates allow real-time adjustment of motor velocity without interrupting the current operation. The new speed setting is applied immediately if the motor is currently moving, or stored for the next movement command if the motor is stopped.

This endpoint preserves the current motor direction (wind/unwind) and only modifies the velocity component of the operation.

put/api/v1/reel/speed

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": "Motor speed updated during operation",
  "name": "Speed Updated",
  "value": {
    "action": "UPDATE_SPEED",
    "error": false,
    "error_msgs": [],
    "result": {
      "speed": 90
    }
  }
}