What problem does it solve?
Provides a focused, discoverable guide and API reference to implement, extend, and maintain ESP32 firmware for the AutomationOne project, reducing onboarding friction and preventing unsafe GPIO, initialization, and emergency handling mistakes.
Core Features & Use Cases
- Manager API Registry: Centralized signatures and lifecycle guidance for core singletons like GPIOManager, SensorManager, ActuatorManager, MQTTClient and ConfigManager.
- Sensor and Actuator Workflows: Step-by-step patterns for adding sensors, creating IActuatorDriver implementations, registering drivers in the factory, and configuring SensorConfig/ActuatorConfig.
- Safety and Reliability Patterns: Explicit startup order, GPIO safe-mode and pin reservation rules, emergency-stop sequencing, circuit-breaker recommendations, and error-code ranges.
- MQTT and Build Guidance: Topic patterns, QoS guidance, PlatformIO build and flash commands, and testing recommendations for validation.
- Use Case Example: Add a new pump actuator driver, wire it to runtime protection and safety controller, extend TopicBuilder for telemetry, and validate via PlatformIO native tests and serial monitor.
Quick Start
Implement a new pump driver by creating an IActuatorDriver implementation, registering it in the ActuatorManager factory, and running the PlatformIO build from the El Trabajante folder.