From 28b42f797c458ce8fec7182e0a086aac1b8d63af Mon Sep 17 00:00:00 2001
From: Paul <paul@derbyshire.nl>
Date: Sun, 27 Oct 2019 23:01:29 +0100
Subject: [PATCH] `publish_always` option.
 https://github.com/proddy/EMS-ESP/issues/224

---
 CHANGELOG.md                |  2 ++
 src/custom.htm              | 15 +++++++++++++++
 src/custom.js               | 14 ++++++++++++++
 src/ems-esp.cpp             | 25 +++++++++++++++++++++++++
 src/version.h               |  2 +-
 tools/wsemulator/wserver.js |  1 +
 6 files changed, 58 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 05747c618..dbc38ac26 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added `publish_always` forcing MQTT topics to be always sent regardless if the data hasn't changed
+
 ### Fixed
 
 ### Changed
diff --git a/src/custom.htm b/src/custom.htm
index d7ca2187c..e97ed54e6 100644
--- a/src/custom.htm
+++ b/src/custom.htm
@@ -122,6 +122,21 @@
         <br>
     </div>
 
+    <div class="row form-group">
+        <label class="col-xs-3">Publish Always<i style="margin-left: 10px;" class="glyphicon glyphicon-info-sign"
+                aria-hidden="true" data-toggle="popover" data-trigger="hover" data-placement="right"
+                data-content="Always send MQTT topics, regardless if the payload hasn't changed"></i></label>
+        <span class="col-xs-9">
+            <form>
+                <label class="radio-inline">
+                    <input type="radio" value="1" name="publish_always">Enabled</label>
+                <label class="radio-inline">
+                    <input type="radio" value="0" name="publish_always" checked>Disabled</label>
+            </form>
+        </span>
+        <br>
+    </div>
+
     <div class="row form-group">
         <label class="col-xs-3">Tx mode<i style="margin-left: 10px;"
                 class="glyphicon glyphicon-exclamation-sign text-danger" aria-hidden="true" data-toggle="popover"
diff --git a/src/custom.js b/src/custom.js
index 93eca92fd..416c7a13e 100644
--- a/src/custom.js
+++ b/src/custom.js
@@ -9,6 +9,7 @@ var custom_config = {
         "shower_timer": false,
         "shower_alert": false,
         "publish_time": 120,
+        "publish_always": false,
         "tx_mode": 1
     }
 };
