Library APIs

Include headers¶

AutoConnect.h¶

#include <AutoConnect.h>

Defined macros¶

#define AC_DEBUG                                // Monitor message output activation
#define AC_DEBUG_PORT           Serial          // Default message output device
#define AUTOCONNECT_AP_IP       0x01F4A8C0      // Default SoftAP IP
#define AUTOCONNECT_AP_GW       0x01F4A8C0      // Default SoftAP Gateway IP
#define AUTOCONNECT_AP_NM       0x00FFFFFF      // Default subnet mask
#define AUTOCONNECT_DNSPORT     53              // Default DNS port at captive portal
#define AUTOCONNECT_HTTPPORT    80              // Default HTTP
#define AUTOCONNECT_MENU_TITLE  "AutoConnect"   // Default AutoConnect menu title
#define AUTOCONNECT_STARTUPTIME 10              // Default waiting time[s] for after reset
#define AUTOCONNECT_URI         "/_ac"          // Default AutoConnect root path
#define AUTOCONNECT_TIMEOUT     30000           // Default connection timeout[ms]

AutoConnect API¶

Constructors¶

AutoConnect¶

AutoConnect()

AutoConnect default constructor. This entry internally allocates the ESP8266WebServer for ESP8266 or WebServer for ESP32 and is activated internally.

For ESP8266

AutoConnect(ESP8266WebServer& webServer)

For ESP32

AutoConnect(WebServer& webServer)

Run the AutoConnect site using the externally ensured ESP8266WebServer for ESP8266 or WebServer for ESP32.

The handleClient function of AutoConnect can include the response of the URI handler added by the user using the "on" function of ESP8266WebServer/WebServer. If ESP8266WebServer/WebServer is assigned internally by AutoConnect, the sketch can obtain that reference with the host function.

Parameters: webServerA reference of ESP8266WebServer or WebServer instance.

Public member functions¶

begin¶

bool begin()

bool begin(const char* ssid, const char* passphraase)

bool begin(const char* ssid, const char* passphraase, unsigned long timeout)

Starts establishing the WiFi connection.
AutoConnect first invokes WiFi.begin. If the case of SSID and Password missing, its WiFi.begin has no SSID and Password. The WiFi mode at this time is WIFI_STA. Then ESP8266WebServer/WebServer will be started immediately after the first WiFi.begin regardless of the result.

The captive portal will not be started if the connection has been established with first WiFi.begin. If the connection cannot establish, switch to WIFI_AP_STA mode and activate SoftAP. Then DNS server starts.

Parameters: ssidSSID to be connected.; passphrasePassword for connection.; timeoutA time out value in milliseconds for waiting connection.
Return value: trueConnection established, AutoConnect service started with WIFI_STA mode.; falseCould not connected, Captive portal started with WIFI_AP_STA mode.

config¶

bool config(AutoConnectConfig& config)

bool config(const char* ap, const char* password = nullptr)

Set SoftAP's WiFi configuration and static IP configuration.

Parameters: configReference to AutoConnectConfig containing SoftAP's parameters and static IP parameters.; apSSID for SoftAP. The default value is esp8266ap for ESP8266, esp32ap for ESP32.; passwordPassword for SodtAP. The default value is 12345678.
Return value: trueSuccessfully configured.; falseConfiguration parameter is invalid, some values out of range.

end¶

void end()

Stops AutoConnect captive portal service. Release ESP8266WebServer/WebServer and DNSServer.

Attention to end

The end function releases the instance of ESP8266WebServer/WebServer and DNSServer. It can not process them after the end function.

handleClient¶

void handleClient()

Process the AutoConnect menu interface. The handleClient() function of the ESP8266WebServer/WebServer hosted by AutoConnect is also called from within AutoConnect and client requests contained in the user sketch handler are also handled.

handleRequest¶

void handleRequest()

Handling for the AutoConnect menu request.

About used in combination with handleClient

The handleRequest function is not supposed to use with AutoConnect::handleClient. It should be used with ESP8266WebServer::handleClient or WebServer::handleClient.

home¶

void home(String uri)

Put a user site's home URI. The URI specified by home is linked from "HOME" in the AutoConnect menu.

Parameters: uri A URI string of user site's home path.

host¶

Returns the reference of the ESP8266WebServer/WebServer which is allocated in AutoConnect automatically.

For ESP8266

ESP8266WebServer& host()

For ESP32

WebServer& host()

Return value: A reference of the ESP8266WebServer/WebServer.

&reference is not a pointer

A reference cannot be re-assigned, and must be assigned at initialization. It's like as bind as alias.

ESP8266WebServer& server = portal.host();
server.handleClient();

or

portal.host().handleClient();

onDetect¶

void onDetect(DetectExit_ft fn)

Register the function which will call from AutoConnect at the start of the captive portal.

Parameters: fnFunction called at the captive portal start.

An fn specifies the function called when the captive portal starts. Its prototype declaration is defined as "DetectExit_ft".

typedef std::function<bool(IPAddress softapIP)>  DetectExit_ft

Parameters: softapIPAn IP address of SoftAP for the captive portal.
Retuen value: trueContinues captive portal handling.; falseCancel the captive portal. AutoConnect::begin function will return with a false.

onNotFound¶

For ESP8266

void onNotFound(ESP8266WebServer::THandlerFunction fn)

For ESP32

void onNotFound(WebServer::THandlerFunction fn)

Register the handler function for undefined URL request detected.

Parameters: fnA function of the "not found" handler.

AutoConnectConfig API¶

Constructor¶

AutoConnectConfig¶

AutoConnectConfig();

AutoConnectConfig(const char* ap, const char* password);

