Each part of the project is contained in it's own directory; all should be self-explanatory, and additionally possess their own README.md.
This is a work in progress, and I'm prone to forgetting about things when I discover something more interesting...!
Complete schematics and design for the device itself.
A platformio project composing of two components:
- Firmware for the ESP8266 based Wifi Control Board;
- firmare for the Arduino Uno based Main Control Board.
See the Hardware directory for more information on the design and function of these two boards.
A simple gateway service to interact with the device, and translate the rather basic API in to something more usable. Able to respond to (and register) webhooks.
Required tools:
platformiogo >=1.15make
For viewing and making changes to any schematics, you will require KiCad.
Upon cloning the repository simply run make init to (a) configure git hooks and (b) extracts all the hardware datasheets.
The Makefile exposes the following commands:
test-gateway- executes both unit tests and formating checks for the gatewaygatewayd- builds the gateway, outputting a binary namedgatewaydtest-firmware-mcu- executes the unit tests for the Main Control Boardtest-firmware-wifi- executes the unit tests for the Wifi Control Board firmwaretest-firmware- executes bothtest-firmware-[mcu|wifi]commands