v1

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

settings

Get cable reel system information

Retrieve static system information and capabilities including hardware configuration, calibration status, and API version details.

Provides read-only information about the reel system's hardware configuration, current calibration factors, supported maximum speeds, and installed component specifications. This data remains relatively static unless hardware is modified or recalibrated.

get/api/v1/reel/info

Response

Successful Response

uuidstring uuid4

Unique identifier for this reel system.

Permanent UUID that uniquely identifies this specific reel hardware. Used for asset tracking, configuration management, and system identification.

serial_numberstring

Hardware serial number for this reel system.

Factory or field-assigned serial number for hardware identification and warranty tracking. Can be updated by administrators.

display_namestring

User-friendly display name for this reel system.

Customizable name for easy identification in multi-reel environments or user interfaces. Can be updated by any authenticated user.

api_versionstring semantic_version required

Current ReelAPI software version.

Version of the ReelAPI system software. Used for compatibility checking and feature availability verification by client applications.

Example response

{
  "description": "Full system information including reel identification and setup status",
  "name": "Complete Reel Info",
  "value": {
    "api_version": "1.1.3",
    "calibrations": {
      "cable_position_encoder": {
        "calibrated": true,
        "calibrated_timestamp": "2024-09-03T10:15:30Z",
        "calibration_factor": 1895,
        "connected": true
      },
      "pid_controller": {
        "calibrated": true,
        "calibrated_timestamp": "2024-09-15T14:30:00Z",
        "calibrating": false
      }
    },
    "display_name": "Smart Winch",
    "encoders": {
      "cable_position": {
        "type": "qsb"
      },
      "motor_position": {
        "type": "roboclaw"
      }
    },
    "motor_driver": {
      "type": "roboclaw",
      "version": "v4.2.8"
    },
    "reel_chassis": {
      "type": "croc_mini"
    },
    "serial_number": "RWS-2024-001",
    "setup": {
      "component_configuration_complete": true,
      "configured_components": 6,
      "current_phase": "complete",
      "hardware_verification_complete": true,
      "setup_mode_active": false,
      "unconfigured_components": 0
    },
    "uuid": "550e8400-e29b-41d4-a716-446655440000"
  }
}