Merge branch 'docs/update_esp_https_ota_docs_for_esp_events' into 'master'

docs: Update esp_https_ota docs to have information about OTA events

See merge request espressif/esp-idf!21531
This commit is contained in:
Aditya Patwardhan
2022-12-19 19:02:43 +08:00
2 changed files with 61 additions and 11 deletions

View File

@@ -22,17 +22,6 @@ ESP_EVENT_DECLARE_BASE(ESP_HTTPS_OTA_EVENT);
/**
* @brief Events generated by OTA process
*
* @note Expected data type for different OTA events:
* - ESP_HTTPS_OTA_START : NULL
* - ESP_HTTPS_OTA_CONNECTED : NULL
* - ESP_HTTPS_OTA_GET_IMG_DESC : NULL
* - ESP_HTTPS_OTA_VERIFY_CHIP_ID : esp_chip_id_t
* - ESP_HTTPS_OTA_DECRYPT_CB : NULL
* - ESP_HTTPS_OTA_WRITE_FLASH : int
* - ESP_HTTPS_OTA_UPDATE_BOOT_PARTITION : esp_partition_subtype_t
* - ESP_HTTPS_OTA_FINISH : NULL
* - ESP_HTTPS_OTA_ABORT : NULL
*/
typedef enum {
ESP_HTTPS_OTA_START, /*!< OTA started */