v1

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

reel-movement

Stop reel motor

Immediately stops reel motor operation and sets motor speed to zero.

Stop operations provide immediate cessation of all motor movement and can be issued regardless of current motor state. This is the primary method for halting ongoing wind, unwind, or positioning operations under normal conditions.

Stop commands are always processed and take priority over other movement commands, making this endpoint essential for safe operation control.

NOTE: If Active Hold Position is enabled, once the reel stops AHP will start its position maintainence procedure until a movement command is received.

put/api/v1/reel/stop

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 stopped successfully",
  "name": "Motor Stopped",
  "value": {
    "action": "STOP",
    "error": false,
    "error_msgs": [],
    "result": {
      "speed": 0
    }
  }
}