Merge pull request #21 from seanlano/add_arduino_projects

Add Arduino projects to GitHub and convert them to PlatformIO projects. Also, add significant detail to the WiLEDProto implementation.

Author: seanlano

.gitignore

@@ -27,3 +27,11 @@
 *.exe
 *.out
 *.app
+
+# PlatformIO things
+.pioenvs
+.piolibdeps
+.clang_complete
+.gcc-flags.json
+.travis.yml
+libraries/readme.txt

README.md

@@ -1,34 +1,41 @@
 # WiLED 
-Arduino and ESP8266 powered controller for a dimmable LED, controlled over Wi-Fi using MQTT. 
 
-This is the Arduino code. 
+WiLED is a project that aims to create a simple but highly effective control system for home (and commercial) lighting applications. 
+
+The main targets are initially stand-alone lamps, i.e. those that connect to a general purpose power outlet. Future goals also include embedded fixed lighting. 
+
+The target hardware is (Arduino-powered) ESP8266 modules for the end devices, and a Feather M0 coupled to a Raspberry Pi Zero W for the coordinator. 
+
+This repository provides the code for WiLED. See the [WiLED-PCB](https://github.com/seanlano/WiLED-pcb) repository for the circuit schematics. 
 
 ## Installation and usage
 
-The code is written for an ATmega328 based Arduino, running at a base clock of 8 MHz - i.e. the 3.3 V versions of the [Arduino Pro Mini](https://www.arduino.cc/en/Main/ArduinoBoardProMini) and similar. It should also work on the 5 V / 16 MHz versions, although level shifting will then be needed on the serial interface with the ESP8266. 
+The code is written for Arduino-powered devices - at the moment, the ESP8266 and the Feather M0. 
 
 *TODO* 
 
 ## Roadmap
 
 The overall goal for WiLED is to provide a flexible system for lighting control, powered by MQTT. 
 
-The current development progress has an ESP8266 for Wi-Fi networking to support MQTT, but in the future this may use something like an XBee radio with MQTT-SN. 
+The current system plan is to use an RFM-69 radio to connect the lighting devices together, and then have a coordinator that interfaces the radio link to an MQTT broker. 
 
 ### Goals
 - Extensible and open system 
   - MQTT interface for integration with other systems 
   - Open source schematics and software 
 - Ability to control multiple light outputs with a single switch or dial, through groups 
 - Separation of lighting output device and control input device, to allow for flexible reconfiguration 
-  - Option to have hardwired controller so lighting is usable even with failure in MQTT network 
-- Tested performance metrics for switching latency 
+  - Option to have hardwired controller so lighting is usable even with failure in radio network 
+- Tested performance metrics for switching latency tm
 - Bindings for OpenHAB 
 
 ## Contributors and thanks 
 
 The Rotary library for Arduino, by Ben Buxton, has been used and the files `Rotary.h` and `Rotary.cpp` are included in this project. [See here for the original source](https://github.com/brianlow/Rotary). It is GPLv3 licensed. 
 
+Additionally, the wonderful RadioHead library from Mike McCauley and AirSpayce has been used via an inclusion through PlatformIO. [See here for the homepage](http://www.airspayce.com/mikem/arduino/RadioHead/index.html). It is GPLv2 licensed (not clear if this is GPLv2 _only_ or GPLv2+). 
+
 ## License
 
 This project is released under the terms of the GNU GPL version 3 (or later). Please see [LICENSE](LICENSE) for details. 

docs/WiLEDProto.md

@@ -57,11 +57,11 @@ Several Message Type specifications are defined, using an 8 bit number. The Mess
 
 The following list details the hexadecimal code and corresponding message type, and then the value that each byte in the payload will contain: 
 
-  - **0x00: Beacon**.
+  - **0x01: Beacon**.
     - Broadcast
     - _4 bytes_
     - `1-4: Device milliseconds uptime (32 bit integer)`
-  - **0x01: Device Status**. 
+  - **0x02: Device Status**. 
     - Broadcast
     - _5 bytes_
     - `1:   Output Level`