#pragma once #include #include #include "esphome/core/defines.h" #include "esphome/core/preferences.h" #include "esphome/core/component.h" #include "esphome/core/hal.h" #include "esphome/core/helpers.h" #include "esphome/core/scheduler.h" #ifdef USE_BINARY_SENSOR #include "esphome/components/binary_sensor/binary_sensor.h" #endif #ifdef USE_SENSOR #include "esphome/components/sensor/sensor.h" #endif #ifdef USE_SWITCH #include "esphome/components/switch/switch.h" #endif #ifdef USE_BUTTON #include "esphome/components/button/button.h" #endif #ifdef USE_TEXT_SENSOR #include "esphome/components/text_sensor/text_sensor.h" #endif #ifdef USE_FAN #include "esphome/components/fan/fan_state.h" #endif #ifdef USE_CLIMATE #include "esphome/components/climate/climate.h" #endif #ifdef USE_LIGHT #include "esphome/components/light/light_state.h" #endif #ifdef USE_COVER #include "esphome/components/cover/cover.h" #endif #ifdef USE_NUMBER #include "esphome/components/number/number.h" #endif #ifdef USE_SELECT #include "esphome/components/select/select.h" #endif namespace esphome { class Application { public: void pre_setup(const std::string &name, const char *compilation_time, bool name_add_mac_suffix) { arch_init(); this->name_add_mac_suffix_ = name_add_mac_suffix; if (name_add_mac_suffix) { this->name_ = name + "-" + get_mac_address().substr(6); } else { this->name_ = name; } this->compilation_time_ = compilation_time; } #ifdef USE_BINARY_SENSOR void register_binary_sensor(binary_sensor::BinarySensor *binary_sensor) { this->binary_sensors_.push_back(binary_sensor); } #endif #ifdef USE_SENSOR void register_sensor(sensor::Sensor *sensor) { this->sensors_.push_back(sensor); } #endif #ifdef USE_SWITCH void register_switch(switch_::Switch *a_switch) { this->switches_.push_back(a_switch); } #endif #ifdef USE_BUTTON void register_button(button::Button *button) { this->buttons_.push_back(button); } #endif #ifdef USE_TEXT_SENSOR void register_text_sensor(text_sensor::TextSensor *sensor) { this->text_sensors_.push_back(sensor); } #endif #ifdef USE_FAN void register_fan(fan::FanState *state) { this->fans_.push_back(state); } #endif #ifdef USE_COVER void register_cover(cover::Cover *cover) { this->covers_.push_back(cover); } #endif #ifdef USE_CLIMATE void register_climate(climate::Climate *climate) { this->climates_.push_back(climate); } #endif #ifdef USE_LIGHT void register_light(light::LightState *light) { this->lights_.push_back(light); } #endif #ifdef USE_NUMBER void register_number(number::Number *number) { this->numbers_.push_back(number); } #endif #ifdef USE_SELECT void register_select(select::Select *select) { this->selects_.push_back(select); } #endif /// Register the component in this Application instance. template C *register_component(C *c) { static_assert(std::is_base_of::value, "Only Component subclasses can be registered"); this->register_component_((Component *) c); return c; } /// Set up all the registered components. Call this at the end of your setup() function. void setup(); /// Make a loop iteration. Call this in your loop() function. void loop(); /// Get the name of this Application set by set_name(). const std::string &get_name() const { return this->name_; } bool is_name_add_mac_suffix_enabled() const { return this->name_add_mac_suffix_; } const std::string &get_compilation_time() const { return this->compilation_time_; } /** Set the target interval with which to run the loop() calls. * If the loop() method takes longer than the target interval, ESPHome won't * sleep in loop(), but if the time spent in loop() is small than the target, ESPHome * will delay at the end of the App.loop() method. * * This is done to conserve power: In most use-cases, high-speed loop() calls are not required * and degrade power consumption. * * Each component can request a high frequency loop execution by using the HighFrequencyLoopRequester * helper in helpers.h * * @param loop_interval The interval in milliseconds to run the core loop at. Defaults to 16 milliseconds. */ void set_loop_interval(uint32_t loop_interval) { this->loop_interval_ = loop_interval; } void schedule_dump_config() { this->dump_config_at_ = 0; } void feed_wdt(); void reboot(); void safe_reboot(); void run_safe_shutdown_hooks() { for (auto *comp : this->components_) { comp->on_safe_shutdown(); } for (auto *comp : this->components_) { comp->on_shutdown(); } } uint32_t get_app_state() const { return this->app_state_; } #ifdef USE_BINARY_SENSOR const std::vector &get_binary_sensors() { return this->binary_sensors_; } binary_sensor::BinarySensor *get_binary_sensor_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->binary_sensors_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_SWITCH const std::vector &get_switches() { return this->switches_; } switch_::Switch *get_switch_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->switches_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_BUTTON const std::vector &get_buttons() { return this->buttons_; } button::Button *get_button_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->buttons_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_SENSOR const std::vector &get_sensors() { return this->sensors_; } sensor::Sensor *get_sensor_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->sensors_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_TEXT_SENSOR const std::vector &get_text_sensors() { return this->text_sensors_; } text_sensor::TextSensor *get_text_sensor_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->text_sensors_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_FAN const std::vector &get_fans() { return this->fans_; } fan::FanState *get_fan_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->fans_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_COVER const std::vector &get_covers() { return this->covers_; } cover::Cover *get_cover_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->covers_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_LIGHT const std::vector &get_lights() { return this->lights_; } light::LightState *get_light_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->lights_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_CLIMATE const std::vector &get_climates() { return this->climates_; } climate::Climate *get_climate_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->climates_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_NUMBER const std::vector &get_numbers() { return this->numbers_; } number::Number *get_number_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->numbers_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif #ifdef USE_SELECT const std::vector &get_selects() { return this->selects_; } select::Select *get_select_by_key(uint32_t key, bool include_internal = false) { for (auto *obj : this->selects_) if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) return obj; return nullptr; } #endif Scheduler scheduler; protected: friend Component; void register_component_(Component *comp); void calculate_looping_components_(); void feed_wdt_arch_(); std::vector components_{}; std::vector looping_components_{}; #ifdef USE_BINARY_SENSOR std::vector binary_sensors_{}; #endif #ifdef USE_SWITCH std::vector switches_{}; #endif #ifdef USE_BUTTON std::vector buttons_{}; #endif #ifdef USE_SENSOR std::vector sensors_{}; #endif #ifdef USE_TEXT_SENSOR std::vector text_sensors_{}; #endif #ifdef USE_FAN std::vector fans_{}; #endif #ifdef USE_COVER std::vector covers_{}; #endif #ifdef USE_CLIMATE std::vector climates_{}; #endif #ifdef USE_LIGHT std::vector lights_{}; #endif #ifdef USE_NUMBER std::vector numbers_{}; #endif #ifdef USE_SELECT std::vector selects_{}; #endif std::string name_; std::string compilation_time_; bool name_add_mac_suffix_; uint32_t last_loop_{0}; uint32_t loop_interval_{16}; size_t dump_config_at_{SIZE_MAX}; uint32_t app_state_{0}; }; /// Global storage of Application pointer - only one Application can exist. extern Application App; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables) } // namespace esphome