From 51d1da84604904315513a86d87197ee62c68cffa Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Tue, 13 May 2025 01:04:09 -0500 Subject: [PATCH] revert ota --- esphome/components/ota/__init__.py | 107 ++-- esphome/components/ota/automation.h | 23 +- esphome/components/ota/ota_backend.h | 79 +-- .../ota/ota_backend_arduino_esp32.cpp | 34 +- .../ota/ota_backend_arduino_esp32.h | 8 +- .../ota/ota_backend_arduino_esp8266.cpp | 36 +- .../ota/ota_backend_arduino_esp8266.h | 5 +- .../ota/ota_backend_arduino_libretiny.cpp | 38 +- .../ota/ota_backend_arduino_libretiny.h | 7 +- .../ota/ota_backend_arduino_rp2040.cpp | 36 +- .../ota/ota_backend_arduino_rp2040.h | 5 +- .../components/ota/ota_backend_esp_idf.cpp | 13 +- esphome/components/ota/ota_backend_esp_idf.h | 8 +- esphome/components/ota/ota_component.cpp | 535 ++++++++++++++++++ esphome/components/ota/ota_component.h | 112 ++++ 15 files changed, 781 insertions(+), 265 deletions(-) create mode 100644 esphome/components/ota/ota_component.cpp create mode 100644 esphome/components/ota/ota_component.h diff --git a/esphome/components/ota/__init__.py b/esphome/components/ota/__init__.py index 627c55e910..5d6b8eaf2f 100644 --- a/esphome/components/ota/__init__.py +++ b/esphome/components/ota/__init__.py @@ -2,70 +2,70 @@ from esphome import automation import esphome.codegen as cg import esphome.config_validation as cv from esphome.const import ( - CONF_ESPHOME, - CONF_ON_ERROR, + CONF_ID, + CONF_NUM_ATTEMPTS, CONF_OTA, - CONF_PLATFORM, + CONF_PASSWORD, + CONF_PORT, + CONF_REBOOT_TIMEOUT, + CONF_SAFE_MODE, CONF_TRIGGER_ID, + CONF_VERSION, + KEY_PAST_SAFE_MODE, ) from esphome.core import CORE, coroutine_with_priority +from esphome.cpp_generator import RawExpression CODEOWNERS = ["@esphome/core"] -AUTO_LOAD = ["md5", "safe_mode"] +DEPENDENCIES = ["network"] +AUTO_LOAD = ["socket", "md5"] -IS_PLATFORM_COMPONENT = True - -CONF_ON_ABORT = "on_abort" -CONF_ON_BEGIN = "on_begin" -CONF_ON_END = "on_end" -CONF_ON_PROGRESS = "on_progress" CONF_ON_STATE_CHANGE = "on_state_change" - +CONF_ON_BEGIN = "on_begin" +CONF_ON_PROGRESS = "on_progress" +CONF_ON_END = "on_end" +CONF_ON_ERROR = "on_error" ota_ns = cg.esphome_ns.namespace("ota") -OTAComponent = ota_ns.class_("OTAComponent", cg.Component) OTAState = ota_ns.enum("OTAState") -OTAAbortTrigger = ota_ns.class_("OTAAbortTrigger", automation.Trigger.template()) -OTAEndTrigger = ota_ns.class_("OTAEndTrigger", automation.Trigger.template()) -OTAErrorTrigger = ota_ns.class_("OTAErrorTrigger", automation.Trigger.template()) -OTAProgressTrigger = ota_ns.class_("OTAProgressTrigger", automation.Trigger.template()) -OTAStartTrigger = ota_ns.class_("OTAStartTrigger", automation.Trigger.template()) +OTAComponent = ota_ns.class_("OTAComponent", cg.Component) OTAStateChangeTrigger = ota_ns.class_( "OTAStateChangeTrigger", automation.Trigger.template() ) +OTAStartTrigger = ota_ns.class_("OTAStartTrigger", automation.Trigger.template()) +OTAProgressTrigger = ota_ns.class_("OTAProgressTrigger", automation.Trigger.template()) +OTAEndTrigger = ota_ns.class_("OTAEndTrigger", automation.Trigger.template()) +OTAErrorTrigger = ota_ns.class_("OTAErrorTrigger", automation.Trigger.template()) -def _ota_final_validate(config): - if len(config) < 1: - raise cv.Invalid( - f"At least one platform must be specified for '{CONF_OTA}'; add '{CONF_PLATFORM}: {CONF_ESPHOME}' for original OTA functionality" - ) - - -FINAL_VALIDATE_SCHEMA = _ota_final_validate - -BASE_OTA_SCHEMA = cv.Schema( +CONFIG_SCHEMA = cv.Schema( { + cv.GenerateID(): cv.declare_id(OTAComponent), + cv.Optional(CONF_SAFE_MODE, default=True): cv.boolean, + cv.Optional(CONF_VERSION, default=2): cv.one_of(1, 2, int=True), + cv.SplitDefault( + CONF_PORT, + esp8266=8266, + esp32=3232, + rp2040=2040, + bk72xx=8892, + rtl87xx=8892, + ): cv.port, + cv.Optional(CONF_PASSWORD): cv.string, + cv.Optional( + CONF_REBOOT_TIMEOUT, default="5min" + ): cv.positive_time_period_milliseconds, + cv.Optional(CONF_NUM_ATTEMPTS, default="10"): cv.positive_not_null_int, cv.Optional(CONF_ON_STATE_CHANGE): automation.validate_automation( { cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAStateChangeTrigger), } ), - cv.Optional(CONF_ON_ABORT): automation.validate_automation( - { - cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAAbortTrigger), - } - ), cv.Optional(CONF_ON_BEGIN): automation.validate_automation( { cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAStartTrigger), } ), - cv.Optional(CONF_ON_END): automation.validate_automation( - { - cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAEndTrigger), - } - ), cv.Optional(CONF_ON_ERROR): automation.validate_automation( { cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAErrorTrigger), @@ -76,13 +76,35 @@ BASE_OTA_SCHEMA = cv.Schema( cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAProgressTrigger), } ), + cv.Optional(CONF_ON_END): automation.validate_automation( + { + cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAEndTrigger), + } + ), } -) +).extend(cv.COMPONENT_SCHEMA) -@coroutine_with_priority(54.0) +@coroutine_with_priority(50.0) async def to_code(config): + CORE.data[CONF_OTA] = {} + + var = cg.new_Pvariable(config[CONF_ID]) + cg.add(var.set_port(config[CONF_PORT])) cg.add_define("USE_OTA") + if CONF_PASSWORD in config: + cg.add(var.set_auth_password(config[CONF_PASSWORD])) + cg.add_define("USE_OTA_PASSWORD") + cg.add_define("USE_OTA_VERSION", config[CONF_VERSION]) + + await cg.register_component(var, config) + + if config[CONF_SAFE_MODE]: + condition = var.should_enter_safe_mode( + config[CONF_NUM_ATTEMPTS], config[CONF_REBOOT_TIMEOUT] + ) + cg.add(RawExpression(f"if ({condition}) return")) + CORE.data[CONF_OTA][KEY_PAST_SAFE_MODE] = True if CORE.is_esp32 and CORE.using_arduino: cg.add_library("Update", None) @@ -90,18 +112,11 @@ async def to_code(config): if CORE.is_rp2040 and CORE.using_arduino: cg.add_library("Updater", None) - -async def ota_to_code(var, config): - await cg.past_safe_mode() use_state_callback = False for conf in config.get(CONF_ON_STATE_CHANGE, []): trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var) await automation.build_automation(trigger, [(OTAState, "state")], conf) use_state_callback = True - for conf in config.get(CONF_ON_ABORT, []): - trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var) - await automation.build_automation(trigger, [], conf) - use_state_callback = True for conf in config.get(CONF_ON_BEGIN, []): trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var) await automation.build_automation(trigger, [], conf) diff --git a/esphome/components/ota/automation.h b/esphome/components/ota/automation.h index 7e1a60f3ce..0c77a18ce1 100644 --- a/esphome/components/ota/automation.h +++ b/esphome/components/ota/automation.h @@ -1,8 +1,11 @@ #pragma once -#ifdef USE_OTA_STATE_CALLBACK -#include "ota_backend.h" +#include "esphome/core/defines.h" +#ifdef USE_OTA_STATE_CALLBACK + +#include "esphome/core/component.h" #include "esphome/core/automation.h" +#include "esphome/components/ota/ota_component.h" namespace esphome { namespace ota { @@ -12,7 +15,7 @@ class OTAStateChangeTrigger : public Trigger { explicit OTAStateChangeTrigger(OTAComponent *parent) { parent->add_on_state_callback([this, parent](OTAState state, float progress, uint8_t error) { if (!parent->is_failed()) { - trigger(state); + return trigger(state); } }); } @@ -51,17 +54,6 @@ class OTAEndTrigger : public Trigger<> { } }; -class OTAAbortTrigger : public Trigger<> { - public: - explicit OTAAbortTrigger(OTAComponent *parent) { - parent->add_on_state_callback([this, parent](OTAState state, float progress, uint8_t error) { - if (state == OTA_ABORT && !parent->is_failed()) { - trigger(); - } - }); - } -}; - class OTAErrorTrigger : public Trigger { public: explicit OTAErrorTrigger(OTAComponent *parent) { @@ -75,4 +67,5 @@ class OTAErrorTrigger : public Trigger { } // namespace ota } // namespace esphome -#endif + +#endif // USE_OTA_STATE_CALLBACK diff --git a/esphome/components/ota/ota_backend.h b/esphome/components/ota/ota_backend.h index bc8ab46643..5c5b61a278 100644 --- a/esphome/components/ota/ota_backend.h +++ b/esphome/components/ota/ota_backend.h @@ -1,53 +1,9 @@ #pragma once - -#include "esphome/core/component.h" -#include "esphome/core/defines.h" -#include "esphome/core/helpers.h" - -#ifdef USE_OTA_STATE_CALLBACK -#include "esphome/core/automation.h" -#endif +#include "ota_component.h" namespace esphome { namespace ota { -enum OTAResponseTypes { - OTA_RESPONSE_OK = 0x00, - OTA_RESPONSE_REQUEST_AUTH = 0x01, - - OTA_RESPONSE_HEADER_OK = 0x40, - OTA_RESPONSE_AUTH_OK = 0x41, - OTA_RESPONSE_UPDATE_PREPARE_OK = 0x42, - OTA_RESPONSE_BIN_MD5_OK = 0x43, - OTA_RESPONSE_RECEIVE_OK = 0x44, - OTA_RESPONSE_UPDATE_END_OK = 0x45, - OTA_RESPONSE_SUPPORTS_COMPRESSION = 0x46, - OTA_RESPONSE_CHUNK_OK = 0x47, - - OTA_RESPONSE_ERROR_MAGIC = 0x80, - OTA_RESPONSE_ERROR_UPDATE_PREPARE = 0x81, - OTA_RESPONSE_ERROR_AUTH_INVALID = 0x82, - OTA_RESPONSE_ERROR_WRITING_FLASH = 0x83, - OTA_RESPONSE_ERROR_UPDATE_END = 0x84, - OTA_RESPONSE_ERROR_INVALID_BOOTSTRAPPING = 0x85, - OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG = 0x86, - OTA_RESPONSE_ERROR_WRONG_NEW_FLASH_CONFIG = 0x87, - OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE = 0x88, - OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE = 0x89, - OTA_RESPONSE_ERROR_NO_UPDATE_PARTITION = 0x8A, - OTA_RESPONSE_ERROR_MD5_MISMATCH = 0x8B, - OTA_RESPONSE_ERROR_RP2040_NOT_ENOUGH_SPACE = 0x8C, - OTA_RESPONSE_ERROR_UNKNOWN = 0xFF, -}; - -enum OTAState { - OTA_COMPLETED = 0, - OTA_STARTED, - OTA_IN_PROGRESS, - OTA_ABORT, - OTA_ERROR, -}; - class OTABackend { public: virtual ~OTABackend() = default; @@ -59,38 +15,5 @@ class OTABackend { virtual bool supports_compression() = 0; }; -class OTAComponent : public Component { -#ifdef USE_OTA_STATE_CALLBACK - public: - void add_on_state_callback(std::function &&callback) { - this->state_callback_.add(std::move(callback)); - } - - protected: - CallbackManager state_callback_{}; -#endif -}; - -#ifdef USE_OTA_STATE_CALLBACK -class OTAGlobalCallback { - public: - void register_ota(OTAComponent *ota_caller) { - ota_caller->add_on_state_callback([this, ota_caller](OTAState state, float progress, uint8_t error) { - this->state_callback_.call(state, progress, error, ota_caller); - }); - } - void add_on_state_callback(std::function &&callback) { - this->state_callback_.add(std::move(callback)); - } - - protected: - CallbackManager state_callback_{}; -}; - -OTAGlobalCallback *get_global_ota_callback(); -void register_ota_platform(OTAComponent *ota_caller); -#endif -std::unique_ptr make_ota_backend(); - } // namespace ota } // namespace esphome diff --git a/esphome/components/ota/ota_backend_arduino_esp32.cpp b/esphome/components/ota/ota_backend_arduino_esp32.cpp index 15dfc98a6c..4759737dbd 100644 --- a/esphome/components/ota/ota_backend_arduino_esp32.cpp +++ b/esphome/components/ota/ota_backend_arduino_esp32.cpp @@ -1,19 +1,15 @@ -#ifdef USE_ESP32_FRAMEWORK_ARDUINO #include "esphome/core/defines.h" -#include "esphome/core/log.h" +#ifdef USE_ESP32_FRAMEWORK_ARDUINO -#include "ota_backend.h" #include "ota_backend_arduino_esp32.h" +#include "ota_component.h" +#include "ota_backend.h" #include namespace esphome { namespace ota { -static const char *const TAG = "ota.arduino_esp32"; - -std::unique_ptr make_ota_backend() { return make_unique(); } - OTAResponseTypes ArduinoESP32OTABackend::begin(size_t image_size) { bool ret = Update.begin(image_size, U_FLASH); if (ret) { @@ -23,9 +19,6 @@ OTAResponseTypes ArduinoESP32OTABackend::begin(size_t image_size) { uint8_t error = Update.getError(); if (error == UPDATE_ERROR_SIZE) return OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE; - - ESP_LOGE(TAG, "Begin error: %d", error); - return OTA_RESPONSE_ERROR_UNKNOWN; } @@ -33,25 +26,16 @@ void ArduinoESP32OTABackend::set_update_md5(const char *md5) { Update.setMD5(md5 OTAResponseTypes ArduinoESP32OTABackend::write(uint8_t *data, size_t len) { size_t written = Update.write(data, len); - if (written == len) { - return OTA_RESPONSE_OK; + if (written != len) { + return OTA_RESPONSE_ERROR_WRITING_FLASH; } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "Write error: %d", error); - - return OTA_RESPONSE_ERROR_WRITING_FLASH; + return OTA_RESPONSE_OK; } OTAResponseTypes ArduinoESP32OTABackend::end() { - if (Update.end()) { - return OTA_RESPONSE_OK; - } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "End error: %d", error); - - return OTA_RESPONSE_ERROR_UPDATE_END; + if (!Update.end()) + return OTA_RESPONSE_ERROR_UPDATE_END; + return OTA_RESPONSE_OK; } void ArduinoESP32OTABackend::abort() { Update.abort(); } diff --git a/esphome/components/ota/ota_backend_arduino_esp32.h b/esphome/components/ota/ota_backend_arduino_esp32.h index ac7fe9f14f..f86a70d678 100644 --- a/esphome/components/ota/ota_backend_arduino_esp32.h +++ b/esphome/components/ota/ota_backend_arduino_esp32.h @@ -1,9 +1,9 @@ #pragma once -#ifdef USE_ESP32_FRAMEWORK_ARDUINO -#include "ota_backend.h" - #include "esphome/core/defines.h" -#include "esphome/core/helpers.h" +#ifdef USE_ESP32_FRAMEWORK_ARDUINO + +#include "ota_component.h" +#include "ota_backend.h" namespace esphome { namespace ota { diff --git a/esphome/components/ota/ota_backend_arduino_esp8266.cpp b/esphome/components/ota/ota_backend_arduino_esp8266.cpp index 42edbf5d2b..23dc0d4e21 100644 --- a/esphome/components/ota/ota_backend_arduino_esp8266.cpp +++ b/esphome/components/ota/ota_backend_arduino_esp8266.cpp @@ -1,21 +1,17 @@ +#include "esphome/core/defines.h" #ifdef USE_ARDUINO #ifdef USE_ESP8266 -#include "ota_backend_arduino_esp8266.h" -#include "ota_backend.h" +#include "ota_backend_arduino_esp8266.h" +#include "ota_component.h" +#include "ota_backend.h" #include "esphome/components/esp8266/preferences.h" -#include "esphome/core/defines.h" -#include "esphome/core/log.h" #include namespace esphome { namespace ota { -static const char *const TAG = "ota.arduino_esp8266"; - -std::unique_ptr make_ota_backend() { return make_unique(); } - OTAResponseTypes ArduinoESP8266OTABackend::begin(size_t image_size) { bool ret = Update.begin(image_size, U_FLASH); if (ret) { @@ -32,9 +28,6 @@ OTAResponseTypes ArduinoESP8266OTABackend::begin(size_t image_size) { return OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG; if (error == UPDATE_ERROR_SPACE) return OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE; - - ESP_LOGE(TAG, "Begin error: %d", error); - return OTA_RESPONSE_ERROR_UNKNOWN; } @@ -42,25 +35,16 @@ void ArduinoESP8266OTABackend::set_update_md5(const char *md5) { Update.setMD5(m OTAResponseTypes ArduinoESP8266OTABackend::write(uint8_t *data, size_t len) { size_t written = Update.write(data, len); - if (written == len) { - return OTA_RESPONSE_OK; + if (written != len) { + return OTA_RESPONSE_ERROR_WRITING_FLASH; } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "Write error: %d", error); - - return OTA_RESPONSE_ERROR_WRITING_FLASH; + return OTA_RESPONSE_OK; } OTAResponseTypes ArduinoESP8266OTABackend::end() { - if (Update.end()) { - return OTA_RESPONSE_OK; - } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "End error: %d", error); - - return OTA_RESPONSE_ERROR_UPDATE_END; + if (!Update.end()) + return OTA_RESPONSE_ERROR_UPDATE_END; + return OTA_RESPONSE_OK; } void ArduinoESP8266OTABackend::abort() { diff --git a/esphome/components/ota/ota_backend_arduino_esp8266.h b/esphome/components/ota/ota_backend_arduino_esp8266.h index 7f44d7c965..7937c665b0 100644 --- a/esphome/components/ota/ota_backend_arduino_esp8266.h +++ b/esphome/components/ota/ota_backend_arduino_esp8266.h @@ -1,9 +1,10 @@ #pragma once +#include "esphome/core/defines.h" #ifdef USE_ARDUINO #ifdef USE_ESP8266 -#include "ota_backend.h" -#include "esphome/core/defines.h" +#include "ota_component.h" +#include "ota_backend.h" #include "esphome/core/macros.h" namespace esphome { diff --git a/esphome/components/ota/ota_backend_arduino_libretiny.cpp b/esphome/components/ota/ota_backend_arduino_libretiny.cpp index 6b2cf80684..dbf6c97988 100644 --- a/esphome/components/ota/ota_backend_arduino_libretiny.cpp +++ b/esphome/components/ota/ota_backend_arduino_libretiny.cpp @@ -1,19 +1,15 @@ -#ifdef USE_LIBRETINY -#include "ota_backend_arduino_libretiny.h" -#include "ota_backend.h" - #include "esphome/core/defines.h" -#include "esphome/core/log.h" +#ifdef USE_LIBRETINY + +#include "ota_backend_arduino_libretiny.h" +#include "ota_component.h" +#include "ota_backend.h" #include namespace esphome { namespace ota { -static const char *const TAG = "ota.arduino_libretiny"; - -std::unique_ptr make_ota_backend() { return make_unique(); } - OTAResponseTypes ArduinoLibreTinyOTABackend::begin(size_t image_size) { bool ret = Update.begin(image_size, U_FLASH); if (ret) { @@ -23,9 +19,6 @@ OTAResponseTypes ArduinoLibreTinyOTABackend::begin(size_t image_size) { uint8_t error = Update.getError(); if (error == UPDATE_ERROR_SIZE) return OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE; - - ESP_LOGE(TAG, "Begin error: %d", error); - return OTA_RESPONSE_ERROR_UNKNOWN; } @@ -33,25 +26,16 @@ void ArduinoLibreTinyOTABackend::set_update_md5(const char *md5) { Update.setMD5 OTAResponseTypes ArduinoLibreTinyOTABackend::write(uint8_t *data, size_t len) { size_t written = Update.write(data, len); - if (written == len) { - return OTA_RESPONSE_OK; + if (written != len) { + return OTA_RESPONSE_ERROR_WRITING_FLASH; } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "Write error: %d", error); - - return OTA_RESPONSE_ERROR_WRITING_FLASH; + return OTA_RESPONSE_OK; } OTAResponseTypes ArduinoLibreTinyOTABackend::end() { - if (Update.end()) { - return OTA_RESPONSE_OK; - } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "End error: %d", error); - - return OTA_RESPONSE_ERROR_UPDATE_END; + if (!Update.end()) + return OTA_RESPONSE_ERROR_UPDATE_END; + return OTA_RESPONSE_OK; } void ArduinoLibreTinyOTABackend::abort() { Update.abort(); } diff --git a/esphome/components/ota/ota_backend_arduino_libretiny.h b/esphome/components/ota/ota_backend_arduino_libretiny.h index 11deb6e2f2..79656bb353 100644 --- a/esphome/components/ota/ota_backend_arduino_libretiny.h +++ b/esphome/components/ota/ota_backend_arduino_libretiny.h @@ -1,8 +1,9 @@ #pragma once -#ifdef USE_LIBRETINY -#include "ota_backend.h" - #include "esphome/core/defines.h" +#ifdef USE_LIBRETINY + +#include "ota_component.h" +#include "ota_backend.h" namespace esphome { namespace ota { diff --git a/esphome/components/ota/ota_backend_arduino_rp2040.cpp b/esphome/components/ota/ota_backend_arduino_rp2040.cpp index ffeab2e93f..260387cec1 100644 --- a/esphome/components/ota/ota_backend_arduino_rp2040.cpp +++ b/esphome/components/ota/ota_backend_arduino_rp2040.cpp @@ -1,21 +1,17 @@ +#include "esphome/core/defines.h" #ifdef USE_ARDUINO #ifdef USE_RP2040 -#include "ota_backend_arduino_rp2040.h" -#include "ota_backend.h" #include "esphome/components/rp2040/preferences.h" -#include "esphome/core/defines.h" -#include "esphome/core/log.h" +#include "ota_backend.h" +#include "ota_backend_arduino_rp2040.h" +#include "ota_component.h" #include namespace esphome { namespace ota { -static const char *const TAG = "ota.arduino_rp2040"; - -std::unique_ptr make_ota_backend() { return make_unique(); } - OTAResponseTypes ArduinoRP2040OTABackend::begin(size_t image_size) { bool ret = Update.begin(image_size, U_FLASH); if (ret) { @@ -32,9 +28,6 @@ OTAResponseTypes ArduinoRP2040OTABackend::begin(size_t image_size) { return OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG; if (error == UPDATE_ERROR_SPACE) return OTA_RESPONSE_ERROR_RP2040_NOT_ENOUGH_SPACE; - - ESP_LOGE(TAG, "Begin error: %d", error); - return OTA_RESPONSE_ERROR_UNKNOWN; } @@ -42,25 +35,16 @@ void ArduinoRP2040OTABackend::set_update_md5(const char *md5) { Update.setMD5(md OTAResponseTypes ArduinoRP2040OTABackend::write(uint8_t *data, size_t len) { size_t written = Update.write(data, len); - if (written == len) { - return OTA_RESPONSE_OK; + if (written != len) { + return OTA_RESPONSE_ERROR_WRITING_FLASH; } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "Write error: %d", error); - - return OTA_RESPONSE_ERROR_WRITING_FLASH; + return OTA_RESPONSE_OK; } OTAResponseTypes ArduinoRP2040OTABackend::end() { - if (Update.end()) { - return OTA_RESPONSE_OK; - } - - uint8_t error = Update.getError(); - ESP_LOGE(TAG, "End error: %d", error); - - return OTA_RESPONSE_ERROR_UPDATE_END; + if (!Update.end()) + return OTA_RESPONSE_ERROR_UPDATE_END; + return OTA_RESPONSE_OK; } void ArduinoRP2040OTABackend::abort() { diff --git a/esphome/components/ota/ota_backend_arduino_rp2040.h b/esphome/components/ota/ota_backend_arduino_rp2040.h index b189964ab3..5aa2ec9435 100644 --- a/esphome/components/ota/ota_backend_arduino_rp2040.h +++ b/esphome/components/ota/ota_backend_arduino_rp2040.h @@ -1,10 +1,11 @@ #pragma once +#include "esphome/core/defines.h" #ifdef USE_ARDUINO #ifdef USE_RP2040 -#include "ota_backend.h" -#include "esphome/core/defines.h" #include "esphome/core/macros.h" +#include "ota_backend.h" +#include "ota_component.h" namespace esphome { namespace ota { diff --git a/esphome/components/ota/ota_backend_esp_idf.cpp b/esphome/components/ota/ota_backend_esp_idf.cpp index 6f45fb75e4..319a1482f1 100644 --- a/esphome/components/ota/ota_backend_esp_idf.cpp +++ b/esphome/components/ota/ota_backend_esp_idf.cpp @@ -1,12 +1,13 @@ -#ifdef USE_ESP_IDF -#include "ota_backend_esp_idf.h" - -#include "esphome/components/md5/md5.h" #include "esphome/core/defines.h" +#ifdef USE_ESP_IDF -#include #include +#include "ota_backend_esp_idf.h" +#include "ota_component.h" +#include +#include "esphome/components/md5/md5.h" + #if ESP_IDF_VERSION_MAJOR >= 5 #include #endif @@ -14,8 +15,6 @@ namespace esphome { namespace ota { -std::unique_ptr make_ota_backend() { return make_unique(); } - OTAResponseTypes IDFOTABackend::begin(size_t image_size) { this->partition_ = esp_ota_get_next_update_partition(nullptr); if (this->partition_ == nullptr) { diff --git a/esphome/components/ota/ota_backend_esp_idf.h b/esphome/components/ota/ota_backend_esp_idf.h index ed66d9b970..af09d0d693 100644 --- a/esphome/components/ota/ota_backend_esp_idf.h +++ b/esphome/components/ota/ota_backend_esp_idf.h @@ -1,11 +1,11 @@ #pragma once -#ifdef USE_ESP_IDF -#include "ota_backend.h" - -#include "esphome/components/md5/md5.h" #include "esphome/core/defines.h" +#ifdef USE_ESP_IDF +#include "ota_component.h" +#include "ota_backend.h" #include +#include "esphome/components/md5/md5.h" namespace esphome { namespace ota { diff --git a/esphome/components/ota/ota_component.cpp b/esphome/components/ota/ota_component.cpp new file mode 100644 index 0000000000..15af14ff1a --- /dev/null +++ b/esphome/components/ota/ota_component.cpp @@ -0,0 +1,535 @@ +#include "ota_component.h" +#include "ota_backend.h" +#include "ota_backend_arduino_esp32.h" +#include "ota_backend_arduino_esp8266.h" +#include "ota_backend_arduino_rp2040.h" +#include "ota_backend_arduino_libretiny.h" +#include "ota_backend_esp_idf.h" + +#include "esphome/core/log.h" +#include "esphome/core/application.h" +#include "esphome/core/hal.h" +#include "esphome/core/util.h" +#include "esphome/components/md5/md5.h" +#include "esphome/components/network/util.h" + +#include +#include + +namespace esphome { +namespace ota { + +static const char *const TAG = "ota"; +static constexpr u_int16_t OTA_BLOCK_SIZE = 8192; + +OTAComponent *global_ota_component = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables) + +std::unique_ptr make_ota_backend() { +#ifdef USE_ARDUINO +#ifdef USE_ESP8266 + return make_unique(); +#endif // USE_ESP8266 +#ifdef USE_ESP32 + return make_unique(); +#endif // USE_ESP32 +#endif // USE_ARDUINO +#ifdef USE_ESP_IDF + return make_unique(); +#endif // USE_ESP_IDF +#ifdef USE_RP2040 + return make_unique(); +#endif // USE_RP2040 +#ifdef USE_LIBRETINY + return make_unique(); +#endif +} + +OTAComponent::OTAComponent() { global_ota_component = this; } + +void OTAComponent::setup() { + server_ = socket::socket_ip(SOCK_STREAM, 0); + if (server_ == nullptr) { + ESP_LOGW(TAG, "Could not create socket."); + this->mark_failed(); + return; + } + int enable = 1; + int err = server_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable, sizeof(int)); + if (err != 0) { + ESP_LOGW(TAG, "Socket unable to set reuseaddr: errno %d", err); + // we can still continue + } + err = server_->setblocking(false); + if (err != 0) { + ESP_LOGW(TAG, "Socket unable to set nonblocking mode: errno %d", err); + this->mark_failed(); + return; + } + + struct sockaddr_storage server; + + socklen_t sl = socket::set_sockaddr_any((struct sockaddr *) &server, sizeof(server), this->port_); + if (sl == 0) { + ESP_LOGW(TAG, "Socket unable to set sockaddr: errno %d", errno); + this->mark_failed(); + return; + } + + err = server_->bind((struct sockaddr *) &server, sizeof(server)); + if (err != 0) { + ESP_LOGW(TAG, "Socket unable to bind: errno %d", errno); + this->mark_failed(); + return; + } + + err = server_->listen(4); + if (err != 0) { + ESP_LOGW(TAG, "Socket unable to listen: errno %d", errno); + this->mark_failed(); + return; + } + + this->dump_config(); +} + +void OTAComponent::dump_config() { + ESP_LOGCONFIG(TAG, "Over-The-Air Updates:"); + ESP_LOGCONFIG(TAG, " Address: %s:%u", network::get_use_address().c_str(), this->port_); +#ifdef USE_OTA_PASSWORD + if (!this->password_.empty()) { + ESP_LOGCONFIG(TAG, " Using Password."); + } +#endif + ESP_LOGCONFIG(TAG, " OTA version: %d.", USE_OTA_VERSION); + if (this->has_safe_mode_ && this->safe_mode_rtc_value_ > 1 && + this->safe_mode_rtc_value_ != esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) { + ESP_LOGW(TAG, "Last Boot was an unhandled reset, will proceed to safe mode in %" PRIu32 " restarts", + this->safe_mode_num_attempts_ - this->safe_mode_rtc_value_); + } +} + +void OTAComponent::loop() { + this->handle_(); + + if (this->has_safe_mode_ && (millis() - this->safe_mode_start_time_) > this->safe_mode_enable_time_) { + this->has_safe_mode_ = false; + // successful boot, reset counter + ESP_LOGI(TAG, "Boot seems successful, resetting boot loop counter."); + this->clean_rtc(); + } +} + +static const uint8_t FEATURE_SUPPORTS_COMPRESSION = 0x01; + +void OTAComponent::handle_() { + OTAResponseTypes error_code = OTA_RESPONSE_ERROR_UNKNOWN; + bool update_started = false; + size_t total = 0; + uint32_t last_progress = 0; + uint8_t buf[1024]; + char *sbuf = reinterpret_cast(buf); + size_t ota_size; + uint8_t ota_features; + std::unique_ptr backend; + (void) ota_features; +#if USE_OTA_VERSION == 2 + size_t size_acknowledged = 0; +#endif + + if (client_ == nullptr) { + struct sockaddr_storage source_addr; + socklen_t addr_len = sizeof(source_addr); + client_ = server_->accept((struct sockaddr *) &source_addr, &addr_len); + } + if (client_ == nullptr) + return; + + int enable = 1; + int err = client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable, sizeof(int)); + if (err != 0) { + ESP_LOGW(TAG, "Socket could not enable tcp nodelay, errno: %d", errno); + return; + } + + ESP_LOGD(TAG, "Starting OTA Update from %s...", this->client_->getpeername().c_str()); + this->status_set_warning(); +#ifdef USE_OTA_STATE_CALLBACK + this->state_callback_.call(OTA_STARTED, 0.0f, 0); +#endif + + if (!this->readall_(buf, 5)) { + ESP_LOGW(TAG, "Reading magic bytes failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + // 0x6C, 0x26, 0xF7, 0x5C, 0x45 + if (buf[0] != 0x6C || buf[1] != 0x26 || buf[2] != 0xF7 || buf[3] != 0x5C || buf[4] != 0x45) { + ESP_LOGW(TAG, "Magic bytes do not match! 0x%02X-0x%02X-0x%02X-0x%02X-0x%02X", buf[0], buf[1], buf[2], buf[3], + buf[4]); + error_code = OTA_RESPONSE_ERROR_MAGIC; + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + + // Send OK and version - 2 bytes + buf[0] = OTA_RESPONSE_OK; + buf[1] = USE_OTA_VERSION; + this->writeall_(buf, 2); + + backend = make_ota_backend(); + + // Read features - 1 byte + if (!this->readall_(buf, 1)) { + ESP_LOGW(TAG, "Reading features failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + ota_features = buf[0]; // NOLINT + ESP_LOGV(TAG, "OTA features is 0x%02X", ota_features); + + // Acknowledge header - 1 byte + buf[0] = OTA_RESPONSE_HEADER_OK; + if ((ota_features & FEATURE_SUPPORTS_COMPRESSION) != 0 && backend->supports_compression()) { + buf[0] = OTA_RESPONSE_SUPPORTS_COMPRESSION; + } + + this->writeall_(buf, 1); + +#ifdef USE_OTA_PASSWORD + if (!this->password_.empty()) { + buf[0] = OTA_RESPONSE_REQUEST_AUTH; + this->writeall_(buf, 1); + md5::MD5Digest md5{}; + md5.init(); + sprintf(sbuf, "%08" PRIx32, random_uint32()); + md5.add(sbuf, 8); + md5.calculate(); + md5.get_hex(sbuf); + ESP_LOGV(TAG, "Auth: Nonce is %s", sbuf); + + // Send nonce, 32 bytes hex MD5 + if (!this->writeall_(reinterpret_cast(sbuf), 32)) { + ESP_LOGW(TAG, "Auth: Writing nonce failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + + // prepare challenge + md5.init(); + md5.add(this->password_.c_str(), this->password_.length()); + // add nonce + md5.add(sbuf, 32); + + // Receive cnonce, 32 bytes hex MD5 + if (!this->readall_(buf, 32)) { + ESP_LOGW(TAG, "Auth: Reading cnonce failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + sbuf[32] = '\0'; + ESP_LOGV(TAG, "Auth: CNonce is %s", sbuf); + // add cnonce + md5.add(sbuf, 32); + + // calculate result + md5.calculate(); + md5.get_hex(sbuf); + ESP_LOGV(TAG, "Auth: Result is %s", sbuf); + + // Receive result, 32 bytes hex MD5 + if (!this->readall_(buf + 64, 32)) { + ESP_LOGW(TAG, "Auth: Reading response failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + sbuf[64 + 32] = '\0'; + ESP_LOGV(TAG, "Auth: Response is %s", sbuf + 64); + + bool matches = true; + for (uint8_t i = 0; i < 32; i++) + matches = matches && buf[i] == buf[64 + i]; + + if (!matches) { + ESP_LOGW(TAG, "Auth failed! Passwords do not match!"); + error_code = OTA_RESPONSE_ERROR_AUTH_INVALID; + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + } +#endif // USE_OTA_PASSWORD + + // Acknowledge auth OK - 1 byte + buf[0] = OTA_RESPONSE_AUTH_OK; + this->writeall_(buf, 1); + + // Read size, 4 bytes MSB first + if (!this->readall_(buf, 4)) { + ESP_LOGW(TAG, "Reading size failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + ota_size = 0; + for (uint8_t i = 0; i < 4; i++) { + ota_size <<= 8; + ota_size |= buf[i]; + } + ESP_LOGV(TAG, "OTA size is %u bytes", ota_size); + + error_code = backend->begin(ota_size); + if (error_code != OTA_RESPONSE_OK) + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + update_started = true; + + // Acknowledge prepare OK - 1 byte + buf[0] = OTA_RESPONSE_UPDATE_PREPARE_OK; + this->writeall_(buf, 1); + + // Read binary MD5, 32 bytes + if (!this->readall_(buf, 32)) { + ESP_LOGW(TAG, "Reading binary MD5 checksum failed!"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + sbuf[32] = '\0'; + ESP_LOGV(TAG, "Update: Binary MD5 is %s", sbuf); + backend->set_update_md5(sbuf); + + // Acknowledge MD5 OK - 1 byte + buf[0] = OTA_RESPONSE_BIN_MD5_OK; + this->writeall_(buf, 1); + + while (total < ota_size) { + // TODO: timeout check + size_t requested = std::min(sizeof(buf), ota_size - total); + ssize_t read = this->client_->read(buf, requested); + if (read == -1) { + if (errno == EAGAIN || errno == EWOULDBLOCK) { + App.feed_wdt(); + delay(1); + continue; + } + ESP_LOGW(TAG, "Error receiving data for update, errno: %d", errno); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } else if (read == 0) { + // $ man recv + // "When a stream socket peer has performed an orderly shutdown, the return value will + // be 0 (the traditional "end-of-file" return)." + ESP_LOGW(TAG, "Remote end closed connection"); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + + error_code = backend->write(buf, read); + if (error_code != OTA_RESPONSE_OK) { + ESP_LOGW(TAG, "Error writing binary data to flash!, error_code: %d", error_code); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + total += read; +#if USE_OTA_VERSION == 2 + while (size_acknowledged + OTA_BLOCK_SIZE <= total || (total == ota_size && size_acknowledged < ota_size)) { + buf[0] = OTA_RESPONSE_CHUNK_OK; + this->writeall_(buf, 1); + size_acknowledged += OTA_BLOCK_SIZE; + } +#endif + + uint32_t now = millis(); + if (now - last_progress > 1000) { + last_progress = now; + float percentage = (total * 100.0f) / ota_size; + ESP_LOGD(TAG, "OTA in progress: %0.1f%%", percentage); +#ifdef USE_OTA_STATE_CALLBACK + this->state_callback_.call(OTA_IN_PROGRESS, percentage, 0); +#endif + // feed watchdog and give other tasks a chance to run + App.feed_wdt(); + yield(); + } + } + + // Acknowledge receive OK - 1 byte + buf[0] = OTA_RESPONSE_RECEIVE_OK; + this->writeall_(buf, 1); + + error_code = backend->end(); + if (error_code != OTA_RESPONSE_OK) { + ESP_LOGW(TAG, "Error ending OTA!, error_code: %d", error_code); + goto error; // NOLINT(cppcoreguidelines-avoid-goto) + } + + // Acknowledge Update end OK - 1 byte + buf[0] = OTA_RESPONSE_UPDATE_END_OK; + this->writeall_(buf, 1); + + // Read ACK + if (!this->readall_(buf, 1) || buf[0] != OTA_RESPONSE_OK) { + ESP_LOGW(TAG, "Reading back acknowledgement failed!"); + // do not go to error, this is not fatal + } + + this->client_->close(); + this->client_ = nullptr; + delay(10); + ESP_LOGI(TAG, "OTA update finished!"); + this->status_clear_warning(); +#ifdef USE_OTA_STATE_CALLBACK + this->state_callback_.call(OTA_COMPLETED, 100.0f, 0); +#endif + delay(100); // NOLINT + App.safe_reboot(); + +error: + buf[0] = static_cast(error_code); + this->writeall_(buf, 1); + this->client_->close(); + this->client_ = nullptr; + + if (backend != nullptr && update_started) { + backend->abort(); + } + + this->status_momentary_error("onerror", 5000); +#ifdef USE_OTA_STATE_CALLBACK + this->state_callback_.call(OTA_ERROR, 0.0f, static_cast(error_code)); +#endif +} + +bool OTAComponent::readall_(uint8_t *buf, size_t len) { + uint32_t start = millis(); + uint32_t at = 0; + while (len - at > 0) { + uint32_t now = millis(); + if (now - start > 1000) { + ESP_LOGW(TAG, "Timed out reading %d bytes of data", len); + return false; + } + + ssize_t read = this->client_->read(buf + at, len - at); + if (read == -1) { + if (errno == EAGAIN || errno == EWOULDBLOCK) { + App.feed_wdt(); + delay(1); + continue; + } + ESP_LOGW(TAG, "Failed to read %d bytes of data, errno: %d", len, errno); + return false; + } else if (read == 0) { + ESP_LOGW(TAG, "Remote closed connection"); + return false; + } else { + at += read; + } + App.feed_wdt(); + delay(1); + } + + return true; +} +bool OTAComponent::writeall_(const uint8_t *buf, size_t len) { + uint32_t start = millis(); + uint32_t at = 0; + while (len - at > 0) { + uint32_t now = millis(); + if (now - start > 1000) { + ESP_LOGW(TAG, "Timed out writing %d bytes of data", len); + return false; + } + + ssize_t written = this->client_->write(buf + at, len - at); + if (written == -1) { + if (errno == EAGAIN || errno == EWOULDBLOCK) { + App.feed_wdt(); + delay(1); + continue; + } + ESP_LOGW(TAG, "Failed to write %d bytes of data, errno: %d", len, errno); + return false; + } else { + at += written; + } + App.feed_wdt(); + delay(1); + } + return true; +} + +float OTAComponent::get_setup_priority() const { return setup_priority::AFTER_WIFI; } +uint16_t OTAComponent::get_port() const { return this->port_; } +void OTAComponent::set_port(uint16_t port) { this->port_ = port; } + +void OTAComponent::set_safe_mode_pending(const bool &pending) { + if (!this->has_safe_mode_) + return; + + uint32_t current_rtc = this->read_rtc_(); + + if (pending && current_rtc != esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) { + ESP_LOGI(TAG, "Device will enter safe mode on next boot."); + this->write_rtc_(esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC); + } + + if (!pending && current_rtc == esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) { + ESP_LOGI(TAG, "Safe mode pending has been cleared"); + this->clean_rtc(); + } +} +bool OTAComponent::get_safe_mode_pending() { + return this->has_safe_mode_ && this->read_rtc_() == esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC; +} + +bool OTAComponent::should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_time) { + this->has_safe_mode_ = true; + this->safe_mode_start_time_ = millis(); + this->safe_mode_enable_time_ = enable_time; + this->safe_mode_num_attempts_ = num_attempts; + this->rtc_ = global_preferences->make_preference(233825507UL, false); + this->safe_mode_rtc_value_ = this->read_rtc_(); + + bool is_manual_safe_mode = this->safe_mode_rtc_value_ == esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC; + + if (is_manual_safe_mode) { + ESP_LOGI(TAG, "Safe mode has been entered manually"); + } else { + ESP_LOGCONFIG(TAG, "There have been %" PRIu32 " suspected unsuccessful boot attempts.", this->safe_mode_rtc_value_); + } + + if (this->safe_mode_rtc_value_ >= num_attempts || is_manual_safe_mode) { + this->clean_rtc(); + + if (!is_manual_safe_mode) { + ESP_LOGE(TAG, "Boot loop detected. Proceeding to safe mode."); + } + + this->status_set_error(); + this->set_timeout(enable_time, []() { + ESP_LOGE(TAG, "No OTA attempt made, restarting."); + App.reboot(); + }); + + // Delay here to allow power to stabilise before Wi-Fi/Ethernet is initialised. + delay(300); // NOLINT + App.setup(); + + ESP_LOGI(TAG, "Waiting for OTA attempt."); + + return true; + } else { + // increment counter + this->write_rtc_(this->safe_mode_rtc_value_ + 1); + return false; + } +} +void OTAComponent::write_rtc_(uint32_t val) { + this->rtc_.save(&val); + global_preferences->sync(); +} +uint32_t OTAComponent::read_rtc_() { + uint32_t val; + if (!this->rtc_.load(&val)) + return 0; + return val; +} +void OTAComponent::clean_rtc() { this->write_rtc_(0); } +void OTAComponent::on_safe_shutdown() { + if (this->has_safe_mode_ && this->read_rtc_() != esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) + this->clean_rtc(); +} + +#ifdef USE_OTA_STATE_CALLBACK +void OTAComponent::add_on_state_callback(std::function &&callback) { + this->state_callback_.add(std::move(callback)); +} +#endif + +} // namespace ota +} // namespace esphome diff --git a/esphome/components/ota/ota_component.h b/esphome/components/ota/ota_component.h new file mode 100644 index 0000000000..c20f4f0709 --- /dev/null +++ b/esphome/components/ota/ota_component.h @@ -0,0 +1,112 @@ +#pragma once + +#include "esphome/components/socket/socket.h" +#include "esphome/core/component.h" +#include "esphome/core/preferences.h" +#include "esphome/core/helpers.h" +#include "esphome/core/defines.h" + +namespace esphome { +namespace ota { + +enum OTAResponseTypes { + OTA_RESPONSE_OK = 0x00, + OTA_RESPONSE_REQUEST_AUTH = 0x01, + + OTA_RESPONSE_HEADER_OK = 0x40, + OTA_RESPONSE_AUTH_OK = 0x41, + OTA_RESPONSE_UPDATE_PREPARE_OK = 0x42, + OTA_RESPONSE_BIN_MD5_OK = 0x43, + OTA_RESPONSE_RECEIVE_OK = 0x44, + OTA_RESPONSE_UPDATE_END_OK = 0x45, + OTA_RESPONSE_SUPPORTS_COMPRESSION = 0x46, + OTA_RESPONSE_CHUNK_OK = 0x47, + + OTA_RESPONSE_ERROR_MAGIC = 0x80, + OTA_RESPONSE_ERROR_UPDATE_PREPARE = 0x81, + OTA_RESPONSE_ERROR_AUTH_INVALID = 0x82, + OTA_RESPONSE_ERROR_WRITING_FLASH = 0x83, + OTA_RESPONSE_ERROR_UPDATE_END = 0x84, + OTA_RESPONSE_ERROR_INVALID_BOOTSTRAPPING = 0x85, + OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG = 0x86, + OTA_RESPONSE_ERROR_WRONG_NEW_FLASH_CONFIG = 0x87, + OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE = 0x88, + OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE = 0x89, + OTA_RESPONSE_ERROR_NO_UPDATE_PARTITION = 0x8A, + OTA_RESPONSE_ERROR_MD5_MISMATCH = 0x8B, + OTA_RESPONSE_ERROR_RP2040_NOT_ENOUGH_SPACE = 0x8C, + OTA_RESPONSE_ERROR_UNKNOWN = 0xFF, +}; + +enum OTAState { OTA_COMPLETED = 0, OTA_STARTED, OTA_IN_PROGRESS, OTA_ERROR }; + +/// OTAComponent provides a simple way to integrate Over-the-Air updates into your app using ArduinoOTA. +class OTAComponent : public Component { + public: + OTAComponent(); +#ifdef USE_OTA_PASSWORD + void set_auth_password(const std::string &password) { password_ = password; } +#endif // USE_OTA_PASSWORD + + /// Manually set the port OTA should listen on. + void set_port(uint16_t port); + + bool should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_time); + + /// Set to true if the next startup will enter safe mode + void set_safe_mode_pending(const bool &pending); + bool get_safe_mode_pending(); + +#ifdef USE_OTA_STATE_CALLBACK + void add_on_state_callback(std::function &&callback); +#endif + + // ========== INTERNAL METHODS ========== + // (In most use cases you won't need these) + void setup() override; + void dump_config() override; + float get_setup_priority() const override; + void loop() override; + + uint16_t get_port() const; + + void clean_rtc(); + + void on_safe_shutdown() override; + + protected: + void write_rtc_(uint32_t val); + uint32_t read_rtc_(); + + void handle_(); + bool readall_(uint8_t *buf, size_t len); + bool writeall_(const uint8_t *buf, size_t len); + +#ifdef USE_OTA_PASSWORD + std::string password_; +#endif // USE_OTA_PASSWORD + + uint16_t port_; + + std::unique_ptr server_; + std::unique_ptr client_; + + bool has_safe_mode_{false}; ///< stores whether safe mode can be enabled. + uint32_t safe_mode_start_time_; ///< stores when safe mode was enabled. + uint32_t safe_mode_enable_time_{60000}; ///< The time safe mode should be on for. + uint32_t safe_mode_rtc_value_; + uint8_t safe_mode_num_attempts_; + ESPPreferenceObject rtc_; + + static const uint32_t ENTER_SAFE_MODE_MAGIC = + 0x5afe5afe; ///< a magic number to indicate that safe mode should be entered on next boot + +#ifdef USE_OTA_STATE_CALLBACK + CallbackManager state_callback_{}; +#endif +}; + +extern OTAComponent *global_ota_component; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables) + +} // namespace ota +} // namespace esphome