Added wifi/mqtt reconnection and resubscription

components/firmware/include/nx/firmware/MqttClient.h

@@ -31,10 +31,12 @@ typedef struct MqttSettings
   MqttErrorCallback errorCb;
 } MqttSettings;
 
-void nxStartMqttClient(const MqttSettings* settings);
+bool nxStartMqttClient(const MqttSettings* settings);
 
 bool nxMqttSubscribe(const char* topic, uint8_t qos);
 
-uint32_t nxMqttPublish(const char* topic, uint8_t qos, const char* data, size_t size, uint8_t retain);
+int32_t nxMqttPublish(const char* topic, uint8_t qos, const char* data, size_t size, uint8_t retain);
+
+bool nxMqttIsConnected(void);
 
 #endif /* COMPONENTS_FIRMWARE_INCLUDE_NX_FIRMWARE_MQTTCLIENT_H_ */

components/firmware/src/MqttClient.c

@@ -16,6 +16,9 @@
 
 #define UNUSED(x) (void)(x)
 
+#define RECONNECTION_TIMEOUT_MS 5000
+#define KEEPALIVE_SEC 30 // broker ping
+
 static const char* TAG = "MQTT";
 
 static const MqttSettings* settings = NULL;
@@ -84,13 +87,13 @@ static void mqtt_event_handler(void *handler_args, esp_event_base_t base, int32_
 // --------- Public API --------- //
 
 
-void nxStartMqttClient(const MqttSettings* mqttSettings)
+bool nxStartMqttClient(const MqttSettings* mqttSettings)
 {
   ESP_LOGI(TAG, "Initializing MQTT");
 
   if (strlen(mqttSettings->brokerAddr) == 0) {
     ESP_LOGW(TAG, "Empty broker address, skipping MQTT initialization");
-    return;
+    return false;
   }
 
   settings = mqttSettings;
@@ -103,9 +106,15 @@ void nxStartMqttClient(const MqttSettings* mqttSettings)
   mqtt_cfg.username  = settings->user;
   mqtt_cfg.password  = settings->password;
 
+  mqtt_cfg.disable_clean_session = false;
+  mqtt_cfg.disable_auto_reconnect = false;
+  mqtt_cfg.reconnect_timeout_ms = RECONNECTION_TIMEOUT_MS;
+  mqtt_cfg.refresh_connection_after_ms = 0;
+  mqtt_cfg.keepalive = KEEPALIVE_SEC;
+
   esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
   esp_mqtt_client_register_event(client, ESP_EVENT_ANY_ID, mqtt_event_handler, client);
-  esp_mqtt_client_start(client);
+  return esp_mqtt_client_start(client) == ESP_OK;
 }
 
 bool nxMqttSubscribe(const char* topic, uint8_t qos)
@@ -117,17 +126,18 @@ bool nxMqttSubscribe(const char* topic, uint8_t qos)
 
   int msg_id = esp_mqtt_client_subscribe(clientHandle, settings->apiTopic, qos);
   if (msg_id == -1) {
-    ESP_LOGE(TAG, "Subscribtion of topic %s failed", topic);
+    ESP_LOGE(TAG, "Subscription of topic %s failed", topic);
     if (settings->errorCb) {
       settings->errorCb();
     }
     return false;
   }
 
+  ESP_LOGI(TAG, "Subscription of topic %s done", topic);
   return true;
 }
 
