iot/sprocket-device-illucat
1
0
Fork 0
mirror of https://gitlab.com/zwirbel/illucat.git synced 2025-12-16 01:58:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs, ci

Browse Source
This commit is contained in:
0x1d
2018-09-17 22:54:12 +02:00
parent ba7b1f3dde
commit 0852c2cf96
2 changed files with 31 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,25 +1,23 @@
# Illumination-Cat
## Features
- [50%] Enduser setup: initial setup where the cat opens an access point with a captive portal for configuration
- [100%] WiFi: connect to existing AP as client or build a mesh network where all cats act as a collective
- [30%] Web controls: colors and patterns can be changed
- [100%] Configurable default LED sequence
- [0%] OctoPrint plugin: connect to an OctoPrint instance and reflect print status via colors
- [80%] OTA plugin: cats connected to an AP can be updated over-the-air, either via direct TCP flash or upload of a binary
- [30%] Web controls: colors and patterns can be changed through the web interface
- [20%] easy to flash single binary file
- 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
## Bugs
- when new connections arrive, it somehow switches to defaultAnimation
- animations don't seem to work properly anymore
## Initial Setup
TBD
## Enduser Setup
1. Scan for access points
1. connect to illucat-mesh
1. open web browser with URL ..... TODO open website automatically
1. change stationMode to 1 for connecting the cat to your own AP. leave it 0 to build a mesh.
1. open web browser and navigate to the gateway IP
1. change stationMode to 1 in the Settings section for connecting the cat to your own AP. leave it 0 to build a mesh.
1. change stationSSID and stationPassword to match your AP settings
1. submit and hit restart
1. 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.
1. submit all changes
1. hit restart under the System section
1. illucat connects to your network and can be reached with http://illucat (or any other configured hostname)