SPORE

Quick Start

#include <Arduino.h>
#include "spore/Spore.h"
#include "spore/Service.h"
#include "spore/core/ApiServer.h"
#include "spore/core/TaskManager.h"

class HelloService : public Service {
public:
    HelloService() {}

    const char* getName() const override { return "hello"; }

    void registerEndpoints(ApiServer& api) override {
        api.addEndpoint("/api/hello", HTTP_GET, [](AsyncWebServerRequest* req) {
            req->send(200, "application/json", "{\"message\":\"hello\"}");
        });
    }

    void registerTasks(TaskManager& taskManager) override {
        taskManager.registerTask("heartbeat", 1000, [this]() { this->heartbeat(); });
    }

private:
    void heartbeat() {
        // e.g., blink LED, publish telemetry, etc.
    }
};

Spore spore({
    {"app", "my_app"},
    {"role", "controller"}
});

void setup() {
    spore.setup();
    spore.addService(new HelloService());
    spore.begin();
}

void loop() {
    spore.loop();
}

Technical Specifications

• Supported Hardware: ESP-01/ESP-01S (1MB Flash), Wemos D1 (4MB Flash)
• Discovery Protocol: UDP broadcast on port 4210
• API Interface: RESTful HTTP + WebSocket streaming
• Dependencies: ESPAsyncWebServer, ArduinoJson
• Framework: Arduino with PlatformIO build system

Explore applications that extend SPORE.

• LEDLab — Real-time LED matrix animation streaming and visual preset editor

Firmware Requirements

LEDLab requires SPORE nodes running the PixelStreamController firmware, which handles UDP-based RGB data streaming to NeoPixel strips and matrices. The firmware subscribes to udp/raw cluster events and converts incoming hex-encoded pixel data into real-time LED animations.

Key firmware features include support for both strip and matrix configurations, serpentine (zig-zag) wiring patterns, and configurable pixel counts, brightness, and matrix dimensions. The controller automatically remaps pixel coordinates for proper matrix display.

See PixelStream documentation for more information.

Capabilities

• Multi-node management with individual control
• Real-time canvas preview for each node
• 10+ built-in animation presets (rainbow, lava lamp, aurora, etc.)
• Visual preset editor with reusable building blocks
• Live parameter control with instant feedback
• Import/export custom presets as JSON
• Auto-discovery of SPORE nodes on network
• Configurable FPS (1-60) and matrix dimensions
• Requires SPORE nodes running PixelStreamController

Building Blocks