lsbegin.html 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="description" content="ESP8266/ESP32 WLAN configuration at run time with web interface">
  7. <link rel="canonical" href="https://Hieromon.github.io/AutoConnect/lsbegin.html">
  8. <meta name="author" content="Hieromon Ikasamo">
  9. <link rel="shortcut icon" href="assets/images/favicon.png">
  10. <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.1.6">
  11. <title>Inside AutoConnect::begin - AutoConnect for ESP8266/ESP32</title>
  12. <link rel="stylesheet" href="assets/stylesheets/main.6910b76c.min.css">
  13. <link rel="stylesheet" href="assets/stylesheets/palette.196e0c26.min.css">
  14. <meta name="theme-color" content="#4051b5">
  15. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  16. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  17. <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
  18. <link rel="stylesheet" href="css/paragraph.css">
  19. <link rel="stylesheet" href="css/extra.css">
  20. <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css">
  21. <script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-116150854-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})}),document.addEventListener("DOMContentSwitch",function(){ga("send","pageview",document.location.pathname)})</script>
  22. <script async src="https://www.google-analytics.com/analytics.js"></script>
  23. </head>
  24. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="indigo" data-md-color-accent="indigo">
  25. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  26. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  27. <label class="md-overlay" for="__drawer"></label>
  28. <div data-md-component="skip">
  29. <a href="#autoconnectbegin-logic-sequence" class="md-skip">
  30. Skip to content
  31. </a>
  32. </div>
  33. <div data-md-component="announce">
  34. </div>
  35. <header class="md-header" data-md-component="header">
  36. <nav class="md-header-nav md-grid" aria-label="Header">
  37. <a href="https://Hieromon.github.io/AutoConnect/" title="AutoConnect for ESP8266/ESP32" class="md-header-nav__button md-logo" aria-label="AutoConnect for ESP8266/ESP32">
  38. <img src="images/arduino-logo.svg" alt="logo">
  39. </a>
  40. <label class="md-header-nav__button md-icon" for="__drawer">
  41. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  42. </label>
  43. <div class="md-header-nav__title" data-md-component="header-title">
  44. <div class="md-header-nav__ellipsis">
  45. <span class="md-header-nav__topic md-ellipsis">
  46. AutoConnect for ESP8266/ESP32
  47. </span>
  48. <span class="md-header-nav__topic md-ellipsis">
  49. Inside AutoConnect::begin
  50. </span>
  51. </div>
  52. </div>
  53. <label class="md-header-nav__button md-icon" for="__search">
  54. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  55. </label>
  56. <div class="md-search" data-md-component="search" role="dialog">
  57. <label class="md-search__overlay" for="__search"></label>
  58. <div class="md-search__inner" role="search">
  59. <form class="md-search__form" name="search">
  60. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
  61. <label class="md-search__icon md-icon" for="__search">
  62. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  64. </label>
  65. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
  66. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  67. </button>
  68. </form>
  69. <div class="md-search__output">
  70. <div class="md-search__scrollwrap" data-md-scrollfix>
  71. <div class="md-search-result" data-md-component="search-result">
  72. <div class="md-search-result__meta">
  73. Initializing search
  74. </div>
  75. <ol class="md-search-result__list"></ol>
  76. </div>
  77. </div>
  78. </div>
  79. </div>
  80. </div>
  81. <div class="md-header-nav__source">
  82. <a href="https://github.com/Hieromon/AutoConnect" title="Go to repository" class="md-source">
  83. <div class="md-source__icon md-icon">
  84. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
  85. </div>
  86. <div class="md-source__repository">
  87. Hieromon/AutoConnect
  88. </div>
  89. </a>
  90. </div>
  91. </nav>
  92. </header>
  93. <div class="md-container" data-md-component="container">
  94. <main class="md-main" data-md-component="main">
  95. <div class="md-main__inner md-grid">
  96. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  97. <div class="md-sidebar__scrollwrap">
  98. <div class="md-sidebar__inner">
  99. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  100. <label class="md-nav__title" for="__drawer">
  101. <a href="https://Hieromon.github.io/AutoConnect/" title="AutoConnect for ESP8266/ESP32" class="md-nav__button md-logo" aria-label="AutoConnect for ESP8266/ESP32">
  102. <img src="images/arduino-logo.svg" alt="logo">
  103. </a>
  104. AutoConnect for ESP8266/ESP32
  105. </label>
  106. <div class="md-nav__source">
  107. <a href="https://github.com/Hieromon/AutoConnect" title="Go to repository" class="md-source">
  108. <div class="md-source__icon md-icon">
  109. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
  110. </div>
  111. <div class="md-source__repository">
  112. Hieromon/AutoConnect
  113. </div>
  114. </a>
  115. </div>
  116. <ul class="md-nav__list" data-md-scrollfix>
  117. <li class="md-nav__item">
  118. <a href="index.html" class="md-nav__link">
  119. Overview
  120. </a>
  121. </li>
  122. <li class="md-nav__item">
  123. <a href="gettingstarted.html" class="md-nav__link">
  124. Getting started
  125. </a>
  126. </li>
  127. <li class="md-nav__item">
  128. <a href="menu.html" class="md-nav__link">
  129. AutoConnect menu
  130. </a>
  131. </li>
  132. <li class="md-nav__item">
  133. <a href="basicusage.html" class="md-nav__link">
  134. Basic usage
  135. </a>
  136. </li>
  137. <li class="md-nav__item md-nav__item--nested">
  138. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" >
  139. <label class="md-nav__link" for="nav-5">
  140. Advanced usage
  141. <span class="md-nav__icon md-icon"></span>
  142. </label>
  143. <nav class="md-nav" aria-label="Advanced usage" data-md-level="1">
  144. <label class="md-nav__title" for="nav-5">
  145. <span class="md-nav__icon md-icon"></span>
  146. Advanced usage
  147. </label>
  148. <ul class="md-nav__list" data-md-scrollfix>
  149. <li class="md-nav__item">
  150. <a href="advancedusage.html" class="md-nav__link">
  151. Advanced usage
  152. </a>
  153. </li>
  154. <li class="md-nav__item">
  155. <a href="adconnection.html" class="md-nav__link">
  156. AutoConnect WiFi connection control
  157. </a>
  158. </li>
  159. <li class="md-nav__item">
  160. <a href="adcpcontrol.html" class="md-nav__link">
  161. Captive portal control
  162. </a>
  163. </li>
  164. <li class="md-nav__item">
  165. <a href="adnetwork.html" class="md-nav__link">
  166. Settings and controls for network and WiFi
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="adauthentication.html" class="md-nav__link">
  171. Authentication settings
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="adcredential.html" class="md-nav__link">
  176. Credential accesses
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="adexterior.html" class="md-nav__link">
  181. Customizing page appearance
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="adothers.html" class="md-nav__link">
  186. Other operation settings and controls
  187. </a>
  188. </li>
  189. </ul>
  190. </nav>
  191. </li>
  192. <li class="md-nav__item md-nav__item--nested">
  193. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" >
  194. <label class="md-nav__link" for="nav-6">
  195. Custom Web pages
  196. <span class="md-nav__icon md-icon"></span>
  197. </label>
  198. <nav class="md-nav" aria-label="Custom Web pages" data-md-level="1">
  199. <label class="md-nav__title" for="nav-6">
  200. <span class="md-nav__icon md-icon"></span>
  201. Custom Web pages
  202. </label>
  203. <ul class="md-nav__list" data-md-scrollfix>
  204. <li class="md-nav__item">
  205. <a href="acintro.html" class="md-nav__link">
  206. Custom Web pages with AutoConnect
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="acelements.html" class="md-nav__link">
  211. AutoConnectElements
  212. </a>
  213. </li>
  214. <li class="md-nav__item">
  215. <a href="acjson.html" class="md-nav__link">
  216. Custom Web pages with JSON
  217. </a>
  218. </li>
  219. <li class="md-nav__item">
  220. <a href="achandling.html" class="md-nav__link">
  221. Handling the custom Web pages
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7" >
  229. <label class="md-nav__link" for="nav-7">
  230. OTA Updates
  231. <span class="md-nav__icon md-icon"></span>
  232. </label>
  233. <nav class="md-nav" aria-label="OTA Updates" data-md-level="1">
  234. <label class="md-nav__title" for="nav-7">
  235. <span class="md-nav__icon md-icon"></span>
  236. OTA Updates
  237. </label>
  238. <ul class="md-nav__list" data-md-scrollfix>
  239. <li class="md-nav__item">
  240. <a href="otaupdate.html" class="md-nav__link">
  241. OTA Updates
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="otabrowser.html" class="md-nav__link">
  246. Using Web Browser
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="otaserver.html" class="md-nav__link">
  251. Using Update Server
  252. </a>
  253. </li>
  254. </ul>
  255. </nav>
  256. </li>
  257. <li class="md-nav__item md-nav__item--nested">
  258. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8" >
  259. <label class="md-nav__link" for="nav-8">
  260. Library APIs
  261. <span class="md-nav__icon md-icon"></span>
  262. </label>
  263. <nav class="md-nav" aria-label="Library APIs" data-md-level="1">
  264. <label class="md-nav__title" for="nav-8">
  265. <span class="md-nav__icon md-icon"></span>
  266. Library APIs
  267. </label>
  268. <ul class="md-nav__list" data-md-scrollfix>
  269. <li class="md-nav__item">
  270. <a href="api.html" class="md-nav__link">
  271. AutoConnect API
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="apiaux.html" class="md-nav__link">
  276. AutoConnectAux API
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="apiconfig.html" class="md-nav__link">
  281. AutoConnectConfig API
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="apielements.html" class="md-nav__link">
  286. AutoConnectElements API
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="apiupdate.html" class="md-nav__link">
  291. AutoConnectUpdate API
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="apiextra.html" class="md-nav__link">
  296. Something extra
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item md-nav__item--nested">
  303. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9" >
  304. <label class="md-nav__link" for="nav-9">
  305. Examples
  306. <span class="md-nav__icon md-icon"></span>
  307. </label>
  308. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  309. <label class="md-nav__title" for="nav-9">
  310. <span class="md-nav__icon md-icon"></span>
  311. Examples
  312. </label>
  313. <ul class="md-nav__list" data-md-scrollfix>
  314. <li class="md-nav__item">
  315. <a href="howtoembed.html" class="md-nav__link">
  316. How to embed
  317. </a>
  318. </li>
  319. <li class="md-nav__item">
  320. <a href="datatips.html" class="md-nav__link">
  321. Tips for data conversion
  322. </a>
  323. </li>
  324. <li class="md-nav__item">
  325. <a href="menuize.html" class="md-nav__link">
  326. Attach the menus
  327. </a>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="wojson.html" class="md-nav__link">
  331. Custom Web pages w/o JSON
  332. </a>
  333. </li>
  334. </ul>
  335. </nav>
  336. </li>
  337. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  338. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10" checked>
  339. <label class="md-nav__link" for="nav-10">
  340. Appendix
  341. <span class="md-nav__icon md-icon"></span>
  342. </label>
  343. <nav class="md-nav" aria-label="Appendix" data-md-level="1">
  344. <label class="md-nav__title" for="nav-10">
  345. <span class="md-nav__icon md-icon"></span>
  346. Appendix
  347. </label>
  348. <ul class="md-nav__list" data-md-scrollfix>
  349. <li class="md-nav__item md-nav__item--active">
  350. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  351. <label class="md-nav__link md-nav__link--active" for="__toc">
  352. Inside AutoConnect::begin
  353. <span class="md-nav__icon md-icon"></span>
  354. </label>
  355. <a href="lsbegin.html" class="md-nav__link md-nav__link--active">
  356. Inside AutoConnect::begin
  357. </a>
  358. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  359. <label class="md-nav__title" for="__toc">
  360. <span class="md-nav__icon md-icon"></span>
  361. Table of contents
  362. </label>
  363. <ul class="md-nav__list" data-md-scrollfix>
  364. <li class="md-nav__item">
  365. <a href="#autoconnectbegin-logic-sequence" class="md-nav__link">
  366. AutoConnect::begin logic sequence
  367. </a>
  368. </li>
  369. </ul>
  370. </nav>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="credit.html" class="md-nav__link">
  374. Saved credentials access
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="acupload.html" class="md-nav__link">
  379. File upload handler
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="colorized.html" class="md-nav__link">
  384. Custom colorized
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="changelabel.html" class="md-nav__link">
  389. Change label text
  390. </a>
  391. </li>
  392. </ul>
  393. </nav>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="faq.html" class="md-nav__link">
  397. FAQ
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="changelog.html" class="md-nav__link">
  402. Change log
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="license.html" class="md-nav__link">
  407. License
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </div>
  413. </div>
  414. </div>
  415. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  416. <div class="md-sidebar__scrollwrap">
  417. <div class="md-sidebar__inner">
  418. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  419. <label class="md-nav__title" for="__toc">
  420. <span class="md-nav__icon md-icon"></span>
  421. Table of contents
  422. </label>
  423. <ul class="md-nav__list" data-md-scrollfix>
  424. <li class="md-nav__item">
  425. <a href="#autoconnectbegin-logic-sequence" class="md-nav__link">
  426. AutoConnect::begin logic sequence
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </div>
  432. </div>
  433. </div>
  434. <div class="md-content">
  435. <article class="md-content__inner md-typeset">
  436. <h1>Inside AutoConnect::begin</h1>
  437. <h2 id="autoconnectbegin-logic-sequence">AutoConnect::begin logic sequence<a class="headerlink" href="#autoconnectbegin-logic-sequence" title="Permanent link">&para;</a></h2>
  438. <p>The following parameters of <a href="apiconfig.html">AutoConnectConfig</a> affect the behavior and control a logic sequence of <a href="api.html#begin">AutoConnect::begin</a> function. These parameters are evaluated on a case-by-case basis and may not be valid in all situations. The Sketch must consider the role of these parameters and the conditions under which they will work as intended. You need to understand what happens when using these parameters in combination.</p>
  439. <ul>
  440. <li><a href="apiconfig.html#autoreconnect">autoReconnect</a> : Attempts re-connect with past SSID by saved credential.</li>
  441. <li><a href="apiconfig.html#autorise">autoRise</a> : Controls starting the captive portal.</li>
  442. <li><a href="apiconfig.html#immediatestart">immediateStart</a> : Starts the captive portal immediately, without the 1<sup>st</sup>-WiFi.begin.</li>
  443. <li><a href="apiconfig.html#portaltimeout">portalTimeout</a> : Time out limit for the portal.</li>
  444. <li><a href="apiconfig.html#retainportal">retainPortal</a> : Keep DNS server functioning for the captive portal.</li>
  445. </ul>
  446. <p>The following chart shows the AutoConnect::begin logic sequence that contains the control flow with each parameter takes effect.</p>
  447. <p><img align="center" src="images/process_begin.svg"></p>
  448. <p>For example, <a href="api.html#begin">AutoConnect::begin</a> will not end without the <a href="apiconfig.html#portaltimeout"><strong>portalTimeout</strong></a> while the connection not establishes, but WebServer will start to work. Also, the DNS server will start to make a series of the captive portal operation on the client device. The custom web pages now respond correctly by the two internally launched servers, and the Sketch looks like working. But AutoConnect::begin does not end yet. Especially when invoking AutoConnect::begin in the <strong>setup()</strong>, control flow does not pass to the <strong>loop()</strong>.</p>
  449. <p>However, <a href="apiconfig.html#portaltimeout"><strong>portalTimeout</strong></a> can be used effectively in various scenes in combination with <a href="apiconfig.html#immediatestart"><strong>immediateStart</strong></a>. Its combination is useful for implementing Sketches that can work in situations where WiFi is not always available. Namely, Sketch will support a running mode with both offline and online.<br />
  450. If AutoConnect staying in the captive portal exceeds the time limit, Sketch can switch a process-mode to offline according to WiFi signal detection. Conversely, it can start a captive portal immediately with intentional control to shift the process-mode to online from offline. Especially, You can activate the process-mode shift manually by trigger via external switches.</p>
  451. <p>The <a href="apiconfig.html#retainportal"><strong>retainPortal</strong></a> option allows continuing the captive portal operation even after exiting from AutoConnect::begin. This option allows the use of the automatic portal pop-ups on the smartphone devices etc. even after the ESP module has established a connection with some access point in STA mode. (Excepts blocking a series of portal processes via intentionally accessing a URL outside the scope of <strong>/_ac</strong>. eg., if you try to communicate with the mqtt server without connecting to the access point, its access will be redirected to <strong>/_ac</strong> caused by the trap of the captive portal detection)</p>
  452. <div class="admonition info">
  453. <p class="admonition-title">The AutoConnect::begin 3<sup>rd</sup> parameter</p>
  454. <p>Another parameter as the <a href="api.html#begin">3<sup>rd</sup> parameter</a> of AutoConnect::begin related to timeout constrains the connection wait time after WiFi.begin. It is the <strong>CONNECTED</strong> judgment of the above chart that it has an effect.</p>
  455. </div>
  456. </article>
  457. </div>
  458. </div>
  459. </main>
  460. <footer class="md-footer">
  461. <div class="md-footer-nav">
  462. <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
  463. <a href="wojson.html" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  464. <div class="md-footer-nav__button md-icon">
  465. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  466. </div>
  467. <div class="md-footer-nav__title">
  468. <div class="md-ellipsis">
  469. <span class="md-footer-nav__direction">
  470. Previous
  471. </span>
  472. Custom Web pages w/o JSON
  473. </div>
  474. </div>
  475. </a>
  476. <a href="credit.html" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
  477. <div class="md-footer-nav__title">
  478. <div class="md-ellipsis">
  479. <span class="md-footer-nav__direction">
  480. Next
  481. </span>
  482. Saved credentials access
  483. </div>
  484. </div>
  485. <div class="md-footer-nav__button md-icon">
  486. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  487. </div>
  488. </a>
  489. </nav>
  490. </div>
  491. <div class="md-footer-meta md-typeset">
  492. <div class="md-footer-meta__inner md-grid">
  493. <div class="md-footer-copyright">
  494. <div class="md-footer-copyright__highlight">
  495. Copyright &copy; 2018-2020 Hieromon Ikasamo
  496. </div>
  497. Made with
  498. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  499. Material for MkDocs
  500. </a>
  501. </div>
  502. <div class="md-footer-social">
  503. <a href="https://github.com/Hieromon" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
  504. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
  505. </a>
  506. <a href="https://twitter.com/hieromon" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
  507. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
  508. </a>
  509. </div>
  510. </div>
  511. </div>
  512. </footer>
  513. </div>
  514. <script src="assets/javascripts/vendor.fd16492e.min.js"></script>
  515. <script src="assets/javascripts/bundle.7836ba4d.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
  516. <script>
  517. app = initialize({
  518. base: ".",
  519. features: [],
  520. search: Object.assign({
  521. worker: "assets/javascripts/worker/search.4ac00218.min.js"
  522. }, typeof search !== "undefined" && search)
  523. })
  524. </script>
  525. <script src="js/gifffer.min.js"></script>
  526. </body>
  527. </html>