Add Appendix page

pull/41/head
Hieromon Ikasamo 6 years ago
parent 35ddcacab9
commit 346bcf5c02
  1. 1
      mkdocs.yml
  2. 1106
      mkdocs/images/process_begin.svg
  3. 20
      mkdocs/lsbegin.md

@ -30,6 +30,7 @@ nav:
- 'Tips for data conversion': datatips.md - 'Tips for data conversion': datatips.md
- 'Attach the menu': menuize.md - 'Attach the menu': menuize.md
- 'Custom Web pages w/o JSON': wojson.md - 'Custom Web pages w/o JSON': wojson.md
- 'Appendix': lsbegin.md
- 'FAQ' : faq.md - 'FAQ' : faq.md
- 'Change log' : changelog.md - 'Change log' : changelog.md
- 'License' : license.md - 'License' : license.md

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 56 KiB

@ -0,0 +1,20 @@
## AutoCoonnect::begin logic sequence
Several parameters of [AutoConnectConfig](apiconfig.md) affect the behavior of [AutoConnect::begin](api.md#begin) function. Each parameter affects the behaves in complicated order and apply the followings with the priority in the logic sequence of AutoConnect::begin.[^1]
[^1]:Another parameter as the [3rd parameter](api.md#begin) of AutoConnect::begin related to timeout constrains the connection wait time after WiFi.begin. It is the **CONNECTED** judgment of the above chart that it has an effect.
- [immediateStart](apiconfig.md#immediatestart) : The captive portal start immediately, without first WiFi.begin.
- [autoReconenct](apiconfig.md#autoreconnect) : Attempt re-connect with past SSID by saved credential.
- [portalTimeout](apiconfig.md#portaltimeout) : Time out limit for the portal.
- [retainPortal](apiconfig.md#retainportal) : Keep DNS server functioning for the captive portal.
You can use these parameters in combination with your sketch requirements. To make your sketch work as you intended, you need to understand the behavior caused by the parameter correctly. The chart below shows those parameters which are embedded in the AutoConnect::begin logic sequence.
For example, AutoConnect::begin will not exits without the portalTimeout while the connection not establishes, but WebServer will start to work. So, your sketch may work seemingly, but it will close with inside a loop of the AutoConnect::begin function. Especially when invoking AutoConnect::begin in the **setup()**, execution control does not pass to the **loop()**.
As different scenes, you may use the immediateStart effectively. Equipped the external switch to activate the captive portal with the ESP module, combined with the portalTime and the retainPortal it will become WiFi active connection feature. You can start AutoConnect::begin at any point in the **loop()**, which allows your sketch can behave both the offline mode and the online mode.
Please consider these kinds of influence when you make sketches.
<img align="center" src="images/process_begin.svg">
Loading…
Cancel
Save