v1

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

settings

Get current reel settings

Retrieve the current operational configuration of the reel system including safety settings, cable limits, and control modes.

Returns comprehensive configuration data for the reel system including individual safeguard settings, cable length constraints, remote control permissions, and active position hold parameters. This endpoint provides the current state of all user-configurable system parameters.

Use this endpoint to verify system configuration, populate settings interfaces, or ensure proper system state before performing operations that depend on specific settings configurations.

get/api/v1/reel/settings

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 reel settings retrieved successfully",
  "name": "Settings Retrieved",
  "value": {
    "action": "GET_REEL_SETTINGS",
    "error": false,
    "error_msgs": [],
    "result": {
      "settings": {
        "active_position_hold_enabled": true,
        "always_enable_remote_control": false,
        "loop_control_mode": 0,
        "max_cable_length_meters": 300,
        "motor_deceleration": {
          "decelerated_speed_percent": 25,
          "minimum_speed_percent": 15,
          "minimum_trigger_distance": 0.1,
          "trigger_distance_meters": 1
        },
        "motoron_speed_boost": {
          "enabled": false,
          "speed_boost_percentage": 150
        },
        "reel_safeguards_enabled": true,
        "safeguards": {
          "max_tether_length_enabled": true,
          "no_cable_movement_enabled": true,
          "zero_point_enabled": true
        },
        "zero_point_gutter": 0.5
      }
    }
  }
}