Skip to content

Commit 8f9cf8a

Browse files
authored
Merge pull request #5 from bcmi-labs/readme-2
README: Add missing information
2 parents 94d081d + f17d960 commit 8f9cf8a

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
11
`Arduino_ESP32_OTA`
22
====================
33

4-
*Note: This library is currently in [beta](#board-support).*
4+
*Note: This library is currently in [beta](#tests).*
55

66
[![Compile Examples](https://github.com/bcmi-labs/Arduino_ESP32_OTA/workflows/Compile%20Examples/badge.svg)](https://github.com/bcmi-labs/Arduino_ESP32_OTA/actions?workflow=Compile+Examples)
77
[![Arduino Lint](https://github.com/bcmi-labs/Arduino_ESP32_OTA/workflows/Arduino%20Lint/badge.svg)](https://github.com/bcmi-labs/Arduino_ESP32_OTA/actions?workflow=Arduino+Lint)
88
[![Spell Check](https://github.com/bcmi-labs/Arduino_ESP32_OTA/workflows/Spell%20Check/badge.svg)](https://github.com/bcmi-labs/Arduino_ESP32_OTA/actions?workflow=Spell+Check)
99

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.
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 integrity checks the reference to the new firmware is configured in the bootloader and board is resetted to boot new firmware.
1111

12-
## Requirements
12+
The library is based on the [Update](https://github.com/espressif/arduino-esp32/tree/master/libraries/Update) library of the [arduino-esp32](https://github.com/espressif/arduino-esp32) core.
13+
14+
## :mag: How?
15+
16+
* Create a minimal [example](examples/OTA/OTA.ino)
17+
* Create a [compressed](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/extras/tools/lzss.py) [ota](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/extras/tools/bin2ota.py) file
18+
19+
## :key: Requirements
1320

1421
* Flash size > 2MB
1522
* OTA_1 partition available within selected partition scheme
@@ -32,7 +39,7 @@ This library allows OTA (Over-The-Air) firmware updates for ESP32 boards. OTA bi
3239
| `bare_minimum_2MB` | :x: |
3340

3441

35-
## Board support
42+
## :running: Tests
3643

3744
* The library has been tested on the following boards:
3845

@@ -43,7 +50,7 @@ This library allows OTA (Over-The-Air) firmware updates for ESP32 boards. OTA bi
4350
| | DOIT ESP32 DEVKIT V1 |
4451
| | Wemos Lolin D32 |
4552
| | 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) |
53+
| `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) |
4754
| `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) |
4855
| | NodeMCU-32-S2 |
4956
| `ESP32-C3` | [LILYGO mini D1 PLUS](https://github.com/Xinyuan-LilyGO/LilyGo-T-OI-PLUS)|

0 commit comments

Comments
 (0)