ESPHome
2023.11.6
|
#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_text (text::Text *text) |
void | register_select (select::Select *select) |
void | register_lock (lock::Lock *a_lock) |
void | register_media_player (media_player::MediaPlayer *media_player) |
void | register_alarm_control_panel (alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) |
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... | |
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< 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< 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) |
Data Fields | |
Scheduler | scheduler |
Protected Member Functions | |
void | register_component_ (Component *comp) |
void | calculate_looping_components_ () |
void | feed_wdt_arch_ () |
Definition at line 60 of file application.h.
|
protected |
Definition at line 148 of file application.cpp.
void IRAM_ATTR HOT esphome::Application::feed_wdt | ( | ) |
Definition at line 113 of file application.cpp.
|
protected |
|
inline |
Definition at line 333 of file application.h.
|
inline |
Definition at line 330 of file application.h.
|
inline |
Definition at line 200 of file application.h.
|
inline |
Get the area of this Application set by pre_setup().
Definition at line 166 of file application.h.
|
inline |
Definition at line 204 of file application.h.
|
inline |
Definition at line 203 of file application.h.
|
inline |
Definition at line 222 of file application.h.
|
inline |
Definition at line 221 of file application.h.
|
inline |
Definition at line 276 of file application.h.
|
inline |
Definition at line 275 of file application.h.
|
inline |
Get the comment of this Application set by pre_setup().
Definition at line 169 of file application.h.
|
inline |
Definition at line 173 of file application.h.
|
inline |
Definition at line 258 of file application.h.
|
inline |
Definition at line 257 of file application.h.
|
inline |
Definition at line 249 of file application.h.
|
inline |
Definition at line 248 of file application.h.
|
inline |
Get the friendly name of this Application set by pre_setup().
Definition at line 163 of file application.h.
|
inline |
Definition at line 267 of file application.h.
|
inline |
Definition at line 266 of file application.h.
|
inline |
Definition at line 312 of file application.h.
|
inline |
Definition at line 311 of file application.h.
|
inline |
Definition at line 321 of file application.h.
|
inline |
Definition at line 320 of file application.h.
|
inline |
Get the name of this Application set by pre_setup().
Definition at line 160 of file application.h.
|
inline |
Definition at line 285 of file application.h.
|
inline |
Definition at line 284 of file application.h.
|
inline |
Definition at line 303 of file application.h.
|
inline |
Definition at line 302 of file application.h.
|
inline |
Definition at line 231 of file application.h.
|
inline |
Definition at line 230 of file application.h.
|
inline |
Definition at line 213 of file application.h.
|
inline |
Definition at line 212 of file application.h.
|
inline |
Definition at line 294 of file application.h.
|
inline |
Definition at line 240 of file application.h.
|
inline |
Definition at line 239 of file application.h.
|
inline |
Definition at line 293 of file application.h.
|
inline |
Definition at line 171 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 62 of file application.h.
void esphome::Application::reboot | ( | ) |
Definition at line 126 of file application.cpp.
|
inline |
Definition at line 141 of file application.h.
|
inline |
Definition at line 83 of file application.h.
|
inline |
Definition at line 97 of file application.h.
|
inline |
Definition at line 113 of file application.h.
|
inline |
Register the component in this Application instance.
Definition at line 147 of file application.h.
|
protected |
Definition at line 14 of file application.cpp.
|
inline |
Definition at line 109 of file application.h.
|
inline |
Definition at line 105 of file application.h.
|
inline |
Definition at line 117 of file application.h.
|
inline |
Definition at line 133 of file application.h.
|
inline |
Definition at line 137 of file application.h.
|
inline |
Definition at line 121 of file application.h.
|
inline |
Definition at line 129 of file application.h.
|
inline |
Definition at line 89 of file application.h.
|
inline |
Definition at line 93 of file application.h.
|
inline |
Definition at line 125 of file application.h.
|
inline |
Definition at line 101 of file application.h.
void esphome::Application::run_safe_shutdown_hooks | ( | ) |
Definition at line 139 of file application.cpp.
void esphome::Application::safe_reboot | ( | ) |
Definition at line 133 of file application.cpp.
|
inline |
Definition at line 190 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 188 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 398 of file application.h.
|
protected |
Definition at line 410 of file application.h.
|
protected |
Definition at line 403 of file application.h.
|
protected |
Definition at line 356 of file application.h.
|
protected |
Definition at line 362 of file application.h.
|
protected |
Definition at line 377 of file application.h.
|
protected |
Definition at line 404 of file application.h.
|
protected |
Definition at line 405 of file application.h.
|
protected |
Definition at line 344 of file application.h.
|
protected |
Definition at line 352 of file application.h.
|
protected |
Definition at line 374 of file application.h.
|
protected |
Definition at line 409 of file application.h.
|
protected |
Definition at line 371 of file application.h.
|
protected |
Definition at line 402 of file application.h.
|
protected |
Definition at line 407 of file application.h.
|
protected |
Definition at line 380 of file application.h.
|
protected |
Definition at line 392 of file application.h.
|
protected |
Definition at line 408 of file application.h.
|
protected |
Definition at line 353 of file application.h.
|
protected |
Definition at line 395 of file application.h.
|
protected |
Definition at line 401 of file application.h.
|
protected |
Definition at line 406 of file application.h.
|
protected |
Definition at line 383 of file application.h.
Scheduler esphome::Application::scheduler |
Definition at line 341 of file application.h.
|
protected |
Definition at line 386 of file application.h.
|
protected |
Definition at line 365 of file application.h.
|
protected |
Definition at line 359 of file application.h.
|
protected |
Definition at line 368 of file application.h.
|
protected |
Definition at line 389 of file application.h.