Separate OTABackend from OTA component (#6459)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Keith Burzinski 2024-05-15 21:01:09 -05:00 committed by GitHub
parent f91c31f093
commit f46c499c4e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
40 changed files with 505 additions and 391 deletions

View file

@ -18,22 +18,23 @@ from esphome.const import (
CONF_BAUD_RATE, CONF_BAUD_RATE,
CONF_BROKER, CONF_BROKER,
CONF_DEASSERT_RTS_DTR, CONF_DEASSERT_RTS_DTR,
CONF_DISABLED,
CONF_ESPHOME,
CONF_LOGGER, CONF_LOGGER,
CONF_MDNS,
CONF_MQTT,
CONF_NAME, CONF_NAME,
CONF_OTA, CONF_OTA,
CONF_MQTT,
CONF_MDNS,
CONF_DISABLED,
CONF_PASSWORD, CONF_PASSWORD,
CONF_PORT, CONF_PLATFORM,
CONF_ESPHOME,
CONF_PLATFORMIO_OPTIONS, CONF_PLATFORMIO_OPTIONS,
CONF_PORT,
CONF_SUBSTITUTIONS, CONF_SUBSTITUTIONS,
PLATFORM_BK72XX, PLATFORM_BK72XX,
PLATFORM_RTL87XX,
PLATFORM_ESP32, PLATFORM_ESP32,
PLATFORM_ESP8266, PLATFORM_ESP8266,
PLATFORM_RP2040, PLATFORM_RP2040,
PLATFORM_RTL87XX,
SECRETS_FILES, SECRETS_FILES,
) )
from esphome.core import CORE, EsphomeError, coroutine from esphome.core import CORE, EsphomeError, coroutine
@ -330,15 +331,19 @@ def upload_program(config, args, host):
return 1 # Unknown target platform return 1 # Unknown target platform
if CONF_OTA not in config: ota_conf = {}
for ota_item in config.get(CONF_OTA, []):
if ota_item[CONF_PLATFORM] == CONF_ESPHOME:
ota_conf = ota_item
break
if not ota_conf:
raise EsphomeError( raise EsphomeError(
"Cannot upload Over the Air as the config does not include the ota: " f"Cannot upload Over the Air as the {CONF_OTA} configuration is not present or does not include {CONF_PLATFORM}: {CONF_ESPHOME}"
"component"
) )
from esphome import espota2 from esphome import espota2
ota_conf = config[CONF_OTA]
remote_port = ota_conf[CONF_PORT] remote_port = ota_conf[CONF_PORT]
password = ota_conf.get(CONF_PASSWORD, "") password = ota_conf.get(CONF_PASSWORD, "")

View file

