github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-06-24 16:56:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[serial_proxy] Reduce loop() overhead by disabling when idle and splitting read path (#14673)

Browse Source
This commit is contained in:
J. Nick Koston
2026-03-09 21:10:03 -10:00
committed by GitHub
parent e82f0f4432
commit 4b50d14496
2 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
esphome/components/serial_proxy/serial_proxy.cpp
View File

@@ -28,25 +28,38 @@ void SerialProxy::setup() {
// instance_index_ is fixed at registration time; pre-set it so loop() only needs to update data
this->outgoing_msg_.instance = this->instance_index_;
#endif
// No subscriber at startup; disable loop until a client subscribes
this->disable_loop();
}
void SerialProxy::loop() {
#ifdef USE_API
// Detect subscriber disconnect
if (this->api_connection_ != nullptr && (this->api_connection_->is_marked_for_removal() ||
!this->api_connection_->is_connection_setup() || !api_is_connected())) {
ESP_LOGW(TAG, "Subscriber disconnected");
this->api_connection_ = nullptr;
// Safety check — loop should only run when subscribed, but guard against races
if (this->api_connection_ == nullptr) [[unlikely]] {
this->disable_loop();
return;
}
if (this->api_connection_ == nullptr)
// Detect subscriber disconnect
if (this->api_connection_->is_marked_for_removal() || !this->api_connection_->is_connection_setup() ||
!api_is_connected()) {
ESP_LOGW(TAG, "Subscriber disconnected");
this->api_connection_ = nullptr;
this->disable_loop();
return;
}
// Read available data from UART and forward to subscribed client
size_t available = this->available();
if (available == 0)
return;
this->read_and_send_(available);
#endif
}
#ifdef USE_API
void __attribute__((noinline)) SerialProxy::read_and_send_(size_t available) {
// Read in chunks up to SERIAL_PROXY_MAX_READ_SIZE
uint8_t buffer[SERIAL_PROXY_MAX_READ_SIZE];
size_t to_read = std::min(available, sizeof(buffer));
@@ -56,8 +69,8 @@ void SerialProxy::loop() {
this->outgoing_msg_.set_data(buffer, to_read);
this->api_connection_->send_serial_proxy_data(this->outgoing_msg_);
#endif
}
#endif
void SerialProxy::dump_config() {
ESP_LOGCONFIG(TAG,
@@ -166,6 +179,7 @@ void SerialProxy::serial_proxy_request(api::APIConnection *api_connection, api::
return;
}
this->api_connection_ = api_connection;
this->enable_loop();
ESP_LOGV(TAG, "API connection subscribed to serial proxy [%u]", this->instance_index_);
break;
case api::enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE:
@@ -174,6 +188,7 @@ void SerialProxy::serial_proxy_request(api::APIConnection *api_connection, api::
return;
}
this->api_connection_ = nullptr;
this->disable_loop();
ESP_LOGV(TAG, "API connection unsubscribed from serial proxy [%u]", this->instance_index_);
break;
default:

5
esphome/components/serial_proxy/serial_proxy.h
View File

@@ -101,6 +101,11 @@ class SerialProxy : public uart::UARTDevice, public Component {
void set_dtr_pin(GPIOPin *pin) { this->dtr_pin_ = pin; }
protected:
#ifdef USE_API
/// Read from UART and send to API client (slow path with 256-byte stack buffer)
void read_and_send_(size_t available);
#endif
/// Instance index for identifying this proxy in API messages
uint32_t instance_index_{0};