From cab6edd800283aa24d5abc0c5cd2e81ca728beb8 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Wed, 14 May 2025 21:25:44 -0500 Subject: [PATCH 01/11] Avoid protobuf message construction when tx buffer is full (#8787) Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> --- esphome/components/api/api_connection.cpp | 999 ++++++++-------------- esphome/components/api/api_connection.h | 296 +++++-- 2 files changed, 581 insertions(+), 714 deletions(-) diff --git a/esphome/components/api/api_connection.cpp b/esphome/components/api/api_connection.cpp index d71e5587a3..b7db88e6ba 100644 --- a/esphome/components/api/api_connection.cpp +++ b/esphome/components/api/api_connection.cpp @@ -30,7 +30,7 @@ static const char *const TAG = "api.connection"; static const int ESP32_CAMERA_STOP_STREAM = 5000; // helper for allowing only unique entries in the queue -void DeferredMessageQueue::dmq_push_back_with_dedup_(void *source, send_message_t *send_message) { +void DeferredMessageQueue::dmq_push_back_with_dedup_(void *source, send_message_t send_message) { DeferredMessage item(source, send_message); auto iter = std::find_if(this->deferred_queue_.begin(), this->deferred_queue_.end(), @@ -46,7 +46,7 @@ void DeferredMessageQueue::dmq_push_back_with_dedup_(void *source, send_message_ void DeferredMessageQueue::process_queue() { while (!deferred_queue_.empty()) { DeferredMessage &de = deferred_queue_.front(); - if (de.send_message_(this->api_connection_, de.source_)) { + if ((this->api_connection_->*(de.send_message_))(de.source_)) { // O(n) but memory efficiency is more important than speed here which is why std::vector was chosen deferred_queue_.erase(deferred_queue_.begin()); } else { @@ -55,7 +55,7 @@ void DeferredMessageQueue::process_queue() { } } -void DeferredMessageQueue::defer(void *source, send_message_t *send_message) { +void DeferredMessageQueue::defer(void *source, send_message_t send_message) { this->dmq_push_back_with_dedup_(source, send_message); } @@ -154,7 +154,9 @@ void APIConnection::loop() { return; } - this->deferred_message_queue_.process_queue(); + if (!this->deferred_message_queue_.empty() && this->helper_->can_write_without_blocking()) { + this->deferred_message_queue_.process_queue(); + } if (!this->list_entities_iterator_.completed()) this->list_entities_iterator_.advance(); @@ -268,96 +270,65 @@ void APIConnection::on_disconnect_response(const DisconnectResponse &value) { #ifdef USE_BINARY_SENSOR bool APIConnection::send_binary_sensor_state(binary_sensor::BinarySensor *binary_sensor, bool state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_binary_sensor_state(this, binary_sensor, state)) { - this->deferred_message_queue_.defer(binary_sensor, try_send_binary_sensor_state); - } - - return true; + return this->send_state_with_value_(binary_sensor, &APIConnection::try_send_binary_sensor_state_, + &APIConnection::try_send_binary_sensor_state_, state); } void APIConnection::send_binary_sensor_info(binary_sensor::BinarySensor *binary_sensor) { - if (!APIConnection::try_send_binary_sensor_info(this, binary_sensor)) { - this->deferred_message_queue_.defer(binary_sensor, try_send_binary_sensor_info); - } + this->send_info_(static_cast(binary_sensor), + reinterpret_cast(&APIConnection::try_send_binary_sensor_info_)); } -bool APIConnection::try_send_binary_sensor_state(APIConnection *api, void *v_binary_sensor) { - binary_sensor::BinarySensor *binary_sensor = reinterpret_cast(v_binary_sensor); - return APIConnection::try_send_binary_sensor_state(api, binary_sensor, binary_sensor->state); +bool APIConnection::try_send_binary_sensor_state_(binary_sensor::BinarySensor *binary_sensor) { + return this->try_send_binary_sensor_state_(binary_sensor, binary_sensor->state); } -bool APIConnection::try_send_binary_sensor_state(APIConnection *api, binary_sensor::BinarySensor *binary_sensor, - bool state) { - BinarySensorStateResponse resp; - resp.key = binary_sensor->get_object_id_hash(); - resp.state = state; - resp.missing_state = !binary_sensor->has_state(); - return api->send_binary_sensor_state_response(resp); -} -bool APIConnection::try_send_binary_sensor_info(APIConnection *api, void *v_binary_sensor) { - binary_sensor::BinarySensor *binary_sensor = reinterpret_cast(v_binary_sensor); - ListEntitiesBinarySensorResponse msg; - msg.object_id = binary_sensor->get_object_id(); +bool APIConnection::try_send_binary_sensor_state_(binary_sensor::BinarySensor *binary_sensor, bool state) { + BinarySensorStateResponse msg; + msg.state = state; + msg.missing_state = !binary_sensor->has_state(); msg.key = binary_sensor->get_object_id_hash(); - if (binary_sensor->has_own_name()) - msg.name = binary_sensor->get_name(); - msg.unique_id = get_default_unique_id("binary_sensor", binary_sensor); + return this->send_binary_sensor_state_response(msg); +} +bool APIConnection::try_send_binary_sensor_info_(binary_sensor::BinarySensor *binary_sensor) { + ListEntitiesBinarySensorResponse msg; msg.device_class = binary_sensor->get_device_class(); msg.is_status_binary_sensor = binary_sensor->is_status_binary_sensor(); - msg.disabled_by_default = binary_sensor->is_disabled_by_default(); - msg.icon = binary_sensor->get_icon(); - msg.entity_category = static_cast(binary_sensor->get_entity_category()); - return api->send_list_entities_binary_sensor_response(msg); + msg.unique_id = get_default_unique_id("binary_sensor", binary_sensor); + return this->try_send_entity_info_(static_cast(binary_sensor), msg, + &APIConnection::send_list_entities_binary_sensor_response); } #endif #ifdef USE_COVER bool APIConnection::send_cover_state(cover::Cover *cover) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_cover_state(this, cover)) { - this->deferred_message_queue_.defer(cover, try_send_cover_state); - } - - return true; + return this->send_state_(static_cast(cover), + reinterpret_cast(&APIConnection::try_send_cover_state_)); } void APIConnection::send_cover_info(cover::Cover *cover) { - if (!APIConnection::try_send_cover_info(this, cover)) { - this->deferred_message_queue_.defer(cover, try_send_cover_info); - } + this->send_info_(static_cast(cover), + reinterpret_cast(&APIConnection::try_send_cover_info_)); } -bool APIConnection::try_send_cover_state(APIConnection *api, void *v_cover) { - cover::Cover *cover = reinterpret_cast(v_cover); +bool APIConnection::try_send_cover_state_(cover::Cover *cover) { + CoverStateResponse msg; auto traits = cover->get_traits(); - CoverStateResponse resp{}; - resp.key = cover->get_object_id_hash(); - resp.legacy_state = + msg.legacy_state = (cover->position == cover::COVER_OPEN) ? enums::LEGACY_COVER_STATE_OPEN : enums::LEGACY_COVER_STATE_CLOSED; - resp.position = cover->position; + msg.position = cover->position; if (traits.get_supports_tilt()) - resp.tilt = cover->tilt; - resp.current_operation = static_cast(cover->current_operation); - return api->send_cover_state_response(resp); -} -bool APIConnection::try_send_cover_info(APIConnection *api, void *v_cover) { - cover::Cover *cover = reinterpret_cast(v_cover); - auto traits = cover->get_traits(); - ListEntitiesCoverResponse msg; + msg.tilt = cover->tilt; + msg.current_operation = static_cast(cover->current_operation); msg.key = cover->get_object_id_hash(); - msg.object_id = cover->get_object_id(); - if (cover->has_own_name()) - msg.name = cover->get_name(); - msg.unique_id = get_default_unique_id("cover", cover); + return this->send_cover_state_response(msg); +} +bool APIConnection::try_send_cover_info_(cover::Cover *cover) { + ListEntitiesCoverResponse msg; + auto traits = cover->get_traits(); msg.assumed_state = traits.get_is_assumed_state(); msg.supports_position = traits.get_supports_position(); msg.supports_tilt = traits.get_supports_tilt(); msg.supports_stop = traits.get_supports_stop(); msg.device_class = cover->get_device_class(); - msg.disabled_by_default = cover->is_disabled_by_default(); - msg.icon = cover->get_icon(); - msg.entity_category = static_cast(cover->get_entity_category()); - return api->send_list_entities_cover_response(msg); + msg.unique_id = get_default_unique_id("cover", cover); + return this->try_send_entity_info_(static_cast(cover), msg, + &APIConnection::send_list_entities_cover_response); } void APIConnection::cover_command(const CoverCommandRequest &msg) { cover::Cover *cover = App.get_cover_by_key(msg.key); @@ -390,56 +361,41 @@ void APIConnection::cover_command(const CoverCommandRequest &msg) { #ifdef USE_FAN bool APIConnection::send_fan_state(fan::Fan *fan) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_fan_state(this, fan)) { - this->deferred_message_queue_.defer(fan, try_send_fan_state); - } - - return true; + return this->send_state_(static_cast(fan), + reinterpret_cast(&APIConnection::try_send_fan_state_)); } void APIConnection::send_fan_info(fan::Fan *fan) { - if (!APIConnection::try_send_fan_info(this, fan)) { - this->deferred_message_queue_.defer(fan, try_send_fan_info); - } + this->send_info_(static_cast(fan), + reinterpret_cast(&APIConnection::try_send_fan_info_)); } -bool APIConnection::try_send_fan_state(APIConnection *api, void *v_fan) { - fan::Fan *fan = reinterpret_cast(v_fan); +bool APIConnection::try_send_fan_state_(fan::Fan *fan) { + FanStateResponse msg; auto traits = fan->get_traits(); - FanStateResponse resp{}; - resp.key = fan->get_object_id_hash(); - resp.state = fan->state; + msg.state = fan->state; if (traits.supports_oscillation()) - resp.oscillating = fan->oscillating; + msg.oscillating = fan->oscillating; if (traits.supports_speed()) { - resp.speed_level = fan->speed; + msg.speed_level = fan->speed; } if (traits.supports_direction()) - resp.direction = static_cast(fan->direction); + msg.direction = static_cast(fan->direction); if (traits.supports_preset_modes()) - resp.preset_mode = fan->preset_mode; - return api->send_fan_state_response(resp); -} -bool APIConnection::try_send_fan_info(APIConnection *api, void *v_fan) { - fan::Fan *fan = reinterpret_cast(v_fan); - auto traits = fan->get_traits(); - ListEntitiesFanResponse msg; + msg.preset_mode = fan->preset_mode; msg.key = fan->get_object_id_hash(); - msg.object_id = fan->get_object_id(); - if (fan->has_own_name()) - msg.name = fan->get_name(); - msg.unique_id = get_default_unique_id("fan", fan); + return this->send_fan_state_response(msg); +} +bool APIConnection::try_send_fan_info_(fan::Fan *fan) { + ListEntitiesFanResponse msg; + auto traits = fan->get_traits(); msg.supports_oscillation = traits.supports_oscillation(); msg.supports_speed = traits.supports_speed(); msg.supports_direction = traits.supports_direction(); msg.supported_speed_count = traits.supported_speed_count(); for (auto const &preset : traits.supported_preset_modes()) msg.supported_preset_modes.push_back(preset); - msg.disabled_by_default = fan->is_disabled_by_default(); - msg.icon = fan->get_icon(); - msg.entity_category = static_cast(fan->get_entity_category()); - return api->send_list_entities_fan_response(msg); + msg.unique_id = get_default_unique_id("fan", fan); + return this->try_send_entity_info_(static_cast(fan), msg, + &APIConnection::send_list_entities_fan_response); } void APIConnection::fan_command(const FanCommandRequest &msg) { fan::Fan *fan = App.get_fan_by_key(msg.key); @@ -465,28 +421,18 @@ void APIConnection::fan_command(const FanCommandRequest &msg) { #ifdef USE_LIGHT bool APIConnection::send_light_state(light::LightState *light) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_light_state(this, light)) { - this->deferred_message_queue_.defer(light, try_send_light_state); - } - - return true; + return this->send_state_(static_cast(light), + reinterpret_cast(&APIConnection::try_send_light_state_)); } void APIConnection::send_light_info(light::LightState *light) { - if (!APIConnection::try_send_light_info(this, light)) { - this->deferred_message_queue_.defer(light, try_send_light_info); - } + this->send_info_(static_cast(light), + reinterpret_cast(&APIConnection::try_send_light_info_)); } -bool APIConnection::try_send_light_state(APIConnection *api, void *v_light) { - light::LightState *light = reinterpret_cast(v_light); +bool APIConnection::try_send_light_state_(light::LightState *light) { + LightStateResponse resp; auto traits = light->get_traits(); auto values = light->remote_values; auto color_mode = values.get_color_mode(); - LightStateResponse resp{}; - - resp.key = light->get_object_id_hash(); resp.state = values.is_on(); resp.color_mode = static_cast(color_mode); resp.brightness = values.get_brightness(); @@ -500,25 +446,14 @@ bool APIConnection::try_send_light_state(APIConnection *api, void *v_light) { resp.warm_white = values.get_warm_white(); if (light->supports_effects()) resp.effect = light->get_effect_name(); - return api->send_light_state_response(resp); + resp.key = light->get_object_id_hash(); + return this->send_light_state_response(resp); } -bool APIConnection::try_send_light_info(APIConnection *api, void *v_light) { - light::LightState *light = reinterpret_cast(v_light); - auto traits = light->get_traits(); +bool APIConnection::try_send_light_info_(light::LightState *light) { ListEntitiesLightResponse msg; - msg.key = light->get_object_id_hash(); - msg.object_id = light->get_object_id(); - if (light->has_own_name()) - msg.name = light->get_name(); - msg.unique_id = get_default_unique_id("light", light); - - msg.disabled_by_default = light->is_disabled_by_default(); - msg.icon = light->get_icon(); - msg.entity_category = static_cast(light->get_entity_category()); - + auto traits = light->get_traits(); for (auto mode : traits.get_supported_color_modes()) msg.supported_color_modes.push_back(static_cast(mode)); - msg.legacy_supports_brightness = traits.supports_color_capability(light::ColorCapability::BRIGHTNESS); msg.legacy_supports_rgb = traits.supports_color_capability(light::ColorCapability::RGB); msg.legacy_supports_white_value = @@ -526,17 +461,19 @@ bool APIConnection::try_send_light_info(APIConnection *api, void *v_light) { traits.supports_color_capability(light::ColorCapability::COLD_WARM_WHITE)); msg.legacy_supports_color_temperature = traits.supports_color_capability(light::ColorCapability::COLOR_TEMPERATURE) || traits.supports_color_capability(light::ColorCapability::COLD_WARM_WHITE); - if (msg.legacy_supports_color_temperature) { msg.min_mireds = traits.get_min_mireds(); msg.max_mireds = traits.get_max_mireds(); } if (light->supports_effects()) { msg.effects.emplace_back("None"); - for (auto *effect : light->get_effects()) + for (auto *effect : light->get_effects()) { msg.effects.push_back(effect->get_name()); + } } - return api->send_list_entities_light_response(msg); + msg.unique_id = get_default_unique_id("light", light); + return this->try_send_entity_info_(static_cast(light), msg, + &APIConnection::send_list_entities_light_response); } void APIConnection::light_command(const LightCommandRequest &msg) { light::LightState *light = App.get_light_by_key(msg.key); @@ -577,93 +514,65 @@ void APIConnection::light_command(const LightCommandRequest &msg) { #ifdef USE_SENSOR bool APIConnection::send_sensor_state(sensor::Sensor *sensor, float state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_sensor_state(this, sensor, state)) { - this->deferred_message_queue_.defer(sensor, try_send_sensor_state); - } - - return true; + return this->send_state_with_value_(sensor, &APIConnection::try_send_sensor_state_, + &APIConnection::try_send_sensor_state_, state); } void APIConnection::send_sensor_info(sensor::Sensor *sensor) { - if (!APIConnection::try_send_sensor_info(this, sensor)) { - this->deferred_message_queue_.defer(sensor, try_send_sensor_info); - } + this->send_info_(static_cast(sensor), + reinterpret_cast(&APIConnection::try_send_sensor_info_)); } -bool APIConnection::try_send_sensor_state(APIConnection *api, void *v_sensor) { - sensor::Sensor *sensor = reinterpret_cast(v_sensor); - return APIConnection::try_send_sensor_state(api, sensor, sensor->state); +bool APIConnection::try_send_sensor_state_(sensor::Sensor *sensor) { + return this->try_send_sensor_state_(sensor, sensor->state); } -bool APIConnection::try_send_sensor_state(APIConnection *api, sensor::Sensor *sensor, float state) { - SensorStateResponse resp{}; - resp.key = sensor->get_object_id_hash(); +bool APIConnection::try_send_sensor_state_(sensor::Sensor *sensor, float state) { + SensorStateResponse resp; resp.state = state; resp.missing_state = !sensor->has_state(); - return api->send_sensor_state_response(resp); + + resp.key = sensor->get_object_id_hash(); + return this->send_sensor_state_response(resp); } -bool APIConnection::try_send_sensor_info(APIConnection *api, void *v_sensor) { - sensor::Sensor *sensor = reinterpret_cast(v_sensor); +bool APIConnection::try_send_sensor_info_(sensor::Sensor *sensor) { ListEntitiesSensorResponse msg; - msg.key = sensor->get_object_id_hash(); - msg.object_id = sensor->get_object_id(); - if (sensor->has_own_name()) - msg.name = sensor->get_name(); - msg.unique_id = sensor->unique_id(); - if (msg.unique_id.empty()) - msg.unique_id = get_default_unique_id("sensor", sensor); - msg.icon = sensor->get_icon(); msg.unit_of_measurement = sensor->get_unit_of_measurement(); msg.accuracy_decimals = sensor->get_accuracy_decimals(); msg.force_update = sensor->get_force_update(); msg.device_class = sensor->get_device_class(); msg.state_class = static_cast(sensor->get_state_class()); - msg.disabled_by_default = sensor->is_disabled_by_default(); - msg.entity_category = static_cast(sensor->get_entity_category()); - return api->send_list_entities_sensor_response(msg); + msg.unique_id = sensor->unique_id(); + if (msg.unique_id.empty()) + msg.unique_id = get_default_unique_id("sensor", sensor); + return this->try_send_entity_info_(static_cast(sensor), msg, + &APIConnection::send_list_entities_sensor_response); } #endif #ifdef USE_SWITCH bool APIConnection::send_switch_state(switch_::Switch *a_switch, bool state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_switch_state(this, a_switch, state)) { - this->deferred_message_queue_.defer(a_switch, try_send_switch_state); - } - - return true; + return this->send_state_with_value_(a_switch, &APIConnection::try_send_switch_state_, + &APIConnection::try_send_switch_state_, state); } void APIConnection::send_switch_info(switch_::Switch *a_switch) { - if (!APIConnection::try_send_switch_info(this, a_switch)) { - this->deferred_message_queue_.defer(a_switch, try_send_switch_info); - } + this->send_info_(static_cast(a_switch), + reinterpret_cast(&APIConnection::try_send_switch_info_)); } -bool APIConnection::try_send_switch_state(APIConnection *api, void *v_a_switch) { - switch_::Switch *a_switch = reinterpret_cast(v_a_switch); - return APIConnection::try_send_switch_state(api, a_switch, a_switch->state); +bool APIConnection::try_send_switch_state_(switch_::Switch *a_switch) { + return this->try_send_switch_state_(a_switch, a_switch->state); } -bool APIConnection::try_send_switch_state(APIConnection *api, switch_::Switch *a_switch, bool state) { - SwitchStateResponse resp{}; - resp.key = a_switch->get_object_id_hash(); +bool APIConnection::try_send_switch_state_(switch_::Switch *a_switch, bool state) { + SwitchStateResponse resp; resp.state = state; - return api->send_switch_state_response(resp); + + resp.key = a_switch->get_object_id_hash(); + return this->send_switch_state_response(resp); } -bool APIConnection::try_send_switch_info(APIConnection *api, void *v_a_switch) { - switch_::Switch *a_switch = reinterpret_cast(v_a_switch); +bool APIConnection::try_send_switch_info_(switch_::Switch *a_switch) { ListEntitiesSwitchResponse msg; - msg.key = a_switch->get_object_id_hash(); - msg.object_id = a_switch->get_object_id(); - if (a_switch->has_own_name()) - msg.name = a_switch->get_name(); - msg.unique_id = get_default_unique_id("switch", a_switch); - msg.icon = a_switch->get_icon(); msg.assumed_state = a_switch->assumed_state(); - msg.disabled_by_default = a_switch->is_disabled_by_default(); - msg.entity_category = static_cast(a_switch->get_entity_category()); msg.device_class = a_switch->get_device_class(); - return api->send_list_entities_switch_response(msg); + msg.unique_id = get_default_unique_id("switch", a_switch); + return this->try_send_entity_info_(static_cast(a_switch), msg, + &APIConnection::send_list_entities_switch_response); } void APIConnection::switch_command(const SwitchCommandRequest &msg) { switch_::Switch *a_switch = App.get_switch_by_key(msg.key); @@ -680,70 +589,48 @@ void APIConnection::switch_command(const SwitchCommandRequest &msg) { #ifdef USE_TEXT_SENSOR bool APIConnection::send_text_sensor_state(text_sensor::TextSensor *text_sensor, std::string state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_text_sensor_state(this, text_sensor, std::move(state))) { - this->deferred_message_queue_.defer(text_sensor, try_send_text_sensor_state); - } - - return true; + return this->send_state_with_value_(text_sensor, &APIConnection::try_send_text_sensor_state_, + &APIConnection::try_send_text_sensor_state_, std::move(state)); } void APIConnection::send_text_sensor_info(text_sensor::TextSensor *text_sensor) { - if (!APIConnection::try_send_text_sensor_info(this, text_sensor)) { - this->deferred_message_queue_.defer(text_sensor, try_send_text_sensor_info); - } + this->send_info_(static_cast(text_sensor), + reinterpret_cast(&APIConnection::try_send_text_sensor_info_)); } -bool APIConnection::try_send_text_sensor_state(APIConnection *api, void *v_text_sensor) { - text_sensor::TextSensor *text_sensor = reinterpret_cast(v_text_sensor); - return APIConnection::try_send_text_sensor_state(api, text_sensor, text_sensor->state); +bool APIConnection::try_send_text_sensor_state_(text_sensor::TextSensor *text_sensor) { + return this->try_send_text_sensor_state_(text_sensor, text_sensor->state); } -bool APIConnection::try_send_text_sensor_state(APIConnection *api, text_sensor::TextSensor *text_sensor, - std::string state) { - TextSensorStateResponse resp{}; - resp.key = text_sensor->get_object_id_hash(); +bool APIConnection::try_send_text_sensor_state_(text_sensor::TextSensor *text_sensor, std::string state) { + TextSensorStateResponse resp; resp.state = std::move(state); resp.missing_state = !text_sensor->has_state(); - return api->send_text_sensor_state_response(resp); + + resp.key = text_sensor->get_object_id_hash(); + return this->send_text_sensor_state_response(resp); } -bool APIConnection::try_send_text_sensor_info(APIConnection *api, void *v_text_sensor) { - text_sensor::TextSensor *text_sensor = reinterpret_cast(v_text_sensor); +bool APIConnection::try_send_text_sensor_info_(text_sensor::TextSensor *text_sensor) { ListEntitiesTextSensorResponse msg; - msg.key = text_sensor->get_object_id_hash(); - msg.object_id = text_sensor->get_object_id(); - msg.name = text_sensor->get_name(); + msg.device_class = text_sensor->get_device_class(); msg.unique_id = text_sensor->unique_id(); if (msg.unique_id.empty()) msg.unique_id = get_default_unique_id("text_sensor", text_sensor); - msg.icon = text_sensor->get_icon(); - msg.disabled_by_default = text_sensor->is_disabled_by_default(); - msg.entity_category = static_cast(text_sensor->get_entity_category()); - msg.device_class = text_sensor->get_device_class(); - return api->send_list_entities_text_sensor_response(msg); + return this->try_send_entity_info_(static_cast(text_sensor), msg, + &APIConnection::send_list_entities_text_sensor_response); } #endif #ifdef USE_CLIMATE bool APIConnection::send_climate_state(climate::Climate *climate) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_climate_state(this, climate)) { - this->deferred_message_queue_.defer(climate, try_send_climate_state); - } - - return true; + return this->send_state_(static_cast(climate), + reinterpret_cast(&APIConnection::try_send_climate_state_)); } void APIConnection::send_climate_info(climate::Climate *climate) { - if (!APIConnection::try_send_climate_info(this, climate)) { - this->deferred_message_queue_.defer(climate, try_send_climate_info); - } + this->send_info_(static_cast(climate), + reinterpret_cast(&APIConnection::try_send_climate_info_)); } -bool APIConnection::try_send_climate_state(APIConnection *api, void *v_climate) { - climate::Climate *climate = reinterpret_cast(v_climate); - auto traits = climate->get_traits(); - ClimateStateResponse resp{}; +bool APIConnection::try_send_climate_state_(climate::Climate *climate) { + ClimateStateResponse resp; resp.key = climate->get_object_id_hash(); + auto traits = climate->get_traits(); resp.mode = static_cast(climate->mode); resp.action = static_cast(climate->action); if (traits.get_supports_current_temperature()) @@ -769,40 +656,25 @@ bool APIConnection::try_send_climate_state(APIConnection *api, void *v_climate) resp.current_humidity = climate->current_humidity; if (traits.get_supports_target_humidity()) resp.target_humidity = climate->target_humidity; - return api->send_climate_state_response(resp); + return this->send_climate_state_response(resp); } -bool APIConnection::try_send_climate_info(APIConnection *api, void *v_climate) { - climate::Climate *climate = reinterpret_cast(v_climate); - auto traits = climate->get_traits(); +bool APIConnection::try_send_climate_info_(climate::Climate *climate) { ListEntitiesClimateResponse msg; - msg.key = climate->get_object_id_hash(); - msg.object_id = climate->get_object_id(); - if (climate->has_own_name()) - msg.name = climate->get_name(); - msg.unique_id = get_default_unique_id("climate", climate); - - msg.disabled_by_default = climate->is_disabled_by_default(); - msg.icon = climate->get_icon(); - msg.entity_category = static_cast(climate->get_entity_category()); - + auto traits = climate->get_traits(); msg.supports_current_temperature = traits.get_supports_current_temperature(); msg.supports_current_humidity = traits.get_supports_current_humidity(); msg.supports_two_point_target_temperature = traits.get_supports_two_point_target_temperature(); msg.supports_target_humidity = traits.get_supports_target_humidity(); - for (auto mode : traits.get_supported_modes()) msg.supported_modes.push_back(static_cast(mode)); - msg.visual_min_temperature = traits.get_visual_min_temperature(); msg.visual_max_temperature = traits.get_visual_max_temperature(); msg.visual_target_temperature_step = traits.get_visual_target_temperature_step(); msg.visual_current_temperature_step = traits.get_visual_current_temperature_step(); msg.visual_min_humidity = traits.get_visual_min_humidity(); msg.visual_max_humidity = traits.get_visual_max_humidity(); - msg.legacy_supports_away = traits.supports_preset(climate::CLIMATE_PRESET_AWAY); msg.supports_action = traits.get_supports_action(); - for (auto fan_mode : traits.get_supported_fan_modes()) msg.supported_fan_modes.push_back(static_cast(fan_mode)); for (auto const &custom_fan_mode : traits.get_supported_custom_fan_modes()) @@ -813,7 +685,9 @@ bool APIConnection::try_send_climate_info(APIConnection *api, void *v_climate) { msg.supported_custom_presets.push_back(custom_preset); for (auto swing_mode : traits.get_supported_swing_modes()) msg.supported_swing_modes.push_back(static_cast(swing_mode)); - return api->send_list_entities_climate_response(msg); + msg.unique_id = get_default_unique_id("climate", climate); + return this->try_send_entity_info_(static_cast(climate), msg, + &APIConnection::send_list_entities_climate_response); } void APIConnection::climate_command(const ClimateCommandRequest &msg) { climate::Climate *climate = App.get_climate_by_key(msg.key); @@ -847,51 +721,35 @@ void APIConnection::climate_command(const ClimateCommandRequest &msg) { #ifdef USE_NUMBER bool APIConnection::send_number_state(number::Number *number, float state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_number_state(this, number, state)) { - this->deferred_message_queue_.defer(number, try_send_number_state); - } - - return true; + return this->send_state_with_value_(number, &APIConnection::try_send_number_state_, + &APIConnection::try_send_number_state_, state); } void APIConnection::send_number_info(number::Number *number) { - if (!APIConnection::try_send_number_info(this, number)) { - this->deferred_message_queue_.defer(number, try_send_number_info); - } + this->send_info_(static_cast(number), + reinterpret_cast(&APIConnection::try_send_number_info_)); } -bool APIConnection::try_send_number_state(APIConnection *api, void *v_number) { - number::Number *number = reinterpret_cast(v_number); - return APIConnection::try_send_number_state(api, number, number->state); +bool APIConnection::try_send_number_state_(number::Number *number) { + return this->try_send_number_state_(number, number->state); } -bool APIConnection::try_send_number_state(APIConnection *api, number::Number *number, float state) { - NumberStateResponse resp{}; - resp.key = number->get_object_id_hash(); +bool APIConnection::try_send_number_state_(number::Number *number, float state) { + NumberStateResponse resp; resp.state = state; resp.missing_state = !number->has_state(); - return api->send_number_state_response(resp); + + resp.key = number->get_object_id_hash(); + return this->send_number_state_response(resp); } -bool APIConnection::try_send_number_info(APIConnection *api, void *v_number) { - number::Number *number = reinterpret_cast(v_number); +bool APIConnection::try_send_number_info_(number::Number *number) { ListEntitiesNumberResponse msg; - msg.key = number->get_object_id_hash(); - msg.object_id = number->get_object_id(); - if (number->has_own_name()) - msg.name = number->get_name(); - msg.unique_id = get_default_unique_id("number", number); - msg.icon = number->get_icon(); - msg.disabled_by_default = number->is_disabled_by_default(); - msg.entity_category = static_cast(number->get_entity_category()); msg.unit_of_measurement = number->traits.get_unit_of_measurement(); msg.mode = static_cast(number->traits.get_mode()); msg.device_class = number->traits.get_device_class(); - msg.min_value = number->traits.get_min_value(); msg.max_value = number->traits.get_max_value(); msg.step = number->traits.get_step(); - - return api->send_list_entities_number_response(msg); + msg.unique_id = get_default_unique_id("number", number); + return this->try_send_entity_info_(static_cast(number), msg, + &APIConnection::send_list_entities_number_response); } void APIConnection::number_command(const NumberCommandRequest &msg) { number::Number *number = App.get_number_by_key(msg.key); @@ -906,43 +764,28 @@ void APIConnection::number_command(const NumberCommandRequest &msg) { #ifdef USE_DATETIME_DATE bool APIConnection::send_date_state(datetime::DateEntity *date) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_date_state(this, date)) { - this->deferred_message_queue_.defer(date, try_send_date_state); - } - - return true; + return this->send_state_(static_cast(date), + reinterpret_cast(&APIConnection::try_send_date_state_)); } void APIConnection::send_date_info(datetime::DateEntity *date) { - if (!APIConnection::try_send_date_info(this, date)) { - this->deferred_message_queue_.defer(date, try_send_date_info); - } + this->send_info_(static_cast(date), + reinterpret_cast(&APIConnection::try_send_date_info_)); } -bool APIConnection::try_send_date_state(APIConnection *api, void *v_date) { - datetime::DateEntity *date = reinterpret_cast(v_date); - DateStateResponse resp{}; - resp.key = date->get_object_id_hash(); +bool APIConnection::try_send_date_state_(datetime::DateEntity *date) { + DateStateResponse resp; resp.missing_state = !date->has_state(); resp.year = date->year; resp.month = date->month; resp.day = date->day; - return api->send_date_state_response(resp); -} -bool APIConnection::try_send_date_info(APIConnection *api, void *v_date) { - datetime::DateEntity *date = reinterpret_cast(v_date); - ListEntitiesDateResponse msg; - msg.key = date->get_object_id_hash(); - msg.object_id = date->get_object_id(); - if (date->has_own_name()) - msg.name = date->get_name(); - msg.unique_id = get_default_unique_id("date", date); - msg.icon = date->get_icon(); - msg.disabled_by_default = date->is_disabled_by_default(); - msg.entity_category = static_cast(date->get_entity_category()); - return api->send_list_entities_date_response(msg); + resp.key = date->get_object_id_hash(); + return this->send_date_state_response(resp); +} +bool APIConnection::try_send_date_info_(datetime::DateEntity *date) { + ListEntitiesDateResponse msg; + msg.unique_id = get_default_unique_id("date", date); + return this->try_send_entity_info_(static_cast(date), msg, + &APIConnection::send_list_entities_date_response); } void APIConnection::date_command(const DateCommandRequest &msg) { datetime::DateEntity *date = App.get_date_by_key(msg.key); @@ -957,43 +800,28 @@ void APIConnection::date_command(const DateCommandRequest &msg) { #ifdef USE_DATETIME_TIME bool APIConnection::send_time_state(datetime::TimeEntity *time) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_time_state(this, time)) { - this->deferred_message_queue_.defer(time, try_send_time_state); - } - - return true; + return this->send_state_(static_cast(time), + reinterpret_cast(&APIConnection::try_send_time_state_)); } void APIConnection::send_time_info(datetime::TimeEntity *time) { - if (!APIConnection::try_send_time_info(this, time)) { - this->deferred_message_queue_.defer(time, try_send_time_info); - } + this->send_info_(static_cast(time), + reinterpret_cast(&APIConnection::try_send_time_info_)); } -bool APIConnection::try_send_time_state(APIConnection *api, void *v_time) { - datetime::TimeEntity *time = reinterpret_cast(v_time); - TimeStateResponse resp{}; - resp.key = time->get_object_id_hash(); +bool APIConnection::try_send_time_state_(datetime::TimeEntity *time) { + TimeStateResponse resp; resp.missing_state = !time->has_state(); resp.hour = time->hour; resp.minute = time->minute; resp.second = time->second; - return api->send_time_state_response(resp); -} -bool APIConnection::try_send_time_info(APIConnection *api, void *v_time) { - datetime::TimeEntity *time = reinterpret_cast(v_time); - ListEntitiesTimeResponse msg; - msg.key = time->get_object_id_hash(); - msg.object_id = time->get_object_id(); - if (time->has_own_name()) - msg.name = time->get_name(); - msg.unique_id = get_default_unique_id("time", time); - msg.icon = time->get_icon(); - msg.disabled_by_default = time->is_disabled_by_default(); - msg.entity_category = static_cast(time->get_entity_category()); - return api->send_list_entities_time_response(msg); + resp.key = time->get_object_id_hash(); + return this->send_time_state_response(resp); +} +bool APIConnection::try_send_time_info_(datetime::TimeEntity *time) { + ListEntitiesTimeResponse msg; + msg.unique_id = get_default_unique_id("time", time); + return this->try_send_entity_info_(static_cast(time), msg, + &APIConnection::send_list_entities_time_response); } void APIConnection::time_command(const TimeCommandRequest &msg) { datetime::TimeEntity *time = App.get_time_by_key(msg.key); @@ -1008,44 +836,29 @@ void APIConnection::time_command(const TimeCommandRequest &msg) { #ifdef USE_DATETIME_DATETIME bool APIConnection::send_datetime_state(datetime::DateTimeEntity *datetime) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_datetime_state(this, datetime)) { - this->deferred_message_queue_.defer(datetime, try_send_datetime_state); - } - - return true; + return this->send_state_(static_cast(datetime), + reinterpret_cast(&APIConnection::try_send_datetime_state_)); } void APIConnection::send_datetime_info(datetime::DateTimeEntity *datetime) { - if (!APIConnection::try_send_datetime_info(this, datetime)) { - this->deferred_message_queue_.defer(datetime, try_send_datetime_info); - } + this->send_info_(static_cast(datetime), + reinterpret_cast(&APIConnection::try_send_datetime_info_)); } -bool APIConnection::try_send_datetime_state(APIConnection *api, void *v_datetime) { - datetime::DateTimeEntity *datetime = reinterpret_cast(v_datetime); - DateTimeStateResponse resp{}; - resp.key = datetime->get_object_id_hash(); +bool APIConnection::try_send_datetime_state_(datetime::DateTimeEntity *datetime) { + DateTimeStateResponse resp; resp.missing_state = !datetime->has_state(); if (datetime->has_state()) { ESPTime state = datetime->state_as_esptime(); resp.epoch_seconds = state.timestamp; } - return api->send_date_time_state_response(resp); -} -bool APIConnection::try_send_datetime_info(APIConnection *api, void *v_datetime) { - datetime::DateTimeEntity *datetime = reinterpret_cast(v_datetime); - ListEntitiesDateTimeResponse msg; - msg.key = datetime->get_object_id_hash(); - msg.object_id = datetime->get_object_id(); - if (datetime->has_own_name()) - msg.name = datetime->get_name(); - msg.unique_id = get_default_unique_id("datetime", datetime); - msg.icon = datetime->get_icon(); - msg.disabled_by_default = datetime->is_disabled_by_default(); - msg.entity_category = static_cast(datetime->get_entity_category()); - return api->send_list_entities_date_time_response(msg); + resp.key = datetime->get_object_id_hash(); + return this->send_date_time_state_response(resp); +} +bool APIConnection::try_send_datetime_info_(datetime::DateTimeEntity *datetime) { + ListEntitiesDateTimeResponse msg; + msg.unique_id = get_default_unique_id("datetime", datetime); + return this->try_send_entity_info_(static_cast(datetime), msg, + &APIConnection::send_list_entities_date_time_response); } void APIConnection::datetime_command(const DateTimeCommandRequest &msg) { datetime::DateTimeEntity *datetime = App.get_datetime_by_key(msg.key); @@ -1060,47 +873,31 @@ void APIConnection::datetime_command(const DateTimeCommandRequest &msg) { #ifdef USE_TEXT bool APIConnection::send_text_state(text::Text *text, std::string state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_text_state(this, text, std::move(state))) { - this->deferred_message_queue_.defer(text, try_send_text_state); - } - - return true; + return this->send_state_with_value_(text, &APIConnection::try_send_text_state_, &APIConnection::try_send_text_state_, + std::move(state)); } void APIConnection::send_text_info(text::Text *text) { - if (!APIConnection::try_send_text_info(this, text)) { - this->deferred_message_queue_.defer(text, try_send_text_info); - } + this->send_info_(static_cast(text), + reinterpret_cast(&APIConnection::try_send_text_info_)); } -bool APIConnection::try_send_text_state(APIConnection *api, void *v_text) { - text::Text *text = reinterpret_cast(v_text); - return APIConnection::try_send_text_state(api, text, text->state); -} -bool APIConnection::try_send_text_state(APIConnection *api, text::Text *text, std::string state) { - TextStateResponse resp{}; - resp.key = text->get_object_id_hash(); +bool APIConnection::try_send_text_state_(text::Text *text) { return this->try_send_text_state_(text, text->state); } +bool APIConnection::try_send_text_state_(text::Text *text, std::string state) { + TextStateResponse resp; resp.state = std::move(state); resp.missing_state = !text->has_state(); - return api->send_text_state_response(resp); -} -bool APIConnection::try_send_text_info(APIConnection *api, void *v_text) { - text::Text *text = reinterpret_cast(v_text); - ListEntitiesTextResponse msg; - msg.key = text->get_object_id_hash(); - msg.object_id = text->get_object_id(); - msg.name = text->get_name(); - msg.icon = text->get_icon(); - msg.disabled_by_default = text->is_disabled_by_default(); - msg.entity_category = static_cast(text->get_entity_category()); - msg.mode = static_cast(text->traits.get_mode()); + resp.key = text->get_object_id_hash(); + return this->send_text_state_response(resp); +} +bool APIConnection::try_send_text_info_(text::Text *text) { + ListEntitiesTextResponse msg; + msg.mode = static_cast(text->traits.get_mode()); msg.min_length = text->traits.get_min_length(); msg.max_length = text->traits.get_max_length(); msg.pattern = text->traits.get_pattern(); - - return api->send_list_entities_text_response(msg); + msg.unique_id = get_default_unique_id("text", text); + return this->try_send_entity_info_(static_cast(text), msg, + &APIConnection::send_list_entities_text_response); } void APIConnection::text_command(const TextCommandRequest &msg) { text::Text *text = App.get_text_by_key(msg.key); @@ -1115,47 +912,31 @@ void APIConnection::text_command(const TextCommandRequest &msg) { #ifdef USE_SELECT bool APIConnection::send_select_state(select::Select *select, std::string state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_select_state(this, select, std::move(state))) { - this->deferred_message_queue_.defer(select, try_send_select_state); - } - - return true; + return this->send_state_with_value_(select, &APIConnection::try_send_select_state_, + &APIConnection::try_send_select_state_, std::move(state)); } void APIConnection::send_select_info(select::Select *select) { - if (!APIConnection::try_send_select_info(this, select)) { - this->deferred_message_queue_.defer(select, try_send_select_info); - } + this->send_info_(static_cast(select), + reinterpret_cast(&APIConnection::try_send_select_info_)); } -bool APIConnection::try_send_select_state(APIConnection *api, void *v_select) { - select::Select *select = reinterpret_cast(v_select); - return APIConnection::try_send_select_state(api, select, select->state); +bool APIConnection::try_send_select_state_(select::Select *select) { + return this->try_send_select_state_(select, select->state); } -bool APIConnection::try_send_select_state(APIConnection *api, select::Select *select, std::string state) { - SelectStateResponse resp{}; - resp.key = select->get_object_id_hash(); +bool APIConnection::try_send_select_state_(select::Select *select, std::string state) { + SelectStateResponse resp; resp.state = std::move(state); resp.missing_state = !select->has_state(); - return api->send_select_state_response(resp); -} -bool APIConnection::try_send_select_info(APIConnection *api, void *v_select) { - select::Select *select = reinterpret_cast(v_select); - ListEntitiesSelectResponse msg; - msg.key = select->get_object_id_hash(); - msg.object_id = select->get_object_id(); - if (select->has_own_name()) - msg.name = select->get_name(); - msg.unique_id = get_default_unique_id("select", select); - msg.icon = select->get_icon(); - msg.disabled_by_default = select->is_disabled_by_default(); - msg.entity_category = static_cast(select->get_entity_category()); + resp.key = select->get_object_id_hash(); + return this->send_select_state_response(resp); +} +bool APIConnection::try_send_select_info_(select::Select *select) { + ListEntitiesSelectResponse msg; for (const auto &option : select->traits.get_options()) msg.options.push_back(option); - - return api->send_list_entities_select_response(msg); + msg.unique_id = get_default_unique_id("select", select); + return this->try_send_entity_info_(static_cast(select), msg, + &APIConnection::send_list_entities_select_response); } void APIConnection::select_command(const SelectCommandRequest &msg) { select::Select *select = App.get_select_by_key(msg.key); @@ -1169,26 +950,18 @@ void APIConnection::select_command(const SelectCommandRequest &msg) { #endif #ifdef USE_BUTTON -void APIConnection::send_button_info(button::Button *button) { - if (!APIConnection::try_send_button_info(this, button)) { - this->deferred_message_queue_.defer(button, try_send_button_info); - } +void esphome::api::APIConnection::send_button_info(button::Button *button) { + this->send_info_(static_cast(button), + reinterpret_cast(&APIConnection::try_send_button_info_)); } -bool APIConnection::try_send_button_info(APIConnection *api, void *v_button) { - button::Button *button = reinterpret_cast(v_button); +bool esphome::api::APIConnection::try_send_button_info_(button::Button *button) { ListEntitiesButtonResponse msg; - msg.key = button->get_object_id_hash(); - msg.object_id = button->get_object_id(); - if (button->has_own_name()) - msg.name = button->get_name(); - msg.unique_id = get_default_unique_id("button", button); - msg.icon = button->get_icon(); - msg.disabled_by_default = button->is_disabled_by_default(); - msg.entity_category = static_cast(button->get_entity_category()); msg.device_class = button->get_device_class(); - return api->send_list_entities_button_response(msg); + msg.unique_id = get_default_unique_id("button", button); + return this->try_send_entity_info_(static_cast(button), msg, + &APIConnection::send_list_entities_button_response); } -void APIConnection::button_command(const ButtonCommandRequest &msg) { +void esphome::api::APIConnection::button_command(const ButtonCommandRequest &msg) { button::Button *button = App.get_button_by_key(msg.key); if (button == nullptr) return; @@ -1199,45 +972,31 @@ void APIConnection::button_command(const ButtonCommandRequest &msg) { #ifdef USE_LOCK bool APIConnection::send_lock_state(lock::Lock *a_lock, lock::LockState state) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_lock_state(this, a_lock, state)) { - this->deferred_message_queue_.defer(a_lock, try_send_lock_state); - } - - return true; + return this->send_state_with_value_(a_lock, &APIConnection::try_send_lock_state_, + &APIConnection::try_send_lock_state_, state); } void APIConnection::send_lock_info(lock::Lock *a_lock) { - if (!APIConnection::try_send_lock_info(this, a_lock)) { - this->deferred_message_queue_.defer(a_lock, try_send_lock_info); - } + this->send_info_(static_cast(a_lock), + reinterpret_cast(&APIConnection::try_send_lock_info_)); } -bool APIConnection::try_send_lock_state(APIConnection *api, void *v_a_lock) { - lock::Lock *a_lock = reinterpret_cast(v_a_lock); - return APIConnection::try_send_lock_state(api, a_lock, a_lock->state); +bool APIConnection::try_send_lock_state_(lock::Lock *a_lock) { + return this->try_send_lock_state_(a_lock, a_lock->state); } -bool APIConnection::try_send_lock_state(APIConnection *api, lock::Lock *a_lock, lock::LockState state) { - LockStateResponse resp{}; - resp.key = a_lock->get_object_id_hash(); +bool APIConnection::try_send_lock_state_(lock::Lock *a_lock, lock::LockState state) { + LockStateResponse resp; resp.state = static_cast(state); - return api->send_lock_state_response(resp); + + resp.key = a_lock->get_object_id_hash(); + return this->send_lock_state_response(resp); } -bool APIConnection::try_send_lock_info(APIConnection *api, void *v_a_lock) { - lock::Lock *a_lock = reinterpret_cast(v_a_lock); +bool APIConnection::try_send_lock_info_(lock::Lock *a_lock) { ListEntitiesLockResponse msg; - msg.key = a_lock->get_object_id_hash(); - msg.object_id = a_lock->get_object_id(); - if (a_lock->has_own_name()) - msg.name = a_lock->get_name(); - msg.unique_id = get_default_unique_id("lock", a_lock); - msg.icon = a_lock->get_icon(); msg.assumed_state = a_lock->traits.get_assumed_state(); - msg.disabled_by_default = a_lock->is_disabled_by_default(); - msg.entity_category = static_cast(a_lock->get_entity_category()); msg.supports_open = a_lock->traits.get_supports_open(); msg.requires_code = a_lock->traits.get_requires_code(); - return api->send_list_entities_lock_response(msg); + msg.unique_id = get_default_unique_id("lock", a_lock); + return this->try_send_entity_info_(static_cast(a_lock), msg, + &APIConnection::send_list_entities_lock_response); } void APIConnection::lock_command(const LockCommandRequest &msg) { lock::Lock *a_lock = App.get_lock_by_key(msg.key); @@ -1260,45 +1019,31 @@ void APIConnection::lock_command(const LockCommandRequest &msg) { #ifdef USE_VALVE bool APIConnection::send_valve_state(valve::Valve *valve) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_valve_state(this, valve)) { - this->deferred_message_queue_.defer(valve, try_send_valve_state); - } - - return true; + return this->send_state_(static_cast(valve), + reinterpret_cast(&APIConnection::try_send_valve_state_)); } void APIConnection::send_valve_info(valve::Valve *valve) { - if (!APIConnection::try_send_valve_info(this, valve)) { - this->deferred_message_queue_.defer(valve, try_send_valve_info); - } + this->send_info_(static_cast(valve), + reinterpret_cast(&APIConnection::try_send_valve_info_)); } -bool APIConnection::try_send_valve_state(APIConnection *api, void *v_valve) { - valve::Valve *valve = reinterpret_cast(v_valve); - ValveStateResponse resp{}; - resp.key = valve->get_object_id_hash(); +bool APIConnection::try_send_valve_state_(valve::Valve *valve) { + ValveStateResponse resp; resp.position = valve->position; resp.current_operation = static_cast(valve->current_operation); - return api->send_valve_state_response(resp); + + resp.key = valve->get_object_id_hash(); + return this->send_valve_state_response(resp); } -bool APIConnection::try_send_valve_info(APIConnection *api, void *v_valve) { - valve::Valve *valve = reinterpret_cast(v_valve); - auto traits = valve->get_traits(); +bool APIConnection::try_send_valve_info_(valve::Valve *valve) { ListEntitiesValveResponse msg; - msg.key = valve->get_object_id_hash(); - msg.object_id = valve->get_object_id(); - if (valve->has_own_name()) - msg.name = valve->get_name(); - msg.unique_id = get_default_unique_id("valve", valve); - msg.icon = valve->get_icon(); - msg.disabled_by_default = valve->is_disabled_by_default(); - msg.entity_category = static_cast(valve->get_entity_category()); + auto traits = valve->get_traits(); msg.device_class = valve->get_device_class(); msg.assumed_state = traits.get_is_assumed_state(); msg.supports_position = traits.get_supports_position(); msg.supports_stop = traits.get_supports_stop(); - return api->send_list_entities_valve_response(msg); + msg.unique_id = get_default_unique_id("valve", valve); + return this->try_send_entity_info_(static_cast(valve), msg, + &APIConnection::send_list_entities_valve_response); } void APIConnection::valve_command(const ValveCommandRequest &msg) { valve::Valve *valve = App.get_valve_by_key(msg.key); @@ -1316,48 +1061,29 @@ void APIConnection::valve_command(const ValveCommandRequest &msg) { #ifdef USE_MEDIA_PLAYER bool APIConnection::send_media_player_state(media_player::MediaPlayer *media_player) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_media_player_state(this, media_player)) { - this->deferred_message_queue_.defer(media_player, try_send_media_player_state); - } - - return true; + return this->send_state_(static_cast(media_player), + reinterpret_cast(&APIConnection::try_send_media_player_state_)); } void APIConnection::send_media_player_info(media_player::MediaPlayer *media_player) { - if (!APIConnection::try_send_media_player_info(this, media_player)) { - this->deferred_message_queue_.defer(media_player, try_send_media_player_info); - } + this->send_info_(static_cast(media_player), + reinterpret_cast(&APIConnection::try_send_media_player_info_)); } -bool APIConnection::try_send_media_player_state(APIConnection *api, void *v_media_player) { - media_player::MediaPlayer *media_player = reinterpret_cast(v_media_player); - MediaPlayerStateResponse resp{}; - resp.key = media_player->get_object_id_hash(); - +bool APIConnection::try_send_media_player_state_(media_player::MediaPlayer *media_player) { + MediaPlayerStateResponse resp; media_player::MediaPlayerState report_state = media_player->state == media_player::MEDIA_PLAYER_STATE_ANNOUNCING ? media_player::MEDIA_PLAYER_STATE_PLAYING : media_player->state; resp.state = static_cast(report_state); resp.volume = media_player->volume; resp.muted = media_player->is_muted(); - return api->send_media_player_state_response(resp); -} -bool APIConnection::try_send_media_player_info(APIConnection *api, void *v_media_player) { - media_player::MediaPlayer *media_player = reinterpret_cast(v_media_player); - ListEntitiesMediaPlayerResponse msg; - msg.key = media_player->get_object_id_hash(); - msg.object_id = media_player->get_object_id(); - if (media_player->has_own_name()) - msg.name = media_player->get_name(); - msg.unique_id = get_default_unique_id("media_player", media_player); - msg.icon = media_player->get_icon(); - msg.disabled_by_default = media_player->is_disabled_by_default(); - msg.entity_category = static_cast(media_player->get_entity_category()); + resp.key = media_player->get_object_id_hash(); + return this->send_media_player_state_response(resp); +} +bool APIConnection::try_send_media_player_info_(media_player::MediaPlayer *media_player) { + ListEntitiesMediaPlayerResponse msg; auto traits = media_player->get_traits(); msg.supports_pause = traits.get_supports_pause(); - for (auto &supported_format : traits.get_supported_formats()) { MediaPlayerSupportedFormat media_format; media_format.format = supported_format.format; @@ -1367,8 +1093,9 @@ bool APIConnection::try_send_media_player_info(APIConnection *api, void *v_media media_format.sample_bytes = supported_format.sample_bytes; msg.supported_formats.push_back(media_format); } - - return api->send_list_entities_media_player_response(msg); + msg.unique_id = get_default_unique_id("media_player", media_player); + return this->try_send_entity_info_(static_cast(media_player), msg, + &APIConnection::send_list_entities_media_player_response); } void APIConnection::media_player_command(const MediaPlayerCommandRequest &msg) { media_player::MediaPlayer *media_player = App.get_media_player_by_key(msg.key); @@ -1403,22 +1130,14 @@ void APIConnection::set_camera_state(std::shared_ptr this->image_reader_.set_image(std::move(image)); } void APIConnection::send_camera_info(esp32_camera::ESP32Camera *camera) { - if (!APIConnection::try_send_camera_info(this, camera)) { - this->deferred_message_queue_.defer(camera, try_send_camera_info); - } + this->send_info_(static_cast(camera), + reinterpret_cast(&APIConnection::try_send_camera_info_)); } -bool APIConnection::try_send_camera_info(APIConnection *api, void *v_camera) { - esp32_camera::ESP32Camera *camera = reinterpret_cast(v_camera); +bool APIConnection::try_send_camera_info_(esp32_camera::ESP32Camera *camera) { ListEntitiesCameraResponse msg; - msg.key = camera->get_object_id_hash(); - msg.object_id = camera->get_object_id(); - if (camera->has_own_name()) - msg.name = camera->get_name(); msg.unique_id = get_default_unique_id("camera", camera); - msg.disabled_by_default = camera->is_disabled_by_default(); - msg.icon = camera->get_icon(); - msg.entity_category = static_cast(camera->get_entity_category()); - return api->send_list_entities_camera_response(msg); + return this->try_send_entity_info_(static_cast(camera), msg, + &APIConnection::send_list_entities_camera_response); } void APIConnection::camera_image(const CameraImageRequest &msg) { if (esp32_camera::global_esp32_camera == nullptr) @@ -1607,43 +1326,28 @@ void APIConnection::voice_assistant_set_configuration(const VoiceAssistantSetCon #ifdef USE_ALARM_CONTROL_PANEL bool APIConnection::send_alarm_control_panel_state(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_alarm_control_panel_state(this, a_alarm_control_panel)) { - this->deferred_message_queue_.defer(a_alarm_control_panel, try_send_alarm_control_panel_state); - } - - return true; + return this->send_state_(static_cast(a_alarm_control_panel), + reinterpret_cast(&APIConnection::try_send_alarm_control_panel_state_)); } void APIConnection::send_alarm_control_panel_info(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) { - if (!APIConnection::try_send_alarm_control_panel_info(this, a_alarm_control_panel)) { - this->deferred_message_queue_.defer(a_alarm_control_panel, try_send_alarm_control_panel_info); - } + this->send_info_(static_cast(a_alarm_control_panel), + reinterpret_cast(&APIConnection::try_send_alarm_control_panel_info_)); } -bool APIConnection::try_send_alarm_control_panel_state(APIConnection *api, void *v_a_alarm_control_panel) { - alarm_control_panel::AlarmControlPanel *a_alarm_control_panel = - reinterpret_cast(v_a_alarm_control_panel); - AlarmControlPanelStateResponse resp{}; - resp.key = a_alarm_control_panel->get_object_id_hash(); +bool APIConnection::try_send_alarm_control_panel_state_(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) { + AlarmControlPanelStateResponse resp; resp.state = static_cast(a_alarm_control_panel->get_state()); - return api->send_alarm_control_panel_state_response(resp); + + resp.key = a_alarm_control_panel->get_object_id_hash(); + return this->send_alarm_control_panel_state_response(resp); } -bool APIConnection::try_send_alarm_control_panel_info(APIConnection *api, void *v_a_alarm_control_panel) { - alarm_control_panel::AlarmControlPanel *a_alarm_control_panel = - reinterpret_cast(v_a_alarm_control_panel); +bool APIConnection::try_send_alarm_control_panel_info_(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) { ListEntitiesAlarmControlPanelResponse msg; - msg.key = a_alarm_control_panel->get_object_id_hash(); - msg.object_id = a_alarm_control_panel->get_object_id(); - msg.name = a_alarm_control_panel->get_name(); - msg.unique_id = get_default_unique_id("alarm_control_panel", a_alarm_control_panel); - msg.icon = a_alarm_control_panel->get_icon(); - msg.disabled_by_default = a_alarm_control_panel->is_disabled_by_default(); - msg.entity_category = static_cast(a_alarm_control_panel->get_entity_category()); msg.supported_features = a_alarm_control_panel->get_supported_features(); msg.requires_code = a_alarm_control_panel->get_requires_code(); msg.requires_code_to_arm = a_alarm_control_panel->get_requires_code_to_arm(); - return api->send_list_entities_alarm_control_panel_response(msg); + msg.unique_id = get_default_unique_id("alarm_control_panel", a_alarm_control_panel); + return this->try_send_entity_info_(static_cast(a_alarm_control_panel), msg, + &APIConnection::send_list_entities_alarm_control_panel_response); } void APIConnection::alarm_control_panel_command(const AlarmControlPanelCommandRequest &msg) { alarm_control_panel::AlarmControlPanel *a_alarm_control_panel = App.get_alarm_control_panel_by_key(msg.key); @@ -1681,63 +1385,45 @@ void APIConnection::alarm_control_panel_command(const AlarmControlPanelCommandRe #ifdef USE_EVENT void APIConnection::send_event(event::Event *event, std::string event_type) { - if (!APIConnection::try_send_event(this, event, std::move(event_type))) { - this->deferred_message_queue_.defer(event, try_send_event); - } + this->send_state_with_value_(event, &APIConnection::try_send_event_, &APIConnection::try_send_event_, + std::move(event_type)); } void APIConnection::send_event_info(event::Event *event) { - if (!APIConnection::try_send_event_info(this, event)) { - this->deferred_message_queue_.defer(event, try_send_event_info); - } + this->send_info_(static_cast(event), + reinterpret_cast(&APIConnection::try_send_event_info_)); } -bool APIConnection::try_send_event(APIConnection *api, void *v_event) { - event::Event *event = reinterpret_cast(v_event); - return APIConnection::try_send_event(api, event, *(event->last_event_type)); +bool APIConnection::try_send_event_(event::Event *event) { + return this->try_send_event_(event, *(event->last_event_type)); } -bool APIConnection::try_send_event(APIConnection *api, event::Event *event, std::string event_type) { - EventResponse resp{}; - resp.key = event->get_object_id_hash(); +bool APIConnection::try_send_event_(event::Event *event, std::string event_type) { + EventResponse resp; resp.event_type = std::move(event_type); - return api->send_event_response(resp); + + resp.key = event->get_object_id_hash(); + return this->send_event_response(resp); } -bool APIConnection::try_send_event_info(APIConnection *api, void *v_event) { - event::Event *event = reinterpret_cast(v_event); +bool APIConnection::try_send_event_info_(event::Event *event) { ListEntitiesEventResponse msg; - msg.key = event->get_object_id_hash(); - msg.object_id = event->get_object_id(); - if (event->has_own_name()) - msg.name = event->get_name(); - msg.unique_id = get_default_unique_id("event", event); - msg.icon = event->get_icon(); - msg.disabled_by_default = event->is_disabled_by_default(); - msg.entity_category = static_cast(event->get_entity_category()); msg.device_class = event->get_device_class(); for (const auto &event_type : event->get_event_types()) msg.event_types.push_back(event_type); - return api->send_list_entities_event_response(msg); + msg.unique_id = get_default_unique_id("event", event); + return this->try_send_entity_info_(static_cast(event), msg, + &APIConnection::send_list_entities_event_response); } #endif #ifdef USE_UPDATE bool APIConnection::send_update_state(update::UpdateEntity *update) { - if (!this->state_subscription_) - return false; - - if (!APIConnection::try_send_update_state(this, update)) { - this->deferred_message_queue_.defer(update, try_send_update_state); - } - - return true; + return this->send_state_(static_cast(update), + reinterpret_cast(&APIConnection::try_send_update_state_)); } void APIConnection::send_update_info(update::UpdateEntity *update) { - if (!APIConnection::try_send_update_info(this, update)) { - this->deferred_message_queue_.defer(update, try_send_update_info); - } + this->send_info_(static_cast(update), + reinterpret_cast(&APIConnection::try_send_update_info_)); } -bool APIConnection::try_send_update_state(APIConnection *api, void *v_update) { - update::UpdateEntity *update = reinterpret_cast(v_update); - UpdateStateResponse resp{}; - resp.key = update->get_object_id_hash(); +bool APIConnection::try_send_update_state_(update::UpdateEntity *update) { + UpdateStateResponse resp; resp.missing_state = !update->has_state(); if (update->has_state()) { resp.in_progress = update->state == update::UpdateState::UPDATE_STATE_INSTALLING; @@ -1752,21 +1438,15 @@ bool APIConnection::try_send_update_state(APIConnection *api, void *v_update) { resp.release_url = update->update_info.release_url; } - return api->send_update_state_response(resp); + resp.key = update->get_object_id_hash(); + return this->send_update_state_response(resp); } -bool APIConnection::try_send_update_info(APIConnection *api, void *v_update) { - update::UpdateEntity *update = reinterpret_cast(v_update); +bool APIConnection::try_send_update_info_(update::UpdateEntity *update) { ListEntitiesUpdateResponse msg; - msg.key = update->get_object_id_hash(); - msg.object_id = update->get_object_id(); - if (update->has_own_name()) - msg.name = update->get_name(); - msg.unique_id = get_default_unique_id("update", update); - msg.icon = update->get_icon(); - msg.disabled_by_default = update->is_disabled_by_default(); - msg.entity_category = static_cast(update->get_entity_category()); msg.device_class = update->get_device_class(); - return api->send_list_entities_update_response(msg); + msg.unique_id = get_default_unique_id("update", update); + return this->try_send_entity_info_(static_cast(update), msg, + &APIConnection::send_list_entities_update_response); } void APIConnection::update_command(const UpdateCommandRequest &msg) { update::UpdateEntity *update = App.get_update_by_key(msg.key); @@ -1940,26 +1620,29 @@ NoiseEncryptionSetKeyResponse APIConnection::noise_encryption_set_key(const Nois void APIConnection::subscribe_home_assistant_states(const SubscribeHomeAssistantStatesRequest &msg) { state_subs_at_ = 0; } -bool APIConnection::send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) { +bool APIConnection::try_to_clear_buffer(bool log_out_of_space) { if (this->remove_) return false; - if (!this->helper_->can_write_without_blocking()) { - delay(0); - APIError err = this->helper_->loop(); - if (err != APIError::OK) { - on_fatal_error(); - ESP_LOGW(TAG, "%s: Socket operation failed: %s errno=%d", this->client_combined_info_.c_str(), - api_error_to_str(err), errno); - return false; - } - if (!this->helper_->can_write_without_blocking()) { - // SubscribeLogsResponse - if (message_type != 29) { - ESP_LOGV(TAG, "Cannot send message because of TCP buffer space"); - } - delay(0); - return false; - } + if (this->helper_->can_write_without_blocking()) + return true; + delay(0); + APIError err = this->helper_->loop(); + if (err != APIError::OK) { + on_fatal_error(); + ESP_LOGW(TAG, "%s: Socket operation failed: %s errno=%d", this->client_combined_info_.c_str(), + api_error_to_str(err), errno); + return false; + } + if (this->helper_->can_write_without_blocking()) + return true; + if (log_out_of_space) { + ESP_LOGV(TAG, "Cannot send message because of TCP buffer space"); + } + return false; +} +bool APIConnection::send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) { + if (!this->try_to_clear_buffer(message_type != 29)) { // SubscribeLogsResponse + return false; } APIError err = this->helper_->write_protobuf_packet(message_type, buffer); diff --git a/esphome/components/api/api_connection.h b/esphome/components/api/api_connection.h index b40e9602be..e8a29b9c7f 100644 --- a/esphome/components/api/api_connection.h +++ b/esphome/components/api/api_connection.h @@ -8,13 +8,14 @@ #include "api_server.h" #include "esphome/core/application.h" #include "esphome/core/component.h" +#include "esphome/core/entity_base.h" #include namespace esphome { namespace api { -using send_message_t = bool(APIConnection *, void *); +using send_message_t = bool (APIConnection::*)(void *); /* This class holds a pointer to the source component that wants to publish a message, and a pointer to a function that @@ -30,10 +31,10 @@ class DeferredMessageQueue { protected: void *source_; - send_message_t *send_message_; + send_message_t send_message_; public: - DeferredMessage(void *source, send_message_t *send_message) : source_(source), send_message_(send_message) {} + DeferredMessage(void *source, send_message_t send_message) : source_(source), send_message_(send_message) {} bool operator==(const DeferredMessage &test) const { return (source_ == test.source_ && send_message_ == test.send_message_); } @@ -46,12 +47,13 @@ class DeferredMessageQueue { APIConnection *api_connection_; // helper for allowing only unique entries in the queue - void dmq_push_back_with_dedup_(void *source, send_message_t *send_message); + void dmq_push_back_with_dedup_(void *source, send_message_t send_message); public: DeferredMessageQueue(APIConnection *api_connection) : api_connection_(api_connection) {} void process_queue(); - void defer(void *source, send_message_t *send_message); + void defer(void *source, send_message_t send_message); + bool empty() const { return deferred_queue_.empty(); } }; class APIConnection : public APIServerConnection { @@ -69,137 +71,213 @@ class APIConnection : public APIServerConnection { #ifdef USE_BINARY_SENSOR bool send_binary_sensor_state(binary_sensor::BinarySensor *binary_sensor, bool state); void send_binary_sensor_info(binary_sensor::BinarySensor *binary_sensor); - static bool try_send_binary_sensor_state(APIConnection *api, void *v_binary_sensor); - static bool try_send_binary_sensor_state(APIConnection *api, binary_sensor::BinarySensor *binary_sensor, bool state); - static bool try_send_binary_sensor_info(APIConnection *api, void *v_binary_sensor); + + protected: + bool try_send_binary_sensor_state_(binary_sensor::BinarySensor *binary_sensor); + bool try_send_binary_sensor_state_(binary_sensor::BinarySensor *binary_sensor, bool state); + bool try_send_binary_sensor_info_(binary_sensor::BinarySensor *binary_sensor); + + public: #endif #ifdef USE_COVER bool send_cover_state(cover::Cover *cover); void send_cover_info(cover::Cover *cover); - static bool try_send_cover_state(APIConnection *api, void *v_cover); - static bool try_send_cover_info(APIConnection *api, void *v_cover); void cover_command(const CoverCommandRequest &msg) override; + + protected: + bool try_send_cover_state_(cover::Cover *cover); + bool try_send_cover_info_(cover::Cover *cover); + + public: #endif #ifdef USE_FAN bool send_fan_state(fan::Fan *fan); void send_fan_info(fan::Fan *fan); - static bool try_send_fan_state(APIConnection *api, void *v_fan); - static bool try_send_fan_info(APIConnection *api, void *v_fan); void fan_command(const FanCommandRequest &msg) override; + + protected: + bool try_send_fan_state_(fan::Fan *fan); + bool try_send_fan_info_(fan::Fan *fan); + + public: #endif #ifdef USE_LIGHT bool send_light_state(light::LightState *light); void send_light_info(light::LightState *light); - static bool try_send_light_state(APIConnection *api, void *v_light); - static bool try_send_light_info(APIConnection *api, void *v_light); void light_command(const LightCommandRequest &msg) override; + + protected: + bool try_send_light_state_(light::LightState *light); + bool try_send_light_info_(light::LightState *light); + + public: #endif #ifdef USE_SENSOR bool send_sensor_state(sensor::Sensor *sensor, float state); void send_sensor_info(sensor::Sensor *sensor); - static bool try_send_sensor_state(APIConnection *api, void *v_sensor); - static bool try_send_sensor_state(APIConnection *api, sensor::Sensor *sensor, float state); - static bool try_send_sensor_info(APIConnection *api, void *v_sensor); + + protected: + bool try_send_sensor_state_(sensor::Sensor *sensor); + bool try_send_sensor_state_(sensor::Sensor *sensor, float state); + bool try_send_sensor_info_(sensor::Sensor *sensor); + + public: #endif #ifdef USE_SWITCH bool send_switch_state(switch_::Switch *a_switch, bool state); void send_switch_info(switch_::Switch *a_switch); - static bool try_send_switch_state(APIConnection *api, void *v_a_switch); - static bool try_send_switch_state(APIConnection *api, switch_::Switch *a_switch, bool state); - static bool try_send_switch_info(APIConnection *api, void *v_a_switch); void switch_command(const SwitchCommandRequest &msg) override; + + protected: + bool try_send_switch_state_(switch_::Switch *a_switch); + bool try_send_switch_state_(switch_::Switch *a_switch, bool state); + bool try_send_switch_info_(switch_::Switch *a_switch); + + public: #endif #ifdef USE_TEXT_SENSOR bool send_text_sensor_state(text_sensor::TextSensor *text_sensor, std::string state); void send_text_sensor_info(text_sensor::TextSensor *text_sensor); - static bool try_send_text_sensor_state(APIConnection *api, void *v_text_sensor); - static bool try_send_text_sensor_state(APIConnection *api, text_sensor::TextSensor *text_sensor, std::string state); - static bool try_send_text_sensor_info(APIConnection *api, void *v_text_sensor); + + protected: + bool try_send_text_sensor_state_(text_sensor::TextSensor *text_sensor); + bool try_send_text_sensor_state_(text_sensor::TextSensor *text_sensor, std::string state); + bool try_send_text_sensor_info_(text_sensor::TextSensor *text_sensor); + + public: #endif #ifdef USE_ESP32_CAMERA void set_camera_state(std::shared_ptr image); void send_camera_info(esp32_camera::ESP32Camera *camera); - static bool try_send_camera_info(APIConnection *api, void *v_camera); void camera_image(const CameraImageRequest &msg) override; + + protected: + bool try_send_camera_info_(esp32_camera::ESP32Camera *camera); + + public: #endif #ifdef USE_CLIMATE bool send_climate_state(climate::Climate *climate); void send_climate_info(climate::Climate *climate); - static bool try_send_climate_state(APIConnection *api, void *v_climate); - static bool try_send_climate_info(APIConnection *api, void *v_climate); void climate_command(const ClimateCommandRequest &msg) override; + + protected: + bool try_send_climate_state_(climate::Climate *climate); + bool try_send_climate_info_(climate::Climate *climate); + + public: #endif #ifdef USE_NUMBER bool send_number_state(number::Number *number, float state); void send_number_info(number::Number *number); - static bool try_send_number_state(APIConnection *api, void *v_number); - static bool try_send_number_state(APIConnection *api, number::Number *number, float state); - static bool try_send_number_info(APIConnection *api, void *v_number); void number_command(const NumberCommandRequest &msg) override; + + protected: + bool try_send_number_state_(number::Number *number); + bool try_send_number_state_(number::Number *number, float state); + bool try_send_number_info_(number::Number *number); + + public: #endif #ifdef USE_DATETIME_DATE bool send_date_state(datetime::DateEntity *date); void send_date_info(datetime::DateEntity *date); - static bool try_send_date_state(APIConnection *api, void *v_date); - static bool try_send_date_info(APIConnection *api, void *v_date); void date_command(const DateCommandRequest &msg) override; + + protected: + bool try_send_date_state_(datetime::DateEntity *date); + bool try_send_date_info_(datetime::DateEntity *date); + + public: #endif #ifdef USE_DATETIME_TIME bool send_time_state(datetime::TimeEntity *time); void send_time_info(datetime::TimeEntity *time); - static bool try_send_time_state(APIConnection *api, void *v_time); - static bool try_send_time_info(APIConnection *api, void *v_time); void time_command(const TimeCommandRequest &msg) override; + + protected: + bool try_send_time_state_(datetime::TimeEntity *time); + bool try_send_time_info_(datetime::TimeEntity *time); + + public: #endif #ifdef USE_DATETIME_DATETIME bool send_datetime_state(datetime::DateTimeEntity *datetime); void send_datetime_info(datetime::DateTimeEntity *datetime); - static bool try_send_datetime_state(APIConnection *api, void *v_datetime); - static bool try_send_datetime_info(APIConnection *api, void *v_datetime); void datetime_command(const DateTimeCommandRequest &msg) override; + + protected: + bool try_send_datetime_state_(datetime::DateTimeEntity *datetime); + bool try_send_datetime_info_(datetime::DateTimeEntity *datetime); + + public: #endif #ifdef USE_TEXT bool send_text_state(text::Text *text, std::string state); void send_text_info(text::Text *text); - static bool try_send_text_state(APIConnection *api, void *v_text); - static bool try_send_text_state(APIConnection *api, text::Text *text, std::string state); - static bool try_send_text_info(APIConnection *api, void *v_text); void text_command(const TextCommandRequest &msg) override; + + protected: + bool try_send_text_state_(text::Text *text); + bool try_send_text_state_(text::Text *text, std::string state); + bool try_send_text_info_(text::Text *text); + + public: #endif #ifdef USE_SELECT bool send_select_state(select::Select *select, std::string state); void send_select_info(select::Select *select); - static bool try_send_select_state(APIConnection *api, void *v_select); - static bool try_send_select_state(APIConnection *api, select::Select *select, std::string state); - static bool try_send_select_info(APIConnection *api, void *v_select); void select_command(const SelectCommandRequest &msg) override; + + protected: + bool try_send_select_state_(select::Select *select); + bool try_send_select_state_(select::Select *select, std::string state); + bool try_send_select_info_(select::Select *select); + + public: #endif #ifdef USE_BUTTON void send_button_info(button::Button *button); - static bool try_send_button_info(APIConnection *api, void *v_button); void button_command(const ButtonCommandRequest &msg) override; + + protected: + bool try_send_button_info_(button::Button *button); + + public: #endif #ifdef USE_LOCK bool send_lock_state(lock::Lock *a_lock, lock::LockState state); void send_lock_info(lock::Lock *a_lock); - static bool try_send_lock_state(APIConnection *api, void *v_a_lock); - static bool try_send_lock_state(APIConnection *api, lock::Lock *a_lock, lock::LockState state); - static bool try_send_lock_info(APIConnection *api, void *v_a_lock); void lock_command(const LockCommandRequest &msg) override; + + protected: + bool try_send_lock_state_(lock::Lock *a_lock); + bool try_send_lock_state_(lock::Lock *a_lock, lock::LockState state); + bool try_send_lock_info_(lock::Lock *a_lock); + + public: #endif #ifdef USE_VALVE bool send_valve_state(valve::Valve *valve); void send_valve_info(valve::Valve *valve); - static bool try_send_valve_state(APIConnection *api, void *v_valve); - static bool try_send_valve_info(APIConnection *api, void *v_valve); void valve_command(const ValveCommandRequest &msg) override; + + protected: + bool try_send_valve_state_(valve::Valve *valve); + bool try_send_valve_info_(valve::Valve *valve); + + public: #endif #ifdef USE_MEDIA_PLAYER bool send_media_player_state(media_player::MediaPlayer *media_player); void send_media_player_info(media_player::MediaPlayer *media_player); - static bool try_send_media_player_state(APIConnection *api, void *v_media_player); - static bool try_send_media_player_info(APIConnection *api, void *v_media_player); void media_player_command(const MediaPlayerCommandRequest &msg) override; + + protected: + bool try_send_media_player_state_(media_player::MediaPlayer *media_player); + bool try_send_media_player_info_(media_player::MediaPlayer *media_player); + + public: #endif bool try_send_log_message(int level, const char *tag, const char *line); void send_homeassistant_service_call(const HomeassistantServiceResponse &call) { @@ -246,25 +324,37 @@ class APIConnection : public APIServerConnection { #ifdef USE_ALARM_CONTROL_PANEL bool send_alarm_control_panel_state(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel); void send_alarm_control_panel_info(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel); - static bool try_send_alarm_control_panel_state(APIConnection *api, void *v_a_alarm_control_panel); - static bool try_send_alarm_control_panel_info(APIConnection *api, void *v_a_alarm_control_panel); void alarm_control_panel_command(const AlarmControlPanelCommandRequest &msg) override; + + protected: + bool try_send_alarm_control_panel_state_(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel); + bool try_send_alarm_control_panel_info_(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel); + + public: #endif #ifdef USE_EVENT void send_event(event::Event *event, std::string event_type); void send_event_info(event::Event *event); - static bool try_send_event(APIConnection *api, void *v_event); - static bool try_send_event(APIConnection *api, event::Event *event, std::string event_type); - static bool try_send_event_info(APIConnection *api, void *v_event); + + protected: + bool try_send_event_(event::Event *event); + bool try_send_event_(event::Event *event, std::string event_type); + bool try_send_event_info_(event::Event *event); + + public: #endif #ifdef USE_UPDATE bool send_update_state(update::UpdateEntity *update); void send_update_info(update::UpdateEntity *update); - static bool try_send_update_state(APIConnection *api, void *v_update); - static bool try_send_update_info(APIConnection *api, void *v_update); void update_command(const UpdateCommandRequest &msg) override; + + protected: + bool try_send_update_state_(update::UpdateEntity *update); + bool try_send_update_info_(update::UpdateEntity *update); + + public: #endif void on_disconnect_response(const DisconnectResponse &value) override; @@ -325,6 +415,7 @@ class APIConnection : public APIServerConnection { 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); bool send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) override; std::string get_client_combined_info() const { return this->client_combined_info_; } @@ -332,6 +423,99 @@ class APIConnection : public APIServerConnection { protected: friend APIServer; + /** + * Generic send entity state method to reduce code duplication. + * Only attempts to build and send the message if the transmit buffer is available. + * + * This is the base version for entities that use their current state. + * + * @param entity The entity to send state for + * @param try_send_func The function that tries to send the state + * @return True on success or message deferred, false if subscription check failed + */ + bool send_state_(esphome::EntityBase *entity, send_message_t try_send_func) { + if (!this->state_subscription_) + return false; + if (this->try_to_clear_buffer(true) && (this->*try_send_func)(entity)) { + return true; + } + this->deferred_message_queue_.defer(entity, try_send_func); + return true; + } + + /** + * Send entity state method that handles explicit state values. + * Only attempts to build and send the message if the transmit buffer is available. + * + * This method accepts a state parameter to be used instead of the entity's current state. + * It attempts to send the state with the provided value first, and if that fails due to buffer constraints, + * it defers the entity for later processing using the entity-only function. + * + * @tparam EntityT The entity type + * @tparam StateT Type of the state parameter + * @tparam Args Additional argument types (if any) + * @param entity The entity to send state for + * @param try_send_entity_func The function that tries to send the state with entity pointer only + * @param try_send_state_func The function that tries to send the state with entity and state parameters + * @param state The state value to send + * @param args Additional arguments to pass to the try_send_state_func + * @return True on success or message deferred, false if subscription check failed + */ + template + bool send_state_with_value_(EntityT *entity, bool (APIConnection::*try_send_entity_func)(EntityT *), + bool (APIConnection::*try_send_state_func)(EntityT *, StateT, Args...), StateT state, + Args... args) { + if (!this->state_subscription_) + return false; + if (this->try_to_clear_buffer(true) && (this->*try_send_state_func)(entity, state, args...)) { + return true; + } + this->deferred_message_queue_.defer(entity, reinterpret_cast(try_send_entity_func)); + return true; + } + + /** + * Generic send entity info method to reduce code duplication. + * Only attempts to build and send the message if the transmit buffer is available. + * + * @param entity The entity to send info for + * @param try_send_func The function that tries to send the info + */ + void send_info_(esphome::EntityBase *entity, send_message_t try_send_func) { + if (this->try_to_clear_buffer(true) && (this->*try_send_func)(entity)) { + return; + } + this->deferred_message_queue_.defer(entity, try_send_func); + } + + /** + * Generic function for generating entity info response messages. + * This is used to reduce duplication in the try_send_*_info functions. + * + * @param entity The entity to generate info for + * @param response The response object + * @param send_response_func Function pointer to send the response + * @return True if the message was sent successfully + */ + template + bool try_send_entity_info_(esphome::EntityBase *entity, ResponseT &response, + bool (APIServerConnectionBase::*send_response_func)(const ResponseT &)) { + // Set common fields that are shared by all entity types + response.key = entity->get_object_id_hash(); + response.object_id = entity->get_object_id(); + + if (entity->has_own_name()) + response.name = entity->get_name(); + + // Set common EntityBase properties + response.icon = entity->get_icon(); + response.disabled_by_default = entity->is_disabled_by_default(); + response.entity_category = static_cast(entity->get_entity_category()); + + // Send the response using the provided send method + return (this->*send_response_func)(response); + } + bool send_(const void *buf, size_t len, bool force); enum class ConnectionState { From 98470d32f066e9e92236ce33a67d282c42f52624 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 02/11] 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 ef053d23b406b0fb0375390a12224df174ad89b0 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 03/11] 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 89d283eee43dd094cf91a2359b13ecaa60e85f97 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 04/11] 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 +# , /