Sign in

v1

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

Complete cable encoder calibration with measured distance

Complete calibration using the measured cable distance to calculate the new calibration factor.

Calculates the calibration factor (pulses per meter) by dividing encoder position change by the actual measured cable distance. The new factor is applied immediately and saved to system configuration. Requires the exact distance in meters that the cable was extended during calibration.

post/api/v1/reel/calibration/finish

Request body

pulled_cable_lengthnumber required

Exact physical distance the cable was extended during calibration in meters.

This value determines the accuracy of all future position calculations. Measure to nearest centimeter for optimal accuracy. Typical values: 1 meter (minimum), 5 meters (standard), 10 meters (long/high precision).

Example request

{
  "description": "Typical 5 meter calibration",
  "name": "Standard Calibration",
  "value": {
    "pulled_cable_length": 5
  }
}

Response

Calibration completion results with new calibration factor

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 completed with new factor calculated",
  "name": "Calibration Completed",
  "value": {
    "action": "finish_calibration",
    "error": false,
    "error_msgs": [],
    "result": {
      "calibrating": false,
      "new_factor": 1895
    }
  }
}