feat: implement Spore framework class as main orchestration layer
- Add Spore class as unified interface for all core framework functionality - Implement setup() and begin() methods for flexible initialization pattern - Add service registration with addService() for both raw and smart pointers - Provide accessor methods for core components (getTaskManager, getContext, etc.) - Automatically include core services (Node, Network, Cluster, Task) - Update all examples to use simplified Spore framework approach - Fix circular dependency issues in include structure - Remove setHostname and setApiPort configuration methods - Add comprehensive documentation and usage examples The Spore class encapsulates all core functionality from the base example and provides a clean, unified API for the entire framework. Examples now use just spore.setup() -> add services -> spore.begin() -> spore.loop().
This commit is contained in:
45
README.md
45
README.md
@@ -41,6 +41,7 @@ SPORE is a cluster engine for ESP8266 microcontrollers that provides automatic n
|
||||
SPORE uses a modular architecture with automatic node discovery, health monitoring, and distributed task management.
|
||||
|
||||
**Core Components:**
|
||||
- **Spore Framework**: Main framework class that orchestrates all components
|
||||
- **Network Manager**: WiFi connection handling and hostname configuration
|
||||
- **Cluster Manager**: Node discovery, member list management, and health monitoring
|
||||
- **API Server**: HTTP API server with dynamic endpoint registration
|
||||
@@ -58,6 +59,50 @@ SPORE uses a modular architecture with automatic node discovery, health monitori
|
||||
|
||||
📖 **Detailed Architecture:** See [`docs/Architecture.md`](./docs/Architecture.md) for comprehensive system design and implementation details.
|
||||
|
||||
## Quick Start
|
||||
|
||||
The Spore framework provides a simple, unified interface for all core functionality:
|
||||
|
||||
```cpp
|
||||
#include <Arduino.h>
|
||||
#include "Spore.h"
|
||||
|
||||
// Create Spore instance with custom labels
|
||||
Spore spore({
|
||||
{"app", "my_app"},
|
||||
{"role", "controller"}
|
||||
});
|
||||
|
||||
void setup() {
|
||||
spore.setup();
|
||||
spore.begin();
|
||||
}
|
||||
|
||||
void loop() {
|
||||
spore.loop();
|
||||
}
|
||||
```
|
||||
|
||||
**Adding Custom Services:**
|
||||
```cpp
|
||||
void setup() {
|
||||
spore.setup();
|
||||
|
||||
// Create and register custom services
|
||||
RelayService* relayService = new RelayService(spore.getTaskManager(), 2);
|
||||
spore.addService(relayService);
|
||||
|
||||
// Or using smart pointers
|
||||
auto sensorService = std::make_shared<SensorService>();
|
||||
spore.addService(sensorService);
|
||||
|
||||
// Start the API server and complete initialization
|
||||
spore.begin();
|
||||
}
|
||||
```
|
||||
|
||||
**Examples:** See [`examples/base/`](./examples/base/) for basic usage and [`examples/relay/`](./examples/relay/) for custom service integration.
|
||||
|
||||
## API Reference
|
||||
|
||||
The system provides a comprehensive RESTful API for monitoring and controlling the embedded device. All endpoints return JSON responses and support standard HTTP status codes.
|
||||
|
||||
Reference in New Issue
Block a user