mirror of
https://gitlab.com/zwirbel/illucat.git
synced 2025-12-15 01:42:22 +01:00
b566aa7b5b108fd54d1eb25af3f325acd10f8a49
Illumination-Cat
This is the brain of the the almighty Illumination Cat.
Initial Setup
TBD
- download and flash firmware and filesystem
- or: rename example.config.json to config.json, build and upload it yourself
Enduser Setup
- Scan for access points
- connect to illucat-mesh
- open web browser and navigate to the gateway IP
- change stationMode to 1 in the Settings section for connecting the cat to your own AP. leave it 0 to build a mesh.
- change stationSSID and stationPassword to match your AP settings
- 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.
- submit all changes
- hit restart under the System section
- 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
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
Description
Languages
HTML
25.2%
CSS
21.7%
C++
21.4%
C
14.5%
JavaScript
12.4%
Other
4.8%