From 72e885d2b25e7470161e88b1455255fab408bdd2 Mon Sep 17 00:00:00 2001 From: szenglein Date: Thu, 18 May 2023 15:45:11 +0200 Subject: [PATCH 1/9] Add support for saving multiple wifi networks * The new code scans available networks * Tries connecting to each known network, starting at the strongest one * Up to 10 SSIDs are saved in NVS * SSIDs can be added and removed TODO: Web-frontend for listing and deleting networks fix AP never start AP after once successful connect re-add hostname and static IP Try last ssid first and more Web API functions fix for accesspoint wifi POST add POST handlers for network settings to AP server set hostname before every connect simplify nvs key handling clean up wifi logging fix swapped log msg clean up prints from web fix some compiler warnings only print connection fail once update wifi management webinterface smaller formatting changes --- html/accesspoint.html | 15 +- html/locales/de.json | 2 + html/locales/en.json | 2 + html/management.html | 167 ++++++++++-- src/LogMessages_DE.cpp | 20 +- src/LogMessages_EN.cpp | 17 +- src/Web.cpp | 180 +++++++++++-- src/Wlan.cpp | 579 +++++++++++++++++++++++++++++++---------- src/Wlan.h | 10 +- src/logmessages.h | 14 +- 10 files changed, 805 insertions(+), 201 deletions(-) diff --git a/html/accesspoint.html b/html/accesspoint.html index eb9fb09b..618ab74e 100644 --- a/html/accesspoint.html +++ b/html/accesspoint.html @@ -45,7 +45,7 @@ -
+

WiFi-configuration

:

@@ -71,6 +71,19 @@

Ready to go?

