otabrowser.html 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275
  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/otabrowser.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>Using Web Browser - 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="#updates-with-the-web-browserupdated-wv115" 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. Using Web Browser
  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--active md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7" checked>
  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 md-nav__item--active">
  245. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  246. <label class="md-nav__link md-nav__link--active" for="__toc">
  247. Using Web Browser
  248. <span class="md-nav__icon md-icon"></span>
  249. </label>
  250. <a href="otabrowser.html" class="md-nav__link md-nav__link--active">
  251. Using Web Browser
  252. </a>
  253. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  254. <label class="md-nav__title" for="__toc">
  255. <span class="md-nav__icon md-icon"></span>
  256. Table of contents
  257. </label>
  258. <ul class="md-nav__list" data-md-scrollfix>
  259. <li class="md-nav__item">
  260. <a href="#updates-with-the-web-browserupdated-wv115" class="md-nav__link">
  261. Updates with the Web Browser&nbsp;UPDATED w/v1.1.5
  262. </a>
  263. <nav class="md-nav" aria-label="Updates with the Web Browser&nbsp;UPDATED w/v1.1.5">
  264. <ul class="md-nav__list">
  265. <li class="md-nav__item">
  266. <a href="#how-to-embed-autoconnectota-in-your-sketch" class="md-nav__link">
  267. How to embed AutoConnectOTA in your sketch
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="#autoconnectota-allocation-uri" class="md-nav__link">
  272. AutoConnectOTA allocation URI
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="#timing-of-autoconnectota-instantiation" class="md-nav__link">
  277. Timing of AutoConnectOTA instantiation
  278. </a>
  279. </li>
  280. <li class="md-nav__item">
  281. <a href="#how-to-make-the-binary-sketch" class="md-nav__link">
  282. How to make the binary sketch
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="#ota-updates-wbrowser-without-using-autoconnectota" class="md-nav__link">
  287. OTA updates w/browser without using AutoConnectOTA
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="#regular-file-uploading-using-autoconnectotaenhanced-wv120" class="md-nav__link">
  292. Regular file uploading using AutoConnectOTA&nbsp;ENHANCED w/v1.2.0
  293. </a>
  294. </li>
  295. </ul>
  296. </nav>
  297. </li>
  298. </ul>
  299. </nav>
  300. </li>
  301. <li class="md-nav__item">
  302. <a href="otaserver.html" class="md-nav__link">
  303. Using Update Server
  304. </a>
  305. </li>
  306. </ul>
  307. </nav>
  308. </li>
  309. <li class="md-nav__item md-nav__item--nested">
  310. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8" >
  311. <label class="md-nav__link" for="nav-8">
  312. Library APIs
  313. <span class="md-nav__icon md-icon"></span>
  314. </label>
  315. <nav class="md-nav" aria-label="Library APIs" data-md-level="1">
  316. <label class="md-nav__title" for="nav-8">
  317. <span class="md-nav__icon md-icon"></span>
  318. Library APIs
  319. </label>
  320. <ul class="md-nav__list" data-md-scrollfix>
  321. <li class="md-nav__item">
  322. <a href="api.html" class="md-nav__link">
  323. AutoConnect API
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="apiaux.html" class="md-nav__link">
  328. AutoConnectAux API
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="apiconfig.html" class="md-nav__link">
  333. AutoConnectConfig API
  334. </a>
  335. </li>
  336. <li class="md-nav__item">
  337. <a href="apielements.html" class="md-nav__link">
  338. AutoConnectElements API
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="apiupdate.html" class="md-nav__link">
  343. AutoConnectUpdate API
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="apiextra.html" class="md-nav__link">
  348. Something extra
  349. </a>
  350. </li>
  351. </ul>
  352. </nav>
  353. </li>
  354. <li class="md-nav__item md-nav__item--nested">
  355. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9" >
  356. <label class="md-nav__link" for="nav-9">
  357. Examples
  358. <span class="md-nav__icon md-icon"></span>
  359. </label>
  360. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  361. <label class="md-nav__title" for="nav-9">
  362. <span class="md-nav__icon md-icon"></span>
  363. Examples
  364. </label>
  365. <ul class="md-nav__list" data-md-scrollfix>
  366. <li class="md-nav__item">
  367. <a href="howtoembed.html" class="md-nav__link">
  368. How to embed
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="datatips.html" class="md-nav__link">
  373. Tips for data conversion
  374. </a>
  375. </li>
  376. <li class="md-nav__item">
  377. <a href="menuize.html" class="md-nav__link">
  378. Attach the menus
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="wojson.html" class="md-nav__link">
  383. Custom Web pages w/o JSON
  384. </a>
  385. </li>
  386. </ul>
  387. </nav>
  388. </li>
  389. <li class="md-nav__item md-nav__item--nested">
  390. <input class="md-nav__toggle md-toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10" >
  391. <label class="md-nav__link" for="nav-10">
  392. Appendix
  393. <span class="md-nav__icon md-icon"></span>
  394. </label>
  395. <nav class="md-nav" aria-label="Appendix" data-md-level="1">
  396. <label class="md-nav__title" for="nav-10">
  397. <span class="md-nav__icon md-icon"></span>
  398. Appendix
  399. </label>
  400. <ul class="md-nav__list" data-md-scrollfix>
  401. <li class="md-nav__item">
  402. <a href="lsbegin.html" class="md-nav__link">
  403. Inside AutoConnect::begin
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="credit.html" class="md-nav__link">
  408. Saved credentials access
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="acupload.html" class="md-nav__link">
  413. File upload handler
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="colorized.html" class="md-nav__link">
  418. Custom colorized
  419. </a>
  420. </li>
  421. <li class="md-nav__item">
  422. <a href="changelabel.html" class="md-nav__link">
  423. Change label text
  424. </a>
  425. </li>
  426. </ul>
  427. </nav>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="faq.html" class="md-nav__link">
  431. FAQ
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="changelog.html" class="md-nav__link">
  436. Change log
  437. </a>
  438. </li>
  439. <li class="md-nav__item">
  440. <a href="license.html" class="md-nav__link">
  441. License
  442. </a>
  443. </li>
  444. </ul>
  445. </nav>
  446. </div>
  447. </div>
  448. </div>
  449. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  450. <div class="md-sidebar__scrollwrap">
  451. <div class="md-sidebar__inner">
  452. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  453. <label class="md-nav__title" for="__toc">
  454. <span class="md-nav__icon md-icon"></span>
  455. Table of contents
  456. </label>
  457. <ul class="md-nav__list" data-md-scrollfix>
  458. <li class="md-nav__item">
  459. <a href="#updates-with-the-web-browserupdated-wv115" class="md-nav__link">
  460. Updates with the Web Browser&nbsp;UPDATED w/v1.1.5
  461. </a>
  462. <nav class="md-nav" aria-label="Updates with the Web Browser&nbsp;UPDATED w/v1.1.5">
  463. <ul class="md-nav__list">
  464. <li class="md-nav__item">
  465. <a href="#how-to-embed-autoconnectota-in-your-sketch" class="md-nav__link">
  466. How to embed AutoConnectOTA in your sketch
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="#autoconnectota-allocation-uri" class="md-nav__link">
  471. AutoConnectOTA allocation URI
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="#timing-of-autoconnectota-instantiation" class="md-nav__link">
  476. Timing of AutoConnectOTA instantiation
  477. </a>
  478. </li>
  479. <li class="md-nav__item">
  480. <a href="#how-to-make-the-binary-sketch" class="md-nav__link">
  481. How to make the binary sketch
  482. </a>
  483. </li>
  484. <li class="md-nav__item">
  485. <a href="#ota-updates-wbrowser-without-using-autoconnectota" class="md-nav__link">
  486. OTA updates w/browser without using AutoConnectOTA
  487. </a>
  488. </li>
  489. <li class="md-nav__item">
  490. <a href="#regular-file-uploading-using-autoconnectotaenhanced-wv120" class="md-nav__link">
  491. Regular file uploading using AutoConnectOTA&nbsp;ENHANCED w/v1.2.0
  492. </a>
  493. </li>
  494. </ul>
  495. </nav>
  496. </li>
  497. </ul>
  498. </nav>
  499. </div>
  500. </div>
  501. </div>
  502. <div class="md-content">
  503. <article class="md-content__inner md-typeset">
  504. <h1>Using Web Browser</h1>
  505. <h2 id="updates-with-the-web-browserupdated-wv115">Updates with the Web Browser&nbsp;<sup><sub>UPDATED w/v1.1.5</sub></sup><a class="headerlink" href="#updates-with-the-web-browserupdated-wv115" title="Permanent link">&para;</a></h2>
  506. <p>AutoConnect features a built-in OTA function to update ESP module firmware. You can easily make the Sketch that equips OTA and able to operate with the AutoConnect menu. As the <strong>AutoConnectOTA</strong> class, which is compliant with OTA updates using a web browser as described in the <a href="https://arduino-esp8266.readthedocs.io/en/latest/ota_updates/readme.html#implementation-overview">ESP8266 Arduino Core documentation</a>.</p>
  507. <p>You will be able to import the AutoConnectOTA class into your sketch just by specifying <a href="apiconfig.html#ota">AutoConnectConfig::ota</a>. By incorporating the AutoConnectOTA class into your Sketch, you can have an OTA updating feature which able to updating binary sketch from the AutoConnect menu.</p>
  508. <p><span style="display:block;margin-left:auto;margin-right:auto;width:292px;height:482px;border:1px solid lightgrey;"><img data-gifffer="images/webupdate.gif" data-gifffer-height="480" data-gifffer-width="290" /></span></p>
  509. <p>The AutoConnectOTA feature is implemented based on the <a href="https://arduino-esp8266.readthedocs.io/en/latest/ota_updates/readme.html#updater-class">Updater class</a> of the ESP8266 arduino core library. Its Updater class is also supported by the ESP32 Arduino core, so you can commonly import AutoConnectOTA into the Sketch without being aware of the differences between ESP8266 and ESP32 modules.</p>
  510. <p><img src="images/webupdate.png" width="480" /></p>
  511. <div class="admonition info">
  512. <p class="admonition-title">Limitation of AutoConnectOTA with authentication</p>
  513. <p>AutoConnectOTA does not support authentication in v1.1.5 yet. It is planned for inclusion in AutoConnect v1.2.0, which will support HTTP authentication.</p>
  514. </div>
  515. <h3 id="how-to-embed-autoconnectota-in-your-sketch"><i class="fa fa-edit"></i> How to embed AutoConnectOTA in your sketch<a class="headerlink" href="#how-to-embed-autoconnectota-in-your-sketch" title="Permanent link">&para;</a></h3>
  516. <p>To embed the AutoConnectOTA class into your sketch, basically follow these steps:</p>
  517. <ol>
  518. <li>Include <code>ESP8266WiFi.h</code>, <code>ESP8266WebServer.h</code> and <code>AutoConnect.h</code> as usual.<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></li>
  519. <li>Declare an ESP8266WebServer object. It's optional. (as WebServer for ESP32)</li>
  520. <li>Declare an AutoConnect object, with an argument as ESP8266WebServer if separate the declarations.</li>
  521. <li>Declare an AutoConnectConfig object.</li>
  522. <li>Declare an AutoConnectAux object for your sketch own if needed.</li>
  523. <li>Perform the following procedure steps in the <code>setup()</code> function:<ol>
  524. <li>Set <a href="apiconfig.html#ota">AutoConnectConfig::ota</a> to <strong>AC_OTA_BUILTIN</strong> and configure AutoConnect.</li>
  525. <li>Load the AutoConnectAux pages declared in step <a class="magiclink magiclink-github magiclink-issue" href="https://github.com/Hieromon/AutoConnect/issues/4" title="GitHub Issue: Hieromon/AutoConnect#4">#4</a> for your application.</li>
  526. <li>Join these pages to AutoConnect.</li>
  527. <li>Invokes <a href="api.html#begin">AutoConnect::begin</a> function.</li>
  528. </ol>
  529. </li>
  530. <li>Invokes <a href="api.html#handleclient">AutoConnect::handleClient</a> function in the <code>loop()</code>.</li>
  531. </ol>
  532. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266WiFi.h&gt; // Step #1</span>
  533. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266WebServer.h&gt; // Step #1</span>
  534. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;AutoConnect.h&gt; // Step #1</span>
  535. <span style="color: #f8f8f2">ESP8266WebServer</span> <span style="color: #f8f8f2">server;</span> <span style="color: #75715e">// Step #2</span>
  536. <span style="color: #f8f8f2">AutoConnect</span> <span style="color: #a6e22e">portal</span><span style="color: #f8f8f2">(server);</span> <span style="color: #75715e">// Step #3</span>
  537. <span style="color: #f8f8f2">AutoConnectConfig</span> <span style="color: #f8f8f2">config;</span> <span style="color: #75715e">// Step #4</span>
  538. <span style="color: #f8f8f2">AutoConnectAux</span> <span style="color: #f8f8f2">hello;</span> <span style="color: #75715e">// Step #5</span>
  539. <span style="color: #66d9ef">static</span> <span style="color: #66d9ef">const</span> <span style="color: #66d9ef">char</span> <span style="color: #f8f8f2">HELLO_PAGE[]</span> <span style="color: #f8f8f2">PROGMEM</span> <span style="color: #f92672">=</span> <span style="color: #e6db74">R&quot;(</span>
  540. <span style="color: #e6db74">{ &quot;title&quot;: &quot;Hello world&quot;, &quot;uri&quot;: &quot;/&quot;, &quot;menu&quot;: true, &quot;element&quot;: [</span>
  541. <span style="color: #e6db74"> { &quot;name&quot;: &quot;caption&quot;, &quot;type&quot;: &quot;ACText&quot;, &quot;value&quot;: &quot;&lt;h2&gt;Hello, world&lt;/h2&gt;&quot;, &quot;style&quot;: &quot;text-align:center;color:#2f4f4f;padding:10px;&quot; },</span>
  542. <span style="color: #e6db74"> { &quot;name&quot;: &quot;content&quot;, &quot;type&quot;: &quot;ACText&quot;, &quot;value&quot;: &quot;In this page, place the custom web page handled by the Sketch application.&quot; } ]</span>
  543. <span style="color: #e6db74">}</span>
  544. <span style="color: #e6db74">)&quot;</span><span style="color: #f8f8f2">;</span> <span style="color: #75715e">// Step #5</span>
  545. <span style="color: #66d9ef">void</span> <span style="color: #a6e22e">setup</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
  546. <span style="color: #f8f8f2">config.ota</span> <span style="color: #f92672">=</span> <span style="color: #f8f8f2">AC_OTA_BUILTIN;</span> <span style="color: #75715e">// Step #6.a</span>
  547. <span style="color: #f8f8f2">portal.config(config);</span> <span style="color: #75715e">// Step #6.a</span>
  548. <span style="color: #f8f8f2">hello.load(HELLO_PAGE);</span> <span style="color: #75715e">// Step #6.b</span>
  549. <span style="color: #f8f8f2">portal.join({</span> <span style="color: #f8f8f2">hello</span> <span style="color: #f8f8f2">});</span> <span style="color: #75715e">// Step #6.c</span>
  550. <span style="color: #f8f8f2">portal.begin();</span> <span style="color: #75715e">// Step #6.d</span>
  551. <span style="color: #f8f8f2">}</span>
  552. <span style="color: #66d9ef">void</span> <span style="color: #a6e22e">loop</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
  553. <span style="color: #f8f8f2">portal.handleClient();</span> <span style="color: #75715e">// Step #7</span>
  554. <span style="color: #f8f8f2">}</span>
  555. </code></pre></div>
  556. <div class="admonition faq">
  557. <p class="admonition-title">How LED ticking during updates</p>
  558. <p>AutoConnectOTA applies LED ticking during updates automatically. The destination LED port and ticker drive depends on <a href="apiconfig.html#tickerport">AutoConnectConfig::tickerPort</a> and <a href="apiconfig.html#tickeron">AutoConnectConfig::tickerOn</a> specifying.</p>
  559. <p><strong>IMPORTANT</strong><br />
  560. The AutoConnectOTA activates the ticker constantly regardless of the <a href="apiconfig.html#ticker">AutoConnectConfig::ticker</a> value. If you want to stop the ticker output to GPIO during updates, give <code>0xff</code> to <a href="apiconfig.html#tickerport">AutoConnectConfig::tickerPort</a>.</p>
  561. </div>
  562. <h3 id="autoconnectota-allocation-uri"><i class="fa fa-wrench"></i> AutoConnectOTA allocation URI<a class="headerlink" href="#autoconnectota-allocation-uri" title="Permanent link">&para;</a></h3>
  563. <p>AutoConnectOTA has implemented using AutoConnectAUX. So it occupies two URIs by default. An update operation page is assigned to <strong>AUTOCONNECT_URI_UPDATE</strong> and the binary file uploader for the update is assigned to <strong>AUTOCONNECT_URI_UPDATE_ACT</strong>. These symbols are defined in the <code>AutoConnectDefs.h</code> header file as follows:</p>
  564. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #75715e">#define AUTOCONNECT_URI &quot;/_ac&quot;</span>
  565. <span style="color: #75715e">#define AUTOCONNECT_URI_UPDATE AUTOCONNECT_URI &quot;/update&quot;</span>
  566. <span style="color: #75715e">#define AUTOCONNECT_URI_UPDATE_ACT AUTOCONNECT_URI &quot;/update_act&quot;</span>
  567. </code></pre></div>
  568. <p>Therefore, the normal Sketch that imports AutoConnectOTA while keeping the default, you cannot use the two URIs <code>/_ac/update</code> and <code>/_ac/update_act</code> for your specific. If you want to use the URIs for any purpose other than AutoConnectOTA, you need to override the <code>AutoConnectDefs.h</code> definition at compile time. It can be overwritten by giving the build flags for platformio.ini as follows with the PlatformIO environment for example.</p>
  569. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #a6e22e">build_flags</span> <span style="color: #f92672">=</span> <span style="color: #e6db74"></span>
  570. <span style="color: #e6db74"> -DAUTOCONNECT_URI_UPDATE=&#39;&quot;/YOURURI&quot;&#39;</span>
  571. <span style="color: #e6db74"> -DAUTOCONNECT_URI_UPDATE_ACT=&#39;&quot;/YOURURIACT&quot;&#39;</span>
  572. </code></pre></div>
  573. <h3 id="timing-of-autoconnectota-instantiation"><i class="fa fa-wrench"></i> Timing of AutoConnectOTA instantiation<a class="headerlink" href="#timing-of-autoconnectota-instantiation" title="Permanent link">&para;</a></h3>
  574. <p>It will be born during <a href="api.html#handleclient">AutoConnect::handleClient</a> process. AutoConnect will evaluate the enabled state of <a href="apiconfig.html#ota">AutoConnectConfig::ota</a> each time the handleClient is executed, and if OTA is enabled then it creates an AutoConnectAux internally and assigns it to the update page. At this time, AutoConnectOTA is also instantiated together. The generated AUX page containing AutoConnectOTA is bound to AutoConnect inside the AutoConnect::handleClient process.</p>
  575. <p>If you want to attach AutoConnectOTA dynamically with an external trigger, you can sketch like this:<br />
  576. <em>This sketch imports the OTA update feature with an external switch assigned to the GPIO pin. While the trigger not occurs, AutoConnect OTA will not be imported into Sketch and will not appear on the menu list.</em></p>
  577. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266WiFi.h&gt;</span>
  578. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266WebServer.h&gt;</span>
  579. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;AutoConnect.h&gt;</span>
  580. <span style="color: #75715e">#define TRIGGER 4 // pin assigned to external trigger switch</span>
  581. <span style="color: #f8f8f2">AutoConnect</span> <span style="color: #f8f8f2">portal;</span>
  582. <span style="color: #f8f8f2">AutoConnectConfig</span> <span style="color: #f8f8f2">config;</span>
  583. <span style="color: #66d9ef">void</span> <span style="color: #a6e22e">setup</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
  584. <span style="color: #f8f8f2">pinMode(TRIGGER,</span> <span style="color: #f8f8f2">INPUT);</span>
  585. <span style="color: #f8f8f2">portal.begin();</span>
  586. <span style="color: #f8f8f2">}</span>
  587. <span style="color: #66d9ef">void</span> <span style="color: #a6e22e">loop</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
  588. <span style="color: #66d9ef">if</span> <span style="color: #f8f8f2">(digitalRead(TRIGGER)</span> <span style="color: #f92672">==</span> <span style="color: #f8f8f2">HIGH)</span> <span style="color: #f8f8f2">{</span>
  589. <span style="color: #f8f8f2">config.ota</span> <span style="color: #f92672">=</span> <span style="color: #f8f8f2">AC_OTA_BUILTIN;</span>
  590. <span style="color: #f8f8f2">portal.config(config);</span>
  591. <span style="color: #f8f8f2">}</span>
  592. <span style="color: #f8f8f2">portal.handleClient();</span>
  593. <span style="color: #f8f8f2">}</span>
  594. </code></pre></div>
  595. <div class="admonition note">
  596. <p class="admonition-title">AutoConnectOTA <strong>cannot</strong> detach dynamically</p>
  597. <p>Once imported, AutoConnectOTA cannot be removed from the Sketch. It can be only excluded from the menu by overriding <a href="apiconfig.html#menuitems">AutoConnectConfig::menuItems</a>. In this case, the AutoConnectOTA instance remains as a residue.</p>
  598. </div>
  599. <h3 id="how-to-make-the-binary-sketch"><i class="fa fa-wrench"></i> How to make the binary sketch<a class="headerlink" href="#how-to-make-the-binary-sketch" title="Permanent link">&para;</a></h3>
  600. <p>Binary sketch files for updating can be retrieved using the Arduino IDE. Open the <strong>Sketch</strong> menu and select the <strong>Export compiled Binary</strong>, then starts compilation.</p>
  601. <p><img src="images/export_binary.png" width="450" /></p>
  602. <p>When the compilation is complete, a binary sketch will save with the extension <code>.bin</code> in the same folder as the Sketch.</p>
  603. <h3 id="ota-updates-wbrowser-without-using-autoconnectota"><i class="fa fa-edit"></i> OTA updates w/browser without using AutoConnectOTA<a class="headerlink" href="#ota-updates-wbrowser-without-using-autoconnectota" title="Permanent link">&para;</a></h3>
  604. <p>The legacy OTA method based on ESP8266HTTPUpdateServer without AutoConnectOTA is still valid. To embed the ESP8266HTTPUpdateServer class with AutoConnect into your sketch, basically follow these steps:</p>
  605. <ol>
  606. <li>Include <code>ESP8266HTTPUpdateServer.h</code>, also <code>WiFiClient.h</code>, in addition to the usual directives as <code>ESP8266WebServer.h</code> and <code>AutoConnect.h</code>.<sup id="fnref:2"><a class="footnote-ref" href="#fn:2">2</a></sup></li>
  607. <li>Declare an ESP8266WebServer object. (In ESP32, as WebServer)</li>
  608. <li>Declare an ESP8266HTTPUpdateServer object.</li>
  609. <li>Declare an AutoConnect object with an ESP8266WebServer object as an argument.</li>
  610. <li>Declare an AutoConnectAux object for the update operation page.</li>
  611. <li>Assign <code>/update</code> to the URI of the update dialog page.</li>
  612. <li>Assign any title as the AutoConnect menu for the update dialog page.</li>
  613. <li>Declare additional AutoConnectAux pages for your application intention if needed.</li>
  614. <li>Perform the following procedure steps in the <code>setup()</code> function:<ol>
  615. <li>Invokes <code>ESP8288HTTPUpdateServer::setup</code> function, specifies the <strong>USERNAME</strong> and the <strong>PASSWORD</strong> as needed.</li>
  616. <li>Load the AutoConnectAux pages declared in step <a class="magiclink magiclink-github magiclink-issue" href="https://github.com/Hieromon/AutoConnect/issues/8" title="GitHub Issue: Hieromon/AutoConnect#8">#8</a> for your application. (Except the update dialog page)</li>
  617. <li>Join these pages to AutoConnect along with the update dialog page declared in step <a class="magiclink magiclink-github magiclink-issue" href="https://github.com/Hieromon/AutoConnect/issues/5" title="GitHub Issue: Hieromon/AutoConnect#5">#5</a>.</li>
  618. <li>Invokes <a href="api.html#begin">AutoConnect::begin</a> function.</li>
  619. </ol>
  620. </li>
  621. <li>Invokes <a href="api.html#handleclient">AutoConnect::handleClient</a> function in the <code>loop()</code>. </li>
  622. </ol>
  623. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266WiFi.h&gt;</span>
  624. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266WebServer.h&gt;</span>
  625. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;ESP8266HTTPUpdateServer.h&gt; // Step #1</span>
  626. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;WiFiClient.h&gt; // Step #1</span>
  627. <span style="color: #75715e">#include</span> <span style="color: #75715e">&lt;AutoConnect.h&gt;</span>
  628. <span style="color: #66d9ef">static</span> <span style="color: #66d9ef">const</span> <span style="color: #66d9ef">char</span> <span style="color: #f8f8f2">HELLO_PAGE[]</span> <span style="color: #f8f8f2">PROGMEM</span> <span style="color: #f92672">=</span> <span style="color: #e6db74">R&quot;(</span>
  629. <span style="color: #e6db74">{ &quot;title&quot;: &quot;Hello world&quot;, &quot;uri&quot;: &quot;/&quot;, &quot;menu&quot;: true, &quot;element&quot;: [</span>
  630. <span style="color: #e6db74"> { &quot;name&quot;: &quot;caption&quot;, &quot;type&quot;: &quot;ACText&quot;, &quot;value&quot;: &quot;&lt;h2&gt;Hello, world&lt;/h2&gt;&quot;, &quot;style&quot;: &quot;text-align:center;color:#2f4f4f;padding:10px;&quot; },</span>
  631. <span style="color: #e6db74"> { &quot;name&quot;: &quot;content&quot;, &quot;type&quot;: &quot;ACText&quot;, &quot;value&quot;: &quot;In this page, place the custom web page handled by the Sketch application.&quot; } ]</span>
  632. <span style="color: #e6db74">}</span>
  633. <span style="color: #e6db74">)&quot;</span><span style="color: #f8f8f2">;</span>
  634. <span style="color: #f8f8f2">ESP8266WebServer</span> <span style="color: #f8f8f2">httpServer;</span> <span style="color: #75715e">// Step #2</span>
  635. <span style="color: #f8f8f2">ESP8266HTTPUpdateServer</span> <span style="color: #f8f8f2">httpUpdate;</span> <span style="color: #75715e">// Step #3</span>
  636. <span style="color: #f8f8f2">AutoConnect</span> <span style="color: #a6e22e">portal</span><span style="color: #f8f8f2">(httpServer);</span> <span style="color: #75715e">// Step #4</span>
  637. <span style="color: #f8f8f2">AutoConnectAux</span> <span style="color: #a6e22e">update</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&quot;/update&quot;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&quot;UPDATE&quot;</span><span style="color: #f8f8f2">);</span> <span style="color: #75715e">// Step #5, #6, #7</span>
  638. <span style="color: #f8f8f2">AutoConnectAux</span> <span style="color: #f8f8f2">hello;</span> <span style="color: #75715e">// Step #8</span>
  639. <span style="color: #66d9ef">void</span> <span style="color: #a6e22e">setup</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
  640. <span style="color: #f8f8f2">httpUpdate.setup(</span><span style="color: #f92672">&amp;</span><span style="color: #f8f8f2">httpServer,</span> <span style="color: #e6db74">&quot;USERNAME&quot;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&quot;PASSWORD&quot;</span><span style="color: #f8f8f2">);</span> <span style="color: #75715e">// Step #9.a</span>
  641. <span style="color: #f8f8f2">hello.load(HELLO_PAGE);</span> <span style="color: #75715e">// Step #9.b</span>
  642. <span style="color: #f8f8f2">portal.join({</span> <span style="color: #f8f8f2">hello,</span> <span style="color: #f8f8f2">update</span> <span style="color: #f8f8f2">});</span> <span style="color: #75715e">// Step #9.c</span>
  643. <span style="color: #f8f8f2">portal.begin();</span> <span style="color: #75715e">// Step #9.d</span>
  644. <span style="color: #f8f8f2">}</span>
  645. <span style="color: #66d9ef">void</span> <span style="color: #a6e22e">loop</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
  646. <span style="color: #f8f8f2">portal.handleClient();</span> <span style="color: #75715e">// Step #10</span>
  647. <span style="color: #f8f8f2">}</span>
  648. </code></pre></div>
  649. <h3 id="regular-file-uploading-using-autoconnectotaenhanced-wv120"><i class="fa fa-edit"></i> Regular file uploading using AutoConnectOTA&nbsp;<sup><sub>ENHANCED w/v1.2.0</sub></sup><a class="headerlink" href="#regular-file-uploading-using-autoconnectotaenhanced-wv120" title="Permanent link">&para;</a></h3>
  650. <p>The <a href="otabrowser.html">built-in OTA update feature</a> can update the firmware as well as upload regular files placed in the file system on the ESP module. It allows a regular file is uploaded via OTA using the <a href="menu.html#update"><strong>Update</strong></a> of AutoConnect menu without adding a particular custom Web page that contains AutoConnectFile. This utilization is useful for the operation of transferring the JSON document of the custom web page definition, the external parameter file of your sketch, and so on into the target ESP module via OTA.</p>
  651. <p>The built-in OTA update feature determines where to save the uploaded file according to the filename pattern. By default, a filename with ends a <strong><code>.bin</code></strong> extension is subject to firmware updates. A file that has another extensions will be saved as a regular to LittleFS (or SPIFFS) in the flash.</p>
  652. <p>The filename extension that should be treated as the firmware is defined as the <a href="https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L280"><code>AUTOCONNECT_UPLOAD_ASFIRMWARE</code></a> macro in <a href="https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h">AutoConnectDefs.h</a> header file of the library source code. When dealing with another extensions for the updating file as firmware change this macro definition.</p>
  653. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #75715e">#define AUTOCONNECT_UPLOAD_ASFIRMWARE &quot;.bin&quot;</span>
  654. </code></pre></div>
  655. <div class="admonition info">
  656. <p class="admonition-title">Specify with the PlatformIO</p>
  657. <p><code>AUTOCONNECT_UPLOAD_ASFIRMWARE</code> pattern will be embedded into the binary sketch is determined at compile time. The <a href="https://platformio.org/platformio-ide"><strong>PlatformIO</strong></a> build system allows you to change the pattern of the file extension for each project without modifying the library source code.</p>
  658. <div class="highlight" style="background: #272822"><pre style="line-height: 125%; margin: 0;"><span></span><code><span style="color: #a6e22e">build_flags</span><span style="color: #f92672">=</span><span style="color: #e6db74">-DAUTOCONNECT_UPLOAD_ASFIRMWARE=&#39;&quot;.bin&quot;&#39;</span>
  659. </code></pre></div>
  660. </div>
  661. <div class="admonition note">
  662. <p class="admonition-title">Use a regular expression to specify the file extension</p>
  663. <p>By default, you can specify only one file extension to be treated as firmware in OTA updates. However, you can specify the file extension as a regular expression, but it consumes a lot of memory.</p>
  664. <p>If the file extension pattern contains a regular expression, you need to enable the flag of <a href="https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L277"><code>AUTOCONNECT_UPLOAD_ASFIRMWARE_USE_REGEXP</code></a> in <code>AutoConnectDefs.h</code>. Also, the <code>AUTOCONNECT_UPLOAD_ASFIRMWARE</code> definition as a regular expression is treated as a replacement string for the <strong>#define</strong> directive for C++ preprocessor, so the backslash must be escaped.</p>
  665. </div>
  666. <script>
  667. window.onload = function() {
  668. Gifffer();
  669. };
  670. </script>
  671. <div class="footnote">
  672. <hr />
  673. <ol>
  674. <li id="fn:1">
  675. <p>For ESP32, change the following items:</p>
  676. <ul>
  677. <li>Change the include directives appropriately for the ESP32 environment.</li>
  678. <li>Change ESP8266WebServer to WebServer.</li>
  679. </ul>
  680. <p><a class="footnote-backref" href="#fnref:1" title="Jump back to footnote 1 in the text">&#8617;</a></p>
  681. </li>
  682. <li id="fn:2">
  683. <p>The AutoConnect library provides an implementation of the <strong>HTTPUpdateServer</strong> class that ported from ESP8266HTTPUpdateServer class for ESP32 intention. It is contained the <strong>WebUpdate</strong> under the examples folder.&#160;<a class="footnote-backref" href="#fnref:2" title="Jump back to footnote 2 in the text">&#8617;</a></p>
  684. </li>
  685. </ol>
  686. </div>
  687. </article>
  688. </div>
  689. </div>
  690. </main>
  691. <footer class="md-footer">
  692. <div class="md-footer-nav">
  693. <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
  694. <a href="otaupdate.html" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  695. <div class="md-footer-nav__button md-icon">
  696. <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>
  697. </div>
  698. <div class="md-footer-nav__title">
  699. <div class="md-ellipsis">
  700. <span class="md-footer-nav__direction">
  701. Previous
  702. </span>
  703. OTA Updates
  704. </div>
  705. </div>
  706. </a>
  707. <a href="otaserver.html" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
  708. <div class="md-footer-nav__title">
  709. <div class="md-ellipsis">
  710. <span class="md-footer-nav__direction">
  711. Next
  712. </span>
  713. Using Update Server
  714. </div>
  715. </div>
  716. <div class="md-footer-nav__button md-icon">
  717. <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>
  718. </div>
  719. </a>
  720. </nav>
  721. </div>
  722. <div class="md-footer-meta md-typeset">
  723. <div class="md-footer-meta__inner md-grid">
  724. <div class="md-footer-copyright">
  725. <div class="md-footer-copyright__highlight">
  726. Copyright &copy; 2018-2020 Hieromon Ikasamo
  727. </div>
  728. Made with
  729. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  730. Material for MkDocs
  731. </a>
  732. </div>
  733. <div class="md-footer-social">
  734. <a href="https://github.com/Hieromon" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
  735. <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>
  736. </a>
  737. <a href="https://twitter.com/hieromon" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
  738. <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>
  739. </a>
  740. </div>
  741. </div>
  742. </div>
  743. </footer>
  744. </div>
  745. <script src="assets/javascripts/vendor.fd16492e.min.js"></script>
  746. <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>
  747. <script>
  748. app = initialize({
  749. base: ".",
  750. features: [],
  751. search: Object.assign({
  752. worker: "assets/javascripts/worker/search.4ac00218.min.js"
  753. }, typeof search !== "undefined" && search)
  754. })
  755. </script>
  756. <script src="js/gifffer.min.js"></script>
  757. </body>
  758. </html>