ESPHome
2024.5.0
|
#include <application.h>
Public Member Functions | |
void | pre_setup (const std::string &name, const std::string &friendly_name, const std::string &area, const char *comment, const char *compilation_time, bool name_add_mac_suffix) |
void | register_binary_sensor (binary_sensor::BinarySensor *binary_sensor) |
void | register_sensor (sensor::Sensor *sensor) |
void | register_switch (switch_::Switch *a_switch) |
void | register_button (button::Button *button) |
void | register_text_sensor (text_sensor::TextSensor *sensor) |
void | register_fan (fan::Fan *state) |
void | register_cover (cover::Cover *cover) |
void | register_climate (climate::Climate *climate) |
void | register_light (light::LightState *light) |
void | register_number (number::Number *number) |
void | register_date (datetime::DateEntity *date) |
void | register_time (datetime::TimeEntity *time) |
void | register_datetime (datetime::DateTimeEntity *datetime) |
void | register_text (text::Text *text) |
void | register_select (select::Select *select) |
void | register_lock (lock::Lock *a_lock) |
void | register_valve (valve::Valve *valve) |
void | register_media_player (media_player::MediaPlayer *media_player) |
void | register_alarm_control_panel (alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) |
void | register_event (event::Event *event) |
template<class C > | |
C * | register_component (C *c) |
Register the component in this Application instance. More... | |
void | setup () |
Set up all the registered components. Call this at the end of your setup() function. More... | |
void | loop () |
Make a loop iteration. Call this in your loop() function. More... | |
const std::string & | get_name () const |
Get the name of this Application set by pre_setup(). More... | |
const std::string & | get_friendly_name () const |
Get the friendly name of this Application set by pre_setup(). More... | |
const std::string & | get_area () const |
Get the area of this Application set by pre_setup(). More... | |
std::string | get_comment () const |
Get the comment of this Application set by pre_setup(). More... | |
bool | is_name_add_mac_suffix_enabled () const |
std::string | get_compilation_time () const |
void | set_loop_interval (uint32_t loop_interval) |
Set the target interval with which to run the loop() calls. More... | |
uint32_t | get_loop_interval () const |
void | schedule_dump_config () |
void | feed_wdt () |
void | reboot () |
void | safe_reboot () |
void | run_safe_shutdown_hooks () |
uint32_t | get_app_state () const |
const std::vector< binary_sensor::BinarySensor * > & | get_binary_sensors () |
binary_sensor::BinarySensor * | get_binary_sensor_by_key (uint32_t key, bool include_internal=false) |
const std::vector< switch_::Switch * > & | get_switches () |
switch_::Switch * | get_switch_by_key (uint32_t key, bool include_internal=false) |
const std::vector< button::Button * > & | get_buttons () |
button::Button * | get_button_by_key (uint32_t key, bool include_internal=false) |
const std::vector< sensor::Sensor * > & | get_sensors () |
sensor::Sensor * | get_sensor_by_key (uint32_t key, bool include_internal=false) |
const std::vector< text_sensor::TextSensor * > & | get_text_sensors () |
text_sensor::TextSensor * | get_text_sensor_by_key (uint32_t key, bool include_internal=false) |
const std::vector< fan::Fan * > & | get_fans () |
fan::Fan * | get_fan_by_key (uint32_t key, bool include_internal=false) |
const std::vector< cover::Cover * > & | get_covers () |
cover::Cover * | get_cover_by_key (uint32_t key, bool include_internal=false) |
const std::vector< light::LightState * > & | get_lights () |
light::LightState * | get_light_by_key (uint32_t key, bool include_internal=false) |
const std::vector< climate::Climate * > & | get_climates () |
climate::Climate * | get_climate_by_key (uint32_t key, bool include_internal=false) |
const std::vector< number::Number * > & | get_numbers () |
number::Number * | get_number_by_key (uint32_t key, bool include_internal=false) |
const std::vector< datetime::DateEntity * > & | get_dates () |
datetime::DateEntity * | get_date_by_key (uint32_t key, bool include_internal=false) |
const std::vector< datetime::TimeEntity * > & | get_times () |
datetime::TimeEntity * | get_time_by_key (uint32_t key, bool include_internal=false) |
const std::vector< datetime::DateTimeEntity * > & | get_datetimes () |
datetime::DateTimeEntity * | get_datetime_by_key (uint32_t key, bool include_internal=false) |
const std::vector< text::Text * > & | get_texts () |
text::Text * | get_text_by_key (uint32_t key, bool include_internal=false) |
const std::vector< select::Select * > & | get_selects () |
select::Select * | get_select_by_key (uint32_t key, bool include_internal=false) |
const std::vector< lock::Lock * > & | get_locks () |
lock::Lock * | get_lock_by_key (uint32_t key, bool include_internal=false) |
const std::vector< valve::Valve * > & | get_valves () |
valve::Valve * | get_valve_by_key (uint32_t key, bool include_internal=false) |
const std::vector< media_player::MediaPlayer * > & | get_media_players () |
media_player::MediaPlayer * | get_media_player_by_key (uint32_t key, bool include_internal=false) |
const std::vector< alarm_control_panel::AlarmControlPanel * > & | get_alarm_control_panels () |
alarm_control_panel::AlarmControlPanel * | get_alarm_control_panel_by_key (uint32_t key, bool include_internal=false) |
const std::vector< event::Event * > & | get_events () |
event::Event * | get_event_by_key (uint32_t key, bool include_internal=false) |
Data Fields | |
Scheduler | scheduler |
Protected Member Functions | |
void | register_component_ (Component *comp) |
void | calculate_looping_components_ () |
void | feed_wdt_arch_ () |
Definition at line 75 of file application.h.
|
protected |
Definition at line 146 of file application.cpp.
void IRAM_ATTR HOT esphome::Application::feed_wdt | ( | ) |
Definition at line 111 of file application.cpp.
|
protected |
|
inline |
Definition at line 406 of file application.h.
|
inline |
Definition at line 403 of file application.h.
|
inline |
Definition at line 237 of file application.h.
|
inline |
Get the area of this Application set by pre_setup().
Definition at line 201 of file application.h.
|
inline |
Definition at line 241 of file application.h.
|
inline |
Definition at line 240 of file application.h.
|
inline |
Definition at line 259 of file application.h.
|
inline |
Definition at line 258 of file application.h.
|
inline |
Definition at line 313 of file application.h.
|
inline |
Definition at line 312 of file application.h.
|
inline |
Get the comment of this Application set by pre_setup().
Definition at line 204 of file application.h.
|
inline |
Definition at line 208 of file application.h.
|
inline |
Definition at line 295 of file application.h.
|
inline |
Definition at line 294 of file application.h.
|
inline |
Definition at line 331 of file application.h.
|
inline |
Definition at line 330 of file application.h.
|
inline |
Definition at line 349 of file application.h.
|
inline |
Definition at line 348 of file application.h.
|
inline |
Definition at line 416 of file application.h.
|
inline |
Definition at line 415 of file application.h.
|
inline |
Definition at line 286 of file application.h.
|
inline |
Definition at line 285 of file application.h.
|
inline |
Get the friendly name of this Application set by pre_setup().
Definition at line 198 of file application.h.
|
inline |
Definition at line 304 of file application.h.
|
inline |
Definition at line 303 of file application.h.
|
inline |
Definition at line 376 of file application.h.
|
inline |
Definition at line 375 of file application.h.
|
inline |
Definition at line 225 of file application.h.
|
inline |
Definition at line 394 of file application.h.
|
inline |
Definition at line 393 of file application.h.
|
inline |
Get the name of this Application set by pre_setup().
Definition at line 195 of file application.h.
|
inline |
Definition at line 322 of file application.h.
|
inline |
Definition at line 321 of file application.h.
|
inline |
Definition at line 367 of file application.h.
|
inline |
Definition at line 366 of file application.h.
|
inline |
Definition at line 268 of file application.h.
|
inline |
Definition at line 267 of file application.h.
|
inline |
Definition at line 250 of file application.h.
|
inline |
Definition at line 249 of file application.h.
|
inline |
Definition at line 358 of file application.h.
|
inline |
Definition at line 277 of file application.h.
|
inline |
Definition at line 276 of file application.h.
|
inline |
Definition at line 357 of file application.h.
|
inline |
Definition at line 340 of file application.h.
|
inline |
Definition at line 339 of file application.h.
|
inline |
Definition at line 385 of file application.h.
|
inline |
Definition at line 384 of file application.h.
|
inline |
Definition at line 206 of file application.h.
void esphome::Application::loop | ( | ) |
Make a loop iteration. Call this in your loop() function.
Definition at line 66 of file application.cpp.
|
inline |
Definition at line 77 of file application.h.
void esphome::Application::reboot | ( | ) |
Definition at line 124 of file application.cpp.
|
inline |
Definition at line 172 of file application.h.
|
inline |
Definition at line 98 of file application.h.
|
inline |
Definition at line 112 of file application.h.
|
inline |
Definition at line 128 of file application.h.
|
inline |
Register the component in this Application instance.
Definition at line 182 of file application.h.
|
protected |
Definition at line 14 of file application.cpp.
|
inline |
Definition at line 124 of file application.h.
|
inline |
Definition at line 140 of file application.h.
|
inline |
Definition at line 148 of file application.h.
|
inline |
Definition at line 178 of file application.h.
|
inline |
Definition at line 120 of file application.h.
|
inline |
Definition at line 132 of file application.h.
|
inline |
Definition at line 160 of file application.h.
|
inline |
Definition at line 168 of file application.h.
|
inline |
Definition at line 136 of file application.h.
|
inline |
Definition at line 156 of file application.h.
|
inline |
Definition at line 104 of file application.h.
|
inline |
Definition at line 108 of file application.h.
|
inline |
Definition at line 152 of file application.h.
|
inline |
Definition at line 116 of file application.h.
|
inline |
Definition at line 144 of file application.h.
|
inline |
Definition at line 164 of file application.h.
void esphome::Application::run_safe_shutdown_hooks | ( | ) |
Definition at line 137 of file application.cpp.
void esphome::Application::safe_reboot | ( | ) |
Definition at line 131 of file application.cpp.
|
inline |
Definition at line 227 of file application.h.
|
inline |
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
loop_interval | The interval in milliseconds to run the core loop at. Defaults to 16 milliseconds. |
Definition at line 223 of file application.h.
void esphome::Application::setup | ( | ) |
Set up all the registered components. Call this at the end of your setup() function.
Definition at line 28 of file application.cpp.
|
protected |
Definition at line 496 of file application.h.
|
protected |
Definition at line 508 of file application.h.
|
protected |
Definition at line 501 of file application.h.
|
protected |
Definition at line 439 of file application.h.
|
protected |
Definition at line 445 of file application.h.
|
protected |
Definition at line 463 of file application.h.
|
protected |
Definition at line 502 of file application.h.
|
protected |
Definition at line 503 of file application.h.
|
protected |
Definition at line 427 of file application.h.
|
protected |
Definition at line 435 of file application.h.
|
protected |
Definition at line 460 of file application.h.
|
protected |
Definition at line 472 of file application.h.
|
protected |
Definition at line 478 of file application.h.
|
protected |
Definition at line 507 of file application.h.
|
protected |
Definition at line 448 of file application.h.
|
protected |
Definition at line 457 of file application.h.
|
protected |
Definition at line 500 of file application.h.
|
protected |
Definition at line 505 of file application.h.
|
protected |
Definition at line 466 of file application.h.
|
protected |
Definition at line 487 of file application.h.
|
protected |
Definition at line 506 of file application.h.
|
protected |
Definition at line 436 of file application.h.
|
protected |
Definition at line 493 of file application.h.
|
protected |
Definition at line 499 of file application.h.
|
protected |
Definition at line 504 of file application.h.
|
protected |
Definition at line 469 of file application.h.
Scheduler esphome::Application::scheduler |
Definition at line 424 of file application.h.
|
protected |
Definition at line 481 of file application.h.
|
protected |
Definition at line 451 of file application.h.
|
protected |
Definition at line 442 of file application.h.
|
protected |
Definition at line 454 of file application.h.
|
protected |
Definition at line 484 of file application.h.
|
protected |
Definition at line 475 of file application.h.
|
protected |
Definition at line 490 of file application.h.