From c234afa9c89d2ca887d00f4b801a17a7222b0d5d Mon Sep 17 00:00:00 2001 From: Florian Date: Tue, 1 Oct 2024 11:48:39 -0500 Subject: [PATCH] [SYS] Fix connection validation on unknown indexes and improve erase method (#2075) Before this fix, connections with Index 1 and 2 were supposed valid when not present in the configuration, generating attempts to connect with those indexes. Also improve the erase config by adding an erase when the config file is not present (ESP is connected to WiFi without the config file). This way the ESP will not reconnect to the WiFi AP. Co-authored-by: Florian <1technophile@users.noreply.github.com> --- main/User_config.h | 11 ++++------- main/ZwebUI.ino | 4 ++-- main/main.ino | 34 ++++++++++++++++++---------------- 3 files changed, 24 insertions(+), 25 deletions(-) diff --git a/main/User_config.h b/main/User_config.h index 9abc91d..5d50581 100644 --- a/main/User_config.h +++ b/main/User_config.h @@ -257,10 +257,6 @@ const char* OTAserver_cert = ""; # define MQTT_SECURE_SIGNED_CLIENT 0 // If using a signed certificate for the broker and using client certificate/key set this to true or 1 #endif -#ifndef CNT_DEFAULT_INDEX -# define CNT_DEFAULT_INDEX 0 // Default set of connection parameters -#endif - #ifdef PRIVATE_CERTS # include "certs/private_client_cert.h" # include "certs/private_client_key.h" @@ -273,6 +269,10 @@ const char* OTAserver_cert = ""; #include +#ifndef CNT_DEFAULT_INDEX +# define CNT_DEFAULT_INDEX 0 // Default set of connection parameters +#endif + #if !MQTT_BROKER_MODE struct ss_cnt_parameters { std::string server_cert; @@ -288,9 +288,6 @@ struct ss_cnt_parameters { bool validConnection; }; -// Index 0 is used for connection parameters provided in the build that can be overloaded by WiFi Manager/Onboarding/WebUI,MQTT -# define CNT_DEFAULT_INDEX 0 -// Index 1 and more are used for connection parameters provided at runtime by MQTT # define cnt_parameters_array_size 3 ss_cnt_parameters cnt_parameters_array[cnt_parameters_array_size] = { diff --git a/main/ZwebUI.ino b/main/ZwebUI.ino index d85055e..b3d7c37 100644 --- a/main/ZwebUI.ino +++ b/main/ZwebUI.ino @@ -46,7 +46,7 @@ QueueHandle_t webUIQueue; WebServer server(80); /*------------------- External functions ----------------------*/ -extern void eraseAndRestart(); +extern void erase(bool restart); extern unsigned long uptime(); /*------------------- Web Console Globals ----------------------*/ @@ -1237,7 +1237,7 @@ void handleRT() { response += String(buffer); server.send(200, "text/html", response); - eraseAndRestart(); + erase(true); } else { handleCN(); } diff --git a/main/main.ino b/main/main.ino index 3403f5e..a06e8a6 100644 --- a/main/main.ino +++ b/main/main.ino @@ -1029,7 +1029,7 @@ void setupMQTT() { if (cnt_parameters_backup) { // this was the first attempt to connect to a new server and it succeeded - Log.notice(F("MQTT connection successful" CR)); + Log.notice(F("MQTT connection parameters %d successful" CR), cnt_index); cnt_parameters_array[cnt_index].validConnection = true; readCntParameters(cnt_index); @@ -1754,6 +1754,7 @@ void setupTLS(int index) { /* Reboot for Reason Codes + 0 - Erase and Restart 1 - Repeated MQTT Connection Failure 2 - Repeated WiFi Connection Failure 3 - Failed WiFiManager configuration portal @@ -1863,7 +1864,7 @@ void blockingWaitForReset() { Log.trace(F("Trigger button Pressed" CR)); delay(3000); // reset delay hold if (digitalRead(TRIGGER_GPIO) == LOW) { - Log.trace(F("Button Held" CR)); + Log.notice(F("Button Held" CR)); // Switching off the relay during reset or failsafe operations # ifdef ZactuatorONOFF uint8_t level = digitalRead(ACTUATOR_ONOFF_GPIO); @@ -1877,7 +1878,10 @@ void blockingWaitForReset() { Log.trace(F("mounted file system" CR)); if (SPIFFS.exists("/config.json")) { Log.notice(F("Erasing ESP Config, restarting" CR)); - setupWiFiManager(true); + erase(true); + } else { + Log.notice(F("Erasing ESP Config, without restart" CR)); + erase(false); } } delay(30000); @@ -1887,6 +1891,7 @@ void blockingWaitForReset() { failSafeMode = true; setupWiFiManager(false); } + ESPRestart(5); } } } @@ -2114,8 +2119,9 @@ bool loadConfigFromFlash() { strcat(key, index_suffix); if (json.containsKey(key)) { cnt_parameters_array[i].validConnection = json[key].as(); - } else { - // For backward compatibility, if valid_cnt is not found, we assume the connection is valid + } else if (i == CNT_DEFAULT_INDEX) { + // For backward compatibility, if valid_cnt is not found, we assume the connection is valid for CNT_DEFAULT_INDEX + Log.warning(F("valid_cnt not found, assuming connection is valid" CR)); cnt_parameters_array[i].validConnection = true; } } @@ -2170,7 +2176,7 @@ void setupWiFiManager(bool reset_settings) { WiFi.mode(WIFI_STA); if (reset_settings) - eraseAndRestart(); + erase(true); # ifdef USE_MAC_AS_GATEWAY_NAME String s = WiFi.macAddress(); @@ -2374,9 +2380,6 @@ void setup_ethernet_esp32() { # endif if (ethBeginSuccess) { Log.notice(F("Ethernet started" CR)); - Log.notice(F("OpenMQTTGateway MAC: %s" CR), ETH.macAddress().c_str()); - Log.notice(F("OpenMQTTGateway IP: %s" CR), ETH.localIP().toString().c_str()); - Log.notice(F("OpenMQTTGateway link speed: %d Mbps" CR), ETH.linkSpeed()); while (!ethConnected && failure_number_ntwk <= maxConnectionRetryNetwork) { delay(500); Log.notice(F("." CR)); @@ -2398,9 +2401,9 @@ void WiFiEvent(WiFiEvent_t event) { Log.notice(F("Ethernet Connected" CR)); break; case ARDUINO_EVENT_ETH_GOT_IP: - Log.trace(F("OpenMQTTGateway MAC: %s" CR), ETH.macAddress().c_str()); - Log.trace(F("OpenMQTTGateway IP: %s" CR), ETH.localIP().toString().c_str()); - Log.trace(F("OpenMQTTGateway link speed: %d Mbps" CR), ETH.linkSpeed()); + Log.notice(F("OpenMQTTGateway Ethernet MAC: %s" CR), ETH.macAddress().c_str()); + Log.notice(F("OpenMQTTGateway Ethernet IP: %s" CR), ETH.localIP().toString().c_str()); + Log.notice(F("OpenMQTTGateway Ethernet link speed: %d Mbps" CR), ETH.linkSpeed()); gatewayState = GatewayState::NTWK_CONNECTED; ethConnected = true; break; @@ -2725,7 +2728,7 @@ float intTemperatureRead() { /* Erase flash and restart the ESP */ -void eraseAndRestart() { +void erase(bool restart) { Log.trace(F("Formatting requested, result: %d" CR), SPIFFS.format()); #if defined(ESP8266) @@ -2734,12 +2737,11 @@ void eraseAndRestart() { wifiManager.resetSettings(); # endif delay(5000); - ESP.reset(); #else - //esp_task_wdt_delete(NULL); nvs_flash_erase(); - ESP.restart(); #endif + if (restart) + ESPRestart(0); } String stateMeasures() {