diff --git a/README.md b/README.md index 20be68c..6badd41 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # AutoConnect for ESP8266/ESP32 -[![arduino-library-badge](https://www.ardu-badge.com/badge/AutoConnect.svg?)](https://www.ardu-badge.com/AutoConnect) [![GitHub release](https://img.shields.io/github/v/release/Hieromon/AutoConnect)](https://github.com/Hieromon/AutoConnect/releases) +[![arduino-library-badge](https://www.ardu-badge.com/badge/AutoConnect.svg?)](https://www.ardu-badge.com/AutoConnect) [![Build Status](https://travis-ci.org/Hieromon/AutoConnect.svg?branch=master)](https://travis-ci.org/Hieromon/AutoConnect) [![License](https://img.shields.io/github/license/Hieromon/AutoConnect)](https://github.com/Hieromon/AutoConnect/blob/master/LICENSE) diff --git a/mkdocs/otabrowser.md b/mkdocs/otabrowser.md index f49191c..7eb6f94 100644 --- a/mkdocs/otabrowser.md +++ b/mkdocs/otabrowser.md @@ -62,7 +62,7 @@ void loop() { [^1]:For ESP32, change the following items: - Change the include directives appropriately for the ESP32 environment. - - Change ESP8266WebServer to Web. + - Change ESP8266WebServer to WebServer. !!! faq "How LED ticking during updates" AutoConnectOTA applies LED ticking during updates automatically. The destination LED port and ticker drive depends on [AutoConnectConfig::tickerPort](apiconfig.md#tickerport) and [AutoConnectConfig::tickerOn](apiconfig.md#tickeron) specifying. @@ -132,10 +132,9 @@ When the compilation is complete, a binary sketch will save with the extension ` ### OTA updates w/browser without using AutoConnectOTA -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: +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: -1. Include `ESP8266HTTPUpdateServer.h`, also `WiFiClient.h`, in addition to the usual directives as `ESP8266WebServer.h` and `AutoConnect.h`. +1. Include `ESP8266HTTPUpdateServer.h`, also `WiFiClient.h`, in addition to the usual directives as `ESP8266WebServer.h` and `AutoConnect.h`.[^2] 2. Declare an ESP8266WebServer object. (In ESP32, as WebServer) 3. Declare an ESP8266HTTPUpdateServer object. 4. Declare an AutoConnect object with an ESP8266WebServer object as an argument. @@ -150,6 +149,8 @@ To embed the ESP8266HTTPUpdateServer class with AutoConnect into your sketch, ba 4. Invokes [AutoConnect::begin](api.md#begin) function. 10. Invokes [AutoConnect::handleClient](api.md#handleclient) function in the `loop()`. +[^2]: The AutoConnect library provides an implementation of the **HTTPUpdateServer** class that ported from ESP8266HTTPUpdateServer class for ESP32 intention. It is contained the **WebUpdate** under the examples folder. + ```cpp #include #include diff --git a/mkdocs/otaupdate.md b/mkdocs/otaupdate.md index 39cb5cf..8a536af 100644 --- a/mkdocs/otaupdate.md +++ b/mkdocs/otaupdate.md @@ -4,8 +4,6 @@ AutoConnect provides **two type platforms** for updating the binary sketch in th [**The update behavior using a web browser**](otabrowser.md) as the client that supplies the binary sketch file for update follows the scenario assumed by the ESP8266 Arduino core. Therefore, the user sketch must meet the requirements described in the ESP8266 Arduino Core documentation, but you can easily embed the OTA update feature that able to operate via the web browser by AutoConnect menu. All you need to do is that specify [AutoConnectConfig](apiconfig.md#ota). -[^1]: The AutoConnect library provides an implementation of the **HTTPUpdateServer** class that ported from ESP8266HTTPUpdateServer class for ESP32 intention. It is contained the **WebUpdate** under the examples folder. - !!! caution "It is for the only the same network"