Sign in

v1

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

Update reel settings

Modify operational configuration parameters for the reel system including safety controls, cable limits, and advanced features.

Allows selective updates to reel configuration by providing only the settings to be modified (null values are ignored). Changes are validated for consistency and safety before being applied to the system. Safeguard synchronization ensures master safeguard control properly reflects individual safeguard states.

Critical safety settings modifications require careful consideration as they directly affect operational limits and protection mechanisms. Changes are immediately applied and saved to persistent configuration storage.

put/api/v1/reel/settings

Request body

reel_safeguards_enabledboolean nullable

Master control for all reel safety systems.

When True, enables safety monitoring and protection features. When False, disables all safeguards for maintenance or emergency operations. Changes automatically sync with individual safeguard settings.

max_cable_length_metersnumber nullable

Maximum allowed cable extension distance in meters.

Defines the operational limit for cable unwinding to prevent over-extension, cable damage, or operational area violations. Must be positive value greater than zero.

zero_point_gutternumber nullable

Safety margin distance from zero point in meters.

Additional retraction distance beyond the established zero point where the system will stop winding. Prevents over-retraction and provides operational safety margin.

always_enable_remote_controlboolean nullable

Remote control override for physical controls.

When True, prevents physical control interfaces from disabling remote API control. When False, allows physical controls to disable remote operations for safety.

active_position_hold_enabledboolean nullable

Active motor position holding feature control.

Enables/disables the system's ability to actively maintain the last stopped position using motor encoder feedback and PID control. Requires motor position encoder installation.

zero_point_resetboolean nullable

Cable counter position reset configuration.

If zero_point_reset is true, when the reed switch is closed (active) the reel will reset the cable counter position to 0. This is to accommodate cable counter drift or slippage during operation and set the position back to a known quantity.

Example request

{
  "description": "Enable reel safeguards with all individual protections active",
  "name": "Enable All Safeguards",
  "value": {
    "reel_safeguards_enabled": true,
    "safeguards": {
      "max_tether_length_enabled": true,
      "motor_safe_deceleration_enabled": true,
      "no_cable_movement_enabled": true,
      "zero_point_enabled": true
    }
  }
}

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": "Reel settings updated successfully",
  "name": "Settings Updated",
  "value": {
    "action": "UPDATE_REEL_SETTINGS",
    "error": false,
    "error_msgs": [],
    "result": {
      "settings": {
        "active_position_hold_enabled": true,
        "always_enable_remote_control": true,
        "loop_control_mode": 0,
        "max_cable_length_meters": 250,
        "motor_deceleration": {
          "decelerated_speed_percent": 25,
          "minimum_speed_percent": 15,
          "minimum_trigger_distance": 0.1,
          "trigger_distance_meters": 1
        },
        "motoron_speed_boost": {
          "enabled": true,
          "speed_boost_percentage": 175
        },
        "reel_safeguards_enabled": true,
        "safeguards": {
          "max_tether_length_enabled": true,
          "motor_safe_deceleration_enabled": true,
          "no_cable_movement_enabled": true,
          "zero_point_enabled": true
        },
        "zero_point_gutter": 1
      }
    }
  }
}