esp_https_ota: Add support for HTTPS based ota feature

This commit is contained in:
Jitin George
2018-07-12 17:45:44 +05:30
parent a4270573e7
commit fbe792f33f
22 changed files with 518 additions and 192 deletions

View File

@@ -142,6 +142,8 @@ INPUT = \
../../components/esp32/include/esp_ipc.h \
## Over The Air Updates (OTA)
../../components/app_update/include/esp_ota_ops.h \
## ESP HTTPS OTA
../../components/esp_https_ota/include/esp_https_ota.h \
## Sleep
## NOTE: for line below header_file.inc is not used
../../components/esp32/include/esp_sleep.h \

View File

@@ -0,0 +1,35 @@
ESP HTTPS OTA
=============
Overview
--------
``esp_https_ota`` provides simplified APIs to perform firmware upgrades over HTTPS.
It's an abstraction layer over existing OTA APIs.
Application Example
-------------------
.. highlight:: c
::
esp_err_t do_firmware_upgrade()
{
esp_http_client_config_t config = {
.url = CONFIG_FIRMWARE_UPGRADE_URL,
.cert_pem = (char *)server_cert_pem_start,
};
esp_err_t ret = esp_https_ota(&config);
if (ret == ESP_OK) {
esp_restart();
} else {
return ESP_FAIL;
}
return ESP_OK;
}
API Reference
-------------
.. include:: /_build/inc/esp_https_ota.inc

View File

@@ -18,6 +18,7 @@ System API
Sleep Modes <sleep_modes>
Base MAC address <base_mac_address>
Over The Air Updates (OTA) <ota>
ESP HTTPS OTA <esp_https_ota>
ESP pthread <esp_pthread>
Error Codes and Helper Functions <esp_err>

View File

@@ -37,6 +37,7 @@ See also
* :doc:`Partition Table documentation <../../api-guides/partition-tables>`
* :doc:`Lower-Level SPI Flash/Partition API <../storage/spi_flash>`
* :doc:`ESP HTTPS OTA <esp_https_ota>`
Application Example
-------------------

View File

@@ -0,0 +1 @@
.. include:: ../../../en/api-reference/system/esp_https_ota.rst