Control the delay before ESP restart in auto-restart mode and fix IPv6 support (#42)

* [1] -add delay before restart
-stop ap after send response to user

wait for restart is good

* [1]v2
-add a modifiable delay before restart and readout of delay and remaining time
-add two callbacks before restart

* little correction

* correction: add setter, and removing what is unnecessary

* little correction

* Some code cleanup and fixes

* Fix IPv6 support and concurrency issue when restart mode is disabled

---------

Co-authored-by: alcante <[email protected]>
Co-authored-by: Mathieu Carbou <[email protected]>

Author: 3 people

examples/NonBlockingCaptivePortal/NonBlockingCaptivePortal.ino

@@ -58,7 +58,9 @@ void setup() {
     }
   });
 
-  espConnect.setAutoRestart(true);
+  espConnect.setConnectTimeout(20); // 20 seconds
+  espConnect.setCaptivePortalTimeout(30); // 30 seconds
+  espConnect.setAutoRestart(false);
   espConnect.setBlocking(false);
 
   Serial.println("====> Trying to connect to saved WiFi or will start portal in the background...");

platformio.ini

@@ -3,11 +3,11 @@
 default_envs = arduino-3, arduino-3-latest, esp8266, esp32-poe-arduino-3, esp32-poe-arduino-3-latest, wt32-eth01-arduino-3, wt32-eth01-arduino-3-latest, lilygo-eth-lite-s3-arduino-3, lilygo-eth-lite-s3-arduino-3-latest
 lib_dir = .
 ; src_dir = examples/BlockingCaptivePortal
-; src_dir = examples/NonBlockingCaptivePortal
+src_dir = examples/NonBlockingCaptivePortal
 ; src_dir = examples/AdvancedCaptivePortal
 ; src_dir = examples/TestWiFi8266
 ; src_dir = examples/WiFiStaticIP
-src_dir = examples/LoadSaveConfig
+; src_dir = examples/LoadSaveConfig
 ; src_dir = examples/NoCaptivePortal
 
 [env]
@@ -21,6 +21,8 @@ build_flags =
   ; -D ESPCONNECT_NO_CAPTIVE_PORTAL
   ; -D ESPCONNECT_NO_STD_STRING
   ; -D ESPCONNECT_NO_LOGGING
+  ; -D ESPCONNECT_ETH_SUPPORT
+  ; -D ESPCONNECT_NO_MUTEX
 lib_compat_mode = strict
 lib_ldf_mode = chain
 lib_deps = 

src/MycilaESPConnect.cpp