localize = locI18next.init(i18next); localize('body'); }); + + async function wifiConfig() { + var myObj = { + ssid: document.getElementById('ssid').value, + pwd: document.getElementById('pwd').value + }; + + await fetch("/savedSSIDs", { + method: "POST", + headers: {"Content-Type": "application/json"}, + body: JSON.stringify(myObj) + }); + } \ No newline at end of file diff --git a/html/locales/de.json b/html/locales/de.json index 2742c8b9..a37773b0 100644 --- a/html/locales/de.json +++ b/html/locales/de.json @@ -24,6 +24,8 @@ }, "wifi": { "title": "WLAN-Einstellungen", + "networks": "Netzwerke", + "savedNetworks": "Gespeicherte Netzwerke", "ssid": { "title": "WLAN-Name (SSID)", "placeholder": "SSID", diff --git a/html/locales/en.json b/html/locales/en.json index 4c7b117b..5086ce2b 100644 --- a/html/locales/en.json +++ b/html/locales/en.json @@ -24,6 +24,8 @@ }, "wifi": { "title": "WiFi-configuration", + "networks": "Networks", + "savedNetworks": "Saved Networks", "ssid": { "title": "WiFi-name (SSID)", "placeholder": "SSID", diff --git a/html/management.html b/html/management.html index 6867ef19..86146487 100644 --- a/html/management.html +++ b/html/management.html @@ -175,24 +175,42 @@

@@ -1482,13 +1498,30 @@ }); } + // disable static input fields on toggle + document.getElementById('static_enabled').onchange = function() { + let new_style = this.checked ? null : "none"; + document.getElementById("wifi_static_div").style.display = new_style; + }; + async function wifiConfig(clickedId) { lastIdclicked = clickedId; + let static = document.getElementById('static_enabled').checked; + var myObj = { ssid: document.getElementById('ssid').value, - pwd: document.getElementById('pwd').value + pwd: document.getElementById('pwd').value, + static: static }; - + + if (static) { + myObj[static_addr] = document.getElementById('static_addr').value; + myObj[static_gateway] = document.getElementById('static_gateway').value; + myObj[static_subnet] = document.getElementById('static_subnet').value; + myObj[static_dns1] = document.getElementById('static_dns1').value; + myObj[static_dns2] = document.getElementById('static_dns2').value; + } + await fetch("/savedSSIDs", { method: "POST", headers: {"Content-Type": "application/json"}, diff --git a/src/Web.cpp b/src/Web.cpp index b0387c0c..19f67eff 100644 --- a/src/Web.cpp +++ b/src/Web.cpp @@ -1240,9 +1240,8 @@ void handlePostSavedSSIDs(AsyncWebServerRequest *request, JsonVariant &json) { strncpy(networkSettings.password, (const char*) jsonObj["pwd"], 64); networkSettings.password[64] = '\0'; - // TODO: disabled for now; test later - //networkSettings.use_static_ip = jsonObj["static"]; - networkSettings.use_static_ip = false; + + networkSettings.use_static_ip = (bool) jsonObj["static"]; if (jsonObj.containsKey("static_addr")) { networkSettings.static_addr.fromString((const char*) jsonObj["static_addr"]); diff --git a/src/Wlan.cpp b/src/Wlan.cpp index fc48a4f0..2f92f3cd 100644 --- a/src/Wlan.cpp +++ b/src/Wlan.cpp @@ -77,9 +77,9 @@ void Wlan_Init(void) { // ******************* MIGRATION ******************* // migration from single-wifi setup. Delete some time in the future - String strSSID = gPrefsSettings.getString("SSID", "-1"); - String strPassword = gPrefsSettings.getString("Password", "-1"); - if (!strSSID.equals("-1") && !strPassword.equals("-1")) { + if (gPrefsSettings.isKey("SSID") && gPrefsSettings.isKey("Password")) { + String strSSID = gPrefsSettings.getString("SSID", ""); + String strPassword = gPrefsSettings.getString("Password", ""); Log_Println("migrating from old wifi NVS settings!", LOGLEVEL_NOTICE); gPrefsSettings.putString("LAST_SSID", strSSID); @@ -89,13 +89,20 @@ void Wlan_Init(void) { networkSettings.ssid[32] = '\0'; strncpy(networkSettings.password, strPassword.c_str(), 64); networkSettings.password[64] = '\0'; + + #ifdef STATIC_IP_ENABLE + networkSettings.static_addr = IPAddress(LOCAL_IP); + networkSettings.static_gateway = IPAddress(GATEWAY_IP); + networkSettings.static_subnet = IPAddress(SUBNET_IP); + networkSettings.static_dns1 = IPAddress(DNS_IP); + #endif + Wlan_AddNetworkSettings(networkSettings); } // clean up old values from nvs - if (!strSSID.equals("-1") || !strPassword.equals("-1")) { - gPrefsSettings.remove("SSID"); - gPrefsSettings.remove("Password"); - } + gPrefsSettings.remove("SSID"); + gPrefsSettings.remove("Password"); + // ******************* MIGRATION ******************* @@ -120,6 +127,13 @@ void connectToKnownNetwork(WiFiSettings settings) { WiFi.setHostname(hostname.c_str()); } + if (settings.use_static_ip) { + Log_Println(tryStaticIpConfig, LOGLEVEL_NOTICE); + if (!WiFi.config(settings.static_addr, settings.static_gateway, settings.static_subnet, settings.static_dns1, settings.static_dns2)) { + Log_Println(staticIPConfigFailed, LOGLEVEL_ERROR); + } + } + Log_Printf(LOGLEVEL_NOTICE, wifiConnectionInProgress, settings.ssid); WiFi.begin(settings.ssid, settings.password); @@ -213,16 +227,6 @@ void handleWifiStateScanConnect() { return; } } - - // TODO: now that we manage multiple networks we might want to configure a static ip for each of them - // TODO: this is now doable using the WiFiSettings struct, assuming it can be set from the UI - // Add configuration of static IP (if requested) - #ifdef STATIC_IP_ENABLE - Log_Println(tryStaticIpConfig, LOGLEVEL_NOTICE); - if (!WiFi.config(IPAddress(LOCAL_IP), IPAddress(GATEWAY_IP), IPAddress(SUBNET_IP), IPAddress(DNS_IP))) { - Log_Println(staticIPConfigFailed, LOGLEVEL_ERROR); - } - #endif WiFi.disconnect(true, true); WiFi.mode(WIFI_STA); diff --git a/src/settings-override.h.sample b/src/settings-override.h.sample index f1f92740..481afa50 100644 --- a/src/settings-override.h.sample +++ b/src/settings-override.h.sample @@ -35,7 +35,7 @@ #define NEOPIXEL_ENABLE // Don't forget configuration of NUM_LEDS if enabled //#define NEOPIXEL_REVERSE_ROTATION // Some Neopixels are adressed/soldered counter-clockwise. This can be configured here. #define LANGUAGE DE // DE = deutsch; EN = english - //#define STATIC_IP_ENABLE // Enables static IP-configuration (change static ip-section accordingly) + //#define STATIC_IP_ENABLE // DEPRECATED: Enables static IP-configuration (change static ip-section accordingly) #define HEADPHONE_ADJUST_ENABLE // Used to adjust (lower) volume for optional headphone-pcb (refer maxVolumeSpeaker / maxVolumeHeadphone) and to enable stereo (if PLAY_MONO_SPEAKER is set) #define PLAY_MONO_SPEAKER // If only one speaker is used enabling mono should make sense. Please note: headphones is always stereo (if HEADPHONE_ADJUST_ENABLE is active) #define SHUTDOWN_IF_SD_BOOT_FAILS // Will put ESP to deepsleep if boot fails due to SD. Really recommend this if there's in battery-mode no other way to restart ESP! Interval adjustable via deepsleepTimeAfterBootFails. @@ -145,6 +145,8 @@ // Serial-logging-configuration #define SERIAL_LOGLEVEL LOGLEVEL_DEBUG // Current loglevel for serial console + // DEPRECATED: This is now done using dynamic network configuration. + // If left, it is used for the automatic migration exactly once // Static ip-configuration #ifdef STATIC_IP_ENABLE #define LOCAL_IP 192,168,2,100 // ESPuino's IP diff --git a/src/settings.h b/src/settings.h index b124f6ce..09800600 100644 --- a/src/settings.h +++ b/src/settings.h @@ -37,7 +37,7 @@ #define NEOPIXEL_ENABLE // Don't forget configuration of NUM_LEDS if enabled //#define NEOPIXEL_REVERSE_ROTATION // Some Neopixels are adressed/soldered counter-clockwise. This can be configured here. #define LANGUAGE DE // DE = deutsch; EN = english - //#define STATIC_IP_ENABLE // Enables static IP-configuration (change static ip-section accordingly) + //#define STATIC_IP_ENABLE // DEPRECATED: Enables static IP-configuration (change static ip-section accordingly) #define HEADPHONE_ADJUST_ENABLE // Used to adjust (lower) volume for optional headphone-pcb (refer maxVolumeSpeaker / maxVolumeHeadphone) and to enable stereo (if PLAY_MONO_SPEAKER is set) //#define PLAY_MONO_SPEAKER // If only one speaker is used enabling mono should make sense. Please note: headphones is always stereo (if HEADPHONE_ADJUST_ENABLE is active) #define SHUTDOWN_IF_SD_BOOT_FAILS // Will put ESP to deepsleep if boot fails due to SD. Really recommend this if there's in battery-mode no other way to restart ESP! Interval adjustable via deepsleepTimeAfterBootFails. @@ -153,6 +153,8 @@ // Serial-logging-configuration #define SERIAL_LOGLEVEL LOGLEVEL_DEBUG // Current loglevel for serial console + // DEPRECATED: This is now done using dynamic network configuration. + // If left, it is used for the automatic migration exactly once // Static ip-configuration #ifdef STATIC_IP_ENABLE #define LOCAL_IP 192,168,2,100 // ESPuino's IP From dac646acf47fe6b7e960e97e837e08bf136752b6 Mon Sep 17 00:00:00 2001 From: szenglein Date: Thu, 18 May 2023 15:03:32 +0200 Subject: [PATCH 6/9] make some more variable static or const --- src/Wlan.cpp | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/Wlan.cpp b/src/Wlan.cpp index 2f92f3cd..412ac519 100644 --- a/src/Wlan.cpp +++ b/src/Wlan.cpp @@ -257,7 +257,7 @@ void handleWifiStateScanConnect() { wifiState = WIFI_STATE_CONN_FAILED; } -bool initialStart = true; +static bool initialStart = true; // executed once after successfully connecting void handleWifiStateConnectionSuccess() { initialStart = false; @@ -296,7 +296,7 @@ void handleWifiStateConnectionSuccess() { wifiState = WIFI_STATE_CONNECTED; } -uint32_t lastPrintRssiTimestamp = 0; +static uint32_t lastPrintRssiTimestamp = 0; void handleWifiStateConnected() { switch (WiFi.status()) { case WL_CONNECTED: @@ -319,10 +319,11 @@ void handleWifiStateConnected() { } } -// good candidate for a user setting -uint32_t wifiReconnectTimeout = 600000; -uint32_t wifiAPStartedTimestamp = 0; +static uint32_t wifiAPStartedTimestamp = 0; void handleWifiStateConnectionFailed() { + // good candidate for a user setting + static constexpr uint32_t wifiReconnectTimeout = 600000; + if (connectionFailedTimestamp == 0) { Log_Println(cantConnectToWifi, LOGLEVEL_INFO); connectionFailedTimestamp = millis(); @@ -343,9 +344,10 @@ void handleWifiStateConnectionFailed() { } } -// good candidate for a user setting -uint32_t closeWifiAPTimeout = 300000; void handleWifiStateAP() { + // good candidate for a user setting + static constexpr uint32_t closeWifiAPTimeout = 300000; + // close the AP after the desired time has passed; set to 0 to keep on forever if (closeWifiAPTimeout != 0 && millis() - wifiAPStartedTimestamp > closeWifiAPTimeout) { WiFi.mode(WIFI_OFF); From 2ad2c81cfa18aefa1243fe4c75a38c83ed48c555 Mon Sep 17 00:00:00 2001 From: szenglein Date: Thu, 18 May 2023 15:16:12 +0200 Subject: [PATCH 7/9] rename n for single-char-variable haters --- src/Wlan.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Wlan.cpp b/src/Wlan.cpp index 412ac519..9793cb0b 100644 --- a/src/Wlan.cpp +++ b/src/Wlan.cpp @@ -203,9 +203,9 @@ void handleWifiStateScanConnect() { return; } - int n = WiFi.scanComplete(); + int wifiScanCompleteResult = WiFi.scanComplete(); - switch (n) { + switch (wifiScanCompleteResult) { case -1: // scan not fin return; @@ -219,7 +219,7 @@ void handleWifiStateScanConnect() { } if (connectStartTimestamp == 0) { - for (int i = 0; i < n; ++i) { + for (int i = 0; i < wifiScanCompleteResult; ++i) { Log_Printf(LOGLEVEL_NOTICE, wifiScanResult, WiFi.SSID(i).c_str(), WiFi.RSSI(i), WiFi.channel(i)); } } else { @@ -231,7 +231,7 @@ void handleWifiStateScanConnect() { WiFi.disconnect(true, true); WiFi.mode(WIFI_STA); // fortunately, scan results are already sorted by best signal - for (int i = scanIndex; i < n; i++) { + for (int i = scanIndex; i < wifiScanCompleteResult; i++) { // try to connect to wifi network with index i String issid = WiFi.SSID(i); // check if ssid name matches any saved ssid From 5e3ec1064fc0da505df2f10948c4a00a683697f8 Mon Sep 17 00:00:00 2001 From: szenglein Date: Thu, 18 May 2023 15:48:23 +0200 Subject: [PATCH 8/9] clear wifi scan from ram --- src/Wlan.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/Wlan.cpp b/src/Wlan.cpp index 9793cb0b..7a791570 100644 --- a/src/Wlan.cpp +++ b/src/Wlan.cpp @@ -199,6 +199,7 @@ void handleWifiStateScanConnect() { // wait for scan results and handle them if (WiFi.status() == WL_CONNECTED) { + WiFi.scanDelete(); wifiState = WIFI_STATE_CONN_SUCCESS; return; } @@ -254,6 +255,8 @@ void handleWifiStateScanConnect() { } } } + + WiFi.scanDelete(); wifiState = WIFI_STATE_CONN_FAILED; } From b6c34fa88d61adae2f7615419d5eb84cf37a6d57 Mon Sep 17 00:00:00 2001 From: szenglein Date: Thu, 18 May 2023 15:23:33 +0200 Subject: [PATCH 9/9] remove "-1" default values --- src/Wlan.cpp | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/Wlan.cpp b/src/Wlan.cpp index 7a791570..d7d682c1 100644 --- a/src/Wlan.cpp +++ b/src/Wlan.cpp @@ -58,9 +58,9 @@ constexpr uint8_t DNS_PORT = 53; void Wlan_Init(void) { wifiEnabled = getWifiEnableStatusFromNVS(); - hostname = gPrefsSettings.getString("Hostname", "-1"); + hostname = gPrefsSettings.getString("Hostname"); // Get (optional) hostname-configuration from NVS - if (hostname.compareTo("-1")) { + if (hostname) { Log_Printf(LOGLEVEL_INFO, restoredHostnameFromNvs, hostname.c_str()); } else { Log_Println(wifiHostnameNotSet, LOGLEVEL_INFO); @@ -168,14 +168,16 @@ void handleWifiStateConnectLast() { WiFi.mode(WIFI_STA); // for speed, try to connect to last ssid first - String lastSSID = gPrefsSettings.getString("LAST_SSID", "-1"); + String lastSSID = gPrefsSettings.getString("LAST_SSID"); std::optional lastSettings = std::nullopt; - for(int i=0; i