diff --git a/docs/advancedusage/index.html b/docs/advancedusage/index.html index 8e648b8..58172a3 100644 --- a/docs/advancedusage/index.html +++ b/docs/advancedusage/index.html @@ -730,7 +730,7 @@

Captive portal start detection

-

The captive portal will only be activated if the first WiFi::begin fails. Sketch can detect with the AutoConnect::onDetect funciton that the captive portal has started. For example, the sketch can be written like as follows that turns on the LED at the start captive portal.

+

The captive portal will only be activated if the first WiFi::begin fails. Sketch can detect with the AutoConnect::onDetect function that the captive portal has started. For example, the sketch can be written like as follows that turns on the LED at the start captive portal.

AutoConnect Portal;
 
 bool startCP(IPAddress ip) {
@@ -791,7 +791,7 @@

Move the saving area of EEPROM for the credentials

-

By default, the credentials saving area is occupied from the beginning of EEPROM. ESP8266 Arduino core document says that:

+

By default, the credentials saving area is occupied from the beginning of EEPROM area. ESP8266 Arduino core document says that:

The following diagram illustrates flash layout used in Arduino environment:

@@ -807,7 +807,7 @@

EEPROM library uses one sector of flash located just after the SPIFFS.

-

So in the default state, the credential storage area used by AutoConnect conflicts with data area owned by the user sketch. It will be destroyed together saved data in EEPROM by user sketch and AutoConnect each other. But you can move the storage area to avoid this.

+

So in the default state, the credential storage area used by AutoConnect conflicts with data owned by the user sketch. It will be destroyed together saved data in EEPROM by user sketch and AutoConnect each other. But you can move the storage area to avoid this.

The boundaryOffset in AutoConnectConfig specifies the start offset of the credentials storage area. The default value is 0.

Refers the hosted ESP8266WebServer

Constructing an AutoConnect object variable without parameters then creates and starts an ESP8266WebServer inside the AutoConnect. This object variable could be referred by AutoConnect::host() function to access ESP8266WebServer instance as like below.

@@ -896,7 +896,7 @@

"HOME" for returning to the user's sketch homepage is displayed at the bottom of the AutoConnect menu. It could be set using the AutoConnect::home function.

Relocate the AutoConnect home path

-

A home path of AutoConnect is _ac by default. You can access from the browser with http://IPADDRESS/_ac. You can change the home path by revising AUTOCONNECT_URI macro in the include header file as AutoConnect.h.

+

A home path of AutoConnect is /_ac by default. You can access from the browser with http://IPADDRESS/_ac. You can change the home path by revising AUTOCONNECT_URI macro in the include header file as AutoConnect.h.

#define AUTOCONNECT_URI         "/_ac"
diff --git a/docs/api/index.html b/docs/api/index.html index 4685b0b..3a0fb20 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -1076,6 +1076,7 @@ 
AutoConnect()
+

AutoConnect default constructor. This entry activates WebServer internally and the web server is allocated internal.

AutoConnect(ESP8266WebServer& webServer)
@@ -1177,7 +1178,7 @@ Register the function which will call from AutoConnect at the start of the capti
fnFunction called at the captive portal start.

-

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

+

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
@@ -1218,10 +1219,10 @@ Register the handler function for undefined URL request detected.

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
-
IPAddress
+
IPAddressThe default value is 192.168.244.1

autoReset

-

Reset ESP8266 module automatically when WLAN disconnected. +

Reset ESP8266 module automatically after WLAN disconnected.

Type
bool
@@ -1244,7 +1245,7 @@ Register the handler function for undefined URL request detected.
Type
AC_SAVECREDENTIAL_t
Value
-
AC_SAVECREDENTIAL_AUTOThe credential saved automatically.
+
AC_SAVECREDENTIAL_AUTOThe credential saved automatically. This is the default.
AC_SAVECREDENTIAL_NEVERThe credential no saved.

boundaryOffset

@@ -1267,14 +1268,14 @@ The default value is 0.
1 ~ 14. The default value is 1.

-

See Application note

+

How do I choose Channel

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

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
-
IPAddress
+
IPAddressThe default value is 192.168.244.1

hidden

Sets SoftAP to hidden SSID. @@ -1295,7 +1296,7 @@ The default value is 0.

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
-
IPAddress
+
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. diff --git a/docs/basicusage/index.html b/docs/basicusage/index.html index 37eb5ed..6fd1db1 100644 --- a/docs/basicusage/index.html +++ b/docs/basicusage/index.html @@ -708,13 +708,13 @@

  • Include headers, ESP8266WebServer.h and AutoConnect.h
  • Declare ESP8266WebServer variable.
  • Declare AutoConnect variable.
    • -
  • Implements the URL handler function().
    • +
  • Implements the URL handler with the function().
  • setup()
    5.1 Sets URL handler function() to ESP8266WebServer byESP8266WebServer::on.
    5.2 Starts AutoConnect::begin().
    - 5.3 Check connection status.
    • + 5.3 Check WiFi connection status.
  • loop()
    - 6.1 Invokes AutoConnect::handleClient(),
    or invokes     ESP8266WebServer::handleClient() then AutoConnect::handleRequest().
    + 6.1 Invokes AutoConnect::handleClient(), or invokes ESP8266WebServer::handleClient() then AutoConnect::handleRequest().
    6.2 Do the process for actual sketch.
    • @@ -728,46 +728,46 @@ or

    3. No need WiFI.begin(...)

    -

    AutoConnect performs WiFi.begin for establishing a connection with WLAN internally. There is no need for a general process to establish a connection with WiFi.begin in a sketch.

    +

    AutoConnect internally performs WiFi.begin to establish a WiFi connection. There is no need for a general process to establish a connection using WiFi.begin with a sketch code.

    4. Alternate ESP8266WebServer::begin()

    -

    AutoConnect::begin internally executes ESP8266WebServer::begin too and it starts DNS server to behave as a captive portal. So the sketch does not need to call ESP8266WebServer::begin.

    +

    AutoConnect::begin executes ESP8266WebServer::begin internally too and it starts the DNS server to behave as a Captive portal. So it is not needed to call ESP8266WebServer::begin with the sketch.

    -

    Why DNS Server Starts

    -

    AutoConnect traps the detection of captive portals and directs them to the AutoConnect menu to achieve a connection with the WLAN interactively. In order to trap, it temporarily responds SoftAP address to all DNS queries. When the connection with the WLAN is successfully established, the DNS server will stop.

    +

    Why DNS Server starts

    +

    AutoConnect traps the detection of the captive portal and achieves a connection with the WLAN interactively by the AutoConnect menu. It responds SoftAP address to all DNS queries temporarily to trap. When the WLAN connection establishes, then stops DNS server.

    5. AutoConnect::begin with SSID and Password

    SSID and Password can also specify by AutoConnect::begin. ESP8266 uses provided SSID and Password explicitly. If the connection false with specified SSID with Password then a captive portal is activated. SSID and Password are not present, ESP8266 SDK will attempt to connect using the still effectual SSID and password. Usually, it succeeds.

    6. Use ESP8266WebServer::on to handle URL

    AutoConnect is designed to coexist with the process for handling the web pages by user sketches. The page processing function which will send an HTML to the client invoked by the "on::ESP8266WebServer" function is the same as when using ESP8266WebServer natively.

    7. Use either ESP8266WebServer::handleClient() or AutoConnect::handleClient()

    -

    Both classes member function name is the same: handleClient, but behavior is different. Using the AutoConnect embedded along with ESP8266WebServer::handleClient has limitations. Refer to the below section for details.

    +

    Both classes member function name is the same: handleClient, but the behavior is different. Using the AutoConnect embedded along with ESP8266WebServer::handleClient has limitations. Refer to the below section for details.

    ESP8266WebServer hosted or parasitic

    The interoperable process with an ESP8266WebServer depends on the parameters of the AutoConnect constructor.

    - - + + - - - + + + - - - + + +
    Declaration parameterUse ESP8266WebServer::handleClientDeclaration parameter for the constructorUse ESP8266WebServer::handleClient only Use AutoConnect::handleClient
    NoneAutoConnect menu not available.
    host() is needed.    		AutoConnect menu available.
    host() is needed.    		NoneAutoConnect menu not available.
    To use AutoConnect menu, need AutoConnect::handleRequest().
    also to use ESP8266WebServer natively, need AutoConnect::host().    		AutoConnect menu available.
    To use ESP8266WebServer natively, need AutoConnect::host().
    Reference to ESP8266WebServerAutoConnect menu not available.
    host() not necessary.    		AutoConnect menu available.
    host() not necessary.    		Reference to ESP8266WebServerAutoConnect menu not available.
    To use AutoConnect menu, need AutoConnect::handleRequest().    		AutoConnect menu available.
    diff --git a/docs/faq/index.html b/docs/faq/index.html index 9a5505a..c889585 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -441,8 +441,8 @@
  • - - Does not response from _ac. + + Does not response from /_ac.
    • @@ -517,8 +517,8 @@
  • - - How much memory consumption is AutoConnect? + + How much memory does AutoConnect consume?
  • - - Does not response from _ac. + + Does not response from /_ac.
    • @@ -689,8 +689,8 @@
  • - - How much memory consumption is AutoConnect? + + How much memory does AutoConnect consume?