From 60a5a907bccc0cc8e5283cd9b34cb4bca67bd54a Mon Sep 17 00:00:00 2001 From: pennam Date: Wed, 18 Jan 2023 08:51:49 +0100 Subject: [PATCH 1/5] Fix description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e2c476..c0eb508 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![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) [![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) -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. +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. ## Requirements From 05e1802f72fe97a7cc90a3eabbb7645ab141c991 Mon Sep 17 00:00:00 2001 From: pennam Date: Wed, 18 Jan 2023 08:52:30 +0100 Subject: [PATCH 2/5] Fix test table --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0eb508..584a153 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ This library allows OTA (Over-The-Air) firmware updates for ESP32 boards. OTA bi | | DOIT ESP32 DEVKIT V1 | | | Wemos Lolin D32 | | | NodeMCU-32S | - | `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) | + | `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) | | `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) | | | NodeMCU-32-S2 | | `ESP32-C3` | [LILYGO mini D1 PLUS](https://github.com/Xinyuan-LilyGO/LilyGo-T-OI-PLUS)| From d4ebf40963383a3dc152486d6a75fb073621c860 Mon Sep 17 00:00:00 2001 From: pennam Date: Wed, 18 Jan 2023 08:54:35 +0100 Subject: [PATCH 3/5] Add references to update library --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 584a153..d3bf190 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ 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. +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. + ## Requirements * Flash size > 2MB From 10b22f6a9082b8063e4ba842b8495ee2d9b47555 Mon Sep 17 00:00:00 2001 From: pennam Date: Wed, 18 Jan 2023 08:55:31 +0100 Subject: [PATCH 4/5] Add "How" section --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index d3bf190..94b5879 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ This library allows OTA (Over-The-Air) firmware updates for ESP32 boards. OTA bi 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. +## :mag: How? + +* Create a minimal [example](examples/OTA/OTA.ino) +* 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 + ## Requirements * Flash size > 2MB From f17d960e1eec3849b4966466e59250687d3b473b Mon Sep 17 00:00:00 2001 From: pennam Date: Wed, 18 Jan 2023 08:56:53 +0100 Subject: [PATCH 5/5] Update sections names and references --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 94b5879..641dba4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ `Arduino_ESP32_OTA` ==================== -*Note: This library is currently in [beta](#board-support).* +*Note: This library is currently in [beta](#tests).* [![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) [![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) @@ -16,7 +16,7 @@ The library is based on the [Update](https://github.com/espressif/arduino-esp32/ * Create a minimal [example](examples/OTA/OTA.ino) * 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 -## Requirements +## :key: Requirements * Flash size > 2MB * OTA_1 partition available within selected partition scheme @@ -39,7 +39,7 @@ The library is based on the [Update](https://github.com/espressif/arduino-esp32/ | `bare_minimum_2MB` | :x: | -## Board support +## :running: Tests * The library has been tested on the following boards: