From 465b5230ff707e83b98ef5ed2b1a9fce815b753c Mon Sep 17 00:00:00 2001 From: Martins Ierags Date: Sun, 6 Jan 2019 17:23:05 +0200 Subject: [PATCH] Configure Heartbeat & option HEARTBEAT_REPEAT_STATUS: - Heartbeat mode and interval configuration added to WebUI ADMIN page - New option HEARTBEAT_REPEAT_STATUS: on device startup full heartbeat information and after HEARTBEAT_INTERVAL only STATUS report. - Enhanced first heartbeat message - on device startup it will send heartbeat after ntpSynced will be true to get device time. P.S. Code is tested. Web part is not compiled, and not tested. I hope it will work :) --- code/espurna/config/general.h | 1 + code/espurna/system.ino | 36 ++++++++++++++++++++++++++--------- code/espurna/utils.ino | 20 +++++++++++++------ code/espurna/ws.ino | 2 ++ code/html/index.html | 30 ++++++++++++++++++++++++++++- 5 files changed, 73 insertions(+), 16 deletions(-) diff --git a/code/espurna/config/general.h b/code/espurna/config/general.h index b79c6523..7b5d23fd 100644 --- a/code/espurna/config/general.h +++ b/code/espurna/config/general.h @@ -169,6 +169,7 @@ #define HEARTBEAT_NONE 0 // Never send heartbeat #define HEARTBEAT_ONCE 1 // Send it only once upon MQTT connection #define HEARTBEAT_REPEAT 2 // Send it upon MQTT connection and every HEARTBEAT_INTERVAL +#define HEARTBEAT_REPEAT_STATUS 3 // Send it upon MQTT connection and every HEARTBEAT_INTERVAL only STATUS report // Backwards compatibility check #if defined(HEARTBEAT_ENABLED) && (HEARTBEAT_ENABLED == 0) diff --git a/code/espurna/system.ino b/code/espurna/system.ino index 6afd96b2..7d015bb8 100644 --- a/code/espurna/system.ino +++ b/code/espurna/system.ino @@ -12,6 +12,8 @@ Copyright (C) 2018 by Xose Pérez unsigned long _loop_delay = 0; bool _system_send_heartbeat = false; +unsigned char _heartbeat_mode = HEARTBEAT_MODE; +unsigned long _heartbeat_interval = HEARTBEAT_INTERVAL; // Calculated load average 0 to 100; unsigned short int _load_average = 100; @@ -66,6 +68,10 @@ void systemSendHeartbeat() { _system_send_heartbeat = true; } +bool systemGetHeartbeat() { + return _system_send_heartbeat; +} + unsigned long systemLoopDelay() { return _loop_delay; } @@ -75,6 +81,13 @@ unsigned long systemLoadAverage() { return _load_average; } +void _systemSetupHeartbeat() { + if (getSetting("hbMode").length() == 0) setSetting("hbMode", HEARTBEAT_MODE); + if (getSetting("hbInterval").length() == 0) setSetting("hbInterval", HEARTBEAT_INTERVAL); + _heartbeat_mode = getSetting("hbMode", HEARTBEAT_MODE).toInt(); + _heartbeat_interval = getSetting("hbInterval", HEARTBEAT_INTERVAL).toInt(); +} + void systemLoop() { // ------------------------------------------------------------------------- @@ -97,19 +110,21 @@ void systemLoop() { // Heartbeat // ------------------------------------------------------------------------- - #if HEARTBEAT_MODE == HEARTBEAT_ONCE - if (_system_send_heartbeat) { - _system_send_heartbeat = false; - heartbeat(); - } - #elif HEARTBEAT_MODE == HEARTBEAT_REPEAT + if (_system_send_heartbeat && _heartbeat_mode == HEARTBEAT_ONCE) { + heartbeat(); + _system_send_heartbeat = false; + } else if (_heartbeat_mode == HEARTBEAT_REPEAT || _heartbeat_mode == HEARTBEAT_REPEAT_STATUS) { static unsigned long last_hbeat = 0; - if (_system_send_heartbeat || (last_hbeat == 0) || (millis() - last_hbeat > HEARTBEAT_INTERVAL)) { - _system_send_heartbeat = false; + #if NTP_SUPPORT + if ((_system_send_heartbeat && ntpSynced()) || (millis() - last_hbeat > _heartbeat_interval)) { + #else + if (_system_send_heartbeat || (millis() - last_hbeat > _heartbeat_interval)) { + #endif last_hbeat = millis(); heartbeat(); + _system_send_heartbeat = false; } - #endif // HEARTBEAT_MODE == HEARTBEAT_REPEAT + } // ------------------------------------------------------------------------- // Load Average calculation @@ -179,4 +194,7 @@ void systemSetup() { // Register Loop espurnaRegisterLoop(systemLoop); + // Cache Heartbeat values + _systemSetupHeartbeat(); + } diff --git a/code/espurna/utils.ino b/code/espurna/utils.ino index 4903082f..9d9768bf 100644 --- a/code/espurna/utils.ino +++ b/code/espurna/utils.ino @@ -58,6 +58,14 @@ String getCoreRevision() { #endif } +unsigned char getHeartbeatMode() { + return getSetting("hbMode", HEARTBEAT_MODE).toInt(); +} + +unsigned char getHeartbeatInterval() { + return getSetting("hbInterval", HEARTBEAT_INTERVAL).toInt(); +} + // WTF // Calling ESP.getFreeHeap() is making the system crash on a specific // AiLight bulb, but anywhere else... @@ -135,8 +143,6 @@ unsigned long getUptime() { } -#if HEARTBEAT_MODE != HEARTBEAT_NONE - // ----------------------------------------------------------------------------- // Heartbeat helper // ----------------------------------------------------------------------------- @@ -196,6 +202,7 @@ void heartbeat() { unsigned int free_heap = getFreeHeap(); #if MQTT_SUPPORT + unsigned char _heartbeat_mode = getHeartbeatMode(); bool serial = !mqttConnected(); #else bool serial = true; @@ -224,9 +231,9 @@ void heartbeat() { // ------------------------------------------------------------------------- #if MQTT_SUPPORT - if (!serial) { + if (!serial && (_heartbeat_mode == HEARTBEAT_REPEAT || systemGetHeartbeat())) { if (hb_cfg & Heartbeat::Interval) - mqttSend(MQTT_TOPIC_INTERVAL, String(HEARTBEAT_INTERVAL / 1000).c_str()); + mqttSend(MQTT_TOPIC_INTERVAL, String(getHeartbeatInterval() / 1000).c_str()); if (hb_cfg & Heartbeat::App) mqttSend(MQTT_TOPIC_APP, APP_NAME); @@ -280,7 +287,10 @@ void heartbeat() { if (hb_cfg & Heartbeat::Loadavg) mqttSend(MQTT_TOPIC_LOADAVG, String(systemLoadAverage()).c_str()); + } else if (!serial && _heartbeat_mode == HEARTBEAT_REPEAT_STATUS) { + mqttSend(MQTT_TOPIC_STATUS, MQTT_STATUS_ONLINE, true); } + #endif // ------------------------------------------------------------------------- @@ -300,8 +310,6 @@ void heartbeat() { } -#endif /// HEARTBEAT_MODE != HEARTBEAT_NONE - // ----------------------------------------------------------------------------- // INFO // ----------------------------------------------------------------------------- diff --git a/code/espurna/ws.ino b/code/espurna/ws.ino index 995624f0..aa329e38 100644 --- a/code/espurna/ws.ino +++ b/code/espurna/ws.ino @@ -350,6 +350,8 @@ void _wsOnStart(JsonObject& root) { #if TERMINAL_SUPPORT root["cmdVisible"] = 1; #endif + root["hbMode"] = getSetting("hbMode", HEARTBEAT_MODE).toInt(); + root["hbInterval"] = getSetting("hbInterval", HEARTBEAT_INTERVAL).toInt(); } diff --git a/code/html/index.html b/code/html/index.html index 69b65202..9d8f6ede 100644 --- a/code/html/index.html +++ b/code/html/index.html @@ -620,6 +620,34 @@
Request password when starting telnet session
+
+ + +
+
+
+ HEARTBEAT_NONE: no heartbeat at all, never.
+ HEARTBEAT_ONCE: only on device startup.
+ HEARTBEAT_REPEAT: on device startup and after HEARTBEAT_INTERVAL.
+ HEARTBEAT_REPEAT_STATUS: on device startup full heartbeat information and after HEARTBEAT_INTERVAL only STATUS report. +
+
+ +
+ + +
+
+
+ This is the interval in ms how often to send the heartbeat message. +
+
+
@@ -629,7 +657,7 @@
The device has bytes available for OTA updates. If your image is larger than this consider doing a two-step update.
- +