@@ -23,18 +24,26 @@ function listcustom() {
     if (custom_config.settings.led) {
         $("input[name=\"led\"][value=\"1\"]").prop("checked", true);
     }
+
     if (custom_config.settings.dallas_parasite) {
         $("input[name=\"dallas_parasite\"][value=\"1\"]").prop("checked", true);
     }
+
     if (custom_config.settings.listen_mode) {
         $("input[name=\"listen_mode\"][value=\"1\"]").prop("checked", true);
     }
+
     if (custom_config.settings.shower_timer) {
         $("input[name=\"shower_timer\"][value=\"1\"]").prop("checked", true);
     }
+
     if (custom_config.settings.shower_alert) {
         $("input[name=\"shower_alert\"][value=\"1\"]").prop("checked", true);
     }
+
+    if (custom_config.settings.publish_always) {
+        $("input[name=\"publish_always\"][value=\"1\"]").prop("checked", true);
+    }
 }
 
 function savecustom() {
@@ -66,6 +75,11 @@ function savecustom() {
         custom_config.settings.led = true;
     }
 
+    custom_config.settings.publish_always = false;
+    if (parseInt($("input[name=\"publish_always\"]:checked").val()) === 1) {
+        custom_config.settings.publish_always = true;
+    }
+
     custom_config.settings.publish_time = parseInt(document.getElementById("publish_time").value);
     custom_config.settings.tx_mode = parseInt(document.getElementById("tx_mode").value);
 
diff --git a/src/ems-esp.cpp b/src/ems-esp.cpp
index d12285490..c259f1a68 100644
--- a/src/ems-esp.cpp
+++ b/src/ems-esp.cpp
@@ -89,6 +89,7 @@ typedef struct {
     bool     led;             // LED on/off
     bool     listen_mode;     // stop automatic Tx on/off
     uint16_t publish_time;    // frequency of MQTT publish in seconds
+    bool     publish_always;  // true if publish MQTT regardless if data has changed
     uint8_t  led_gpio;        // pin for LED
     uint8_t  dallas_gpio;     // pin for attaching external dallas temperature sensors
     bool     dallas_parasite; // on/off is using parasite
@@ -113,6 +114,8 @@ static const command_t project_cmds[] PROGMEM = {
     {true, "shower_timer <on | off>", "send MQTT notification on all shower durations"},
     {true, "shower_alert <on | off>", "stop hot water to send 3 cold burst warnings after max shower time is exceeded"},
     {true, "publish_time <seconds>", "set frequency for publishing data to MQTT (0=off)"},
+    {true, "publish_always <on | off>", "set to on to skip payload comparison since last publish"},
+
     {true, "tx_mode <n>", "changes Tx logic. 1=ems generic, 2=ems+, 3=Junkers HT3"},
 
     {false, "info", "show current captured on the devices"},
@@ -527,6 +530,11 @@ void publishValues(bool force) {
         return;
     }
 
+    // override force
+    if (EMSESP_Settings.publish_always) {
+        force = true;
+    }
+
     char                                      s[20] = {0}; // for formatting strings
     StaticJsonDocument<MQTT_MAX_PAYLOAD_SIZE> doc;
     char                                      data[MQTT_MAX_PAYLOAD_SIZE] = {0};
@@ -1026,6 +1034,7 @@ bool LoadSaveCallback(MYESP_FSACTION action, JsonObject settings) {
         EMSESP_Settings.shower_timer    = settings["shower_timer"];
         EMSESP_Settings.shower_alert    = settings["shower_alert"];
         EMSESP_Settings.publish_time    = settings["publish_time"] | DEFAULT_PUBLISHTIME;
+        EMSESP_Settings.publish_always  = settings["publish_always"];
 
         EMSESP_Settings.listen_mode = settings["listen_mode"];
         ems_setTxDisabled(EMSESP_Settings.listen_mode);
@@ -1045,6 +1054,7 @@ bool LoadSaveCallback(MYESP_FSACTION action, JsonObject settings) {
         settings["shower_timer"]    = EMSESP_Settings.shower_timer;
         settings["shower_alert"]    = EMSESP_Settings.shower_alert;
         settings["publish_time"]    = EMSESP_Settings.publish_time;
+        settings["publish_always"]  = EMSESP_Settings.publish_always;
         settings["tx_mode"]         = EMSESP_Settings.tx_mode;
 
         return true;
@@ -1179,6 +1189,19 @@ bool SetListCallback(MYESP_FSACTION action, uint8_t wc, const char * setting, co
             ok                           = true;
         }
 
+        // publish_always
+        if ((strcmp(setting, "publish_always") == 0) && (wc == 2)) {
+            if (strcmp(value, "on") == 0) {
+                EMSESP_Settings.publish_always = true;
+                ok                             = true;
+            } else if (strcmp(value, "off") == 0) {
+                EMSESP_Settings.publish_always = false;
+                ok                             = true;
+            } else {
+                myDebug_P(PSTR("Error. Usage: set publish_always <on | off>"));
+            }
+        }
+
         // tx_mode
         if ((strcmp(setting, "tx_mode") == 0) && (wc == 2)) {
             uint8_t mode = atoi(value);
@@ -1202,6 +1225,7 @@ bool SetListCallback(MYESP_FSACTION action, uint8_t wc, const char * setting, co
         myDebug_P(PSTR("  shower_timer=%s"), EMSESP_Settings.shower_timer ? "on" : "off");
         myDebug_P(PSTR("  shower_alert=%s"), EMSESP_Settings.shower_alert ? "on" : "off");
         myDebug_P(PSTR("  publish_time=%d"), EMSESP_Settings.publish_time);
+        myDebug_P(PSTR("  publish_always=%s"), EMSESP_Settings.publish_always ? "on" : "off");
     }
 
     return ok;
@@ -1878,6 +1902,7 @@ void initEMSESP() {
     EMSESP_Settings.led            = true; // LED is on by default
     EMSESP_Settings.listen_mode    = false;
     EMSESP_Settings.publish_time   = DEFAULT_PUBLISHTIME;
+    EMSESP_Settings.publish_always = false;
     EMSESP_Settings.timestamp      = millis();
     EMSESP_Settings.dallas_sensors = 0;
     EMSESP_Settings.led_gpio       = EMSESP_LED_GPIO;
diff --git a/src/version.h b/src/version.h
index c5400672d..1533a7e99 100644
--- a/src/version.h
+++ b/src/version.h
@@ -1 +1 @@
-#define APP_VERSION "1.9.4b0"
+#define APP_VERSION "1.9.4b1"
diff --git a/tools/wsemulator/wserver.js b/tools/wsemulator/wserver.js
index 1ae6c2be7..e0689365a 100644
--- a/tools/wsemulator/wserver.js
+++ b/tools/wsemulator/wserver.js
@@ -102,6 +102,7 @@ var custom_configfile = {
         "shower_timer": true,
         "shower_alert": false,
         "publish_time": 120,
+        "publish_always": false,
         "tx_mode": 1
     }
 };