@@ -345,6 +345,10 @@ void Mycila::ESPConnect::loop() {
   if (_dnsServer != nullptr)
     _dnsServer->processNextRequest();
 
+#ifndef ESPCONNECT_NO_MUTEX
+  std::lock_guard<std::mutex> lock(_mutex);
+#endif
+
   // first check if we have to enter AP mode
   if (_state == Mycila::ESPConnect::State::NETWORK_ENABLED && _config.apMode) {
     _startAP();
@@ -396,13 +400,34 @@ void Mycila::ESPConnect::loop() {
     _disableCaptivePortal();
   }
 
-  if (_state == Mycila::ESPConnect::State::PORTAL_COMPLETE || _state == Mycila::ESPConnect::State::PORTAL_TIMEOUT) {
+  if (_state == Mycila::ESPConnect::State::PORTAL_TIMEOUT) {
+    LOGW(TAG, "Portal timeout!");
     _stopAP();
     if (_autoRestart) {
-      LOGW(TAG, "Auto Restart of ESP...");
+      LOGW(TAG, "Restarting ESP...");
       ESP.restart();
-    } else
+    } else {
+      // try to reconnect again with configured settings
       _setState(Mycila::ESPConnect::State::NETWORK_ENABLED);
+    }
+  }
+
+  if (_state == Mycila::ESPConnect::State::PORTAL_COMPLETE) {
+    if (_autoRestart) {
+      if (!_restartRequestTime) {
+        // init _restartRequestTime if not already set to teh time when the portal completed
+        _restartRequestTime = millis();
+      } else if (millis() - _restartRequestTime >= _restartDelay) {
+        // delay is over restart
+        LOGW(TAG, "Auto Restart of ESP...");
+        _stopAP();
+        ESP.restart();
+      }
+    } else {
+      _stopAP();
+      // try to reconnect again with new configured settings
+      _setState(Mycila::ESPConnect::State::NETWORK_ENABLED);
+    }
   }
 }
 
@@ -804,6 +829,10 @@ void Mycila::ESPConnect::_onWiFiEvent(WiFiEvent_t event) {
   if (_state == Mycila::ESPConnect::State::NETWORK_DISABLED)
     return;
 
+#ifndef ESPCONNECT_NO_MUTEX
+  std::lock_guard<std::mutex> lock(_mutex);
+#endif
+
   switch (event) {
 #ifdef ESPCONNECT_ETH_SUPPORT
     case ARDUINO_EVENT_ETH_START:
@@ -836,21 +865,23 @@ void Mycila::ESPConnect::_onWiFiEvent(WiFiEvent_t event) {
 
     case ARDUINO_EVENT_WIFI_STA_GOT_IP:
       LOGD(TAG, "[%s] WiFiEvent: ARDUINO_EVENT_WIFI_STA_GOT_IP: %s", getStateName(), WiFi.localIP().toString().c_str());
-#ifndef ESPCONNECT_NO_MDNS
-      MDNS.begin(_config.hostname.c_str());
-#endif
       if (_state == Mycila::ESPConnect::State::NETWORK_CONNECTING || _state == Mycila::ESPConnect::State::NETWORK_RECONNECTING) {
         _lastTime = -1;
         _setState(Mycila::ESPConnect::State::NETWORK_CONNECTED);
       }
+#ifndef ESPCONNECT_NO_MDNS
+      MDNS.begin(_config.hostname.c_str());
+#endif
       break;
 
 #ifndef ESP8266
     case ARDUINO_EVENT_WIFI_STA_GOT_IP6:
-      LOGD(TAG, "[%s] WiFiEvent: ARDUINO_EVENT_WIFI_STA_GOT_IP6: %s", getStateName(), WiFi.globalIPv6().toString().c_str());
-      if (_state == Mycila::ESPConnect::State::NETWORK_CONNECTING || _state == Mycila::ESPConnect::State::NETWORK_RECONNECTING) {
-        _lastTime = -1;
-        _setState(Mycila::ESPConnect::State::NETWORK_CONNECTED);
+      if (WiFi.globalIPv6() != IN6ADDR_ANY) {
+        LOGD(TAG, "[%s] WiFiEvent: ARDUINO_EVENT_WIFI_STA_GOT_IP6: %s", getStateName(), WiFi.globalIPv6().toString().c_str());
+        if (_state == Mycila::ESPConnect::State::NETWORK_CONNECTING || _state == Mycila::ESPConnect::State::NETWORK_RECONNECTING) {
+          _lastTime = -1;
+          _setState(Mycila::ESPConnect::State::NETWORK_CONNECTED);
+        }
       }
       break;
 #endif
@@ -867,7 +898,7 @@ void Mycila::ESPConnect::_onWiFiEvent(WiFiEvent_t event) {
         // we have to move to state disconnected only if we are not connected to ethernet
 #ifdef ESPCONNECT_ETH_SUPPORT
         if (ETH.linkUp() && ETH.localIP()[0] != 0)
-          return;
+          break;
 #endif
         _setState(Mycila::ESPConnect::State::NETWORK_DISCONNECTED);
       }

src/MycilaESPConnect.h

@@ -7,6 +7,7 @@
 #include <DNSServer.h>
 
 #ifdef ESP8266
+  #define ESPCONNECT_NO_MUTEX 1
   #include <ESP8266WiFi.h>
 #else
   #include <WiFi.h>
@@ -26,6 +27,10 @@
   #define ESPCONNECT_STRING std::string
 #endif
 
+#ifndef ESPCONNECT_NO_MUTEX
+  #include <mutex>
+#endif
+
 #define ESPCONNECT_VERSION          "10.0.1"
 #define ESPCONNECT_VERSION_MAJOR    10
 #define ESPCONNECT_VERSION_MINOR    0
@@ -223,6 +228,11 @@ namespace Mycila {
       // when using auto-load and save of configuration, this method can clear saved states.
       void clearConfiguration();
 
+      // Get the delay before a restart occurs
+      uint32_t getRestartDelay() const { return _restartDelay; }
+      // Set the delay before a restart occurs in ms
+      void setRestartDelay(uint32_t delay) { _restartDelay = delay; }
+
 #ifndef ESPCONNECT_NO_CAPTIVE_PORTAL
       void toJson(const JsonObject& root) const;
 #endif
@@ -270,5 +280,10 @@ namespace Mycila {
 
     private:
       static int8_t _wifiSignalQuality(int32_t rssi);
+      uint32_t _restartRequestTime = 0;
+      uint32_t _restartDelay = 1000;
+#ifndef ESPCONNECT_NO_MUTEX
+      std::mutex _mutex;
+#endif
   };
 } // namespace Mycila