alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update OTA README to mention advanced_https_ota example and add reference to API documentation of esp_https_ota component

Browse Source 
Closes: https://github.com/espressif/esp-idf/issues/5487
This commit is contained in:
Shubham Kulkarni 2020-07-13 11:06:53 +05:30 committed by bot
parent f92433b946
commit 7d3618a86c
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
examples/system/ota/README.md
View File

@ -9,7 +9,9 @@ ESP32 application can do upgrading at runtime by downloading new image from spec
- Using the native APIs provided by `app_update` component.
- Using simplified APIs provided by `esp_https_ota` component, which adds an abstraction layer over the native OTA APIs in order to upgrading with HTTPS protocol.
Both methods are demonstrated in OTA Demos under `native_ota_example` and `simple_ota_example` respectively.
Use of native APIs is demonstrated under `native_ota_example` while use of APIs provided by `esp_https_ota` component is demonstrated under `simple_ota_example` and `advanced_https_ota`.
For information regarding APIs provided by `esp_https_ota` component, please refer to [ESP HTTPS OTA](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/esp_https_ota.html).
For simplicity, the OTA examples choose the pre-defined partition table by enabling `CONFIG_PARTITION_TABLE_TWO_OTA` option in menuconfig, which supports three app partitions: factory, OTA_0 and OTA_1. For more information about partition table, please refer to [Partition Tables](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/partition-tables.html).

7
examples/system/ota/advanced_https_ota/README.md Normal file
View File

@ -0,0 +1,7 @@
# Advanced HTTPS OTA example
This example is based on `esp_https_ota` component's APIs.
## Configuration
Refer README.md in the parent directory for setup details