publishing update

Author: Matěj Sychra

.codacy.yml

@@ -0,0 +1,13 @@
+engines:
+ rubocop:
+   enabled: false
+ duplication:
+   enabled: true
+ metrics:
+   enabled: true
+ coverage:
+   enabled: false
+exclude_paths:
+  - lib/ArduinoJson/**
+  - lib/PubSubClient/**
+  - lib/WiFiManager/**

.gitignore

@@ -0,0 +1,8 @@
+.pioenvs/
+
+# developer secret
+thinx-firmware-esp8266/Settings.h
+./.pioenvs/
+.piolibdeps
+.clang_complete
+.gcc-flags.json

README.md

@@ -6,9 +6,11 @@ An Arduino/ESP8266 library to wrap client for OTA updates and RTM (Remote Things
 
 # What's New
 
+* Added Relay example with twin WiFi access variants.
+* Fixes and improved support for timezones. You can set timezone per device on the [RTM Console](https://rtm.thinx.cloud) and current DST will be applied on checkin, if applicable. It will be also used for the SNTP later.
+* HTTPS can be optionally disabled for faster checkins with `THiNX:forceHTTP = true` (speeds up checkin from 120 seconds to 2 seconds)
+* SHA-256 and MD5 firmware validation; currently the MD5 only is supported by ESPhttpUpdate (we're working with Arduino Core team on better implementation)
 * Added setCheckinInterval(long) and setRebootInterval(long) to allow heartbeat and timed restarts (defaults to 24h)
-* Added example that combines THiNX with any other UART device (SigFox) for outage reporting with battery backup
-* Added possibility to set own status string on check-in
 
 # Usage
 
@@ -79,8 +81,6 @@ void loop()
 
 6. Configuration Push can be used to inject custom Environment Variables over the network, without need to have them stored anywhere in the code on the device (e.g. WiFi credentials)
 
-7. You can set `thx.thinx_mqtt_url` after initialization in setup() to DNS/IP address of your own broker 
-
 
 ### Finalize callback
 

docs/esp-firmware.pdf

@@ -1,6 +1,6 @@
 /*
- * THiNX Basic Example with all features
- * 
+ * THiNX Example with all features
+ *
  * - Set your own WiFi credentials for development purposes.
  * - When THiNX finalizes checkin, update device status over MQTT.
  * - Use the `Push Configuration` function in website's action menu to trigger pushConfigCallback() [limit 512 bytes so far]
@@ -21,12 +21,12 @@ THiNX thx;
 
 //
 // Example of using injected Environment variables to change WiFi login credentials.
-// 
+//
 
 void pushConfigCallback (String config) {
 
   // Set MQTT status (unretained)
-  thx.publishStatusUnretained("{ \"status\" : \"push configuration received\"}"); 
+  thx.publishStatusUnretained("{ \"status\" : \"push configuration received\"}");
 
   // Convert incoming JSON string to Object
   DynamicJsonBuffer jsonBuffer(512);
@@ -45,6 +45,7 @@ void pushConfigCallback (String config) {
     if ((strlen(ssid) > 2) && (strlen(pass) > 0)) {
       WiFi.disconnect();
       WiFi.begin(ssid, pass);
+      ssid = ""; pass = "";      
       long timeout = millis() + 20000;
       Serial.println("Attempting WiFi migration...");
       while (WiFi.status() != WL_CONNECTED) {
@@ -74,42 +75,46 @@ void setup() {
   //
   // Static pre-configuration
   //
-  
+
   THiNX::accessPointName = "THiNX-AP";
   THiNX::accessPointPassword = "PASSWORD";
 
   //
   // Initialization
-  // 
-  
+  //
+
+  //THiNX::accessPointName = "THiNX-AP";
+  //THiNX::accessPointPassword = "<enter-ap-mode-password>";
+  THiNX::forceHTTP = true; disable HTTPS to speed-up checkin in development
+
   thx = THiNX(apikey, owner_id);
 
   //
   // App and version identification
-  // 
-  
+  //
+
   // Override versioning with your own app before checkin
   thx.thinx_firmware_version = "ESP8266-THiNX-App-1.0.0";
   thx.thinx_firmware_version_short = "1.0.0";
 
   //
   // Callbacks
-  // 
+  //
 
   // Called after library gets connected and registered.
   thx.setFinalizeCallback([]{
-    Serial.println("*INO: Finalize callback called.");  
-  thx.publishStatus("STATUS:RETAINED"); // set MQTT status (unretained)
+    Serial.println("*INO: Finalize callback called.");
+  thx.publishStatusUnretained("{ \"status\" : \"Hello, world!\" }"); // set MQTT status
   });
 
   // Called when new configuration is pushed OTA
   thx.setPushConfigCallback(pushConfigCallback);
 
   // Callbacks can be defined inline
   thx.setMQTTCallback([](String message) {
-    Serial.println(message);    
+    Serial.println(message);
   });
-       
+
 }
 
 /* Loop must call the thx.loop() in order to pickup MQTT messages and advance the state machine. */