Merge branch 'dev' into compact-ws

SUPPORT.md

@@ -0,0 +1,8 @@
+# ESPurna Support
+
+If you're looking for support for ESPurna there are some options available:
+
+* [Issues](https://github.com/xoseperez/espurna/issues?utf8=%E2%9C%93&q=is%3Aissue): this is the most dinamic channel at the moment, you might find an answer to your question by searching current or closed issues.
+* [Wiki pages](https://github.com/xoseperez/espurna/wiki): might not be as up-to-date as we all would like (hey, you can also contribute in the documentation!).
+* [Gitter channel](https://gitter.im/tinkerman-cat/espurna): you have better chances to get fast answers from me or other ESPurna users.
+* [Issue a question](https://github.com/xoseperez/espurna/issues/new/choose): as a last resort, you can open new *question* issues on GitHub. Just remember: the more info you provide the more chances you'll have to get an accurate answer.

code/espurna/button.ino

@@ -105,37 +105,61 @@ void buttonEvent(unsigned int id, unsigned char event) {
        }
     #endif
 
-    if (action == BUTTON_MODE_TOGGLE) {
+    if (BUTTON_MODE_TOGGLE == action) {
         if (_buttons[id].relayID > 0) {
             relayToggle(_buttons[id].relayID - 1);
         }
     }
-    if (action == BUTTON_MODE_ON) {
+
+    if (BUTTON_MODE_ON == action) {
         if (_buttons[id].relayID > 0) {
             relayStatus(_buttons[id].relayID - 1, true);
         }
     }
-    if (action == BUTTON_MODE_OFF) {
+
+    if (BUTTON_MODE_OFF == action) {
         if (_buttons[id].relayID > 0) {
             relayStatus(_buttons[id].relayID - 1, false);
         }
     }
-    if (action == BUTTON_MODE_AP) wifiStartAP();
-    #if defined(JUSTWIFI_ENABLE_WPS)
-        if (action == BUTTON_MODE_WPS) wifiStartWPS();
-    #endif // defined(JUSTWIFI_ENABLE_WPS)
-    #if defined(JUSTWIFI_ENABLE_SMARTCONFIG)
-        if (action == BUTTON_MODE_SMART_CONFIG) wifiStartSmartConfig();
-    #endif // defined(JUSTWIFI_ENABLE_SMARTCONFIG)
-    if (action == BUTTON_MODE_RESET) {
+    
+    if (BUTTON_MODE_AP == action) {
+        wifiStartAP();
+    }
+    
+    if (BUTTON_MODE_RESET == action) {
         deferredReset(100, CUSTOM_RESET_HARDWARE);
     }
-    if (action == BUTTON_MODE_FACTORY) {
+
+    if (BUTTON_MODE_FACTORY == action) {
         DEBUG_MSG_P(PSTR("\n\nFACTORY RESET\n\n"));
         resetSettings();
         deferredReset(100, CUSTOM_RESET_FACTORY);
     }
 
+    #if defined(JUSTWIFI_ENABLE_WPS)
+        if (BUTTON_MODE_WPS == action) {
+            wifiStartWPS();
+        }
+    #endif // defined(JUSTWIFI_ENABLE_WPS)
+    
+    #if defined(JUSTWIFI_ENABLE_SMARTCONFIG)
+        if (BUTTON_MODE_SMART_CONFIG == action) {
+            wifiStartSmartConfig();
+        }
+    #endif // defined(JUSTWIFI_ENABLE_SMARTCONFIG)
+    
+    #if LIGHT_PROVIDER != LIGHT_PROVIDER_NONE
+    if (BUTTON_MODE_DIM_UP == action) {
+        lightBrightnessStep(1);
+        lightUpdate(true, true);
+    }
+    if (BUTTON_MODE_DIM_DOWN == action) {
+        lightBrightnessStep(-1);
+        lightUpdate(true, true);
+    }
+    #endif // LIGHT_PROVIDER != LIGHT_PROVIDER_NONE
+
 }
 
 void buttonSetup() {

code/espurna/config/general.h

@@ -235,8 +235,8 @@
 #define HEARTBEAT_REPORT_HOSTNAME   1
 #endif
 
-#ifndef HEARTBEAT_REPORT_DESCRITION
-#define HEARTBEAT_REPORT_DESCRITION 1
+#ifndef HEARTBEAT_REPORT_DESCRIPTION
+#define HEARTBEAT_REPORT_DESCRIPTION 1
 #endif
 
 #ifndef HEARTBEAT_REPORT_APP

code/espurna/config/prototypes.h

@@ -194,6 +194,8 @@ void webRequestRegister(web_request_callback_f callback);
     typedef std::function<bool(const char *, JsonVariant&)> ws_on_receive_callback_f;
     void wsOnReceiveRegister(ws_on_receive_callback_f callback);
 
+    bool wsConnected();
+    bool wsConnected(uint32_t);
     bool wsDebugSend(const char*, const char*);
 #else
     #define ws_on_send_callback_f void *

code/espurna/config/types.h

@@ -48,6 +48,9 @@
 #define BUTTON_MODE_FACTORY         7
 #define BUTTON_MODE_WPS             8
 #define BUTTON_MODE_SMART_CONFIG    9
+#define BUTTON_MODE_DIM_UP          10
+#define BUTTON_MODE_DIM_DOWN        11
+
 
 // Needed for ESP8285 boards under Windows using PlatformIO (?)
 #ifndef BUTTON_PUSHBUTTON

code/espurna/encoder.ino

@@ -105,7 +105,7 @@ void _encoderLoop() {
         // action
         if (encoder.button_pin == GPIO_NONE) {
 
-            // if there is no button, the encoder driver the CHANNEL1
+            // if there is no button, the encoder drives CHANNEL1
             lightChannelStep(encoder.channel1, delta);
 
         } else {

code/espurna/espurna.ino

@@ -64,12 +64,12 @@ void setup() {
     // Init EEPROM
     eepromSetup();
 
-    // Init Serial, SPIFFS and system check
-    systemSetup();
-
     // Init persistance
     settingsSetup();
 
+    // Init Serial, SPIFFS and system check
+    systemSetup();
+
     // Init terminal features
     #if TERMINAL_SUPPORT
         terminalSetup();

code/espurna/homeassistant.ino

@@ -9,6 +9,7 @@ Copyright (C) 2017-2018 by Xose Pérez <xose dot perez at gmail dot com>
 #if HOMEASSISTANT_SUPPORT
 
 #include <ArduinoJson.h>
+#include <queue>
 
 bool _haEnabled = false;
 bool _haSendFlag = false;
@@ -147,9 +148,7 @@ void _haSendSwitches() {
 
 // -----------------------------------------------------------------------------
 
-String _haGetConfig() {
-
-    String output;
+void _haDumpConfig(std::function<void(String&)> printer, bool wrapJson = false) {
 
     #if (LIGHT_PROVIDER != LIGHT_PROVIDER_NONE) || (defined(ITEAD_SLAMPHER))
         String type = String("light");
@@ -163,8 +162,16 @@ String _haGetConfig() {
         JsonObject& config = jsonBuffer.createObject();
         _haSendSwitch(i, config);
 
-        output += "\n" + type + ":\n";
+        String output;
+        output.reserve(config.measureLength() + 32);
+
+        if (wrapJson) {
+            output += "{\"haConfig\": \"";
+        }
+
+        output += "\n\n" + type + ":\n";
         bool first = true;
+
         for (auto kv : config) {
             if (first) {
                 output += "  - ";
@@ -172,11 +179,21 @@ String _haGetConfig() {
             } else {
                 output += "    ";
             }
-            output += kv.key + String(": ") + kv.value.as<String>() + String("\n");
+            output += kv.key;
+            output += ": ";
+            output += kv.value.as<String>();
+            output += "\n";
+        }
+        output += " ";
+
+        if (wrapJson) {
+            output += "\"}";
         }
 
         jsonBuffer.clear();
 
+        printer(output);
+
     }
 
     #if SENSOR_SUPPORT
@@ -187,8 +204,16 @@ String _haGetConfig() {
             JsonObject& config = jsonBuffer.createObject();
             _haSendMagnitude(i, config);
 
-            output += "\nsensor:\n";
+            String output;
+            output.reserve(config.measureLength() + 32);
+
+            if (wrapJson) {
+                output += "{\"haConfig\": \"";
+            }
+
+            output += "\n\nsensor:\n";
             bool first = true;
+
             for (auto kv : config) {
                 if (first) {
                     output += "  - ";
@@ -198,18 +223,25 @@ String _haGetConfig() {
                 }
                 String value = kv.value.as<String>();
                 value.replace("%", "'%'");
-                output += kv.key + String(": ") + value + String("\n");
+                output += kv.key;
+                output += ": ";
+                output += value;
+                output += "\n";
+            }
+            output += " ";
+
+            if (wrapJson) {
+                output += "\"}";
             }
-            output += "\n";
 
             jsonBuffer.clear();
 
+            printer(output);
+
         }
 
     #endif
 
-    return output;
-
 }
 
 void _haSend() {
@@ -241,6 +273,8 @@ void _haConfigure() {
 
 #if WEB_SUPPORT
 
+std::queue<uint32_t> _ha_send_config;
+
 bool _haWebSocketOnReceive(const char * key, JsonVariant& value) {
     return (strncmp(key, "ha", 2) == 0);
 }
@@ -253,11 +287,7 @@ void _haWebSocketOnSend(JsonObject& root) {
 
 void _haWebSocketOnAction(uint32_t client_id, const char * action, JsonObject& data) {
     if (strcmp(action, "haconfig") == 0) {
-        String output = _haGetConfig();
-        output.replace(" ", "&nbsp;");
-        output.replace("\n", "<br />");
-        output = String("{\"haConfig\": \"") + output + String("\"}");
-        wsSend(client_id, output.c_str());
+        _ha_send_config.push(client_id);
     }
 }
 
@@ -268,7 +298,10 @@ void _haWebSocketOnAction(uint32_t client_id, const char * action, JsonObject& d
 void _haInitCommands() {
 
     terminalRegisterCommand(F("HA.CONFIG"), [](Embedis* e) {
-        DEBUG_MSG(_haGetConfig().c_str());
+        _haDumpConfig([](String& data) {
+            DEBUG_MSG(data.c_str());
+        });
+        DEBUG_MSG("\n");
         terminalOK();
     });
 
@@ -296,6 +329,23 @@ void _haInitCommands() {
 
 // -----------------------------------------------------------------------------
 
+#if WEB_SUPPORT
+void _haLoop() {
+    if (_ha_send_config.empty()) return;
+
+    uint32_t client_id = _ha_send_config.front();
+    _ha_send_config.pop();
+
+    if (!wsConnected(client_id)) return;
+
+    // TODO check wsConnected after each "printer" call?
+    _haDumpConfig([client_id](String& output) {
+        wsSend(client_id, output.c_str());
+        yield();
+    }, true);
+}
+#endif
+
 void haSetup() {
 
     _haConfigure();
@@ -304,6 +354,7 @@ void haSetup() {
         wsOnSendRegister(_haWebSocketOnSend);
         wsOnActionRegister(_haWebSocketOnAction);
         wsOnReceiveRegister(_haWebSocketOnReceive);
+        espurnaRegisterLoop(_haLoop);
     #endif
 
     #if TERMINAL_SUPPORT

code/espurna/system.ino

@@ -86,6 +86,12 @@ void _systemSetupHeartbeat() {
     _heartbeat_interval = getSetting("hbInterval", HEARTBEAT_INTERVAL).toInt();
 }
 
+#if WEB_SUPPORT
+    bool _systemWebSocketOnReceive(const char * key, JsonVariant& value) {
+        return (strncmp(key, "hb", 2) == 0);
+    }
+#endif
+
 void systemLoop() {
 
     // -------------------------------------------------------------------------
@@ -182,6 +188,10 @@ void systemSetup() {
         systemCheck(false);
     #endif
 
+    #if WEB_SUPPORT
+        wsOnReceiveRegister(_systemWebSocketOnReceive);
+    #endif
+
     // Init device-specific hardware
     _systemSetupSpecificHardware();
 

code/espurna/utils.ino

@@ -181,7 +181,7 @@ namespace Heartbeat {
             (Relay * (HEARTBEAT_REPORT_RELAY)) | \
             (Light * (HEARTBEAT_REPORT_LIGHT)) | \
             (Hostname * (HEARTBEAT_REPORT_HOSTNAME)) | \
-            (Description * (HEARTBEAT_REPORT_DESCRITION)) | \
+            (Description * (HEARTBEAT_REPORT_DESCRIPTION)) | \
             (App * (HEARTBEAT_REPORT_APP)) | \
             (Version * (HEARTBEAT_REPORT_VERSION)) | \
             (Board * (HEARTBEAT_REPORT_BOARD)) | \

code/espurna/ws.ino

@@ -482,6 +482,10 @@ bool wsConnected() {
     return (_ws.count() > 0);
 }
 
+bool wsConnected(uint32_t client_id) {
+    return _ws.hasClient(client_id);
+}
+
 void wsOnSendRegister(ws_on_send_callback_f callback) {
     _ws_on_send_callbacks.push_back(callback);
 }

code/html/custom.js

@@ -657,7 +657,10 @@ function doScan() {
 }
 
 function doHAConfig() {
-    $("#haConfig").html("");
+    $("#haConfig")
+        .text("")
+        .height(0)
+        .show();
     sendAction("haconfig", {});
     return false;
 }
@@ -1384,7 +1387,11 @@ function processData(data) {
         // -----------------------------------------------------------------------------
 
         if ("haConfig" === key) {
-            $("#haConfig").show();
+            websock.send("{}");
+            $("#haConfig")
+                .append(new Text(value))
+                .height($("#haConfig")[0].scrollHeight);
+            return;
         }
 
         // -----------------------------------------------------------------------------
@@ -1736,6 +1743,8 @@ $(function() {
     $(document).on("change", "input", hasChanged);
     $(document).on("change", "select", hasChanged);
 
+    $("textarea").on("dblclick", function() { this.select(); });
+
     // don't autoconnect when opening from filesystem
     if (window.location.protocol === "file:") { return; }
 

code/html/index.html

@@ -633,13 +633,12 @@
 
                                 <div class="pure-g">
                                     <label class="pure-u-1 pure-u-lg-1-4">Heartbeat message</label>
-                                    <select class="pure-u-1 pure-u-lg-1-4" name="hbMode" tabindex="15" >
+                                    <select class="pure-u-1 pure-u-lg-3-4" name="hbMode" tabindex="15" >
                                         <option value="0">Disabled</option>
                                         <option value="1">On device startup</option>
                                         <option value="2">Repeat after defined interval</option>
                                         <option value="3">Repeat only device status</option>
                                     </select>
-                                    <div class="pure-u-0 pure-u-lg-1-2"></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
                                     <div class="pure-u-1 pure-u-lg-3-4 hint">
                                         Define when heartbeat message will be sent.
@@ -1115,7 +1114,7 @@
                                     </div>
                                 </div>
                                 <div class="pure-g">
-                                    <span class="pure-u-1 terminal" id="haConfig" name="haConfig"></span>
+                                    <textarea class="pure-u-1 terminal" id="haConfig" name="haConfig" wrap="off" readonly></textarea>
                                 </div>
 
 

code/platformio.ini

@@ -435,6 +435,17 @@ build_flags = ${common.build_flags_1m0m} -DITEAD_SONOFF_BASIC -DDHT_SUPPORT=1
 monitor_speed = ${common.monitor_speed}
 extra_scripts = ${common.extra_scripts}
 
+[env:itead-sonoff-basic-r2-dht]
+platform = ${common.platform}
+framework = ${common.framework}
+board = ${common.board_1m}
+board_build.flash_mode = ${common.flash_mode}
+lib_deps = ${common.lib_deps}
+lib_ignore = ${common.lib_ignore}
+build_flags = ${common.build_flags_1m0m} -DITEAD_SONOFF_BASIC -DDHT_SUPPORT=1 -DDHT_PIN=2
+monitor_speed = ${common.monitor_speed}
+extra_scripts = ${common.extra_scripts}
+
 [env:itead-sonoff-basic-dht-ota]
 platform = ${common.platform}
 framework = ${common.framework}
@@ -460,6 +471,17 @@ build_flags = ${common.build_flags_1m0m} -DITEAD_SONOFF_BASIC -DDALLAS_SUPPORT=1
 monitor_speed = ${common.monitor_speed}
 extra_scripts = ${common.extra_scripts}
 
+[env:itead-sonoff-basic-r2-dallas]
+platform = ${common.platform}
+framework = ${common.framework}
+board = ${common.board_1m}
+board_build.flash_mode = ${common.flash_mode}
+lib_deps = ${common.lib_deps}
+lib_ignore = ${common.lib_ignore}
+build_flags = ${common.build_flags_1m0m} -DITEAD_SONOFF_BASIC -DDALLAS_SUPPORT=1 -DDALLAS_PIN=2
+monitor_speed = ${common.monitor_speed}
+extra_scripts = ${common.extra_scripts}
+
 [env:itead-sonoff-rf]
 platform = ${common.platform}
 framework = ${common.framework}