From fefcb45e1f569fb7eb9f3bbd7c27446436c98562 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sat, 17 May 2025 22:50:06 -0400 Subject: [PATCH 01/82] Bump cryptography to 45.0.1 (#8826) --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d867610c5b..498834ddb1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ async_timeout==5.0.1; python_version <= "3.10" -cryptography==44.0.2 +cryptography==45.0.1 voluptuous==0.15.2 PyYAML==6.0.2 paho-mqtt==1.6.1 From e87b65948352a559457f96fb2cd0b6ac942f25f8 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Sat, 17 May 2025 22:05:03 -0500 Subject: [PATCH 02/82] [sen5x] Fix validation for values read from hardware (#8769) --- esphome/components/sen5x/sen5x.cpp | 89 ++++++++++++++++++------------ 1 file changed, 54 insertions(+), 35 deletions(-) diff --git a/esphome/components/sen5x/sen5x.cpp b/esphome/components/sen5x/sen5x.cpp index 0efc961943..f29ba18d6e 100644 --- a/esphome/components/sen5x/sen5x.cpp +++ b/esphome/components/sen5x/sen5x.cpp @@ -25,6 +25,10 @@ static const uint16_t SEN5X_CMD_TEMPERATURE_COMPENSATION = 0x60B2; static const uint16_t SEN5X_CMD_VOC_ALGORITHM_STATE = 0x6181; static const uint16_t SEN5X_CMD_VOC_ALGORITHM_TUNING = 0x60D0; +static const int8_t SEN5X_INDEX_SCALE_FACTOR = 10; // used for VOC and NOx index values +static const int8_t SEN5X_MIN_INDEX_VALUE = 1 * SEN5X_INDEX_SCALE_FACTOR; // must be adjusted by the scale factor +static const int16_t SEN5X_MAX_INDEX_VALUE = 500 * SEN5X_INDEX_SCALE_FACTOR; // must be adjusted by the scale factor + void SEN5XComponent::setup() { ESP_LOGCONFIG(TAG, "Setting up sen5x..."); @@ -88,8 +92,9 @@ void SEN5XComponent::setup() { product_name_.push_back(current_char); // second char current_char = *current_int & 0xFF; - if (current_char) + if (current_char) { product_name_.push_back(current_char); + } } current_int++; } while (current_char && --max); @@ -271,10 +276,10 @@ void SEN5XComponent::dump_config() { ESP_LOGCONFIG(TAG, " Low RH/T acceleration mode"); break; case MEDIUM_ACCELERATION: - ESP_LOGCONFIG(TAG, " Medium RH/T accelertion mode"); + ESP_LOGCONFIG(TAG, " Medium RH/T acceleration mode"); break; case HIGH_ACCELERATION: - ESP_LOGCONFIG(TAG, " High RH/T accelertion mode"); + ESP_LOGCONFIG(TAG, " High RH/T acceleration mode"); break; } } @@ -337,47 +342,61 @@ void SEN5XComponent::update() { ESP_LOGD(TAG, "read data error (%d)", this->last_error_); return; } - float pm_1_0 = measurements[0] / 10.0; - if (measurements[0] == 0xFFFF) - pm_1_0 = NAN; - float pm_2_5 = measurements[1] / 10.0; - if (measurements[1] == 0xFFFF) - pm_2_5 = NAN; - float pm_4_0 = measurements[2] / 10.0; - if (measurements[2] == 0xFFFF) - pm_4_0 = NAN; - float pm_10_0 = measurements[3] / 10.0; - if (measurements[3] == 0xFFFF) - pm_10_0 = NAN; - float humidity = measurements[4] / 100.0; - if (measurements[4] == 0xFFFF) - humidity = NAN; - float temperature = (int16_t) measurements[5] / 200.0; - if (measurements[5] == 0xFFFF) - temperature = NAN; - float voc = measurements[6] / 10.0; - if (measurements[6] == 0xFFFF) - voc = NAN; - float nox = measurements[7] / 10.0; - if (measurements[7] == 0xFFFF) - nox = NAN; - if (this->pm_1_0_sensor_ != nullptr) + ESP_LOGVV(TAG, "pm_1_0 = 0x%.4x", measurements[0]); + float pm_1_0 = measurements[0] == UINT16_MAX ? NAN : measurements[0] / 10.0f; + + ESP_LOGVV(TAG, "pm_2_5 = 0x%.4x", measurements[1]); + float pm_2_5 = measurements[1] == UINT16_MAX ? NAN : measurements[1] / 10.0f; + + ESP_LOGVV(TAG, "pm_4_0 = 0x%.4x", measurements[2]); + float pm_4_0 = measurements[2] == UINT16_MAX ? NAN : measurements[2] / 10.0f; + + ESP_LOGVV(TAG, "pm_10_0 = 0x%.4x", measurements[3]); + float pm_10_0 = measurements[3] == UINT16_MAX ? NAN : measurements[3] / 10.0f; + + ESP_LOGVV(TAG, "humidity = 0x%.4x", measurements[4]); + float humidity = measurements[4] == INT16_MAX ? NAN : static_cast(measurements[4]) / 100.0f; + + ESP_LOGVV(TAG, "temperature = 0x%.4x", measurements[5]); + float temperature = measurements[5] == INT16_MAX ? NAN : static_cast(measurements[5]) / 200.0f; + + ESP_LOGVV(TAG, "voc = 0x%.4x", measurements[6]); + int16_t voc_idx = static_cast(measurements[6]); + float voc = (voc_idx < SEN5X_MIN_INDEX_VALUE || voc_idx > SEN5X_MAX_INDEX_VALUE) + ? NAN + : static_cast(voc_idx) / 10.0f; + + ESP_LOGVV(TAG, "nox = 0x%.4x", measurements[7]); + int16_t nox_idx = static_cast(measurements[7]); + float nox = (nox_idx < SEN5X_MIN_INDEX_VALUE || nox_idx > SEN5X_MAX_INDEX_VALUE) + ? NAN + : static_cast(nox_idx) / 10.0f; + + if (this->pm_1_0_sensor_ != nullptr) { this->pm_1_0_sensor_->publish_state(pm_1_0); - if (this->pm_2_5_sensor_ != nullptr) + } + if (this->pm_2_5_sensor_ != nullptr) { this->pm_2_5_sensor_->publish_state(pm_2_5); - if (this->pm_4_0_sensor_ != nullptr) + } + if (this->pm_4_0_sensor_ != nullptr) { this->pm_4_0_sensor_->publish_state(pm_4_0); - if (this->pm_10_0_sensor_ != nullptr) + } + if (this->pm_10_0_sensor_ != nullptr) { this->pm_10_0_sensor_->publish_state(pm_10_0); - if (this->temperature_sensor_ != nullptr) + } + if (this->temperature_sensor_ != nullptr) { this->temperature_sensor_->publish_state(temperature); - if (this->humidity_sensor_ != nullptr) + } + if (this->humidity_sensor_ != nullptr) { this->humidity_sensor_->publish_state(humidity); - if (this->voc_sensor_ != nullptr) + } + if (this->voc_sensor_ != nullptr) { this->voc_sensor_->publish_state(voc); - if (this->nox_sensor_ != nullptr) + } + if (this->nox_sensor_ != nullptr) { this->nox_sensor_->publish_state(nox); + } this->status_clear_warning(); }); } From 18ac1b7c549ed4e3fe3e55dfdb81fc5bbb08a729 Mon Sep 17 00:00:00 2001 From: Anton Sergunov Date: Sun, 18 May 2025 09:11:09 +0600 Subject: [PATCH 03/82] Fix the case of single error (#8824) --- esphome/voluptuous_schema.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/esphome/voluptuous_schema.py b/esphome/voluptuous_schema.py index 15f9206f21..8fb966e3b2 100644 --- a/esphome/voluptuous_schema.py +++ b/esphome/voluptuous_schema.py @@ -15,7 +15,9 @@ class ExtraKeysInvalid(vol.Invalid): def ensure_multiple_invalid(err): if isinstance(err, vol.MultipleInvalid): return err - return vol.MultipleInvalid(err) + if isinstance(err, list): + return vol.MultipleInvalid(err) + return vol.MultipleInvalid([err]) # pylint: disable=protected-access, unidiomatic-typecheck From 44470f31f60d708abd74b262330173fdea1c048e Mon Sep 17 00:00:00 2001 From: Clyde Stubbs <2366188+clydebarrow@users.noreply.github.com> Date: Sun, 18 May 2025 13:30:08 +1000 Subject: [PATCH 04/82] Revert "[binary_sensor] initial state refactor" (#8828) --- .../binary_sensor/binary_sensor.cpp | 16 ++++--- .../components/binary_sensor/binary_sensor.h | 2 +- esphome/components/binary_sensor/filter.cpp | 42 +++++++++---------- esphome/components/binary_sensor/filter.h | 20 ++++----- 4 files changed, 42 insertions(+), 38 deletions(-) diff --git a/esphome/components/binary_sensor/binary_sensor.cpp b/esphome/components/binary_sensor/binary_sensor.cpp index 30fbe4f0b4..20604a0b7e 100644 --- a/esphome/components/binary_sensor/binary_sensor.cpp +++ b/esphome/components/binary_sensor/binary_sensor.cpp @@ -15,17 +15,21 @@ void BinarySensor::publish_state(bool state) { if (!this->publish_dedup_.next(state)) return; if (this->filter_list_ == nullptr) { - this->send_state_internal(state); + this->send_state_internal(state, false); } else { - this->filter_list_->input(state); + this->filter_list_->input(state, false); } } void BinarySensor::publish_initial_state(bool state) { - this->has_state_ = false; - this->publish_state(state); + if (!this->publish_dedup_.next(state)) + return; + if (this->filter_list_ == nullptr) { + this->send_state_internal(state, true); + } else { + this->filter_list_->input(state, true); + } } -void BinarySensor::send_state_internal(bool state) { - bool is_initial = !this->has_state_; +void BinarySensor::send_state_internal(bool state, bool is_initial) { if (is_initial) { ESP_LOGD(TAG, "'%s': Sending initial state %s", this->get_name().c_str(), ONOFF(state)); } else { diff --git a/esphome/components/binary_sensor/binary_sensor.h b/esphome/components/binary_sensor/binary_sensor.h index 9ba7aeeeff..57cae9e2f5 100644 --- a/esphome/components/binary_sensor/binary_sensor.h +++ b/esphome/components/binary_sensor/binary_sensor.h @@ -67,7 +67,7 @@ class BinarySensor : public EntityBase, public EntityBase_DeviceClass { // ========== INTERNAL METHODS ========== // (In most use cases you won't need these) - void send_state_internal(bool state); + void send_state_internal(bool state, bool is_initial); /// Return whether this binary sensor has outputted a state. virtual bool has_state() const; diff --git a/esphome/components/binary_sensor/filter.cpp b/esphome/components/binary_sensor/filter.cpp index fd6cc31008..8f94b108ac 100644 --- a/esphome/components/binary_sensor/filter.cpp +++ b/esphome/components/binary_sensor/filter.cpp @@ -9,37 +9,37 @@ namespace binary_sensor { static const char *const TAG = "sensor.filter"; -void Filter::output(bool value) { +void Filter::output(bool value, bool is_initial) { if (!this->dedup_.next(value)) return; if (this->next_ == nullptr) { - this->parent_->send_state_internal(value); + this->parent_->send_state_internal(value, is_initial); } else { - this->next_->input(value); + this->next_->input(value, is_initial); } } -void Filter::input(bool value) { - auto b = this->new_value(value); +void Filter::input(bool value, bool is_initial) { + auto b = this->new_value(value, is_initial); if (b.has_value()) { - this->output(*b); + this->output(*b, is_initial); } } -optional DelayedOnOffFilter::new_value(bool value) { +optional DelayedOnOffFilter::new_value(bool value, bool is_initial) { if (value) { - this->set_timeout("ON_OFF", this->on_delay_.value(), [this]() { this->output(true); }); + this->set_timeout("ON_OFF", this->on_delay_.value(), [this, is_initial]() { this->output(true, is_initial); }); } else { - this->set_timeout("ON_OFF", this->off_delay_.value(), [this]() { this->output(false); }); + this->set_timeout("ON_OFF", this->off_delay_.value(), [this, is_initial]() { this->output(false, is_initial); }); } return {}; } float DelayedOnOffFilter::get_setup_priority() const { return setup_priority::HARDWARE; } -optional DelayedOnFilter::new_value(bool value) { +optional DelayedOnFilter::new_value(bool value, bool is_initial) { if (value) { - this->set_timeout("ON", this->delay_.value(), [this]() { this->output(true); }); + this->set_timeout("ON", this->delay_.value(), [this, is_initial]() { this->output(true, is_initial); }); return {}; } else { this->cancel_timeout("ON"); @@ -49,9 +49,9 @@ optional DelayedOnFilter::new_value(bool value) { float DelayedOnFilter::get_setup_priority() const { return setup_priority::HARDWARE; } -optional DelayedOffFilter::new_value(bool value) { +optional DelayedOffFilter::new_value(bool value, bool is_initial) { if (!value) { - this->set_timeout("OFF", this->delay_.value(), [this]() { this->output(false); }); + this->set_timeout("OFF", this->delay_.value(), [this, is_initial]() { this->output(false, is_initial); }); return {}; } else { this->cancel_timeout("OFF"); @@ -61,11 +61,11 @@ optional DelayedOffFilter::new_value(bool value) { float DelayedOffFilter::get_setup_priority() const { return setup_priority::HARDWARE; } -optional InvertFilter::new_value(bool value) { return !value; } +optional InvertFilter::new_value(bool value, bool is_initial) { return !value; } AutorepeatFilter::AutorepeatFilter(std::vector timings) : timings_(std::move(timings)) {} -optional AutorepeatFilter::new_value(bool value) { +optional AutorepeatFilter::new_value(bool value, bool is_initial) { if (value) { // Ignore if already running if (this->active_timing_ != 0) @@ -101,7 +101,7 @@ void AutorepeatFilter::next_timing_() { void AutorepeatFilter::next_value_(bool val) { const AutorepeatFilterTiming &timing = this->timings_[this->active_timing_ - 2]; - this->output(val); + this->output(val, false); // This is at least the second one so not initial this->set_timeout("ON_OFF", val ? timing.time_on : timing.time_off, [this, val]() { this->next_value_(!val); }); } @@ -109,18 +109,18 @@ float AutorepeatFilter::get_setup_priority() const { return setup_priority::HARD LambdaFilter::LambdaFilter(std::function(bool)> f) : f_(std::move(f)) {} -optional LambdaFilter::new_value(bool value) { return this->f_(value); } +optional LambdaFilter::new_value(bool value, bool is_initial) { return this->f_(value); } -optional SettleFilter::new_value(bool value) { +optional SettleFilter::new_value(bool value, bool is_initial) { if (!this->steady_) { - this->set_timeout("SETTLE", this->delay_.value(), [this, value]() { + this->set_timeout("SETTLE", this->delay_.value(), [this, value, is_initial]() { this->steady_ = true; - this->output(value); + this->output(value, is_initial); }); return {}; } else { this->steady_ = false; - this->output(value); + this->output(value, is_initial); this->set_timeout("SETTLE", this->delay_.value(), [this]() { this->steady_ = true; }); return value; } diff --git a/esphome/components/binary_sensor/filter.h b/esphome/components/binary_sensor/filter.h index 65838da49d..f7342db2fb 100644 --- a/esphome/components/binary_sensor/filter.h +++ b/esphome/components/binary_sensor/filter.h @@ -14,11 +14,11 @@ class BinarySensor; class Filter { public: - virtual optional new_value(bool value) = 0; + virtual optional new_value(bool value, bool is_initial) = 0; - void input(bool value); + void input(bool value, bool is_initial); - void output(bool value); + void output(bool value, bool is_initial); protected: friend BinarySensor; @@ -30,7 +30,7 @@ class Filter { class DelayedOnOffFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -44,7 +44,7 @@ class DelayedOnOffFilter : public Filter, public Component { class DelayedOnFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -56,7 +56,7 @@ class DelayedOnFilter : public Filter, public Component { class DelayedOffFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -68,7 +68,7 @@ class DelayedOffFilter : public Filter, public Component { class InvertFilter : public Filter { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; }; struct AutorepeatFilterTiming { @@ -86,7 +86,7 @@ class AutorepeatFilter : public Filter, public Component { public: explicit AutorepeatFilter(std::vector timings); - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -102,7 +102,7 @@ class LambdaFilter : public Filter { public: explicit LambdaFilter(std::function(bool)> f); - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; protected: std::function(bool)> f_; @@ -110,7 +110,7 @@ class LambdaFilter : public Filter { class SettleFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; From a78bea78f9d7c6ea8f19acf7ae2999fee09075a9 Mon Sep 17 00:00:00 2001 From: Kent Gibson Date: Sun, 18 May 2025 11:45:12 +0800 Subject: [PATCH 05/82] Fix misspelling of climate in climate_ir.climate_ir_with_receiver_schema (#8829) --- esphome/components/ballu/climate.py | 2 +- esphome/components/climate_ir/__init__.py | 6 +++--- esphome/components/climate_ir_lg/climate.py | 2 +- esphome/components/coolix/climate.py | 2 +- esphome/components/daikin/climate.py | 2 +- esphome/components/daikin_arc/climate.py | 2 +- esphome/components/daikin_brc/climate.py | 2 +- esphome/components/delonghi/climate.py | 2 +- esphome/components/emmeti/climate.py | 2 +- esphome/components/fujitsu_general/climate.py | 2 +- esphome/components/gree/climate.py | 2 +- esphome/components/heatpumpir/climate.py | 2 +- esphome/components/hitachi_ac344/climate.py | 2 +- esphome/components/hitachi_ac424/climate.py | 2 +- esphome/components/midea_ir/climate.py | 2 +- esphome/components/mitsubishi/climate.py | 2 +- esphome/components/noblex/climate.py | 2 +- esphome/components/tcl112/climate.py | 2 +- esphome/components/toshiba/climate.py | 2 +- esphome/components/whirlpool/climate.py | 2 +- esphome/components/whynter/climate.py | 2 +- esphome/components/zhlt01/climate.py | 2 +- 22 files changed, 24 insertions(+), 24 deletions(-) diff --git a/esphome/components/ballu/climate.py b/esphome/components/ballu/climate.py index e35a1d244d..1127084632 100644 --- a/esphome/components/ballu/climate.py +++ b/esphome/components/ballu/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@bazuchan"] ballu_ns = cg.esphome_ns.namespace("ballu") BalluClimate = ballu_ns.class_("BalluClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(BalluClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(BalluClimate) async def to_code(config): diff --git a/esphome/components/climate_ir/__init__.py b/esphome/components/climate_ir/__init__.py index 32b614e933..312b2ad900 100644 --- a/esphome/components/climate_ir/__init__.py +++ b/esphome/components/climate_ir/__init__.py @@ -40,7 +40,7 @@ def climate_ir_schema( ) -def climare_ir_with_receiver_schema( +def climate_ir_with_receiver_schema( class_: MockObjClass, ) -> cv.Schema: return climate_ir_schema(class_).extend( @@ -59,7 +59,7 @@ def deprecated_schema_constant(config): type = str(id.type).split("::", maxsplit=1)[0] _LOGGER.warning( "Using `climate_ir.CLIMATE_IR_WITH_RECEIVER_SCHEMA` is deprecated and will be removed in ESPHome 2025.11.0. " - "Please use `climate_ir.climare_ir_with_receiver_schema(...)` instead. " + "Please use `climate_ir.climate_ir_with_receiver_schema(...)` instead. " "If you are seeing this, report an issue to the external_component author and ask them to update it. " "https://developers.esphome.io/blog/2025/05/14/_schema-deprecations/. " "Component using this schema: %s", @@ -68,7 +68,7 @@ def deprecated_schema_constant(config): return config -CLIMATE_IR_WITH_RECEIVER_SCHEMA = climare_ir_with_receiver_schema(ClimateIR) +CLIMATE_IR_WITH_RECEIVER_SCHEMA = climate_ir_with_receiver_schema(ClimateIR) CLIMATE_IR_WITH_RECEIVER_SCHEMA.add_extra(deprecated_schema_constant) diff --git a/esphome/components/climate_ir_lg/climate.py b/esphome/components/climate_ir_lg/climate.py index de824bfe5c..9c832642ce 100644 --- a/esphome/components/climate_ir_lg/climate.py +++ b/esphome/components/climate_ir_lg/climate.py @@ -13,7 +13,7 @@ CONF_BIT_HIGH = "bit_high" CONF_BIT_ONE_LOW = "bit_one_low" CONF_BIT_ZERO_LOW = "bit_zero_low" -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(LgIrClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(LgIrClimate).extend( { cv.Optional( CONF_HEADER_HIGH, default="8000us" diff --git a/esphome/components/coolix/climate.py b/esphome/components/coolix/climate.py index b280544a5c..1ebcff3c1b 100644 --- a/esphome/components/coolix/climate.py +++ b/esphome/components/coolix/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@glmnet"] coolix_ns = cg.esphome_ns.namespace("coolix") CoolixClimate = coolix_ns.class_("CoolixClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(CoolixClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(CoolixClimate) async def to_code(config): diff --git a/esphome/components/daikin/climate.py b/esphome/components/daikin/climate.py index 2cd44969c1..7f0226143b 100644 --- a/esphome/components/daikin/climate.py +++ b/esphome/components/daikin/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] daikin_ns = cg.esphome_ns.namespace("daikin") DaikinClimate = daikin_ns.class_("DaikinClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DaikinClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DaikinClimate) async def to_code(config): diff --git a/esphome/components/daikin_arc/climate.py b/esphome/components/daikin_arc/climate.py index 8f6b07315d..dbaf12d959 100644 --- a/esphome/components/daikin_arc/climate.py +++ b/esphome/components/daikin_arc/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] daikin_arc_ns = cg.esphome_ns.namespace("daikin_arc") DaikinArcClimate = daikin_arc_ns.class_("DaikinArcClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DaikinArcClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DaikinArcClimate) async def to_code(config): diff --git a/esphome/components/daikin_brc/climate.py b/esphome/components/daikin_brc/climate.py index 1000784380..5b7a4631a9 100644 --- a/esphome/components/daikin_brc/climate.py +++ b/esphome/components/daikin_brc/climate.py @@ -9,7 +9,7 @@ daikin_brc_ns = cg.esphome_ns.namespace("daikin_brc") DaikinBrcClimate = daikin_brc_ns.class_("DaikinBrcClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DaikinBrcClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DaikinBrcClimate).extend( { cv.Optional(CONF_USE_FAHRENHEIT, default=False): cv.boolean, } diff --git a/esphome/components/delonghi/climate.py b/esphome/components/delonghi/climate.py index ff878b4ff7..63576f032d 100644 --- a/esphome/components/delonghi/climate.py +++ b/esphome/components/delonghi/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] delonghi_ns = cg.esphome_ns.namespace("delonghi") DelonghiClimate = delonghi_ns.class_("DelonghiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DelonghiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DelonghiClimate) async def to_code(config): diff --git a/esphome/components/emmeti/climate.py b/esphome/components/emmeti/climate.py index 042f1af64b..56e8e2b804 100644 --- a/esphome/components/emmeti/climate.py +++ b/esphome/components/emmeti/climate.py @@ -7,7 +7,7 @@ AUTO_LOAD = ["climate_ir"] emmeti_ns = cg.esphome_ns.namespace("emmeti") EmmetiClimate = emmeti_ns.class_("EmmetiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(EmmetiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(EmmetiClimate) async def to_code(config): diff --git a/esphome/components/fujitsu_general/climate.py b/esphome/components/fujitsu_general/climate.py index 0f028d0af3..a104eafbcc 100644 --- a/esphome/components/fujitsu_general/climate.py +++ b/esphome/components/fujitsu_general/climate.py @@ -8,7 +8,7 @@ FujitsuGeneralClimate = fujitsu_general_ns.class_( "FujitsuGeneralClimate", climate_ir.ClimateIR ) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(FujitsuGeneralClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(FujitsuGeneralClimate) async def to_code(config): diff --git a/esphome/components/gree/climate.py b/esphome/components/gree/climate.py index 947ef9bb97..057ba67b94 100644 --- a/esphome/components/gree/climate.py +++ b/esphome/components/gree/climate.py @@ -21,7 +21,7 @@ MODELS = { "yag": Model.GREE_YAG, } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(GreeClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(GreeClimate).extend( { cv.Required(CONF_MODEL): cv.enum(MODELS), } diff --git a/esphome/components/heatpumpir/climate.py b/esphome/components/heatpumpir/climate.py index 21b0168615..c0eb8db4b3 100644 --- a/esphome/components/heatpumpir/climate.py +++ b/esphome/components/heatpumpir/climate.py @@ -97,7 +97,7 @@ VERTICAL_DIRECTIONS = { } CONFIG_SCHEMA = cv.All( - climate_ir.climare_ir_with_receiver_schema(HeatpumpIRClimate).extend( + climate_ir.climate_ir_with_receiver_schema(HeatpumpIRClimate).extend( { cv.Required(CONF_PROTOCOL): cv.enum(PROTOCOLS), cv.Required(CONF_HORIZONTAL_DEFAULT): cv.enum(HORIZONTAL_DIRECTIONS), diff --git a/esphome/components/hitachi_ac344/climate.py b/esphome/components/hitachi_ac344/climate.py index 4fa2d54fbb..ebdf4e8db4 100644 --- a/esphome/components/hitachi_ac344/climate.py +++ b/esphome/components/hitachi_ac344/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] hitachi_ac344_ns = cg.esphome_ns.namespace("hitachi_ac344") HitachiClimate = hitachi_ac344_ns.class_("HitachiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(HitachiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(HitachiClimate) async def to_code(config): diff --git a/esphome/components/hitachi_ac424/climate.py b/esphome/components/hitachi_ac424/climate.py index 4b20147922..fde4e77545 100644 --- a/esphome/components/hitachi_ac424/climate.py +++ b/esphome/components/hitachi_ac424/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] hitachi_ac424_ns = cg.esphome_ns.namespace("hitachi_ac424") HitachiClimate = hitachi_ac424_ns.class_("HitachiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(HitachiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(HitachiClimate) async def to_code(config): diff --git a/esphome/components/midea_ir/climate.py b/esphome/components/midea_ir/climate.py index 5c9256b5e4..cbf5fae6fe 100644 --- a/esphome/components/midea_ir/climate.py +++ b/esphome/components/midea_ir/climate.py @@ -10,7 +10,7 @@ midea_ir_ns = cg.esphome_ns.namespace("midea_ir") MideaIR = midea_ir_ns.class_("MideaIR", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(MideaIR).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(MideaIR).extend( { cv.Optional(CONF_USE_FAHRENHEIT, default=False): cv.boolean, } diff --git a/esphome/components/mitsubishi/climate.py b/esphome/components/mitsubishi/climate.py index 5784d3ee8a..8291d70346 100644 --- a/esphome/components/mitsubishi/climate.py +++ b/esphome/components/mitsubishi/climate.py @@ -43,7 +43,7 @@ VERTICAL_DIRECTIONS = { } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(MitsubishiClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(MitsubishiClimate).extend( { cv.Optional(CONF_SET_FAN_MODE, default="3levels"): cv.enum(SETFANMODE), cv.Optional(CONF_SUPPORTS_DRY, default=False): cv.boolean, diff --git a/esphome/components/noblex/climate.py b/esphome/components/noblex/climate.py index d619265d01..19c4b6a08e 100644 --- a/esphome/components/noblex/climate.py +++ b/esphome/components/noblex/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] noblex_ns = cg.esphome_ns.namespace("noblex") NoblexClimate = noblex_ns.class_("NoblexClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(NoblexClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(NoblexClimate) async def to_code(config): diff --git a/esphome/components/tcl112/climate.py b/esphome/components/tcl112/climate.py index 9864113a52..58ed7ee529 100644 --- a/esphome/components/tcl112/climate.py +++ b/esphome/components/tcl112/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@glmnet"] tcl112_ns = cg.esphome_ns.namespace("tcl112") Tcl112Climate = tcl112_ns.class_("Tcl112Climate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(Tcl112Climate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(Tcl112Climate) async def to_code(config): diff --git a/esphome/components/toshiba/climate.py b/esphome/components/toshiba/climate.py index 40112fc460..b8e390dd66 100644 --- a/esphome/components/toshiba/climate.py +++ b/esphome/components/toshiba/climate.py @@ -16,7 +16,7 @@ MODELS = { "RAC-PT1411HWRU-F": Model.MODEL_RAC_PT1411HWRU_F, } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(ToshibaClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(ToshibaClimate).extend( { cv.Optional(CONF_MODEL, default="generic"): cv.enum(MODELS, upper=True), } diff --git a/esphome/components/whirlpool/climate.py b/esphome/components/whirlpool/climate.py index daee9e7fb7..f969a505fb 100644 --- a/esphome/components/whirlpool/climate.py +++ b/esphome/components/whirlpool/climate.py @@ -15,7 +15,7 @@ MODELS = { "DG11J1-91": Model.MODEL_DG11J1_91, } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(WhirlpoolClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(WhirlpoolClimate).extend( { cv.Optional(CONF_MODEL, default="DG11J1-3A"): cv.enum(MODELS, upper=True), } diff --git a/esphome/components/whynter/climate.py b/esphome/components/whynter/climate.py index 4a01c014c7..bf33890d9c 100644 --- a/esphome/components/whynter/climate.py +++ b/esphome/components/whynter/climate.py @@ -9,7 +9,7 @@ whynter_ns = cg.esphome_ns.namespace("whynter") Whynter = whynter_ns.class_("Whynter", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(Whynter).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(Whynter).extend( { cv.Optional(CONF_USE_FAHRENHEIT, default=False): cv.boolean, } diff --git a/esphome/components/zhlt01/climate.py b/esphome/components/zhlt01/climate.py index d5098ab42c..8d0c50308b 100644 --- a/esphome/components/zhlt01/climate.py +++ b/esphome/components/zhlt01/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@cfeenstra1024"] zhlt01_ns = cg.esphome_ns.namespace("zhlt01") ZHLT01Climate = zhlt01_ns.class_("ZHLT01Climate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(ZHLT01Climate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(ZHLT01Climate) async def to_code(config): From e47741d47174bca80b531a2b6ffd6017951cfcb9 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sun, 18 May 2025 15:43:41 -0400 Subject: [PATCH 06/82] Fix ESP32 console logging corruption and message loss in multi-task (#8806) --- esphome/components/logger/logger.cpp | 44 +++++++++++++++++++--------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/esphome/components/logger/logger.cpp b/esphome/components/logger/logger.cpp index 0ad909cb07..014f7e3dec 100644 --- a/esphome/components/logger/logger.cpp +++ b/esphome/components/logger/logger.cpp @@ -16,9 +16,14 @@ static const char *const TAG = "logger"; #ifdef USE_ESP32 // Implementation for ESP32 (multi-task platform with task-specific tracking) // Main task always uses direct buffer access for console output and callbacks -// Other tasks: -// - With task log buffer: stack buffer for console output, async buffer for callbacks -// - Without task log buffer: only console output, no callbacks +// +// For non-main tasks: +// - WITH task log buffer: Prefer sending to ring buffer for async processing +// - Avoids allocating stack memory for console output in normal operation +// - Prevents console corruption from concurrent writes by multiple tasks +// - Messages are serialized through main loop for proper console output +// - Fallback to emergency console logging only if ring buffer is full +// - WITHOUT task log buffer: Only emergency console output, no callbacks void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char *format, va_list args) { // NOLINT if (level > this->level_for(tag)) return; @@ -38,8 +43,18 @@ void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char * return; } - // For non-main tasks: use stack-allocated buffer only for console output - if (this->baud_rate_ > 0) { // If logging is enabled, write to console + bool message_sent = false; +#ifdef USE_ESPHOME_TASK_LOG_BUFFER + // For non-main tasks, queue the message for callbacks - but only if we have any callbacks registered + message_sent = this->log_buffer_->send_message_thread_safe(static_cast(level), tag, + static_cast(line), current_task, format, args); +#endif // USE_ESPHOME_TASK_LOG_BUFFER + + // Emergency console logging for non-main tasks when ring buffer is full or disabled + // This is a fallback mechanism to ensure critical log messages are visible + // Note: This may cause interleaved/corrupted console output if multiple tasks + // log simultaneously, but it's better than losing important messages entirely + if (!message_sent && this->baud_rate_ > 0) { // If logging is enabled, write to console // Maximum size for console log messages (includes null terminator) static const size_t MAX_CONSOLE_LOG_MSG_SIZE = 144; char console_buffer[MAX_CONSOLE_LOG_MSG_SIZE]; // MUST be stack allocated for thread safety @@ -49,15 +64,6 @@ void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char * this->write_msg_(console_buffer); } -#ifdef USE_ESPHOME_TASK_LOG_BUFFER - // For non-main tasks, queue the message for callbacks - but only if we have any callbacks registered - if (this->log_callback_.size() > 0) { - // This will be processed in the main loop - this->log_buffer_->send_message_thread_safe(static_cast(level), tag, static_cast(line), - current_task, format, args); - } -#endif // USE_ESPHOME_TASK_LOG_BUFFER - // Reset the recursion guard for this task this->reset_task_log_recursion_(is_main_task); } @@ -184,7 +190,17 @@ void Logger::loop() { this->write_footer_to_buffer_(this->tx_buffer_, &this->tx_buffer_at_, this->tx_buffer_size_); this->tx_buffer_[this->tx_buffer_at_] = '\0'; this->call_log_callbacks_(message->level, message->tag, this->tx_buffer_); + // At this point all the data we need from message has been transferred to the tx_buffer + // so we can release the message to allow other tasks to use it as soon as possible. this->log_buffer_->release_message_main_loop(received_token); + + // Write to console from the main loop to prevent corruption from concurrent writes + // This ensures all log messages appear on the console in a clean, serialized manner + // Note: Messages may appear slightly out of order due to async processing, but + // this is preferred over corrupted/interleaved console output + if (this->baud_rate_ > 0) { + this->write_msg_(this->tx_buffer_); + } } } #endif From 574aabdedec80ca20dec5a54439a9ad649bf8cb4 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sun, 18 May 2025 15:48:57 -0400 Subject: [PATCH 07/82] Reduce number of calls to fetch time in the main loop (#8804) --- esphome/components/api/api_connection.cpp | 5 +-- esphome/components/bedjet/bedjet_hub.cpp | 1 + .../bluetooth_proxy/bluetooth_proxy.cpp | 3 +- esphome/components/cse7766/cse7766.cpp | 3 +- .../current_based/current_based_cover.cpp | 3 +- esphome/components/daly_bms/daly_bms.cpp | 3 +- esphome/components/debug/debug_component.cpp | 2 +- esphome/components/endstop/endstop_cover.cpp | 3 +- .../components/esp32_ble/ble_advertising.cpp | 3 +- .../components/esp32_camera/esp32_camera.cpp | 3 +- .../esp32_improv/esp32_improv_component.cpp | 2 +- .../components/esp32_touch/esp32_touch.cpp | 2 +- .../ethernet/ethernet_component.cpp | 2 +- .../components/feedback/feedback_cover.cpp | 3 +- esphome/components/gcja5/gcja5.cpp | 3 +- .../growatt_solar/growatt_solar.cpp | 3 +- esphome/components/kuntze/kuntze.cpp | 3 +- .../matrix_keypad/matrix_keypad.cpp | 3 +- .../components/max7219digit/max7219digit.cpp | 3 +- esphome/components/modbus/modbus.cpp | 3 +- esphome/components/mqtt/mqtt_client.cpp | 2 +- esphome/components/pmsx003/pmsx003.cpp | 3 +- esphome/components/pzem004t/pzem004t.cpp | 3 +- esphome/components/rf_bridge/rf_bridge.cpp | 3 +- esphome/components/sds011/sds011.cpp | 3 +- .../components/slow_pwm/slow_pwm_output.cpp | 3 +- esphome/components/sprinkler/sprinkler.cpp | 11 ++++--- .../time_based/time_based_cover.cpp | 3 +- .../components/uart/switch/uart_switch.cpp | 3 +- .../climate/uponor_smatrix_climate.cpp | 3 +- .../uponor_smatrix/uponor_smatrix.cpp | 3 +- esphome/core/application.cpp | 32 +++++++++++++------ esphome/core/application.h | 6 +++- esphome/core/component.cpp | 15 ++++++--- esphome/core/component.h | 6 +++- esphome/core/scheduler.cpp | 5 ++- 36 files changed, 107 insertions(+), 53 deletions(-) diff --git a/esphome/components/api/api_connection.cpp b/esphome/components/api/api_connection.cpp index c377909951..1c945b200f 100644 --- a/esphome/components/api/api_connection.cpp +++ b/esphome/components/api/api_connection.cpp @@ -8,6 +8,7 @@ #include "esphome/core/hal.h" #include "esphome/core/log.h" #include "esphome/core/version.h" +#include "esphome/core/application.h" #ifdef USE_DEEP_SLEEP #include "esphome/components/deep_sleep/deep_sleep_component.h" @@ -146,7 +147,7 @@ void APIConnection::loop() { } return; } else { - this->last_traffic_ = millis(); + this->last_traffic_ = App.get_loop_component_start_time(); // read a packet this->read_message(buffer.data_len, buffer.type, &buffer.container[buffer.data_offset]); if (this->remove_) @@ -165,7 +166,7 @@ void APIConnection::loop() { static uint32_t keepalive = 60000; static uint8_t max_ping_retries = 60; static uint16_t ping_retry_interval = 1000; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->sent_ping_) { // Disconnect if not responded within 2.5*keepalive if (now - this->last_traffic_ > (keepalive * 5) / 2) { diff --git a/esphome/components/bedjet/bedjet_hub.cpp b/esphome/components/bedjet/bedjet_hub.cpp index 6404298697..fea7080de6 100644 --- a/esphome/components/bedjet/bedjet_hub.cpp +++ b/esphome/components/bedjet/bedjet_hub.cpp @@ -3,6 +3,7 @@ #include "bedjet_hub.h" #include "bedjet_child.h" #include "bedjet_const.h" +#include "esphome/core/application.h" #include namespace esphome { diff --git a/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp b/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp index 915d2882d3..d8b2111cb0 100644 --- a/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp +++ b/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp @@ -2,6 +2,7 @@ #include "esphome/core/log.h" #include "esphome/core/macros.h" +#include "esphome/core/application.h" #ifdef USE_ESP32 @@ -177,7 +178,7 @@ void BluetoothProxy::loop() { // Flush any pending BLE advertisements that have been accumulated but not yet sent if (this->raw_advertisements_) { static uint32_t last_flush_time = 0; - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); // Flush accumulated advertisements every 100ms if (now - last_flush_time >= 100) { diff --git a/esphome/components/cse7766/cse7766.cpp b/esphome/components/cse7766/cse7766.cpp index 88a91e374a..b0876778a3 100644 --- a/esphome/components/cse7766/cse7766.cpp +++ b/esphome/components/cse7766/cse7766.cpp @@ -1,5 +1,6 @@ #include "cse7766.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace cse7766 { @@ -7,7 +8,7 @@ namespace cse7766 { static const char *const TAG = "cse7766"; void CSE7766Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_transmission_ >= 500) { // last transmission too long ago. Reset RX index. this->raw_data_index_ = 0; diff --git a/esphome/components/current_based/current_based_cover.cpp b/esphome/components/current_based/current_based_cover.cpp index 8404e07894..8bb27dbeca 100644 --- a/esphome/components/current_based/current_based_cover.cpp +++ b/esphome/components/current_based/current_based_cover.cpp @@ -1,6 +1,7 @@ #include "current_based_cover.h" #include "esphome/core/hal.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include namespace esphome { @@ -60,7 +61,7 @@ void CurrentBasedCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->current_operation == COVER_OPERATION_OPENING) { if (this->malfunction_detection_ && this->is_closing_()) { // Malfunction diff --git a/esphome/components/daly_bms/daly_bms.cpp b/esphome/components/daly_bms/daly_bms.cpp index 929f31e008..1dd0520465 100644 --- a/esphome/components/daly_bms/daly_bms.cpp +++ b/esphome/components/daly_bms/daly_bms.cpp @@ -1,6 +1,7 @@ #include "daly_bms.h" #include #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace daly_bms { @@ -32,7 +33,7 @@ void DalyBmsComponent::update() { } void DalyBmsComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->receiving_ && (now - this->last_transmission_ >= 200)) { // last transmission too long ago. Reset RX index. ESP_LOGW(TAG, "Last transmission too long ago. Reset RX index."); diff --git a/esphome/components/debug/debug_component.cpp b/esphome/components/debug/debug_component.cpp index 5bcc676247..c4de42c7e9 100644 --- a/esphome/components/debug/debug_component.cpp +++ b/esphome/components/debug/debug_component.cpp @@ -70,7 +70,7 @@ void DebugComponent::loop() { #ifdef USE_SENSOR // calculate loop time - from last call to this one if (this->loop_time_sensor_ != nullptr) { - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); uint32_t loop_time = now - this->last_loop_timetag_; this->max_loop_time_ = std::max(this->max_loop_time_, loop_time); this->last_loop_timetag_ = now; diff --git a/esphome/components/endstop/endstop_cover.cpp b/esphome/components/endstop/endstop_cover.cpp index 1190acc46b..381f098eb5 100644 --- a/esphome/components/endstop/endstop_cover.cpp +++ b/esphome/components/endstop/endstop_cover.cpp @@ -1,6 +1,7 @@ #include "endstop_cover.h" #include "esphome/core/log.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" namespace esphome { namespace endstop { @@ -65,7 +66,7 @@ void EndstopCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->current_operation == COVER_OPERATION_OPENING && this->is_open_()) { float dur = (now - this->start_dir_time_) / 1e3f; diff --git a/esphome/components/esp32_ble/ble_advertising.cpp b/esphome/components/esp32_ble/ble_advertising.cpp index 1d340c76d9..8d43b5af33 100644 --- a/esphome/components/esp32_ble/ble_advertising.cpp +++ b/esphome/components/esp32_ble/ble_advertising.cpp @@ -6,6 +6,7 @@ #include #include "ble_uuid.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace esp32_ble { @@ -143,7 +144,7 @@ void BLEAdvertising::loop() { if (this->raw_advertisements_callbacks_.empty()) { return; } - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_advertisement_time_ > this->advertising_cycle_time_) { this->stop(); this->current_adv_index_ += 1; diff --git a/esphome/components/esp32_camera/esp32_camera.cpp b/esphome/components/esp32_camera/esp32_camera.cpp index e9e9d3cffb..60accba747 100644 --- a/esphome/components/esp32_camera/esp32_camera.cpp +++ b/esphome/components/esp32_camera/esp32_camera.cpp @@ -3,6 +3,7 @@ #include "esp32_camera.h" #include "esphome/core/log.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" #include @@ -162,7 +163,7 @@ void ESP32Camera::loop() { } // request idle image every idle_update_interval - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->idle_update_interval_ != 0 && now - this->last_idle_request_ > this->idle_update_interval_) { this->last_idle_request_ = now; this->request_image(IDLE); diff --git a/esphome/components/esp32_improv/esp32_improv_component.cpp b/esphome/components/esp32_improv/esp32_improv_component.cpp index b720425506..d74714838f 100644 --- a/esphome/components/esp32_improv/esp32_improv_component.cpp +++ b/esphome/components/esp32_improv/esp32_improv_component.cpp @@ -92,7 +92,7 @@ void ESP32ImprovComponent::loop() { if (!this->incoming_data_.empty()) this->process_incoming_data_(); - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); switch (this->state_) { case improv::STATE_STOPPED: diff --git a/esphome/components/esp32_touch/esp32_touch.cpp b/esphome/components/esp32_touch/esp32_touch.cpp index 69e4e37cec..1dcb39e5de 100644 --- a/esphome/components/esp32_touch/esp32_touch.cpp +++ b/esphome/components/esp32_touch/esp32_touch.cpp @@ -288,7 +288,7 @@ uint32_t ESP32TouchComponent::component_touch_pad_read(touch_pad_t tp) { } void ESP32TouchComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); bool should_print = this->setup_mode_ && now - this->setup_mode_last_log_print_ > 250; for (auto *child : this->children_) { child->value_ = this->component_touch_pad_read(child->get_touch_pad()); diff --git a/esphome/components/ethernet/ethernet_component.cpp b/esphome/components/ethernet/ethernet_component.cpp index 68a6e617fc..79ef0715d8 100644 --- a/esphome/components/ethernet/ethernet_component.cpp +++ b/esphome/components/ethernet/ethernet_component.cpp @@ -240,7 +240,7 @@ void EthernetComponent::setup() { } void EthernetComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); switch (this->state_) { case EthernetComponentState::STOPPED: diff --git a/esphome/components/feedback/feedback_cover.cpp b/esphome/components/feedback/feedback_cover.cpp index fa3166ba65..e419ee6229 100644 --- a/esphome/components/feedback/feedback_cover.cpp +++ b/esphome/components/feedback/feedback_cover.cpp @@ -1,6 +1,7 @@ #include "feedback_cover.h" #include "esphome/core/hal.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace feedback { @@ -220,7 +221,7 @@ void FeedbackCover::set_open_obstacle_sensor(binary_sensor::BinarySensor *open_o void FeedbackCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Recompute position every loop cycle this->recompute_position_(); diff --git a/esphome/components/gcja5/gcja5.cpp b/esphome/components/gcja5/gcja5.cpp index b1db58654b..64b237515b 100644 --- a/esphome/components/gcja5/gcja5.cpp +++ b/esphome/components/gcja5/gcja5.cpp @@ -6,6 +6,7 @@ */ #include "gcja5.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include namespace esphome { @@ -16,7 +17,7 @@ static const char *const TAG = "gcja5"; void GCJA5Component::setup() { ESP_LOGCONFIG(TAG, "Setting up gcja5..."); } void GCJA5Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_transmission_ >= 500) { // last transmission too long ago. Reset RX index. this->rx_message_.clear(); diff --git a/esphome/components/growatt_solar/growatt_solar.cpp b/esphome/components/growatt_solar/growatt_solar.cpp index c4ed5ab841..60fd1379e8 100644 --- a/esphome/components/growatt_solar/growatt_solar.cpp +++ b/esphome/components/growatt_solar/growatt_solar.cpp @@ -1,5 +1,6 @@ #include "growatt_solar.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace growatt_solar { @@ -18,7 +19,7 @@ void GrowattSolar::loop() { void GrowattSolar::update() { // If our last send has had no reply yet, and it wasn't that long ago, do nothing. - uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_send_ < this->get_update_interval() / 2) { return; } diff --git a/esphome/components/kuntze/kuntze.cpp b/esphome/components/kuntze/kuntze.cpp index e50dafca86..8ab7af8cd9 100644 --- a/esphome/components/kuntze/kuntze.cpp +++ b/esphome/components/kuntze/kuntze.cpp @@ -1,5 +1,6 @@ #include "kuntze.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace kuntze { @@ -60,7 +61,7 @@ void Kuntze::on_modbus_data(const std::vector &data) { } void Kuntze::loop() { - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); // timeout after 15 seconds if (this->waiting_ && (now - this->last_send_ > 15000)) { ESP_LOGW(TAG, "timed out waiting for response"); diff --git a/esphome/components/matrix_keypad/matrix_keypad.cpp b/esphome/components/matrix_keypad/matrix_keypad.cpp index 8537997935..6cb4fc4f3c 100644 --- a/esphome/components/matrix_keypad/matrix_keypad.cpp +++ b/esphome/components/matrix_keypad/matrix_keypad.cpp @@ -1,5 +1,6 @@ #include "matrix_keypad.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace matrix_keypad { @@ -28,7 +29,7 @@ void MatrixKeypad::setup() { void MatrixKeypad::loop() { static uint32_t active_start = 0; static int active_key = -1; - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); int key = -1; bool error = false; int pos = 0, row, col; diff --git a/esphome/components/max7219digit/max7219digit.cpp b/esphome/components/max7219digit/max7219digit.cpp index 13b75ca734..154accd66f 100644 --- a/esphome/components/max7219digit/max7219digit.cpp +++ b/esphome/components/max7219digit/max7219digit.cpp @@ -2,6 +2,7 @@ #include "esphome/core/log.h" #include "esphome/core/helpers.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" #include "max7219font.h" #include @@ -63,7 +64,7 @@ void MAX7219Component::dump_config() { } void MAX7219Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); const uint32_t millis_since_last_scroll = now - this->last_scroll_; const size_t first_line_size = this->max_displaybuffer_[0].size(); // check if the buffer has shrunk past the current position since last update diff --git a/esphome/components/modbus/modbus.cpp b/esphome/components/modbus/modbus.cpp index 47deea83e6..80c2ffe3d6 100644 --- a/esphome/components/modbus/modbus.cpp +++ b/esphome/components/modbus/modbus.cpp @@ -1,6 +1,7 @@ #include "modbus.h" #include "esphome/core/log.h" #include "esphome/core/helpers.h" +#include "esphome/core/application.h" namespace esphome { namespace modbus { @@ -13,7 +14,7 @@ void Modbus::setup() { } } void Modbus::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); while (this->available()) { uint8_t byte; diff --git a/esphome/components/mqtt/mqtt_client.cpp b/esphome/components/mqtt/mqtt_client.cpp index 1fcef3293c..e3722099a7 100644 --- a/esphome/components/mqtt/mqtt_client.cpp +++ b/esphome/components/mqtt/mqtt_client.cpp @@ -345,7 +345,7 @@ void MQTTClientComponent::loop() { this->disconnect_reason_.reset(); } - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); switch (this->state_) { case MQTT_CLIENT_DISABLED: diff --git a/esphome/components/pmsx003/pmsx003.cpp b/esphome/components/pmsx003/pmsx003.cpp index 11626768d8..0abed8a5a4 100644 --- a/esphome/components/pmsx003/pmsx003.cpp +++ b/esphome/components/pmsx003/pmsx003.cpp @@ -1,5 +1,6 @@ #include "pmsx003.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace pmsx003 { @@ -42,7 +43,7 @@ void PMSX003Component::dump_config() { } void PMSX003Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // If we update less often than it takes the device to stabilise, spin the fan down // rather than running it constantly. It does take some time to stabilise, so we diff --git a/esphome/components/pzem004t/pzem004t.cpp b/esphome/components/pzem004t/pzem004t.cpp index 35b66b03f2..356847825e 100644 --- a/esphome/components/pzem004t/pzem004t.cpp +++ b/esphome/components/pzem004t/pzem004t.cpp @@ -1,5 +1,6 @@ #include "pzem004t.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include namespace esphome { @@ -16,7 +17,7 @@ void PZEM004T::setup() { } void PZEM004T::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_read_ > 500 && this->available() < 7) { while (this->available()) this->read(); diff --git a/esphome/components/rf_bridge/rf_bridge.cpp b/esphome/components/rf_bridge/rf_bridge.cpp index 3b3e00a416..52ce037dbe 100644 --- a/esphome/components/rf_bridge/rf_bridge.cpp +++ b/esphome/components/rf_bridge/rf_bridge.cpp @@ -1,5 +1,6 @@ #include "rf_bridge.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include #include @@ -128,7 +129,7 @@ void RFBridgeComponent::write_byte_str_(const std::string &codes) { } void RFBridgeComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_bridge_byte_ > 50) { this->rx_buffer_.clear(); this->last_bridge_byte_ = now; diff --git a/esphome/components/sds011/sds011.cpp b/esphome/components/sds011/sds011.cpp index 0c04ff557f..a34059d85d 100644 --- a/esphome/components/sds011/sds011.cpp +++ b/esphome/components/sds011/sds011.cpp @@ -1,5 +1,6 @@ #include "sds011.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace sds011 { @@ -75,7 +76,7 @@ void SDS011Component::dump_config() { } void SDS011Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if ((now - this->last_transmission_ >= 500) && this->data_index_) { // last transmission too long ago. Reset RX index. ESP_LOGV(TAG, "Last transmission too long ago. Reset RX index."); diff --git a/esphome/components/slow_pwm/slow_pwm_output.cpp b/esphome/components/slow_pwm/slow_pwm_output.cpp index d6b2cdfe12..643294303c 100644 --- a/esphome/components/slow_pwm/slow_pwm_output.cpp +++ b/esphome/components/slow_pwm/slow_pwm_output.cpp @@ -1,5 +1,6 @@ #include "slow_pwm_output.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace slow_pwm { @@ -39,7 +40,7 @@ void SlowPWMOutput::set_output_state_(bool new_state) { } void SlowPWMOutput::loop() { - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); float scaled_state = this->state_ * this->period_; if (now - this->period_start_time_ >= this->period_) { diff --git a/esphome/components/sprinkler/sprinkler.cpp b/esphome/components/sprinkler/sprinkler.cpp index 3cfb5ccdee..50ea3eff51 100644 --- a/esphome/components/sprinkler/sprinkler.cpp +++ b/esphome/components/sprinkler/sprinkler.cpp @@ -20,7 +20,7 @@ SprinklerSwitch::SprinklerSwitch(switch_::Switch *off_switch, switch_::Switch *o bool SprinklerSwitch::is_latching_valve() { return (this->off_switch_ != nullptr) && (this->on_switch_ != nullptr); } void SprinklerSwitch::loop() { - if ((this->pinned_millis_) && (millis() > this->pinned_millis_ + this->pulse_duration_)) { + if ((this->pinned_millis_) && (App.get_loop_component_start_time() > this->pinned_millis_ + this->pulse_duration_)) { this->pinned_millis_ = 0; // reset tracker if (this->off_switch_->state) { this->off_switch_->turn_off(); @@ -148,22 +148,23 @@ SprinklerValveOperator::SprinklerValveOperator(SprinklerValve *valve, Sprinkler : controller_(controller), valve_(valve) {} void SprinklerValveOperator::loop() { - if (millis() >= this->start_millis_) { // dummy check + uint32_t now = App.get_loop_component_start_time(); + if (now >= this->start_millis_) { // dummy check switch (this->state_) { case STARTING: - if (millis() > (this->start_millis_ + this->start_delay_)) { + if (now > (this->start_millis_ + this->start_delay_)) { this->run_(); // start_delay_ has been exceeded, so ensure both valves are on and update the state } break; case ACTIVE: - if (millis() > (this->start_millis_ + this->start_delay_ + this->run_duration_)) { + if (now > (this->start_millis_ + this->start_delay_ + this->run_duration_)) { this->stop(); // start_delay_ + run_duration_ has been exceeded, start shutting down } break; case STOPPING: - if (millis() > (this->stop_millis_ + this->stop_delay_)) { + if (now > (this->stop_millis_ + this->stop_delay_)) { this->kill_(); // stop_delay_has been exceeded, ensure all valves are off } break; diff --git a/esphome/components/time_based/time_based_cover.cpp b/esphome/components/time_based/time_based_cover.cpp index e1936d5ee1..ec219d6db7 100644 --- a/esphome/components/time_based/time_based_cover.cpp +++ b/esphome/components/time_based/time_based_cover.cpp @@ -1,6 +1,7 @@ #include "time_based_cover.h" #include "esphome/core/log.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" namespace esphome { namespace time_based { @@ -26,7 +27,7 @@ void TimeBasedCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Recompute position every loop cycle this->recompute_position_(); diff --git a/esphome/components/uart/switch/uart_switch.cpp b/esphome/components/uart/switch/uart_switch.cpp index 1edb54641b..96f50ff50f 100644 --- a/esphome/components/uart/switch/uart_switch.cpp +++ b/esphome/components/uart/switch/uart_switch.cpp @@ -1,5 +1,6 @@ #include "uart_switch.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace uart { @@ -8,7 +9,7 @@ static const char *const TAG = "uart.switch"; void UARTSwitch::loop() { if (this->send_every_) { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_transmission_ > this->send_every_) { this->write_command_(this->state); this->last_transmission_ = now; diff --git a/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp b/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp index 5afc628db3..cc9b8a0f90 100644 --- a/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp +++ b/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp @@ -1,6 +1,7 @@ #include "uponor_smatrix_climate.h" #include "esphome/core/helpers.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace uponor_smatrix { @@ -13,7 +14,7 @@ void UponorSmatrixClimate::dump_config() { } void UponorSmatrixClimate::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Publish state after all update packets are processed if (this->last_data_ != 0 && (now - this->last_data_ > 100) && this->target_temperature_raw_ != 0) { diff --git a/esphome/components/uponor_smatrix/uponor_smatrix.cpp b/esphome/components/uponor_smatrix/uponor_smatrix.cpp index e058de2852..2dbbef72ab 100644 --- a/esphome/components/uponor_smatrix/uponor_smatrix.cpp +++ b/esphome/components/uponor_smatrix/uponor_smatrix.cpp @@ -1,5 +1,6 @@ #include "uponor_smatrix.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace uponor_smatrix { @@ -35,7 +36,7 @@ void UponorSmatrixComponent::dump_config() { } void UponorSmatrixComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Discard stale data if (!this->rx_buffer_.empty() && (now - this->last_rx_ > 50)) { diff --git a/esphome/core/application.cpp b/esphome/core/application.cpp index 3f5a283fd8..a81a2c580c 100644 --- a/esphome/core/application.cpp +++ b/esphome/core/application.cpp @@ -67,22 +67,32 @@ void Application::loop() { uint32_t new_app_state = 0; this->scheduler.call(); - this->feed_wdt(); + + // Get the initial loop time at the start + uint32_t last_op_end_time = millis(); + + // Feed WDT with time + this->feed_wdt(last_op_end_time); + for (Component *component : this->looping_components_) { + // Update the cached time before each component runs + this->loop_component_start_time_ = last_op_end_time; + { this->set_current_component(component); - WarnIfComponentBlockingGuard guard{component}; + WarnIfComponentBlockingGuard guard{component, last_op_end_time}; component->call(); + // Use the finish method to get the current time as the end time + last_op_end_time = guard.finish(); } new_app_state |= component->get_component_state(); this->app_state_ |= new_app_state; - this->feed_wdt(); + this->feed_wdt(last_op_end_time); } this->app_state_ = new_app_state; - const uint32_t now = millis(); - - auto elapsed = now - this->last_loop_; + // Use the last component's end time instead of calling millis() again + auto elapsed = last_op_end_time - this->last_loop_; if (elapsed >= this->loop_interval_ || HighFrequencyLoopRequester::is_high_frequency()) { yield(); } else { @@ -94,7 +104,7 @@ void Application::loop() { delay_time = std::min(next_schedule, delay_time); delay(delay_time); } - this->last_loop_ = now; + this->last_loop_ = last_op_end_time; if (this->dump_config_at_ < this->components_.size()) { if (this->dump_config_at_ == 0) { @@ -109,10 +119,12 @@ void Application::loop() { } } -void IRAM_ATTR HOT Application::feed_wdt() { +void IRAM_ATTR HOT Application::feed_wdt(uint32_t time) { static uint32_t last_feed = 0; - uint32_t now = micros(); - if (now - last_feed > 3000) { + // Use provided time if available, otherwise get current time + uint32_t now = time ? time : millis(); + // Compare in milliseconds (3ms threshold) + if (now - last_feed > 3) { arch_feed_wdt(); last_feed = now; #ifdef USE_STATUS_LED diff --git a/esphome/core/application.h b/esphome/core/application.h index e64e2b7655..aa44d9ba1d 100644 --- a/esphome/core/application.h +++ b/esphome/core/application.h @@ -217,6 +217,9 @@ class Application { std::string get_compilation_time() const { return this->compilation_time_; } + /// Get the cached time in milliseconds from when the current component started its loop execution + inline uint32_t IRAM_ATTR HOT get_loop_component_start_time() const { return this->loop_component_start_time_; } + /** Set the target interval with which to run the loop() calls. * If the loop() method takes longer than the target interval, ESPHome won't * sleep in loop(), but if the time spent in loop() is small than the target, ESPHome @@ -236,7 +239,7 @@ class Application { void schedule_dump_config() { this->dump_config_at_ = 0; } - void feed_wdt(); + void feed_wdt(uint32_t time = 0); void reboot(); @@ -551,6 +554,7 @@ class Application { size_t dump_config_at_{SIZE_MAX}; uint32_t app_state_{0}; Component *current_component_{nullptr}; + uint32_t loop_component_start_time_{0}; }; /// Global storage of Application pointer - only one Application can exist. diff --git a/esphome/core/component.cpp b/esphome/core/component.cpp index a7e451b93d..1141e4067d 100644 --- a/esphome/core/component.cpp +++ b/esphome/core/component.cpp @@ -240,10 +240,12 @@ void PollingComponent::stop_poller() { uint32_t PollingComponent::get_update_interval() const { return this->update_interval_; } void PollingComponent::set_update_interval(uint32_t update_interval) { this->update_interval_ = update_interval; } -WarnIfComponentBlockingGuard::WarnIfComponentBlockingGuard(Component *component) - : started_(millis()), component_(component) {} -WarnIfComponentBlockingGuard::~WarnIfComponentBlockingGuard() { - uint32_t blocking_time = millis() - this->started_; +WarnIfComponentBlockingGuard::WarnIfComponentBlockingGuard(Component *component, uint32_t start_time) + : started_(start_time), component_(component) {} +uint32_t WarnIfComponentBlockingGuard::finish() { + uint32_t curr_time = millis(); + + uint32_t blocking_time = curr_time - this->started_; bool should_warn; if (this->component_ != nullptr) { should_warn = this->component_->should_warn_of_blocking(blocking_time); @@ -254,8 +256,11 @@ WarnIfComponentBlockingGuard::~WarnIfComponentBlockingGuard() { const char *src = component_ == nullptr ? "" : component_->get_component_source(); ESP_LOGW(TAG, "Component %s took a long time for an operation (%" PRIu32 " ms).", src, blocking_time); ESP_LOGW(TAG, "Components should block for at most 30 ms."); - ; } + + return curr_time; } +WarnIfComponentBlockingGuard::~WarnIfComponentBlockingGuard() {} + } // namespace esphome diff --git a/esphome/core/component.h b/esphome/core/component.h index 412074282d..7b3e12eb59 100644 --- a/esphome/core/component.h +++ b/esphome/core/component.h @@ -339,7 +339,11 @@ class PollingComponent : public Component { class WarnIfComponentBlockingGuard { public: - WarnIfComponentBlockingGuard(Component *component); + WarnIfComponentBlockingGuard(Component *component, uint32_t start_time); + + // Finish the timing operation and return the current time + uint32_t finish(); + ~WarnIfComponentBlockingGuard(); protected: diff --git a/esphome/core/scheduler.cpp b/esphome/core/scheduler.cpp index b4f617d405..2dea450ead 100644 --- a/esphome/core/scheduler.cpp +++ b/esphome/core/scheduler.cpp @@ -229,8 +229,11 @@ void HOT Scheduler::call() { // - timeouts/intervals get added, potentially invalidating vector pointers // - timeouts/intervals get cancelled { - WarnIfComponentBlockingGuard guard{item->component}; + uint32_t now_ms = millis(); + WarnIfComponentBlockingGuard guard{item->component, now_ms}; item->callback(); + // Call finish to ensure blocking time is properly calculated and reported + guard.finish(); } } From b0c1e0e28ce8633de259a02bd9a1c9ec7b87e1c9 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sun, 18 May 2025 17:05:20 -0400 Subject: [PATCH 08/82] Refactor API frame helpers to enable buffer reuse (#8825) --- esphome/components/api/api_connection.cpp | 2 +- esphome/components/api/api_connection.h | 9 +- esphome/components/api/api_frame_helper.cpp | 128 ++++++++++++++------ esphome/components/api/api_frame_helper.h | 41 ++++++- esphome/components/api/proto.h | 28 +++++ 5 files changed, 162 insertions(+), 46 deletions(-) diff --git a/esphome/components/api/api_connection.cpp b/esphome/components/api/api_connection.cpp index 1c945b200f..b7db88e6ba 100644 --- a/esphome/components/api/api_connection.cpp +++ b/esphome/components/api/api_connection.cpp @@ -1645,7 +1645,7 @@ bool APIConnection::send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) return false; } - APIError err = this->helper_->write_packet(message_type, buffer.get_buffer()->data(), buffer.get_buffer()->size()); + APIError err = this->helper_->write_protobuf_packet(message_type, buffer); if (err == APIError::WOULD_BLOCK) return false; if (err != APIError::OK) { diff --git a/esphome/components/api/api_connection.h b/esphome/components/api/api_connection.h index dd24802e72..e8a29b9c7f 100644 --- a/esphome/components/api/api_connection.h +++ b/esphome/components/api/api_connection.h @@ -405,7 +405,14 @@ class APIConnection : public APIServerConnection { ProtoWriteBuffer create_buffer(uint32_t reserve_size) override { // FIXME: ensure no recursive writes can happen this->proto_write_buffer_.clear(); - this->proto_write_buffer_.reserve(reserve_size); + // Get header padding size - used for both reserve and insert + uint8_t header_padding = this->helper_->frame_header_padding(); + // Reserve space for header padding + message + footer + // - Header padding: space for protocol headers (7 bytes for Noise, 6 for Plaintext) + // - Footer: space for MAC (16 bytes for Noise, 0 for Plaintext) + this->proto_write_buffer_.reserve(reserve_size + header_padding + this->helper_->frame_footer_size()); + // Insert header padding bytes so message encoding starts at the correct position + this->proto_write_buffer_.insert(this->proto_write_buffer_.begin(), header_padding, 0); return {&this->proto_write_buffer_}; } bool try_to_clear_buffer(bool log_out_of_space); diff --git a/esphome/components/api/api_frame_helper.cpp b/esphome/components/api/api_frame_helper.cpp index f251ceb6e4..f18f4104b6 100644 --- a/esphome/components/api/api_frame_helper.cpp +++ b/esphome/components/api/api_frame_helper.cpp @@ -493,9 +493,12 @@ void APINoiseFrameHelper::send_explicit_handshake_reject_(const std::string &rea std::vector data; data.resize(reason.length() + 1); data[0] = 0x01; // failure - for (size_t i = 0; i < reason.length(); i++) { - data[i + 1] = (uint8_t) reason[i]; + + // Copy error message in bulk + if (!reason.empty()) { + std::memcpy(data.data() + 1, reason.c_str(), reason.length()); } + // temporarily remove failed state auto orig_state = state_; state_ = State::EXPLICIT_REJECT; @@ -557,7 +560,7 @@ APIError APINoiseFrameHelper::read_packet(ReadPacketBuffer *buffer) { return APIError::OK; } bool APINoiseFrameHelper::can_write_without_blocking() { return state_ == State::DATA && tx_buf_.empty(); } -APIError APINoiseFrameHelper::write_packet(uint16_t type, const uint8_t *payload, size_t payload_len) { +APIError APINoiseFrameHelper::write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) { int err; APIError aerr; aerr = state_action_(); @@ -569,31 +572,36 @@ APIError APINoiseFrameHelper::write_packet(uint16_t type, const uint8_t *payload return APIError::WOULD_BLOCK; } + std::vector *raw_buffer = buffer.get_buffer(); + // Message data starts after padding + size_t payload_len = raw_buffer->size() - frame_header_padding_; size_t padding = 0; size_t msg_len = 4 + payload_len + padding; - size_t frame_len = 3 + msg_len + noise_cipherstate_get_mac_length(send_cipher_); - auto tmpbuf = std::unique_ptr{new (std::nothrow) uint8_t[frame_len]}; - if (tmpbuf == nullptr) { - HELPER_LOG("Could not allocate for writing packet"); - return APIError::OUT_OF_MEMORY; - } - tmpbuf[0] = 0x01; // indicator - // tmpbuf[1], tmpbuf[2] to be set later + // We need to resize to include MAC space, but we already reserved it in create_buffer + raw_buffer->resize(raw_buffer->size() + frame_footer_size_); + + // Write the noise header in the padded area + // Buffer layout: + // [0] - 0x01 indicator byte + // [1-2] - Size of encrypted payload (filled after encryption) + // [3-4] - Message type (encrypted) + // [5-6] - Payload length (encrypted) + // [7...] - Actual payload data (encrypted) + uint8_t *buf_start = raw_buffer->data(); + buf_start[0] = 0x01; // indicator + // buf_start[1], buf_start[2] to be set later after encryption const uint8_t msg_offset = 3; - const uint8_t payload_offset = msg_offset + 4; - tmpbuf[msg_offset + 0] = (uint8_t) (type >> 8); // type - tmpbuf[msg_offset + 1] = (uint8_t) type; - tmpbuf[msg_offset + 2] = (uint8_t) (payload_len >> 8); // data_len - tmpbuf[msg_offset + 3] = (uint8_t) payload_len; - // copy data - std::copy(payload, payload + payload_len, &tmpbuf[payload_offset]); - // fill padding with zeros - std::fill(&tmpbuf[payload_offset + payload_len], &tmpbuf[frame_len], 0); + buf_start[msg_offset + 0] = (uint8_t) (type >> 8); // type high byte + buf_start[msg_offset + 1] = (uint8_t) type; // type low byte + buf_start[msg_offset + 2] = (uint8_t) (payload_len >> 8); // data_len high byte + buf_start[msg_offset + 3] = (uint8_t) payload_len; // data_len low byte + // payload data is already in the buffer starting at position 7 NoiseBuffer mbuf; noise_buffer_init(mbuf); - noise_buffer_set_inout(mbuf, &tmpbuf[msg_offset], msg_len, frame_len - msg_offset); + // The capacity parameter should be msg_len + frame_footer_size_ (MAC length) to allow space for encryption + noise_buffer_set_inout(mbuf, buf_start + msg_offset, msg_len, msg_len + frame_footer_size_); err = noise_cipherstate_encrypt(send_cipher_, &mbuf); if (err != 0) { state_ = State::FAILED; @@ -602,11 +610,13 @@ APIError APINoiseFrameHelper::write_packet(uint16_t type, const uint8_t *payload } size_t total_len = 3 + mbuf.size; - tmpbuf[1] = (uint8_t) (mbuf.size >> 8); - tmpbuf[2] = (uint8_t) mbuf.size; + buf_start[1] = (uint8_t) (mbuf.size >> 8); + buf_start[2] = (uint8_t) mbuf.size; struct iovec iov; - iov.iov_base = &tmpbuf[0]; + // Point iov_base to the beginning of the buffer (no unused padding in Noise) + // We send the entire frame: indicator + size + encrypted(type + data_len + payload + MAC) + iov.iov_base = buf_start; iov.iov_len = total_len; // write raw to not have two packets sent if NAGLE disabled @@ -718,6 +728,8 @@ APIError APINoiseFrameHelper::check_handshake_finished_() { return APIError::HANDSHAKESTATE_SPLIT_FAILED; } + frame_footer_size_ = noise_cipherstate_get_mac_length(send_cipher_); + HELPER_LOG("Handshake complete!"); noise_handshakestate_free(handshake_); handshake_ = nullptr; @@ -990,28 +1002,66 @@ APIError APIPlaintextFrameHelper::read_packet(ReadPacketBuffer *buffer) { return APIError::OK; } bool APIPlaintextFrameHelper::can_write_without_blocking() { return state_ == State::DATA && tx_buf_.empty(); } -APIError APIPlaintextFrameHelper::write_packet(uint16_t type, const uint8_t *payload, size_t payload_len) { +APIError APIPlaintextFrameHelper::write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) { if (state_ != State::DATA) { return APIError::BAD_STATE; } - std::vector header; - header.reserve(1 + api::ProtoSize::varint(static_cast(payload_len)) + - api::ProtoSize::varint(static_cast(type))); - header.push_back(0x00); - ProtoVarInt(payload_len).encode(header); - ProtoVarInt(type).encode(header); + std::vector *raw_buffer = buffer.get_buffer(); + // Message data starts after padding (frame_header_padding_ = 6) + size_t payload_len = raw_buffer->size() - frame_header_padding_; - struct iovec iov[2]; - iov[0].iov_base = &header[0]; - iov[0].iov_len = header.size(); - if (payload_len == 0) { - return write_raw_(iov, 1); + // Calculate varint sizes for header components + size_t size_varint_len = api::ProtoSize::varint(static_cast(payload_len)); + size_t type_varint_len = api::ProtoSize::varint(static_cast(type)); + size_t total_header_len = 1 + size_varint_len + type_varint_len; + + if (total_header_len > frame_header_padding_) { + // Header is too large to fit in the padding + return APIError::BAD_ARG; } - iov[1].iov_base = const_cast(payload); - iov[1].iov_len = payload_len; - return write_raw_(iov, 2); + // Calculate where to start writing the header + // The header starts at the latest possible position to minimize unused padding + // + // Example 1 (small values): total_header_len = 3, header_offset = 6 - 3 = 3 + // [0-2] - Unused padding + // [3] - 0x00 indicator byte + // [4] - Payload size varint (1 byte, for sizes 0-127) + // [5] - Message type varint (1 byte, for types 0-127) + // [6...] - Actual payload data + // + // Example 2 (medium values): total_header_len = 4, header_offset = 6 - 4 = 2 + // [0-1] - Unused padding + // [2] - 0x00 indicator byte + // [3-4] - Payload size varint (2 bytes, for sizes 128-16383) + // [5] - Message type varint (1 byte, for types 0-127) + // [6...] - Actual payload data + // + // Example 3 (large values): total_header_len = 6, header_offset = 6 - 6 = 0 + // [0] - 0x00 indicator byte + // [1-3] - Payload size varint (3 bytes, for sizes 16384-2097151) + // [4-5] - Message type varint (2 bytes, for types 128-32767) + // [6...] - Actual payload data + uint8_t *buf_start = raw_buffer->data(); + size_t header_offset = frame_header_padding_ - total_header_len; + + // Write the plaintext header + buf_start[header_offset] = 0x00; // indicator + + // Encode size varint directly into buffer + ProtoVarInt(payload_len).encode_to_buffer_unchecked(buf_start + header_offset + 1, size_varint_len); + + // Encode type varint directly into buffer + ProtoVarInt(type).encode_to_buffer_unchecked(buf_start + header_offset + 1 + size_varint_len, type_varint_len); + + struct iovec iov; + // Point iov_base to the beginning of our header (skip unused padding) + // This ensures we only send the actual header and payload, not the empty padding bytes + iov.iov_base = buf_start + header_offset; + iov.iov_len = total_header_len + payload_len; + + return write_raw_(&iov, 1); } APIError APIPlaintextFrameHelper::try_send_tx_buf_() { // try send from tx_buf diff --git a/esphome/components/api/api_frame_helper.h b/esphome/components/api/api_frame_helper.h index db506ea1ce..25bfd594ec 100644 --- a/esphome/components/api/api_frame_helper.h +++ b/esphome/components/api/api_frame_helper.h @@ -16,6 +16,8 @@ namespace esphome { namespace api { +class ProtoWriteBuffer; + struct ReadPacketBuffer { std::vector container; uint16_t type; @@ -65,32 +67,46 @@ class APIFrameHelper { virtual APIError loop() = 0; virtual APIError read_packet(ReadPacketBuffer *buffer) = 0; virtual bool can_write_without_blocking() = 0; - virtual APIError write_packet(uint16_t type, const uint8_t *data, size_t len) = 0; + virtual APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) = 0; virtual std::string getpeername() = 0; virtual int getpeername(struct sockaddr *addr, socklen_t *addrlen) = 0; virtual APIError close() = 0; virtual APIError shutdown(int how) = 0; // Give this helper a name for logging virtual void set_log_info(std::string info) = 0; + // Get the frame header padding required by this protocol + virtual uint8_t frame_header_padding() = 0; + // Get the frame footer size required by this protocol + virtual uint8_t frame_footer_size() = 0; protected: // Common implementation for writing raw data to socket template APIError write_raw_(const struct iovec *iov, int iovcnt, socket::Socket *socket, std::vector &tx_buf, const std::string &info, StateEnum &state, StateEnum failed_state); + + uint8_t frame_header_padding_{0}; + uint8_t frame_footer_size_{0}; }; #ifdef USE_API_NOISE class APINoiseFrameHelper : public APIFrameHelper { public: APINoiseFrameHelper(std::unique_ptr socket, std::shared_ptr ctx) - : socket_(std::move(socket)), ctx_(std::move(std::move(ctx))) {} + : socket_(std::move(socket)), ctx_(std::move(ctx)) { + // Noise header structure: + // Pos 0: indicator (0x01) + // Pos 1-2: encrypted payload size (16-bit big-endian) + // Pos 3-6: encrypted type (16-bit) + data_len (16-bit) + // Pos 7+: actual payload data + frame_header_padding_ = 7; + } ~APINoiseFrameHelper() override; APIError init() override; APIError loop() override; APIError read_packet(ReadPacketBuffer *buffer) override; bool can_write_without_blocking() override; - APIError write_packet(uint16_t type, const uint8_t *payload, size_t len) override; + APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override; std::string getpeername() override { return this->socket_->getpeername(); } int getpeername(struct sockaddr *addr, socklen_t *addrlen) override { return this->socket_->getpeername(addr, addrlen); @@ -99,6 +115,10 @@ class APINoiseFrameHelper : public APIFrameHelper { APIError shutdown(int how) override; // Give this helper a name for logging void set_log_info(std::string info) override { info_ = std::move(info); } + // Get the frame header padding required by this protocol + uint8_t frame_header_padding() override { return frame_header_padding_; } + // Get the frame footer size required by this protocol + uint8_t frame_footer_size() override { return frame_footer_size_; } protected: struct ParsedFrame { @@ -152,13 +172,20 @@ class APINoiseFrameHelper : public APIFrameHelper { #ifdef USE_API_PLAINTEXT class APIPlaintextFrameHelper : public APIFrameHelper { public: - APIPlaintextFrameHelper(std::unique_ptr socket) : socket_(std::move(socket)) {} + APIPlaintextFrameHelper(std::unique_ptr socket) : socket_(std::move(socket)) { + // Plaintext header structure (worst case): + // Pos 0: indicator (0x00) + // Pos 1-3: payload size varint (up to 3 bytes) + // Pos 4-5: message type varint (up to 2 bytes) + // Pos 6+: actual payload data + frame_header_padding_ = 6; + } ~APIPlaintextFrameHelper() override = default; APIError init() override; APIError loop() override; APIError read_packet(ReadPacketBuffer *buffer) override; bool can_write_without_blocking() override; - APIError write_packet(uint16_t type, const uint8_t *payload, size_t len) override; + APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override; std::string getpeername() override { return this->socket_->getpeername(); } int getpeername(struct sockaddr *addr, socklen_t *addrlen) override { return this->socket_->getpeername(addr, addrlen); @@ -167,6 +194,10 @@ class APIPlaintextFrameHelper : public APIFrameHelper { APIError shutdown(int how) override; // Give this helper a name for logging void set_log_info(std::string info) override { info_ = std::move(info); } + // Get the frame header padding required by this protocol + uint8_t frame_header_padding() override { return frame_header_padding_; } + // Get the frame footer size required by this protocol + uint8_t frame_footer_size() override { return frame_footer_size_; } protected: struct ParsedFrame { diff --git a/esphome/components/api/proto.h b/esphome/components/api/proto.h index e110a58eda..65bef0b6f7 100644 --- a/esphome/components/api/proto.h +++ b/esphome/components/api/proto.h @@ -83,6 +83,34 @@ class ProtoVarInt { return static_cast(this->value_ >> 1); } } + /** + * Encode the varint value to a pre-allocated buffer without bounds checking. + * + * @param buffer The pre-allocated buffer to write the encoded varint to + * @param len The size of the buffer in bytes + * + * @note The caller is responsible for ensuring the buffer is large enough + * to hold the encoded value. Use ProtoSize::varint() to calculate + * the exact size needed before calling this method. + * @note No bounds checking is performed for performance reasons. + */ + void encode_to_buffer_unchecked(uint8_t *buffer, size_t len) { + uint64_t val = this->value_; + if (val <= 0x7F) { + buffer[0] = val; + return; + } + size_t i = 0; + while (val && i < len) { + uint8_t temp = val & 0x7F; + val >>= 7; + if (val) { + buffer[i++] = temp | 0x80; + } else { + buffer[i++] = temp; + } + } + } void encode(std::vector &out) { uint64_t val = this->value_; if (val <= 0x7F) { From 24fbe602dd4c888a2db53ead21d42f1b2878321e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 May 2025 09:13:20 +1200 Subject: [PATCH 09/82] Bump codecov/codecov-action from 5.4.2 to 5.4.3 (#8820) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8d2ec68010..4913e8ee19 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -221,7 +221,7 @@ jobs: . venv/bin/activate pytest -vv --cov-report=xml --tb=native tests - name: Upload coverage to Codecov - uses: codecov/codecov-action@v5.4.2 + uses: codecov/codecov-action@v5.4.3 with: token: ${{ secrets.CODECOV_TOKEN }} From 660030d1573cb281698fec95c55f8f471613c382 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 May 2025 09:20:29 +1200 Subject: [PATCH 10/82] Bump docker/build-push-action from 6.16.0 to 6.17.0 in /.github/actions/build-image (#8810) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/actions/build-image/action.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/actions/build-image/action.yaml b/.github/actions/build-image/action.yaml index 3d6de54f42..0e41314ce6 100644 --- a/.github/actions/build-image/action.yaml +++ b/.github/actions/build-image/action.yaml @@ -47,7 +47,7 @@ runs: - name: Build and push to ghcr by digest id: build-ghcr - uses: docker/build-push-action@v6.16.0 + uses: docker/build-push-action@v6.17.0 env: DOCKER_BUILD_SUMMARY: false DOCKER_BUILD_RECORD_UPLOAD: false @@ -73,7 +73,7 @@ runs: - name: Build and push to dockerhub by digest id: build-dockerhub - uses: docker/build-push-action@v6.16.0 + uses: docker/build-push-action@v6.17.0 env: DOCKER_BUILD_SUMMARY: false DOCKER_BUILD_RECORD_UPLOAD: false From 9704de66478676340d0c7ad4b9a24edd7be20b81 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Thu, 15 May 2025 14:40:11 +1200 Subject: [PATCH 11/82] Update some sensor schemas to be Optional (#8803) --- esphome/components/ccs811/sensor.py | 15 ++++++----- esphome/components/dps310/sensor.py | 12 ++++----- esphome/components/ee895/sensor.py | 18 ++++++------- esphome/components/ens160_base/__init__.py | 21 ++++++++------- esphome/components/hte501/sensor.py | 12 ++++----- esphome/components/hyt271/sensor.py | 12 ++++----- esphome/components/mhz19/sensor.py | 18 ++++++++----- esphome/components/ms5611/sensor.py | 12 ++++----- esphome/components/ms8607/sensor.py | 6 ++--- esphome/components/senseair/sensor.py | 6 ++--- esphome/components/sgp30/sensor.py | 30 ++++++++++------------ esphome/components/shtcx/sensor.py | 12 ++++----- esphome/components/t6615/sensor.py | 6 ++--- esphome/components/t6615/t6615.cpp | 3 ++- 14 files changed, 96 insertions(+), 87 deletions(-) diff --git a/esphome/components/ccs811/sensor.py b/esphome/components/ccs811/sensor.py index 10565cb328..d9023a415f 100644 --- a/esphome/components/ccs811/sensor.py +++ b/esphome/components/ccs811/sensor.py @@ -32,14 +32,14 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(CCS811Component), - cv.Required(CONF_ECO2): sensor.sensor_schema( + cv.Optional(CONF_ECO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, icon=ICON_MOLECULE_CO2, accuracy_decimals=0, device_class=DEVICE_CLASS_CARBON_DIOXIDE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_TVOC): sensor.sensor_schema( + cv.Optional(CONF_TVOC): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_BILLION, icon=ICON_RADIATOR, accuracy_decimals=0, @@ -64,10 +64,13 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - sens = await sensor.new_sensor(config[CONF_ECO2]) - cg.add(var.set_co2(sens)) - sens = await sensor.new_sensor(config[CONF_TVOC]) - cg.add(var.set_tvoc(sens)) + if eco2_config := config.get(CONF_ECO2): + sens = await sensor.new_sensor(eco2_config) + cg.add(var.set_co2(sens)) + + if tvoc_config := config.get(CONF_TVOC): + sens = await sensor.new_sensor(tvoc_config) + cg.add(var.set_tvoc(sens)) if version_config := config.get(CONF_VERSION): sens = await text_sensor.new_text_sensor(version_config) diff --git a/esphome/components/dps310/sensor.py b/esphome/components/dps310/sensor.py index b2a98e5bab..605812beaa 100644 --- a/esphome/components/dps310/sensor.py +++ b/esphome/components/dps310/sensor.py @@ -27,14 +27,14 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(DPS310Component), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, icon=ICON_THERMOMETER, accuracy_decimals=1, device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_PRESSURE): sensor.sensor_schema( + cv.Optional(CONF_PRESSURE): sensor.sensor_schema( unit_of_measurement=UNIT_HECTOPASCAL, icon=ICON_GAUGE, accuracy_decimals=1, @@ -53,10 +53,10 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature_sensor(sens)) - if CONF_PRESSURE in config: - sens = await sensor.new_sensor(config[CONF_PRESSURE]) + if pressure := config.get(CONF_PRESSURE): + sens = await sensor.new_sensor(pressure) cg.add(var.set_pressure_sensor(sens)) diff --git a/esphome/components/ee895/sensor.py b/esphome/components/ee895/sensor.py index 0f8f44c8a2..8c9c7e7238 100644 --- a/esphome/components/ee895/sensor.py +++ b/esphome/components/ee895/sensor.py @@ -26,19 +26,19 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(EE895Component), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, accuracy_decimals=1, device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_CO2): sensor.sensor_schema( + cv.Optional(CONF_CO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, icon=ICON_MOLECULE_CO2, accuracy_decimals=0, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_PRESSURE): sensor.sensor_schema( + cv.Optional(CONF_PRESSURE): sensor.sensor_schema( unit_of_measurement=UNIT_HECTOPASCAL, accuracy_decimals=1, device_class=DEVICE_CLASS_PRESSURE, @@ -56,14 +56,14 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature_sensor(sens)) - if CONF_CO2 in config: - sens = await sensor.new_sensor(config[CONF_CO2]) + if co2 := config.get(CONF_CO2): + sens = await sensor.new_sensor(co2) cg.add(var.set_co2_sensor(sens)) - if CONF_PRESSURE in config: - sens = await sensor.new_sensor(config[CONF_PRESSURE]) + if pressure := config.get(CONF_PRESSURE): + sens = await sensor.new_sensor(pressure) cg.add(var.set_pressure_sensor(sens)) diff --git a/esphome/components/ens160_base/__init__.py b/esphome/components/ens160_base/__init__.py index 28e77e322b..3b6ad8a4ee 100644 --- a/esphome/components/ens160_base/__init__.py +++ b/esphome/components/ens160_base/__init__.py @@ -28,21 +28,21 @@ UNIT_INDEX = "index" CONFIG_SCHEMA_BASE = cv.Schema( { - cv.Required(CONF_ECO2): sensor.sensor_schema( + cv.Optional(CONF_ECO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, icon=ICON_MOLECULE_CO2, accuracy_decimals=0, device_class=DEVICE_CLASS_CARBON_DIOXIDE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_TVOC): sensor.sensor_schema( + cv.Optional(CONF_TVOC): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_BILLION, icon=ICON_RADIATOR, accuracy_decimals=0, device_class=DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_AQI): sensor.sensor_schema( + cv.Optional(CONF_AQI): sensor.sensor_schema( icon=ICON_CHEMICAL_WEAPON, accuracy_decimals=0, device_class=DEVICE_CLASS_AQI, @@ -62,12 +62,15 @@ async def to_code_base(config): var = cg.new_Pvariable(config[CONF_ID]) await cg.register_component(var, config) - sens = await sensor.new_sensor(config[CONF_ECO2]) - cg.add(var.set_co2(sens)) - sens = await sensor.new_sensor(config[CONF_TVOC]) - cg.add(var.set_tvoc(sens)) - sens = await sensor.new_sensor(config[CONF_AQI]) - cg.add(var.set_aqi(sens)) + if eco2_config := config.get(CONF_ECO2): + sens = await sensor.new_sensor(eco2_config) + cg.add(var.set_co2(sens)) + if tvoc_config := config.get(CONF_TVOC): + sens = await sensor.new_sensor(tvoc_config) + cg.add(var.set_tvoc(sens)) + if aqi_config := config.get(CONF_AQI): + sens = await sensor.new_sensor(aqi_config) + cg.add(var.set_aqi(sens)) if compensation_config := config.get(CONF_COMPENSATION): sens = await cg.get_variable(compensation_config[CONF_TEMPERATURE]) diff --git a/esphome/components/hte501/sensor.py b/esphome/components/hte501/sensor.py index 7eef641c4a..17ae3a3d1b 100644 --- a/esphome/components/hte501/sensor.py +++ b/esphome/components/hte501/sensor.py @@ -25,13 +25,13 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(HTE501Component), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, accuracy_decimals=1, device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_HUMIDITY): sensor.sensor_schema( + cv.Optional(CONF_HUMIDITY): sensor.sensor_schema( unit_of_measurement=UNIT_PERCENT, accuracy_decimals=1, device_class=DEVICE_CLASS_HUMIDITY, @@ -49,10 +49,10 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature_sensor(sens)) - if CONF_HUMIDITY in config: - sens = await sensor.new_sensor(config[CONF_HUMIDITY]) + if humidity := config.get(CONF_HUMIDITY): + sens = await sensor.new_sensor(humidity) cg.add(var.set_humidity_sensor(sens)) diff --git a/esphome/components/hyt271/sensor.py b/esphome/components/hyt271/sensor.py index 22364ce854..bf37646d4f 100644 --- a/esphome/components/hyt271/sensor.py +++ b/esphome/components/hyt271/sensor.py @@ -23,13 +23,13 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(HYT271Component), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, accuracy_decimals=1, device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_HUMIDITY): sensor.sensor_schema( + cv.Optional(CONF_HUMIDITY): sensor.sensor_schema( unit_of_measurement=UNIT_PERCENT, accuracy_decimals=1, device_class=DEVICE_CLASS_HUMIDITY, @@ -47,10 +47,10 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature(sens)) - if CONF_HUMIDITY in config: - sens = await sensor.new_sensor(config[CONF_HUMIDITY]) + if humidity := config.get(CONF_HUMIDITY): + sens = await sensor.new_sensor(humidity) cg.add(var.set_humidity(sens)) diff --git a/esphome/components/mhz19/sensor.py b/esphome/components/mhz19/sensor.py index 10428b1e4a..106636a6ba 100644 --- a/esphome/components/mhz19/sensor.py +++ b/esphome/components/mhz19/sensor.py @@ -32,7 +32,7 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(MHZ19Component), - cv.Required(CONF_CO2): sensor.sensor_schema( + cv.Optional(CONF_CO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, icon=ICON_MOLECULE_CO2, accuracy_decimals=0, @@ -61,16 +61,20 @@ async def to_code(config): await cg.register_component(var, config) await uart.register_uart_device(var, config) - if CONF_CO2 in config: - sens = await sensor.new_sensor(config[CONF_CO2]) + if co2 := config.get(CONF_CO2): + sens = await sensor.new_sensor(co2) cg.add(var.set_co2_sensor(sens)) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature_sensor(sens)) - if CONF_AUTOMATIC_BASELINE_CALIBRATION in config: - cg.add(var.set_abc_enabled(config[CONF_AUTOMATIC_BASELINE_CALIBRATION])) + if ( + automatic_baseline_calibration := config.get( + CONF_AUTOMATIC_BASELINE_CALIBRATION + ) + ) is not None: + cg.add(var.set_abc_enabled(automatic_baseline_calibration)) cg.add(var.set_warmup_seconds(config[CONF_WARMUP_TIME])) diff --git a/esphome/components/ms5611/sensor.py b/esphome/components/ms5611/sensor.py index 168ca0c5c8..dfb6083bef 100644 --- a/esphome/components/ms5611/sensor.py +++ b/esphome/components/ms5611/sensor.py @@ -24,13 +24,13 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(MS5611Component), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, accuracy_decimals=1, device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_PRESSURE): sensor.sensor_schema( + cv.Optional(CONF_PRESSURE): sensor.sensor_schema( unit_of_measurement=UNIT_HECTOPASCAL, icon=ICON_GAUGE, accuracy_decimals=1, @@ -49,10 +49,10 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature_sensor(sens)) - if CONF_PRESSURE in config: - sens = await sensor.new_sensor(config[CONF_PRESSURE]) + if pressure := config.get(CONF_PRESSURE): + sens = await sensor.new_sensor(pressure) cg.add(var.set_pressure_sensor(sens)) diff --git a/esphome/components/ms8607/sensor.py b/esphome/components/ms8607/sensor.py index 7ed7c61750..038f17190a 100644 --- a/esphome/components/ms8607/sensor.py +++ b/esphome/components/ms8607/sensor.py @@ -29,19 +29,19 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(MS8607Component), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, accuracy_decimals=2, # Resolution: 0.01 device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_PRESSURE): sensor.sensor_schema( + cv.Optional(CONF_PRESSURE): sensor.sensor_schema( unit_of_measurement=UNIT_HECTOPASCAL, accuracy_decimals=2, # Resolution: 0.016 device_class=DEVICE_CLASS_PRESSURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_HUMIDITY): sensor.sensor_schema( + cv.Optional(CONF_HUMIDITY): sensor.sensor_schema( unit_of_measurement=UNIT_PERCENT, accuracy_decimals=2, # Resolution: 0.04 device_class=DEVICE_CLASS_HUMIDITY, diff --git a/esphome/components/senseair/sensor.py b/esphome/components/senseair/sensor.py index cd6d85c12b..2eb2617e30 100644 --- a/esphome/components/senseair/sensor.py +++ b/esphome/components/senseair/sensor.py @@ -38,7 +38,7 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(SenseAirComponent), - cv.Required(CONF_CO2): sensor.sensor_schema( + cv.Optional(CONF_CO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, icon=ICON_MOLECULE_CO2, accuracy_decimals=0, @@ -57,8 +57,8 @@ async def to_code(config): await cg.register_component(var, config) await uart.register_uart_device(var, config) - if CONF_CO2 in config: - sens = await sensor.new_sensor(config[CONF_CO2]) + if co2 := config.get(CONF_CO2): + sens = await sensor.new_sensor(co2) cg.add(var.set_co2_sensor(sens)) diff --git a/esphome/components/sgp30/sensor.py b/esphome/components/sgp30/sensor.py index 8c92f55ef7..848e4e9f9f 100644 --- a/esphome/components/sgp30/sensor.py +++ b/esphome/components/sgp30/sensor.py @@ -37,14 +37,14 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(SGP30Component), - cv.Required(CONF_ECO2): sensor.sensor_schema( + cv.Optional(CONF_ECO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, icon=ICON_MOLECULE_CO2, accuracy_decimals=0, device_class=DEVICE_CLASS_CARBON_DIOXIDE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_TVOC): sensor.sensor_schema( + cv.Optional(CONF_TVOC): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_BILLION, icon=ICON_RADIATOR, accuracy_decimals=0, @@ -86,32 +86,30 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_ECO2 in config: - sens = await sensor.new_sensor(config[CONF_ECO2]) + if eco2_config := config.get(CONF_ECO2): + sens = await sensor.new_sensor(eco2_config) cg.add(var.set_eco2_sensor(sens)) - if CONF_TVOC in config: - sens = await sensor.new_sensor(config[CONF_TVOC]) + if tvoc_config := config.get(CONF_TVOC): + sens = await sensor.new_sensor(tvoc_config) cg.add(var.set_tvoc_sensor(sens)) - if CONF_ECO2_BASELINE in config: - sens = await sensor.new_sensor(config[CONF_ECO2_BASELINE]) + if eco2_baseline_config := config.get(CONF_ECO2_BASELINE): + sens = await sensor.new_sensor(eco2_baseline_config) cg.add(var.set_eco2_baseline_sensor(sens)) - if CONF_TVOC_BASELINE in config: - sens = await sensor.new_sensor(config[CONF_TVOC_BASELINE]) + if tvoc_baseline_config := config.get(CONF_TVOC_BASELINE): + sens = await sensor.new_sensor(tvoc_baseline_config) cg.add(var.set_tvoc_baseline_sensor(sens)) - if CONF_STORE_BASELINE in config: - cg.add(var.set_store_baseline(config[CONF_STORE_BASELINE])) + if (store_baseline := config.get(CONF_STORE_BASELINE)) is not None: + cg.add(var.set_store_baseline(store_baseline)) - if CONF_BASELINE in config: - baseline_config = config[CONF_BASELINE] + if baseline_config := config.get(CONF_BASELINE): cg.add(var.set_eco2_baseline(baseline_config[CONF_ECO2_BASELINE])) cg.add(var.set_tvoc_baseline(baseline_config[CONF_TVOC_BASELINE])) - if CONF_COMPENSATION in config: - compensation_config = config[CONF_COMPENSATION] + if compensation_config := config.get(CONF_COMPENSATION): sens = await cg.get_variable(compensation_config[CONF_HUMIDITY_SOURCE]) cg.add(var.set_humidity_sensor(sens)) sens = await cg.get_variable(compensation_config[CONF_TEMPERATURE_SOURCE]) diff --git a/esphome/components/shtcx/sensor.py b/esphome/components/shtcx/sensor.py index bb83ee4482..fdb1344fb7 100644 --- a/esphome/components/shtcx/sensor.py +++ b/esphome/components/shtcx/sensor.py @@ -26,13 +26,13 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(SHTCXComponent), - cv.Required(CONF_TEMPERATURE): sensor.sensor_schema( + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema( unit_of_measurement=UNIT_CELSIUS, accuracy_decimals=1, device_class=DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT, ), - cv.Required(CONF_HUMIDITY): sensor.sensor_schema( + cv.Optional(CONF_HUMIDITY): sensor.sensor_schema( unit_of_measurement=UNIT_PERCENT, accuracy_decimals=1, device_class=DEVICE_CLASS_HUMIDITY, @@ -50,10 +50,10 @@ async def to_code(config): await cg.register_component(var, config) await i2c.register_i2c_device(var, config) - if CONF_TEMPERATURE in config: - sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) + if temperature := config.get(CONF_TEMPERATURE): + sens = await sensor.new_sensor(temperature) cg.add(var.set_temperature_sensor(sens)) - if CONF_HUMIDITY in config: - sens = await sensor.new_sensor(config[CONF_HUMIDITY]) + if humidity := config.get(CONF_HUMIDITY): + sens = await sensor.new_sensor(humidity) cg.add(var.set_humidity_sensor(sens)) diff --git a/esphome/components/t6615/sensor.py b/esphome/components/t6615/sensor.py index 6df40497a9..9315e4a669 100644 --- a/esphome/components/t6615/sensor.py +++ b/esphome/components/t6615/sensor.py @@ -19,7 +19,7 @@ CONFIG_SCHEMA = ( cv.Schema( { cv.GenerateID(): cv.declare_id(T6615Component), - cv.Required(CONF_CO2): sensor.sensor_schema( + cv.Optional(CONF_CO2): sensor.sensor_schema( unit_of_measurement=UNIT_PARTS_PER_MILLION, accuracy_decimals=0, device_class=DEVICE_CLASS_CARBON_DIOXIDE, @@ -41,6 +41,6 @@ async def to_code(config): await cg.register_component(var, config) await uart.register_uart_device(var, config) - if CONF_CO2 in config: - sens = await sensor.new_sensor(config[CONF_CO2]) + if co2 := config.get(CONF_CO2): + sens = await sensor.new_sensor(co2) cg.add(var.set_co2_sensor(sens)) diff --git a/esphome/components/t6615/t6615.cpp b/esphome/components/t6615/t6615.cpp index c139c56ce4..1c78833500 100644 --- a/esphome/components/t6615/t6615.cpp +++ b/esphome/components/t6615/t6615.cpp @@ -63,7 +63,8 @@ void T6615Component::loop() { case T6615Command::GET_PPM: { const uint16_t ppm = encode_uint16(response_buffer[3], response_buffer[4]); ESP_LOGD(TAG, "T6615 Received CO₂=%uppm", ppm); - this->co2_sensor_->publish_state(ppm); + if (this->co2_sensor_ != nullptr) + this->co2_sensor_->publish_state(ppm); break; } default: From 2341ff651a0ccdee8e22d329287977723adba770 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 15 May 2025 00:16:08 -0500 Subject: [PATCH 12/82] Use fixed buffer for plaintext protocol like noise protocol (#8800) --- esphome/components/api/api_frame_helper.cpp | 59 +++++++++++++++++---- esphome/components/api/api_frame_helper.h | 14 ++++- 2 files changed, 61 insertions(+), 12 deletions(-) diff --git a/esphome/components/api/api_frame_helper.cpp b/esphome/components/api/api_frame_helper.cpp index 31b0732275..f251ceb6e4 100644 --- a/esphome/components/api/api_frame_helper.cpp +++ b/esphome/components/api/api_frame_helper.cpp @@ -830,6 +830,10 @@ APIError APIPlaintextFrameHelper::try_read_frame_(ParsedFrame *frame) { // read header while (!rx_header_parsed_) { uint8_t data; + // Reading one byte at a time is fastest in practice for ESP32 when + // there is no data on the wire (which is the common case). + // This results in faster failure detection compared to + // attempting to read multiple bytes at once. ssize_t received = socket_->read(&data, 1); if (received == -1) { if (errno == EWOULDBLOCK || errno == EAGAIN) { @@ -843,27 +847,60 @@ APIError APIPlaintextFrameHelper::try_read_frame_(ParsedFrame *frame) { HELPER_LOG("Connection closed"); return APIError::CONNECTION_CLOSED; } - rx_header_buf_.push_back(data); - // try parse header - if (rx_header_buf_[0] != 0x00) { - state_ = State::FAILED; - HELPER_LOG("Bad indicator byte %u", rx_header_buf_[0]); - return APIError::BAD_INDICATOR; + // Successfully read a byte + + // Process byte according to current buffer position + if (rx_header_buf_pos_ == 0) { // Case 1: First byte (indicator byte) + if (data != 0x00) { + state_ = State::FAILED; + HELPER_LOG("Bad indicator byte %u", data); + return APIError::BAD_INDICATOR; + } + // We don't store the indicator byte, just increment position + rx_header_buf_pos_ = 1; // Set to 1 directly + continue; // Need more bytes before we can parse } - size_t i = 1; + // Check buffer overflow before storing + if (rx_header_buf_pos_ == 5) { // Case 2: Buffer would overflow (5 bytes is max allowed) + state_ = State::FAILED; + HELPER_LOG("Header buffer overflow"); + return APIError::BAD_DATA_PACKET; + } + + // Store byte in buffer (adjust index to account for skipped indicator byte) + rx_header_buf_[rx_header_buf_pos_ - 1] = data; + + // Increment position after storing + rx_header_buf_pos_++; + + // Case 3: If we only have one varint byte, we need more + if (rx_header_buf_pos_ == 2) { // Have read indicator + 1 byte + continue; // Need more bytes before we can parse + } + + // At this point, we have at least 3 bytes total: + // - Validated indicator byte (0x00) but not stored + // - At least 2 bytes in the buffer for the varints + // Buffer layout: + // First 1-3 bytes: Message size varint (variable length) + // - 2 bytes would only allow up to 16383, which is less than noise's 65535 + // - 3 bytes allows up to 2097151, ensuring we support at least as much as noise + // Remaining 1-2 bytes: Message type varint (variable length) + // We now attempt to parse both varints. If either is incomplete, + // we'll continue reading more bytes. + uint32_t consumed = 0; - auto msg_size_varint = ProtoVarInt::parse(&rx_header_buf_[i], rx_header_buf_.size() - i, &consumed); + auto msg_size_varint = ProtoVarInt::parse(&rx_header_buf_[0], rx_header_buf_pos_ - 1, &consumed); if (!msg_size_varint.has_value()) { // not enough data there yet continue; } - i += consumed; rx_header_parsed_len_ = msg_size_varint->as_uint32(); - auto msg_type_varint = ProtoVarInt::parse(&rx_header_buf_[i], rx_header_buf_.size() - i, &consumed); + auto msg_type_varint = ProtoVarInt::parse(&rx_header_buf_[consumed], rx_header_buf_pos_ - 1 - consumed, &consumed); if (!msg_type_varint.has_value()) { // not enough data there yet continue; @@ -909,7 +946,7 @@ APIError APIPlaintextFrameHelper::try_read_frame_(ParsedFrame *frame) { // consume msg rx_buf_ = {}; rx_buf_len_ = 0; - rx_header_buf_.clear(); + rx_header_buf_pos_ = 0; rx_header_parsed_ = false; return APIError::OK; } diff --git a/esphome/components/api/api_frame_helper.h b/esphome/components/api/api_frame_helper.h index 59f3cf7471..db506ea1ce 100644 --- a/esphome/components/api/api_frame_helper.h +++ b/esphome/components/api/api_frame_helper.h @@ -119,6 +119,9 @@ class APINoiseFrameHelper : public APIFrameHelper { std::unique_ptr socket_; std::string info_; + // Fixed-size header buffer for noise protocol: + // 1 byte for indicator + 2 bytes for message size (16-bit value, not varint) + // Note: Maximum message size is 65535, with a limit of 128 bytes during handshake phase uint8_t rx_header_buf_[3]; size_t rx_header_buf_len_ = 0; std::vector rx_buf_; @@ -179,7 +182,16 @@ class APIPlaintextFrameHelper : public APIFrameHelper { std::unique_ptr socket_; std::string info_; - std::vector rx_header_buf_; + // Fixed-size header buffer for plaintext protocol: + // We only need space for the two varints since we validate the indicator byte separately. + // To match noise protocol's maximum message size (65535), we need: + // 3 bytes for message size varint (supports up to 2097151) + 2 bytes for message type varint + // + // While varints could theoretically be up to 10 bytes each for 64-bit values, + // attempting to process messages with headers that large would likely crash the + // ESP32 due to memory constraints. + uint8_t rx_header_buf_[5]; // 5 bytes for varints (3 for size + 2 for type) + uint8_t rx_header_buf_pos_ = 0; bool rx_header_parsed_ = false; uint32_t rx_header_parsed_type_ = 0; uint32_t rx_header_parsed_len_ = 0; From c7e62d1279a179be0f51f62c4f8c091001ef4598 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 15 May 2025 00:16:25 -0500 Subject: [PATCH 13/82] Optimize protobuf varint decoder for ESPHome use case (#8791) --- esphome/components/api/proto.h | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/esphome/components/api/proto.h b/esphome/components/api/proto.h index b8ee6b7920..e110a58eda 100644 --- a/esphome/components/api/proto.h +++ b/esphome/components/api/proto.h @@ -20,16 +20,26 @@ class ProtoVarInt { explicit ProtoVarInt(uint64_t value) : value_(value) {} static optional parse(const uint8_t *buffer, uint32_t len, uint32_t *consumed) { - if (consumed != nullptr) - *consumed = 0; - - if (len == 0) + if (len == 0) { + if (consumed != nullptr) + *consumed = 0; return {}; + } - uint64_t result = 0; - uint8_t bitpos = 0; + // Most common case: single-byte varint (values 0-127) + if ((buffer[0] & 0x80) == 0) { + if (consumed != nullptr) + *consumed = 1; + return ProtoVarInt(buffer[0]); + } - for (uint32_t i = 0; i < len; i++) { + // General case for multi-byte varints + // Since we know buffer[0]'s high bit is set, initialize with its value + uint64_t result = buffer[0] & 0x7F; + uint8_t bitpos = 7; + + // Start from the second byte since we've already processed the first + for (uint32_t i = 1; i < len; i++) { uint8_t val = buffer[i]; result |= uint64_t(val & 0x7F) << uint64_t(bitpos); bitpos += 7; @@ -40,7 +50,9 @@ class ProtoVarInt { } } - return {}; + if (consumed != nullptr) + *consumed = 0; + return {}; // Incomplete or invalid varint } uint32_t as_uint32() const { return this->value_; } From 41f860c2a3655c2992a9a22794f44ef239234cb1 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 15 May 2025 04:36:28 -0500 Subject: [PATCH 14/82] Logger Recursion Guard per Task on ESP32 (#8765) --- esphome/components/logger/__init__.py | 1 + esphome/components/logger/logger.cpp | 47 +++++++++++---------- esphome/components/logger/logger.h | 60 ++++++++++++++++++++++++--- 3 files changed, 82 insertions(+), 26 deletions(-) diff --git a/esphome/components/logger/__init__.py b/esphome/components/logger/__init__.py index 01e75a424d..4698c1d9f1 100644 --- a/esphome/components/logger/__init__.py +++ b/esphome/components/logger/__init__.py @@ -254,6 +254,7 @@ async def to_code(config): config[CONF_TX_BUFFER_SIZE], ) if CORE.is_esp32: + cg.add(log.create_pthread_key()) task_log_buffer_size = config[CONF_TASK_LOG_BUFFER_SIZE] if task_log_buffer_size > 0: cg.add_define("USE_ESPHOME_TASK_LOG_BUFFER") diff --git a/esphome/components/logger/logger.cpp b/esphome/components/logger/logger.cpp index 812a7cc16d..0ad909cb07 100644 --- a/esphome/components/logger/logger.cpp +++ b/esphome/components/logger/logger.cpp @@ -14,20 +14,27 @@ namespace logger { static const char *const TAG = "logger"; #ifdef USE_ESP32 -// Implementation for ESP32 (multi-core with atomic support) -// Main thread: synchronous logging with direct buffer access -// Other threads: console output with stack buffer, callbacks via async buffer +// Implementation for ESP32 (multi-task platform with task-specific tracking) +// Main task always uses direct buffer access for console output and callbacks +// Other tasks: +// - With task log buffer: stack buffer for console output, async buffer for callbacks +// - Without task log buffer: only console output, no callbacks void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char *format, va_list args) { // NOLINT - if (level > this->level_for(tag) || recursion_guard_.load(std::memory_order_relaxed)) + if (level > this->level_for(tag)) return; - recursion_guard_.store(true, std::memory_order_relaxed); TaskHandle_t current_task = xTaskGetCurrentTaskHandle(); + bool is_main_task = (current_task == main_task_); - // For main task: call log_message_to_buffer_and_send_ which does console and callback logging - if (current_task == main_task_) { + // Check and set recursion guard - uses pthread TLS for per-task state + if (this->check_and_set_task_log_recursion_(is_main_task)) { + return; // Recursion detected + } + + // Main task uses the shared buffer for efficiency + if (is_main_task) { this->log_message_to_buffer_and_send_(level, tag, line, format, args); - recursion_guard_.store(false, std::memory_order_release); + this->reset_task_log_recursion_(is_main_task); return; } @@ -51,23 +58,21 @@ void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char * } #endif // USE_ESPHOME_TASK_LOG_BUFFER - recursion_guard_.store(false, std::memory_order_release); + // Reset the recursion guard for this task + this->reset_task_log_recursion_(is_main_task); } -#endif // USE_ESP32 - -#ifndef USE_ESP32 -// Implementation for platforms that do not support atomic operations -// or have to consider logging in other tasks +#else +// Implementation for all other platforms void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char *format, va_list args) { // NOLINT - if (level > this->level_for(tag) || recursion_guard_) + if (level > this->level_for(tag) || global_recursion_guard_) return; - recursion_guard_ = true; + global_recursion_guard_ = true; // Format and send to both console and callbacks this->log_message_to_buffer_and_send_(level, tag, line, format, args); - recursion_guard_ = false; + global_recursion_guard_ = false; } #endif // !USE_ESP32 @@ -76,10 +81,10 @@ void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char * // Note: USE_STORE_LOG_STR_IN_FLASH is only defined for ESP8266. void Logger::log_vprintf_(int level, const char *tag, int line, const __FlashStringHelper *format, va_list args) { // NOLINT - if (level > this->level_for(tag) || recursion_guard_) + if (level > this->level_for(tag) || global_recursion_guard_) return; - recursion_guard_ = true; + global_recursion_guard_ = true; this->tx_buffer_at_ = 0; // Copy format string from progmem @@ -91,7 +96,7 @@ void Logger::log_vprintf_(int level, const char *tag, int line, const __FlashStr // Buffer full from copying format if (this->tx_buffer_at_ >= this->tx_buffer_size_) { - recursion_guard_ = false; // Make sure to reset the recursion guard before returning + global_recursion_guard_ = false; // Make sure to reset the recursion guard before returning return; } @@ -107,7 +112,7 @@ void Logger::log_vprintf_(int level, const char *tag, int line, const __FlashStr } this->call_log_callbacks_(level, tag, this->tx_buffer_ + msg_start); - recursion_guard_ = false; + global_recursion_guard_ = false; } #endif // USE_STORE_LOG_STR_IN_FLASH diff --git a/esphome/components/logger/logger.h b/esphome/components/logger/logger.h index 8619cc0992..5c53c4d40c 100644 --- a/esphome/components/logger/logger.h +++ b/esphome/components/logger/logger.h @@ -3,7 +3,7 @@ #include #include #ifdef USE_ESP32 -#include +#include #endif #include "esphome/core/automation.h" #include "esphome/core/component.h" @@ -84,6 +84,23 @@ enum UARTSelection { }; #endif // USE_ESP32 || USE_ESP8266 || USE_RP2040 || USE_LIBRETINY +/** + * @brief Logger component for all ESPHome logging. + * + * This class implements a multi-platform logging system with protection against recursion. + * + * Recursion Protection Strategy: + * - On ESP32: Uses task-specific recursion guards + * * Main task: Uses a dedicated boolean member variable for efficiency + * * Other tasks: Uses pthread TLS with a dynamically allocated key for task-specific state + * - On other platforms: Uses a simple global recursion guard + * + * We use pthread TLS via pthread_key_create to create a unique key for storing + * task-specific recursion state, which: + * 1. Efficiently handles multiple tasks without locks or mutexes + * 2. Works with ESP-IDF's pthread implementation that uses a linked list for TLS variables + * 3. Avoids the limitations of the fixed FreeRTOS task local storage slots + */ class Logger : public Component { public: explicit Logger(uint32_t baud_rate, size_t tx_buffer_size); @@ -102,6 +119,9 @@ class Logger : public Component { #ifdef USE_ESP_IDF uart_port_t get_uart_num() const { return uart_num_; } #endif +#ifdef USE_ESP32 + void create_pthread_key() { pthread_key_create(&log_recursion_key_, nullptr); } +#endif #if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2040) || defined(USE_LIBRETINY) void set_uart_selection(UARTSelection uart_selection) { uart_ = uart_selection; } /// Get the UART used by the logger. @@ -222,18 +242,22 @@ class Logger : public Component { std::map log_levels_{}; CallbackManager log_callback_{}; int current_level_{ESPHOME_LOG_LEVEL_VERY_VERBOSE}; -#ifdef USE_ESP32 - std::atomic recursion_guard_{false}; #ifdef USE_ESPHOME_TASK_LOG_BUFFER std::unique_ptr log_buffer_; // Will be initialized with init_log_buffer #endif +#ifdef USE_ESP32 + // Task-specific recursion guards: + // - Main task uses a dedicated member variable for efficiency + // - Other tasks use pthread TLS with a dynamically created key via pthread_key_create + bool main_task_recursion_guard_{false}; + pthread_key_t log_recursion_key_; #else - bool recursion_guard_{false}; + bool global_recursion_guard_{false}; // Simple global recursion guard for single-task platforms #endif - void *main_task_ = nullptr; CallbackManager level_callback_{}; #if defined(USE_ESP32) || defined(USE_LIBRETINY) + void *main_task_ = nullptr; // Only used for thread name identification const char *HOT get_thread_name_() { TaskHandle_t current_task = xTaskGetCurrentTaskHandle(); if (current_task == main_task_) { @@ -248,6 +272,32 @@ class Logger : public Component { } #endif +#ifdef USE_ESP32 + inline bool HOT check_and_set_task_log_recursion_(bool is_main_task) { + if (is_main_task) { + const bool was_recursive = main_task_recursion_guard_; + main_task_recursion_guard_ = true; + return was_recursive; + } + + intptr_t current = (intptr_t) pthread_getspecific(log_recursion_key_); + if (current != 0) + return true; + + pthread_setspecific(log_recursion_key_, (void *) 1); + return false; + } + + inline void HOT reset_task_log_recursion_(bool is_main_task) { + if (is_main_task) { + main_task_recursion_guard_ = false; + return; + } + + pthread_setspecific(log_recursion_key_, (void *) 0); + } +#endif + inline void HOT write_header_to_buffer_(int level, const char *tag, int line, const char *thread_name, char *buffer, int *buffer_at, int buffer_size) { // Format header From 5a84bab9ec088b74fb96ff217d9483efaf89d70f Mon Sep 17 00:00:00 2001 From: Thomas Rupprecht Date: Thu, 15 May 2025 11:45:07 +0200 Subject: [PATCH 15/82] [log] improve/refactor `log` (#8708) --- esphome/__main__.py | 30 +++++++++-------- esphome/config.py | 26 +++++++-------- esphome/log.py | 34 +++++++++---------- esphome/mqtt.py | 4 +-- esphome/wizard.py | 80 +++++++++++++++++++++++++-------------------- 5 files changed, 91 insertions(+), 83 deletions(-) diff --git a/esphome/__main__.py b/esphome/__main__.py index c78eda7e12..9f638456e6 100644 --- a/esphome/__main__.py +++ b/esphome/__main__.py @@ -43,7 +43,7 @@ from esphome.const import ( ) from esphome.core import CORE, EsphomeError, coroutine from esphome.helpers import get_bool_env, indent, is_ip_address -from esphome.log import Fore, color, setup_log +from esphome.log import AnsiFore, color, setup_log from esphome.util import ( get_serial_ports, list_yaml_files, @@ -83,7 +83,7 @@ def choose_prompt(options, purpose: str = None): raise ValueError break except ValueError: - safe_print(color(Fore.RED, f"Invalid option: '{opt}'")) + safe_print(color(AnsiFore.RED, f"Invalid option: '{opt}'")) return options[opt - 1][1] @@ -596,30 +596,30 @@ def command_update_all(args): click.echo(f"{half_line}{middle_text}{half_line}") for f in files: - print(f"Updating {color(Fore.CYAN, f)}") + print(f"Updating {color(AnsiFore.CYAN, f)}") print("-" * twidth) print() rc = run_external_process( "esphome", "--dashboard", "run", f, "--no-logs", "--device", "OTA" ) if rc == 0: - print_bar(f"[{color(Fore.BOLD_GREEN, 'SUCCESS')}] {f}") + print_bar(f"[{color(AnsiFore.BOLD_GREEN, 'SUCCESS')}] {f}") success[f] = True else: - print_bar(f"[{color(Fore.BOLD_RED, 'ERROR')}] {f}") + print_bar(f"[{color(AnsiFore.BOLD_RED, 'ERROR')}] {f}") success[f] = False print() print() print() - print_bar(f"[{color(Fore.BOLD_WHITE, 'SUMMARY')}]") + print_bar(f"[{color(AnsiFore.BOLD_WHITE, 'SUMMARY')}]") failed = 0 for f in files: if success[f]: - print(f" - {f}: {color(Fore.GREEN, 'SUCCESS')}") + print(f" - {f}: {color(AnsiFore.GREEN, 'SUCCESS')}") else: - print(f" - {f}: {color(Fore.BOLD_RED, 'FAILED')}") + print(f" - {f}: {color(AnsiFore.BOLD_RED, 'FAILED')}") failed += 1 return failed @@ -645,7 +645,7 @@ def command_rename(args, config): if c not in ALLOWED_NAME_CHARS: print( color( - Fore.BOLD_RED, + AnsiFore.BOLD_RED, f"'{c}' is an invalid character for names. Valid characters are: " f"{ALLOWED_NAME_CHARS} (lowercase, no spaces)", ) @@ -658,7 +658,9 @@ def command_rename(args, config): yaml = yaml_util.load_yaml(CORE.config_path) if CONF_ESPHOME not in yaml or CONF_NAME not in yaml[CONF_ESPHOME]: print( - color(Fore.BOLD_RED, "Complex YAML files cannot be automatically renamed.") + color( + AnsiFore.BOLD_RED, "Complex YAML files cannot be automatically renamed." + ) ) return 1 old_name = yaml[CONF_ESPHOME][CONF_NAME] @@ -681,7 +683,7 @@ def command_rename(args, config): ) > 1 ): - print(color(Fore.BOLD_RED, "Too many matches in YAML to safely rename")) + print(color(AnsiFore.BOLD_RED, "Too many matches in YAML to safely rename")) return 1 new_raw = re.sub( @@ -693,7 +695,7 @@ def command_rename(args, config): new_path = os.path.join(CORE.config_dir, args.name + ".yaml") print( - f"Updating {color(Fore.CYAN, CORE.config_path)} to {color(Fore.CYAN, new_path)}" + f"Updating {color(AnsiFore.CYAN, CORE.config_path)} to {color(AnsiFore.CYAN, new_path)}" ) print() @@ -702,7 +704,7 @@ def command_rename(args, config): rc = run_external_process("esphome", "config", new_path) if rc != 0: - print(color(Fore.BOLD_RED, "Rename failed. Reverting changes.")) + print(color(AnsiFore.BOLD_RED, "Rename failed. Reverting changes.")) os.remove(new_path) return 1 @@ -728,7 +730,7 @@ def command_rename(args, config): if CORE.config_path != new_path: os.remove(CORE.config_path) - print(color(Fore.BOLD_GREEN, "SUCCESS")) + print(color(AnsiFore.BOLD_GREEN, "SUCCESS")) print() return 0 diff --git a/esphome/config.py b/esphome/config.py index 09ee2a8f9b..4b26b33c78 100644 --- a/esphome/config.py +++ b/esphome/config.py @@ -28,7 +28,7 @@ import esphome.core.config as core_config import esphome.final_validate as fv from esphome.helpers import indent from esphome.loader import ComponentManifest, get_component, get_platform -from esphome.log import Fore, color +from esphome.log import AnsiFore, color from esphome.types import ConfigFragmentType, ConfigType from esphome.util import OrderedDict, safe_print from esphome.voluptuous_schema import ExtraKeysInvalid @@ -959,7 +959,7 @@ def line_info(config, path, highlight=True): if obj: mark = obj.start_mark source = f"[source {mark.document}:{mark.line + 1}]" - return color(Fore.CYAN, source) + return color(AnsiFore.CYAN, source) return "None" @@ -983,7 +983,7 @@ def dump_dict( if at_root: error = config.get_error_for_path(path) if error is not None: - ret += f"\n{color(Fore.BOLD_RED, _format_vol_invalid(error, config))}\n" + ret += f"\n{color(AnsiFore.BOLD_RED, _format_vol_invalid(error, config))}\n" if isinstance(conf, (list, tuple)): multiline = True @@ -995,11 +995,11 @@ def dump_dict( path_ = path + [i] error = config.get_error_for_path(path_) if error is not None: - ret += f"\n{color(Fore.BOLD_RED, _format_vol_invalid(error, config))}\n" + ret += f"\n{color(AnsiFore.BOLD_RED, _format_vol_invalid(error, config))}\n" sep = "- " if config.is_in_error_path(path_): - sep = color(Fore.RED, sep) + sep = color(AnsiFore.RED, sep) msg, _ = dump_dict(config, path_, at_root=False) msg = indent(msg) inf = line_info(config, path_, highlight=config.is_in_error_path(path_)) @@ -1018,11 +1018,11 @@ def dump_dict( path_ = path + [k] error = config.get_error_for_path(path_) if error is not None: - ret += f"\n{color(Fore.BOLD_RED, _format_vol_invalid(error, config))}\n" + ret += f"\n{color(AnsiFore.BOLD_RED, _format_vol_invalid(error, config))}\n" st = f"{k}: " if config.is_in_error_path(path_): - st = color(Fore.RED, st) + st = color(AnsiFore.RED, st) msg, m = dump_dict(config, path_, at_root=False) inf = line_info(config, path_, highlight=config.is_in_error_path(path_)) @@ -1044,7 +1044,7 @@ def dump_dict( if len(conf) > 80: conf = f"|-\n{indent(conf)}" error = config.get_error_for_path(path) - col = Fore.BOLD_RED if error else Fore.KEEP + col = AnsiFore.BOLD_RED if error else AnsiFore.KEEP ret += color(col, str(conf)) elif isinstance(conf, core.Lambda): if is_secret(conf): @@ -1052,13 +1052,13 @@ def dump_dict( conf = f"!lambda |-\n{indent(str(conf.value))}" error = config.get_error_for_path(path) - col = Fore.BOLD_RED if error else Fore.KEEP + col = AnsiFore.BOLD_RED if error else AnsiFore.KEEP ret += color(col, conf) elif conf is None: pass else: error = config.get_error_for_path(path) - col = Fore.BOLD_RED if error else Fore.KEEP + col = AnsiFore.BOLD_RED if error else AnsiFore.KEEP ret += color(col, str(conf)) multiline = "\n" in ret @@ -1100,13 +1100,13 @@ def read_config(command_line_substitutions): if not CORE.verbose: res = strip_default_ids(res) - safe_print(color(Fore.BOLD_RED, "Failed config")) + safe_print(color(AnsiFore.BOLD_RED, "Failed config")) safe_print("") for path, domain in res.output_paths: if not res.is_in_error_path(path): continue - errstr = color(Fore.BOLD_RED, f"{domain}:") + errstr = color(AnsiFore.BOLD_RED, f"{domain}:") errline = line_info(res, path) if errline: errstr += f" {errline}" @@ -1121,7 +1121,7 @@ def read_config(command_line_substitutions): safe_print(indent("\n".join(split_dump[:i]))) for err in res.errors: - safe_print(color(Fore.BOLD_RED, err.msg)) + safe_print(color(AnsiFore.BOLD_RED, err.msg)) safe_print("") return None diff --git a/esphome/log.py b/esphome/log.py index 516f27be45..7e69a2fef8 100644 --- a/esphome/log.py +++ b/esphome/log.py @@ -1,9 +1,10 @@ +from enum import Enum import logging from esphome.core import CORE -class AnsiFore: +class AnsiFore(Enum): KEEP = "" BLACK = "\033[30m" RED = "\033[31m" @@ -26,7 +27,7 @@ class AnsiFore: BOLD_RESET = "\033[1;39m" -class AnsiStyle: +class AnsiStyle(Enum): BRIGHT = "\033[1m" BOLD = "\033[1m" DIM = "\033[2m" @@ -35,16 +36,10 @@ class AnsiStyle: RESET_ALL = "\033[0m" -Fore = AnsiFore() -Style = AnsiStyle() - - -def color(col: str, msg: str, reset: bool = True) -> bool: - if col and not col.startswith("\033["): - raise ValueError("Color must be value from esphome.log.Fore") - s = str(col) + msg +def color(col: AnsiFore, msg: str, reset: bool = True) -> str: + s = col.value + msg if reset and col: - s += str(Style.RESET_ALL) + s += AnsiStyle.RESET_ALL.value return s @@ -54,20 +49,21 @@ class ESPHomeLogFormatter(logging.Formatter): fmt += "%(levelname)s %(message)s" super().__init__(fmt=fmt, style="%") - def format(self, record): + # @override + def format(self, record: logging.LogRecord) -> str: formatted = super().format(record) prefix = { - "DEBUG": Fore.CYAN, - "INFO": Fore.GREEN, - "WARNING": Fore.YELLOW, - "ERROR": Fore.RED, - "CRITICAL": Fore.RED, + "DEBUG": AnsiFore.CYAN.value, + "INFO": AnsiFore.GREEN.value, + "WARNING": AnsiFore.YELLOW.value, + "ERROR": AnsiFore.RED.value, + "CRITICAL": AnsiFore.RED.value, }.get(record.levelname, "") - return f"{prefix}{formatted}{Style.RESET_ALL}" + return f"{prefix}{formatted}{AnsiStyle.RESET_ALL.value}" def setup_log( - log_level=logging.INFO, + log_level: int = logging.INFO, include_timestamp: bool = False, ) -> None: import colorama diff --git a/esphome/mqtt.py b/esphome/mqtt.py index 2403a4a1d9..a420b5ba7f 100644 --- a/esphome/mqtt.py +++ b/esphome/mqtt.py @@ -28,7 +28,7 @@ from esphome.const import ( ) from esphome.core import CORE, EsphomeError from esphome.helpers import get_int_env, get_str_env -from esphome.log import Fore, color +from esphome.log import AnsiFore, color from esphome.util import safe_print _LOGGER = logging.getLogger(__name__) @@ -291,7 +291,7 @@ def get_fingerprint(config): sha1 = hashlib.sha1(cert_der).hexdigest() - safe_print(f"SHA1 Fingerprint: {color(Fore.CYAN, sha1)}") + safe_print(f"SHA1 Fingerprint: {color(AnsiFore.CYAN, sha1)}") safe_print( f"Copy the string above into mqtt.ssl_fingerprints section of {CORE.config_path}" ) diff --git a/esphome/wizard.py b/esphome/wizard.py index 8c5bd07e1f..ca987304e2 100644 --- a/esphome/wizard.py +++ b/esphome/wizard.py @@ -9,7 +9,7 @@ import esphome.config_validation as cv from esphome.const import ALLOWED_NAME_CHARS, ENV_QUICKWIZARD from esphome.core import CORE from esphome.helpers import get_bool_env, write_file -from esphome.log import Fore, color +from esphome.log import AnsiFore, color from esphome.storage_json import StorageJSON, ext_storage_path from esphome.util import safe_input, safe_print @@ -219,7 +219,7 @@ def wizard_write(path, **kwargs): elif board in rtl87xx_boards.BOARDS: platform = "RTL87XX" else: - safe_print(color(Fore.RED, f'The board "{board}" is unknown.')) + safe_print(color(AnsiFore.RED, f'The board "{board}" is unknown.')) return False kwargs["platform"] = platform hardware = kwargs["platform"] @@ -274,12 +274,12 @@ def wizard(path): if not path.endswith(".yaml") and not path.endswith(".yml"): safe_print( - f"Please make your configuration file {color(Fore.CYAN, path)} have the extension .yaml or .yml" + f"Please make your configuration file {color(AnsiFore.CYAN, path)} have the extension .yaml or .yml" ) return 1 if os.path.exists(path): safe_print( - f"Uh oh, it seems like {color(Fore.CYAN, path)} already exists, please delete that file first or chose another configuration file." + f"Uh oh, it seems like {color(AnsiFore.CYAN, path)} already exists, please delete that file first or chose another configuration file." ) return 2 @@ -298,17 +298,19 @@ def wizard(path): sleep(3.0) safe_print() safe_print_step(1, CORE_BIG) - safe_print(f"First up, please choose a {color(Fore.GREEN, 'name')} for your node.") + safe_print( + f"First up, please choose a {color(AnsiFore.GREEN, 'name')} for your node." + ) safe_print( "It should be a unique name that can be used to identify the device later." ) sleep(1) safe_print( - f"For example, I like calling the node in my living room {color(Fore.BOLD_WHITE, 'livingroom')}." + f"For example, I like calling the node in my living room {color(AnsiFore.BOLD_WHITE, 'livingroom')}." ) safe_print() sleep(1) - name = safe_input(color(Fore.BOLD_WHITE, "(name): ")) + name = safe_input(color(AnsiFore.BOLD_WHITE, "(name): ")) while True: try: @@ -317,7 +319,7 @@ def wizard(path): except vol.Invalid: safe_print( color( - Fore.RED, + AnsiFore.RED, f'Oh noes, "{name}" isn\'t a valid name. Names can only ' f"include numbers, lower-case letters and hyphens. ", ) @@ -325,11 +327,13 @@ def wizard(path): name = strip_accents(name).lower().replace(" ", "-") name = strip_accents(name).lower().replace("_", "-") name = "".join(c for c in name if c in ALLOWED_NAME_CHARS) - safe_print(f'Shall I use "{color(Fore.CYAN, name)}" as the name instead?') + safe_print( + f'Shall I use "{color(AnsiFore.CYAN, name)}" as the name instead?' + ) sleep(0.5) name = default_input("(name [{}]): ", name) - safe_print(f'Great! Your node is now called "{color(Fore.CYAN, name)}".') + safe_print(f'Great! Your node is now called "{color(AnsiFore.CYAN, name)}".') sleep(1) safe_print_step(2, ESP_BIG) safe_print( @@ -346,7 +350,7 @@ def wizard(path): sleep(0.5) safe_print() platform = safe_input( - color(Fore.BOLD_WHITE, f"({'/'.join(wizard_platforms)}): ") + color(AnsiFore.BOLD_WHITE, f"({'/'.join(wizard_platforms)}): ") ) try: platform = vol.All(vol.Upper, vol.Any(*wizard_platforms))(platform.upper()) @@ -355,7 +359,9 @@ def wizard(path): safe_print( f'Unfortunately, I can\'t find an espressif microcontroller called "{platform}". Please try again.' ) - safe_print(f"Thanks! You've chosen {color(Fore.CYAN, platform)} as your platform.") + safe_print( + f"Thanks! You've chosen {color(AnsiFore.CYAN, platform)} as your platform." + ) safe_print() sleep(1) @@ -376,27 +382,29 @@ def wizard(path): else: raise NotImplementedError("Unknown platform!") - safe_print(f"Next, I need to know what {color(Fore.GREEN, 'board')} you're using.") + safe_print( + f"Next, I need to know what {color(AnsiFore.GREEN, 'board')} you're using." + ) sleep(0.5) - safe_print(f"Please go to {color(Fore.GREEN, board_link)} and choose a board.") + safe_print(f"Please go to {color(AnsiFore.GREEN, board_link)} and choose a board.") if platform == "ESP32": - safe_print(f"(Type {color(Fore.GREEN, 'esp01_1m')} for Sonoff devices)") + safe_print(f"(Type {color(AnsiFore.GREEN, 'esp01_1m')} for Sonoff devices)") safe_print() # Don't sleep because user needs to copy link if platform == "ESP32": - safe_print(f'For example "{color(Fore.BOLD_WHITE, "nodemcu-32s")}".') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "nodemcu-32s")}".') boards_list = esp32_boards.BOARDS.items() elif platform == "ESP8266": - safe_print(f'For example "{color(Fore.BOLD_WHITE, "nodemcuv2")}".') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "nodemcuv2")}".') boards_list = esp8266_boards.BOARDS.items() elif platform == "BK72XX": - safe_print(f'For example "{color(Fore.BOLD_WHITE, "cb2s")}".') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "cb2s")}".') boards_list = bk72xx_boards.BOARDS.items() elif platform == "RTL87XX": - safe_print(f'For example "{color(Fore.BOLD_WHITE, "wr3")}".') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "wr3")}".') boards_list = rtl87xx_boards.BOARDS.items() elif platform == "RP2040": - safe_print(f'For example "{color(Fore.BOLD_WHITE, "rpipicow")}".') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "rpipicow")}".') boards_list = rp2040_boards.BOARDS.items() else: @@ -409,19 +417,21 @@ def wizard(path): boards.append(board_id) while True: - board = safe_input(color(Fore.BOLD_WHITE, "(board): ")) + board = safe_input(color(AnsiFore.BOLD_WHITE, "(board): ")) try: board = vol.All(vol.Lower, vol.Any(*boards))(board) break except vol.Invalid: safe_print( - color(Fore.RED, f'Sorry, I don\'t think the board "{board}" exists.') + color( + AnsiFore.RED, f'Sorry, I don\'t think the board "{board}" exists.' + ) ) safe_print() sleep(0.25) safe_print() - safe_print(f"Way to go! You've chosen {color(Fore.CYAN, board)} as your board.") + safe_print(f"Way to go! You've chosen {color(AnsiFore.CYAN, board)} as your board.") safe_print() sleep(1) @@ -432,19 +442,19 @@ def wizard(path): safe_print() sleep(1) safe_print( - f"First, what's the {color(Fore.GREEN, 'SSID')} (the name) of the WiFi network {name} should connect to?" + f"First, what's the {color(AnsiFore.GREEN, 'SSID')} (the name) of the WiFi network {name} should connect to?" ) sleep(1.5) - safe_print(f'For example "{color(Fore.BOLD_WHITE, "Abraham Linksys")}".') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "Abraham Linksys")}".') while True: - ssid = safe_input(color(Fore.BOLD_WHITE, "(ssid): ")) + ssid = safe_input(color(AnsiFore.BOLD_WHITE, "(ssid): ")) try: ssid = cv.ssid(ssid) break except vol.Invalid: safe_print( color( - Fore.RED, + AnsiFore.RED, f'Unfortunately, "{ssid}" doesn\'t seem to be a valid SSID. Please try again.', ) ) @@ -452,18 +462,18 @@ def wizard(path): sleep(1) safe_print( - f'Thank you very much! You\'ve just chosen "{color(Fore.CYAN, ssid)}" as your SSID.' + f'Thank you very much! You\'ve just chosen "{color(AnsiFore.CYAN, ssid)}" as your SSID.' ) safe_print() sleep(0.75) safe_print( - f"Now please state the {color(Fore.GREEN, 'password')} of the WiFi network so that I can connect to it (Leave empty for no password)" + f"Now please state the {color(AnsiFore.GREEN, 'password')} of the WiFi network so that I can connect to it (Leave empty for no password)" ) safe_print() - safe_print(f'For example "{color(Fore.BOLD_WHITE, "PASSWORD42")}"') + safe_print(f'For example "{color(AnsiFore.BOLD_WHITE, "PASSWORD42")}"') sleep(0.5) - psk = safe_input(color(Fore.BOLD_WHITE, "(PSK): ")) + psk = safe_input(color(AnsiFore.BOLD_WHITE, "(PSK): ")) safe_print( "Perfect! WiFi is now set up (you can create static IPs and so on later)." ) @@ -475,12 +485,12 @@ def wizard(path): "(over the air) and integrates into Home Assistant with a native API." ) safe_print( - f"This can be insecure if you do not trust the WiFi network. Do you want to set a {color(Fore.GREEN, 'password')} for connecting to this ESP?" + f"This can be insecure if you do not trust the WiFi network. Do you want to set a {color(AnsiFore.GREEN, 'password')} for connecting to this ESP?" ) safe_print() sleep(0.25) safe_print("Press ENTER for no password") - password = safe_input(color(Fore.BOLD_WHITE, "(password): ")) + password = safe_input(color(AnsiFore.BOLD_WHITE, "(password): ")) else: ssid, password, psk = "", "", "" @@ -497,8 +507,8 @@ def wizard(path): safe_print() safe_print( - color(Fore.CYAN, "DONE! I've now written a new configuration file to ") - + color(Fore.BOLD_CYAN, path) + color(AnsiFore.CYAN, "DONE! I've now written a new configuration file to ") + + color(AnsiFore.BOLD_CYAN, path) ) safe_print() safe_print("Next steps:") From c50e33f531aed5536267c1633d37ac6a98a5fcfe Mon Sep 17 00:00:00 2001 From: Thomas Rupprecht Date: Thu, 15 May 2025 12:07:41 +0200 Subject: [PATCH 16/82] [gps] update lib, improve code/tests/config (#8768) --- CODEOWNERS | 2 +- esphome/components/gps/__init__.py | 53 +++++++++++++++++++++--------- esphome/components/gps/gps.cpp | 50 ++++++++++++++++++---------- esphome/components/gps/gps.h | 31 ++++++++--------- platformio.ini | 2 +- tests/components/gps/common.yaml | 14 ++++++++ 6 files changed, 102 insertions(+), 50 deletions(-) diff --git a/CODEOWNERS b/CODEOWNERS index ddd0494a3c..a6e08f225d 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -169,7 +169,7 @@ esphome/components/gp2y1010au0f/* @zry98 esphome/components/gp8403/* @jesserockz esphome/components/gpio/* @esphome/core esphome/components/gpio/one_wire/* @ssieb -esphome/components/gps/* @coogle +esphome/components/gps/* @coogle @ximex esphome/components/graph/* @synco esphome/components/graphical_display_menu/* @MrMDavidson esphome/components/gree/* @orestismers diff --git a/esphome/components/gps/__init__.py b/esphome/components/gps/__init__.py index 88e6f0fd9b..7ccd82dec3 100644 --- a/esphome/components/gps/__init__.py +++ b/esphome/components/gps/__init__.py @@ -9,23 +9,32 @@ from esphome.const import ( CONF_LONGITUDE, CONF_SATELLITES, CONF_SPEED, + DEVICE_CLASS_SPEED, STATE_CLASS_MEASUREMENT, UNIT_DEGREES, UNIT_KILOMETER_PER_HOUR, UNIT_METER, ) +CONF_GPS_ID = "gps_id" +CONF_HDOP = "hdop" + +ICON_ALTIMETER = "mdi:altimeter" +ICON_COMPASS = "mdi:compass" +ICON_LATITUDE = "mdi:latitude" +ICON_LONGITUDE = "mdi:longitude" +ICON_SATELLITE = "mdi:satellite-variant" +ICON_SPEEDOMETER = "mdi:speedometer" + DEPENDENCIES = ["uart"] AUTO_LOAD = ["sensor"] -CODEOWNERS = ["@coogle"] +CODEOWNERS = ["@coogle", "@ximex"] gps_ns = cg.esphome_ns.namespace("gps") GPS = gps_ns.class_("GPS", cg.Component, uart.UARTDevice) GPSListener = gps_ns.class_("GPSListener") -CONF_GPS_ID = "gps_id" -CONF_HDOP = "hdop" MULTI_CONF = True CONFIG_SCHEMA = cv.All( cv.Schema( @@ -33,25 +42,37 @@ CONFIG_SCHEMA = cv.All( cv.GenerateID(): cv.declare_id(GPS), cv.Optional(CONF_LATITUDE): sensor.sensor_schema( unit_of_measurement=UNIT_DEGREES, + icon=ICON_LATITUDE, accuracy_decimals=6, + state_class=STATE_CLASS_MEASUREMENT, ), cv.Optional(CONF_LONGITUDE): sensor.sensor_schema( unit_of_measurement=UNIT_DEGREES, + icon=ICON_LONGITUDE, accuracy_decimals=6, + state_class=STATE_CLASS_MEASUREMENT, ), cv.Optional(CONF_SPEED): sensor.sensor_schema( unit_of_measurement=UNIT_KILOMETER_PER_HOUR, + icon=ICON_SPEEDOMETER, accuracy_decimals=3, + device_class=DEVICE_CLASS_SPEED, + state_class=STATE_CLASS_MEASUREMENT, ), cv.Optional(CONF_COURSE): sensor.sensor_schema( unit_of_measurement=UNIT_DEGREES, + icon=ICON_COMPASS, accuracy_decimals=2, + state_class=STATE_CLASS_MEASUREMENT, ), cv.Optional(CONF_ALTITUDE): sensor.sensor_schema( unit_of_measurement=UNIT_METER, + icon=ICON_ALTIMETER, accuracy_decimals=2, + state_class=STATE_CLASS_MEASUREMENT, ), cv.Optional(CONF_SATELLITES): sensor.sensor_schema( + icon=ICON_SATELLITE, accuracy_decimals=0, state_class=STATE_CLASS_MEASUREMENT, ), @@ -73,28 +94,28 @@ async def to_code(config): await cg.register_component(var, config) await uart.register_uart_device(var, config) - if CONF_LATITUDE in config: - sens = await sensor.new_sensor(config[CONF_LATITUDE]) + if latitude_config := config.get(CONF_LATITUDE): + sens = await sensor.new_sensor(latitude_config) cg.add(var.set_latitude_sensor(sens)) - if CONF_LONGITUDE in config: - sens = await sensor.new_sensor(config[CONF_LONGITUDE]) + if longitude_config := config.get(CONF_LONGITUDE): + sens = await sensor.new_sensor(longitude_config) cg.add(var.set_longitude_sensor(sens)) - if CONF_SPEED in config: - sens = await sensor.new_sensor(config[CONF_SPEED]) + if speed_config := config.get(CONF_SPEED): + sens = await sensor.new_sensor(speed_config) cg.add(var.set_speed_sensor(sens)) - if CONF_COURSE in config: - sens = await sensor.new_sensor(config[CONF_COURSE]) + if course_config := config.get(CONF_COURSE): + sens = await sensor.new_sensor(course_config) cg.add(var.set_course_sensor(sens)) - if CONF_ALTITUDE in config: - sens = await sensor.new_sensor(config[CONF_ALTITUDE]) + if altitude_config := config.get(CONF_ALTITUDE): + sens = await sensor.new_sensor(altitude_config) cg.add(var.set_altitude_sensor(sens)) - if CONF_SATELLITES in config: - sens = await sensor.new_sensor(config[CONF_SATELLITES]) + if satellites_config := config.get(CONF_SATELLITES): + sens = await sensor.new_sensor(satellites_config) cg.add(var.set_satellites_sensor(sens)) if hdop_config := config.get(CONF_HDOP): @@ -102,4 +123,4 @@ async def to_code(config): cg.add(var.set_hdop_sensor(sens)) # https://platformio.org/lib/show/1655/TinyGPSPlus - cg.add_library("mikalhart/TinyGPSPlus", "1.0.2") + cg.add_library("mikalhart/TinyGPSPlus", "1.1.0") diff --git a/esphome/components/gps/gps.cpp b/esphome/components/gps/gps.cpp index e54afdb07e..9dcb351b39 100644 --- a/esphome/components/gps/gps.cpp +++ b/esphome/components/gps/gps.cpp @@ -10,6 +10,17 @@ static const char *const TAG = "gps"; TinyGPSPlus &GPSListener::get_tiny_gps() { return this->parent_->get_tiny_gps(); } +void GPS::dump_config() { + ESP_LOGCONFIG(TAG, "GPS:"); + LOG_SENSOR(" ", "Latitude", this->latitude_sensor_); + LOG_SENSOR(" ", "Longitude", this->longitude_sensor_); + LOG_SENSOR(" ", "Speed", this->speed_sensor_); + LOG_SENSOR(" ", "Course", this->course_sensor_); + LOG_SENSOR(" ", "Altitude", this->altitude_sensor_); + LOG_SENSOR(" ", "Satellites", this->satellites_sensor_); + LOG_SENSOR(" ", "HDOP", this->hdop_sensor_); +} + void GPS::update() { if (this->latitude_sensor_ != nullptr) this->latitude_sensor_->publish_state(this->latitude_); @@ -34,40 +45,45 @@ void GPS::update() { } void GPS::loop() { - while (this->available() && !this->has_time_) { + while (this->available() > 0 && !this->has_time_) { if (this->tiny_gps_.encode(this->read())) { - if (tiny_gps_.location.isUpdated()) { - this->latitude_ = tiny_gps_.location.lat(); - this->longitude_ = tiny_gps_.location.lng(); + if (this->tiny_gps_.location.isUpdated()) { + this->latitude_ = this->tiny_gps_.location.lat(); + this->longitude_ = this->tiny_gps_.location.lng(); ESP_LOGD(TAG, "Location:"); - ESP_LOGD(TAG, " Lat: %f", this->latitude_); - ESP_LOGD(TAG, " Lon: %f", this->longitude_); + ESP_LOGD(TAG, " Lat: %.6f °", this->latitude_); + ESP_LOGD(TAG, " Lon: %.6f °", this->longitude_); } - if (tiny_gps_.speed.isUpdated()) { - this->speed_ = tiny_gps_.speed.kmph(); + if (this->tiny_gps_.speed.isUpdated()) { + this->speed_ = this->tiny_gps_.speed.kmph(); ESP_LOGD(TAG, "Speed: %.3f km/h", this->speed_); } - if (tiny_gps_.course.isUpdated()) { - this->course_ = tiny_gps_.course.deg(); + + if (this->tiny_gps_.course.isUpdated()) { + this->course_ = this->tiny_gps_.course.deg(); ESP_LOGD(TAG, "Course: %.2f °", this->course_); } - if (tiny_gps_.altitude.isUpdated()) { - this->altitude_ = tiny_gps_.altitude.meters(); + + if (this->tiny_gps_.altitude.isUpdated()) { + this->altitude_ = this->tiny_gps_.altitude.meters(); ESP_LOGD(TAG, "Altitude: %.2f m", this->altitude_); } - if (tiny_gps_.satellites.isUpdated()) { - this->satellites_ = tiny_gps_.satellites.value(); + + if (this->tiny_gps_.satellites.isUpdated()) { + this->satellites_ = this->tiny_gps_.satellites.value(); ESP_LOGD(TAG, "Satellites: %d", this->satellites_); } - if (tiny_gps_.hdop.isUpdated()) { - this->hdop_ = tiny_gps_.hdop.hdop(); + + if (this->tiny_gps_.hdop.isUpdated()) { + this->hdop_ = this->tiny_gps_.hdop.hdop(); ESP_LOGD(TAG, "HDOP: %.3f", this->hdop_); } - for (auto *listener : this->listeners_) + for (auto *listener : this->listeners_) { listener->on_update(this->tiny_gps_); + } } } } diff --git a/esphome/components/gps/gps.h b/esphome/components/gps/gps.h index a400820738..7bc23ed1e0 100644 --- a/esphome/components/gps/gps.h +++ b/esphome/components/gps/gps.h @@ -5,7 +5,7 @@ #include "esphome/core/component.h" #include "esphome/components/uart/uart.h" #include "esphome/components/sensor/sensor.h" -#include +#include #include @@ -27,13 +27,13 @@ class GPSListener { class GPS : public PollingComponent, public uart::UARTDevice { public: - void set_latitude_sensor(sensor::Sensor *latitude_sensor) { latitude_sensor_ = latitude_sensor; } - void set_longitude_sensor(sensor::Sensor *longitude_sensor) { longitude_sensor_ = longitude_sensor; } - void set_speed_sensor(sensor::Sensor *speed_sensor) { speed_sensor_ = speed_sensor; } - void set_course_sensor(sensor::Sensor *course_sensor) { course_sensor_ = course_sensor; } - void set_altitude_sensor(sensor::Sensor *altitude_sensor) { altitude_sensor_ = altitude_sensor; } - void set_satellites_sensor(sensor::Sensor *satellites_sensor) { satellites_sensor_ = satellites_sensor; } - void set_hdop_sensor(sensor::Sensor *hdop_sensor) { hdop_sensor_ = hdop_sensor; } + void set_latitude_sensor(sensor::Sensor *latitude_sensor) { this->latitude_sensor_ = latitude_sensor; } + void set_longitude_sensor(sensor::Sensor *longitude_sensor) { this->longitude_sensor_ = longitude_sensor; } + void set_speed_sensor(sensor::Sensor *speed_sensor) { this->speed_sensor_ = speed_sensor; } + void set_course_sensor(sensor::Sensor *course_sensor) { this->course_sensor_ = course_sensor; } + void set_altitude_sensor(sensor::Sensor *altitude_sensor) { this->altitude_sensor_ = altitude_sensor; } + void set_satellites_sensor(sensor::Sensor *satellites_sensor) { this->satellites_sensor_ = satellites_sensor; } + void set_hdop_sensor(sensor::Sensor *hdop_sensor) { this->hdop_sensor_ = hdop_sensor; } void register_listener(GPSListener *listener) { listener->parent_ = this; @@ -41,19 +41,20 @@ class GPS : public PollingComponent, public uart::UARTDevice { } float get_setup_priority() const override { return setup_priority::HARDWARE; } + void dump_config() override; void loop() override; void update() override; TinyGPSPlus &get_tiny_gps() { return this->tiny_gps_; } protected: - float latitude_ = NAN; - float longitude_ = NAN; - float speed_ = NAN; - float course_ = NAN; - float altitude_ = NAN; - int satellites_ = 0; - double hdop_ = NAN; + float latitude_{NAN}; + float longitude_{NAN}; + float speed_{NAN}; + float course_{NAN}; + float altitude_{NAN}; + uint16_t satellites_{0}; + float hdop_{NAN}; sensor::Sensor *latitude_sensor_{nullptr}; sensor::Sensor *longitude_sensor_{nullptr}; diff --git a/platformio.ini b/platformio.ini index ccfd52c3ca..292188c6fa 100644 --- a/platformio.ini +++ b/platformio.ini @@ -64,7 +64,7 @@ lib_deps = heman/AsyncMqttClient-esphome@1.0.0 ; mqtt esphome/ESPAsyncWebServer-esphome@3.3.0 ; web_server_base fastled/FastLED@3.9.16 ; fastled_base - mikalhart/TinyGPSPlus@1.0.2 ; gps + mikalhart/TinyGPSPlus@1.1.0 ; gps freekode/TM1651@1.0.1 ; tm1651 glmnet/Dsmr@0.7 ; dsmr rweather/Crypto@0.4.0 ; dsmr diff --git a/tests/components/gps/common.yaml b/tests/components/gps/common.yaml index fc8228c909..53dc67e457 100644 --- a/tests/components/gps/common.yaml +++ b/tests/components/gps/common.yaml @@ -6,6 +6,20 @@ uart: parity: EVEN gps: + latitude: + name: "Latitude" + longitude: + name: "Longitude" + altitude: + name: "Altitude" + speed: + name: "Speed" + course: + name: "Course" + satellites: + name: "Satellites" + hdop: + name: "HDOP" time: - platform: gps From d847b345b8ae233088e0cdeab42218a3ce1901b5 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 15 May 2025 18:42:54 -0500 Subject: [PATCH 17/82] Fix ESP32 Camera class inheritance (#8811) --- esphome/components/esp32_camera/esp32_camera.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/esphome/components/esp32_camera/esp32_camera.h b/esphome/components/esp32_camera/esp32_camera.h index 71f47d3c06..d5fe48c2a7 100644 --- a/esphome/components/esp32_camera/esp32_camera.h +++ b/esphome/components/esp32_camera/esp32_camera.h @@ -106,7 +106,7 @@ class CameraImageReader { }; /* ---------------- ESP32Camera class ---------------- */ -class ESP32Camera : public Component, public EntityBase { +class ESP32Camera : public EntityBase, public Component { public: ESP32Camera(); From d8516cfabb118434f84fa49aa50dbf5e02d2de87 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Sat, 17 May 2025 22:05:03 -0500 Subject: [PATCH 18/82] [sen5x] Fix validation for values read from hardware (#8769) --- esphome/components/sen5x/sen5x.cpp | 89 ++++++++++++++++++------------ 1 file changed, 54 insertions(+), 35 deletions(-) diff --git a/esphome/components/sen5x/sen5x.cpp b/esphome/components/sen5x/sen5x.cpp index 0efc961943..f29ba18d6e 100644 --- a/esphome/components/sen5x/sen5x.cpp +++ b/esphome/components/sen5x/sen5x.cpp @@ -25,6 +25,10 @@ static const uint16_t SEN5X_CMD_TEMPERATURE_COMPENSATION = 0x60B2; static const uint16_t SEN5X_CMD_VOC_ALGORITHM_STATE = 0x6181; static const uint16_t SEN5X_CMD_VOC_ALGORITHM_TUNING = 0x60D0; +static const int8_t SEN5X_INDEX_SCALE_FACTOR = 10; // used for VOC and NOx index values +static const int8_t SEN5X_MIN_INDEX_VALUE = 1 * SEN5X_INDEX_SCALE_FACTOR; // must be adjusted by the scale factor +static const int16_t SEN5X_MAX_INDEX_VALUE = 500 * SEN5X_INDEX_SCALE_FACTOR; // must be adjusted by the scale factor + void SEN5XComponent::setup() { ESP_LOGCONFIG(TAG, "Setting up sen5x..."); @@ -88,8 +92,9 @@ void SEN5XComponent::setup() { product_name_.push_back(current_char); // second char current_char = *current_int & 0xFF; - if (current_char) + if (current_char) { product_name_.push_back(current_char); + } } current_int++; } while (current_char && --max); @@ -271,10 +276,10 @@ void SEN5XComponent::dump_config() { ESP_LOGCONFIG(TAG, " Low RH/T acceleration mode"); break; case MEDIUM_ACCELERATION: - ESP_LOGCONFIG(TAG, " Medium RH/T accelertion mode"); + ESP_LOGCONFIG(TAG, " Medium RH/T acceleration mode"); break; case HIGH_ACCELERATION: - ESP_LOGCONFIG(TAG, " High RH/T accelertion mode"); + ESP_LOGCONFIG(TAG, " High RH/T acceleration mode"); break; } } @@ -337,47 +342,61 @@ void SEN5XComponent::update() { ESP_LOGD(TAG, "read data error (%d)", this->last_error_); return; } - float pm_1_0 = measurements[0] / 10.0; - if (measurements[0] == 0xFFFF) - pm_1_0 = NAN; - float pm_2_5 = measurements[1] / 10.0; - if (measurements[1] == 0xFFFF) - pm_2_5 = NAN; - float pm_4_0 = measurements[2] / 10.0; - if (measurements[2] == 0xFFFF) - pm_4_0 = NAN; - float pm_10_0 = measurements[3] / 10.0; - if (measurements[3] == 0xFFFF) - pm_10_0 = NAN; - float humidity = measurements[4] / 100.0; - if (measurements[4] == 0xFFFF) - humidity = NAN; - float temperature = (int16_t) measurements[5] / 200.0; - if (measurements[5] == 0xFFFF) - temperature = NAN; - float voc = measurements[6] / 10.0; - if (measurements[6] == 0xFFFF) - voc = NAN; - float nox = measurements[7] / 10.0; - if (measurements[7] == 0xFFFF) - nox = NAN; - if (this->pm_1_0_sensor_ != nullptr) + ESP_LOGVV(TAG, "pm_1_0 = 0x%.4x", measurements[0]); + float pm_1_0 = measurements[0] == UINT16_MAX ? NAN : measurements[0] / 10.0f; + + ESP_LOGVV(TAG, "pm_2_5 = 0x%.4x", measurements[1]); + float pm_2_5 = measurements[1] == UINT16_MAX ? NAN : measurements[1] / 10.0f; + + ESP_LOGVV(TAG, "pm_4_0 = 0x%.4x", measurements[2]); + float pm_4_0 = measurements[2] == UINT16_MAX ? NAN : measurements[2] / 10.0f; + + ESP_LOGVV(TAG, "pm_10_0 = 0x%.4x", measurements[3]); + float pm_10_0 = measurements[3] == UINT16_MAX ? NAN : measurements[3] / 10.0f; + + ESP_LOGVV(TAG, "humidity = 0x%.4x", measurements[4]); + float humidity = measurements[4] == INT16_MAX ? NAN : static_cast(measurements[4]) / 100.0f; + + ESP_LOGVV(TAG, "temperature = 0x%.4x", measurements[5]); + float temperature = measurements[5] == INT16_MAX ? NAN : static_cast(measurements[5]) / 200.0f; + + ESP_LOGVV(TAG, "voc = 0x%.4x", measurements[6]); + int16_t voc_idx = static_cast(measurements[6]); + float voc = (voc_idx < SEN5X_MIN_INDEX_VALUE || voc_idx > SEN5X_MAX_INDEX_VALUE) + ? NAN + : static_cast(voc_idx) / 10.0f; + + ESP_LOGVV(TAG, "nox = 0x%.4x", measurements[7]); + int16_t nox_idx = static_cast(measurements[7]); + float nox = (nox_idx < SEN5X_MIN_INDEX_VALUE || nox_idx > SEN5X_MAX_INDEX_VALUE) + ? NAN + : static_cast(nox_idx) / 10.0f; + + if (this->pm_1_0_sensor_ != nullptr) { this->pm_1_0_sensor_->publish_state(pm_1_0); - if (this->pm_2_5_sensor_ != nullptr) + } + if (this->pm_2_5_sensor_ != nullptr) { this->pm_2_5_sensor_->publish_state(pm_2_5); - if (this->pm_4_0_sensor_ != nullptr) + } + if (this->pm_4_0_sensor_ != nullptr) { this->pm_4_0_sensor_->publish_state(pm_4_0); - if (this->pm_10_0_sensor_ != nullptr) + } + if (this->pm_10_0_sensor_ != nullptr) { this->pm_10_0_sensor_->publish_state(pm_10_0); - if (this->temperature_sensor_ != nullptr) + } + if (this->temperature_sensor_ != nullptr) { this->temperature_sensor_->publish_state(temperature); - if (this->humidity_sensor_ != nullptr) + } + if (this->humidity_sensor_ != nullptr) { this->humidity_sensor_->publish_state(humidity); - if (this->voc_sensor_ != nullptr) + } + if (this->voc_sensor_ != nullptr) { this->voc_sensor_->publish_state(voc); - if (this->nox_sensor_ != nullptr) + } + if (this->nox_sensor_ != nullptr) { this->nox_sensor_->publish_state(nox); + } this->status_clear_warning(); }); } From 59295a615e728465ba64b156f1bb5bef2ff9dd00 Mon Sep 17 00:00:00 2001 From: Anton Sergunov Date: Sun, 18 May 2025 09:11:09 +0600 Subject: [PATCH 19/82] Fix the case of single error (#8824) --- esphome/voluptuous_schema.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/esphome/voluptuous_schema.py b/esphome/voluptuous_schema.py index 15f9206f21..8fb966e3b2 100644 --- a/esphome/voluptuous_schema.py +++ b/esphome/voluptuous_schema.py @@ -15,7 +15,9 @@ class ExtraKeysInvalid(vol.Invalid): def ensure_multiple_invalid(err): if isinstance(err, vol.MultipleInvalid): return err - return vol.MultipleInvalid(err) + if isinstance(err, list): + return vol.MultipleInvalid(err) + return vol.MultipleInvalid([err]) # pylint: disable=protected-access, unidiomatic-typecheck From 868f5ff20c6570c52e26023a7f379113e98a5209 Mon Sep 17 00:00:00 2001 From: Clyde Stubbs <2366188+clydebarrow@users.noreply.github.com> Date: Sun, 18 May 2025 13:30:08 +1000 Subject: [PATCH 20/82] Revert "[binary_sensor] initial state refactor" (#8828) --- .../binary_sensor/binary_sensor.cpp | 16 ++++--- .../components/binary_sensor/binary_sensor.h | 2 +- esphome/components/binary_sensor/filter.cpp | 42 +++++++++---------- esphome/components/binary_sensor/filter.h | 20 ++++----- 4 files changed, 42 insertions(+), 38 deletions(-) diff --git a/esphome/components/binary_sensor/binary_sensor.cpp b/esphome/components/binary_sensor/binary_sensor.cpp index 30fbe4f0b4..20604a0b7e 100644 --- a/esphome/components/binary_sensor/binary_sensor.cpp +++ b/esphome/components/binary_sensor/binary_sensor.cpp @@ -15,17 +15,21 @@ void BinarySensor::publish_state(bool state) { if (!this->publish_dedup_.next(state)) return; if (this->filter_list_ == nullptr) { - this->send_state_internal(state); + this->send_state_internal(state, false); } else { - this->filter_list_->input(state); + this->filter_list_->input(state, false); } } void BinarySensor::publish_initial_state(bool state) { - this->has_state_ = false; - this->publish_state(state); + if (!this->publish_dedup_.next(state)) + return; + if (this->filter_list_ == nullptr) { + this->send_state_internal(state, true); + } else { + this->filter_list_->input(state, true); + } } -void BinarySensor::send_state_internal(bool state) { - bool is_initial = !this->has_state_; +void BinarySensor::send_state_internal(bool state, bool is_initial) { if (is_initial) { ESP_LOGD(TAG, "'%s': Sending initial state %s", this->get_name().c_str(), ONOFF(state)); } else { diff --git a/esphome/components/binary_sensor/binary_sensor.h b/esphome/components/binary_sensor/binary_sensor.h index 9ba7aeeeff..57cae9e2f5 100644 --- a/esphome/components/binary_sensor/binary_sensor.h +++ b/esphome/components/binary_sensor/binary_sensor.h @@ -67,7 +67,7 @@ class BinarySensor : public EntityBase, public EntityBase_DeviceClass { // ========== INTERNAL METHODS ========== // (In most use cases you won't need these) - void send_state_internal(bool state); + void send_state_internal(bool state, bool is_initial); /// Return whether this binary sensor has outputted a state. virtual bool has_state() const; diff --git a/esphome/components/binary_sensor/filter.cpp b/esphome/components/binary_sensor/filter.cpp index fd6cc31008..8f94b108ac 100644 --- a/esphome/components/binary_sensor/filter.cpp +++ b/esphome/components/binary_sensor/filter.cpp @@ -9,37 +9,37 @@ namespace binary_sensor { static const char *const TAG = "sensor.filter"; -void Filter::output(bool value) { +void Filter::output(bool value, bool is_initial) { if (!this->dedup_.next(value)) return; if (this->next_ == nullptr) { - this->parent_->send_state_internal(value); + this->parent_->send_state_internal(value, is_initial); } else { - this->next_->input(value); + this->next_->input(value, is_initial); } } -void Filter::input(bool value) { - auto b = this->new_value(value); +void Filter::input(bool value, bool is_initial) { + auto b = this->new_value(value, is_initial); if (b.has_value()) { - this->output(*b); + this->output(*b, is_initial); } } -optional DelayedOnOffFilter::new_value(bool value) { +optional DelayedOnOffFilter::new_value(bool value, bool is_initial) { if (value) { - this->set_timeout("ON_OFF", this->on_delay_.value(), [this]() { this->output(true); }); + this->set_timeout("ON_OFF", this->on_delay_.value(), [this, is_initial]() { this->output(true, is_initial); }); } else { - this->set_timeout("ON_OFF", this->off_delay_.value(), [this]() { this->output(false); }); + this->set_timeout("ON_OFF", this->off_delay_.value(), [this, is_initial]() { this->output(false, is_initial); }); } return {}; } float DelayedOnOffFilter::get_setup_priority() const { return setup_priority::HARDWARE; } -optional DelayedOnFilter::new_value(bool value) { +optional DelayedOnFilter::new_value(bool value, bool is_initial) { if (value) { - this->set_timeout("ON", this->delay_.value(), [this]() { this->output(true); }); + this->set_timeout("ON", this->delay_.value(), [this, is_initial]() { this->output(true, is_initial); }); return {}; } else { this->cancel_timeout("ON"); @@ -49,9 +49,9 @@ optional DelayedOnFilter::new_value(bool value) { float DelayedOnFilter::get_setup_priority() const { return setup_priority::HARDWARE; } -optional DelayedOffFilter::new_value(bool value) { +optional DelayedOffFilter::new_value(bool value, bool is_initial) { if (!value) { - this->set_timeout("OFF", this->delay_.value(), [this]() { this->output(false); }); + this->set_timeout("OFF", this->delay_.value(), [this, is_initial]() { this->output(false, is_initial); }); return {}; } else { this->cancel_timeout("OFF"); @@ -61,11 +61,11 @@ optional DelayedOffFilter::new_value(bool value) { float DelayedOffFilter::get_setup_priority() const { return setup_priority::HARDWARE; } -optional InvertFilter::new_value(bool value) { return !value; } +optional InvertFilter::new_value(bool value, bool is_initial) { return !value; } AutorepeatFilter::AutorepeatFilter(std::vector timings) : timings_(std::move(timings)) {} -optional AutorepeatFilter::new_value(bool value) { +optional AutorepeatFilter::new_value(bool value, bool is_initial) { if (value) { // Ignore if already running if (this->active_timing_ != 0) @@ -101,7 +101,7 @@ void AutorepeatFilter::next_timing_() { void AutorepeatFilter::next_value_(bool val) { const AutorepeatFilterTiming &timing = this->timings_[this->active_timing_ - 2]; - this->output(val); + this->output(val, false); // This is at least the second one so not initial this->set_timeout("ON_OFF", val ? timing.time_on : timing.time_off, [this, val]() { this->next_value_(!val); }); } @@ -109,18 +109,18 @@ float AutorepeatFilter::get_setup_priority() const { return setup_priority::HARD LambdaFilter::LambdaFilter(std::function(bool)> f) : f_(std::move(f)) {} -optional LambdaFilter::new_value(bool value) { return this->f_(value); } +optional LambdaFilter::new_value(bool value, bool is_initial) { return this->f_(value); } -optional SettleFilter::new_value(bool value) { +optional SettleFilter::new_value(bool value, bool is_initial) { if (!this->steady_) { - this->set_timeout("SETTLE", this->delay_.value(), [this, value]() { + this->set_timeout("SETTLE", this->delay_.value(), [this, value, is_initial]() { this->steady_ = true; - this->output(value); + this->output(value, is_initial); }); return {}; } else { this->steady_ = false; - this->output(value); + this->output(value, is_initial); this->set_timeout("SETTLE", this->delay_.value(), [this]() { this->steady_ = true; }); return value; } diff --git a/esphome/components/binary_sensor/filter.h b/esphome/components/binary_sensor/filter.h index 65838da49d..f7342db2fb 100644 --- a/esphome/components/binary_sensor/filter.h +++ b/esphome/components/binary_sensor/filter.h @@ -14,11 +14,11 @@ class BinarySensor; class Filter { public: - virtual optional new_value(bool value) = 0; + virtual optional new_value(bool value, bool is_initial) = 0; - void input(bool value); + void input(bool value, bool is_initial); - void output(bool value); + void output(bool value, bool is_initial); protected: friend BinarySensor; @@ -30,7 +30,7 @@ class Filter { class DelayedOnOffFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -44,7 +44,7 @@ class DelayedOnOffFilter : public Filter, public Component { class DelayedOnFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -56,7 +56,7 @@ class DelayedOnFilter : public Filter, public Component { class DelayedOffFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -68,7 +68,7 @@ class DelayedOffFilter : public Filter, public Component { class InvertFilter : public Filter { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; }; struct AutorepeatFilterTiming { @@ -86,7 +86,7 @@ class AutorepeatFilter : public Filter, public Component { public: explicit AutorepeatFilter(std::vector timings); - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; @@ -102,7 +102,7 @@ class LambdaFilter : public Filter { public: explicit LambdaFilter(std::function(bool)> f); - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; protected: std::function(bool)> f_; @@ -110,7 +110,7 @@ class LambdaFilter : public Filter { class SettleFilter : public Filter, public Component { public: - optional new_value(bool value) override; + optional new_value(bool value, bool is_initial) override; float get_setup_priority() const override; From f8681adec463433392be69e7ce20ff99b39294d6 Mon Sep 17 00:00:00 2001 From: Kent Gibson Date: Sun, 18 May 2025 11:45:12 +0800 Subject: [PATCH 21/82] Fix misspelling of climate in climate_ir.climate_ir_with_receiver_schema (#8829) --- esphome/components/ballu/climate.py | 2 +- esphome/components/climate_ir/__init__.py | 6 +++--- esphome/components/climate_ir_lg/climate.py | 2 +- esphome/components/coolix/climate.py | 2 +- esphome/components/daikin/climate.py | 2 +- esphome/components/daikin_arc/climate.py | 2 +- esphome/components/daikin_brc/climate.py | 2 +- esphome/components/delonghi/climate.py | 2 +- esphome/components/emmeti/climate.py | 2 +- esphome/components/fujitsu_general/climate.py | 2 +- esphome/components/gree/climate.py | 2 +- esphome/components/heatpumpir/climate.py | 2 +- esphome/components/hitachi_ac344/climate.py | 2 +- esphome/components/hitachi_ac424/climate.py | 2 +- esphome/components/midea_ir/climate.py | 2 +- esphome/components/mitsubishi/climate.py | 2 +- esphome/components/noblex/climate.py | 2 +- esphome/components/tcl112/climate.py | 2 +- esphome/components/toshiba/climate.py | 2 +- esphome/components/whirlpool/climate.py | 2 +- esphome/components/whynter/climate.py | 2 +- esphome/components/zhlt01/climate.py | 2 +- 22 files changed, 24 insertions(+), 24 deletions(-) diff --git a/esphome/components/ballu/climate.py b/esphome/components/ballu/climate.py index e35a1d244d..1127084632 100644 --- a/esphome/components/ballu/climate.py +++ b/esphome/components/ballu/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@bazuchan"] ballu_ns = cg.esphome_ns.namespace("ballu") BalluClimate = ballu_ns.class_("BalluClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(BalluClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(BalluClimate) async def to_code(config): diff --git a/esphome/components/climate_ir/__init__.py b/esphome/components/climate_ir/__init__.py index 32b614e933..312b2ad900 100644 --- a/esphome/components/climate_ir/__init__.py +++ b/esphome/components/climate_ir/__init__.py @@ -40,7 +40,7 @@ def climate_ir_schema( ) -def climare_ir_with_receiver_schema( +def climate_ir_with_receiver_schema( class_: MockObjClass, ) -> cv.Schema: return climate_ir_schema(class_).extend( @@ -59,7 +59,7 @@ def deprecated_schema_constant(config): type = str(id.type).split("::", maxsplit=1)[0] _LOGGER.warning( "Using `climate_ir.CLIMATE_IR_WITH_RECEIVER_SCHEMA` is deprecated and will be removed in ESPHome 2025.11.0. " - "Please use `climate_ir.climare_ir_with_receiver_schema(...)` instead. " + "Please use `climate_ir.climate_ir_with_receiver_schema(...)` instead. " "If you are seeing this, report an issue to the external_component author and ask them to update it. " "https://developers.esphome.io/blog/2025/05/14/_schema-deprecations/. " "Component using this schema: %s", @@ -68,7 +68,7 @@ def deprecated_schema_constant(config): return config -CLIMATE_IR_WITH_RECEIVER_SCHEMA = climare_ir_with_receiver_schema(ClimateIR) +CLIMATE_IR_WITH_RECEIVER_SCHEMA = climate_ir_with_receiver_schema(ClimateIR) CLIMATE_IR_WITH_RECEIVER_SCHEMA.add_extra(deprecated_schema_constant) diff --git a/esphome/components/climate_ir_lg/climate.py b/esphome/components/climate_ir_lg/climate.py index de824bfe5c..9c832642ce 100644 --- a/esphome/components/climate_ir_lg/climate.py +++ b/esphome/components/climate_ir_lg/climate.py @@ -13,7 +13,7 @@ CONF_BIT_HIGH = "bit_high" CONF_BIT_ONE_LOW = "bit_one_low" CONF_BIT_ZERO_LOW = "bit_zero_low" -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(LgIrClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(LgIrClimate).extend( { cv.Optional( CONF_HEADER_HIGH, default="8000us" diff --git a/esphome/components/coolix/climate.py b/esphome/components/coolix/climate.py index b280544a5c..1ebcff3c1b 100644 --- a/esphome/components/coolix/climate.py +++ b/esphome/components/coolix/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@glmnet"] coolix_ns = cg.esphome_ns.namespace("coolix") CoolixClimate = coolix_ns.class_("CoolixClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(CoolixClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(CoolixClimate) async def to_code(config): diff --git a/esphome/components/daikin/climate.py b/esphome/components/daikin/climate.py index 2cd44969c1..7f0226143b 100644 --- a/esphome/components/daikin/climate.py +++ b/esphome/components/daikin/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] daikin_ns = cg.esphome_ns.namespace("daikin") DaikinClimate = daikin_ns.class_("DaikinClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DaikinClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DaikinClimate) async def to_code(config): diff --git a/esphome/components/daikin_arc/climate.py b/esphome/components/daikin_arc/climate.py index 8f6b07315d..dbaf12d959 100644 --- a/esphome/components/daikin_arc/climate.py +++ b/esphome/components/daikin_arc/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] daikin_arc_ns = cg.esphome_ns.namespace("daikin_arc") DaikinArcClimate = daikin_arc_ns.class_("DaikinArcClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DaikinArcClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DaikinArcClimate) async def to_code(config): diff --git a/esphome/components/daikin_brc/climate.py b/esphome/components/daikin_brc/climate.py index 1000784380..5b7a4631a9 100644 --- a/esphome/components/daikin_brc/climate.py +++ b/esphome/components/daikin_brc/climate.py @@ -9,7 +9,7 @@ daikin_brc_ns = cg.esphome_ns.namespace("daikin_brc") DaikinBrcClimate = daikin_brc_ns.class_("DaikinBrcClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DaikinBrcClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DaikinBrcClimate).extend( { cv.Optional(CONF_USE_FAHRENHEIT, default=False): cv.boolean, } diff --git a/esphome/components/delonghi/climate.py b/esphome/components/delonghi/climate.py index ff878b4ff7..63576f032d 100644 --- a/esphome/components/delonghi/climate.py +++ b/esphome/components/delonghi/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] delonghi_ns = cg.esphome_ns.namespace("delonghi") DelonghiClimate = delonghi_ns.class_("DelonghiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(DelonghiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(DelonghiClimate) async def to_code(config): diff --git a/esphome/components/emmeti/climate.py b/esphome/components/emmeti/climate.py index 042f1af64b..56e8e2b804 100644 --- a/esphome/components/emmeti/climate.py +++ b/esphome/components/emmeti/climate.py @@ -7,7 +7,7 @@ AUTO_LOAD = ["climate_ir"] emmeti_ns = cg.esphome_ns.namespace("emmeti") EmmetiClimate = emmeti_ns.class_("EmmetiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(EmmetiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(EmmetiClimate) async def to_code(config): diff --git a/esphome/components/fujitsu_general/climate.py b/esphome/components/fujitsu_general/climate.py index 0f028d0af3..a104eafbcc 100644 --- a/esphome/components/fujitsu_general/climate.py +++ b/esphome/components/fujitsu_general/climate.py @@ -8,7 +8,7 @@ FujitsuGeneralClimate = fujitsu_general_ns.class_( "FujitsuGeneralClimate", climate_ir.ClimateIR ) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(FujitsuGeneralClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(FujitsuGeneralClimate) async def to_code(config): diff --git a/esphome/components/gree/climate.py b/esphome/components/gree/climate.py index 947ef9bb97..057ba67b94 100644 --- a/esphome/components/gree/climate.py +++ b/esphome/components/gree/climate.py @@ -21,7 +21,7 @@ MODELS = { "yag": Model.GREE_YAG, } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(GreeClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(GreeClimate).extend( { cv.Required(CONF_MODEL): cv.enum(MODELS), } diff --git a/esphome/components/heatpumpir/climate.py b/esphome/components/heatpumpir/climate.py index 21b0168615..c0eb8db4b3 100644 --- a/esphome/components/heatpumpir/climate.py +++ b/esphome/components/heatpumpir/climate.py @@ -97,7 +97,7 @@ VERTICAL_DIRECTIONS = { } CONFIG_SCHEMA = cv.All( - climate_ir.climare_ir_with_receiver_schema(HeatpumpIRClimate).extend( + climate_ir.climate_ir_with_receiver_schema(HeatpumpIRClimate).extend( { cv.Required(CONF_PROTOCOL): cv.enum(PROTOCOLS), cv.Required(CONF_HORIZONTAL_DEFAULT): cv.enum(HORIZONTAL_DIRECTIONS), diff --git a/esphome/components/hitachi_ac344/climate.py b/esphome/components/hitachi_ac344/climate.py index 4fa2d54fbb..ebdf4e8db4 100644 --- a/esphome/components/hitachi_ac344/climate.py +++ b/esphome/components/hitachi_ac344/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] hitachi_ac344_ns = cg.esphome_ns.namespace("hitachi_ac344") HitachiClimate = hitachi_ac344_ns.class_("HitachiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(HitachiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(HitachiClimate) async def to_code(config): diff --git a/esphome/components/hitachi_ac424/climate.py b/esphome/components/hitachi_ac424/climate.py index 4b20147922..fde4e77545 100644 --- a/esphome/components/hitachi_ac424/climate.py +++ b/esphome/components/hitachi_ac424/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] hitachi_ac424_ns = cg.esphome_ns.namespace("hitachi_ac424") HitachiClimate = hitachi_ac424_ns.class_("HitachiClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(HitachiClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(HitachiClimate) async def to_code(config): diff --git a/esphome/components/midea_ir/climate.py b/esphome/components/midea_ir/climate.py index 5c9256b5e4..cbf5fae6fe 100644 --- a/esphome/components/midea_ir/climate.py +++ b/esphome/components/midea_ir/climate.py @@ -10,7 +10,7 @@ midea_ir_ns = cg.esphome_ns.namespace("midea_ir") MideaIR = midea_ir_ns.class_("MideaIR", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(MideaIR).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(MideaIR).extend( { cv.Optional(CONF_USE_FAHRENHEIT, default=False): cv.boolean, } diff --git a/esphome/components/mitsubishi/climate.py b/esphome/components/mitsubishi/climate.py index 5784d3ee8a..8291d70346 100644 --- a/esphome/components/mitsubishi/climate.py +++ b/esphome/components/mitsubishi/climate.py @@ -43,7 +43,7 @@ VERTICAL_DIRECTIONS = { } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(MitsubishiClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(MitsubishiClimate).extend( { cv.Optional(CONF_SET_FAN_MODE, default="3levels"): cv.enum(SETFANMODE), cv.Optional(CONF_SUPPORTS_DRY, default=False): cv.boolean, diff --git a/esphome/components/noblex/climate.py b/esphome/components/noblex/climate.py index d619265d01..19c4b6a08e 100644 --- a/esphome/components/noblex/climate.py +++ b/esphome/components/noblex/climate.py @@ -6,7 +6,7 @@ AUTO_LOAD = ["climate_ir"] noblex_ns = cg.esphome_ns.namespace("noblex") NoblexClimate = noblex_ns.class_("NoblexClimate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(NoblexClimate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(NoblexClimate) async def to_code(config): diff --git a/esphome/components/tcl112/climate.py b/esphome/components/tcl112/climate.py index 9864113a52..58ed7ee529 100644 --- a/esphome/components/tcl112/climate.py +++ b/esphome/components/tcl112/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@glmnet"] tcl112_ns = cg.esphome_ns.namespace("tcl112") Tcl112Climate = tcl112_ns.class_("Tcl112Climate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(Tcl112Climate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(Tcl112Climate) async def to_code(config): diff --git a/esphome/components/toshiba/climate.py b/esphome/components/toshiba/climate.py index 40112fc460..b8e390dd66 100644 --- a/esphome/components/toshiba/climate.py +++ b/esphome/components/toshiba/climate.py @@ -16,7 +16,7 @@ MODELS = { "RAC-PT1411HWRU-F": Model.MODEL_RAC_PT1411HWRU_F, } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(ToshibaClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(ToshibaClimate).extend( { cv.Optional(CONF_MODEL, default="generic"): cv.enum(MODELS, upper=True), } diff --git a/esphome/components/whirlpool/climate.py b/esphome/components/whirlpool/climate.py index daee9e7fb7..f969a505fb 100644 --- a/esphome/components/whirlpool/climate.py +++ b/esphome/components/whirlpool/climate.py @@ -15,7 +15,7 @@ MODELS = { "DG11J1-91": Model.MODEL_DG11J1_91, } -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(WhirlpoolClimate).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(WhirlpoolClimate).extend( { cv.Optional(CONF_MODEL, default="DG11J1-3A"): cv.enum(MODELS, upper=True), } diff --git a/esphome/components/whynter/climate.py b/esphome/components/whynter/climate.py index 4a01c014c7..bf33890d9c 100644 --- a/esphome/components/whynter/climate.py +++ b/esphome/components/whynter/climate.py @@ -9,7 +9,7 @@ whynter_ns = cg.esphome_ns.namespace("whynter") Whynter = whynter_ns.class_("Whynter", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(Whynter).extend( +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(Whynter).extend( { cv.Optional(CONF_USE_FAHRENHEIT, default=False): cv.boolean, } diff --git a/esphome/components/zhlt01/climate.py b/esphome/components/zhlt01/climate.py index d5098ab42c..8d0c50308b 100644 --- a/esphome/components/zhlt01/climate.py +++ b/esphome/components/zhlt01/climate.py @@ -7,7 +7,7 @@ CODEOWNERS = ["@cfeenstra1024"] zhlt01_ns = cg.esphome_ns.namespace("zhlt01") ZHLT01Climate = zhlt01_ns.class_("ZHLT01Climate", climate_ir.ClimateIR) -CONFIG_SCHEMA = climate_ir.climare_ir_with_receiver_schema(ZHLT01Climate) +CONFIG_SCHEMA = climate_ir.climate_ir_with_receiver_schema(ZHLT01Climate) async def to_code(config): From 316fe2f06cfa7333b072e9ef09c2b8d5d18f3bd5 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sun, 18 May 2025 15:43:41 -0400 Subject: [PATCH 22/82] Fix ESP32 console logging corruption and message loss in multi-task (#8806) --- esphome/components/logger/logger.cpp | 44 +++++++++++++++++++--------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/esphome/components/logger/logger.cpp b/esphome/components/logger/logger.cpp index 0ad909cb07..014f7e3dec 100644 --- a/esphome/components/logger/logger.cpp +++ b/esphome/components/logger/logger.cpp @@ -16,9 +16,14 @@ static const char *const TAG = "logger"; #ifdef USE_ESP32 // Implementation for ESP32 (multi-task platform with task-specific tracking) // Main task always uses direct buffer access for console output and callbacks -// Other tasks: -// - With task log buffer: stack buffer for console output, async buffer for callbacks -// - Without task log buffer: only console output, no callbacks +// +// For non-main tasks: +// - WITH task log buffer: Prefer sending to ring buffer for async processing +// - Avoids allocating stack memory for console output in normal operation +// - Prevents console corruption from concurrent writes by multiple tasks +// - Messages are serialized through main loop for proper console output +// - Fallback to emergency console logging only if ring buffer is full +// - WITHOUT task log buffer: Only emergency console output, no callbacks void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char *format, va_list args) { // NOLINT if (level > this->level_for(tag)) return; @@ -38,8 +43,18 @@ void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char * return; } - // For non-main tasks: use stack-allocated buffer only for console output - if (this->baud_rate_ > 0) { // If logging is enabled, write to console + bool message_sent = false; +#ifdef USE_ESPHOME_TASK_LOG_BUFFER + // For non-main tasks, queue the message for callbacks - but only if we have any callbacks registered + message_sent = this->log_buffer_->send_message_thread_safe(static_cast(level), tag, + static_cast(line), current_task, format, args); +#endif // USE_ESPHOME_TASK_LOG_BUFFER + + // Emergency console logging for non-main tasks when ring buffer is full or disabled + // This is a fallback mechanism to ensure critical log messages are visible + // Note: This may cause interleaved/corrupted console output if multiple tasks + // log simultaneously, but it's better than losing important messages entirely + if (!message_sent && this->baud_rate_ > 0) { // If logging is enabled, write to console // Maximum size for console log messages (includes null terminator) static const size_t MAX_CONSOLE_LOG_MSG_SIZE = 144; char console_buffer[MAX_CONSOLE_LOG_MSG_SIZE]; // MUST be stack allocated for thread safety @@ -49,15 +64,6 @@ void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char * this->write_msg_(console_buffer); } -#ifdef USE_ESPHOME_TASK_LOG_BUFFER - // For non-main tasks, queue the message for callbacks - but only if we have any callbacks registered - if (this->log_callback_.size() > 0) { - // This will be processed in the main loop - this->log_buffer_->send_message_thread_safe(static_cast(level), tag, static_cast(line), - current_task, format, args); - } -#endif // USE_ESPHOME_TASK_LOG_BUFFER - // Reset the recursion guard for this task this->reset_task_log_recursion_(is_main_task); } @@ -184,7 +190,17 @@ void Logger::loop() { this->write_footer_to_buffer_(this->tx_buffer_, &this->tx_buffer_at_, this->tx_buffer_size_); this->tx_buffer_[this->tx_buffer_at_] = '\0'; this->call_log_callbacks_(message->level, message->tag, this->tx_buffer_); + // At this point all the data we need from message has been transferred to the tx_buffer + // so we can release the message to allow other tasks to use it as soon as possible. this->log_buffer_->release_message_main_loop(received_token); + + // Write to console from the main loop to prevent corruption from concurrent writes + // This ensures all log messages appear on the console in a clean, serialized manner + // Note: Messages may appear slightly out of order due to async processing, but + // this is preferred over corrupted/interleaved console output + if (this->baud_rate_ > 0) { + this->write_msg_(this->tx_buffer_); + } } } #endif From 15d0b4355ebf88699d423b95e0226100854f02b3 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sun, 18 May 2025 15:48:57 -0400 Subject: [PATCH 23/82] Reduce number of calls to fetch time in the main loop (#8804) --- esphome/components/api/api_connection.cpp | 5 +-- esphome/components/bedjet/bedjet_hub.cpp | 1 + .../bluetooth_proxy/bluetooth_proxy.cpp | 3 +- esphome/components/cse7766/cse7766.cpp | 3 +- .../current_based/current_based_cover.cpp | 3 +- esphome/components/daly_bms/daly_bms.cpp | 3 +- esphome/components/debug/debug_component.cpp | 2 +- esphome/components/endstop/endstop_cover.cpp | 3 +- .../components/esp32_ble/ble_advertising.cpp | 3 +- .../components/esp32_camera/esp32_camera.cpp | 3 +- .../esp32_improv/esp32_improv_component.cpp | 2 +- .../components/esp32_touch/esp32_touch.cpp | 2 +- .../ethernet/ethernet_component.cpp | 2 +- .../components/feedback/feedback_cover.cpp | 3 +- esphome/components/gcja5/gcja5.cpp | 3 +- .../growatt_solar/growatt_solar.cpp | 3 +- esphome/components/kuntze/kuntze.cpp | 3 +- .../matrix_keypad/matrix_keypad.cpp | 3 +- .../components/max7219digit/max7219digit.cpp | 3 +- esphome/components/modbus/modbus.cpp | 3 +- esphome/components/mqtt/mqtt_client.cpp | 2 +- esphome/components/pmsx003/pmsx003.cpp | 3 +- esphome/components/pzem004t/pzem004t.cpp | 3 +- esphome/components/rf_bridge/rf_bridge.cpp | 3 +- esphome/components/sds011/sds011.cpp | 3 +- .../components/slow_pwm/slow_pwm_output.cpp | 3 +- esphome/components/sprinkler/sprinkler.cpp | 11 ++++--- .../time_based/time_based_cover.cpp | 3 +- .../components/uart/switch/uart_switch.cpp | 3 +- .../climate/uponor_smatrix_climate.cpp | 3 +- .../uponor_smatrix/uponor_smatrix.cpp | 3 +- esphome/core/application.cpp | 32 +++++++++++++------ esphome/core/application.h | 6 +++- esphome/core/component.cpp | 15 ++++++--- esphome/core/component.h | 6 +++- esphome/core/scheduler.cpp | 5 ++- 36 files changed, 107 insertions(+), 53 deletions(-) diff --git a/esphome/components/api/api_connection.cpp b/esphome/components/api/api_connection.cpp index ee0451f499..847d7840dc 100644 --- a/esphome/components/api/api_connection.cpp +++ b/esphome/components/api/api_connection.cpp @@ -8,6 +8,7 @@ #include "esphome/core/hal.h" #include "esphome/core/log.h" #include "esphome/core/version.h" +#include "esphome/core/application.h" #ifdef USE_DEEP_SLEEP #include "esphome/components/deep_sleep/deep_sleep_component.h" @@ -146,7 +147,7 @@ void APIConnection::loop() { } return; } else { - this->last_traffic_ = millis(); + this->last_traffic_ = App.get_loop_component_start_time(); // read a packet this->read_message(buffer.data_len, buffer.type, &buffer.container[buffer.data_offset]); if (this->remove_) @@ -163,7 +164,7 @@ void APIConnection::loop() { static uint32_t keepalive = 60000; static uint8_t max_ping_retries = 60; static uint16_t ping_retry_interval = 1000; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->sent_ping_) { // Disconnect if not responded within 2.5*keepalive if (now - this->last_traffic_ > (keepalive * 5) / 2) { diff --git a/esphome/components/bedjet/bedjet_hub.cpp b/esphome/components/bedjet/bedjet_hub.cpp index 6404298697..fea7080de6 100644 --- a/esphome/components/bedjet/bedjet_hub.cpp +++ b/esphome/components/bedjet/bedjet_hub.cpp @@ -3,6 +3,7 @@ #include "bedjet_hub.h" #include "bedjet_child.h" #include "bedjet_const.h" +#include "esphome/core/application.h" #include namespace esphome { diff --git a/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp b/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp index 915d2882d3..d8b2111cb0 100644 --- a/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp +++ b/esphome/components/bluetooth_proxy/bluetooth_proxy.cpp @@ -2,6 +2,7 @@ #include "esphome/core/log.h" #include "esphome/core/macros.h" +#include "esphome/core/application.h" #ifdef USE_ESP32 @@ -177,7 +178,7 @@ void BluetoothProxy::loop() { // Flush any pending BLE advertisements that have been accumulated but not yet sent if (this->raw_advertisements_) { static uint32_t last_flush_time = 0; - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); // Flush accumulated advertisements every 100ms if (now - last_flush_time >= 100) { diff --git a/esphome/components/cse7766/cse7766.cpp b/esphome/components/cse7766/cse7766.cpp index 88a91e374a..b0876778a3 100644 --- a/esphome/components/cse7766/cse7766.cpp +++ b/esphome/components/cse7766/cse7766.cpp @@ -1,5 +1,6 @@ #include "cse7766.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace cse7766 { @@ -7,7 +8,7 @@ namespace cse7766 { static const char *const TAG = "cse7766"; void CSE7766Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_transmission_ >= 500) { // last transmission too long ago. Reset RX index. this->raw_data_index_ = 0; diff --git a/esphome/components/current_based/current_based_cover.cpp b/esphome/components/current_based/current_based_cover.cpp index 8404e07894..8bb27dbeca 100644 --- a/esphome/components/current_based/current_based_cover.cpp +++ b/esphome/components/current_based/current_based_cover.cpp @@ -1,6 +1,7 @@ #include "current_based_cover.h" #include "esphome/core/hal.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include namespace esphome { @@ -60,7 +61,7 @@ void CurrentBasedCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->current_operation == COVER_OPERATION_OPENING) { if (this->malfunction_detection_ && this->is_closing_()) { // Malfunction diff --git a/esphome/components/daly_bms/daly_bms.cpp b/esphome/components/daly_bms/daly_bms.cpp index 929f31e008..1dd0520465 100644 --- a/esphome/components/daly_bms/daly_bms.cpp +++ b/esphome/components/daly_bms/daly_bms.cpp @@ -1,6 +1,7 @@ #include "daly_bms.h" #include #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace daly_bms { @@ -32,7 +33,7 @@ void DalyBmsComponent::update() { } void DalyBmsComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->receiving_ && (now - this->last_transmission_ >= 200)) { // last transmission too long ago. Reset RX index. ESP_LOGW(TAG, "Last transmission too long ago. Reset RX index."); diff --git a/esphome/components/debug/debug_component.cpp b/esphome/components/debug/debug_component.cpp index 5bcc676247..c4de42c7e9 100644 --- a/esphome/components/debug/debug_component.cpp +++ b/esphome/components/debug/debug_component.cpp @@ -70,7 +70,7 @@ void DebugComponent::loop() { #ifdef USE_SENSOR // calculate loop time - from last call to this one if (this->loop_time_sensor_ != nullptr) { - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); uint32_t loop_time = now - this->last_loop_timetag_; this->max_loop_time_ = std::max(this->max_loop_time_, loop_time); this->last_loop_timetag_ = now; diff --git a/esphome/components/endstop/endstop_cover.cpp b/esphome/components/endstop/endstop_cover.cpp index 1190acc46b..381f098eb5 100644 --- a/esphome/components/endstop/endstop_cover.cpp +++ b/esphome/components/endstop/endstop_cover.cpp @@ -1,6 +1,7 @@ #include "endstop_cover.h" #include "esphome/core/log.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" namespace esphome { namespace endstop { @@ -65,7 +66,7 @@ void EndstopCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->current_operation == COVER_OPERATION_OPENING && this->is_open_()) { float dur = (now - this->start_dir_time_) / 1e3f; diff --git a/esphome/components/esp32_ble/ble_advertising.cpp b/esphome/components/esp32_ble/ble_advertising.cpp index 1d340c76d9..8d43b5af33 100644 --- a/esphome/components/esp32_ble/ble_advertising.cpp +++ b/esphome/components/esp32_ble/ble_advertising.cpp @@ -6,6 +6,7 @@ #include #include "ble_uuid.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace esp32_ble { @@ -143,7 +144,7 @@ void BLEAdvertising::loop() { if (this->raw_advertisements_callbacks_.empty()) { return; } - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_advertisement_time_ > this->advertising_cycle_time_) { this->stop(); this->current_adv_index_ += 1; diff --git a/esphome/components/esp32_camera/esp32_camera.cpp b/esphome/components/esp32_camera/esp32_camera.cpp index e9e9d3cffb..60accba747 100644 --- a/esphome/components/esp32_camera/esp32_camera.cpp +++ b/esphome/components/esp32_camera/esp32_camera.cpp @@ -3,6 +3,7 @@ #include "esp32_camera.h" #include "esphome/core/log.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" #include @@ -162,7 +163,7 @@ void ESP32Camera::loop() { } // request idle image every idle_update_interval - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (this->idle_update_interval_ != 0 && now - this->last_idle_request_ > this->idle_update_interval_) { this->last_idle_request_ = now; this->request_image(IDLE); diff --git a/esphome/components/esp32_improv/esp32_improv_component.cpp b/esphome/components/esp32_improv/esp32_improv_component.cpp index b720425506..d74714838f 100644 --- a/esphome/components/esp32_improv/esp32_improv_component.cpp +++ b/esphome/components/esp32_improv/esp32_improv_component.cpp @@ -92,7 +92,7 @@ void ESP32ImprovComponent::loop() { if (!this->incoming_data_.empty()) this->process_incoming_data_(); - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); switch (this->state_) { case improv::STATE_STOPPED: diff --git a/esphome/components/esp32_touch/esp32_touch.cpp b/esphome/components/esp32_touch/esp32_touch.cpp index 69e4e37cec..1dcb39e5de 100644 --- a/esphome/components/esp32_touch/esp32_touch.cpp +++ b/esphome/components/esp32_touch/esp32_touch.cpp @@ -288,7 +288,7 @@ uint32_t ESP32TouchComponent::component_touch_pad_read(touch_pad_t tp) { } void ESP32TouchComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); bool should_print = this->setup_mode_ && now - this->setup_mode_last_log_print_ > 250; for (auto *child : this->children_) { child->value_ = this->component_touch_pad_read(child->get_touch_pad()); diff --git a/esphome/components/ethernet/ethernet_component.cpp b/esphome/components/ethernet/ethernet_component.cpp index 68a6e617fc..79ef0715d8 100644 --- a/esphome/components/ethernet/ethernet_component.cpp +++ b/esphome/components/ethernet/ethernet_component.cpp @@ -240,7 +240,7 @@ void EthernetComponent::setup() { } void EthernetComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); switch (this->state_) { case EthernetComponentState::STOPPED: diff --git a/esphome/components/feedback/feedback_cover.cpp b/esphome/components/feedback/feedback_cover.cpp index fa3166ba65..e419ee6229 100644 --- a/esphome/components/feedback/feedback_cover.cpp +++ b/esphome/components/feedback/feedback_cover.cpp @@ -1,6 +1,7 @@ #include "feedback_cover.h" #include "esphome/core/hal.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace feedback { @@ -220,7 +221,7 @@ void FeedbackCover::set_open_obstacle_sensor(binary_sensor::BinarySensor *open_o void FeedbackCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Recompute position every loop cycle this->recompute_position_(); diff --git a/esphome/components/gcja5/gcja5.cpp b/esphome/components/gcja5/gcja5.cpp index b1db58654b..64b237515b 100644 --- a/esphome/components/gcja5/gcja5.cpp +++ b/esphome/components/gcja5/gcja5.cpp @@ -6,6 +6,7 @@ */ #include "gcja5.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include namespace esphome { @@ -16,7 +17,7 @@ static const char *const TAG = "gcja5"; void GCJA5Component::setup() { ESP_LOGCONFIG(TAG, "Setting up gcja5..."); } void GCJA5Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_transmission_ >= 500) { // last transmission too long ago. Reset RX index. this->rx_message_.clear(); diff --git a/esphome/components/growatt_solar/growatt_solar.cpp b/esphome/components/growatt_solar/growatt_solar.cpp index c4ed5ab841..60fd1379e8 100644 --- a/esphome/components/growatt_solar/growatt_solar.cpp +++ b/esphome/components/growatt_solar/growatt_solar.cpp @@ -1,5 +1,6 @@ #include "growatt_solar.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace growatt_solar { @@ -18,7 +19,7 @@ void GrowattSolar::loop() { void GrowattSolar::update() { // If our last send has had no reply yet, and it wasn't that long ago, do nothing. - uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_send_ < this->get_update_interval() / 2) { return; } diff --git a/esphome/components/kuntze/kuntze.cpp b/esphome/components/kuntze/kuntze.cpp index e50dafca86..8ab7af8cd9 100644 --- a/esphome/components/kuntze/kuntze.cpp +++ b/esphome/components/kuntze/kuntze.cpp @@ -1,5 +1,6 @@ #include "kuntze.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace kuntze { @@ -60,7 +61,7 @@ void Kuntze::on_modbus_data(const std::vector &data) { } void Kuntze::loop() { - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); // timeout after 15 seconds if (this->waiting_ && (now - this->last_send_ > 15000)) { ESP_LOGW(TAG, "timed out waiting for response"); diff --git a/esphome/components/matrix_keypad/matrix_keypad.cpp b/esphome/components/matrix_keypad/matrix_keypad.cpp index 8537997935..6cb4fc4f3c 100644 --- a/esphome/components/matrix_keypad/matrix_keypad.cpp +++ b/esphome/components/matrix_keypad/matrix_keypad.cpp @@ -1,5 +1,6 @@ #include "matrix_keypad.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace matrix_keypad { @@ -28,7 +29,7 @@ void MatrixKeypad::setup() { void MatrixKeypad::loop() { static uint32_t active_start = 0; static int active_key = -1; - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); int key = -1; bool error = false; int pos = 0, row, col; diff --git a/esphome/components/max7219digit/max7219digit.cpp b/esphome/components/max7219digit/max7219digit.cpp index 13b75ca734..154accd66f 100644 --- a/esphome/components/max7219digit/max7219digit.cpp +++ b/esphome/components/max7219digit/max7219digit.cpp @@ -2,6 +2,7 @@ #include "esphome/core/log.h" #include "esphome/core/helpers.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" #include "max7219font.h" #include @@ -63,7 +64,7 @@ void MAX7219Component::dump_config() { } void MAX7219Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); const uint32_t millis_since_last_scroll = now - this->last_scroll_; const size_t first_line_size = this->max_displaybuffer_[0].size(); // check if the buffer has shrunk past the current position since last update diff --git a/esphome/components/modbus/modbus.cpp b/esphome/components/modbus/modbus.cpp index 47deea83e6..80c2ffe3d6 100644 --- a/esphome/components/modbus/modbus.cpp +++ b/esphome/components/modbus/modbus.cpp @@ -1,6 +1,7 @@ #include "modbus.h" #include "esphome/core/log.h" #include "esphome/core/helpers.h" +#include "esphome/core/application.h" namespace esphome { namespace modbus { @@ -13,7 +14,7 @@ void Modbus::setup() { } } void Modbus::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); while (this->available()) { uint8_t byte; diff --git a/esphome/components/mqtt/mqtt_client.cpp b/esphome/components/mqtt/mqtt_client.cpp index 1fcef3293c..e3722099a7 100644 --- a/esphome/components/mqtt/mqtt_client.cpp +++ b/esphome/components/mqtt/mqtt_client.cpp @@ -345,7 +345,7 @@ void MQTTClientComponent::loop() { this->disconnect_reason_.reset(); } - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); switch (this->state_) { case MQTT_CLIENT_DISABLED: diff --git a/esphome/components/pmsx003/pmsx003.cpp b/esphome/components/pmsx003/pmsx003.cpp index 11626768d8..0abed8a5a4 100644 --- a/esphome/components/pmsx003/pmsx003.cpp +++ b/esphome/components/pmsx003/pmsx003.cpp @@ -1,5 +1,6 @@ #include "pmsx003.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace pmsx003 { @@ -42,7 +43,7 @@ void PMSX003Component::dump_config() { } void PMSX003Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // If we update less often than it takes the device to stabilise, spin the fan down // rather than running it constantly. It does take some time to stabilise, so we diff --git a/esphome/components/pzem004t/pzem004t.cpp b/esphome/components/pzem004t/pzem004t.cpp index 35b66b03f2..356847825e 100644 --- a/esphome/components/pzem004t/pzem004t.cpp +++ b/esphome/components/pzem004t/pzem004t.cpp @@ -1,5 +1,6 @@ #include "pzem004t.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include namespace esphome { @@ -16,7 +17,7 @@ void PZEM004T::setup() { } void PZEM004T::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_read_ > 500 && this->available() < 7) { while (this->available()) this->read(); diff --git a/esphome/components/rf_bridge/rf_bridge.cpp b/esphome/components/rf_bridge/rf_bridge.cpp index 3b3e00a416..52ce037dbe 100644 --- a/esphome/components/rf_bridge/rf_bridge.cpp +++ b/esphome/components/rf_bridge/rf_bridge.cpp @@ -1,5 +1,6 @@ #include "rf_bridge.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" #include #include @@ -128,7 +129,7 @@ void RFBridgeComponent::write_byte_str_(const std::string &codes) { } void RFBridgeComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_bridge_byte_ > 50) { this->rx_buffer_.clear(); this->last_bridge_byte_ = now; diff --git a/esphome/components/sds011/sds011.cpp b/esphome/components/sds011/sds011.cpp index 0c04ff557f..a34059d85d 100644 --- a/esphome/components/sds011/sds011.cpp +++ b/esphome/components/sds011/sds011.cpp @@ -1,5 +1,6 @@ #include "sds011.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace sds011 { @@ -75,7 +76,7 @@ void SDS011Component::dump_config() { } void SDS011Component::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if ((now - this->last_transmission_ >= 500) && this->data_index_) { // last transmission too long ago. Reset RX index. ESP_LOGV(TAG, "Last transmission too long ago. Reset RX index."); diff --git a/esphome/components/slow_pwm/slow_pwm_output.cpp b/esphome/components/slow_pwm/slow_pwm_output.cpp index d6b2cdfe12..643294303c 100644 --- a/esphome/components/slow_pwm/slow_pwm_output.cpp +++ b/esphome/components/slow_pwm/slow_pwm_output.cpp @@ -1,5 +1,6 @@ #include "slow_pwm_output.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace slow_pwm { @@ -39,7 +40,7 @@ void SlowPWMOutput::set_output_state_(bool new_state) { } void SlowPWMOutput::loop() { - uint32_t now = millis(); + uint32_t now = App.get_loop_component_start_time(); float scaled_state = this->state_ * this->period_; if (now - this->period_start_time_ >= this->period_) { diff --git a/esphome/components/sprinkler/sprinkler.cpp b/esphome/components/sprinkler/sprinkler.cpp index 3cfb5ccdee..50ea3eff51 100644 --- a/esphome/components/sprinkler/sprinkler.cpp +++ b/esphome/components/sprinkler/sprinkler.cpp @@ -20,7 +20,7 @@ SprinklerSwitch::SprinklerSwitch(switch_::Switch *off_switch, switch_::Switch *o bool SprinklerSwitch::is_latching_valve() { return (this->off_switch_ != nullptr) && (this->on_switch_ != nullptr); } void SprinklerSwitch::loop() { - if ((this->pinned_millis_) && (millis() > this->pinned_millis_ + this->pulse_duration_)) { + if ((this->pinned_millis_) && (App.get_loop_component_start_time() > this->pinned_millis_ + this->pulse_duration_)) { this->pinned_millis_ = 0; // reset tracker if (this->off_switch_->state) { this->off_switch_->turn_off(); @@ -148,22 +148,23 @@ SprinklerValveOperator::SprinklerValveOperator(SprinklerValve *valve, Sprinkler : controller_(controller), valve_(valve) {} void SprinklerValveOperator::loop() { - if (millis() >= this->start_millis_) { // dummy check + uint32_t now = App.get_loop_component_start_time(); + if (now >= this->start_millis_) { // dummy check switch (this->state_) { case STARTING: - if (millis() > (this->start_millis_ + this->start_delay_)) { + if (now > (this->start_millis_ + this->start_delay_)) { this->run_(); // start_delay_ has been exceeded, so ensure both valves are on and update the state } break; case ACTIVE: - if (millis() > (this->start_millis_ + this->start_delay_ + this->run_duration_)) { + if (now > (this->start_millis_ + this->start_delay_ + this->run_duration_)) { this->stop(); // start_delay_ + run_duration_ has been exceeded, start shutting down } break; case STOPPING: - if (millis() > (this->stop_millis_ + this->stop_delay_)) { + if (now > (this->stop_millis_ + this->stop_delay_)) { this->kill_(); // stop_delay_has been exceeded, ensure all valves are off } break; diff --git a/esphome/components/time_based/time_based_cover.cpp b/esphome/components/time_based/time_based_cover.cpp index e1936d5ee1..ec219d6db7 100644 --- a/esphome/components/time_based/time_based_cover.cpp +++ b/esphome/components/time_based/time_based_cover.cpp @@ -1,6 +1,7 @@ #include "time_based_cover.h" #include "esphome/core/log.h" #include "esphome/core/hal.h" +#include "esphome/core/application.h" namespace esphome { namespace time_based { @@ -26,7 +27,7 @@ void TimeBasedCover::loop() { if (this->current_operation == COVER_OPERATION_IDLE) return; - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Recompute position every loop cycle this->recompute_position_(); diff --git a/esphome/components/uart/switch/uart_switch.cpp b/esphome/components/uart/switch/uart_switch.cpp index 1edb54641b..96f50ff50f 100644 --- a/esphome/components/uart/switch/uart_switch.cpp +++ b/esphome/components/uart/switch/uart_switch.cpp @@ -1,5 +1,6 @@ #include "uart_switch.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace uart { @@ -8,7 +9,7 @@ static const char *const TAG = "uart.switch"; void UARTSwitch::loop() { if (this->send_every_) { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); if (now - this->last_transmission_ > this->send_every_) { this->write_command_(this->state); this->last_transmission_ = now; diff --git a/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp b/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp index 5afc628db3..cc9b8a0f90 100644 --- a/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp +++ b/esphome/components/uponor_smatrix/climate/uponor_smatrix_climate.cpp @@ -1,6 +1,7 @@ #include "uponor_smatrix_climate.h" #include "esphome/core/helpers.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace uponor_smatrix { @@ -13,7 +14,7 @@ void UponorSmatrixClimate::dump_config() { } void UponorSmatrixClimate::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Publish state after all update packets are processed if (this->last_data_ != 0 && (now - this->last_data_ > 100) && this->target_temperature_raw_ != 0) { diff --git a/esphome/components/uponor_smatrix/uponor_smatrix.cpp b/esphome/components/uponor_smatrix/uponor_smatrix.cpp index e058de2852..2dbbef72ab 100644 --- a/esphome/components/uponor_smatrix/uponor_smatrix.cpp +++ b/esphome/components/uponor_smatrix/uponor_smatrix.cpp @@ -1,5 +1,6 @@ #include "uponor_smatrix.h" #include "esphome/core/log.h" +#include "esphome/core/application.h" namespace esphome { namespace uponor_smatrix { @@ -35,7 +36,7 @@ void UponorSmatrixComponent::dump_config() { } void UponorSmatrixComponent::loop() { - const uint32_t now = millis(); + const uint32_t now = App.get_loop_component_start_time(); // Discard stale data if (!this->rx_buffer_.empty() && (now - this->last_rx_ > 50)) { diff --git a/esphome/core/application.cpp b/esphome/core/application.cpp index 3f5a283fd8..a81a2c580c 100644 --- a/esphome/core/application.cpp +++ b/esphome/core/application.cpp @@ -67,22 +67,32 @@ void Application::loop() { uint32_t new_app_state = 0; this->scheduler.call(); - this->feed_wdt(); + + // Get the initial loop time at the start + uint32_t last_op_end_time = millis(); + + // Feed WDT with time + this->feed_wdt(last_op_end_time); + for (Component *component : this->looping_components_) { + // Update the cached time before each component runs + this->loop_component_start_time_ = last_op_end_time; + { this->set_current_component(component); - WarnIfComponentBlockingGuard guard{component}; + WarnIfComponentBlockingGuard guard{component, last_op_end_time}; component->call(); + // Use the finish method to get the current time as the end time + last_op_end_time = guard.finish(); } new_app_state |= component->get_component_state(); this->app_state_ |= new_app_state; - this->feed_wdt(); + this->feed_wdt(last_op_end_time); } this->app_state_ = new_app_state; - const uint32_t now = millis(); - - auto elapsed = now - this->last_loop_; + // Use the last component's end time instead of calling millis() again + auto elapsed = last_op_end_time - this->last_loop_; if (elapsed >= this->loop_interval_ || HighFrequencyLoopRequester::is_high_frequency()) { yield(); } else { @@ -94,7 +104,7 @@ void Application::loop() { delay_time = std::min(next_schedule, delay_time); delay(delay_time); } - this->last_loop_ = now; + this->last_loop_ = last_op_end_time; if (this->dump_config_at_ < this->components_.size()) { if (this->dump_config_at_ == 0) { @@ -109,10 +119,12 @@ void Application::loop() { } } -void IRAM_ATTR HOT Application::feed_wdt() { +void IRAM_ATTR HOT Application::feed_wdt(uint32_t time) { static uint32_t last_feed = 0; - uint32_t now = micros(); - if (now - last_feed > 3000) { + // Use provided time if available, otherwise get current time + uint32_t now = time ? time : millis(); + // Compare in milliseconds (3ms threshold) + if (now - last_feed > 3) { arch_feed_wdt(); last_feed = now; #ifdef USE_STATUS_LED diff --git a/esphome/core/application.h b/esphome/core/application.h index e64e2b7655..aa44d9ba1d 100644 --- a/esphome/core/application.h +++ b/esphome/core/application.h @@ -217,6 +217,9 @@ class Application { std::string get_compilation_time() const { return this->compilation_time_; } + /// Get the cached time in milliseconds from when the current component started its loop execution + inline uint32_t IRAM_ATTR HOT get_loop_component_start_time() const { return this->loop_component_start_time_; } + /** Set the target interval with which to run the loop() calls. * If the loop() method takes longer than the target interval, ESPHome won't * sleep in loop(), but if the time spent in loop() is small than the target, ESPHome @@ -236,7 +239,7 @@ class Application { void schedule_dump_config() { this->dump_config_at_ = 0; } - void feed_wdt(); + void feed_wdt(uint32_t time = 0); void reboot(); @@ -551,6 +554,7 @@ class Application { size_t dump_config_at_{SIZE_MAX}; uint32_t app_state_{0}; Component *current_component_{nullptr}; + uint32_t loop_component_start_time_{0}; }; /// Global storage of Application pointer - only one Application can exist. diff --git a/esphome/core/component.cpp b/esphome/core/component.cpp index a7e451b93d..1141e4067d 100644 --- a/esphome/core/component.cpp +++ b/esphome/core/component.cpp @@ -240,10 +240,12 @@ void PollingComponent::stop_poller() { uint32_t PollingComponent::get_update_interval() const { return this->update_interval_; } void PollingComponent::set_update_interval(uint32_t update_interval) { this->update_interval_ = update_interval; } -WarnIfComponentBlockingGuard::WarnIfComponentBlockingGuard(Component *component) - : started_(millis()), component_(component) {} -WarnIfComponentBlockingGuard::~WarnIfComponentBlockingGuard() { - uint32_t blocking_time = millis() - this->started_; +WarnIfComponentBlockingGuard::WarnIfComponentBlockingGuard(Component *component, uint32_t start_time) + : started_(start_time), component_(component) {} +uint32_t WarnIfComponentBlockingGuard::finish() { + uint32_t curr_time = millis(); + + uint32_t blocking_time = curr_time - this->started_; bool should_warn; if (this->component_ != nullptr) { should_warn = this->component_->should_warn_of_blocking(blocking_time); @@ -254,8 +256,11 @@ WarnIfComponentBlockingGuard::~WarnIfComponentBlockingGuard() { const char *src = component_ == nullptr ? "" : component_->get_component_source(); ESP_LOGW(TAG, "Component %s took a long time for an operation (%" PRIu32 " ms).", src, blocking_time); ESP_LOGW(TAG, "Components should block for at most 30 ms."); - ; } + + return curr_time; } +WarnIfComponentBlockingGuard::~WarnIfComponentBlockingGuard() {} + } // namespace esphome diff --git a/esphome/core/component.h b/esphome/core/component.h index 412074282d..7b3e12eb59 100644 --- a/esphome/core/component.h +++ b/esphome/core/component.h @@ -339,7 +339,11 @@ class PollingComponent : public Component { class WarnIfComponentBlockingGuard { public: - WarnIfComponentBlockingGuard(Component *component); + WarnIfComponentBlockingGuard(Component *component, uint32_t start_time); + + // Finish the timing operation and return the current time + uint32_t finish(); + ~WarnIfComponentBlockingGuard(); protected: diff --git a/esphome/core/scheduler.cpp b/esphome/core/scheduler.cpp index b4f617d405..2dea450ead 100644 --- a/esphome/core/scheduler.cpp +++ b/esphome/core/scheduler.cpp @@ -229,8 +229,11 @@ void HOT Scheduler::call() { // - timeouts/intervals get added, potentially invalidating vector pointers // - timeouts/intervals get cancelled { - WarnIfComponentBlockingGuard guard{item->component}; + uint32_t now_ms = millis(); + WarnIfComponentBlockingGuard guard{item->component, now_ms}; item->callback(); + // Call finish to ensure blocking time is properly calculated and reported + guard.finish(); } } From 4d54cb9b316bf35b32d26332a2887ceae26fa30a Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sun, 18 May 2025 17:05:20 -0400 Subject: [PATCH 24/82] Refactor API frame helpers to enable buffer reuse (#8825) --- esphome/components/api/api_connection.cpp | 2 +- esphome/components/api/api_connection.h | 9 +- esphome/components/api/api_frame_helper.cpp | 128 ++++++++++++++------ esphome/components/api/api_frame_helper.h | 41 ++++++- esphome/components/api/proto.h | 28 +++++ 5 files changed, 162 insertions(+), 46 deletions(-) diff --git a/esphome/components/api/api_connection.cpp b/esphome/components/api/api_connection.cpp index 847d7840dc..d71e5587a3 100644 --- a/esphome/components/api/api_connection.cpp +++ b/esphome/components/api/api_connection.cpp @@ -1962,7 +1962,7 @@ bool APIConnection::send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) } } - APIError err = this->helper_->write_packet(message_type, buffer.get_buffer()->data(), buffer.get_buffer()->size()); + APIError err = this->helper_->write_protobuf_packet(message_type, buffer); if (err == APIError::WOULD_BLOCK) return false; if (err != APIError::OK) { diff --git a/esphome/components/api/api_connection.h b/esphome/components/api/api_connection.h index 1e47418d90..b40e9602be 100644 --- a/esphome/components/api/api_connection.h +++ b/esphome/components/api/api_connection.h @@ -315,7 +315,14 @@ class APIConnection : public APIServerConnection { ProtoWriteBuffer create_buffer(uint32_t reserve_size) override { // FIXME: ensure no recursive writes can happen this->proto_write_buffer_.clear(); - this->proto_write_buffer_.reserve(reserve_size); + // Get header padding size - used for both reserve and insert + uint8_t header_padding = this->helper_->frame_header_padding(); + // Reserve space for header padding + message + footer + // - Header padding: space for protocol headers (7 bytes for Noise, 6 for Plaintext) + // - Footer: space for MAC (16 bytes for Noise, 0 for Plaintext) + this->proto_write_buffer_.reserve(reserve_size + header_padding + this->helper_->frame_footer_size()); + // Insert header padding bytes so message encoding starts at the correct position + this->proto_write_buffer_.insert(this->proto_write_buffer_.begin(), header_padding, 0); return {&this->proto_write_buffer_}; } bool send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) override; diff --git a/esphome/components/api/api_frame_helper.cpp b/esphome/components/api/api_frame_helper.cpp index f251ceb6e4..f18f4104b6 100644 --- a/esphome/components/api/api_frame_helper.cpp +++ b/esphome/components/api/api_frame_helper.cpp @@ -493,9 +493,12 @@ void APINoiseFrameHelper::send_explicit_handshake_reject_(const std::string &rea std::vector data; data.resize(reason.length() + 1); data[0] = 0x01; // failure - for (size_t i = 0; i < reason.length(); i++) { - data[i + 1] = (uint8_t) reason[i]; + + // Copy error message in bulk + if (!reason.empty()) { + std::memcpy(data.data() + 1, reason.c_str(), reason.length()); } + // temporarily remove failed state auto orig_state = state_; state_ = State::EXPLICIT_REJECT; @@ -557,7 +560,7 @@ APIError APINoiseFrameHelper::read_packet(ReadPacketBuffer *buffer) { return APIError::OK; } bool APINoiseFrameHelper::can_write_without_blocking() { return state_ == State::DATA && tx_buf_.empty(); } -APIError APINoiseFrameHelper::write_packet(uint16_t type, const uint8_t *payload, size_t payload_len) { +APIError APINoiseFrameHelper::write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) { int err; APIError aerr; aerr = state_action_(); @@ -569,31 +572,36 @@ APIError APINoiseFrameHelper::write_packet(uint16_t type, const uint8_t *payload return APIError::WOULD_BLOCK; } + std::vector *raw_buffer = buffer.get_buffer(); + // Message data starts after padding + size_t payload_len = raw_buffer->size() - frame_header_padding_; size_t padding = 0; size_t msg_len = 4 + payload_len + padding; - size_t frame_len = 3 + msg_len + noise_cipherstate_get_mac_length(send_cipher_); - auto tmpbuf = std::unique_ptr{new (std::nothrow) uint8_t[frame_len]}; - if (tmpbuf == nullptr) { - HELPER_LOG("Could not allocate for writing packet"); - return APIError::OUT_OF_MEMORY; - } - tmpbuf[0] = 0x01; // indicator - // tmpbuf[1], tmpbuf[2] to be set later + // We need to resize to include MAC space, but we already reserved it in create_buffer + raw_buffer->resize(raw_buffer->size() + frame_footer_size_); + + // Write the noise header in the padded area + // Buffer layout: + // [0] - 0x01 indicator byte + // [1-2] - Size of encrypted payload (filled after encryption) + // [3-4] - Message type (encrypted) + // [5-6] - Payload length (encrypted) + // [7...] - Actual payload data (encrypted) + uint8_t *buf_start = raw_buffer->data(); + buf_start[0] = 0x01; // indicator + // buf_start[1], buf_start[2] to be set later after encryption const uint8_t msg_offset = 3; - const uint8_t payload_offset = msg_offset + 4; - tmpbuf[msg_offset + 0] = (uint8_t) (type >> 8); // type - tmpbuf[msg_offset + 1] = (uint8_t) type; - tmpbuf[msg_offset + 2] = (uint8_t) (payload_len >> 8); // data_len - tmpbuf[msg_offset + 3] = (uint8_t) payload_len; - // copy data - std::copy(payload, payload + payload_len, &tmpbuf[payload_offset]); - // fill padding with zeros - std::fill(&tmpbuf[payload_offset + payload_len], &tmpbuf[frame_len], 0); + buf_start[msg_offset + 0] = (uint8_t) (type >> 8); // type high byte + buf_start[msg_offset + 1] = (uint8_t) type; // type low byte + buf_start[msg_offset + 2] = (uint8_t) (payload_len >> 8); // data_len high byte + buf_start[msg_offset + 3] = (uint8_t) payload_len; // data_len low byte + // payload data is already in the buffer starting at position 7 NoiseBuffer mbuf; noise_buffer_init(mbuf); - noise_buffer_set_inout(mbuf, &tmpbuf[msg_offset], msg_len, frame_len - msg_offset); + // The capacity parameter should be msg_len + frame_footer_size_ (MAC length) to allow space for encryption + noise_buffer_set_inout(mbuf, buf_start + msg_offset, msg_len, msg_len + frame_footer_size_); err = noise_cipherstate_encrypt(send_cipher_, &mbuf); if (err != 0) { state_ = State::FAILED; @@ -602,11 +610,13 @@ APIError APINoiseFrameHelper::write_packet(uint16_t type, const uint8_t *payload } size_t total_len = 3 + mbuf.size; - tmpbuf[1] = (uint8_t) (mbuf.size >> 8); - tmpbuf[2] = (uint8_t) mbuf.size; + buf_start[1] = (uint8_t) (mbuf.size >> 8); + buf_start[2] = (uint8_t) mbuf.size; struct iovec iov; - iov.iov_base = &tmpbuf[0]; + // Point iov_base to the beginning of the buffer (no unused padding in Noise) + // We send the entire frame: indicator + size + encrypted(type + data_len + payload + MAC) + iov.iov_base = buf_start; iov.iov_len = total_len; // write raw to not have two packets sent if NAGLE disabled @@ -718,6 +728,8 @@ APIError APINoiseFrameHelper::check_handshake_finished_() { return APIError::HANDSHAKESTATE_SPLIT_FAILED; } + frame_footer_size_ = noise_cipherstate_get_mac_length(send_cipher_); + HELPER_LOG("Handshake complete!"); noise_handshakestate_free(handshake_); handshake_ = nullptr; @@ -990,28 +1002,66 @@ APIError APIPlaintextFrameHelper::read_packet(ReadPacketBuffer *buffer) { return APIError::OK; } bool APIPlaintextFrameHelper::can_write_without_blocking() { return state_ == State::DATA && tx_buf_.empty(); } -APIError APIPlaintextFrameHelper::write_packet(uint16_t type, const uint8_t *payload, size_t payload_len) { +APIError APIPlaintextFrameHelper::write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) { if (state_ != State::DATA) { return APIError::BAD_STATE; } - std::vector header; - header.reserve(1 + api::ProtoSize::varint(static_cast(payload_len)) + - api::ProtoSize::varint(static_cast(type))); - header.push_back(0x00); - ProtoVarInt(payload_len).encode(header); - ProtoVarInt(type).encode(header); + std::vector *raw_buffer = buffer.get_buffer(); + // Message data starts after padding (frame_header_padding_ = 6) + size_t payload_len = raw_buffer->size() - frame_header_padding_; - struct iovec iov[2]; - iov[0].iov_base = &header[0]; - iov[0].iov_len = header.size(); - if (payload_len == 0) { - return write_raw_(iov, 1); + // Calculate varint sizes for header components + size_t size_varint_len = api::ProtoSize::varint(static_cast(payload_len)); + size_t type_varint_len = api::ProtoSize::varint(static_cast(type)); + size_t total_header_len = 1 + size_varint_len + type_varint_len; + + if (total_header_len > frame_header_padding_) { + // Header is too large to fit in the padding + return APIError::BAD_ARG; } - iov[1].iov_base = const_cast(payload); - iov[1].iov_len = payload_len; - return write_raw_(iov, 2); + // Calculate where to start writing the header + // The header starts at the latest possible position to minimize unused padding + // + // Example 1 (small values): total_header_len = 3, header_offset = 6 - 3 = 3 + // [0-2] - Unused padding + // [3] - 0x00 indicator byte + // [4] - Payload size varint (1 byte, for sizes 0-127) + // [5] - Message type varint (1 byte, for types 0-127) + // [6...] - Actual payload data + // + // Example 2 (medium values): total_header_len = 4, header_offset = 6 - 4 = 2 + // [0-1] - Unused padding + // [2] - 0x00 indicator byte + // [3-4] - Payload size varint (2 bytes, for sizes 128-16383) + // [5] - Message type varint (1 byte, for types 0-127) + // [6...] - Actual payload data + // + // Example 3 (large values): total_header_len = 6, header_offset = 6 - 6 = 0 + // [0] - 0x00 indicator byte + // [1-3] - Payload size varint (3 bytes, for sizes 16384-2097151) + // [4-5] - Message type varint (2 bytes, for types 128-32767) + // [6...] - Actual payload data + uint8_t *buf_start = raw_buffer->data(); + size_t header_offset = frame_header_padding_ - total_header_len; + + // Write the plaintext header + buf_start[header_offset] = 0x00; // indicator + + // Encode size varint directly into buffer + ProtoVarInt(payload_len).encode_to_buffer_unchecked(buf_start + header_offset + 1, size_varint_len); + + // Encode type varint directly into buffer + ProtoVarInt(type).encode_to_buffer_unchecked(buf_start + header_offset + 1 + size_varint_len, type_varint_len); + + struct iovec iov; + // Point iov_base to the beginning of our header (skip unused padding) + // This ensures we only send the actual header and payload, not the empty padding bytes + iov.iov_base = buf_start + header_offset; + iov.iov_len = total_header_len + payload_len; + + return write_raw_(&iov, 1); } APIError APIPlaintextFrameHelper::try_send_tx_buf_() { // try send from tx_buf diff --git a/esphome/components/api/api_frame_helper.h b/esphome/components/api/api_frame_helper.h index db506ea1ce..25bfd594ec 100644 --- a/esphome/components/api/api_frame_helper.h +++ b/esphome/components/api/api_frame_helper.h @@ -16,6 +16,8 @@ namespace esphome { namespace api { +class ProtoWriteBuffer; + struct ReadPacketBuffer { std::vector container; uint16_t type; @@ -65,32 +67,46 @@ class APIFrameHelper { virtual APIError loop() = 0; virtual APIError read_packet(ReadPacketBuffer *buffer) = 0; virtual bool can_write_without_blocking() = 0; - virtual APIError write_packet(uint16_t type, const uint8_t *data, size_t len) = 0; + virtual APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) = 0; virtual std::string getpeername() = 0; virtual int getpeername(struct sockaddr *addr, socklen_t *addrlen) = 0; virtual APIError close() = 0; virtual APIError shutdown(int how) = 0; // Give this helper a name for logging virtual void set_log_info(std::string info) = 0; + // Get the frame header padding required by this protocol + virtual uint8_t frame_header_padding() = 0; + // Get the frame footer size required by this protocol + virtual uint8_t frame_footer_size() = 0; protected: // Common implementation for writing raw data to socket template APIError write_raw_(const struct iovec *iov, int iovcnt, socket::Socket *socket, std::vector &tx_buf, const std::string &info, StateEnum &state, StateEnum failed_state); + + uint8_t frame_header_padding_{0}; + uint8_t frame_footer_size_{0}; }; #ifdef USE_API_NOISE class APINoiseFrameHelper : public APIFrameHelper { public: APINoiseFrameHelper(std::unique_ptr socket, std::shared_ptr ctx) - : socket_(std::move(socket)), ctx_(std::move(std::move(ctx))) {} + : socket_(std::move(socket)), ctx_(std::move(ctx)) { + // Noise header structure: + // Pos 0: indicator (0x01) + // Pos 1-2: encrypted payload size (16-bit big-endian) + // Pos 3-6: encrypted type (16-bit) + data_len (16-bit) + // Pos 7+: actual payload data + frame_header_padding_ = 7; + } ~APINoiseFrameHelper() override; APIError init() override; APIError loop() override; APIError read_packet(ReadPacketBuffer *buffer) override; bool can_write_without_blocking() override; - APIError write_packet(uint16_t type, const uint8_t *payload, size_t len) override; + APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override; std::string getpeername() override { return this->socket_->getpeername(); } int getpeername(struct sockaddr *addr, socklen_t *addrlen) override { return this->socket_->getpeername(addr, addrlen); @@ -99,6 +115,10 @@ class APINoiseFrameHelper : public APIFrameHelper { APIError shutdown(int how) override; // Give this helper a name for logging void set_log_info(std::string info) override { info_ = std::move(info); } + // Get the frame header padding required by this protocol + uint8_t frame_header_padding() override { return frame_header_padding_; } + // Get the frame footer size required by this protocol + uint8_t frame_footer_size() override { return frame_footer_size_; } protected: struct ParsedFrame { @@ -152,13 +172,20 @@ class APINoiseFrameHelper : public APIFrameHelper { #ifdef USE_API_PLAINTEXT class APIPlaintextFrameHelper : public APIFrameHelper { public: - APIPlaintextFrameHelper(std::unique_ptr socket) : socket_(std::move(socket)) {} + APIPlaintextFrameHelper(std::unique_ptr socket) : socket_(std::move(socket)) { + // Plaintext header structure (worst case): + // Pos 0: indicator (0x00) + // Pos 1-3: payload size varint (up to 3 bytes) + // Pos 4-5: message type varint (up to 2 bytes) + // Pos 6+: actual payload data + frame_header_padding_ = 6; + } ~APIPlaintextFrameHelper() override = default; APIError init() override; APIError loop() override; APIError read_packet(ReadPacketBuffer *buffer) override; bool can_write_without_blocking() override; - APIError write_packet(uint16_t type, const uint8_t *payload, size_t len) override; + APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override; std::string getpeername() override { return this->socket_->getpeername(); } int getpeername(struct sockaddr *addr, socklen_t *addrlen) override { return this->socket_->getpeername(addr, addrlen); @@ -167,6 +194,10 @@ class APIPlaintextFrameHelper : public APIFrameHelper { APIError shutdown(int how) override; // Give this helper a name for logging void set_log_info(std::string info) override { info_ = std::move(info); } + // Get the frame header padding required by this protocol + uint8_t frame_header_padding() override { return frame_header_padding_; } + // Get the frame footer size required by this protocol + uint8_t frame_footer_size() override { return frame_footer_size_; } protected: struct ParsedFrame { diff --git a/esphome/components/api/proto.h b/esphome/components/api/proto.h index e110a58eda..65bef0b6f7 100644 --- a/esphome/components/api/proto.h +++ b/esphome/components/api/proto.h @@ -83,6 +83,34 @@ class ProtoVarInt { return static_cast(this->value_ >> 1); } } + /** + * Encode the varint value to a pre-allocated buffer without bounds checking. + * + * @param buffer The pre-allocated buffer to write the encoded varint to + * @param len The size of the buffer in bytes + * + * @note The caller is responsible for ensuring the buffer is large enough + * to hold the encoded value. Use ProtoSize::varint() to calculate + * the exact size needed before calling this method. + * @note No bounds checking is performed for performance reasons. + */ + void encode_to_buffer_unchecked(uint8_t *buffer, size_t len) { + uint64_t val = this->value_; + if (val <= 0x7F) { + buffer[0] = val; + return; + } + size_t i = 0; + while (val && i < len) { + uint8_t temp = val & 0x7F; + val >>= 7; + if (val) { + buffer[i++] = temp | 0x80; + } else { + buffer[i++] = temp; + } + } + } void encode(std::vector &out) { uint64_t val = this->value_; if (val <= 0x7F) { From 1b9ae57b9d553e251fdc6e1180a072cf0c64ac81 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 May 2025 09:20:29 +1200 Subject: [PATCH 25/82] Bump docker/build-push-action from 6.16.0 to 6.17.0 in /.github/actions/build-image (#8810) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/actions/build-image/action.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/actions/build-image/action.yaml b/.github/actions/build-image/action.yaml index 3d6de54f42..0e41314ce6 100644 --- a/.github/actions/build-image/action.yaml +++ b/.github/actions/build-image/action.yaml @@ -47,7 +47,7 @@ runs: - name: Build and push to ghcr by digest id: build-ghcr - uses: docker/build-push-action@v6.16.0 + uses: docker/build-push-action@v6.17.0 env: DOCKER_BUILD_SUMMARY: false DOCKER_BUILD_RECORD_UPLOAD: false @@ -73,7 +73,7 @@ runs: - name: Build and push to dockerhub by digest id: build-dockerhub - uses: docker/build-push-action@v6.16.0 + uses: docker/build-push-action@v6.17.0 env: DOCKER_BUILD_SUMMARY: false DOCKER_BUILD_RECORD_UPLOAD: false From 38cfd323829552e2aa7843894295c5a6c04dfdab Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Mon, 19 May 2025 09:24:53 +1200 Subject: [PATCH 26/82] Bump version to 2025.5.0b3 --- esphome/const.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/esphome/const.py b/esphome/const.py index f48de581ea..9b38c8b085 100644 --- a/esphome/const.py +++ b/esphome/const.py @@ -1,6 +1,6 @@ """Constants used by esphome.""" -__version__ = "2025.5.0b2" +__version__ = "2025.5.0b3" ALLOWED_NAME_CHARS = "abcdefghijklmnopqrstuvwxyz0123456789-_" VALID_SUBSTITUTIONS_CHARACTERS = ( From dbce54477a2b6238510d09776482eb688f61c79f Mon Sep 17 00:00:00 2001 From: Thomas Rupprecht Date: Sun, 18 May 2025 23:44:33 +0200 Subject: [PATCH 27/82] unify and add missing metric suffixes (#8816) --- esphome/config_validation.py | 43 ++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 17 deletions(-) diff --git a/esphome/config_validation.py b/esphome/config_validation.py index 2eabcc8568..54056240ce 100644 --- a/esphome/config_validation.py +++ b/esphome/config_validation.py @@ -982,23 +982,32 @@ def uuid(value): METRIC_SUFFIXES = { - "E": 1e18, - "P": 1e15, - "T": 1e12, - "G": 1e9, - "M": 1e6, - "k": 1e3, - "da": 10, - "d": 1e-1, - "c": 1e-2, - "m": 0.001, - "µ": 1e-6, - "u": 1e-6, - "n": 1e-9, - "p": 1e-12, - "f": 1e-15, - "a": 1e-18, - "": 1, + "Q": 1e30, # Quetta + "R": 1e27, # Ronna + "Y": 1e24, # Yotta + "Z": 1e21, # Zetta + "E": 1e18, # Exa + "P": 1e15, # Peta + "T": 1e12, # Tera + "G": 1e9, # Giga + "M": 1e6, # Mega + "k": 1e3, # Kilo + "h": 1e2, # Hecto + "da": 1e1, # Deca + "": 1e0, # No prefix + "d": 1e-1, # Deci + "c": 1e-2, # Centi + "m": 1e-3, # Milli + "µ": 1e-6, # Micro + "u": 1e-6, # Micro (same as µ) + "n": 1e-9, # Nano + "p": 1e-12, # Pico + "f": 1e-15, # Femto + "a": 1e-18, # Atto + "z": 1e-21, # Zepto + "y": 1e-24, # Yocto + "r": 1e-27, # Ronto + "q": 1e-30, # Quecto } From 87a9dd18c8213c95c5c76aba913934f1b11b661e Mon Sep 17 00:00:00 2001 From: DanielV Date: Mon, 19 May 2025 00:01:30 +0200 Subject: [PATCH 28/82] Improve stability for a test that crashes intermittently in CI (#8699) Co-authored-by: NP v/d Spek --- tests/dashboard/test_web_server.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/dashboard/test_web_server.py b/tests/dashboard/test_web_server.py index a61850abf3..1ea9c73f32 100644 --- a/tests/dashboard/test_web_server.py +++ b/tests/dashboard/test_web_server.py @@ -75,6 +75,7 @@ async def test_devices_page(dashboard: DashboardTestHelper) -> None: assert response.headers["content-type"] == "application/json" json_data = json.loads(response.body.decode()) configured_devices = json_data["configured"] + assert len(configured_devices) != 0 first_device = configured_devices[0] assert first_device["name"] == "pico" assert first_device["configuration"] == "pico.yaml" From 99c4f88c3f3ac43575638340ef267518173ccf8c Mon Sep 17 00:00:00 2001 From: Fexiven <48439988+Fexiven@users.noreply.github.com> Date: Mon, 19 May 2025 01:01:31 +0200 Subject: [PATCH 29/82] Update esp32-camera library version (#8832) --- esphome/components/esp32_camera/__init__.py | 2 +- esphome/components/esp32_camera/esp32_camera.cpp | 9 --------- esphome/idf_component.yml | 2 +- 3 files changed, 2 insertions(+), 11 deletions(-) diff --git a/esphome/components/esp32_camera/__init__.py b/esphome/components/esp32_camera/__init__.py index e55c54f097..b4038c1841 100644 --- a/esphome/components/esp32_camera/__init__.py +++ b/esphome/components/esp32_camera/__init__.py @@ -296,7 +296,7 @@ async def to_code(config): add_idf_component( name="esp32-camera", repo="https://github.com/espressif/esp32-camera.git", - ref="v2.0.9", + ref="v2.0.15", ) for conf in config.get(CONF_ON_STREAM_START, []): diff --git a/esphome/components/esp32_camera/esp32_camera.cpp b/esphome/components/esp32_camera/esp32_camera.cpp index 60accba747..cfcf7869d4 100644 --- a/esphome/components/esp32_camera/esp32_camera.cpp +++ b/esphome/components/esp32_camera/esp32_camera.cpp @@ -55,11 +55,7 @@ void ESP32Camera::dump_config() { ESP_LOGCONFIG(TAG, " HREF Pin: %d", conf.pin_href); ESP_LOGCONFIG(TAG, " Pixel Clock Pin: %d", conf.pin_pclk); ESP_LOGCONFIG(TAG, " External Clock: Pin:%d Frequency:%u", conf.pin_xclk, conf.xclk_freq_hz); -#ifdef USE_ESP_IDF // Temporary until the espressif/esp32-camera library is updated - ESP_LOGCONFIG(TAG, " I2C Pins: SDA:%d SCL:%d", conf.pin_sscb_sda, conf.pin_sscb_scl); -#else ESP_LOGCONFIG(TAG, " I2C Pins: SDA:%d SCL:%d", conf.pin_sccb_sda, conf.pin_sccb_scl); -#endif ESP_LOGCONFIG(TAG, " Reset Pin: %d", conf.pin_reset); switch (this->config_.frame_size) { case FRAMESIZE_QQVGA: @@ -239,13 +235,8 @@ void ESP32Camera::set_external_clock(uint8_t pin, uint32_t frequency) { this->config_.xclk_freq_hz = frequency; } void ESP32Camera::set_i2c_pins(uint8_t sda, uint8_t scl) { -#ifdef USE_ESP_IDF // Temporary until the espressif/esp32-camera library is updated - this->config_.pin_sscb_sda = sda; - this->config_.pin_sscb_scl = scl; -#else this->config_.pin_sccb_sda = sda; this->config_.pin_sccb_scl = scl; -#endif } void ESP32Camera::set_reset_pin(uint8_t pin) { this->config_.pin_reset = pin; } void ESP32Camera::set_power_down_pin(uint8_t pin) { this->config_.pin_pwdn = pin; } diff --git a/esphome/idf_component.yml b/esphome/idf_component.yml index c273cae07e..8460de5638 100644 --- a/esphome/idf_component.yml +++ b/esphome/idf_component.yml @@ -4,7 +4,7 @@ dependencies: version: v1.3.1 esp32_camera: git: https://github.com/espressif/esp32-camera.git - version: v2.0.9 + version: v2.0.15 mdns: git: https://github.com/espressif/esp-protocols.git version: mdns-v1.8.2 From 904495e1b87f3566361ee91911e959bff2503396 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Mon, 19 May 2025 13:57:41 +1200 Subject: [PATCH 30/82] Fix api doc homepage (#8836) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- esphome/components/weikai/weikai.cpp | 52 ---------------------------- esphome/core/doxygen.h | 13 +++++++ 2 files changed, 13 insertions(+), 52 deletions(-) create mode 100644 esphome/core/doxygen.h diff --git a/esphome/components/weikai/weikai.cpp b/esphome/components/weikai/weikai.cpp index 00bce9bcff..19aa09e20d 100644 --- a/esphome/components/weikai/weikai.cpp +++ b/esphome/components/weikai/weikai.cpp @@ -8,58 +8,6 @@ namespace esphome { namespace weikai { -/*! @mainpage Weikai source code documentation - This documentation provides information about the implementation of the family of WeiKai Components in ESPHome. - Here is the class diagram related to Weikai family of components: - @image html weikai_class.png - - @section WKRingBuffer_ The WKRingBuffer template class -The WKRingBuffer template class has it names implies implement a simple ring buffer helper class. This straightforward -container implements FIFO functionality, enabling bytes to be pushed into one side and popped from the other in the -order of entry. Implementation is classic and therefore not described in any details. - - @section WeikaiRegister_ The WeikaiRegister class - The WeikaiRegister helper class creates objects that act as proxies to the device registers. - @details This is an abstract virtual class (interface) that provides all the necessary access to registers while hiding - the actual implementation. The access to the registers can be made through an I²C bus in for example for wk2168_i2c - component or through a SPI bus for example in the case of the wk2168_spi component. Derived classes will actually - performs the specific bus operations. - - @section WeikaiRegisterI2C_ WeikaiRegisterI2C - The weikai_i2c::WeikaiRegisterI2C class implements the virtual methods of the WeikaiRegister class for an I2C bus. - - @section WeikaiRegisterSPI_ WeikaiRegisterSPI - The weikai_spi::WeikaiRegisterSPI class implements the virtual methods of the WeikaiRegister class for an SPI bus. - - @section WeikaiComponent_ The WeikaiComponent class -The WeikaiComponent class stores the information global to a WeiKai family component and provides methods to set/access -this information. It also serves as a container for WeikaiChannel instances. This is done by maintaining an array of -references these WeikaiChannel instances. This class derives from the esphome::Component classes. This class override -esphome::Component::loop() method to facilitate the seamless transfer of accumulated bytes from the receive -FIFO into the ring buffer. This process ensures quick access to the stored bytes, enhancing the overall efficiency of -the component. - - @section WeikaiComponentI2C_ WeikaiComponentI2C - The weikai_i2c::WeikaiComponentI2C class implements the virtual methods of the WeikaiComponent class for an I2C bus. - - @section WeikaiComponentSPI_ WeikaiComponentSPI - The weikai_spi::WeikaiComponentSPI class implements the virtual methods of the WeikaiComponent class for an SPI bus. - - @section WeikaiGPIOPin_ WeikaiGPIOPin class - The WeikaiGPIOPin class is an helper class to expose the GPIO pins of WK family components as if they were internal - GPIO pins. It also provides the setup() and dump_summary() methods. - - @section WeikaiChannel_ The WeikaiChannel class - The WeikaiChannel class is used to implement all the virtual methods of the ESPHome uart::UARTComponent class. An - individual instance of this class is created for each UART channel. It has a link back to the WeikaiComponent object it - belongs to. This class derives from the uart::UARTComponent class. It collaborates through an aggregation with - WeikaiComponent. This implies that WeikaiComponent acts as a container, housing several WeikaiChannel instances. - Furthermore, the WeikaiChannel class derives from the ESPHome uart::UARTComponent class, it also has an association - relationship with the WKRingBuffer and WeikaiRegister helper classes. Consequently, when a WeikaiChannel instance is - destroyed, the associated WKRingBuffer instance is also destroyed. - -*/ - static const char *const TAG = "weikai"; /// @brief convert an int to binary representation as C++ std::string diff --git a/esphome/core/doxygen.h b/esphome/core/doxygen.h new file mode 100644 index 0000000000..36a394bee9 --- /dev/null +++ b/esphome/core/doxygen.h @@ -0,0 +1,13 @@ +#pragma once + +namespace esphome { + +/*! @mainpage ESPHome source code documentation + This documentation provides references to the ESPHome source code classes and methods. + + @details This documentation site is purely for reference and does not contain any user documentation. + If you are contributing to ESPHome or building an ESPHome component, then you should be starting at + https://developers.esphome.io. +*/ + +} // namespace esphome From 2e15ee232d4e577df0243f793da266d870bcdb20 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Mon, 19 May 2025 14:09:38 +1200 Subject: [PATCH 31/82] Deploy doxygen docs to netlify (#8837) --- .github/workflows/release.yml | 50 + .gitignore | 1 + Doxyfile | 2877 +++++++++++++++++++++++++++++++++ script/bump-version.py | 6 + 4 files changed, 2934 insertions(+) create mode 100644 Doxyfile diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 41e9186987..098f1ec733 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -18,6 +18,7 @@ jobs: outputs: tag: ${{ steps.tag.outputs.tag }} branch_build: ${{ steps.tag.outputs.branch_build }} + deploy_env: ${{ steps.tag.outputs.environment }} steps: - uses: actions/checkout@v4.1.7 - name: Get tag @@ -27,6 +28,11 @@ jobs: if [[ "${{ github.event_name }}" = "release" ]]; then TAG="${{ github.event.release.tag_name}}" BRANCH_BUILD="false" + if [[ "${{ github.event.release.prerelease }}" = "true" ]]; then + ENVIRONMENT="beta" + else + ENVIRONMENT="production" + fi else TAG=$(cat esphome/const.py | sed -n -E "s/^__version__\s+=\s+\"(.+)\"$/\1/p") today="$(date --utc '+%Y%m%d')" @@ -35,12 +41,15 @@ jobs: if [[ "$BRANCH" != "dev" ]]; then TAG="${TAG}-${BRANCH}" BRANCH_BUILD="true" + ENVIRONMENT="" else BRANCH_BUILD="false" + ENVIRONMENT="dev" fi fi echo "tag=${TAG}" >> $GITHUB_OUTPUT echo "branch_build=${BRANCH_BUILD}" >> $GITHUB_OUTPUT + echo "deploy_env=${ENVIRONMENT}" >> $GITHUB_OUTPUT # yamllint enable rule:line-length deploy-pypi: @@ -251,3 +260,44 @@ jobs: version: "${{ needs.init.outputs.tag }}", } }) + + deploy-api-docs: + if: github.repository == 'esphome/esphome' && needs.init.outputs.branch_build == 'false' + runs-on: ubuntu-latest + needs: [init] + environment: ${{ needs.init.outputs.deploy_env }} + steps: + - name: Checkout repo + uses: actions/checkout@v4.1.7 + + - name: Set up Node.js + uses: actions/setup-node@v4.4.0 + with: + node-version: "22" + + - name: Generate docs + uses: mattnotmitt/doxygen-action@v1.12.0 + + - name: Deploy to netlify ${{ needs.init.outputs.deploy_env }} + if: needs.init.outputs.deploy_env != 'production' + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} + run: | + npx netlify-cli deploy \ + --dir api-docs \ + --no-build \ + --alias ${{ needs.init.outputs.deploy_env }} \ + --message "Deploy API docs for ${{ needs.init.outputs.tag }}" + + - name: Deploy to netlify production + if: needs.init.outputs.deploy_env == 'production' + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} + run: | + npx netlify-cli deploy \ + --dir api-docs \ + --no-build \ + --prod \ + --message "Deploy API docs for ${{ needs.init.outputs.tag }}" diff --git a/.gitignore b/.gitignore index ad38e26fdd..390d1ab45b 100644 --- a/.gitignore +++ b/.gitignore @@ -143,3 +143,4 @@ sdkconfig.* /components /managed_components +api-docs/ diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000000..f807ba5c4e --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2877 @@ +# Doxyfile 1.12.0 + +# This file describes the settings to be used by the documentation system +# Doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use Doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use Doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = ESPHome + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 2025.6.0-dev + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where Doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = YES + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by Doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which Doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where Doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by Doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and Doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = NO + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make Doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by Doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 6. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled Doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let Doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# Doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then Doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# Doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run Doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = YES + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and macOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = NO + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = NO + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = NO + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= NO + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# Doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by Doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by Doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents Doxygen's defaults, run Doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by Doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, Doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = esphome + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by Doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cpp \ + *.tcc \ + *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which Doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = *.cpp + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that Doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that Doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the Doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by Doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which Doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not Doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then Doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by Doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not Doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = api-docs + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank Doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that Doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that Doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of Doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank Doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that Doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank Doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that Doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by Doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, Doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# Doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by Doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# Doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# Doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the JavaScript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /