From 64d0b2c1d52ecf5f53ce5b8fe73800bf19b26dab Mon Sep 17 00:00:00 2001 From: Hieromon Ikasamo Date: Sun, 14 Apr 2019 00:05:06 +0900 Subject: [PATCH] Moved the description section --- mkdocs/advancedusage.md | 4 ++++ mkdocs/credit.md | 8 +++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/mkdocs/advancedusage.md b/mkdocs/advancedusage.md index e62e905..4b3b90f 100644 --- a/mkdocs/advancedusage.md +++ b/mkdocs/advancedusage.md @@ -4,6 +4,10 @@ Registering the "not found" handler is a different way than ESP8266WebServer/WebServer. The *onNotFound* of ESP8266WebServer/WebServer does not work with AutoConnect. AutoConnect overrides *ESP8266WebServer::onNotFound*/*WebServer::onNotFound* to handle a captive portal. To register "not found" handler, use [*AutoConnect::onNotFound*](api.md#onnotfound). +### Access to saved credentials + +AutoConnect stores the established WiFi connection in the EEPROM of the ESP8266/ESP32 module and equips the class to access it from the sketch. You can read, write or erase the credentials using this class individually. It's [AutoConnectCredential](credit.md#autoconnectcredential) class which provides the access method to the saved credentials in EEPROM. Refer to section [Saved credentail access](credit.md) for details. + ### Automatic reconnect When the captive portal is started, SoftAP starts and the STA is disconnected. The current SSID setting memorized in ESP8266 will be lost but then the reconnect behavior of ESP32 is somewhat different from this. diff --git a/mkdocs/credit.md b/mkdocs/credit.md index e3b3431..964630a 100644 --- a/mkdocs/credit.md +++ b/mkdocs/credit.md @@ -1,6 +1,8 @@ ## Saved credential in EEPROM -AutoConnect stores the established WiFi connection in the EEPROM of the ESP8266/ESP32 module and equips the class to access it from the sketch. You can read, write or erase the credentials using this class individually. It's [**AutoConnectCredential**](#autoconnectcredential) class which provides the access method to the saved credentials in EEPROM. +AutoConnect stores the established WiFi connection in the EEPROM of the ESP8266/ESP32 module and equips the class to access it from the sketch. You can read, write or erase the credentials using this class individually. It's [**AutoConnectCredential**](#autoconnectcredential) class which provides the access method to the saved credentials in EEPROM.[^1] + +[^1]:An example using AutoConnectCredential is provided as [an example](https://github.com/Hieromon/AutoConnect/blob/master/examples/Credential/Credential.ino) of a library sketch to delete saved credentials. ## AutoConnectCredential @@ -123,9 +125,9 @@ struct station_config { ### The credential entry -A data structure of the credential saving area in EEPROM as the below. [^1] +A data structure of the credential saving area in EEPROM as the below. [^2] -[^1]: +[^2]: There may be 0xff as an invalid data in the credential saving area. The 0xff area would be reused. | Byte offset | Length | Value |