Patrick Balsiger
3cc5405292
ApiServer: add AsyncWebSocket at /ws; accept JSON {event, payload} (string or object) and dispatch via ctx.fire; mirror all local events to clients using NodeContext::onAny.\nNodeContext: add onAny subscriber API.\nNeoPatternService: add api/neopattern/color event to set solid color.\nCluster: centralize cluster/broadcast sending in core; services delegate.\nAPI: add generic /api/node/event and /api/cluster/event endpoints in respective services.\nTests: add ws-color-client, ws-cluster-broadcast-color, http-cluster-broadcast-color.\nDocs: add StreamingAPI.md; update README and test/README.\nFixes: robust WS JSON parsing on ESP8266 and payload handling.
SPORE Documentation
This folder contains comprehensive documentation for the SPORE embedded system.
Available Documentation
📖 API.md
Complete API reference with detailed endpoint documentation, examples, and integration guides.
Includes:
- API endpoint specifications
- Request/response examples
- HTTP status codes
- Integration examples (Python, JavaScript)
- Task management workflows
- Cluster monitoring examples
📖 MonitoringService.md
System resource monitoring API for CPU, memory, filesystem, and uptime.
📖 TaskManagement.md
Complete guide to the task management system with examples and best practices.
Includes:
- Task registration methods (std::bind, lambdas, functions)
- Task control and lifecycle management
- Remote task management via API
- Performance considerations and best practices
- Migration guides and compatibility information
📖 Architecture.md
Comprehensive system architecture and implementation details.
Includes:
- Core component descriptions
- Auto discovery protocol details
- Task scheduling system
- Event system architecture
- Resource monitoring
- Performance characteristics
- Security and scalability considerations
📖 Development.md
Complete development and deployment guide.
Includes:
- PlatformIO configuration
- Filesystem, linker scripts, and flash layout mapping
- Build and flash instructions
- OTA update procedures
- Cluster management commands
- Development workflow
- Troubleshooting guide
- Best practices
📖 StaticFileService.md
Static file hosting over HTTP using LittleFS.
Quick Links
- Main Project: ../README.md
- OpenAPI Specification: ../api/
- Source Code: ../src/
Contributing
When adding new documentation:
- Create a new
.mdfile in this folder - Use clear, descriptive filenames
- Include practical examples and code snippets
- Update this README.md to reference new files
- Follow the existing documentation style
Documentation Style Guide
- Use clear, concise language
- Include practical examples
- Use code blocks with appropriate language tags
- Include links to related documentation
- Use emojis sparingly for visual organization
- Keep README.md files focused and scoped