-
Notifications
You must be signed in to change notification settings - Fork 186
/
AutoConnect.cpp
1635 lines (1495 loc) · 55.6 KB
/
AutoConnect.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* AutoConnect class implementation.
* @file AutoConnect.cpp
* @author hieromon@gmail.com
* @version 1.3.0
* @date 2021-09-06
* @copyright MIT license.
*/
#include "AutoConnect.h"
#ifdef ARDUINO_ARCH_ESP32
#include <esp_wifi.h>
/**
* Ensure backword compatibility depending on Arduino core version.
*/
// Declare pseudo a new enumerator of WiFiEvent_t type adopted from the core 2.0.0.
#include <Arduino.h>
#ifdef ESP_ARDUINO_VERSION_MAJOR
#if ESP_ARDUINO_VERSION_MAJOR>=2
#define AC_ESP_WIFIEVENT_DECLARE(x) ARDUINO_EVENT_WIFI_##x
#endif
#endif
#ifndef AC_ESP_WIFIEVENT_DECLARE
#define AC_ESP_WIFIEVENT_DECLARE(x) SYSTEM_EVENT_##x
#endif
#endif
/**
* An actual reset function dependent on the architecture
*/
#if defined(ARDUINO_ARCH_ESP8266)
#define SOFT_RESET() ESP.reset()
#define SET_HOSTNAME(x) do { WiFi.hostname(x); } while(0)
#elif defined(ARDUINO_ARCH_ESP32)
#define SOFT_RESET() ESP.restart()
#define SET_HOSTNAME(x) do { WiFi.setHostname(x); } while(0)
#endif
/**
* AutoConnect default constructor. This entry activates WebServer
* internally and the web server is allocated internal.
*/
AutoConnect::AutoConnect()
: _scanCount( 0 )
, _menuTitle( _apConfig.title )
{
memset(&_credential, 0x00, sizeof(station_config_t));
}
/**
* Run the AutoConnect site using the externally ensured ESP 8266 WebServer.
* User's added URI handler response can be included in handleClient method.
* @param webServer A reference of ESP8266WebServer instance.
*/
AutoConnect::AutoConnect(WebServerClass& webServer)
: AutoConnect()
{
_webServer = WebserverUP(&webServer, [](WebServerClass*){});
}
/**
* A destructor. Free AutoConnect web pages and release Web server.
* When the server is hosted it will be purged.
*/
AutoConnect::~AutoConnect() {
end();
}
/**
* Starts establishing WiFi connection without SSID and password.
*/
bool AutoConnect::begin(void) {
return begin(nullptr, nullptr, _apConfig.beginTimeout);
}
/**
* Starts establishing WiFi connection.
* Before establishing, start the Web server and DNS server for the captive
* portal. Then begins connection establishment in WIFI_STA mode. If
* connection can not established with the specified SSID and password,
* switch to WIFI_AP_STA mode and activate SoftAP.
* @param ssid SSID to be connected.
* @param passphrase Password for connection.
* @param timeout A time out value in milliseconds for waiting connection.
* @return true Connection established, AutoConnect service started with WIFI_STA mode.
* @return false Could not connected, Captive portal started with WIFI_AP_STA mode.
*/
bool AutoConnect::begin(const char* ssid, const char* passphrase, unsigned long timeout) {
bool cs;
AC_ESP_LOG("wifi", ESP_LOG_VERBOSE);
AC_ESP_LOG("dhcpc", ESP_LOG_VERBOSE);
// Overwrite for the current timeout value.
if (timeout == 0)
timeout = _apConfig.beginTimeout;
// Ensure persistence to save the connected station_config in the SDK.
// Correspondence to change of WiFi initial mode due to update to ESP8266 core 3.0.0.
if (!_isPersistent()) {
WiFi.persistent(true);
AC_DBG("Set persistance\n");
}
if (_apConfig.preserveAPMode && !_apConfig.autoRise) {
// Captive portal will not be started on connection failure. Enable Station mode
// without disabling any current soft AP.
cs = WiFi.enableSTA(true);
AC_DBG("WiFi mode %d maintained, STA %s\n", WiFi.getMode(), cs ? "enabled" : "unavailable");
}
else {
// Start WiFi connection with station mode.
WiFi.softAPdisconnect(true);
if (!WiFi.mode(WIFI_STA))
AC_DBG("Unable start WIFI_STA\n");
delay(100);
}
// Set host name
if (_apConfig.hostName.length())
SET_HOSTNAME(_apConfig.hostName.c_str());
// Start Ticker according to the WiFi condition with Ticker is available.
if (_apConfig.ticker) {
_ticker.reset(new AutoConnectTicker(_apConfig.tickerPort, _apConfig.tickerOn));
if (WiFi.status() != WL_CONNECTED)
_ticker->start(AUTOCONNECT_FLICKER_PERIODDC, (uint8_t)AUTOCONNECT_FLICKER_WIDTHDC);
}
// If the portal is requested promptly skip the first WiFi.begin and
// immediately start the portal.
if (_apConfig.immediateStart) {
cs = false;
AC_DBG("Start the portal immediately\n");
}
else {
station_config_t current;
// Restore current STA configuration
if (_getConfigSTA(¤t))
AC_DBG("Current:%.32s\n", current.ssid);
// Prepare valid configuration according to the WiFi connection right order.
cs = true;
_rfAdHocBegin = ssid == nullptr ? false : (strlen(ssid) > 0);
if (_rfAdHocBegin) {
// Save for autoReconnect
strcpy(reinterpret_cast<char*>(_credential.ssid), ssid);
if (passphrase)
strcpy(reinterpret_cast<char*>(_credential.password), passphrase);
}
else {
// AC_PRINCIPLE_RSSI is available when SSID and password are not provided.
if (_apConfig.principle == AC_PRINCIPLE_RSSI) {
// Find the strongest signal from the broadcast among the saved credentials.
if ((cs = _loadCurrentCredential(reinterpret_cast<char*>(current.ssid), reinterpret_cast<char*>(current.password), AC_PRINCIPLE_RSSI, false))) {
ssid = reinterpret_cast<const char*>(current.ssid);
passphrase = reinterpret_cast<const char*>(current.password);
AC_DBG("Adopted:%.32s\n", ssid);
}
}
_loadAvailCredential(reinterpret_cast<const char*>(current.ssid));
}
if (cs) {
// Advance configuration for STA mode. Restore previous configuration of STA.
// _loadAvailCredential(reinterpret_cast<const char*>(current.ssid));
if (!_configSTA(_apConfig.staip, _apConfig.staGateway, _apConfig.staNetmask, _apConfig.dns1, _apConfig.dns2))
return false;
// Try to connect by STA immediately.
if (!_rfAdHocBegin)
cs = WiFi.begin() != WL_CONNECT_FAILED;
else {
_disconnectWiFi(false);
cs = WiFi.begin(ssid, passphrase) != WL_CONNECT_FAILED;
}
AC_DBG("WiFi.begin(%s%s%s)", ssid == nullptr ? "" : ssid, passphrase == nullptr ? "" : ",", passphrase == nullptr ? "" : passphrase);
if (cs)
cs = _waitForConnect(timeout) == WL_CONNECTED;
else {
AC_DBG_DUMB(" failed");
// Wait for the access point to free resources with inserting
// a delay. This duration will be eventually pulled out since
// the issue will be gone by the arduino-esp32. issue #292
_reconnectDelay(AUTOCONNECT_RECONNECT_DELAY);
AC_DBG_DUMB("\n");
}
}
// Reconnect with a valid credential as the autoReconnect option is enabled.
if (!cs && _apConfig.autoReconnect && !_rfAdHocBegin) {
// Load a valid credential.
char ssid_c[sizeof(station_config_t::ssid) + sizeof('\0')];
char password_c[sizeof(station_config_t::password) + sizeof('\0')];
AC_DBG("autoReconnect");
if ((cs = _loadCurrentCredential(ssid_c, password_c, _apConfig.principle, strlen(reinterpret_cast<const char*>(current.ssid)) > 0))) {
// Try to reconnect with a stored credential.
AC_DBG_DUMB(", %s(%s) loaded\n", ssid_c, _apConfig.principle == AC_PRINCIPLE_RECENT ? "RECENT" : "RSSI");
const char* psk = strlen(password_c) ? password_c : nullptr;
_configSTA(IPAddress(_credential.config.sta.ip), IPAddress(_credential.config.sta.gateway), IPAddress(_credential.config.sta.netmask), IPAddress(_credential.config.sta.dns1), IPAddress(_credential.config.sta.dns2));
cs = WiFi.begin(ssid_c, psk) != WL_CONNECT_FAILED;
AC_DBG("WiFi.begin(%s%s%s)", ssid_c, psk == nullptr ? "" : ",", psk == nullptr ? "" : psk);
if (cs)
cs = _waitForConnect(timeout) == WL_CONNECTED;
}
if (!cs) {
AC_DBG_DUMB(" failed\n");
}
}
}
_currentHostIP = WiFi.localIP();
// End first begin process, the captive portal specific process starts here.
if (cs) {
// Activate AutoConnectUpdate if it is attached and incorporate it into the AutoConnect menu.
if (_update)
_update->enable();
}
// Rushing into the portal.
else {
// Connection unsuccessful, launch the captive portal.
// The captive portal is effective at the autoRise is valid only.
if (_apConfig.autoRise) {
// Change WiFi working mode, Enable AP with STA
WiFi.setAutoConnect(false);
_disconnectWiFi(false);
// Activate the AP mode with configured softAP and start the access point.
_softAP();
_currentHostIP = WiFi.softAPIP();
// Fork to the exit routine that starts captive portal.
cs = _onDetectExit ? _onDetectExit(_currentHostIP) : true;
// Start Web server when TCP connection is enabled.
_startWebServer();
// Start captive portal without cancellation by DetectExit.
if (cs) {
// Prepare for redirecting captive portal detection.
// Pass all URL requests to _captivePortal to disguise the captive portal.
_startDNSServer();
// The following two lines are the trick statements.
// They have the effect of avoiding unintended automatic
// reconnection by autoReconnect within handleClient.
// Also retainPortal too.
bool actReconnect = _apConfig.autoReconnect;
bool actRetainPortal = _apConfig.retainPortal;
_apConfig.autoReconnect = false;
_apConfig.retainPortal = true;
// Start the captive portal to make a new connection
bool hasTimeout = false;
_portalAccessPeriod = millis();
while (WiFi.status() != WL_CONNECTED && !_rfReset) {
handleClient();
// By an exit routine to escape from Captive portal
if (_whileCaptivePortal) {
if (!_whileCaptivePortal())
break;
}
// Force execution of queued processes.
yield();
// Check timeout
if ((hasTimeout = _hasTimeout(_apConfig.portalTimeout))) {
AC_DBG("CP timeout exceeded:%ld\n", millis() - _portalAccessPeriod);
break;
}
}
cs = WiFi.status() == WL_CONNECTED;
// Restore actual autoReconnect and retainPortal settings.
_apConfig.autoReconnect = actReconnect;
_apConfig.retainPortal = actRetainPortal;
// Captive portal staying time exceeds timeout,
// Close the portal if an option for keeping the portal is false.
if (!cs && hasTimeout) {
if (_apConfig.retainPortal) {
_purgePages();
AC_DBG("Maintain portal\n");
}
else
_stopPortal();
}
}
}
else {
AC_DBG("Suppress autoRise\n");
}
}
// It doesn't matter the connection status for launching the Web server.
if (!_responsePage)
_startWebServer();
return cs;
}
/**
* Configure AutoConnect portal access point.
* @param ap SSID for access point.
* @param psk Password for access point.
*/
bool AutoConnect::config(const char* ap, const char* password) {
_apConfig.apid = String(ap);
_apConfig.psk = String(password);
return true; //_config();
}
/**
* Configure AutoConnect portal access point.
* @param Config AutoConnectConfig class instance.
*/
bool AutoConnect::config(AutoConnectConfig& Config) {
_apConfig = Config;
return true; //_config();
}
/**
* Configure access point.
* Set up access point with internal AutoConnectConfig parameter corrected
* by Config method.
*/
bool AutoConnect::_configAP(void) {
if (static_cast<uint32_t>(_apConfig.apip) == 0U || static_cast<uint32_t>(_apConfig.gateway) == 0U || static_cast<uint32_t>(_apConfig.netmask) == 0U) {
AC_DBG("Warning: Contains invalid SoftAPIP address(es).\n");
}
bool rc = WiFi.softAPConfig(_apConfig.apip, _apConfig.gateway, _apConfig.netmask);
AC_DBG("SoftAP configure %s, %s, %s %s\n", _apConfig.apip.toString().c_str(), _apConfig.gateway.toString().c_str(), _apConfig.netmask.toString().c_str(), rc ? "" : "failed");
return rc;
}
/**
* Advance configuration for STA mode.
* @param ip IP address
* @param gateway Gateway address
* @param netmask Netmask
* @param dns1 Primary DNS address
* @param dns2 Secondary DNS address
* @return true Station successfully configured
* @return false WiFi.config failed
*/
bool AutoConnect::_configSTA(const IPAddress& ip, const IPAddress& gateway, const IPAddress& netmask, const IPAddress& dns1, const IPAddress& dns2) {
bool rc;
AC_DBG("WiFi.config(IP=%s, Gateway=%s, Subnetmask=%s, DNS1=%s, DNS2=%s)\n", ip.toString().c_str(), gateway.toString().c_str(), netmask.toString().c_str(), dns1.toString().c_str(), dns2.toString().c_str());
if (!(rc = WiFi.config(ip, gateway, netmask, dns1, dns2))) {
AC_DBG("failed, AC::begin abort\n");
}
#ifdef ARDUINO_ARCH_ESP8266
AC_DBG("DHCP client(%s)\n", wifi_station_dhcpc_status() == DHCP_STOPPED ? "STOPPED" : "STARTED");
#endif
return rc;
}
/**
* Get URI to redirect at boot. It uses the URI according to the
* AutoConnectConfig::bootUti setting with the AutoConnectConfig::homeUri
* as the boot path.
* @return the boot uri.
*/
String AutoConnect::_getBootUri(void) {
if (_apConfig.bootUri == AC_ONBOOTURI_ROOT)
return String(AUTOCONNECT_URI);
else if (_apConfig.bootUri == AC_ONBOOTURI_HOME)
return _apConfig.homeUri.length() > 0 ? _apConfig.homeUri : String("/");
else
return _emptyString;
}
/**
* Obtains the currently established AP connection to determine if the
* station configuration needs to run before the first WiFi.begin.
* Get the SSID of the currently connected AP stored in the ESP module
* by using the SDK API natively.
* AutoConnect::begin retrieves the IP configuration from the stored
* credentials of AutoConnectCredential based on that SSID and executes
* WiFi.config before WiFi.begin.
* @param config Station configuration stored in the ESP module.
* @return true The config parameter has obtained configuration.
* @return false Station configuration does not exist.
*/
bool AutoConnect::_getConfigSTA(station_config_t* config) {
bool rc;
uint8_t* ssid;
uint8_t* bssid;
#if defined(ARDUINO_ARCH_ESP8266)
struct station_config current;
ssid = current.ssid;
bssid = current.bssid;
rc = wifi_station_get_config(¤t);
#elif defined(ARDUINO_ARCH_ESP32)
wifi_config_t current;
ssid = current.sta.ssid;
bssid = current.sta.bssid;
rc = (esp_wifi_get_config(WIFI_IF_STA, ¤t) == ESP_OK);
#endif
if (rc) {
memcpy(config->ssid, ssid, sizeof(station_config_t::ssid));
memcpy(config->bssid, bssid, sizeof(station_config_t::bssid));
}
return rc;
}
/**
* Stops AutoConnect captive portal service.
*/
void AutoConnect::end(void) {
_currentPageElement.reset();
_ticker.reset();
_update.reset();
_ota.reset();
_stopPortal();
_dnsServer.reset();
_webServer.reset();
}
/**
* Get the total amount of memory required to hold the AutoConnect credentials
* and any custom configuration settings stored in EEPROM.
* This function is available only for ESP8266 use.
* @return Combined size of AutoConnect credentials and custom settings.
*/
uint16_t AutoConnect::getEEPROMUsedSize(void) {
#if defined(ARDUINO_ARCH_ESP8266)
AutoConnectCredential credentials(_apConfig.boundaryOffset);
return _apConfig.boundaryOffset + credentials.dataSize();
#elif defined(ARDUINO_ARCH_ESP32)
return 0;
#endif
}
/**
* Handling for the AutoConnect web interface.
* Invoke the handleClient of parent web server to process client request of
* AutoConnect WEB interface.
* No effects when the web server is not available.
*/
void AutoConnect::handleClient(void) {
// Is there DNS Server process next request?
if (_dnsServer)
_dnsServer->processNextRequest();
// handleClient valid only at _webServer activated.
if (_webServer)
_webServer->handleClient();
handleRequest();
}
/**
* Handling for the AutoConnect menu request.
*/
void AutoConnect::handleRequest(void) {
bool skipPostTicker;
// Controls reconnection and portal startup when WiFi is disconnected.
if (WiFi.status() != WL_CONNECTED) {
// Launch the captive portal when SoftAP is active and autoRise is
// specified to be maintained.
// Pass all URL requests to _captivePortal to disguise the captive portal.
if (_apConfig.retainPortal && _apConfig.autoRise) {
// Cancel AutoReconnect to ensure detection for queries to penetrate
// to the internet from a client.
if (WiFi.getAutoConnect())
WiFi.setAutoReconnect(false);
// Restart the responder for the captive portal detection.
if (!(WiFi.getMode() & WIFI_AP)) {
_softAP();
_currentHostIP = WiFi.softAPIP();
}
if (!_dnsServer) {
bool cs = _onDetectExit ? _onDetectExit(_currentHostIP) : true;
if (cs)
_startDNSServer();
}
}
// AutoConnectConfig::reconnectInterval allows a dynamic connection
// to a known access point without blocking the execution of
// Sketch's loop function.
if (_apConfig.autoReconnect && _apConfig.reconnectInterval > 0) {
int8_t sc = WiFi.scanComplete();
// Scan has not triggered then starts asynchrony scan and repeats at
// intervals of time with AutoConnectConfig::reconnectInterval value
// multiplied by AUTOCONNECT_UNITTIME.
if (sc == WIFI_SCAN_FAILED) {
if (millis() - _attemptPeriod > ((unsigned long)_apConfig.reconnectInterval * AUTOCONNECT_UNITTIME * 1000)) {
int8_t sn = WiFi.scanNetworks(true, true);
AC_DBG("autoReconnect %s\n", sn == WIFI_SCAN_RUNNING ? "running" : "failed");
_attemptPeriod = millis();
(void)(sn);
}
}
// After the background scan is complete, seek a connectable
// access point. If it is found, it will generate a connection
// request inside.
else if (sc != WIFI_SCAN_RUNNING) {
AC_DBG("%d network(s) found\n", (int)sc);
if (sc > 0) {
if (_seekCredential(_apConfig.principle, _rfAdHocBegin ? AC_SEEKMODE_CURRENT : AC_SEEKMODE_ANY))
_rfConnect = true;
}
WiFi.scanDelete();
}
}
}
else
_attemptPeriod = millis();
// Handling processing requests to AutoConnect.
if (_rfConnect) {
// Leave from the AP currently.
if (WiFi.status() == WL_CONNECTED)
_disconnectWiFi(true);
// Leave current AP, reconfigure station
_configSTA(_apConfig.staip, _apConfig.staGateway, _apConfig.staNetmask, _apConfig.dns1, _apConfig.dns2);
// Purge scan results to initialize the asynchronous network scan that
// will be triggered by disconnection during handleRequests.
WiFi.scanDelete();
// An attempt to establish a new AP.
int32_t ch = _connectCh == 0 ? _apConfig.channel : _connectCh;
char ssid_c[sizeof(station_config_t::ssid) + 1];
char password_c[sizeof(station_config_t::password) + 1];
*ssid_c = '\0';
strncat(ssid_c, reinterpret_cast<const char*>(_credential.ssid), sizeof(ssid_c) - 1);
*password_c = '\0';
strncat(password_c, reinterpret_cast<const char*>(_credential.password), sizeof(password_c) - 1);
AC_DBG("WiFi.begin(%s%s%s) ch(%d)", ssid_c, strlen(password_c) ? "," : "", strlen(password_c) ? password_c : "", (int)ch);
_redirectURI = "";
// Establish a WiFi connection with the access point.
if (WiFi.begin(ssid_c, password_c, ch) != WL_CONNECT_FAILED) {
// Wait for the connection attempt to complete and send a response
// page to notify the connection result.
// End the current session to complete a response page transmission.
_rsConnect = _waitForConnect(_apConfig.beginTimeout);
do {
_webServer->handleClient();
} while (_webServer->client());
if (_rsConnect == WL_CONNECTED) {
// WLAN successfully connected then release the DNS server.
// Also, stop WIFI_AP if retainPortal not specified.
_stopDNSServer();
if (!_apConfig.retainPortal) {
WiFi.softAPdisconnect(true);
WiFi.enableAP(false);
}
else {
AC_DBG("Maintain SoftAP\n");
}
// WiFi linked, validate availability
if (WiFi.BSSID() != NULL) {
// Successfully conencted
memcpy(_credential.bssid, WiFi.BSSID(), sizeof(station_config_t::bssid));
_currentHostIP = WiFi.localIP();
_redirectURI = String(F(AUTOCONNECT_URI_SUCCESS));
// Ensures that keeps a connection with the current AP
// while the portal behaves.
_setReconnect(AC_RECONNECT_SET);
}
// WiFi linked up, but IP does not bind.
else
_rsConnect = WL_CONNECT_FAILED;
// Activate AutoConnectUpdate if it is attached and incorporate
// it into the AutoConnect menu.
if (_update)
_update->enable();
}
else {
_currentHostIP = WiFi.softAPIP();
_redirectURI = String(F(AUTOCONNECT_URI_FAIL));
_disconnectWiFi(false);
wl_status_t wl = WiFi.status();
unsigned long tm = millis();
while (wl != WL_IDLE_STATUS && wl != WL_DISCONNECTED && wl != WL_NO_SSID_AVAIL) {
if (millis() - tm > 3000)
break;
delay(1);
yield();
wl = WiFi.status();
}
AC_DBG("Quit connecting, status(%d)\n", wl);
}
// It will automatically save the credential which was able to
// establish current connection.
// AC_SAVECREDENTIAL_ALWAYS is an option to intentionally register
// an unconnected credential. This option allows the storage of a
// credential regardless of the established WIFI connection.
if (_apConfig.autoSave == AC_SAVECREDENTIAL_ALWAYS ||
((_rsConnect == WL_CONNECTED) & (_apConfig.autoSave == AC_SAVECREDENTIAL_AUTO))) {
AutoConnectCredential credit(_apConfig.boundaryOffset);
if (credit.save(&_credential)) {
AC_DBG("%.*s credential saved\n", sizeof(_credential.ssid), reinterpret_cast<const char*>(_credential.ssid));
}
else {
AC_DBG("credential %.*s save failed\n", sizeof(_credential.ssid), reinterpret_cast<const char*>(_credential.ssid));
}
}
}
_rfConnect = false;
}
if (_rfReset) {
// Reset or disconnect by portal operation result
_stopPortal();
AC_DBG("Reset\n");
delay(1000);
SOFT_RESET();
delay(1000);
}
if (_rfDisconnect) {
// Response for disconnection request is not completed while
// the session exists.
if (!_webServer->client()) {
// Disconnect from the current AP.
_disconnectWiFi(false);
while (WiFi.status() == WL_CONNECTED) {
delay(10);
yield();
}
AC_DBG("Disconnected ");
if ((WiFi.getMode() & WIFI_AP) && !_apConfig.retainPortal) {
_stopPortal();
}
else {
if (_dnsServer)
AC_DBG_DUMB("- Portal maintained");
AC_DBG_DUMB("\n");
}
// Reset disconnection request
_rfDisconnect = false;
if (_apConfig.autoReset) {
delay(1000);
SOFT_RESET();
delay(1000);
}
}
}
// Indicate that not disturb the ticker cycle during OTA.
// It will be set to true during OTA in progress due to
// subsequent OTA handling.
skipPostTicker = false;
// Handle the update behaviors for attached AutoConnectUpdate.
if (_update) {
_update->handleUpdate();
if (_update->status() == UPDATE_PROGRESS)
skipPostTicker = true;
}
// Attach AutoConnectOTA if OTA is available.
if (_apConfig.ota == AC_OTA_BUILTIN) {
if (!_ota) {
_ota.reset(new AutoConnectOTA());
_ota->extraCaption = _apConfig.otaExtraCaption;
_ota->attach(*this);
_ota->authentication(_apConfig.auth);
_ota->setTicker(_apConfig.tickerPort, _apConfig.tickerOn);
if (_onOTAStartExit)
_ota->onStart(_onOTAStartExit);
if (_onOTAEndExit)
_ota->onEnd(_onOTAEndExit);
if (_onOTAErrorExit)
_ota->onError(_onOTAErrorExit);
if (_onOTAStartExit)
_ota->onProgress(_onOTAProgressExit);
}
}
// Post-process for AutoConnectOTA
if (_ota) {
if (_ota->status() == AutoConnectOTA::AC_OTA_RIP) {
// Indicate the reboot at the next handleClient turn
// with on completion of the update via OTA.
if (_webServer->client().connected()) {
_webServer->client().setNoDelay(true);
_ota->reset();
}
if (_ota->dest() == AutoConnectOTA::OTA_DEST_FIRM)
// OTA for firmware update requires module reset.
_rfReset = true;
}
else if (_ota->status() == AutoConnectOTA::AC_OTA_PROGRESS)
skipPostTicker = true;
// Reflect the menu display specifier from AutoConnectConfig to
// AutoConnectOTA page
_ota->menu(_apConfig.menuItems & AC_MENUITEM_UPDATE);
}
// Post-process for ticker
// Adjust the ticker cycle to the latest WiFi connection state.
if (_ticker && !skipPostTicker) {
uint8_t tWidth;
uint32_t tCycle = WiFi.status() == WL_CONNECTED ? 0 : AUTOCONNECT_FLICKER_PERIODDC;
tWidth = AUTOCONNECT_FLICKER_WIDTHDC;
if (WiFi.getMode() & WIFI_AP) {
tCycle = AUTOCONNECT_FLICKER_PERIODAP;
tWidth = AUTOCONNECT_FLICKER_WIDTHAP;
}
if (tCycle != _ticker->getCycle()) {
_ticker->stop();
if (tCycle)
_ticker->start(tCycle, tWidth);
}
}
}
/**
* Put a user site's home URI.
* The URI specified by home is linked from "HOME" in the AutoConnect
* portal menu.
* @param uri A URI string of user site's home.
*/
void AutoConnect::home(const String& uri) {
_apConfig.homeUri = uri;
}
/**
* Returns the current hosted ESP8266WebServer.
*/
WebServerClass& AutoConnect::host(void) {
return *_webServer;
}
/**
* Returns AutoConnectAux instance of specified.
* @param uri An uri string.
* @return A pointer of AutoConnectAux instance.
*/
AutoConnectAux* AutoConnect::aux(const String& uri) const {
AutoConnectAux* aux_p = _aux;
while (aux_p) {
if (!strcmp(aux_p->uri(), uri.c_str()))
break;
aux_p = aux_p->_next;
}
if (!aux_p) {
AC_DBG("'%s' not found in auxiliaries", uri.c_str());
if (uri[0] != '/') {
AC_DBG_DUMB(", path may be missing '/'");
}
AC_DBG_DUMB("\n");
}
return aux_p;
}
/**
* Creates an AutoConnectAux dynamically with the specified URI and
* integrates it into the menu. Returns false if a menu item with
* the same URI already exists.
* @param uri An uri of a new item to add
* @param title Title of the menu item
* @return A pointer to an added AutoConnectAux
*/
AutoConnectAux* AutoConnect::append(const String& uri, const String& title) {
AutoConnectAux* reg = aux(uri);
if (!reg) {
reg = new AutoConnectAux(uri, title);
reg->_deletable = true;
join(*reg);
return reg;
}
AC_DBG("%s has already listed\n", uri.c_str());
return nullptr;
}
/**
* Creates an AutoConnectAux dynamically with the specified URI and
* integrates it into the menu. It will register the request handler
* for the WebServer after the addMenuItem works. It has similar
* efficacy to calling addMenuItem and WebSever::on at once.
* @param uri An uri of a new item to add
* @param title Title of the menu item
* @param handler Function of the request handler for WebServer class
* @return true Added
* @return A pointer to an added AutoConnectAux
*/
AutoConnectAux* AutoConnect::append(const String& uri, const String& title, WebServerClass::THandlerFunction handler) {
if (_webServer) {
AutoConnectAux* reg = append(uri, title);
if (reg)
_webServer->on(uri, handler);
return reg;
}
AC_DBG("No WebServer instance\n");
return nullptr;
}
/**
* Detach a AutoConnectAux from the portal.
* @param uri An uri of the AutoConnectAux should be released
* @return true Specified AUX has released
* @return false Specified AUX not registered
*/
bool AutoConnect::detach(const String &uri) {
AutoConnectAux** self = &_aux;
while (*self) {
if (!strcmp((*self)->uri(), uri.c_str())) {
AC_DBG("%s released\n", (*self)->uri());
AutoConnectAux* ref = *self;
*self = (*self)->_next;
if (ref->_deletable)
delete ref;
return true;
}
self = &((*self)->_next);
}
AC_DBG("%s not listed\n", uri.c_str());
return false;
}
/**
* Append auxiliary pages made up with AutoConnectAux.
* @param aux A reference to AutoConnectAux that made up
* the auxiliary page to be added.
*/
void AutoConnect::join(AutoConnectAux& aux) {
if (_aux)
_aux->_concat(aux);
else
_aux = &aux;
aux._join(*this);
AC_DBG("%s on hands\n", aux.uri());
}
/**
* Append auxiliary pages made up with AutoConnectAux.
* @param aux A vector of reference to AutoConnectAux that made up
* the auxiliary page to be added.
*/
void AutoConnect::join(AutoConnectAuxVT auxVector) {
for (std::reference_wrapper<AutoConnectAux> aux : auxVector)
join(aux.get());
}
/**
* Register the exit routine for AutoConnectAux.
* @param uri Specify the URI of the AutoConnectAux page that
* registers the exit routine.
* @param handler A handler function of the exit routine.
* @param order Specify an enumeration type of
* AutoConnectExitOrder_t for the call timing of the exit routine.
* @return true An exit routine registered.
* @return false AutoConnectAux page for the specified URI is not
* registered.
*/
bool AutoConnect::on(const String& uri, const AuxHandlerFunctionT handler, AutoConnectExitOrder_t order) {
AutoConnectAux* aux = _aux;
while (aux) {
if (!strcmp(uri.c_str(), aux->uri())) {
aux->on(handler, order);
return true;
}
aux = aux->_next;
}
return false;
}
/**
* Register the exit routine that is being called when WiFi connected.
* @param fn A function of the exit routine.
*/
void AutoConnect::onConnect(ConnectExit_ft fn) {
_onConnectExit = fn;
}
/**
* Register the exit routine for the starting captive portal.
* @param fn A function of the exit routine.
*/
void AutoConnect::onDetect(DetectExit_ft fn) {
_onDetectExit = fn;
}
/**
* Register the handler function for undefined url request detected.
* @param fn A function of the not found handler.
*/
void AutoConnect::onNotFound(WebServerClass::THandlerFunction fn) {
_notFoundHandler = fn;
}
/**
* Register an exit routine to call during the captive portal.
* @param fn A function of the exit routine that calls while captive portal.
*/
void AutoConnect::whileCaptivePortal(WhileCaptivePortalExit_ft fn) {
_whileCaptivePortal = fn;
}
/**
* Register a status change notification callback function
* @param fn A status change notification callback function.
*/
void AutoConnect::onOTAStart(OTAStartExit_ft fn) {
_onOTAStartExit = fn;
}
/**
* Register a status change notification callback function
* @param fn A status change notification callback function.
*/
void AutoConnect::onOTAEnd(OTAEndExit_ft fn) {
_onOTAEndExit = fn;
}
/**
* Register a status change notification callback function
* @param fn A status change notification callback function.
*/
void AutoConnect::onOTAError(OTAErrorExit_ft fn) {
_onOTAErrorExit = fn;
}
/**
* Register a status change notification callback function
* @param fn A status change notification callback function.
*/
void AutoConnect::onOTAProgress(OTAProgressExit_ft fn) {
_onOTAProgressExit = fn;
}
/**
* Load current available credential
* @param ssid A pointer to the buffer that SSID should be stored.
* @param password A pointer to the buffer that password should be stored.
* @param principle WiFi connection principle.
* @param excludeCurrent Skip loading the current SSID.
* @return true Current SSID and password returned.
* @return false There is no available SSID.
*/
bool AutoConnect::_loadCurrentCredential(char* ssid, char* password, const AC_PRINCIPLE_t principle, const bool excludeCurrent) {
bool rc;
if ((rc = _loadAvailCredential(nullptr, principle, excludeCurrent))) {
strcpy(ssid, reinterpret_cast<const char*>(_credential.ssid));
strcpy(password, reinterpret_cast<const char*>(_credential.password));
}
return rc;
}
/**
* Load stored credentials that match nearby WLANs.
* @param ssid SSID which should be loaded. If nullptr is assigned, search SSID with WiFi.scan.
* @param principle WiFi connection principle.
* @param excludeCurrent Skip loading the current SSID.
* @return true A matched credential of BSSID was loaded.
*/
bool AutoConnect::_loadAvailCredential(const char* ssid, const AC_PRINCIPLE_t principle, const bool excludeCurrent) {
AutoConnectCredential credential(_apConfig.boundaryOffset);
if (credential.entries() > 0) {
// Scan the vicinity only when the saved credentials are existing.
if (!ssid) {
int8_t nn = WiFi.scanNetworks(false, true);
AC_DBG_DUMB(", %d network(s) found", (int)nn);
if (nn > 0)
return _seekCredential(principle, excludeCurrent ? AC_SEEKMODE_NEWONE : AC_SEEKMODE_ANY);
}
// The SSID to load was specified.
// Set the IP configuration globally from the saved credential.
else if (strlen(ssid))
if (credential.load(ssid, &_credential) >= 0) {
if (_credential.dhcp == STA_STATIC) {
_apConfig.staip = static_cast<IPAddress>(_credential.config.sta.ip);
_apConfig.staGateway = static_cast<IPAddress>(_credential.config.sta.gateway);
_apConfig.staNetmask = static_cast<IPAddress>(_credential.config.sta.netmask);
_apConfig.dns1 = static_cast<IPAddress>(_credential.config.sta.dns1);
_apConfig.dns2 = static_cast<IPAddress>(_credential.config.sta.dns2);
}
return true;
}
}
return false;
}
/**