Skip to content

Commit

Permalink
fix: async mode doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushsharma82 committed Jun 28, 2024
1 parent 1d175b8 commit 87f0ed9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 21 deletions.
29 changes: 21 additions & 8 deletions docs/async-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,31 @@ sidebar_label: Async Mode
sidebar_position: 7
---

> NOTE: Async Mode is supported for ESP8266 & ESP32 microcontrollers only
## Introduction

One of the features of ElegantOTA is the async mode, which provides asynchronous web server functionality for handling OTA updates. This mode should only be enabled if you are using ESPAsyncWebServer library in your project/firmware.


## Enabling Async Mode
### Dependencies

#### For ESP8266

- (mathieucarbou) [esphome-ESPAsyncTCP](https://github.com/mathieucarbou/esphome-ESPAsyncTCP#v2.0.0) - **v2.0.0**
- (mathieucarbou) [ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.3) - **v3.0.3**

#### For ESP32

- (mathieucarbou) [AsyncTCP](https://github.com/mathieucarbou/AsyncTCP#v3.1.4) @ **v3.1.4**
- (mathieucarbou) [ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.3) - **v3.0.3**

### For Arduino IDE:
#### For RP2040+W

- (khoih-prog) [AsyncTCP_RP2040W](https://github.com/khoih-prog/AsyncTCP_RP2040W#v1.2.0) @ **v1.2.0**
- (mathieucarbou) [ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.3) - **v3.0.3**

### Enabling Async Mode

#### For Arduino IDE

1. Go to your Arduino libraries directory
2. Open `ElegantOTA` folder and then open `src` folder
Expand All @@ -27,8 +42,7 @@ One of the features of ElegantOTA is the async mode, which provides asynchronous
5. You are now ready to use ElegantOTA in async mode for your OTA updates, utilizing the ESPAsyncWebServer library.
### For PlatformIO:
#### For PlatformIO
If you use PlatformIO then we can use a neat trick! You can set `build_flags` in your `platformio.ini` file that enables Async Mode of ElegantOTA.
Expand All @@ -38,8 +52,7 @@ If you use PlatformIO then we can use a neat trick! You can set `build_flags` in
PlatformIO will now compile ElegantOTA in Async Mode!
## Benefits of Async Mode
### Benefits of Async Mode
Enabling async mode for ElegantOTA offers several advantages:
Expand Down
14 changes: 1 addition & 13 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,7 @@ sidebar_label: Installation
sidebar_position: 2
---

ElegantOTA requires no dependencies and runs out of the box with existing libraries provided in Arduino core. You can install ElegantOTA through one of the following methods:
<!--
##### For ESP8266:
- [ESP8266 Arduino Core](https://github.com/esp8266/Arduino) - **(latest)**
- [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) - **v1.2.0**
- [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) - **v1.2.3**
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson) - **v6.17.0**
##### For ESP32:
- [ESP32 Arduino Core](https://github.com/espressif/arduino-esp32) - **(latest)**
- [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) - **v1.0.3**
- [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) - **v1.2.3**
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson) - **v6.17.0** -->
ElegantOTA requires no dependencies and runs out of the box with existing libraries provided in Arduino core. You can install ElegantOTA through one of the following methods:

---

Expand Down
1 change: 1 addition & 0 deletions portal
Submodule portal added at 2a36c6

0 comments on commit 87f0ed9

Please sign in to comment.