Sign in

v1

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

Add cable position offset

Adds a specified offset to the current cable encoder position.

This operation performs a relative adjustment to the current position reading by adding the specified offset value. Positive values increase the position reading, negative values decrease it.

put/api/v1/reel/encoder/add-cable-offset

Request body

offset_to_add_in_metersnumber required

Offset value to add to the current cable position in meters.

Positive values increase the position reading, negative values decrease it. This performs a relative adjustment without requiring knowledge of the absolute position.

Example request

{
  "description": "Add 2.5 meters to current position",
  "name": "Positive Offset",
  "value": {
    "offset_to_add_in_meters": 2.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 offset added successfully",
  "name": "Offset Added",
  "value": {
    "action": "REEL_ADD_ENCODER_OFFSET",
    "error": false,
    "error_msgs": [],
    "result": {
      "new_cable_length": 28.2,
      "success": true
    }
  }
}