---
title: "Get cable reel system information"
method: GET
path: "/api/v1/reel/info"
tags: ["v1", "settings"]
---

# Get cable reel system information

`GET /api/v1/reel/info`

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.

## Response `200`

Successful Response

- CableReelInfoResponse — Static system information and hardware configuration details.
  - `uuid` string, 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_number` string — 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_name` string — 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_version` string, semantic_version, required — Current ReelAPI software version. Version of the ReelAPI system software. Used for compatibility checking and feature availability verification by client applications.
  - `reel_chassis` ReelChassisInfoResponse, required — Reel chassis hardware information.
    - `type` 'croc_mini' | 'croc_xl' | 'kronos' | 'caiman' | 'user', required
  - `motor_driver` MotorDriverInfoResponse — Motor driver hardware information.
    - `type` 'roboclaw' | 'motoron' | 'auto' | 'none'
    - `version` string, Driver-specific version string, nullable — Motor driver firmware or software version. Provides specific version information for the installed motor driver. Format depends on the driver type. Null indicates version information is unavailable.
  - `encoders` EncodersInfoResponse, required — Consolidated encoder information for all system encoders.
    - `cable_position` EncoderInfoResponse, required — Encoder type information for system encoders.
      - `type` 'none' | 'roboclaw' | 'qsb' | 'auto'
    - `motor_position` EncoderInfoResponse, required — Encoder type information for system encoders.
      - `type` 'none' | 'roboclaw' | 'qsb' | 'auto'
  - `calibrations` CalibrationsInfoResponse, required — Consolidated calibration information for all system components.
    - `pid_controller` PIDControllerInfoResponse, required — Status and calibration information for the PID controller.
      - `calibrated` boolean, required — Indicates whether the PID controller has been successfully calibrated. True when the controller has completed calibration and parameters are set for optimal position holding performance. False when calibration is required or has not been performed.
      - `calibrating` boolean, required — Current calibration process status. Indicates whether PID calibration is actively in progress. Monitor this field during calibration operations to track completion status.
      - `calibrated_timestamp` string, ISO 8601 datetime string, nullable, required — ISO 8601 timestamp of the last successful PID calibration. Records when calibration was last completed successfully. Null if no calibration has been performed. Useful for maintenance tracking and calibration history.
    - `cable_position_encoder` CablePositionEncoderInfoResponse, required — Status and calibration information for the cable position encoder.
      - `calibrated` boolean, required — Indicates whether the cable position encoder has been successfully calibrated. True when the encoder has completed calibration and calibration factor is set for accurate position measurements. False when calibration is required or has not been performed.
      - `calibrated_timestamp` string, ISO 8601 datetime string, nullable, required — ISO 8601 timestamp of the last successful cable position calibration. Records when calibration was last completed successfully. Null if no calibration has been performed. Useful for maintenance tracking and calibration history.
      - `calibration_factor` integer, required — Current encoder calibration factor in pulses per meter. Conversion factor used to translate encoder pulses into distance measurements. Determined during calibration process and affects all position calculations.
      - `connected` boolean, required — Cable position encoder connectivity status. True when the encoder is connected and communicating properly. False when encoder is disconnected, offline, or experiencing communication issues.
  - `setup` SetupStatusSimple, required — Simplified setup status for discovery and high-level monitoring
    - `setup_mode_active` boolean, required — Whether the system is currently in any setup phase
    - `current_phase` 'component_configuration' | 'hardware_verification' | 'complete', required — Represents the different phases of system setup
    - `component_configuration_complete` boolean, required — Whether component configuration phase is complete
    - `hardware_verification_complete` boolean, required — Whether hardware verification phase is complete
    - `unconfigured_components` integer, required — Number of components that still require manual configuration
    - `configured_components` integer, required — Number of components that have been successfully configured
  - `reed_switch` object, nullable — Reed switch configuration and role information. Provides information about the reed switch hardware if installed. Not all systems have reed switches installed.
    - `role` 'emergency_stop' | 'limit_hold' | 'benson_push_push_lock'

## Other responses

- `401` — Could not validate credentials
- `403` — Setup required before using this endpoint
- `500` — Internal server error

---

[API](https://skmtc.net/reach-systems-tech/apis/reelapi-v1.md) · [All operations](https://skmtc.net/reach-systems-tech/apis/reelapi-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reach-systems-tech/reelapi-v1/versions/1dd366a9c6a3/schema)