Parameters: apSSID for SoftAP. The length should be up to 31. The default value is esp8266ap for ESP8266, esp32ap for ESP32.; passwordPassword for SodtAP. The length should be from 8 to up to 63. The default value is 12345678.

Public member variables¶

apid¶

SoftAP's SSID.

Type: String

apip¶

Sets IP address for Soft AP in captive portal. When AutoConnect fails the initial WiFi.begin, it starts the captive portal with the IP address specified this.

Type: IPAddressThe default value is 192.168.244.1

autoReconnect¶

Automatically will try to reconnect with the past established access point (BSSID) when the current configured SSID in ESP8266/ESP32 could not be connected. By enabling this option, AutoConnect::begin() function will attempt to reconnect to a known access point using credentials stored in the EEPROM, even if the connection failed by current SSID.
If the connection fails, starts the captive portal in SoftAP + STA mode.

Type: bool
Value: trueReconnect automatically.; falseStarts Captive Portal in SoftAP + STA mode without trying to reconnect. This is the default.

When the autoReconnect option is enabled, an automatic connection will behave if the following conditions are satisfied.

Invokes AutoConnect::begin without user name and password parameter as begin().
If one of the saved BSSIDs (not the SSID) of the credentials matches the BSSID detected by the network scan.

autoReset¶

Reset ESP8266 module automatically after WLAN disconnected.

Type: bool
Value: trueReset after WiFi disconnected automatically.; falseNo reset.

autoRise¶

Captive portal activation switch. False for disabling the captive portal. It prevents starting the captive portal even if the connection at the first WiFi.begin fails.

Type: bool
Value: trueEnable the captive portal. This is the default.; falseDisable the captive portal.

autoSave¶

The credential saved automatically at the connection establishment.

Type: AC_SAVECREDENTIAL_t
Value: AC_SAVECREDENTIAL_AUTOThe credential saved automatically. This is the default.; AC_SAVECREDENTIAL_NEVERThe credential no saved.

boundaryOffset¶

Sets the offset address of the credential storage area for EEPROM. This value must be between greater than 4 and less than flash sector size. (4096 by SDK)
The default value is 0.

Type: uint16_t

It will conflict with user data.

If the sketch leaves this offset at zero, it will conflict the storage area of credentials with the user sketch owned data. It needs to use the behind of credential area.

channel¶

The channel number of WIFi when SoftAP starts.

Type: uint8_t
Value: 1 ~ 14. The default value is 1.

How do I choose Channel

Espressif Systems had announced the application note about Wi-Fi channel selection.

dns1¶

Set primary DNS server address when using static IP address.

Type: IPAddress

dns2¶

Set secondary DNS server address when using static IP address.

Type: IPAddress

gateway¶

Sets gateway address for Soft AP in captive portal. When AutoConnect fails the initial WiFi.begin, it starts the captive portal with the IP address specified this.

Type: IPAddressThe default value is 192.168.244.1

hidden¶

Sets SoftAP to hidden SSID.

Type: uint8_t
Value: 0SSID will be appeared. This is the default.; 1SSID will be hidden.

homeUri¶

Sets the home path of user sketch. This path would be linked from 'HOME' in the AutoConnect menu.

Type: String

netmask¶

Sets subnet mask for Soft AP in captive portal. When AutoConnect fails the initial WiFi.begin, it starts the captive portal with the IP address specified this.

Type: IPAddressThe default value is 255.255.255.0

psk¶

Sets password for SoftAP. The length should be from 8 to up to 63. The default value is 12345678.

Type: String

staip¶

Set a static IP address. The IP will behave with STA mode.

Type: IPAddress

staGateway¶

Set the gateway address when using static IP address.

Type: IPAddress

staNetmask¶

Set the subnetmask when using static IP address.

Type: IPAddress

AutoConnectConfig example¶

AutoConenct        Portal;
AutoConenctConfig  Config("", "passpass");    // SoftAp name is determined at runtime
Config.apid = ESP.hostname();                 // Retrieve host name to SotAp identification
Config.apip = IPAddress(192,168,10,101);      // Sets SoftAP IP address
Config.gateway = IPAddress(192,168,10,1);     // Sets WLAN router IP address
Config.netmask = IPAddress(255,255,255,0);    // Sets WLAN scope
Config.autoReconnect = true;                  // Enable auto-reconnect
Config.autoSave = AC_SAVECREDENTIAL_NEVER;    // No save credential
COnfig.boundaryOffet = 64;                    // Reserve 64 bytes for the user data in EEPROM. 
Config.homeUri = "/index.html"                // Sets home path of the sketch application
Config.staip = IPAddress(192,168,10,10);      // Sets static IP
Config.staGateway = IPAddress(192,168,10,1);  // Sets WiFi router address
Config.staNetmask = IPAddress(255,255,255,0); // Sets WLAN scope
Config.dns1 = IPAddress(192,168,10,1);        // Sets primary DNS address
Portal.config(Config);                        // Configure AutoConnect
Portal.begin();                               // Starts and behaves captive portal

Something extra¶

The library presents two PNG icons which can be used to embed a hyperlink to the AutoConnect menu.

Bar type
Cog type

To reference the icon, use the AUTOCONNECT_LINK macro in the sketch. It expands into the string literal as an HTML <a></a> tag with PNG embedded of the AutoConnect menu hyperlinks. Icon type is specified by the parameter of the macro.

BAR_24Bars icon, 24x24.

BAR_32Bars icon, 32x32.

BAR_48Bars icon, 48x48.

COG_24Cog icon, 24x24.

COG_32Cog icon, 32x32.

Usage

String html = "<html>";
html += AUTOCONNECT_LINK(BAR_32);
html += "</html>";
server.send(200, "text/html", html);