---
title: "Get System Setup Status"
method: GET
path: "/api/v1/setup/status"
tags: ["v1", "setup", "factory"]
---

# Get System Setup Status

`GET /api/v1/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.

## Response `200`

Current setup mode status and component configuration state

- SetupStatusDetailed — Enhanced setup status with phase information
  - `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` string[], required — List of components that still require manual configuration
  - `configured_components` ConfiguredComponent[], required — List of components that have been successfully configured
    - `component_id` string, required — Component identifier from system manifest. **Common Component IDs:** - **motor_driver** - Primary motor control hardware - **cable_encoder** - Cable position measurement system - **motor_encoder** - Motor position feedback encoder - **physical_control** - Manual control interfaces - **reed_switch** - Magnetic proximity sensors - **estop** - Emergency stop safety systems
    - `type` string, required — Configured hardware type identifier. **Hardware Types by Component:** - **Motor Drivers**: roboclaw, motoron, null - **Encoders**: roboclaw, qsb, null - **Control Systems**: pendant, gpio, null - **Safety Systems**: gpio, null **null type**: Indicates component is not physically present
  - `hardware_ready_for_initialization` boolean, 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_setup` boolean, 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

## Other responses

- `500` — Internal server error during setup operation

---

[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)