From bd16286da964cc67216b4f704238cbd0ce9d689c Mon Sep 17 00:00:00 2001 From: Hieromon Ikasamo Date: Thu, 14 Feb 2019 19:10:33 +0900 Subject: [PATCH] Under the work of v0.9.7 documentation --- docs/404.html | 63 +- docs/acelements.html | 99 ++- docs/achandling.html | 105 ++- docs/acintro.html | 63 +- docs/acjson.html | 63 +- docs/advancedusage.html | 97 ++- docs/api.html | 63 +- docs/apiaux.html | 63 +- docs/apiconfig.html | 63 +- docs/apielements.html | 86 +- docs/apiextra.html | 67 +- docs/basicusage.html | 63 +- docs/changelog.html | 63 +- docs/faq.html | 83 +- docs/gettingstarted.html | 63 +- docs/{examples.html => howtoembed.html} | 97 ++- docs/images/aux_fsbrowser.gif | Bin 0 -> 164821 bytes docs/images/fsbrowser_ba.svg | 1029 +++++++++++++++++++++++ docs/index.html | 103 ++- docs/license.html | 63 +- docs/menu.html | 63 +- docs/menuize.html | 875 +++++++++++++++++++ docs/search/search_index.json | 2 +- docs/sitemap.xml | 48 +- docs/sitemap.xml.gz | Bin 338 -> 353 bytes mkdocs.yml | 5 +- mkdocs/advancedusage.md | 34 +- mkdocs/{examples.md => howtoembed.md} | 2 +- mkdocs/images/aux_fsbrowser.gif | Bin 0 -> 164821 bytes mkdocs/images/fsbrowser_ba.svg | 1029 +++++++++++++++++++++++ mkdocs/index.md | 19 +- mkdocs/menuize.md | 42 + 32 files changed, 4339 insertions(+), 176 deletions(-) rename docs/{examples.html => howtoembed.html} (93%) create mode 100644 docs/images/aux_fsbrowser.gif create mode 100644 docs/images/fsbrowser_ba.svg create mode 100644 docs/menuize.html rename mkdocs/{examples.md => howtoembed.md} (99%) create mode 100644 mkdocs/images/aux_fsbrowser.gif create mode 100644 mkdocs/images/fsbrowser_ba.svg create mode 100644 mkdocs/menuize.md diff --git a/docs/404.html b/docs/404.html index 722fe62..de5bc09 100644 --- a/docs/404.html +++ b/docs/404.html @@ -256,6 +256,17 @@ + + +
  • + + + Examples + + +
    • + + @@ -529,12 +540,60 @@ -
  • - +
  • + + + + + +
    • + diff --git a/docs/acelements.html b/docs/acelements.html index 8584236..024c5f6 100644 --- a/docs/acelements.html +++ b/docs/acelements.html @@ -264,6 +264,17 @@ + + +
  • + + + Examples + + +
    • + + @@ -622,6 +633,13 @@ label + + +
  • + + pattern + +
  • @@ -970,12 +988,60 @@ -
  • - +
  • + + + + + +
    • + @@ -1216,6 +1282,13 @@ label + + +
  • + + pattern + +
  • @@ -1562,7 +1635,7 @@ Only will be displayed if a label is not specified AutoConnectInput input("input", "", "Server", "MQTT broker server");

    On the page:

    Constructor

    -
    AutoConnectInput(const char* name, const char* value, const char* label, const char* placeholder)
+
    AutoConnectInput(const char* name, const char* value, const char* label, const char* pattern, const char* placeholder)
 
    
 
 
     name
    
@@ -1571,6 +1644,26 @@ Only  will be displayed if a label is not specified
 
    It becomes a string value of the value attribute of an HTML <input type="text"> tag. The text entered from the custom Web page will be grouped in the query string of the form submission and the string set before accessing the page will be displayed as the initial value.
    
 
     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.
    
+
     pattern
    
+
    A pattern specifies a regular expression that the AutoConnectInput element's value is checked against on form submission. If it is invalid, the background color will change, but it will be sent even if the data format does not match. 
    