@ -18,7 +18,7 @@
#include <cinttypes> #include <cinttypes>
#ifdef USE_OTA #ifdef USE_OTA
#include "esphome/components/ota/ota_component.h" #include "esphome/components/ota/ota_backend.h"
#endif #endif
#ifdef USE_ARDUINO #ifdef USE_ARDUINO
@ -61,7 +61,8 @@ void ESP32BLETracker::setup() {
this->scanner_idle_ = true; this->scanner_idle_ = true;
#ifdef USE_OTA #ifdef USE_OTA
ota::global_ota_component->add_on_state_callback([this](ota::OTAState state, float progress, uint8_t error) { ota::get_global_ota_callback()->add_on_state_callback(
[this](ota::OTAState state, float progress, uint8_t error, ota::OTAComponent *comp) {
if (state == ota::OTA_STARTED) { if (state == ota::OTA_STARTED) {
this->stop_scan(); this->stop_scan();
} }

View file

@ -0,0 +1,72 @@
from esphome.cpp_generator import RawExpression
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.components.ota import BASE_OTA_SCHEMA, ota_to_code, OTAComponent
from esphome.const import (
CONF_ID,
CONF_NUM_ATTEMPTS,
CONF_OTA,
CONF_PASSWORD,
CONF_PORT,
CONF_REBOOT_TIMEOUT,
CONF_SAFE_MODE,
CONF_VERSION,
KEY_PAST_SAFE_MODE,
)
from esphome.core import CORE, coroutine_with_priority
CODEOWNERS = ["@esphome/core"]
AUTO_LOAD = ["md5", "socket"]
DEPENDENCIES = ["network"]
esphome = cg.esphome_ns.namespace("esphome")
ESPHomeOTAComponent = esphome.class_("ESPHomeOTAComponent", OTAComponent)
CONFIG_SCHEMA = (
cv.Schema(
{
cv.GenerateID(): cv.declare_id(ESPHomeOTAComponent),
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,
}
)
.extend(BASE_OTA_SCHEMA)
.extend(cv.COMPONENT_SCHEMA)
)
@coroutine_with_priority(50.0)
async def to_code(config):
CORE.data[CONF_OTA] = {}
var = cg.new_Pvariable(config[CONF_ID])
await ota_to_code(var, config)
cg.add(var.set_port(config[CONF_PORT]))
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

View file

@ -1,55 +1,34 @@
#include "ota_component.h" #include "ota_esphome.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/md5/md5.h"
#include "esphome/components/network/util.h" #include "esphome/components/network/util.h"
#include "esphome/components/ota/ota_backend.h"
#include "esphome/components/ota/ota_backend_arduino_esp32.h"
#include "esphome/components/ota/ota_backend_arduino_esp8266.h"
#include "esphome/components/ota/ota_backend_arduino_libretiny.h"
#include "esphome/components/ota/ota_backend_arduino_rp2040.h"
#include "esphome/components/ota/ota_backend_esp_idf.h"
#include "esphome/core/application.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
#include "esphome/core/util.h"
#include <cerrno> #include <cerrno>
#include <cstdio> #include <cstdio>
namespace esphome { namespace esphome {
namespace ota {
static const char *const TAG = "ota"; static const char *const TAG = "esphome.ota";
static constexpr u_int16_t OTA_BLOCK_SIZE = 8192; static constexpr u_int16_t OTA_BLOCK_SIZE = 8192;
OTAComponent *global_ota_component = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables) void ESPHomeOTAComponent::setup() {
#ifdef USE_OTA_STATE_CALLBACK
std::unique_ptr<OTABackend> make_ota_backend() { ota::register_ota_platform(this);
#ifdef USE_ARDUINO
#ifdef USE_ESP8266
return make_unique<ArduinoESP8266OTABackend>();
#endif // USE_ESP8266
#ifdef USE_ESP32
return make_unique<ArduinoESP32OTABackend>();
#endif // USE_ESP32
#endif // USE_ARDUINO
#ifdef USE_ESP_IDF
return make_unique<IDFOTABackend>();
#endif // USE_ESP_IDF
#ifdef USE_RP2040
return make_unique<ArduinoRP2040OTABackend>();
#endif // USE_RP2040
#ifdef USE_LIBRETINY
return make_unique<ArduinoLibreTinyOTABackend>();
#endif #endif
}
OTAComponent::OTAComponent() { global_ota_component = this; }
void OTAComponent::setup() {
server_ = socket::socket_ip(SOCK_STREAM, 0); server_ = socket::socket_ip(SOCK_STREAM, 0);
if (server_ == nullptr) { if (server_ == nullptr) {
ESP_LOGW(TAG, "Could not create socket."); ESP_LOGW(TAG, "Could not create socket");
this->mark_failed(); this->mark_failed();
return; return;
} }
@ -88,41 +67,39 @@ void OTAComponent::setup() {
this->mark_failed(); this->mark_failed();
return; return;
} }
this->dump_config();
} }
void OTAComponent::dump_config() { void ESPHomeOTAComponent::dump_config() {
ESP_LOGCONFIG(TAG, "Over-The-Air Updates:"); ESP_LOGCONFIG(TAG, "Over-The-Air updates:");
ESP_LOGCONFIG(TAG, " Address: %s:%u", network::get_use_address().c_str(), this->port_); ESP_LOGCONFIG(TAG, " Address: %s:%u", network::get_use_address().c_str(), this->port_);
ESP_LOGCONFIG(TAG, " Version: %d", USE_OTA_VERSION);
#ifdef USE_OTA_PASSWORD #ifdef USE_OTA_PASSWORD
if (!this->password_.empty()) { if (!this->password_.empty()) {
ESP_LOGCONFIG(TAG, " Using Password."); ESP_LOGCONFIG(TAG, " Password configured");
} }
#endif #endif
ESP_LOGCONFIG(TAG, " OTA version: %d.", USE_OTA_VERSION);
if (this->has_safe_mode_ && this->safe_mode_rtc_value_ > 1 && if (this->has_safe_mode_ && this->safe_mode_rtc_value_ > 1 &&
this->safe_mode_rtc_value_ != esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) { this->safe_mode_rtc_value_ != ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC) {
ESP_LOGW(TAG, "Last Boot was an unhandled reset, will proceed to safe mode in %" PRIu32 " restarts", ESP_LOGW(TAG, "Last reset occurred too quickly; safe mode will be invoked in %" PRIu32 " restarts",
this->safe_mode_num_attempts_ - this->safe_mode_rtc_value_); this->safe_mode_num_attempts_ - this->safe_mode_rtc_value_);
} }
} }
void OTAComponent::loop() { void ESPHomeOTAComponent::loop() {
this->handle_(); this->handle_();
if (this->has_safe_mode_ && (millis() - this->safe_mode_start_time_) > this->safe_mode_enable_time_) { if (this->has_safe_mode_ && (millis() - this->safe_mode_start_time_) > this->safe_mode_enable_time_) {
this->has_safe_mode_ = false; this->has_safe_mode_ = false;
// successful boot, reset counter // successful boot, reset counter
ESP_LOGI(TAG, "Boot seems successful, resetting boot loop counter."); ESP_LOGI(TAG, "Boot seems successful; resetting boot loop counter");
this->clean_rtc(); this->clean_rtc();
} }
} }
static const uint8_t FEATURE_SUPPORTS_COMPRESSION = 0x01; static const uint8_t FEATURE_SUPPORTS_COMPRESSION = 0x01;
void OTAComponent::handle_() { void ESPHomeOTAComponent::handle_() {
OTAResponseTypes error_code = OTA_RESPONSE_ERROR_UNKNOWN; ota::OTAResponseTypes error_code = ota::OTA_RESPONSE_ERROR_UNKNOWN;
bool update_started = false; bool update_started = false;
size_t total = 0; size_t total = 0;
uint32_t last_progress = 0; uint32_t last_progress = 0;
@ -130,7 +107,7 @@ void OTAComponent::handle_() {
char *sbuf = reinterpret_cast<char *>(buf); char *sbuf = reinterpret_cast<char *>(buf);
size_t ota_size; size_t ota_size;
uint8_t ota_features; uint8_t ota_features;
std::unique_ptr<OTABackend> backend; std::unique_ptr<ota::OTABackend> backend;
(void) ota_features; (void) ota_features;
#if USE_OTA_VERSION == 2 #if USE_OTA_VERSION == 2
size_t size_acknowledged = 0; size_t size_acknowledged = 0;
@ -147,54 +124,54 @@ void OTAComponent::handle_() {
int enable = 1; int enable = 1;
int err = client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable, sizeof(int)); int err = client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable, sizeof(int));
if (err != 0) { if (err != 0) {
ESP_LOGW(TAG, "Socket could not enable tcp nodelay, errno: %d", errno); ESP_LOGW(TAG, "Socket could not enable TCP nodelay, errno %d", errno);
return; return;
} }
ESP_LOGD(TAG, "Starting OTA Update from %s...", this->client_->getpeername().c_str()); ESP_LOGD(TAG, "Starting update from %s...", this->client_->getpeername().c_str());
this->status_set_warning(); this->status_set_warning();
#ifdef USE_OTA_STATE_CALLBACK #ifdef USE_OTA_STATE_CALLBACK
this->state_callback_.call(OTA_STARTED, 0.0f, 0); this->state_callback_.call(ota::OTA_STARTED, 0.0f, 0);
#endif #endif
if (!this->readall_(buf, 5)) { if (!this->readall_(buf, 5)) {
ESP_LOGW(TAG, "Reading magic bytes failed!"); ESP_LOGW(TAG, "Reading magic bytes failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
// 0x6C, 0x26, 0xF7, 0x5C, 0x45 // 0x6C, 0x26, 0xF7, 0x5C, 0x45
if (buf[0] != 0x6C || buf[1] != 0x26 || buf[2] != 0xF7 || buf[3] != 0x5C || buf[4] != 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], 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]); buf[4]);
error_code = OTA_RESPONSE_ERROR_MAGIC; error_code = ota::OTA_RESPONSE_ERROR_MAGIC;
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
// Send OK and version - 2 bytes // Send OK and version - 2 bytes
buf[0] = OTA_RESPONSE_OK; buf[0] = ota::OTA_RESPONSE_OK;
buf[1] = USE_OTA_VERSION; buf[1] = USE_OTA_VERSION;
this->writeall_(buf, 2); this->writeall_(buf, 2);
backend = make_ota_backend(); backend = ota::make_ota_backend();
// Read features - 1 byte // Read features - 1 byte
if (!this->readall_(buf, 1)) { if (!this->readall_(buf, 1)) {
ESP_LOGW(TAG, "Reading features failed!"); ESP_LOGW(TAG, "Reading features failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
ota_features = buf[0]; // NOLINT ota_features = buf[0]; // NOLINT
ESP_LOGV(TAG, "OTA features is 0x%02X", ota_features); ESP_LOGV(TAG, "Features: 0x%02X", ota_features);
// Acknowledge header - 1 byte // Acknowledge header - 1 byte
buf[0] = OTA_RESPONSE_HEADER_OK; buf[0] = ota::OTA_RESPONSE_HEADER_OK;
if ((ota_features & FEATURE_SUPPORTS_COMPRESSION) != 0 && backend->supports_compression()) { if ((ota_features & FEATURE_SUPPORTS_COMPRESSION) != 0 && backend->supports_compression()) {
buf[0] = OTA_RESPONSE_SUPPORTS_COMPRESSION; buf[0] = ota::OTA_RESPONSE_SUPPORTS_COMPRESSION;
} }
this->writeall_(buf, 1); this->writeall_(buf, 1);
#ifdef USE_OTA_PASSWORD #ifdef USE_OTA_PASSWORD
if (!this->password_.empty()) { if (!this->password_.empty()) {
buf[0] = OTA_RESPONSE_REQUEST_AUTH; buf[0] = ota::OTA_RESPONSE_REQUEST_AUTH;
this->writeall_(buf, 1); this->writeall_(buf, 1);
md5::MD5Digest md5{}; md5::MD5Digest md5{};
md5.init(); md5.init();
@ -206,7 +183,7 @@ void OTAComponent::handle_() {
// Send nonce, 32 bytes hex MD5 // Send nonce, 32 bytes hex MD5
if (!this->writeall_(reinterpret_cast<uint8_t *>(sbuf), 32)) { if (!this->writeall_(reinterpret_cast<uint8_t *>(sbuf), 32)) {
ESP_LOGW(TAG, "Auth: Writing nonce failed!"); ESP_LOGW(TAG, "Auth: Writing nonce failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
@ -218,7 +195,7 @@ void OTAComponent::handle_() {
// Receive cnonce, 32 bytes hex MD5 // Receive cnonce, 32 bytes hex MD5
if (!this->readall_(buf, 32)) { if (!this->readall_(buf, 32)) {
ESP_LOGW(TAG, "Auth: Reading cnonce failed!"); ESP_LOGW(TAG, "Auth: Reading cnonce failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
sbuf[32] = '\0'; sbuf[32] = '\0';
@ -233,7 +210,7 @@ void OTAComponent::handle_() {
// Receive result, 32 bytes hex MD5 // Receive result, 32 bytes hex MD5
if (!this->readall_(buf + 64, 32)) { if (!this->readall_(buf + 64, 32)) {
ESP_LOGW(TAG, "Auth: Reading response failed!"); ESP_LOGW(TAG, "Auth: Reading response failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
sbuf[64 + 32] = '\0'; sbuf[64 + 32] = '\0';
@ -244,20 +221,20 @@ void OTAComponent::handle_() {
matches = matches && buf[i] == buf[64 + i]; matches = matches && buf[i] == buf[64 + i];
if (!matches) { if (!matches) {
ESP_LOGW(TAG, "Auth failed! Passwords do not match!"); ESP_LOGW(TAG, "Auth failed! Passwords do not match");
error_code = OTA_RESPONSE_ERROR_AUTH_INVALID; error_code = ota::OTA_RESPONSE_ERROR_AUTH_INVALID;
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
} }
#endif // USE_OTA_PASSWORD #endif // USE_OTA_PASSWORD
// Acknowledge auth OK - 1 byte // Acknowledge auth OK - 1 byte
buf[0] = OTA_RESPONSE_AUTH_OK; buf[0] = ota::OTA_RESPONSE_AUTH_OK;
this->writeall_(buf, 1); this->writeall_(buf, 1);
// Read size, 4 bytes MSB first // Read size, 4 bytes MSB first
if (!this->readall_(buf, 4)) { if (!this->readall_(buf, 4)) {
ESP_LOGW(TAG, "Reading size failed!"); ESP_LOGW(TAG, "Reading size failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
ota_size = 0; ota_size = 0;
@ -265,20 +242,20 @@ void OTAComponent::handle_() {
ota_size <<= 8; ota_size <<= 8;
ota_size |= buf[i]; ota_size |= buf[i];
} }
ESP_LOGV(TAG, "OTA size is %u bytes", ota_size); ESP_LOGV(TAG, "Size is %u bytes", ota_size);
error_code = backend->begin(ota_size); error_code = backend->begin(ota_size);
if (error_code != OTA_RESPONSE_OK) if (error_code != ota::OTA_RESPONSE_OK)
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
update_started = true; update_started = true;
// Acknowledge prepare OK - 1 byte // Acknowledge prepare OK - 1 byte
buf[0] = OTA_RESPONSE_UPDATE_PREPARE_OK; buf[0] = ota::OTA_RESPONSE_UPDATE_PREPARE_OK;
this->writeall_(buf, 1); this->writeall_(buf, 1);
// Read binary MD5, 32 bytes // Read binary MD5, 32 bytes
if (!this->readall_(buf, 32)) { if (!this->readall_(buf, 32)) {
ESP_LOGW(TAG, "Reading binary MD5 checksum failed!"); ESP_LOGW(TAG, "Reading binary MD5 checksum failed");
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
sbuf[32] = '\0'; sbuf[32] = '\0';
@ -286,7 +263,7 @@ void OTAComponent::handle_() {
backend->set_update_md5(sbuf); backend->set_update_md5(sbuf);
// Acknowledge MD5 OK - 1 byte // Acknowledge MD5 OK - 1 byte
buf[0] = OTA_RESPONSE_BIN_MD5_OK; buf[0] = ota::OTA_RESPONSE_BIN_MD5_OK;
this->writeall_(buf, 1); this->writeall_(buf, 1);
while (total < ota_size) { while (total < ota_size) {
@ -299,7 +276,7 @@ void OTAComponent::handle_() {
delay(1); delay(1);
continue; continue;
} }
ESP_LOGW(TAG, "Error receiving data for update, errno: %d", errno); ESP_LOGW(TAG, "Error receiving data for update, errno %d", errno);
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} else if (read == 0) { } else if (read == 0) {
// $ man recv // $ man recv
@ -310,14 +287,14 @@ void OTAComponent::handle_() {
} }
error_code = backend->write(buf, read); error_code = backend->write(buf, read);
if (error_code != OTA_RESPONSE_OK) { if (error_code != ota::OTA_RESPONSE_OK) {
ESP_LOGW(TAG, "Error writing binary data to flash!, error_code: %d", error_code); ESP_LOGW(TAG, "Error writing binary data to flash!, error_code: %d", error_code);
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
total += read; total += read;
#if USE_OTA_VERSION == 2 #if USE_OTA_VERSION == 2
while (size_acknowledged + OTA_BLOCK_SIZE <= total || (total == ota_size && size_acknowledged < ota_size)) { while (size_acknowledged + OTA_BLOCK_SIZE <= total || (total == ota_size && size_acknowledged < ota_size)) {
buf[0] = OTA_RESPONSE_CHUNK_OK; buf[0] = ota::OTA_RESPONSE_CHUNK_OK;
this->writeall_(buf, 1); this->writeall_(buf, 1);
size_acknowledged += OTA_BLOCK_SIZE; size_acknowledged += OTA_BLOCK_SIZE;
} }
@ -327,9 +304,9 @@ void OTAComponent::handle_() {
if (now - last_progress > 1000) { if (now - last_progress > 1000) {
last_progress = now; last_progress = now;
float percentage = (total * 100.0f) / ota_size; float percentage = (total * 100.0f) / ota_size;
ESP_LOGD(TAG, "OTA in progress: %0.1f%%", percentage); ESP_LOGD(TAG, "Progress: %0.1f%%", percentage);
#ifdef USE_OTA_STATE_CALLBACK #ifdef USE_OTA_STATE_CALLBACK
this->state_callback_.call(OTA_IN_PROGRESS, percentage, 0); this->state_callback_.call(ota::OTA_IN_PROGRESS, percentage, 0);
#endif #endif
// feed watchdog and give other tasks a chance to run // feed watchdog and give other tasks a chance to run
App.feed_wdt(); App.feed_wdt();
@ -338,32 +315,32 @@ void OTAComponent::handle_() {
} }
// Acknowledge receive OK - 1 byte // Acknowledge receive OK - 1 byte
buf[0] = OTA_RESPONSE_RECEIVE_OK; buf[0] = ota::OTA_RESPONSE_RECEIVE_OK;
this->writeall_(buf, 1); this->writeall_(buf, 1);
error_code = backend->end(); error_code = backend->end();
if (error_code != OTA_RESPONSE_OK) { if (error_code != ota::OTA_RESPONSE_OK) {
ESP_LOGW(TAG, "Error ending OTA!, error_code: %d", error_code); ESP_LOGW(TAG, "Error ending update! error_code: %d", error_code);
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
// Acknowledge Update end OK - 1 byte // Acknowledge Update end OK - 1 byte
buf[0] = OTA_RESPONSE_UPDATE_END_OK; buf[0] = ota::OTA_RESPONSE_UPDATE_END_OK;
this->writeall_(buf, 1); this->writeall_(buf, 1);
// Read ACK // Read ACK
if (!this->readall_(buf, 1) || buf[0] != OTA_RESPONSE_OK) { if (!this->readall_(buf, 1) || buf[0] != ota::OTA_RESPONSE_OK) {
ESP_LOGW(TAG, "Reading back acknowledgement failed!"); ESP_LOGW(TAG, "Reading back acknowledgement failed");
// do not go to error, this is not fatal // do not go to error, this is not fatal
} }
this->client_->close(); this->client_->close();
this->client_ = nullptr; this->client_ = nullptr;
delay(10); delay(10);
ESP_LOGI(TAG, "OTA update finished!"); ESP_LOGI(TAG, "Update complete");
this->status_clear_warning(); this->status_clear_warning();
#ifdef USE_OTA_STATE_CALLBACK #ifdef USE_OTA_STATE_CALLBACK
this->state_callback_.call(OTA_COMPLETED, 100.0f, 0); this->state_callback_.call(ota::OTA_COMPLETED, 100.0f, 0);
#endif #endif
delay(100); // NOLINT delay(100); // NOLINT
App.safe_reboot(); App.safe_reboot();
@ -380,11 +357,11 @@ error:
this->status_momentary_error("onerror", 5000); this->status_momentary_error("onerror", 5000);
#ifdef USE_OTA_STATE_CALLBACK #ifdef USE_OTA_STATE_CALLBACK
this->state_callback_.call(OTA_ERROR, 0.0f, static_cast<uint8_t>(error_code)); this->state_callback_.call(ota::OTA_ERROR, 0.0f, static_cast<uint8_t>(error_code));
#endif #endif
} }
bool OTAComponent::readall_(uint8_t *buf, size_t len) { bool ESPHomeOTAComponent::readall_(uint8_t *buf, size_t len) {
uint32_t start = millis(); uint32_t start = millis();
uint32_t at = 0; uint32_t at = 0;
while (len - at > 0) { while (len - at > 0) {
@ -401,7 +378,7 @@ bool OTAComponent::readall_(uint8_t *buf, size_t len) {
delay(1); delay(1);
continue; continue;
} }
ESP_LOGW(TAG, "Failed to read %d bytes of data, errno: %d", len, errno); ESP_LOGW(TAG, "Failed to read %d bytes of data, errno %d", len, errno);
return false; return false;
} else if (read == 0) { } else if (read == 0) {
ESP_LOGW(TAG, "Remote closed connection"); ESP_LOGW(TAG, "Remote closed connection");
@ -415,7 +392,7 @@ bool OTAComponent::readall_(uint8_t *buf, size_t len) {
return true; return true;
} }
bool OTAComponent::writeall_(const uint8_t *buf, size_t len) { bool ESPHomeOTAComponent::writeall_(const uint8_t *buf, size_t len) {
uint32_t start = millis(); uint32_t start = millis();
uint32_t at = 0; uint32_t at = 0;
while (len - at > 0) { while (len - at > 0) {
@ -432,7 +409,7 @@ bool OTAComponent::writeall_(const uint8_t *buf, size_t len) {
delay(1); delay(1);
continue; continue;
} }
ESP_LOGW(TAG, "Failed to write %d bytes of data, errno: %d", len, errno); ESP_LOGW(TAG, "Failed to write %d bytes of data, errno %d", len, errno);
return false; return false;
} else { } else {
at += written; at += written;
@ -443,31 +420,31 @@ bool OTAComponent::writeall_(const uint8_t *buf, size_t len) {
return true; return true;
} }
float OTAComponent::get_setup_priority() const { return setup_priority::AFTER_WIFI; } float ESPHomeOTAComponent::get_setup_priority() const { return setup_priority::AFTER_WIFI; }
uint16_t OTAComponent::get_port() const { return this->port_; } uint16_t ESPHomeOTAComponent::get_port() const { return this->port_; }
void OTAComponent::set_port(uint16_t port) { this->port_ = port; } void ESPHomeOTAComponent::set_port(uint16_t port) { this->port_ = port; }
void OTAComponent::set_safe_mode_pending(const bool &pending) { void ESPHomeOTAComponent::set_safe_mode_pending(const bool &pending) {
if (!this->has_safe_mode_) if (!this->has_safe_mode_)
return; return;
uint32_t current_rtc = this->read_rtc_(); uint32_t current_rtc = this->read_rtc_();
if (pending && current_rtc != esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) { if (pending && current_rtc != ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC) {
ESP_LOGI(TAG, "Device will enter safe mode on next boot."); ESP_LOGI(TAG, "Device will enter safe mode on next boot");
this->write_rtc_(esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC); this->write_rtc_(ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC);
} }
if (!pending && current_rtc == esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC) { if (!pending && current_rtc == ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC) {
ESP_LOGI(TAG, "Safe mode pending has been cleared"); ESP_LOGI(TAG, "Safe mode pending has been cleared");
this->clean_rtc(); this->clean_rtc();
} }
} }
bool OTAComponent::get_safe_mode_pending() { bool ESPHomeOTAComponent::get_safe_mode_pending() {
return this->has_safe_mode_ && this->read_rtc_() == esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC; return this->has_safe_mode_ && this->read_rtc_() == ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC;
} }
bool OTAComponent::should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_time) { bool ESPHomeOTAComponent::should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_time) {
this->has_safe_mode_ = true; this->has_safe_mode_ = true;
this->safe_mode_start_time_ = millis(); this->safe_mode_start_time_ = millis();
this->safe_mode_enable_time_ = enable_time; this->safe_mode_enable_time_ = enable_time;
@ -475,24 +452,24 @@ bool OTAComponent::should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_
this->rtc_ = global_preferences->make_preference<uint32_t>(233825507UL, false); this->rtc_ = global_preferences->make_preference<uint32_t>(233825507UL, false);
this->safe_mode_rtc_value_ = this->read_rtc_(); 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; bool is_manual_safe_mode = this->safe_mode_rtc_value_ == ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC;
if (is_manual_safe_mode) { if (is_manual_safe_mode) {
ESP_LOGI(TAG, "Safe mode has been entered manually"); ESP_LOGI(TAG, "Safe mode has been entered manually");
} else { } else {
ESP_LOGCONFIG(TAG, "There have been %" PRIu32 " suspected unsuccessful boot attempts.", this->safe_mode_rtc_value_); 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) { if (this->safe_mode_rtc_value_ >= num_attempts || is_manual_safe_mode) {
this->clean_rtc(); this->clean_rtc();
if (!is_manual_safe_mode) { if (!is_manual_safe_mode) {
ESP_LOGE(TAG, "Boot loop detected. Proceeding to safe mode."); ESP_LOGE(TAG, "Boot loop detected. Proceeding to safe mode");
} }
this->status_set_error(); this->status_set_error();
this->set_timeout(enable_time, []() { this->set_timeout(enable_time, []() {
ESP_LOGE(TAG, "No OTA attempt made, restarting."); ESP_LOGE(TAG, "No OTA attempt made, restarting");
App.reboot(); App.reboot();
}); });
@ -500,7 +477,7 @@ bool OTAComponent::should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_
delay(300); // NOLINT delay(300); // NOLINT
App.setup(); App.setup();
ESP_LOGI(TAG, "Waiting for OTA attempt."); ESP_LOGI(TAG, "Waiting for OTA attempt");
return true; return true;
} else { } else {
@ -509,27 +486,23 @@ bool OTAComponent::should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_
return false; return false;
} }
} }
void OTAComponent::write_rtc_(uint32_t val) {
void ESPHomeOTAComponent::write_rtc_(uint32_t val) {
this->rtc_.save(&val); this->rtc_.save(&val);
global_preferences->sync(); global_preferences->sync();
} }
uint32_t OTAComponent::read_rtc_() {
uint32_t ESPHomeOTAComponent::read_rtc_() {
uint32_t val; uint32_t val;
if (!this->rtc_.load(&val)) if (!this->rtc_.load(&val))
return 0; return 0;
return val; return val;
} }
void OTAComponent::clean_rtc() { this->write_rtc_(0); }
void OTAComponent::on_safe_shutdown() { void ESPHomeOTAComponent::clean_rtc() { this->write_rtc_(0); }
if (this->has_safe_mode_ && this->read_rtc_() != esphome::ota::OTAComponent::ENTER_SAFE_MODE_MAGIC)
void ESPHomeOTAComponent::on_safe_shutdown() {
if (this->has_safe_mode_ && this->read_rtc_() != ESPHomeOTAComponent::ENTER_SAFE_MODE_MAGIC)
this->clean_rtc(); this->clean_rtc();
} }
#ifdef USE_OTA_STATE_CALLBACK
void OTAComponent::add_on_state_callback(std::function<void(OTAState, float, uint8_t)> &&callback) {
this->state_callback_.add(std::move(callback));
}
#endif
} // namespace ota
} // namespace esphome } // namespace esphome

View file

@ -1,49 +1,16 @@
#pragma once #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" #include "esphome/core/defines.h"
#include "esphome/core/helpers.h"
#include "esphome/core/preferences.h"
#include "esphome/components/ota/ota_backend.h"
#include "esphome/components/socket/socket.h"
namespace esphome { namespace esphome {
namespace ota {
enum OTAResponseTypes { /// ESPHomeOTAComponent provides a simple way to integrate Over-the-Air updates into your app using ArduinoOTA.
OTA_RESPONSE_OK = 0x00, class ESPHomeOTAComponent : public ota::OTAComponent {
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: public:
OTAComponent();
#ifdef USE_OTA_PASSWORD #ifdef USE_OTA_PASSWORD
void set_auth_password(const std::string &password) { password_ = password; } void set_auth_password(const std::string &password) { password_ = password; }
#endif // USE_OTA_PASSWORD #endif // USE_OTA_PASSWORD
@ -57,10 +24,6 @@ class OTAComponent : public Component {
void set_safe_mode_pending(const bool &pending); void set_safe_mode_pending(const bool &pending);
bool get_safe_mode_pending(); bool get_safe_mode_pending();
#ifdef USE_OTA_STATE_CALLBACK
void add_on_state_callback(std::function<void(OTAState, float, uint8_t)> &&callback);
#endif
// ========== INTERNAL METHODS ========== // ========== INTERNAL METHODS ==========
// (In most use cases you won't need these) // (In most use cases you won't need these)
void setup() override; void setup() override;
@ -91,22 +54,15 @@ class OTAComponent : public Component {
std::unique_ptr<socket::Socket> server_; std::unique_ptr<socket::Socket> server_;
std::unique_ptr<socket::Socket> client_; std::unique_ptr<socket::Socket> client_;
bool has_safe_mode_{false}; ///< stores whether safe mode can be enabled. 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_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_enable_time_{60000}; ///< The time safe mode should be on for
uint32_t safe_mode_rtc_value_; uint32_t safe_mode_rtc_value_;
uint8_t safe_mode_num_attempts_; uint8_t safe_mode_num_attempts_;
ESPPreferenceObject rtc_; ESPPreferenceObject rtc_;
static const uint32_t ENTER_SAFE_MODE_MAGIC = static const uint32_t ENTER_SAFE_MODE_MAGIC =
0x5afe5afe; ///< a magic number to indicate that safe mode should be entered on next boot 0x5afe5afe; ///< a magic number to indicate that safe mode should be entered on next boot
#ifdef USE_OTA_STATE_CALLBACK
CallbackManager<void(OTAState, float, uint8_t)> state_callback_{};
#endif
}; };
extern OTAComponent *global_ota_component; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
} // namespace ota
} // namespace esphome } // namespace esphome

View file

@ -1,71 +1,67 @@
from esphome.cpp_generator import RawExpression
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome import automation from esphome import automation
from esphome.const import (
CONF_ID,
CONF_NUM_ATTEMPTS,
CONF_PASSWORD,
CONF_PORT,
CONF_REBOOT_TIMEOUT,
CONF_SAFE_MODE,
CONF_TRIGGER_ID,
CONF_OTA,
KEY_PAST_SAFE_MODE,
CONF_VERSION,
)
from esphome.core import CORE, coroutine_with_priority from esphome.core import CORE, coroutine_with_priority
CODEOWNERS = ["@esphome/core"] from esphome.const import CONF_ESPHOME, CONF_OTA, CONF_PLATFORM, CONF_TRIGGER_ID
DEPENDENCIES = ["network"]
AUTO_LOAD = ["socket", "md5"]
CONF_ON_STATE_CHANGE = "on_state_change" CODEOWNERS = ["@esphome/core"]
AUTO_LOAD = ["md5"]
IS_PLATFORM_COMPONENT = True
CONF_ON_ABORT = "on_abort"
CONF_ON_BEGIN = "on_begin" CONF_ON_BEGIN = "on_begin"
CONF_ON_PROGRESS = "on_progress"
CONF_ON_END = "on_end" CONF_ON_END = "on_end"
CONF_ON_ERROR = "on_error" CONF_ON_ERROR = "on_error"
CONF_ON_PROGRESS = "on_progress"
CONF_ON_STATE_CHANGE = "on_state_change"
ota_ns = cg.esphome_ns.namespace("ota") ota_ns = cg.esphome_ns.namespace("ota")
OTAState = ota_ns.enum("OTAState")
OTAComponent = ota_ns.class_("OTAComponent", cg.Component) 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())
OTAStateChangeTrigger = ota_ns.class_( OTAStateChangeTrigger = ota_ns.class_(
"OTAStateChangeTrigger", automation.Trigger.template() "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())
CONFIG_SCHEMA = cv.Schema( 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(
{ {
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.Optional(CONF_ON_STATE_CHANGE): automation.validate_automation(
{ {
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAStateChangeTrigger), 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.Optional(CONF_ON_BEGIN): automation.validate_automation(
{ {
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAStartTrigger), 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.Optional(CONF_ON_ERROR): automation.validate_automation(
{ {
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAErrorTrigger), cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAErrorTrigger),
@ -76,35 +72,13 @@ CONFIG_SCHEMA = cv.Schema(
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(OTAProgressTrigger), 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(50.0) @coroutine_with_priority(50.0)
async def to_code(config): 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") 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: if CORE.is_esp32 and CORE.using_arduino:
cg.add_library("Update", None) cg.add_library("Update", None)
@ -112,11 +86,17 @@ async def to_code(config):
if CORE.is_rp2040 and CORE.using_arduino: if CORE.is_rp2040 and CORE.using_arduino:
cg.add_library("Updater", None) cg.add_library("Updater", None)
async def ota_to_code(var, config):
use_state_callback = False use_state_callback = False
for conf in config.get(CONF_ON_STATE_CHANGE, []): for conf in config.get(CONF_ON_STATE_CHANGE, []):
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var) trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
await automation.build_automation(trigger, [(OTAState, "state")], conf) await automation.build_automation(trigger, [(OTAState, "state")], conf)
use_state_callback = True 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, []): for conf in config.get(CONF_ON_BEGIN, []):
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var) trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
await automation.build_automation(trigger, [], conf) await automation.build_automation(trigger, [], conf)

View file

@ -1,11 +1,8 @@
#pragma once #pragma once
#include "esphome/core/defines.h"
#ifdef USE_OTA_STATE_CALLBACK #ifdef USE_OTA_STATE_CALLBACK
#include "ota_backend.h"
#include "esphome/core/component.h"
#include "esphome/core/automation.h" #include "esphome/core/automation.h"
#include "esphome/components/ota/ota_component.h"
namespace esphome { namespace esphome {
namespace ota { namespace ota {
@ -54,6 +51,17 @@ 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<uint8_t> { class OTAErrorTrigger : public Trigger<uint8_t> {
public: public:
explicit OTAErrorTrigger(OTAComponent *parent) { explicit OTAErrorTrigger(OTAComponent *parent) {
@ -67,5 +75,4 @@ class OTAErrorTrigger : public Trigger<uint8_t> {
} // namespace ota } // namespace ota
} // namespace esphome } // namespace esphome
#endif
#endif // USE_OTA_STATE_CALLBACK

View file

@ -0,0 +1,20 @@
#include "ota_backend.h"
namespace esphome {
namespace ota {
#ifdef USE_OTA_STATE_CALLBACK
OTAGlobalCallback *global_ota_callback{nullptr}; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
OTAGlobalCallback *get_global_ota_callback() {
if (global_ota_callback == nullptr) {
global_ota_callback = new OTAGlobalCallback(); // NOLINT(cppcoreguidelines-owning-memory)
}
return global_ota_callback;
}
void register_ota_platform(OTAComponent *ota_caller) { get_global_ota_callback()->register_ota(ota_caller); }
#endif
} // namespace ota
} // namespace esphome

View file

@ -1,9 +1,53 @@
#pragma once #pragma once
#include "ota_component.h"
#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
namespace esphome { namespace esphome {
namespace ota { 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 { class OTABackend {
public: public:
virtual ~OTABackend() = default; virtual ~OTABackend() = default;
@ -15,5 +59,38 @@ class OTABackend {
virtual bool supports_compression() = 0; virtual bool supports_compression() = 0;
}; };
class OTAComponent : public Component {
#ifdef USE_OTA_STATE_CALLBACK
public:
void add_on_state_callback(std::function<void(ota::OTAState, float, uint8_t)> &&callback) {
this->state_callback_.add(std::move(callback));
}
protected:
CallbackManager<void(ota::OTAState, float, uint8_t)> 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<void(OTAState, float, uint8_t, OTAComponent *)> &&callback) {
this->state_callback_.add(std::move(callback));
}
protected:
CallbackManager<void(OTAState, float, uint8_t, OTAComponent *)> state_callback_{};
};
OTAGlobalCallback *get_global_ota_callback();
void register_ota_platform(OTAComponent *ota_caller);
#endif
std::unique_ptr<ota::OTABackend> make_ota_backend();
} // namespace ota } // namespace ota
} // namespace esphome } // namespace esphome

View file

@ -1,8 +1,7 @@
#include "esphome/core/defines.h"
#ifdef USE_ESP32_FRAMEWORK_ARDUINO #ifdef USE_ESP32_FRAMEWORK_ARDUINO
#include "esphome/core/defines.h"
#include "ota_backend_arduino_esp32.h" #include "ota_backend_arduino_esp32.h"
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include <Update.h> #include <Update.h>
@ -10,6 +9,8 @@
namespace esphome { namespace esphome {
namespace ota { namespace ota {
std::unique_ptr<ota::OTABackend> make_ota_backend() { return make_unique<ota::ArduinoESP32OTABackend>(); }
OTAResponseTypes ArduinoESP32OTABackend::begin(size_t image_size) { OTAResponseTypes ArduinoESP32OTABackend::begin(size_t image_size) {
bool ret = Update.begin(image_size, U_FLASH); bool ret = Update.begin(image_size, U_FLASH);
if (ret) { if (ret) {

View file

@ -1,10 +1,10 @@
#pragma once #pragma once
#include "esphome/core/defines.h"
#ifdef USE_ESP32_FRAMEWORK_ARDUINO #ifdef USE_ESP32_FRAMEWORK_ARDUINO
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "esphome/core/defines.h"
#include "esphome/core/helpers.h"
namespace esphome { namespace esphome {
namespace ota { namespace ota {

View file

@ -1,10 +1,9 @@
#include "esphome/core/defines.h"
#ifdef USE_ARDUINO #ifdef USE_ARDUINO
#ifdef USE_ESP8266 #ifdef USE_ESP8266
#include "ota_backend_arduino_esp8266.h"
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "ota_backend_arduino_esp8266.h"
#include "esphome/core/defines.h"
#include "esphome/components/esp8266/preferences.h" #include "esphome/components/esp8266/preferences.h"
#include <Updater.h> #include <Updater.h>
@ -12,6 +11,8 @@
namespace esphome { namespace esphome {
namespace ota { namespace ota {
std::unique_ptr<ota::OTABackend> make_ota_backend() { return make_unique<ota::ArduinoESP8266OTABackend>(); }
OTAResponseTypes ArduinoESP8266OTABackend::begin(size_t image_size) { OTAResponseTypes ArduinoESP8266OTABackend::begin(size_t image_size) {
bool ret = Update.begin(image_size, U_FLASH); bool ret = Update.begin(image_size, U_FLASH);
if (ret) { if (ret) {

View file

@ -1,10 +1,9 @@
#pragma once #pragma once
#include "esphome/core/defines.h"
#ifdef USE_ARDUINO #ifdef USE_ARDUINO
#ifdef USE_ESP8266 #ifdef USE_ESP8266
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "esphome/core/defines.h"
#include "esphome/core/macros.h" #include "esphome/core/macros.h"
namespace esphome { namespace esphome {

View file

@ -1,15 +1,16 @@
#include "esphome/core/defines.h"
#ifdef USE_LIBRETINY #ifdef USE_LIBRETINY
#include "ota_backend_arduino_libretiny.h"
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "ota_backend_arduino_libretiny.h"
#include "esphome/core/defines.h"
#include <Update.h> #include <Update.h>
namespace esphome { namespace esphome {
namespace ota { namespace ota {
std::unique_ptr<ota::OTABackend> make_ota_backend() { return make_unique<ota::ArduinoLibreTinyOTABackend>(); }
OTAResponseTypes ArduinoLibreTinyOTABackend::begin(size_t image_size) { OTAResponseTypes ArduinoLibreTinyOTABackend::begin(size_t image_size) {
bool ret = Update.begin(image_size, U_FLASH); bool ret = Update.begin(image_size, U_FLASH);
if (ret) { if (ret) {

View file

@ -1,10 +1,9 @@
#pragma once #pragma once
#include "esphome/core/defines.h"
#ifdef USE_LIBRETINY #ifdef USE_LIBRETINY
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "esphome/core/defines.h"
namespace esphome { namespace esphome {
namespace ota { namespace ota {

View file

@ -1,17 +1,18 @@
#include "esphome/core/defines.h"
#ifdef USE_ARDUINO #ifdef USE_ARDUINO
#ifdef USE_RP2040 #ifdef USE_RP2040
#include "esphome/components/rp2040/preferences.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "ota_backend_arduino_rp2040.h" #include "ota_backend_arduino_rp2040.h"
#include "ota_component.h"
#include "esphome/components/rp2040/preferences.h"
#include "esphome/core/defines.h"
#include <Updater.h> #include <Updater.h>
namespace esphome { namespace esphome {
namespace ota { namespace ota {
std::unique_ptr<ota::OTABackend> make_ota_backend() { return make_unique<ota::ArduinoRP2040OTABackend>(); }
OTAResponseTypes ArduinoRP2040OTABackend::begin(size_t image_size) { OTAResponseTypes ArduinoRP2040OTABackend::begin(size_t image_size) {
bool ret = Update.begin(image_size, U_FLASH); bool ret = Update.begin(image_size, U_FLASH);
if (ret) { if (ret) {

View file

@ -1,11 +1,10 @@
#pragma once #pragma once
#include "esphome/core/defines.h"
#ifdef USE_ARDUINO #ifdef USE_ARDUINO
#ifdef USE_RP2040 #ifdef USE_RP2040
#include "esphome/core/macros.h"
#include "ota_backend.h" #include "ota_backend.h"
#include "ota_component.h"
#include "esphome/core/defines.h"
#include "esphome/core/macros.h"
namespace esphome { namespace esphome {
namespace ota { namespace ota {

View file

@ -1,12 +1,11 @@
#include "esphome/core/defines.h"
#ifdef USE_ESP_IDF #ifdef USE_ESP_IDF
#include <esp_task_wdt.h>
#include "ota_backend_esp_idf.h" #include "ota_backend_esp_idf.h"
#include "ota_component.h"
#include <esp_ota_ops.h>
#include "esphome/components/md5/md5.h" #include "esphome/components/md5/md5.h"
#include "esphome/core/defines.h"
#include <esp_ota_ops.h>
#include <esp_task_wdt.h>
#if ESP_IDF_VERSION_MAJOR >= 5 #if ESP_IDF_VERSION_MAJOR >= 5
#include <spi_flash_mmap.h> #include <spi_flash_mmap.h>
@ -15,6 +14,8 @@
namespace esphome { namespace esphome {
namespace ota { namespace ota {
std::unique_ptr<ota::OTABackend> make_ota_backend() { return make_unique<ota::IDFOTABackend>(); }
OTAResponseTypes IDFOTABackend::begin(size_t image_size) { OTAResponseTypes IDFOTABackend::begin(size_t image_size) {
this->partition_ = esp_ota_get_next_update_partition(nullptr); this->partition_ = esp_ota_get_next_update_partition(nullptr);
if (this->partition_ == nullptr) { if (this->partition_ == nullptr) {

View file

@ -1,11 +1,11 @@
#pragma once #pragma once
#include "esphome/core/defines.h"
#ifdef USE_ESP_IDF #ifdef USE_ESP_IDF
#include "ota_component.h"
#include "ota_backend.h" #include "ota_backend.h"
#include <esp_ota_ops.h>
#include "esphome/components/md5/md5.h" #include "esphome/components/md5/md5.h"
#include "esphome/core/defines.h"
#include <esp_ota_ops.h>
namespace esphome { namespace esphome {
namespace ota { namespace ota {

View file

@ -1,18 +1,17 @@
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.components import button from esphome.components import button
from esphome.components.ota import OTAComponent from esphome.components.esphome.ota import ESPHomeOTAComponent
from esphome.const import ( from esphome.const import (
CONF_ID, CONF_ESPHOME,
CONF_OTA,
DEVICE_CLASS_RESTART, DEVICE_CLASS_RESTART,
ENTITY_CATEGORY_CONFIG, ENTITY_CATEGORY_CONFIG,
ICON_RESTART_ALERT, ICON_RESTART_ALERT,
) )
from .. import safe_mode_ns
DEPENDENCIES = ["ota"] DEPENDENCIES = ["ota.esphome"]
safe_mode_ns = cg.esphome_ns.namespace("safe_mode")
SafeModeButton = safe_mode_ns.class_("SafeModeButton", button.Button, cg.Component) SafeModeButton = safe_mode_ns.class_("SafeModeButton", button.Button, cg.Component)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = (
@ -22,15 +21,14 @@ CONFIG_SCHEMA = (
entity_category=ENTITY_CATEGORY_CONFIG, entity_category=ENTITY_CATEGORY_CONFIG,
icon=ICON_RESTART_ALERT, icon=ICON_RESTART_ALERT,
) )
.extend({cv.GenerateID(CONF_OTA): cv.use_id(OTAComponent)}) .extend({cv.GenerateID(CONF_ESPHOME): cv.use_id(ESPHomeOTAComponent)})
.extend(cv.COMPONENT_SCHEMA) .extend(cv.COMPONENT_SCHEMA)
) )
async def to_code(config): async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID]) var = await button.new_button(config)
await cg.register_component(var, config) await cg.register_component(var, config)
await button.register_button(var, config)
ota = await cg.get_variable(config[CONF_OTA]) ota = await cg.get_variable(config[CONF_ESPHOME])
cg.add(var.set_ota(ota)) cg.add(var.set_ota(ota))

View file

@ -8,7 +8,7 @@ namespace safe_mode {
static const char *const TAG = "safe_mode.button"; static const char *const TAG = "safe_mode.button";
void SafeModeButton::set_ota(ota::OTAComponent *ota) { this->ota_ = ota; } void SafeModeButton::set_ota(esphome::ESPHomeOTAComponent *ota) { this->ota_ = ota; }
void SafeModeButton::press_action() { void SafeModeButton::press_action() {
ESP_LOGI(TAG, "Restarting device in safe mode..."); ESP_LOGI(TAG, "Restarting device in safe mode...");

View file

@ -1,8 +1,8 @@
#pragma once #pragma once
#include "esphome/core/component.h"
#include "esphome/components/ota/ota_component.h"
#include "esphome/components/button/button.h" #include "esphome/components/button/button.h"
#include "esphome/components/esphome/ota/ota_esphome.h"
#include "esphome/core/component.h"
namespace esphome { namespace esphome {
namespace safe_mode { namespace safe_mode {
@ -10,10 +10,10 @@ namespace safe_mode {
class SafeModeButton : public button::Button, public Component { class SafeModeButton : public button::Button, public Component {
public: public:
void dump_config() override; void dump_config() override;
void set_ota(ota::OTAComponent *ota); void set_ota(esphome::ESPHomeOTAComponent *ota);
protected: protected:
ota::OTAComponent *ota_; esphome::ESPHomeOTAComponent *ota_;
void press_action() override; void press_action() override;
}; };

View file

@ -1,26 +1,26 @@
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.components import switch from esphome.components import switch
from esphome.components.ota import OTAComponent from esphome.components.esphome.ota import ESPHomeOTAComponent
from esphome.const import ( from esphome.const import (
CONF_OTA, CONF_ESPHOME,
ENTITY_CATEGORY_CONFIG, ENTITY_CATEGORY_CONFIG,
ICON_RESTART_ALERT, ICON_RESTART_ALERT,
) )
from .. import safe_mode_ns from .. import safe_mode_ns
DEPENDENCIES = ["ota"] DEPENDENCIES = ["ota.esphome"]
SafeModeSwitch = safe_mode_ns.class_("SafeModeSwitch", switch.Switch, cg.Component) SafeModeSwitch = safe_mode_ns.class_("SafeModeSwitch", switch.Switch, cg.Component)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = (
switch.switch_schema( switch.switch_schema(
SafeModeSwitch, SafeModeSwitch,
icon=ICON_RESTART_ALERT,
entity_category=ENTITY_CATEGORY_CONFIG,
block_inverted=True, block_inverted=True,
entity_category=ENTITY_CATEGORY_CONFIG,
icon=ICON_RESTART_ALERT,
) )
.extend({cv.GenerateID(CONF_OTA): cv.use_id(OTAComponent)}) .extend({cv.GenerateID(CONF_ESPHOME): cv.use_id(ESPHomeOTAComponent)})
.extend(cv.COMPONENT_SCHEMA) .extend(cv.COMPONENT_SCHEMA)
) )
@ -29,5 +29,5 @@ async def to_code(config):
var = await switch.new_switch(config) var = await switch.new_switch(config)
await cg.register_component(var, config) await cg.register_component(var, config)
ota = await cg.get_variable(config[CONF_OTA]) ota = await cg.get_variable(config[CONF_ESPHOME])
cg.add(var.set_ota(ota)) cg.add(var.set_ota(ota))

View file

@ -1,14 +1,14 @@
#include "safe_mode_switch.h" #include "safe_mode_switch.h"
#include "esphome/core/application.h"
#include "esphome/core/hal.h" #include "esphome/core/hal.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#include "esphome/core/application.h"
namespace esphome { namespace esphome {
namespace safe_mode { namespace safe_mode {
static const char *const TAG = "safe_mode_switch"; static const char *const TAG = "safe_mode_switch";
void SafeModeSwitch::set_ota(ota::OTAComponent *ota) { this->ota_ = ota; } void SafeModeSwitch::set_ota(esphome::ESPHomeOTAComponent *ota) { this->ota_ = ota; }
void SafeModeSwitch::write_state(bool state) { void SafeModeSwitch::write_state(bool state) {
// Acknowledge // Acknowledge

View file

@ -1,8 +1,8 @@
#pragma once #pragma once
#include "esphome/core/component.h" #include "esphome/components/esphome/ota/ota_esphome.h"
#include "esphome/components/ota/ota_component.h"
#include "esphome/components/switch/switch.h" #include "esphome/components/switch/switch.h"
#include "esphome/core/component.h"
namespace esphome { namespace esphome {
namespace safe_mode { namespace safe_mode {
@ -10,10 +10,10 @@ namespace safe_mode {
class SafeModeSwitch : public switch_::Switch, public Component { class SafeModeSwitch : public switch_::Switch, public Component {
public: public:
void dump_config() override; void dump_config() override;
void set_ota(ota::OTAComponent *ota); void set_ota(esphome::ESPHomeOTAComponent *ota);
protected: protected:
ota::OTAComponent *ota_; esphome::ESPHomeOTAComponent *ota_;
void write_state(bool state) override; void write_state(bool state) override;
}; };

View file

@ -3,14 +3,16 @@ import logging
from esphome.const import ( from esphome.const import (
CONF_DISABLED_BY_DEFAULT, CONF_DISABLED_BY_DEFAULT,
CONF_ENTITY_CATEGORY, CONF_ENTITY_CATEGORY,
CONF_ESPHOME,
CONF_ICON, CONF_ICON,
CONF_INTERNAL, CONF_INTERNAL,
CONF_NAME, CONF_NAME,
CONF_SETUP_PRIORITY,
CONF_UPDATE_INTERVAL,
CONF_TYPE_ID,
CONF_OTA, CONF_OTA,
CONF_PLATFORM,
CONF_SAFE_MODE, CONF_SAFE_MODE,
CONF_SETUP_PRIORITY,
CONF_TYPE_ID,
CONF_UPDATE_INTERVAL,
KEY_PAST_SAFE_MODE, KEY_PAST_SAFE_MODE,
) )
@ -139,9 +141,16 @@ async def build_registry_list(registry, config):
async def past_safe_mode(): async def past_safe_mode():
safe_mode_enabled = ( ota_conf = {}
CONF_OTA in CORE.config and CORE.config[CONF_OTA][CONF_SAFE_MODE] for ota_item in CORE.config.get(CONF_OTA, []):
) if ota_item[CONF_PLATFORM] == CONF_ESPHOME:
ota_conf = ota_item
break
if not ota_conf:
return
safe_mode_enabled = ota_conf[CONF_SAFE_MODE]
if not safe_mode_enabled: if not safe_mode_enabled:
return return

View file

@ -153,6 +153,7 @@ def wizard_file(**kwargs):
# Configure OTA # Configure OTA
config += "\nota:\n" config += "\nota:\n"
config += " - platform: esphome\n"
if "ota_password" in kwargs: if "ota_password" in kwargs:
config += f" password: \"{kwargs['ota_password']}\"" config += f" password: \"{kwargs['ota_password']}\""
elif "password" in kwargs: elif "password" in kwargs:

View file

@ -3,6 +3,7 @@ wifi:
password: password1 password: password1
ota: ota:
- platform: esphome
safe_mode: true safe_mode: true
password: "superlongpasswordthatnoonewillknow" password: "superlongpasswordthatnoonewillknow"
port: 3286 port: 3286

View file

@ -3,6 +3,8 @@ wifi:
password: password1 password: password1
ota: ota:
- platform: esphome
safe_mode: true
button: button:
- platform: safe_mode - platform: safe_mode

View file

@ -5,7 +5,7 @@
#include <esphome/components/gpio/switch/gpio_switch.h> #include <esphome/components/gpio/switch/gpio_switch.h>
#include <esphome/components/logger/logger.h> #include <esphome/components/logger/logger.h>
#include <esphome/components/ota/ota_component.h> #include <esphome/components/esphome/ota/ota_esphome.h>
#include <esphome/components/wifi/wifi_component.h> #include <esphome/components/wifi/wifi_component.h>
#include <esphome/core/application.h> #include <esphome/core/application.h>
@ -25,7 +25,7 @@ void setup() {
ap.set_password("password1"); ap.set_password("password1");
wifi->add_sta(ap); wifi->add_sta(ap);
auto *ota = new ota::OTAComponent(); // NOLINT auto *ota = new esphome::ESPHomeOTAComponent(); // NOLINT
ota->set_port(8266); ota->set_port(8266);
App.setup(); App.setup();

View file

@ -265,6 +265,7 @@ uart:
baud_rate: 9600 baud_rate: 9600
ota: ota:
- platform: esphome
safe_mode: true safe_mode: true
password: "superlongpasswordthatnoonewillknow" password: "superlongpasswordthatnoonewillknow"
port: 3286 port: 3286

View file

@ -31,6 +31,7 @@ network:
api: api:
ota: ota:
- platform: esphome
logger: logger:

View file

@ -80,6 +80,7 @@ uart:
- lambda: UARTDebug::log_hex(direction, bytes, ':'); - lambda: UARTDebug::log_hex(direction, bytes, ':');
ota: ota:
- platform: esphome
safe_mode: true safe_mode: true
port: 3286 port: 3286
num_attempts: 15 num_attempts: 15

View file

@ -49,6 +49,7 @@ spi:
number: GPIO14 number: GPIO14
ota: ota:
- platform: esphome
version: 2 version: 2
logger: logger:

View file

@ -328,6 +328,7 @@ vbus:
uart_id: uart_4 uart_id: uart_4
ota: ota:
- platform: esphome
safe_mode: true safe_mode: true
port: 3286 port: 3286
reboot_timeout: 15min reboot_timeout: 15min

View file

@ -103,6 +103,7 @@ uart:
parity: EVEN parity: EVEN
ota: ota:
- platform: esphome
safe_mode: true safe_mode: true
port: 3286 port: 3286

View file

@ -28,6 +28,7 @@ network:
api: api:
ota: ota:
- platform: esphome
logger: logger:

View file

@ -22,6 +22,7 @@ network:
api: api:
ota: ota:
- platform: esphome
logger: logger:

View file

@ -12,6 +12,7 @@ esphome:
logger: logger:
ota: ota:
- platform: esphome
captive_portal: captive_portal:

View file

@ -12,6 +12,7 @@ esphome:
logger: logger:
ota: ota:
- platform: esphome
captive_portal: captive_portal: