v1

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

Start cable encoder calibration process

Initiate cable encoder calibration by recording the current encoder position as baseline.

The encoder position is recorded as the starting reference point for calibration calculations. Once started, use reel controls to unwind a measured distance of cable (1-10 meters), then complete the process with the finish endpoint.

Emergency stop remains functional during calibration. Monitor calibration status via the is_cable_counter_calibrating field in heartbeat responses.

post/api/v1/reel/calibration/start

Response

Calibration initiation status with system state information

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": "Calibration process initiated successfully",
  "name": "Calibration Started",
  "value": {
    "action": "start_calibration",
    "error": false,
    "error_msgs": [],
    "result": {
      "calibrating": true
    }
  }
}