Sign in

v1

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

Move to specific cable position

Commands the reel motor to move to a specific cable position using encoder feedback for precise positioning.

Go-to operations automatically determine the required direction (wind or unwind) based on current position and target position. The system uses encoder calibration data to convert position measurements to motor movements with high accuracy.

Requires a properly calibrated encoder system and is subject to all standard safeguards including maximum cable length and zero point protection. Optional speed parameter allows control over positioning velocity.

put/api/v1/reel/go-to-position

Request body

target_positionnumber required

Target cable position in meters from the established zero point.

Specifies the desired final cable position using the current encoder calibration. Position must be within operational limits defined by maximum cable length and zero point gutter settings.

speedinteger nullable

Optional speed percentage for positioning operation.

If specified, the motor moves to target position at this speed. If None, uses the current motor speed setting. Slower speeds provide more precise positioning but longer operation time.

Example request

{
  "description": "Move to specific position at default speed",
  "name": "Standard Positioning",
  "value": {
    "target_position": 25
  }
}

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": "Moving to target by winding cable",
  "name": "Go-To Wind Direction",
  "value": {
    "action": "GO_TO_POSITION",
    "error": false,
    "error_msgs": [],
    "result": {
      "current_position": 23.5,
      "reel_direction": "WIND",
      "target_position": 15
    }
  }
}