Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB
v1
setup
factory

Get System Setup Status

Get the current system setup mode status and component configuration state.

FACTORY USE ONLY - This endpoint is designed for factory configuration and initial system setup.

This endpoint provides comprehensive information about the system's setup state including:

  • Setup mode activation status - Whether system requires configuration
  • Component configuration progress - Which components are configured vs pending
  • Setup completion readiness - Whether system can exit setup mode

Setup Mode Overview

Setup mode is automatically activated when the system detects unconfigured components in the manifest. During setup mode:

  • Normal reel operations are disabled until all components are properly configured
  • Only factory/setup endpoints remain accessible for configuration tasks
  • System remains in safe state preventing operation with unconfigured hardware

Component Types Requiring Configuration

  • motor_driver - Motor control hardware (Roboclaw, Motoron, etc.)
  • cable_encoder - Cable position measurement system
  • motor_encoder - Motor position feedback encoder
  • physical_control - Manual control interfaces (pendant, switches)
  • reed_switch - Magnetic proximity sensors
  • estop - Emergency stop safety systems
  • status_rgb_led - Visual status indication
  • cable_reel_chassis - Physical reel mounting configuration
  • serial_handler - Communication interface setup

Usage in Factory Environment

  1. Check setup status to identify unconfigured components
  2. Configure each component using the appropriate hardware type
  3. Verify configuration by checking remaining components
  4. Exit setup mode once all components are configured

This endpoint is essential for factory technicians and system integrators during initial deployment.

get/api/v1/setup/status

Response

Current setup mode status and component configuration state

setup_mode_activeboolean 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_completeboolean required

Whether component configuration phase is complete

hardware_verification_completeboolean required

Whether hardware verification phase is complete

unconfigured_componentsstring[] required

List of components that still require manual configuration

hardware_ready_for_initializationboolean required

Whether hardware components can be fully initialized.

  • True: Components configured, ReelManager can create full hardware instances
  • False: Component configuration incomplete, limited functionality

Usage: Determines if motor/encoder testing is available during verification

can_exit_setupboolean required

Whether setup mode can be exited (all phases complete).

  • True: Both component configuration AND hardware verification complete
  • False: One or more phases still pending

Requirements: component_configuration_complete=True AND hardware_verification_complete=True

Example response

{
  "can_exit_setup": false,
  "component_configuration_complete": false,
  "configured_components": [
    {
      "component_id": "physical_control",
      "type": "gpio"
    },
    {
      "component_id": "reed_switch",
      "type": "gpio"
    },
    {
      "component_id": "estop",
      "type": "gpio"
    }
  ],
  "configured_components_count": 3,
  "current_phase": "hardware_verification",
  "hardware_ready_for_initialization": true,
  "hardware_verification_complete": false,
  "setup_mode_active": true,
  "unconfigured_components": [
    "motor_driver",
    "cable_encoder"
  ],
  "unconfigured_components_count": 2
}