ESP-WebOTA/README.md
2019-03-14 15:44:39 -07:00

43 lines
1.3 KiB
Markdown

# ESP WebOTA
Easily add web based [OTA](https://en.wikipedia.org/wiki/Over-the-air_programming) updates to your ESP32 projects.
## Installation
Clone this repo to your Arduino libraries directory. On Linux this is `~/Arduino/libraries/`
## Usage
Create a global variable for the Web Server:
#include <WebOTA.h>
WebServer OTAServer(8080);
Initialize the WebOTA library at the end of your `setup()` function:
void setup() {
// Other init code here (WiFi, etc)
init_web_ota(&OTAServer);
}
Listen for update requests at the end of your `loop()` function:
void loop() {
// Other loop code here
OTAServer.handleClient();
}
**Note:** If you have long `delay()` commands in your `loop()` WebOTA may not be responsive. We have provided `webota_delay()` as a drop-in replacement, which is more WebOTA friendly.
## Upload a sketch
You will need to create a binary sketch image to upload. This is done in the Arduino IDE by going to the `Sketch` menu and selecting `Export compiled Binary`.
Navigate to your ESP32 in a web browser to upload your binary image. Typical URLs are: http://esp32-ota.local:8080/webota.
## Based on
Borrowed from [randomnerdtutorials.com](https://randomnerdtutorials.com/esp32-over-the-air-ota-programming/) and improved upon.