From a70ee9bf2994a9a8a38a988f0d457435911de222 Mon Sep 17 00:00:00 2001 From: Hieromon Ikasamo Date: Wed, 17 Jul 2019 15:18:46 +0900 Subject: [PATCH] Emend the documentation for release v0.9.11. --- mkdocs/achandling.md | 4 ++-- mkdocs/advancedusage.md | 6 +++--- mkdocs/apiconfig.md | 2 +- mkdocs/apielements.md | 15 ++++++++++++++- 4 files changed, 20 insertions(+), 7 deletions(-) diff --git a/mkdocs/achandling.md b/mkdocs/achandling.md index 5bf3d70..ec952d1 100644 --- a/mkdocs/achandling.md +++ b/mkdocs/achandling.md @@ -597,9 +597,9 @@ portal.begin(); ### Retrieve the values with WebServer::on handler -ESP8266WebServer class and the WebServer class assume that the implementation of the ReqestHandler class contained in the WebServer library will handle the URL requests. Usually, it is sketch code registered by ESP8266WebServer::on function. +ESP8266WebServer class and the WebServer (for ESP32) class assume that the implementation of the ReqestHandler class contained in the WebServer library will handle the URL requests. Usually, it is sketch code registered by ESP8266WebServer::on (or WebServer::on for ESP32) function. -When the page transitions from the custom Web page created by AutoConnectAux to the handler registered by ESP2866WebServer::on function, a little trick is needed to retrieve the values of AutoConnectElements. (i.e. the URI of the ESP8266WebServer::on handler is specified in the [uri](acelements.md#uri) attribute of [AutoConnectSubmit](acelements.md#autoconnectsubmit)) AutoConnect cannot intervene in the procedure in which the ESP8266WebServer class calls the on-page handler by the sketch. Therefore, it is necessary to retrieve preliminary the values of AutoConnectElements using the [AutoConnectAux::fetchElement](apiaux.md#fetchelement) function for value processing with the on-page handler. +When the page transitions from the custom Web page created by AutoConnectAux to the handler registered by ESP2866WebServer::on function, a little trick is needed to retrieve the values of AutoConnectElements. (i.e. the URI of the ESP8266WebServer::on handler is specified in the [uri](acelements.md#uri) attribute of [AutoConnectSubmit](acelements.md#autoconnectsubmit)) AutoConnect cannot intervene in the procedure in which the ESP8266WebServer class calls the on-page handler by the sketch. Therefore, it is necessary to retrieve preliminary the values of AutoConnectElements using the [**AutoConnectAux::fetchElement**](apiaux.md#fetchelement) function for value processing with the on-page handler. The following sketch is an example of extracting values inputted on a custom web page with an on-page handler and then processing it. diff --git a/mkdocs/advancedusage.md b/mkdocs/advancedusage.md index 6ccf77a..52def81 100644 --- a/mkdocs/advancedusage.md +++ b/mkdocs/advancedusage.md @@ -515,7 +515,7 @@ portal.begin(); The AutoConnect ticker indicates the WiFi connection status in the following three flicker patterns: -- Short blink: The ESP module stays in APSTA mode. +- Short blink: The ESP8266/ESP32 module stays in APSTA mode. - Short-on and long-off: No STA connection state. (i.e. WiFi.status != WL_CONNECTED) - No blink: WiFi connection with access point established and data link enabled. (i.e. WiFi.status = WL_CONNECTED) @@ -529,13 +529,13 @@ The flicker cycle length is defined by some macros in `AutoConnectDefs.h` header ``` - `AUTOCONNECTT_FLICKER_PERIODAP`: - Assigns a flicker period when the ESP module stays in APSTA mode. + Assigns a flicker period when the ESP8266/ESP32 module stays in APSTA mode. - `AUTOCONNECT_FLICKER_PERIODDC`: Assigns a flicker period when WiFi is disconnected. - `AUTOCONNECT_FLICKER_WIDTHAP` and `AUTOCONNECT_FLICKER_WIDTHDC`: Specify the duty rate for each period[ms] in 8-bit resolution. -[AutoConnectConfig::tickerPort](apiconfig.md#tickerport) specifies a port that outputs the flicker signal. If you are using an LED-equipped ESP module board, you can assign a LED pin to the tick-port for the WiFi connection monitoring without the external LED. The default pin is arduino valiant's **LED\_BUILTIN**. You can refer to the Arduino IDE's variant information to find out which pin actually on the module assign to **LED\_BUILTIN**.[^3] +[AutoConnectConfig::tickerPort](apiconfig.md#tickerport) specifies a port that outputs the flicker signal. If you are using an LED-equipped ESP8266/ESP32 module board, you can assign a LED pin to the tick-port for the WiFi connection monitoring without the external LED. The default pin is arduino valiant's **LED\_BUILTIN**. You can refer to the Arduino IDE's variant information to find out which pin actually on the module assign to **LED\_BUILTIN**.[^3] [^3]: It's defined in the `pins_arduino.h` file, located in the sub-folder named **variants** wherein Arduino IDE installed folder. diff --git a/mkdocs/apiconfig.md b/mkdocs/apiconfig.md index c2ba667..3dcabec 100644 --- a/mkdocs/apiconfig.md +++ b/mkdocs/apiconfig.md @@ -260,7 +260,7 @@ Set flicker signal output according to WiFi connection status during AutoConnect
**Type**
bool
**Value**
-
trueOutput the flicker signal while [AutoConnect::begin](api.md#begin) operation. The **AUTOCONNECT_TICKER_PORT** macro in the `AutoConnectDefs.h` header file assigns pins for signal output. The default pin is arduino valiant's LED_BUILTIN. For boards without the LED\_BUILTIN pin, assume pin #2.
+
trueOutput the flicker signal while [AutoConnect::begin](api.md#begin) operation. The **AUTOCONNECT_TICKER_PORT** macro defined in the `AutoConnectDefs.h` header file assigns pins for signal output. The default pin is arduino variants LED_BUILTIN. For boards without the LED\_BUILTIN pin, assume pin #2.
falseNo flicker signal output.
diff --git a/mkdocs/apielements.md b/mkdocs/apielements.md index 9f653c6..f0ac96e 100644 --- a/mkdocs/apielements.md +++ b/mkdocs/apielements.md @@ -80,7 +80,7 @@ Returns type of AutoConnectElement. ### Constructor ```cpp - explicit AutoConnectCheckboxBasis(const char* name = "", const char* value = "", const char* label = "", const bool checked = false, const ACPosterior_t post = AC_Tag_BR) +AutoConnectCheckbox(const char* name = "", const char* value = "", const char* label = "", const bool checked = false, const ACPosition_t labelPosition = AC_Behind, const ACPosterior_t post = AC_Tag_BR) ```
**Parameters**
@@ -88,6 +88,7 @@ Returns type of AutoConnectElement.
valueValue of the element.
labelA label string prefixed to the checkbox.
checkChecked state of the checkbox.
+
labelPositionSpecifies the position of the label to generate.
postSpecifies the tag to be output afterward the element.
@@ -117,6 +118,18 @@ A label is an optional string. A label is always arranged on the right side of t
String
+#### labelPosition + +Specifies the position of the label to generate with ACPostion_t enumeration value. +
+
**Type**
+
ACPosition_t + +- **`AC_Infront`** : Place a label in front of the check box. +- **`AC_Behind`** : Place a label behind the check box. +
+
+ #### name The element name.