v1

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

cable-position

Zero cable position

Resets the cable encoder position to zero meters.

This operation establishes a new reference point for cable position measurements by setting the current encoder reading to zero. Use this endpoint when the cable is at a known reference position and you want to reset the position counter.

put/api/v1/reel/encoder/zero

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 successfully reset to zero",
  "name": "Position Zeroed",
  "value": {
    "action": "REEL_ZERO_ENCODER",
    "error": false,
    "error_msgs": [],
    "result": {
      "new_position": 0
    }
  }
}