+
      
+
    • The password that must contain 8 or more characters that are of at least one number, and one uppercase and lowercase letter:
      (?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,}
      • 
+
    • 
+
      Email address as characters@characters.domain:
      [a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,}$
      
+
      • 
+
    • 
+
      IP address
      
+
      • 
+
    • 
+
      Host name of the internet
      
+
      • 
+
    • 
+
      Date (MM-DD-YYYY)
      
+
      • 
+
    • 
+
      Twitter account:
      ^@?(\w){1,15}$
      
+
      • 
+
    
 
     placeholder
    
 
    A placeholder is an option string. Specification of a placeholder will generate a placeholder attribute for the input tag.
    
 
    AutoConnectRadio
    
diff --git a/docs/achandling.html b/docs/achandling.html
index 8e889a1..1b34148 100644
--- a/docs/achandling.html
+++ b/docs/achandling.html
@@ -264,6 +264,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -516,8 +527,8 @@
  • - - Parameter handling + + Custom field data handling
    • + +
  • + + Check data against on submission + + +
    • + +
  • + + Convert data to actually type + +
    • @@ -688,12 +713,60 @@ -
  • - +
  • + + + + + +
    • + @@ -804,8 +877,8 @@
  • - - Parameter handling + + Custom field data handling
    • + +
  • + + Check data against on submission + + +
    • + +
  • + + Convert data to actually type + +
    • @@ -1073,7 +1160,7 @@ ] -

    Parameter handling

    +

    Custom field data handling

    A sketch can access variables of AutoConnectElements in the custom Web page. The value entered into the AutoConnectElements on the page is stored in the member variable of each element by AutoConnect whenever GET/POST transmission occurs.

    The following diagram shows the flow of the input values of a custom Web page into a sketch and is the basis for actions to manipulate the values of custom Web pages using sketches.

    @@ -1327,8 +1414,10 @@ ESP8266WebServer class will parse the query string and rebuilds its arguments wh portal.begin(); -

    Over typing ​​with LoadElement function

    +

    Over typing ​​with LoadElement function

    The AutoConnectAux::loadElement function overwrites its value when loading an AutoConnectElement. If the loadElement function wields an element with an input value, the previous value will be lost by the loaded value. If you need to preserve input values ​​even during page transition operations, we recommend that you load parameters only once at an early stage in the setup() of sketches.

    +

    Check data against on submission

    +

    Convert data to actually type

    Transitions of the custom Web pages

    The URI of the custom Web pages

    The transition of the custom Web page follows the URI of the page, but the ESP8266WebServer class does not know the URI of an AutoConnectAux page. (Registering a custom Web page does not use the ESP8266WebServer::on/WebServer::on function.) Therefore ESP8266WebServer class does not detect its URI access. If you want to detect an http request to AutoConnectAux's custom Web page, you need to register its URI with the AutoConnectAux::on function.

    diff --git a/docs/acintro.html b/docs/acintro.html index e0971c7..006ffda 100644 --- a/docs/acintro.html +++ b/docs/acintro.html @@ -264,6 +264,17 @@ + + +
  • + + + Examples + + +
    • + + @@ -615,12 +626,60 @@ -
  • - +
  • + + + + + +
    • + diff --git a/docs/acjson.html b/docs/acjson.html index a5a17fe..b8bb40e 100644 --- a/docs/acjson.html +++ b/docs/acjson.html @@ -264,6 +264,17 @@ + + +
  • + + + Examples + + +
    • + + @@ -738,12 +749,60 @@ -
  • - +
  • + + + + + +
    • + diff --git a/docs/advancedusage.html b/docs/advancedusage.html index f99400c..b13a0f3 100644 --- a/docs/advancedusage.html +++ b/docs/advancedusage.html @@ -262,6 +262,17 @@ + + +
  • + + + Examples + + +
    • + + @@ -735,12 +746,60 @@ -
  • - +
  • + + + + + +
    • + @@ -1125,7 +1184,7 @@ Also, if you want to stop AutoConnect completely when the captive portal is time

    Cast items of your sketch own into the AutocCnnect menu

    If your sketch is handling your own web page, you can call that page from the AutoConnect menu. Unlike the custom Web pages by AutoConnectAux, this allows AutoConnect menu to legacy web pages registered by ESP8266WebServer::on/WebServer::on function.

    -

    To implement this with your sketch, use only the AutoConnectAux constructed with the URI of that page. AutoConnectElements is not required. The basic procedure for this as follows. The FSBrowser menu as the below has Edit and List item, which are implemented according to this basic procedure.

    +

    To implement this with your sketch, use only the AutoConnectAux constructed with the URI of that page. AutoConnectElements is not required. The basic procedure for this as follows.

    1. Declare AutoConnectAux for each legacy page. It includes the URI of the page and item string which will display in the AutoConnect menu.
    2. Sketch legacy page handlers.
      3. @@ -1134,37 +1193,7 @@ Also, if you want to stop AutoConnect completely when the captive portal is time
    3. Begin the portal.
    4. Performs AutoConnect::handleClient in the loop function.
    -
    ESP8266WebServer Server;
