Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB
v1
cable-position

Set cable position

Sets the cable encoder position to a specific value in meters.

This operation manually assigns a specific position value to the current encoder reading, useful for correcting position readings or setting the encoder to match a known cable length. The position can be positive or negative depending on your reference system.

put/api/v1/reel/encoder/count

Request body

cable_positionnumber required

Desired cable position in meters.

Sets the encoder reading to this specific value. Can be positive or negative depending on your reference system. Use when the actual cable position is known and differs from current encoder reading.

Example request

{
  "description": "Set cable position to 15.5 meters",
  "name": "Standard Position",
  "value": {
    "cable_position": 15.5
  }
}

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": "Cable position set to specified value",
  "name": "Position Set",
  "value": {
    "action": "REEL_SET_ENCODER_COUNT",
    "error": false,
    "error_msgs": [],
    "result": {
      "new_position": 15.5
    }
  }
}