Skip to content
This repository was archived by the owner on Jul 6, 2024. It is now read-only.

Commit aa3cdae

Browse files
ayushsharma82ayushsharma82
authored
Update README.md
1 parent 098cbd1 commit aa3cdae

File tree

1 file changed

+3
-203
lines changed

1 file changed

+3
-203
lines changed

‎README.md

Lines changed: 3 additions & 203 deletions
Original file line numberDiff line numberDiff line change
@@ -1,209 +1,9 @@
11
<p align="center"><img src="/docs/logo.svg?sanitize=true&raw=true" width="400"></p>
22

3-
<hr/>
4-
<p align="center">
5-
<img src="https://img.shields.io/github/last-commit/ayushsharma82/AsyncElegantOTA.svg?style=for-the-badge" />
6-
&nbsp;
7-
<img src="https://img.shields.io/github/actions/workflow/status/ayushsharma82/AsyncElegantOTA/ci.yml?branch=master&style=for-the-badge" />
8-
&nbsp;
9-
<img src="https://img.shields.io/github/license/ayushsharma82/AsyncElegantOTA.svg?style=for-the-badge" />
10-
&nbsp;
11-
<a href="https://www.buymeacoffee.com/6QGVpSj" target="_blank"><img src="https://img.shields.io/badge/Buy%20me%20a%20coffee-%245-orange?style=for-the-badge&logo=buy-me-a-coffee" /></a>
12-
</p>
13-
<hr/>
14-
15-
16-
<p align="center">Perform OTAs for ESP8266 & ESP32 Asynchronously</p>
17-
<p align="center">
18-
AsyncElegantOTA provides a beautiful interface to upload Over the Air `.bin` updates to your ESP Modules with precise status and progress displayed over UI. This Library shows the current upload progress of your OTA and once finished, it will display the status of your OTA. This Version of Library uses AsyncWebServer. Thanks to @me-no-dev for a wonderful webserver library.
19-
</p>
20-
21-
<br>
22-
<br>
23-
24-
<h2 align="center">Preview</h2>
25-
<p align="center"><img src="/docs/elegantOtaDemo.gif?raw=true"></p>
26-
27-
<br>
28-
<br>
29-
30-
<h2>How to Install</h2>
31-
32-
###### Directly Through Arduino IDE ( Currently Submitted for Approval. Use Mannual Install till it gets Approved.)
33-
Go to Sketch > Include Library > Library Manager > Search for "AsyncElegantOTA" > Install
34-
35-
###### Manual Install
36-
37-
For Windows: Download the [Repository](https://github.com/ayushsharma82/AsyncElegantOTA/archive/master.zip) and extract the .zip in Documents>Arduino>Libraries>{Place "ElegantOTA" folder Here}
38-
39-
For Linux: Download the [Repository](https://github.com/ayushsharma82/AsyncElegantOTA/archive/master.zip) and extract the .zip in Sketchbook>Libraries>{Place "ElegantOTA" folder Here}
40-
41-
###### Manually through IDE
42-
43-
Download the [Repository](https://github.com/ayushsharma82/AsyncElegantOTA/archive/master.zip), Go to Sketch>Include Library>Add .zip Library> Select the Downloaded .zip File.
44-
45-
<br>
46-
47-
<h2>Documentation</h2>
48-
<p>AsyncElegantOTA is a dead simple library which does your work in just 1 Line. Honestly, It's just a wrapper library which injects it's own elegant webpage instead of the ugly upload page which comes by default in Arduino Library.</p>
49-
50-
Include AsyncElegantOTA Library `#include <AsyncElegantOTA.h>` at top of your Arduino Code.
51-
52-
Paste this - `AsyncElegantOTA.begin(&server);` line above your `server.begin();`
53-
54-
That's all!
553

56-
Now copy the IPAddress displayed over your Serial Monitor and go to `http://<IPAddress>/update` in browser. ( where `<IPAddress>` is the IP of your ESP Module)
57-
58-
<br>
59-
60-
#### Additional Security:
61-
62-
If you would like to add login to your OTA webpage, then please replace `AsyncElegantOTA.begin(&server);` with `AsyncElegantOTA.begin(&server, "username", "password");`. This will prevent unauthorized requests to your OTA webpage and prevent unauthorized firmware upload to your MCU.
63-
64-
<br>
65-
66-
<b>Antivirus Issue:</b> If you have an antivirus on your PC with internet security, the progress bar on webpage will instantly show 100% because of request caching by your antivirus software. There is no fix for this unless you want to disable your antivirus or whitelist your local IP addresses in it. ( Same is the case with iOS, safari will cache the outgoing requests )
67-
68-
<br>
69-
70-
<h2>Tutorials</h2>
71-
<p>Tutorials for AsyncElegantOTA is live on RandomNerdTutorials.</p>
4+
<h2 align="center">Deprecated</h2>
725

73-
<h3>ESP8266</h3>
74-
<h4>Arduino IDE:</h4>
75-
<p>https://randomnerdtutorials.com/esp8266-nodemcu-ota-over-the-air-arduino/</p>
76-
<h4>PlatformIO (manual method):</h4>
77-
<p>https://randomnerdtutorials.com/esp8266-nodemcu-ota-over-the-air-vs-code/</p>
78-
<br>
79-
80-
<h3>ESP32</h3>
81-
<h4>Arduino IDE:</h4>
82-
<p>https://randomnerdtutorials.com/esp32-ota-over-the-air-arduino/</p>
83-
<h4>PlatformIO (manual method):</h4>
84-
<p>https://randomnerdtutorials.com/esp32-ota-over-the-air-vs-code/</p>
85-
<br>
86-
<h3>PlatformIO Automatic Method</h3>
87-
<ul>
88-
<li> Copy the file "platformio_upload.py" from this repository into the same folder as your platformio.ini file
89-
<li> Set the upload method for your project in platformio.ini:
90-
</ul>
91-
92-
```
93-
extra_scripts = platformio_upload.py
94-
upload_protocol = custom
95-
upload_url = <your upload URL, such as http://192.168.1.123/update>
96-
```
97-
<br>
98-
<h2>Examples</h2>
99-
100-
<h3>For ESP8266:</h3>
101-
102-
```
103-
#include <ESP8266WiFi.h>
104-
#include <ESPAsyncTCP.h>
105-
#include <ESPAsyncWebServer.h>
106-
#include <AsyncElegantOTA.h>
107-
108-
const char* ssid = "........";
109-
const char* password = "........";
110-
111-
AsyncWebServer server(80);
112-
113-
114-
void setup(void) {
115-
Serial.begin(115200);
116-
WiFi.mode(WIFI_STA);
117-
WiFi.begin(ssid, password);
118-
Serial.println("");
119-
120-
// Wait for connection
121-
while (WiFi.status() != WL_CONNECTED) {
122-
delay(500);
123-
Serial.print(".");
124-
}
125-
Serial.println("");
126-
Serial.print("Connected to ");
127-
Serial.println(ssid);
128-
Serial.print("IP address: ");
129-
Serial.println(WiFi.localIP());
130-
131-
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) {
132-
request->send(200, "text/plain", "Hi! I am ESP8266.");
133-
});
134-
135-
AsyncElegantOTA.begin(&server); // Start ElegantOTA
136-
server.begin();
137-
Serial.println("HTTP server started");
138-
}
139-
140-
void loop(void) {
141-
}
142-
143-
```
144-
145-
<br>
146-
<h3>For ESP32:</h3>
147-
148-
```
149-
#include <WiFi.h>
150-
#include <AsyncTCP.h>
151-
#include <ESPAsyncWebServer.h>
152-
#include <AsyncElegantOTA.h>
153-
154-
const char* ssid = "........";
155-
const char* password = "........";
156-
157-
AsyncWebServer server(80);
158-
159-
160-
void setup(void) {
161-
Serial.begin(115200);
162-
WiFi.mode(WIFI_STA);
163-
WiFi.begin(ssid, password);
164-
Serial.println("");
165-
166-
// Wait for connection
167-
while (WiFi.status() != WL_CONNECTED) {
168-
delay(500);
169-
Serial.print(".");
170-
}
171-
Serial.println("");
172-
Serial.print("Connected to ");
173-
Serial.println(ssid);
174-
Serial.print("IP address: ");
175-
Serial.println(WiFi.localIP());
176-
177-
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) {
178-
request->send(200, "text/plain", "Hi! I am ESP32.");
179-
});
180-
181-
AsyncElegantOTA.begin(&server); // Start ElegantOTA
182-
server.begin();
183-
Serial.println("HTTP server started");
184-
}
185-
186-
void loop(void) {
187-
}
188-
189-
```
190-
<br>
191-
<br>
192-
193-
<h2>Contributions</h2>
194-
<p>Every Contribution to this repository is highly appriciated! Don't fear to create pull requests which enhance or fix the library as ultimatly you are going to help everybody.</p>
195-
<p>
196-
If you want to donate to the author then <b>you can buy me a coffee</b>, It really helps me keep these libraries updated:
197-
<br/><br/>
198-
<a href="https://www.buymeacoffee.com/6QGVpSj" target="_blank"><img src="https://img.shields.io/badge/Buy%20me%20a%20coffee-%245-orange?style=for-the-badge&logo=buy-me-a-coffee" /></a>
6+
<p align="center">
7+
AsyncElegantOTA has been deprecated in favor of new ElegantOTA V3 which now comes with Async Mode and latest features. Please consider moving to ElegantOTA V3 for further updates and improvements. <a href="https://github.com/ayushsharma82/ElegantOTA">Learn More</a>
1998
</p>
200-
<br/>
201-
<br/>
202-
2039

204-
<h2>License</h2>
205-
ESP-DASH is licensed under MIT.
206-
<br/>
207-
<br/>
208-
<img src="https://img.shields.io/github/license/ayushsharma82/AsyncElegantOTA.svg?style=for-the-badge" />
209-
</div>

0 commit comments

Comments
 (0)