-uint32_t nxMqttPublish(const char* topic, uint8_t qos, const char* data, size_t size, uint8_t retain)
+int32_t nxMqttPublish(const char* topic, uint8_t qos, const char* data, size_t size, uint8_t retain)
 {
   if (!clientHandle) {
     ESP_LOGE(TAG, "MQTT client not initialized, aborting data publishing in topic %s", topic);
@@ -136,3 +146,7 @@ uint32_t nxMqttPublish(const char* topic, uint8_t qos, const char* data, size_t
   return esp_mqtt_client_publish(clientHandle, topic, data, size, qos, retain);
 }
 
+bool nxMqttIsConnected(void)
+{
+  return clientHandle != NULL;
+}

components/software/include/nx/software/AppSettings.h

@@ -8,8 +8,8 @@
 #define WIFI_STRINGS_MAX_LEN 32
 #define URI_MAX_SIZE 64
 #define USER_DATA_MAX_SIZE 16
-#define CA_CERT_MAX_SIZE 1500
 #define DEVICE_NAME_MAX_LEN 64
+#define CA_CERT_MAX_SIZE 1500
 
 typedef bool (*StorageReadFn)(const char* key, void* data, size_t size);
 
@@ -24,10 +24,10 @@ typedef struct AppSettings {
   char mqttUser[USER_DATA_MAX_SIZE];
   char mqttPassword[USER_DATA_MAX_SIZE];
   uint16_t mqttHbIntervalSec;
-  uint8_t mqttUseTls;
-  char caCert[CA_CERT_MAX_SIZE];
+  bool mqttUseTls;
   bool overrideDevName;
   char customDevName[DEVICE_NAME_MAX_LEN];
+  char caCert[CA_CERT_MAX_SIZE];
 } AppSettings;
 
 

components/software/src/AppSettings.c

@@ -76,7 +76,10 @@ void nxInitAppSettings(StorageWriteFn writeFn,
   settingsUpdatedCb = updateCb;
 
   if (firstRun()) {
+    SettingsUpdatedCb cb = settingsUpdatedCb;
+    settingsUpdatedCb = NULL; // skip callback during first init
     nxRestoreAppDefaultSettings();
+    settingsUpdatedCb = cb;
   }
   else {
     loadSettings();
@@ -95,16 +98,16 @@ void nxRestoreAppDefaultSettings(void)
   printf("Restoring DEFAULT application settings\n");
   settings.mqttHbIntervalSec = DEFAULT_MQTT_HB_SEC;
   settings.mqttUseTls        = DEFAULT_MQTT_TLS;
+  settings.overrideDevName   = DEFAULT_OV_DEVNAME;
 
   strcpy(settings.mqttHbUri       , DEFAULT_MQTT_HB_URI   );
   strcpy(settings.mqttApiUri      , DEFAULT_MQTT_API_URI  );
   strcpy(settings.mqttHost        , DEFAULT_MQTT_HOST     );
   strcpy(settings.mqttUser        , DEFAULT_MQTT_USER     );
   strcpy(settings.mqttPassword    , DEFAULT_MQTT_PASS     );
-  strcpy(settings.caCert          , DEFAULT_CA_CERT       );
   strcpy(settings.customDevName   , DEFAULT_CUSTOM_DEVNAME);
+  strcpy(settings.caCert          , DEFAULT_CA_CERT       );
 
-  settings.overrideDevName = DEFAULT_OV_DEVNAME;
 
   nxWriteAppSettings();
 }

components/software/src/SystemSettingsApi.c

@@ -104,8 +104,8 @@ void nxApiGetSystemSettings(const uint8_t* msg, size_t msgLen,
   sprintf(responseBuffer,
       "{"
       "\"%s\":\"%s\", " // ssid
-      "\"%s\":%s, " // power save
-      "\"%s\":%s, " // use static ip
+      "\"%s\":%i, " // power save
+      "\"%s\":%i, " // use static ip
       "\"%s\":\"%i.%i.%i.%i\", " // ip
       "\"%s\":\"%i.%i.%i.%i\", " // gw
       "\"%s\":\"%i.%i.%i.%i\"," // mask
@@ -116,8 +116,8 @@ void nxApiGetSystemSettings(const uint8_t* msg, size_t msgLen,
       "\"%s\":\"%s\"" // dn
       "}",
       API_KEY_SSID, settings->wifiSsid,
-      API_KEY_WPWSAVE, settings->wifiPowerSave ? "true" : "false",
-      API_KEY_USE_STATIC, settings->useStaticAddr ? "true" : "false",
+      API_KEY_WPWSAVE, settings->wifiPowerSave,
+      API_KEY_USE_STATIC, settings->useStaticAddr,
       API_KEY_IPV4ADDR, settings->ip4addr[0], settings->ip4addr[1], settings->ip4addr[2], settings->ip4addr[3],
       API_KEY_IPV4GW, settings->ip4gw[0], settings->ip4gw[1], settings->ip4gw[2], settings->ip4gw[3],
       API_KEY_IPV4MASK, settings->ip4mask[0], settings->ip4mask[1], settings->ip4mask[2], settings->ip4mask[3],

main/Main.c

@@ -45,6 +45,9 @@ static AppSettings* appSettings = NULL;
 static WifiSettings wifiSettings;
 static MqttSettings mqttSettings;
 
+static bool wifiStarted = false;
+static bool mqttStarted = false;
+
 static const MqTriggerHttpCallbacks httpCallbacks = {
     .getRoot = rootHandler,
     .getJs = jsHandler,
@@ -66,12 +69,22 @@ void app_main(void)
 
   nxInitStorage();
 
+  // uncomment to force default NVS initialization for development
+//  uint8_t zero = 0;
+//  nxStorageWrite("ledinit", &zero, 1);
+//  nxStorageWrite("sysinit", &zero, 1);
+
   nxInitSystemSettings(nxStorageWrite, nxStorageRead);
   nxInitAppSettings(nxStorageWrite, nxStorageRead, onAppSettingsUpdate);
 
   systemSettings = nxGetSystemSettings();
   appSettings = nxGetAppSettings();
 
+  // uncomment to force WiFi settings for development
+//  strcpy(systemSettings->wifiSsid, "androidAp");
+//  strcpy(systemSettings->wifiPassword, "password");
+//  systemSettings->useStaticAddr = false;
+
   nxStartRestarter(systemSettings->rsSchedule, systemSettings->tzEnv);
 
   nxSetWifiConnectedCallback(onWifiConnected);
@@ -83,9 +96,6 @@ void app_main(void)
 
 static void startWifi(void)
 {
-  systemSettings->useStaticAddr = true;
-  systemSettings->ip4addr[3] = 91;
-
   wifiSettings = (struct WifiSettings){
     .wname = systemSettings->wifiSsid,
         .wpass = systemSettings->wifiPassword,
@@ -106,6 +116,13 @@ static void startWifi(void)
 
 static void onWifiConnected(void)
 {
+  nxUpdateStatus(STATUS_OK);
+
+  if (wifiStarted) {
+    return;
+  }
+
+  wifiStarted = true;
   systemSettings->deviceName = nxGetWifiDeviceName();
 
   nxInitSntpClient(SNTP_RETRIES, systemSettings->sntpAddr, systemSettings->tzEnv);
@@ -127,7 +144,9 @@ static void onWifiConnected(void)
   mqttSettings.disconnectedCb = onMqttDisconnected;
   mqttSettings.errorCb = onMqttError;
 
-  nxStartMqttClient(&mqttSettings);
+  if (!nxStartMqttClient(&mqttSettings)) {
+    onMqttError();
+  }
 
   nxSetMqTriggerHttpCallbacks(&httpCallbacks);
   nxStartMqTriggerHttpServer();
@@ -154,8 +173,14 @@ static void onWifiError()
 static void onMqttConnected()
 {
   ESP_LOGI(TAG, "MQTT CONNECTED");
-  if (nxMqttSubscribe(appSettings->mqttApiUri, API_QOS)) {
+
+  if (!mqttStarted) {
     xTaskCreate(&hbTask, "hb_task", 2048, NULL, 1, NULL);
+    mqttStarted = true;
+  }
+
+  // (re)subscribe
+  if (nxMqttSubscribe(appSettings->mqttApiUri, API_QOS)) {
     nxUpdateStatus(STATUS_OK);
   }
 }
@@ -186,16 +211,23 @@ static void hbTask(void* param)
   }
 
   while (1) {
-    ESP_LOGI(TAG, "Sending MQTT heartbeat");
-
-    char timeStr[DT_FORMAT_LEN];
-    nxGetTimeStr(timeStr);
-    char hbMessage[DT_FORMAT_LEN + strlen(nxGetWifiDeviceName()) + 2];
-    strcpy(hbMessage, nxGetWifiDeviceName());
-    strcat(hbMessage, " ");
-    strcat(hbMessage, timeStr);
-
-    nxMqttPublish(appSettings->mqttHbUri, HB_QOS, hbMessage, strlen(hbMessage), 1);
+    if (nxMqttIsConnected()) {
+      ESP_LOGI(TAG, "Sending MQTT heartbeat");
+
+      char timeStr[DT_FORMAT_LEN];
+      nxGetTimeStr(timeStr);
+      char hbMessage[DT_FORMAT_LEN + strlen(nxGetWifiDeviceName()) + 2];
+      strcpy(hbMessage, nxGetWifiDeviceName());
+      strcat(hbMessage, " ");
+      strcat(hbMessage, timeStr);
+
+      if(nxMqttPublish(appSettings->mqttHbUri, HB_QOS, hbMessage, strlen(hbMessage), 1) < 0) {
+        ESP_LOGE(TAG, "Cannot publish heartbeat message");
+      }
+    }
+    else {
+      ESP_LOGW(TAG, "Skipping MQTT heartbeat due to the disconnected client");
+    }
 
     vTaskDelay(appSettings->mqttHbIntervalSec*1000 / portTICK_PERIOD_MS);
   }

main/static/app.html

@@ -16,13 +16,13 @@
   </p>
 
   <p>
-    <label>Heartbeat topic [TODO]:
+    <label>Heartbeat topic:
       <input type="text" name="mqhb">
     </label>
   </p>
 
   <p>
-    <label>Heartbeat interval (sec) [TODO]
+    <label>Heartbeat interval (sec)
       <input type="number" name="mqhbs">
     </label>
   </p>

main/static/index.html

@@ -33,7 +33,7 @@
   <footer>
     <div class="col-sm col-md-10 col-md-offset-1">
       <p>
-        Copyright &copy; Łukasz Chodyła 2022
+        MqTrigger v1.1 2022
       </p>
     </div>
   </footer>

main/static/index.js

@@ -71,7 +71,24 @@ function loadContent(url) {
   http.send();
 }
 
+function fillInputs(element, jsonString) {
+  let obj = JSON.parse(jsonString);
+  if (obj) {
+    for (var key of Object.keys(obj)) {
+      console.log(key + " -> " + obj[key])
+      let input = element.querySelector("[name='" + key + "'");
+      if (input) { //TODO: checkbox/radio
+        input.value = obj[key];
+        if (input.hasAttribute('data-onset')) {
+          eval(input.getAttribute("data-onset"));
+        }
+      }
+    }
+  }
+}
+
 function loadValues(element) {
+  valuesCache = {};
 
   const forms = element.querySelectorAll('form');
   for (i = 0; i < forms.length; ++i) {
@@ -82,20 +99,7 @@ function loadValues(element) {
 
     if (valuesCache[srcUrl]) {
       console.log("Source values already cached: " + valuesCache[srcUrl]);
-      //TODO: dry
-      let obj = JSON.parse(valuesCache[srcUrl]);
-      if (obj) {
-        for (var key of Object.keys(obj)) {
-          console.log(key + " -> " + obj[key])
-          let input = element.querySelector("[name='" + key + "'");
-          if (input) { //TODO: checkbox/radio
-            input.value = obj[key];
-            if (input.hasAttribute('data-onset')) {
-              eval(input.getAttribute("data-onset"));
-            }
-          }
-        }
-      }
+      fillInputs(element, valuesCache[srcUrl]);
       continue;
     }
 
@@ -111,21 +115,7 @@ function loadValues(element) {
       if (http.readyState == 4 && http.status == 200) {
         console.log("Values received: " + http.responseText);
         valuesCache[srcUrl] = http.responseText;
-
-        //TODO: dry
-        let obj = JSON.parse(http.responseText);
-        if (obj) {
-          for (var key of Object.keys(obj)) {
-            console.log(key + " -> " + obj[key])
-            let input = element.querySelector("[name='" + key + "'");
-            if (input) { //TODO: checkbox/radio
-              input.value = obj[key];
-              if (input.hasAttribute('data-onset')) {
-                eval(input.getAttribute("data-onset"));
-              }
-            }
-          }
-        }
+        fillInputs(element, http.responseText);
       }
     }
     http.send();

main/static/min/app.html

@@ -1,7 +1,7 @@
 <h1>Application settings</h1><h3>MQTT settings</h3><form id=app-settings action=/app data-values-src=/app><p><label>MQTT host address:
 <input name=mqhost></label><p><label>API topic:
-<input name=mqapi></label><p><label>Heartbeat topic [TODO]:
-<input name=mqhb></label><p><label>Heartbeat interval (sec) [TODO]
+<input name=mqapi></label><p><label>Heartbeat topic:
+<input name=mqhb></label><p><label>Heartbeat interval (sec)
 <input type=number name=mqhbs></label><p><label>User name:
 <input name=mquser></label><p><label>Password:
 <input type=password name=mqpass></label><p><label class=label>Use TLS:

main/static/min/index.html

@@ -1,2 +1,2 @@
 <meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon type=image/png href=data:image/png,%89PNG%0D%0A%1A%0A><link rel=stylesheet href=index.css><script src=index.js></script><header class="sticky row"><div class="col-sm col-md-10 col-md-offset-1"><a id=app-btn href=# role=button class=nav-btn data-dst=/app/form>App</a>
-<a href=# role=button class=nav-btn data-dst=/sys/form>System</a></div></header><div class=container><div class="row cols-sm-12 cols-md-10"><div class=col-md-offset-1 id=content><h1>Loading</h1><p>Loading content... Please make sure that JavaScript is enabled.</div><div class=col-md-offset-1><hr></div></div></div><footer><div class="col-sm col-md-10 col-md-offset-1"><p>Copyright &copy; Łukasz Chodyła 2022</div></footer><script>initNavButtons();document.getElementById('app-btn').click();</script>
+<a href=# role=button class=nav-btn data-dst=/sys/form>System</a></div></header><div class=container><div class="row cols-sm-12 cols-md-10"><div class=col-md-offset-1 id=content><h1>Loading</h1><p>Loading content... Please make sure that JavaScript is enabled.</div><div class=col-md-offset-1><hr></div></div></div><footer><div class="col-sm col-md-10 col-md-offset-1"><p>MqTrigger v1.1 2022</div></footer><script>initNavButtons();document.getElementById('app-btn').click();</script>

main/static/min/index.js

@@ -5,12 +5,11 @@ else{console.log("Ignoring "+element.name);}}});console.log("params: "+params);p
 function initFormSendButtons(form){const btns=form.querySelectorAll('.send');for(i=0;i<btns.length;++i){btns[i].addEventListener('click',sendClickHandler);}}
 function loadContent(url){let http=new XMLHttpRequest();http.open('GET',url,true);let element=document.getElementById('content');element.innerHTML="LOADING...";http.onreadystatechange=function(){if(http.readyState==4&&http.status==200){console.log("Content received");element.innerHTML=http.responseText;loadValues(element);initFormSendButtons(element);}}
 http.send();}
-function loadValues(element){const forms=element.querySelectorAll('form');for(i=0;i<forms.length;++i){const srcUrl=forms[i].getAttribute('data-values-src');if(!srcUrl){continue;}
-if(valuesCache[srcUrl]){console.log("Source values already cached: "+valuesCache[srcUrl]);let obj=JSON.parse(valuesCache[srcUrl]);if(obj){for(var key of Object.keys(obj)){console.log(key+" -> "+obj[key])
-let input=element.querySelector("[name='"+key+"'");if(input){input.value=obj[key];if(input.hasAttribute('data-onset')){eval(input.getAttribute("data-onset"));}}}}
-continue;}
-console.log("Getting values from "+srcUrl);let http=new XMLHttpRequest();http.open('GET',srcUrl,false);http.onreadystatechange=function(){if(http.readyState==4&&http.status==200){console.log("Values received: "+http.responseText);valuesCache[srcUrl]=http.responseText;let obj=JSON.parse(http.responseText);if(obj){for(var key of Object.keys(obj)){console.log(key+" -> "+obj[key])
-let input=element.querySelector("[name='"+key+"'");if(input){input.value=obj[key];if(input.hasAttribute('data-onset')){eval(input.getAttribute("data-onset"));}}}}}}
+function fillInputs(element,jsonString){let obj=JSON.parse(jsonString);if(obj){for(var key of Object.keys(obj)){console.log(key+" -> "+obj[key])
+let input=element.querySelector("[name='"+key+"'");if(input){input.value=obj[key];if(input.hasAttribute('data-onset')){eval(input.getAttribute("data-onset"));}}}}}
+function loadValues(element){valuesCache={};const forms=element.querySelectorAll('form');for(i=0;i<forms.length;++i){const srcUrl=forms[i].getAttribute('data-values-src');if(!srcUrl){continue;}
+if(valuesCache[srcUrl]){console.log("Source values already cached: "+valuesCache[srcUrl]);fillInputs(element,valuesCache[srcUrl]);continue;}
+console.log("Getting values from "+srcUrl);let http=new XMLHttpRequest();http.open('GET',srcUrl,false);http.onreadystatechange=function(){if(http.readyState==4&&http.status==200){console.log("Values received: "+http.responseText);valuesCache[srcUrl]=http.responseText;fillInputs(element,http.responseText);}}
 http.send();}}
 function postParams(url,params){var http=new XMLHttpRequest();http.open('POST',url,true);http.setRequestHeader('Content-type','application/x-www-form-urlencoded');http.onreadystatechange=function(){if(http.readyState==4&&http.status==200){alert(http.responseText);}}
 http.send(params);}