sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-09-07 22:02:22 +01:00
Code Issues Releases Wiki Activity

[esphome] ESP8266: Move OTA error strings to PROGMEM (saves 116 bytes RAM) (#10620)

Browse Source
This commit is contained in:
J. Nick Koston
2025-09-05 17:44:23 -05:00
committed by GitHub
parent a49669ee58
commit 1510db277c
2 changed files with 25 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
esphome/components/esphome/ota/ota_esphome.cpp
View File

@@ -30,19 +30,19 @@ void ESPHomeOTAComponent::setup() {
this->server_ = socket::socket_ip_loop_monitored(SOCK_STREAM, 0); // monitored for incoming connections this->server_ = socket::socket_ip_loop_monitored(SOCK_STREAM, 0); // monitored for incoming connections
if (this->server_ == nullptr) { if (this->server_ == nullptr) {
this->log_socket_error_("creation"); this->log_socket_error_(LOG_STR("creation"));
this->mark_failed(); this->mark_failed();
return; return;
} }
int enable = 1; int enable = 1;
int err = this->server_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable, sizeof(int)); int err = this->server_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable, sizeof(int));
if (err != 0) { if (err != 0) {
this->log_socket_error_("reuseaddr"); this->log_socket_error_(LOG_STR("reuseaddr"));
// we can still continue // we can still continue
} }
err = this->server_->setblocking(false); err = this->server_->setblocking(false);
if (err != 0) { if (err != 0) {
this->log_socket_error_("non-blocking"); this->log_socket_error_(LOG_STR("non-blocking"));
this->mark_failed(); this->mark_failed();
return; return;
} }
@@ -51,21 +51,21 @@ void ESPHomeOTAComponent::setup() {
socklen_t sl = socket::set_sockaddr_any((struct sockaddr *) &server, sizeof(server), this->port_); socklen_t sl = socket::set_sockaddr_any((struct sockaddr *) &server, sizeof(server), this->port_);
if (sl == 0) { if (sl == 0) {
this->log_socket_error_("set sockaddr"); this->log_socket_error_(LOG_STR("set sockaddr"));
this->mark_failed(); this->mark_failed();
return; return;
} }
err = this->server_->bind((struct sockaddr *) &server, sizeof(server)); err = this->server_->bind((struct sockaddr *) &server, sizeof(server));
if (err != 0) { if (err != 0) {
this->log_socket_error_("bind"); this->log_socket_error_(LOG_STR("bind"));
this->mark_failed(); this->mark_failed();
return; return;
} }
err = this->server_->listen(4); err = this->server_->listen(4);
if (err != 0) { if (err != 0) {
this->log_socket_error_("listen"); this->log_socket_error_(LOG_STR("listen"));
this->mark_failed(); this->mark_failed();
return; return;
} }
@@ -114,17 +114,17 @@ void ESPHomeOTAComponent::handle_handshake_() {
return; return;
int err = this->client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable, sizeof(int)); int err = this->client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable, sizeof(int));
if (err != 0) { if (err != 0) {
this->log_socket_error_("nodelay"); this->log_socket_error_(LOG_STR("nodelay"));
this->cleanup_connection_(); this->cleanup_connection_();
return; return;
} }
err = this->client_->setblocking(false); err = this->client_->setblocking(false);
if (err != 0) { if (err != 0) {
this->log_socket_error_("non-blocking"); this->log_socket_error_(LOG_STR("non-blocking"));
this->cleanup_connection_(); this->cleanup_connection_();
return; return;
} }
this->log_start_("handshake"); this->log_start_(LOG_STR("handshake"));
this->client_connect_time_ = App.get_loop_component_start_time(); this->client_connect_time_ = App.get_loop_component_start_time();
this->magic_buf_pos_ = 0; // Reset magic buffer position this->magic_buf_pos_ = 0; // Reset magic buffer position
} }
@@ -150,7 +150,7 @@ void ESPHomeOTAComponent::handle_handshake_() {
if (read <= 0) { if (read <= 0) {
// Error or connection closed // Error or connection closed
if (read == -1) { if (read == -1) {
this->log_socket_error_("reading magic bytes"); this->log_socket_error_(LOG_STR("reading magic bytes"));
} else { } else {
ESP_LOGW(TAG, "Remote closed during handshake"); ESP_LOGW(TAG, "Remote closed during handshake");
} }
@@ -209,7 +209,7 @@ void ESPHomeOTAComponent::handle_data_() {
// Read features - 1 byte // Read features - 1 byte
if (!this->readall_(buf, 1)) { if (!this->readall_(buf, 1)) {
this->log_read_error_("features"); this->log_read_error_(LOG_STR("features"));
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
ota_features = buf[0]; // NOLINT ota_features = buf[0]; // NOLINT
@@ -288,7 +288,7 @@ void ESPHomeOTAComponent::handle_data_() {
// Read size, 4 bytes MSB first // Read size, 4 bytes MSB first
if (!this->readall_(buf, 4)) { if (!this->readall_(buf, 4)) {
this->log_read_error_("size"); this->log_read_error_(LOG_STR("size"));
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
ota_size = 0; ota_size = 0;
@@ -302,7 +302,7 @@ void ESPHomeOTAComponent::handle_data_() {
// starting the update, set the warning status and notify // starting the update, set the warning status and notify
// listeners. This ensures that port scanners do not // listeners. This ensures that port scanners do not
// accidentally trigger the update process. // accidentally trigger the update process.
this->log_start_("update"); this->log_start_(LOG_STR("update"));
this->status_set_warning(); this->status_set_warning();
#ifdef USE_OTA_STATE_CALLBACK #ifdef USE_OTA_STATE_CALLBACK
this->state_callback_.call(ota::OTA_STARTED, 0.0f, 0); this->state_callback_.call(ota::OTA_STARTED, 0.0f, 0);
@@ -320,7 +320,7 @@ void ESPHomeOTAComponent::handle_data_() {
// Read binary MD5, 32 bytes // Read binary MD5, 32 bytes
if (!this->readall_(buf, 32)) { if (!this->readall_(buf, 32)) {
this->log_read_error_("MD5 checksum"); this->log_read_error_(LOG_STR("MD5 checksum"));
goto error; // NOLINT(cppcoreguidelines-avoid-goto) goto error; // NOLINT(cppcoreguidelines-avoid-goto)
} }
sbuf[32] = '\0'; sbuf[32] = '\0';
@@ -393,7 +393,7 @@ void ESPHomeOTAComponent::handle_data_() {
// Read ACK // Read ACK
if (!this->readall_(buf, 1) || buf[0] != ota::OTA_RESPONSE_OK) { if (!this->readall_(buf, 1) || buf[0] != ota::OTA_RESPONSE_OK) {
this->log_read_error_("ack"); this->log_read_error_(LOG_STR("ack"));
// do not go to error, this is not fatal // do not go to error, this is not fatal
} }
@@ -477,12 +477,14 @@ float ESPHomeOTAComponent::get_setup_priority() const { return setup_priority::A
uint16_t ESPHomeOTAComponent::get_port() const { return this->port_; } uint16_t ESPHomeOTAComponent::get_port() const { return this->port_; }
void ESPHomeOTAComponent::set_port(uint16_t port) { this->port_ = port; } void ESPHomeOTAComponent::set_port(uint16_t port) { this->port_ = port; }
void ESPHomeOTAComponent::log_socket_error_(const char *msg) { ESP_LOGW(TAG, "Socket %s: errno %d", msg, errno); } void ESPHomeOTAComponent::log_socket_error_(const LogString *msg) {
ESP_LOGW(TAG, "Socket %s: errno %d", LOG_STR_ARG(msg), errno);
}
void ESPHomeOTAComponent::log_read_error_(const char *what) { ESP_LOGW(TAG, "Read %s failed", what); } void ESPHomeOTAComponent::log_read_error_(const LogString *what) { ESP_LOGW(TAG, "Read %s failed", LOG_STR_ARG(what)); }
void ESPHomeOTAComponent::log_start_(const char *phase) { void ESPHomeOTAComponent::log_start_(const LogString *phase) {
ESP_LOGD(TAG, "Starting %s from %s", phase, this->client_->getpeername().c_str()); ESP_LOGD(TAG, "Starting %s from %s", LOG_STR_ARG(phase), this->client_->getpeername().c_str());
} }
void ESPHomeOTAComponent::cleanup_connection_() { void ESPHomeOTAComponent::cleanup_connection_() {

7
esphome/components/esphome/ota/ota_esphome.h
View File

@@ -3,6 +3,7 @@
#include "esphome/core/defines.h" #include "esphome/core/defines.h"
#ifdef USE_OTA #ifdef USE_OTA
#include "esphome/core/helpers.h" #include "esphome/core/helpers.h"
#include "esphome/core/log.h"
#include "esphome/core/preferences.h" #include "esphome/core/preferences.h"
#include "esphome/components/ota/ota_backend.h" #include "esphome/components/ota/ota_backend.h"
#include "esphome/components/socket/socket.h" #include "esphome/components/socket/socket.h"
@@ -31,9 +32,9 @@ class ESPHomeOTAComponent : public ota::OTAComponent {
void handle_data_(); void handle_data_();
bool readall_(uint8_t *buf, size_t len); bool readall_(uint8_t *buf, size_t len);
bool writeall_(const uint8_t *buf, size_t len); bool writeall_(const uint8_t *buf, size_t len);
void log_socket_error_(const char *msg); void log_socket_error_(const LogString *msg);
void log_read_error_(const char *what); void log_read_error_(const LogString *what);
void log_start_(const char *phase); void log_start_(const LogString *phase);
void cleanup_connection_(); void cleanup_connection_();
void yield_and_feed_watchdog_(); void yield_and_feed_watchdog_();