esp_https_ota_finish() function

Clean-up HTTPS OTA Firmware upgrade and close HTTPS connection This function closes the HTTP connection and frees the ESP HTTPS OTA context. This function switches the boot partition to the OTA partition containing the new firmware image.

Syntax

Show:

Summary

Declaration

Definition

from esp_https_ota.h:186

esp_err_t esp_https_ota_finish(esp_https_ota_handle_t https_ota_handle);

Implemented in esp_https_ota.c:648

Arguments

Argument

Description

https_ota_handle

pointer to esp_https_ota_handle_t structure

Return value

- ESP_OK: Clean-up successful - ESP_ERR_INVALID_STATE - ESP_ERR_INVALID_ARG: Invalid argument - ESP_ERR_OTA_VALIDATE_FAILED: Invalid app image

Notes

If this API returns successfully, esp_restart() must be called to boot from the new firmware image esp_https_ota_finish should not be called after calling esp_https_ota_abort

Examples

esp_https_ota_finish() is referenced by 2 libraries and example projects:

References

from examples

esp_https_ota_finish() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle