@@ -112,11 +112,11 @@ AutoConnect supports that loading the AutoConnectAux as a set of elements, and L
To load a JSON document as AutoConnectAux use the [**AutoConnect::load**](api.md#load) function and load the JSON document of each AutoConnectElement using the [**AutoConnectAux::loadElement**](apiaux.md#loadelement) function. Although the functions of both are similar, the structure of the target JSON document is different.
-The [AutoConnect::load](apiaux.md#load) function loads the entire AutoConnectAux and creates both the AutoConnectAux instance and each AutoConnectElement instance. If the JSON document is described as an array of multiple custom Web pages, all pages contained in the array will be generated. Therefore, it is necessary to supply the JSON document of AutoConnectAux as an input of the load function and must contain the elements described [**here**](acjson.md#json-document-structure-for-autoconnectaux).
+The [AutoConnect::load](apiaux.md#load) function loads the entire AutoConnectAux and creates both the AutoConnectAux instance and each AutoConnectElement instance. A single JSON document can contain multiple custom Web pages. If you write JSON of AutoConnectAux as an array, the load function generates all the pages contained in that array. Therefore, it is necessary to supply the JSON document of AutoConnectAux as an input of the load function and must contain the elements described [**here**](acjson.md#json-document-structure-for-autoconnectaux).
The [AutoConnectAux::loadElement](apiaux.md#loadelement) function loads the elements individually into an AutoConnectAux object. The structure of its supplying JSON document is not AutoConnectAux. It must be a [JSON structure for AutoConnectElement](acjson.md#json-object-for-autoconnectelements), but you can specify an array.
-```cpp
+```cpp hl_lines="49 55"
// AutoConnectAux as a custom Web page.
const char page[] PROGMEM = R"raw(
{
@@ -130,7 +130,7 @@ const char page[] PROGMEM = R"raw(
"label": "Server"
},
{
- "name": "set",
+ "name": "set",
"type": "ACSubmit",
"value": "SET",
"uri" : "/set"
@@ -228,13 +228,164 @@ The following diagram shows the flow of the input values of a custom Web page in
-### When to pick up the values
+### Where to pick up the values
+
+The sketch receives the values of AutoConnectElements entered in a custom Web page after sending, but it is not the handler of the page where the values entered. It is necessary to be aware that can accept the entered values by the next page handler after the transition.
+
+Usually, two ways to retrieve entered values we have. One is to use the [ESP8266WebServer::arg](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer#getting-information-about-request-arguments) (or WebServer::arg for ESP32) function in the [`on handler`](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer#client-request-handlers) attached by ESP8266WebServer (WebServer w/ESP32 also).
+
+```cpp hl_lines="33"
+#include " + feel + String(" and a bold world!
"); + webServer.send(200, "text/html", echo); +} + +void setup() { + delay(1000); + webServer.on("/feels", feelsOn); // Register /feels handler + portal.load(addonJson); // Load a custom Web page + portal.begin(); +} + +void loop() { + portal.handleClient(); +} +``` + +An above example is the most simple sketch of handling values entered into a custom Web page. This sketch obtains the string entered in the AutoConnectInput named `feels` with the `/feels` handler after page transition, and the AutoConnectInput is an `` element wrapped in the form as the actual HTML code. + +!!! info "Should be accessed `/_ac` first" + When you actually try the above sketch, there is no a root handler. So the URL that should be accessed first is `/_ac` concatenated with the local IP address of the esp8266 module. + +Another method is effective when custom Web pages have complicated page transitions. It is a way to straight access the AutoConnectElements member value. You can get the AutoConnectElement with the specified name using the [getElement](#get-autoconnectelement-from-the-autoconnectaux) function. The following sketch executes the above example with AutoConnect only, without using the function of ESP8266WebServer. + +```cpp hl_lines="47 50" +#include+POST /feels HTTP/1.1 +Host: ESP8266_IP_ADDRESS +name1=value1&name2=value2&name3=value3 ++The query string included in the HTTP request body is parsed by ESP8266WebServer class and retrieved it using the `ESP8266WebServer::arg` function in the handler with sketch side. Its argument specifies the name of the input element. WebServer.args, PageArgument Handling in 'on' handler ## Transitions of the custom Web pages + +A handler registered with ESP8266Server::on can not coexist with AutoConnectAux::on. diff --git a/mkdocs/api.md b/mkdocs/api.md index 4a7db47..b200313 100644 --- a/mkdocs/api.md +++ b/mkdocs/api.md @@ -273,3 +273,14 @@ Register the handler function for undefined URL request detected.