Skip to content

README: Add missing information #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 18, 2023
Merged

README: Add missing information #5

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
60a5a90
Fix description
pennam Jan 18, 2023
05e1802
Fix test table
pennam Jan 18, 2023
d4ebf40
Add references to update library
pennam Jan 18, 2023
10b22f6
Add "How" section
pennam Jan 18, 2023
f17d960
Update sections names and references
pennam Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
`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)
[![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
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

## :key: Requirements

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


## Board support
## :running: Tests

* The library has been tested on the following boards:

Expand All @@ -43,7 +50,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)|