sprocket-device-illucat/README.md

Illumination-Cat

This is the brain of the the almighty Illumination Cat.

API

WebSocket

Endpoint: /pixel

Fields:

Field	Type	Description
topic	String	Defines which functionality is executed, usually to set a value or activate a pattern
payload	String	data to be set

Example:

{
    "topic": "pixels/color",
    "payload": "13505813"
}

Topics

Topic	Data
pixels/color
pixels/color2
pixels/pattern
pixels/totalSteps
pixels/brightness

REST

Endpoints

POST /pixel/state
POST /config

Mesh

Features

• Enduser setup: initial setup where the cat opens an access point for configuration
• WiFi: connect to existing AP as client or build a mesh network where all cats act as a collective
• Web controls: colors and patterns can be changed through the web interface
• OTA plugin: cats connected to an AP can be updated over-the-air via TCP flash method
• [0%] audio output
• [0%] OctoPrint plugin: connect to an OctoPrint instance and reflect print status via colors