Skip to content

Commit 82fd2d3

Browse files
committed
Add Requirements and Tested boards
1 parent 970a594 commit 82fd2d3

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,49 @@
1-
Arduino_ESP_OTA
1+
`Arduino_ESP_OTA`
22
====================
33

4+
*Note: This library is currently in [beta](#board-support).*
5+
46
[![Compile Examples](https://github.com/bcmi-labs/Arduino_ESP_OTA/workflows/Compile%20Examples/badge.svg)](https://github.com/bcmi-labs/Arduino_ESP_OTA/actions?workflow=Compile+Examples)
57
[![Arduino Lint](https://github.com/bcmi-labs/Arduino_ESP_OTA/workflows/Arduino%20Lint/badge.svg)](https://github.com/bcmi-labs/Arduino_ESP_OTA/actions?workflow=Arduino+Lint)
68
[![Spell Check](https://github.com/bcmi-labs/Arduino_ESP_OTA/workflows/Spell%20Check/badge.svg)](https://github.com/bcmi-labs/Arduino_ESP_OTA/actions?workflow=Spell+Check)
79

8-
This library allows OTA (Over-The-Air) firmware updates for ESP boards. OTA binaries are downloaded via WiFi and stored in the OTA flash partition. After a reset the ESP bootloader performs the firmware update.
10+
This library allows OTA (Over-The-Air) firmware updates for ESP32 boards. OTA binaries are downloaded via WiFi and stored in the OTA flash partition. After a reset the ESP32 bootloader update the reference to the new firmware.
11+
12+
## Requirements
13+
14+
* Flash size > 2MB
15+
* OTA_1 partition available within selected partition scheme
16+
17+
| Partition scheme | OTA support |
18+
| --- | --- |
19+
| `app3M_fat9M_16MB` | :heavy_check_mark: |
20+
| `default_16MB` | :heavy_check_mark: |
21+
| `large_spiffs_16MB` | :heavy_check_mark: |
22+
| `ffat` | :heavy_check_mark: |
23+
| `default_8MB` | :heavy_check_mark: |
24+
| `max_app_8MB` | :x: |
25+
| `min_spiffs` | :heavy_check_mark: |
26+
| `default` / `default_ffat` | :heavy_check_mark: |
27+
| `huge_app` | :x: |
28+
| `no_ota` | :x: |
29+
| `noota_3g` / `noota_3gffat` / `noota_ffat` | :x: |
30+
| `rainmaker` | :heavy_check_mark: |
31+
| `minimal` | :x: |
32+
| `bare_minimum_2MB` | :x: |
33+
34+
35+
## Board support
36+
37+
* The library has been tested on the following boards:
38+
39+
| Module | Board |
40+
| --- | --- |
41+
| `ESP32-WROOM` | [ESP32-DevKitC V4](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#) |
42+
| `ESP32-WROVER` | [Freenove_ESP32_WROVER](https://github.com/Freenove/Freenove_ESP32_WROVER_Board) |
43+
| | DOIT ESP32 DEVKIT V1 |
44+
| | Wemos Lolin D32 |
45+
| | NodeMCU-32S |
46+
| `ESP32-­S3-­WROOM`­ | [ESP32-S3-DevKitC-1 v1.1](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html) |
47+
| `ESP32-­S2-­SOLO` | [ESP32-S2-DevKitC-1](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-s2-devkitc-1.html) |
48+
| | NodeMCU-32-S2 |
49+
| `ESP32-C3` | [LILYGO mini D1 PLUS](https://github.com/Xinyuan-LilyGO/LilyGo-T-OI-PLUS)|

0 commit comments

Comments
 (0)