add some docs

This commit is contained in:
2018-09-19 16:17:25 +02:00
parent 410804a14e
commit f748ca32c6
2 changed files with 93 additions and 9 deletions

View File

@@ -1,12 +1,5 @@
# 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
This is the brain of the the almighty [Illumination Cat](https://www.thingiverse.com/thing:2974862).
## Initial Setup
TBD
@@ -40,4 +33,12 @@ pixels/brightness
POST /pixel/state
POST /config
### Mesh
### 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