v1

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

Jog reel motor briefly

Performs a brief directional motor movement at full speed for precise cable positioning adjustments.

Jog operations run for exactly 1/10th of a second at 100% speed in the specified direction (wind or unwind). This provides fine control for cable positioning during setup, maintenance, or when precise adjustments are needed.

Jog commands are useful for incremental positioning and cable tension adjustment without requiring continuous motor operation or specific target positions.

put/api/v1/reel/jog

Request body

Example request

{
  "description": "Brief wind movement using integer direction",
  "name": "Jog Wind (Integer)",
  "value": {
    "direction": 1
  }
}

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": "Brief wind jog completed successfully",
  "name": "Jog Wind Complete",
  "value": {
    "action": "JOG_WIND",
    "error": false,
    "error_msgs": [],
    "result": {
      "speed": 100
    }
  }
}