docs, ci

.gitlab-ci.yml

@@ -0,0 +1,19 @@
+image: python:2.7-stretch
+
+stages:
+  - test
+  - build
+
+before_script:
+  - "pip install -U platformio"
+
+firmware-build:
+  stage: build
+  image: python:2.7-stretch
+  script:
+    - pio run -t clean
+    - pio run
+  artifacts:
+    paths:
+      - .pioenvs/*/firmware.*
+      - .pioenvs/*/spiffs.bin

README.md

@@ -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
+- Enduser setup: initial setup where the cat opens an access point for configuration
-- [100%] WiFi: connect to existing AP as client or build a mesh network where all cats act as a collective  
+- 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 
+- Web controls: colors and patterns can be changed through the web interface  
-- [100%] Configurable default LED sequence  
+- OTA plugin: cats connected to an AP can be updated over-the-air via TCP flash method
-- [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  
 - [0%] audio output  
+- [0%] OctoPrint plugin: connect to an OctoPrint instance and reflect print status via colors
 
-## Bugs
+## Initial Setup
-- when new connections arrive, it somehow switches to defaultAnimation
+TBD  
-- animations don't seem to work properly anymore
 
 ## Enduser Setup
 1. Scan for access points
 1. connect to illucat-mesh
-1. open web browser with URL ..... TODO open website automatically
+1. open web browser and navigate to the gateway IP
-1. change stationMode to 1 for connecting the cat to your own AP. leave it 0 to build a mesh.
+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)