v1
setup
factory
Exit Setup Mode
Exit setup mode and transition system to normal operational state.
FACTORY USE ONLY - This endpoint finalizes factory configuration and enables system operation.
This endpoint completes the setup process by:
- Validating complete configuration - Ensuring all required components are configured
- Transitioning to operational mode - Enabling normal reel control endpoints
- Activating safety systems - Initializing configured hardware safeguards
- Publishing system events - Notifying system of setup completion
Prerequisites for Exiting Setup
Before the system can exit setup mode, ALL components in the manifest must be configured:
- Critical components (motor_driver, cable_encoder) must have valid hardware types
- Optional components can be set to 'null' if not physically present
- Configuration validation ensures all settings are compatible
System State Transition
During Setup Mode:
- Reel operations disabled - Movement, calibration, and control endpoints blocked
- Setup endpoints active - Configuration and status endpoints available
- Safety systems inactive - Hardware not yet initialized
After Exiting Setup:
- Full reel operations enabled - All movement and control endpoints available
- Hardware systems initialized - Configured components become active
- Safety systems operational - Emergency stops, safeguards, and monitoring active
- Setup endpoints disabled - Configuration locked to prevent accidental changes
Error Conditions
The system cannot exit setup mode if:
- Unconfigured components remain - All components must have assigned types
- Invalid configurations detected - Hardware settings fail validation
- Critical hardware missing - Required components (motor_driver) not configured
Factory Completion Workflow
- Configure all system components using setup endpoints
- Verify setup status shows can_exit_setup: true
- Call exit setup endpoint to complete configuration
- Verify normal operations by testing reel control endpoints
- Document final configuration for customer deployment
This endpoint represents the final step in factory configuration before customer delivery.
post/api/v1/setup/exit
Response
Setup mode exit result and operational status
Example response
{
"description": "Successfully transitioned to normal operation",
"summary": "Setup Exit Success",
"value": {
"message": "Successfully exited setup mode",
"success": true
}
}