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.
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.
@@ -1158,8 +1172,8 @@ If the connection fails, starts the captive portal in SoftAP + STA mode.
When the autoReconnect option is enabled, an automatic connection will behave if the following conditions are satisfied.
@@ -1172,8 +1186,8 @@ If the connection fails, starts the captive portal in SoftAP + STA mode.
- Type
- bool
- Value
- - trueReset after WiFi disconnected automatically.
- - falseNo reset.
+ - 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.
@@ -1181,8 +1195,8 @@ If the connection fails, starts the captive portal in SoftAP + STA mode.
- Type
- bool
- Value
- - trueEnable the captive portal. This is the default.
- - falseDisable the captive portal.
+ - trueEnable the captive portal. This is the default.
+ - falseDisable the captive portal.
autoSave
The credential saved automatically at the connection establishment.
@@ -1190,8 +1204,8 @@ If the connection fails, starts the captive portal in SoftAP + STA mode.
- Type
- AC_SAVECREDENTIAL_t
- Value
- - AC_SAVECREDENTIAL_AUTOThe credential saved automatically. This is the default.
- - AC_SAVECREDENTIAL_NEVERThe credential no saved.
+ - AC_SAVECREDENTIAL_AUTO The credential saved automatically. This is the default.
+ - AC_SAVECREDENTIAL_NEVER The 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.
@@ -1199,8 +1213,8 @@ If the connection fails, starts the captive portal in SoftAP + STA mode.
- 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.
+ - AC_ONBOOTURI_ROOT Resetting the module redirects it to the AutoConnect root path. The root path is assumed to be AUTOCONNECT_URI defined in AutoConnectDefs.h.
+ - AC_ONBOOTURI_HOME It is redirected to the uri specified by AutoConnectConfig::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)
@@ -1241,7 +1255,7 @@ The default value is 0.
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
+ - IPAddressThe default value is 192.168.244.1
hidden
Sets SoftAP to hidden SSID.
@@ -1249,8 +1263,8 @@ The default value is 0.
- Type
- uint8_t
- Value
- - 0SSID will be appeared. This is the default.
- - 1SSID will be hidden.
+ - 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 "/".
@@ -1270,20 +1284,20 @@ The default value is 0.
- Type
- bool
- Value
- - trueStart the captive portal with AutoConnect::begin.
- - falseEnable the first WiFi.begin() and it will start captive portal when connection failed. This is default.
+ - trueStart the captive portal with AutoConnect::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
+ - IPAddressThe default value is 255.255.255.0
portalTimeout
Specify the timeout value of the captive portal in [ms] units. It is valid when the station is not connected and does not time out if the station is connected to the ESP module in SoftAP mode (ie Attempting WiFi connection with the portal function). If 0, the captive portal will not be timed-out.
- Type
- - unsigned longCaptive portal timeout value. The default value is 0.
+ - unsigned longCaptive portal timeout value. The default value is 0.
psk
Sets password for SoftAP. The length should be from 8 to up to 63. The default value is 12345678.
@@ -1297,8 +1311,8 @@ The default value is 0.
- Type
- bool
- Value
- - trueContinue the portal function even if the captive portal times out. The STA + SoftAP mode of the ESP module continues and accepts the connection request to the AP.
- - falseWhen the captive portal times out, STA + SoftAP mode of the ESP module is stopped. This is default.
+ - trueContinue the portal function even if the captive portal times out. The STA + SoftAP mode of the ESP module continues and accepts the connection request to the AP.
+ - falseWhen the captive portal times out, STA + SoftAP mode of the ESP module is stopped. This is default.
Connection request after timed-out
diff --git a/docs/apielements.html b/docs/apielements.html
index af66727..a79eff4 100644
--- a/docs/apielements.html
+++ b/docs/apielements.html
@@ -73,6 +73,8 @@
+
+
@@ -982,6 +984,101 @@
AutoConnectSelect
+
+
-
@@ -1063,8 +1160,20 @@
-
-
- Tips for data retrieval
+
+ Tips for data conversion
+
+
+
+
+
+
+
+
+
+
-
+
+ Constucting the menu
@@ -1075,8 +1184,8 @@
-
-
- Constucting menu
+
+ Custom Web pages w/o JSON
@@ -1578,6 +1687,101 @@
AutoConnectSelect
+
+
-
@@ -1619,28 +1823,28 @@
- Parameters
- - nameThe element name.
- - valueValue of the element.
- - actionNative code of the action script executed when the button is clicked.
+ - nameThe element name.
+ - valueValue of the element.
+ - actionNative code of the action script executed when the button is clicked.
Public member variables
name
The element name.
- Type
- - String
+ - String
value
Value of the element.
- Type
- - String
+ - String
action
HTML native code of the action script to be executed when the button is clicked. It is mostly used with a JavaScript to activate a script.
- Type
- - String
+ - String
Public member functions
typeOf
@@ -1657,35 +1861,35 @@ Returns type of AutoConnectElement.
- Parameters
- - nameThe element name.
- - valueValue of the element.
- - labelA label string prefixed to the checkbox.
- - checkChecked state of the checkbox.
+ - nameThe element name.
+ - valueValue of the element.
+ - labelA label string prefixed to the checkbox.
+ - checkChecked state of the checkbox.
Public member variables
name
The element name.
- Type
- - String
+ - String
value
Value of the element. It becomes a value attribute of an HTML <input type="checkbox"> tag.
- Type
- - String
+ - String
label
A label is an optional string. A label is always arranged on the right side of the checkbox. Specification of a label will generate an HTML <label> tag with an id attribute. The checkbox and the label are connected by the id attribute.
- Type
- - String
+ - String
checked
It indicates the checked status of the checkbox. The value of the checked checkbox element is packed in the query string and sent by submit.
- Type
- - Boolean
+ - Boolean
Public member functions
typeOf
@@ -1702,21 +1906,21 @@ Returns type of AutoConnectElement.
- Parameters
- - nameThe element name.
- - valueValue of the element.
+ - nameThe element name.
+ - valueValue of the element.
Public member variables
name
The element name.
- Type
- - String
+ - String
value
Value of the element. It is output as HTML as it is as a source for generating HTML code.
- Type
- - String
+ - String
Public member functions
typeOf
@@ -1733,42 +1937,42 @@ Returns type of AutoConnectElement.
- Parameters
- - nameThe element name.
- - valueValue of the element.
- - labelLabel string.
- - patternRegular expression string for checking data format.
- - placeholderA placeholder string.
+ - nameThe element name.
+ - valueValue of the element.
+ - labelLabel string.
+ - patternRegular expression string for checking data format.
+ - placeholderA placeholder string.
Public member variables
name
The element name.
- Type
- - String
+ - String
value
Value of the element. It becomes a value attribute of an HTML <input type="text"> tag. An entered text in the custom Web page will be sent with a query string of the form. The value set before accessing the page is displayed as the initial value.
- Type
- - String
+ - String
label
A label is an optional string. A label is always arranged on the left side of the input box. Specification of a label will generate an HTML <label> tag with an id attribute. The input box and the label are connected by the id attribute.
- Type
- - String
+ - String
pattern
A pattern specifies a regular expression that the input-box's value is checked against on form submission.
- Type
- - String
+ - String
placeholder
A placeholder is an option string. Specification of a placeholder will generate a placeholder attribute for the input tag.
- Type
- - String
+ - String
Public member functions
typeOf
@@ -1785,46 +1989,47 @@ Returns type of AutoConnectElement.
- Parameters
- - nameThe element name.
- - valuesAn array of values of the radio buttons. Specifies an std::vector object.
- - labelLabel string.
- - orderThe direction to arrange the radio buttons.
- - checkedAn index to be checked in the radio buttons.
+ - nameThe element name.
+ - valuesAn array of values of the radio buttons. Specifies an std::vector object.
+ - labelLabel string.
+ - orderThe direction to arrange the radio buttons.
+ - checkedAn index to be checked in the radio buttons.
Public member variables
name
The element name.
- Type
- - String
+ - String
values
An array of String type for the radio button options. It is an initialization list can be used. The <input type="radio"> tags will be generated from each entry in the values.
- Type
- - std::vector<String>
+ - std::vector<String>
label
A label is an optional string. A label will be arranged in the left or top of the radio buttons according to the order.
- Type
- - String
+ - String
order
-Specifies the direction to arrange the radio buttons. A label will place in the left or the top according to the order. It is a value of ACArrange_t type and accepts one of the following:
-
checked
Specifies the index number (1-based) of the values to be checked. If this parameter is not specified neither item is checked.
- Type
- - uint8_t
+ - uint8_t
Public member functions
typeOf
@@ -1841,7 +2046,7 @@ Returns type of AutoConnectElement.
Adds an option for the radio button.
- Parameters
- - valueAn option string to add to the radio button.
+ - valueAn option string to add to the radio button.
check
void check(const String& value)
@@ -1849,7 +2054,7 @@ Adds an option for the radio button.
Indicates the check of the specified option for the radio buttons. You can use the check function for checking dynamically with arbitrary of the radio button.
- Parameters
- - valueAn option string to be checked.
+ - valueAn option string to be checked.
empty
void empty(const size_t reserve = 0)
@@ -1857,7 +2062,7 @@ Indicates the check of the specified option for the radio buttons. You can use t
Clear the array of option strings that AutoConnectRadio has in values. When a reserve parameter is specified, a vector container of that size is reserved.
- Parameters
- - reserveReserved size of a container for option strings.
+ - reserveReserved size of a container for option strings.
operator [ ]
const String& operator[] (const std::size_t n)
@@ -1865,7 +2070,7 @@ Clear the array of option strings that AutoConnectRadio has in values. When a n.
- Parameters
- - nIndex of values array to return.
+ - nIndex of values array to return.
value
const String& value(void) const
@@ -1876,6 +2081,59 @@ Returns current checked option of the radio buttons.
- A String of an option current checked. If there is no checked option, a null string returned.
AutoConnectSelect
+
Constructor
+
AutoConnectSelect(const char* name = "", std::vector<String> const& options = {}, const char* label = "")
+
+
+ - Parameters
+ - nameThe element name.
+ - optionsAn array of options of the select element. Specifies an std::vector object.
+ - labelLabel string.
+
+
Public member variables
+
name
+
The element name.
+
+ - Type
+ - String
+
+
options
+
An array of String type for the selection options. It is an initialization list can be used. The <option value> tags will be generated from each entry in the options.
+
+ - Type
+ - std::vector<String>
+
+
label
+
A label is an optional string. A label will be arranged in the top of the selection list.
+
+ - Type
+ - String
+
+
Public member functions
+
typeOf
+
ACElement_t typeOf(void)
+
+Returns type of AutoConnectElement.
+
+ - Return value
+ - AC_Select
+
+
add
+
void add(const String& option)
+
+
+
empty
+
void empty(const size_t reserve = 0)
+
+
+
size
+
+
+
operator [ ]
+
const String& operator[] (const std::size_t n)
+
+
AutoConnectSubmit
AutoConnectText
4. Reports the issue to AutoConnect repository on Github
-
If you can not solve AutoConnect problems please report to Issues. And please make your question comprehensively, not a statement. Include all relevant information.
+
If you can not solve AutoConnect problems please report to Issues. And please make your question comprehensively, not a statement. Include all relevant information as follows.
+
+- Hardware module
+- Arduino core Version (including the upstream tag ID.)
+- Operating System which you use
+- lwIP variant
+- Problem description
+- If you have a STACK DUMP decoded result with formatted by the code block tag
+- The sketch code with formatted by the code block tag
+- Debug messages output
+