sprocket-device-illucat/README.md

Illumination-Cat

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

Initial Setup

TBD

• download and flash firmware and filesystem
• or: rename example.config.json to config.json, build and upload it yourself

Enduser Setup

1. Scan for access points
2. connect to illucat-mesh
3. open web browser and navigate to the gateway IP
4. change stationMode to 1 in the Settings section for connecting the cat to your own AP. leave it 0 to build a mesh.
5. change stationSSID and stationPassword to match your AP settings
6. change the NeoPixel settings according to your hardware. The pin needs to be specified as the pin id of your board, e.g. 4 = D2 on a Wemos D1 Mini.
7. submit all changes
8. hit restart under the System section
9. illucat connects to your network and can be reached with http://illucat (or any other configured hostname)

API

WebSocket

Endpoint: /pixel

Topics

pixels/color pixels/color2 pixels/pattern pixels/totalSteps pixels/brightness

REST

Endpoints

POST /pixel/state
POST /config

Mesh