-AutoConnect      Portal(Server);
-// Declare for menu item for legacy pages
-AutoConnectAux   FSBedit("/edit", "Edit");
-AutoConnectAux   FSBlist("/list?dir=\"/\"", "List");
-
-// /edit page handler
-Void handleEdit() {
-  ...
-}
-
-// /list page handler
-void handleList() {
-  ...
-}
-
-void setup() {
-  // Register legacy page handler to WebServer
-  Server.on("/edit", handleEdit);
-  Server.on("/list", handleList);
-  // Insert the menu items for legacy pages
-  Portal.join({ FSBedit, FSBlist });
-  // Start portal
-  portal.begin();
-}
-
-void loop() {
-  Portal.handleClient();
-}
-
    - +

    For details see the Constructing menu section of Examples page.

    Change menu title

    Although the default menu title is AutoConnect, you can change the title by setting AutoConnectConfig::title. To set the menu title properly, you must set before calling AutoConnect::begin.

    AutoConnect       Portal;
diff --git a/docs/api.html b/docs/api.html
index 9f85a77..af75009 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -264,6 +264,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -724,12 +735,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
diff --git a/docs/apiaux.html b/docs/apiaux.html
index 46737f8..9e330ce 100644
--- a/docs/apiaux.html
+++ b/docs/apiaux.html
@@ -264,6 +264,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -676,12 +687,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
diff --git a/docs/apiconfig.html b/docs/apiconfig.html
index 69760d8..9a4eb3b 100644
--- a/docs/apiconfig.html
+++ b/docs/apiconfig.html
@@ -264,6 +264,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -774,12 +785,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
diff --git a/docs/apielements.html b/docs/apielements.html
index 3a1da2c..af66727 100644
--- a/docs/apielements.html
+++ b/docs/apielements.html
@@ -264,6 +264,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -797,6 +808,13 @@
      label
   
   
+
+        
+          
  • 
+  
+     pattern
+  
+  
 
    • 
         
           
  • 
@@ -1013,12 +1031,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
@@ -1338,6 +1404,13 @@
      label
   
   
+
+        
+          
  • 
+  
+     pattern
+  
+  
 
    • 
         
           
  • 
@@ -1656,13 +1729,14 @@ Returns type of AutoConnectElement.
 
    
 
    AutoConnectInput
    
 
     Constructor
    
-
    AutoConnectInput(const char* name = "", const char* value = "", const char* label = "", const char* placeholder = "")
+
    AutoConnectInput(const char* name = "", const char* value = "", const char* label = "", const char* pattern = "", const char* placeholder = "")
 
    
 
    
     
    Parameters
    
     
    nameThe element name.
    
     
    valueValue of the element.
    
     
    labelLabel string.
    
+    
    patternRegular expression string for checking data format.
    
     
    placeholderA placeholder string.
    
 
    
 
     Public member variables
    
