-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Improves WiFiMulti #9139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Improves WiFiMulti #9139
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f451344
feat(wifi): Improves WiFiMulti
SuGlider 638ab50
fix(wifi): Fixes Initialization of Security Mode
SuGlider b5b34c7
Merge branch 'master' into pr_wifimulti
SuGlider bf315f8
Merge branch 'espressif:master' into pr_wifimulti
SuGlider 787f27f
feat(wifi): simplifies the example by using HTTPClient
SuGlider 459dd98
fix(WiFi): fixes a type in the commentaries
SuGlider d8ba28c
Merge branch 'master' into pr_wifimulti
SuGlider File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
113 changes: 113 additions & 0 deletions
113
libraries/WiFi/examples/WiFiMultiAdvanced/WiFiMultiAdvanced.ino
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
/* | ||
* This sketch tries to connect to the best AP available | ||
* and tests for captive portals on open networks | ||
* | ||
*/ | ||
|
||
#include <WiFi.h> | ||
#include <WiFiMulti.h> | ||
|
||
WiFiMulti wifiMulti; | ||
|
||
// This is used to test the Internet connection of connected the AP | ||
// Use a non-302 status code to ensure we bypass captive portals. Can be any text in the webpage. | ||
String _testResp = "301 Moved"; // usually http:// is moves to https:// by a 301 code | ||
// You can also set this to a simple test page on your own server to ensure you can reach it, | ||
// like "http://www.mysite.com/test.html" | ||
String _testURL = "http://www.espressif.com"; // Must include "http://" if testing a HTTP host | ||
const int _testPort = 80; // HTTP port | ||
|
||
bool testConnection(){ | ||
//parse url | ||
int8_t split = _testURL.indexOf('/',7); | ||
String host = _testURL.substring(7, split); | ||
String url = (split < 0) ? "/":_testURL.substring(split,_testURL.length()); | ||
log_i("Testing Connection to %s. Test Respponse is \"%s\"",_testURL.c_str(), _testResp.c_str()); | ||
// Use WiFiClient class to create TCP connections | ||
WiFiClient client; | ||
if (!client.connect(host.c_str(), _testPort)) { | ||
log_e("Connection failed"); | ||
return false; | ||
} else { | ||
log_i("Connected to test host"); | ||
} | ||
|
||
// This will send the request to the server | ||
client.print(String("GET ") + url + " HTTP/1.1\r\n" + | ||
"Host: " + host + "\r\n" + | ||
"Connection: close\r\n\r\n"); | ||
unsigned long timeout = millis(); | ||
while (client.available() == 0) { | ||
if (millis() - timeout > 5000) { | ||
log_e(">>>Client timeout!"); | ||
client.stop(); | ||
return false; | ||
} | ||
} | ||
|
||
bool bSuccess = false; | ||
timeout = millis(); | ||
while(client.available()) { | ||
if (millis() - timeout < 5000) { | ||
String line = client.readStringUntil('\r'); | ||
Serial.println("=============HTTP RESPONSE============="); | ||
Serial.print(line); | ||
Serial.println("\n======================================="); | ||
|
||
bSuccess = client.find(_testResp.c_str()); | ||
if (bSuccess){ | ||
log_i("Success. Found test response"); | ||
} else { | ||
log_e("Failed. Can't find test response"); | ||
} | ||
return bSuccess; | ||
} else { | ||
log_e("Test Response checking has timed out!"); | ||
break; | ||
} | ||
} | ||
return false; // timeout | ||
} | ||
|
||
void setup() | ||
{ | ||
Serial.begin(115200); | ||
delay(10); | ||
|
||
wifiMulti.addAP("ssid_from_AP_1", "your_password_for_AP_1"); | ||
wifiMulti.addAP("ssid_from_AP_2", "your_password_for_AP_2"); | ||
wifiMulti.addAP("ssid_from_AP_3", "your_password_for_AP_3"); | ||
|
||
// These options can help when you need ANY kind of wifi connection to get a config file, report errors, etc. | ||
wifiMulti.setStrictMode(false); // Default is true. Library will disconnect and forget currently connected AP if it's not in the AP list. | ||
wifiMulti.setAllowOpenAP(true); // Default is false. True adds open APs to the AP list. | ||
wifiMulti.setConnectionTestCallbackFunc(testConnection); // Attempts to connect to a remote webserver in case of captive portals. | ||
|
||
Serial.println("Connecting Wifi..."); | ||
if(wifiMulti.run() == WL_CONNECTED) { | ||
Serial.println(""); | ||
Serial.println("WiFi connected"); | ||
Serial.println("IP address: "); | ||
Serial.println(WiFi.localIP()); | ||
} | ||
} | ||
|
||
void loop() | ||
{ | ||
static bool isConnected = false; | ||
uint8_t WiFiStatus = wifiMulti.run(); | ||
|
||
if (WiFiStatus == WL_CONNECTED) { | ||
if (!isConnected) { | ||
Serial.println(""); | ||
Serial.println("WiFi connected"); | ||
Serial.println("IP address: "); | ||
Serial.println(WiFi.localIP()); | ||
} | ||
isConnected = true; | ||
} else { | ||
Serial.println("WiFi not connected!"); | ||
isConnected = false; | ||
delay(5000); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,10 +33,9 @@ WiFiMulti::WiFiMulti() | |
ipv6_support = false; | ||
} | ||
|
||
WiFiMulti::~WiFiMulti() | ||
void WiFiMulti::APlistClean(void) | ||
{ | ||
for(uint32_t i = 0; i < APlist.size(); i++) { | ||
WifiAPlist_t entry = APlist[i]; | ||
for(auto entry : APlist) { | ||
if(entry.ssid) { | ||
free(entry.ssid); | ||
} | ||
|
@@ -47,17 +46,22 @@ WiFiMulti::~WiFiMulti() | |
APlist.clear(); | ||
} | ||
|
||
WiFiMulti::~WiFiMulti() | ||
{ | ||
APlistClean(); | ||
} | ||
|
||
bool WiFiMulti::addAP(const char* ssid, const char *passphrase) | ||
{ | ||
WifiAPlist_t newAP; | ||
|
||
if(!ssid || *ssid == 0x00 || strlen(ssid) > 31) { | ||
if(!ssid || *ssid == '\0' || strlen(ssid) > 31) { | ||
// fail SSID too long or missing! | ||
log_e("[WIFI][APlistAdd] no ssid or ssid too long"); | ||
return false; | ||
} | ||
|
||
if(passphrase && strlen(passphrase) > 64) { | ||
if(passphrase && strlen(passphrase) > 63) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👁️🗨️ |
||
// fail passphrase too long! | ||
log_e("[WIFI][APlistAdd] passphrase too long"); | ||
return false; | ||
|
@@ -70,7 +74,7 @@ bool WiFiMulti::addAP(const char* ssid, const char *passphrase) | |
return false; | ||
} | ||
|
||
if(passphrase && *passphrase != 0x00) { | ||
if(passphrase && *passphrase != '\0') { | ||
newAP.passphrase = strdup(passphrase); | ||
if(!newAP.passphrase) { | ||
log_e("[WIFI][APlistAdd] fail newAP.passphrase == 0"); | ||
|
@@ -80,7 +84,7 @@ bool WiFiMulti::addAP(const char* ssid, const char *passphrase) | |
} else { | ||
newAP.passphrase = NULL; | ||
} | ||
|
||
newAP.hasFailed = false; | ||
APlist.push_back(newAP); | ||
log_i("[WIFI][APlistAdd] add SSID: %s", newAP.ssid); | ||
return true; | ||
|
@@ -91,9 +95,20 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
int8_t scanResult; | ||
uint8_t status = WiFi.status(); | ||
if(status == WL_CONNECTED) { | ||
for(uint32_t x = 0; x < APlist.size(); x++) { | ||
if(WiFi.SSID()==APlist[x].ssid) { | ||
if (!_bWFMInit && _connectionTestCBFunc != NULL){ | ||
if (_connectionTestCBFunc() == true) { | ||
_bWFMInit = true; | ||
return status; | ||
} | ||
} else { | ||
if (!_bStrict) { | ||
return status; | ||
} else { | ||
for(auto ap : APlist) { | ||
if(WiFi.SSID() == ap.ssid) { | ||
return status; | ||
} | ||
} | ||
} | ||
} | ||
WiFi.disconnect(false,false); | ||
|
@@ -102,22 +117,27 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
} | ||
|
||
scanResult = WiFi.scanNetworks(); | ||
if(scanResult == WIFI_SCAN_RUNNING) { | ||
if (scanResult == WIFI_SCAN_RUNNING) { | ||
// scan is running | ||
return WL_NO_SSID_AVAIL; | ||
} else if(scanResult >= 0) { | ||
} else if (scanResult >= 0) { | ||
// scan done analyze | ||
WifiAPlist_t bestNetwork { NULL, NULL }; | ||
int32_t bestIndex = 0; | ||
WifiAPlist_t bestNetwork { NULL, NULL, false }; | ||
int bestNetworkDb = INT_MIN; | ||
int bestNetworkSec = WIFI_AUTH_MAX; | ||
uint8_t bestBSSID[6]; | ||
int32_t bestChannel = 0; | ||
|
||
log_i("[WIFI] scan done"); | ||
|
||
if(scanResult == 0) { | ||
if (scanResult == 0) { | ||
log_e("[WIFI] no networks found"); | ||
} else { | ||
log_i("[WIFI] %d networks found", scanResult); | ||
|
||
int8_t failCount = 0; | ||
int8_t foundCount = 0; | ||
for(int8_t i = 0; i < scanResult; ++i) { | ||
|
||
String ssid_scan; | ||
|
@@ -127,22 +147,47 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
int32_t chan_scan; | ||
|
||
WiFi.getNetworkInfo(i, ssid_scan, sec_scan, rssi_scan, BSSID_scan, chan_scan); | ||
// add any Open WiFi AP to the list, if allowed with setAllowOpenAP(true) | ||
if (_bAllowOpenAP && sec_scan == WIFI_AUTH_OPEN){ | ||
bool found = false; | ||
for(auto check : APlist) { | ||
if (ssid_scan == check.ssid){ | ||
found = true; | ||
break; | ||
} | ||
} | ||
// If we didn't find it, add this Open WiFi AP to the list | ||
if (!found){ | ||
log_i("[WIFI][APlistAdd] adding Open WiFi SSID: %s", ssid_scan.c_str()); | ||
addAP(ssid_scan.c_str()); | ||
} | ||
} | ||
|
||
bool known = false; | ||
for(uint32_t x = APlist.size() ; x > 0; x--) { | ||
WifiAPlist_t entry = APlist[x-1]; | ||
for(uint32_t x = 0; x < APlist.size(); x++) { | ||
WifiAPlist_t entry = APlist[x]; | ||
|
||
if(ssid_scan == entry.ssid) { // SSID match | ||
known = true; | ||
if(rssi_scan > bestNetworkDb) { // best network | ||
if(sec_scan == WIFI_AUTH_OPEN || entry.passphrase) { // check for passphrase if not open wlan | ||
bestNetworkDb = rssi_scan; | ||
bestChannel = chan_scan; | ||
memcpy((void*) &bestNetwork, (void*) &entry, sizeof(bestNetwork)); | ||
memcpy((void*) &bestBSSID, (void*) BSSID_scan, sizeof(bestBSSID)); | ||
log_v("known ssid: %s, has failed: %s", entry.ssid, entry.hasFailed ? "yes" : "no"); | ||
foundCount++; | ||
if (!entry.hasFailed){ | ||
known = true; | ||
log_v("rssi_scan: %d, bestNetworkDb: %d", rssi_scan, bestNetworkDb); | ||
if(rssi_scan > bestNetworkDb) { // best network | ||
if(_bAllowOpenAP || (sec_scan == WIFI_AUTH_OPEN || entry.passphrase)) { // check for passphrase if not open wlan | ||
log_v("best network is now: %s", ssid_scan); | ||
bestIndex = x; | ||
bestNetworkSec = sec_scan; | ||
bestNetworkDb = rssi_scan; | ||
bestChannel = chan_scan; | ||
memcpy((void*) &bestNetwork, (void*) &entry, sizeof(bestNetwork)); | ||
memcpy((void*) &bestBSSID, (void*) BSSID_scan, sizeof(bestBSSID)); | ||
} | ||
} | ||
break; | ||
} else { | ||
failCount++; | ||
} | ||
break; | ||
} | ||
} | ||
|
||
|
@@ -152,8 +197,12 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
log_d(" %d: [%d][%02X:%02X:%02X:%02X:%02X:%02X] %s (%d) %c", i, chan_scan, BSSID_scan[0], BSSID_scan[1], BSSID_scan[2], BSSID_scan[3], BSSID_scan[4], BSSID_scan[5], ssid_scan.c_str(), rssi_scan, (sec_scan == WIFI_AUTH_OPEN) ? ' ' : '*'); | ||
} | ||
} | ||
log_v("foundCount = %d, failCount = %d", foundCount, failCount); | ||
// if all the APs in the list have failed, reset the failure flags | ||
if (foundCount == failCount) { | ||
resetFails(); // keeps trying the APs in the list | ||
} | ||
} | ||
|
||
// clean up ram | ||
WiFi.scanDelete(); | ||
|
||
|
@@ -163,12 +212,15 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
if (ipv6_support == true) { | ||
WiFi.enableIPv6(); | ||
} | ||
WiFi.begin(bestNetwork.ssid, bestNetwork.passphrase, bestChannel, bestBSSID); | ||
WiFi.disconnect(); | ||
delay(10); | ||
WiFi.begin(bestNetwork.ssid, (_bAllowOpenAP && bestNetworkSec == WIFI_AUTH_OPEN) ? NULL : bestNetwork.passphrase, bestChannel, bestBSSID); | ||
status = WiFi.status(); | ||
_bWFMInit = true; | ||
|
||
auto startTime = millis(); | ||
// wait for connection, fail, or timeout | ||
while(status != WL_CONNECTED && status != WL_NO_SSID_AVAIL && status != WL_CONNECT_FAILED && (millis() - startTime) <= connectTimeout) { | ||
while(status != WL_CONNECTED && (millis() - startTime) <= connectTimeout) { // && status != WL_NO_SSID_AVAIL && status != WL_CONNECT_FAILED | ||
delay(10); | ||
status = WiFi.status(); | ||
} | ||
|
@@ -180,15 +232,32 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
log_d("[WIFI] IP: %s", WiFi.localIP().toString().c_str()); | ||
log_d("[WIFI] MAC: %s", WiFi.BSSIDstr().c_str()); | ||
log_d("[WIFI] Channel: %d", WiFi.channel()); | ||
|
||
if (_connectionTestCBFunc != NULL) { | ||
// We connected to an AP but if it's a captive portal we're not going anywhere. Test it. | ||
if (_connectionTestCBFunc()) { | ||
resetFails(); | ||
} else { | ||
markAsFailed(bestIndex); | ||
WiFi.disconnect(); | ||
delay(10); | ||
status = WiFi.status(); | ||
} | ||
} else { | ||
resetFails(); | ||
} | ||
break; | ||
case WL_NO_SSID_AVAIL: | ||
log_e("[WIFI] Connecting Failed AP not found."); | ||
markAsFailed(bestIndex); | ||
break; | ||
case WL_CONNECT_FAILED: | ||
log_e("[WIFI] Connecting Failed."); | ||
markAsFailed(bestIndex); | ||
break; | ||
default: | ||
log_e("[WIFI] Connecting Failed (%d).", status); | ||
markAsFailed(bestIndex); | ||
break; | ||
} | ||
} else { | ||
|
@@ -210,3 +279,27 @@ uint8_t WiFiMulti::run(uint32_t connectTimeout) | |
void WiFiMulti::enableIPv6(bool state) { | ||
ipv6_support = state; | ||
} | ||
|
||
void WiFiMulti::markAsFailed(int32_t i) { | ||
APlist[i].hasFailed = true; | ||
log_d("[WIFI] Marked SSID %s as failed", APlist[i].ssid); | ||
} | ||
|
||
void WiFiMulti::resetFails(){ | ||
for(uint32_t i = 0; i < APlist.size(); i++) { | ||
APlist[i].hasFailed = false; | ||
} | ||
log_d("[WIFI] Resetting failure flags"); | ||
} | ||
|
||
void WiFiMulti::setStrictMode(bool bStrict) { | ||
_bStrict = bStrict; | ||
} | ||
|
||
void WiFiMulti::setAllowOpenAP(bool bAllowOpenAP) { | ||
_bAllowOpenAP = bAllowOpenAP; | ||
} | ||
|
||
void WiFiMulti::setConnectionTestCallbackFunc(ConnectionTestCB_t cbFunc) { | ||
_connectionTestCBFunc = cbFunc; | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.