wirtz
/
AutoConnect
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
146 Commits
3 Branches
19 Tags
22 MiB
 
 
 
 
 
Tag: Branch: Tree: abec10c1bd
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'abec10c1bd'
${ noResults }
AutoConnect/mkdocs/apiconfig.md

8.9 KiB
Raw Blame History

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.

bootUri

Specify the location to be redirected after module reset in the AutoConnect menu. It is given as an enumeration value of AC_ONBOOTURI_t indicating either the AutoConnect root path or the user screen home path.

**Type**
AC_ONBOOTURI_t
**Value**
AC_ONBOOTURI_ROOTResetting the module redirects it to the AutoConnect root path. The root path is assumed to be AUTOCONNECT_URI defined in AutoConnectDefs.h.
AC_ONBOOTURI_HOMEIt is redirected to the uri specified by [**AutoConnectConfig::homeUri**](apiconfig.md#homeuri).

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

!!! warning "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.

!!! info "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. The default for homeUri is "/".

**Type**
String

hostName

Sets the station host name of ESP8266/ESP32.

**Type**
String

immediateStart

Disable the first WiFi.begin() and start the captive portal. If this option is enabled, the module will be in AP_STA mode and the captive portal will be activated regardless of AutoConnectConfig::autoRise specification.

**Type**
bool
**Value**
trueStart the captive portal with [**AutoConnect::begin**](api.md#begin).
falseEnable the first WiFi.begin() and it will start captive portal when connection failed. This is default.

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