transform sketch as a library, and add examples

Author: getlarge

AloesDevice.h

@@ -0,0 +1,67 @@
+#ifndef AloesDevice_h
+#define AloesDevice_h
+
+//	#include <Arduino.h>
+
+#include <FS.h>
+#include <advancedSerial.h>
+
+#include <ESP8266WiFi.h>
+#include <ESP8266WiFiMulti.h>
+#include <ESP8266httpUpdate.h>
+#include <ESP8266mDNS.h>
+//  #include <DNSServer.h>
+#include <TimeLib.h>
+#include <Wire.h>
+
+
+#if CLIENT_SECURE == 1
+#include <WiFiClientSecure.h>
+#endif
+
+#include <ESP8266WebServer.h>
+#include <WiFiManager.h>
+#include <ArduinoJson.h>
+
+#include "lib/Constants.h"
+
+ESP8266WiFiMulti WiFiMulti;
+
+#if CLIENT_SECURE == 0
+WiFiClient wifiClient;
+#elif CLIENT_SECURE == 1
+WiFiClientSecure wifiClient;
+#endif
+
+Config config;
+Message message;
+
+// todo :remove from global but need to change attachInterrupt callback signature ?
+WiFiManager wifiManager;
+
+
+#include "lib/Helpers.cpp"
+Helpers helpers; 
+
+#include "lib/Transport.cpp"
+#if MQTT_CLIENT == 1
+Transport transport(wifiClient); 
+#elif WEB_SERVER == 1
+ESP8266WebServer server(80);
+WiFiClient client = server.client();
+Transport transport(client); 
+#endif
+
+#include "lib/Network.cpp"
+Network network(config); 
+
+#include "lib/Manager.cpp"
+Manager manager(config); 
+
+#include "lib/Aloes.cpp"
+extern Aloes aloes;
+Aloes aloes;
+
+#include "lib/Exec.cpp"
+
+#endif

README.md

@@ -1,6 +1,6 @@
 # Arduino-device-mqtt
 
-ESP8266 arduino sketch to interact with [Aloes backend](https://framagit.org/aloes/device-manager) MQTT API.
+ESP8266 arduino library to interact with [Aloes backend](https://framagit.org/aloes/device-manager) MQTT API.
 
 
 ## Requirements
@@ -13,37 +13,29 @@ Packages for ESP8266
 
 - Enter `http://arduino.esp8266.com/stable/package_esp8266com_index.json` into Additional Board Manager URLs field. 
 
-following libraries are required :
-
-- ArduinoJson
-- Bounce2
-- FS
-- Ticker
-- WifiManager
 
 ## Installation
 
+- Via git, clone into your `~/Arduino/Libraries` folder
 ```
 git clone https://framagit.org/aloes/arduino-device-mqtt.git
 ```
 
+- Via Arduino Library Manager, look for AloesDevice
+
+
 ## Usage
 
 - Open any .ino file of the folder with Arduino IDE
 
 - Edit your preferences in `config.h`
 
-- Upload the code on your ESP8266 board
+- Enter wifi and device credentials or configure the board via the Access Point ( 192.168.244.1 )
 
-#if using MQTT_CLIENT
+- Configure your sensors following [Open Mobile Alliance LwM2M Registry](http://openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html) ( see examples )
 
-- Copy the deviceId ( generated at setup on the serial interface ) to Aloes backend
-
-- Enter wifi and device credentials in `config.h` or configure the board via the Access Point ( 192.168.244.1 )
-
-#endif
+- Upload the code on your ESP8266 board
 
+- Copy the deviceId ( generated at setup on the serial interface ) to Aloes backend
 
-## Reference
 
-- Set resetConfig to true, to restore default state at reset