@@ -1684,6 +1758,12 @@ Returns type of AutoConnectElement.
     
    Type
    
     
    String
    
 
    
+
     pattern
    
+
    A pattern specifies a regular expression that the input-box's value is checked against on form submission.
+
    
+    
    Type
    
+    
    String
    
+
    
 
     placeholder
    
 
    A placeholder is an option string. Specification of a placeholder will generate a placeholder attribute for the input tag.
 
    
diff --git a/docs/apiextra.html b/docs/apiextra.html
index b42b28a..034a0f2 100644
--- a/docs/apiextra.html
+++ b/docs/apiextra.html
@@ -264,6 +264,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -573,12 +584,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
@@ -719,13 +778,13 @@
           
         
         
-          
  • 
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -664,12 +675,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
diff --git a/docs/changelog.html b/docs/changelog.html
index d77d6f7..58905ef 100644
--- a/docs/changelog.html
+++ b/docs/changelog.html
@@ -262,6 +262,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -535,12 +546,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
diff --git a/docs/faq.html b/docs/faq.html
index cb29463..266e643 100644
--- a/docs/faq.html
+++ b/docs/faq.html
@@ -262,6 +262,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -535,12 +546,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
@@ -699,6 +758,13 @@
      I cannot complete to Wi-Fi login from smartphone.
   
   
+
    • 
+      
+        
  • 
+  
+     I can not see the custom web page.
+  
+  
 
    • 
       
         
  • 
@@ -944,6 +1010,13 @@
      I cannot complete to Wi-Fi login from smartphone.
   
   
+
    • 
+      
+        
  • 
+  
+     I can not see the custom web page.
+  
+  
 
    • 
       
         
  • 
@@ -1227,6 +1300,8 @@ wdt reset
 
    It consumes about 2K bytes in the static and about 12K bytes are consumed at the moment when menu executed.
    
 
     I cannot complete to Wi-Fi login from smartphone.
    
 
    Because AutoConnect does not send a login success response to the captive portal requests from the smartphone. The login success response varies iOS, Android and Windows. By analyzing the request URL of different login success inquiries for each OS, the correct behavior can be implemented, but not yet. Please resets ESP8266 from the AutoConnect menu.
    
+
     I can not see the custom web page.
    
+
    JSON parse error
    
 
     AutoConnect behaves not stable with my sketch yet.
    
 
    If AutoConnect behavior is not stable with your sketch, you can try the following measures.
    
 
    1. Change WiFi channel
    
@@ -1285,7 +1360,7 @@ wdt reset
     
    
       
    
diff --git a/docs/gettingstarted.html b/docs/gettingstarted.html
index 088c8a6..89a9be3 100644
--- a/docs/gettingstarted.html
+++ b/docs/gettingstarted.html
@@ -262,6 +262,17 @@
 
       
         
+  
+  
+    
  • 
+      
+        
+          Examples
+        
+      
+    
    • 
+  
+
       
         
       
@@ -603,12 +614,60 @@
       
 
 
-  
  • 
-    
+  
  • 
+    
+      
+    
+    
+    
+  
    • 
+
     
       
       
diff --git a/docs/examples.html b/docs/howtoembed.html
similarity index 93%
rename from docs/examples.html
rename to docs/howtoembed.html
index 255f447..63ddd5b 100644
--- a/docs/examples.html
+++ b/docs/howtoembed.html
@@ -13,7 +13,7 @@
         
       
       
-        
+        
       
       
         
@@ -42,7 +42,7 @@
     
     
       
-        Examples - AutoConnect for ESP8266/ESP32
+        How to embed - AutoConnect for ESP8266/ESP32
       
     
     
@@ -115,7 +115,7 @@
     
     
     
-      
+      
         Skip to content
       
     
@@ -141,7 +141,7 @@
                 AutoConnect for ESP8266/ESP32
               
               
-                Examples
+                How to embed
               
             
           
@@ -213,14 +213,16 @@
       
         
 
-