From f748ca32c6899319796043fd284f6343cc125203 Mon Sep 17 00:00:00 2001
From: Patrick Balsiger <frupii@gmail.com>
Date: Wed, 19 Sep 2018 16:17:25 +0200
Subject: [PATCH] add some docs

---
 README.md       | 19 +++++------
 installation.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 93 insertions(+), 9 deletions(-)
 create mode 100644 installation.md

diff --git a/README.md b/README.md
index 531b0c7..ac127cb 100644
--- a/README.md
+++ b/README.md
@@ -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
\ No newline at end of file
+### 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
\ No newline at end of file
diff --git a/installation.md b/installation.md
new file mode 100644
index 0000000..590bfc5
--- /dev/null
+++ b/installation.md
@@ -0,0 +1,83 @@
+# Installation
+
+## Initial Setup (TODO)
+- 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
+1. connect to illucat access point
+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. 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)
+
+
+## Install and setup Python
+
+### Linux
+Download udev rules and follow install instructions in rules file.
+
+```
+wget https://raw.githubusercontent.com/platformio/platformio-core/develop/scripts/99-platformio-udev.rules
+```
+
+### MacOs
+{TBD}
+
+### Windows
+download and install python 2.7.x for Windows
+https://www.python.org/downloads/
+
+now open your command shell (start->cmd.exe) 
+type "python" and hit enter
+
+    python
+
+if it starts up the python shell you can type "exit()" and hit enter
+{IMG} python.png
+
+if you get the error message: "'python' is not recognized as an internal or external command,
+operable program or batch file" follow the instructions bellow, then resart your shell and retry the python command
+https://superuser.com/questions/143119/how-do-i-add-python-to-the-windows-path/143121#143121
+
+## Install  Esptool
+
+now open your command shell (start->cmd.exe) 
+type "python -m pip install --upgrade esptool" and hit enter
+
+    python -m pip install --upgrade esptool
+
+{IMG} esptool.png
+
+## Flash Firmware
+
+Extract firmware.bin and spiffs.bin
+
+in the command shell window change to the folder where you extracted the .bin files using cd
+
+flash the firmware with the command "python -m esptool --port **YOUR SERIAL PORT** --baud 115200 write_flash 0x00000 firmware.bin 0x00300000 spiffs.bin"
+hint: you can crank the baudrate up to 921600 bps ;)
+
+    python -m esptool --port COM11 --baud 115200 write_flash 0x00000 firmware.bin 0x00300000 spiffs.bin 
+
+# Configuration after first boot
+
+the esp will build a AP with ssid name **illu** and password **illumination**
+
+when connected browse to **192.168.4.1**
+
+now you can enter the SSID and Password of your WLAN, press save (and may reset the esp)
+
+the Cat should now joined your network
+
+find the ip of your cat in your DHCP table
+
+have fun
+
+
+
+