Captive portal improvements

mathieucarbou · Oct 12, 2024 · ec7a003 · ec7a003
1 parent a0bc300
commit ec7a003
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 37 deletions.
diff --git a/src/MycilaESPConnect.cpp b/src/MycilaESPConnect.cpp
@@ -497,10 +497,16 @@ void Mycila::ESPConnect::_startSTA() {
 
   LOGI(TAG, "Starting WiFi...");
 
+#ifndef ESP8266
+  WiFi.setScanMethod(WIFI_ALL_CHANNEL_SCAN);
+  WiFi.setSortMethod(WIFI_CONNECT_AP_BY_SIGNAL);
+#endif
+
   WiFi.setHostname(_hostname.c_str());
   WiFi.setSleep(false);
   WiFi.persistent(false);
   WiFi.setAutoReconnect(true);
+
   WiFi.mode(WIFI_STA);
 
 #ifndef ESPCONNECT_ETH_SUPPORT
@@ -528,14 +534,18 @@ void Mycila::ESPConnect::_startAP() {
 
   LOGI(TAG, "Starting Access Point...");
 
-  WiFi.setHostname(_hostname.c_str());
 #ifndef ESP8266
   WiFi.softAPsetHostname(_hostname.c_str());
+  WiFi.setScanMethod(WIFI_ALL_CHANNEL_SCAN);
+  WiFi.setSortMethod(WIFI_CONNECT_AP_BY_SIGNAL);
 #endif
+
+  WiFi.setHostname(_hostname.c_str());
   WiFi.setSleep(false);
   WiFi.persistent(false);
   WiFi.setAutoReconnect(false);
   WiFi.softAPConfig(IPAddress(192, 168, 4, 1), IPAddress(192, 168, 4, 1), IPAddress(255, 255, 255, 0));
+
   WiFi.mode(_config.apMode ? WIFI_AP : WIFI_AP_STA);
 
   if (_apPassword.isEmpty() || _apPassword.length() < 8) {
@@ -575,45 +585,27 @@ void Mycila::ESPConnect::_stopAP() {
 
 void Mycila::ESPConnect::_enableCaptivePortal() {
   LOGI(TAG, "Enable Captive Portal...");
-
-#ifndef ESP8266
-  WiFi.setScanMethod(WIFI_ALL_CHANNEL_SCAN);
-  WiFi.setSortMethod(WIFI_CONNECT_AP_BY_SIGNAL);
-#endif
-  WiFi.scanNetworks(true);
-  _scanStart = millis();
+  _scan();
 
   if (_scanHandler == nullptr) {
     _scanHandler = &_httpd->on("/espconnect/scan", HTTP_GET, [&](AsyncWebServerRequest* request) {
       int n = WiFi.scanComplete();
 
-      // scan still running ? wait...
       if (n == WIFI_SCAN_RUNNING) {
-        return request->send(202);
+        // scan still running ? wait...
+        request->send(202);
 
+      } else if (n == WIFI_SCAN_FAILED) {
         // scan error or finished with no result ?
-      } else if (n == 0 || n == WIFI_SCAN_FAILED) {
-        // timeout ?
-        const bool timedOut = millis() - _scanStart > _scanTimeout;
-
         // re-scan
-        WiFi.scanDelete();
-        WiFi.scanNetworks(true);
-        _scanStart = millis();
-
-        // send empty json response, to let the user choose AP mode if timeout, or still ask client to wait
-        if (timedOut) {
-          AsyncJsonResponse* response = new AsyncJsonResponse(true);
-          response->setLength();
-          return request->send(response);
-        } else {
-          return request->send(202);
-        }
+        _scan();
+        request->send(202);
 
-        // scan results ?
       } else {
+        // scan results ?
         AsyncJsonResponse* response = new AsyncJsonResponse(true);
         JsonArray json = response->getRoot();
+
         // we have some results
         for (int i = 0; i < n; ++i) {
 #if ARDUINOJSON_VERSION_MAJOR == 6
@@ -626,12 +618,10 @@ void Mycila::ESPConnect::_enableCaptivePortal() {
           entry["signal"] = _wifiSignalQuality(WiFi.RSSI(i));
           entry["open"] = WiFi.encryptionType(i) == WIFI_AUTH_OPEN;
         }
-        // clean up and start scanning again in background
+
         WiFi.scanDelete();
-        WiFi.scanNetworks(true);
-        _scanStart = millis();
         response->setLength();
-        return request->send(response);
+        request->send(response);
       }
     });
   }
@@ -684,22 +674,30 @@ void Mycila::ESPConnect::_enableCaptivePortal() {
 void Mycila::ESPConnect::_disableCaptivePortal() {
   if (_homeHandler == nullptr)
     return;
+
   LOGI(TAG, "Disable Captive Portal...");
+
+  WiFi.scanDelete();
+
 #ifndef ESPCONNECT_NO_MDNS
   #ifndef ESP8266
   mdns_service_remove("_http", "_tcp");
   #endif
 #endif
+
   _httpd->end();
   _httpd->onNotFound(nullptr);
+
   if (_connectHandler != nullptr) {
     _httpd->removeHandler(_connectHandler);
     _connectHandler = nullptr;
   }
+
   if (_scanHandler != nullptr) {
     _httpd->removeHandler(_scanHandler);
     _scanHandler = nullptr;
   }
+
   if (_homeHandler != nullptr) {
     _httpd->removeHandler(_homeHandler);
     _homeHandler = nullptr;
@@ -794,3 +792,12 @@ bool Mycila::ESPConnect::_durationPassed(uint32_t intervalSec) {
   }
   return false;
 }
+
+void Mycila::ESPConnect::_scan() {
+  WiFi.scanDelete();
+#ifndef ESP8266
+  WiFi.scanNetworks(true, false, false, 500, 0, nullptr, nullptr);
+#else
+  WiFi.scanNetworks(true);
+#endif
+}
diff --git a/src/MycilaESPConnect.h b/src/MycilaESPConnect.h
@@ -22,10 +22,6 @@
   #define ESPCONNECT_PORTAL_TIMEOUT 180
 #endif
 
-#ifndef ESPCONNECT_PORTAL_SCAN_TIMEOUT
-  #define ESPCONNECT_PORTAL_SCAN_TIMEOUT 20
-#endif
-
 namespace Mycila {
   class ESPConnect {
     public:
@@ -212,8 +208,6 @@ namespace Mycila {
       String _apPassword = emptyString;
       uint32_t _connectTimeout = ESPCONNECT_CONNECTION_TIMEOUT;
       uint32_t _portalTimeout = ESPCONNECT_PORTAL_TIMEOUT;
-      uint32_t _scanStart = 0;
-      uint32_t _scanTimeout = ESPCONNECT_PORTAL_SCAN_TIMEOUT;
       Config _config;
       IPConfig _ipConfig;
 #ifndef ESP8266
@@ -240,6 +234,7 @@ namespace Mycila {
       void _disableCaptivePortal();
       void _onWiFiEvent(WiFiEvent_t event);
       bool _durationPassed(uint32_t intervalSec);
+      void _scan();
 #ifdef ESPCONNECT_ETH_SUPPORT
       void _startEthernet();
 #endif