Function esp_idf_sys::esp_https_ota_perform

source · 
pub unsafe extern "C" fn esp_https_ota_perform(
    https_ota_handle: esp_https_ota_handle_t,
) -> esp_err_t
Expand description

@brief Read image data from HTTP stream and write it to OTA partition

This function reads image data from HTTP stream and writes it to OTA partition. This function must be called only if esp_https_ota_begin() returns successfully. This function must be called in a loop since it returns after every HTTP read operation thus giving you the flexibility to stop OTA operation midway.

@param[in] https_ota_handle pointer to esp_https_ota_handle_t structure

@return

  • ESP_ERR_HTTPS_OTA_IN_PROGRESS: OTA update is in progress, call this API again to continue.
  • ESP_OK: OTA update was successful
  • ESP_FAIL: OTA update failed
  • ESP_ERR_INVALID_ARG: Invalid argument
  • ESP_ERR_INVALID_VERSION: Invalid chip revision in image header
  • ESP_ERR_OTA_VALIDATE_FAILED: Invalid app image
  • ESP_ERR_NO_MEM: Cannot allocate memory for OTA operation.
  • ESP_ERR_FLASH_OP_TIMEOUT or ESP_ERR_FLASH_OP_FAIL: Flash write failed.
  • For other return codes, refer OTA documentation in esp-idf’s app_update component.