REreach-systems-tech
v1
cable-position

Get cable position

Retrieves the current cable position from the encoder in meters.

Returns the current encoder reading converted to meters using the active calibration factor. This the cable position is also returned as part of the heartbeat data.

get/api/v1/reel/encoder/count

Request

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": "Current cable position retrieved successfully",
  "name": "Position Retrieved",
  "value": {
    "action": "REEL_GET_ENCODER_COUNT",
    "error": false,
    "error_msgs": [],
    "result": {
      "cable_position": 23.7
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.