diff --git a/README.md b/README.md index c75c8e4..11f374b 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,74 @@ -mqtt-playground -=============== +spejsiot +======== -This repository is a storage for my mqtt and IoT (( ͡° ͜ʖ ͡°)) playground. +This is the repository of hswaw spejsiot project, meant to IoTize EVERYTHING easily. + +This includes simple framework for building appliances compatible with +[Homie MQTT convention](https://github.com/marvinroger/homie), based on cheapo +ESP8266 SoCs and [Sming](https://github.com/SmingHub/Sming). + +It currently supports most of Homie protcol (with `homie/` prefix replaced +by `iot/`), OTA and preliminary SSL support. (provided by Sming itself, currently +not enabled) + +Sample application is present in `switch/` directory. (simple relay device) +For more information take a look at [project wiki page](https://wiki.hackerspace.pl/project:spejsiot). -Hardware --------- +Getting started +--------------- -Current tests involve NodeMCU ESP12-E/ESP8266 boards. Switch is activated with -GPIO0 (FLASH button on NodeMCU) and light is connected to GPIO2, where blue LED -is directly connected on ESP-12E module. - - -Software --------- - -Mosquitto contained in docker is used as a broker. For proper TLS you need to -create self-signed certificate and store its SHA-1 fingerprint in -`common/common_config.h`. - -ESP8266 code uses [patched slaff's -fork of Sming framework](https://github.com/informatic/Sming/tree/patch-1). -(For axTLS support) Set your Wifi configuration in `common/common_config.h` -(used by both `switch` and `light`) - - -Thoughts --------- - -Oh my, that's slow.^W^Wquite fast, when patched properly. + # Create relevant environment variables in your ~/.bashrc + cat >> ~/.bashrc <