ESPHome 2025.12.5
Loading...
Searching...
No Matches
esphome::Application Class Reference

#include <application.h>

Public Member Functions

void pre_setup (const std::string &name, const std::string &friendly_name, const char *comment, const char *compilation_time, bool name_add_mac_suffix)
 
void register_device (Device *device)
 
void register_area (Area *area)
 
void set_current_component (Component *component)
 
Componentget_current_component ()
 
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)
 
void register_update (update::UpdateEntity *update)
 
template<class C >
C * register_component (C *c)
 Reserve space for components to avoid memory fragmentation.
 
void setup ()
 Set up all the registered components. Call this at the end of your setup() function.
 
void loop ()
 Make a loop iteration. Call this in your loop() function.
 
const std::string & get_name () const
 Get the name of this Application set by pre_setup().
 
const std::string & get_friendly_name () const
 Get the friendly name of this Application set by pre_setup().
 
const char * get_area () const
 Get the area of this Application set by pre_setup().
 
std::string get_comment () const
 Get the comment of this Application set by pre_setup().
 
StringRef get_comment_ref () const
 Get the comment as StringRef (avoids allocation)
 
bool is_name_add_mac_suffix_enabled () const
 
std::string get_compilation_time () const
 
StringRef get_compilation_time_ref () const
 Get the compilation time as StringRef (for API usage)
 
uint32_t IRAM_ATTR HOT get_loop_component_start_time () const
 Get the cached time in milliseconds from when the current component started its loop execution.
 
void set_loop_interval (uint32_t loop_interval)
 Set the target interval with which to run the loop() calls.
 
uint32_t get_loop_interval () const
 
void schedule_dump_config ()
 
void feed_wdt (uint32_t time=0)
 
void reboot ()
 
void safe_reboot ()
 
void run_safe_shutdown_hooks ()
 
void run_powerdown_hooks ()
 
void teardown_components (uint32_t timeout_ms)
 Teardown all components with a timeout.
 
uint8_t get_app_state () const
 
const auto & get_devices ()
 
const auto & get_areas ()
 
auto & get_binary_sensors () const
 
 GET_ENTITY_METHOD (binary_sensor::BinarySensor, binary_sensor, binary_sensors) auto &get_switches() const
 
 GET_ENTITY_METHOD (switch_::Switch, switch, switches) auto &get_buttons() const
 
 GET_ENTITY_METHOD (button::Button, button, buttons) auto &get_sensors() const
 
 GET_ENTITY_METHOD (sensor::Sensor, sensor, sensors) auto &get_text_sensors() const
 
 GET_ENTITY_METHOD (text_sensor::TextSensor, text_sensor, text_sensors) auto &get_fans() const
 
 GET_ENTITY_METHOD (fan::Fan, fan, fans) auto &get_covers() const
 
 GET_ENTITY_METHOD (cover::Cover, cover, covers) auto &get_lights() const
 
 GET_ENTITY_METHOD (light::LightState, light, lights) auto &get_climates() const
 
 GET_ENTITY_METHOD (climate::Climate, climate, climates) auto &get_numbers() const
 
 GET_ENTITY_METHOD (number::Number, number, numbers) auto &get_dates() const
 
 GET_ENTITY_METHOD (datetime::DateEntity, date, dates) auto &get_times() const
 
 GET_ENTITY_METHOD (datetime::TimeEntity, time, times) auto &get_datetimes() const
 
 GET_ENTITY_METHOD (datetime::DateTimeEntity, datetime, datetimes) auto &get_texts() const
 
 GET_ENTITY_METHOD (text::Text, text, texts) auto &get_selects() const
 
 GET_ENTITY_METHOD (select::Select, select, selects) auto &get_locks() const
 
 GET_ENTITY_METHOD (lock::Lock, lock, locks) auto &get_valves() const
 
 GET_ENTITY_METHOD (valve::Valve, valve, valves) auto &get_media_players() const
 
 GET_ENTITY_METHOD (media_player::MediaPlayer, media_player, media_players) auto &get_alarm_control_panels() const
 
 GET_ENTITY_METHOD (alarm_control_panel::AlarmControlPanel, alarm_control_panel, alarm_control_panels) auto &get_events() const
 
 GET_ENTITY_METHOD (event::Event, event, events) auto &get_updates() const
 
 GET_ENTITY_METHOD (update::UpdateEntity, update, updates) Scheduler scheduler
 
bool register_socket_fd (int fd)
 Register/unregister a socket file descriptor to be monitored for read events.
 
void unregister_socket_fd (int fd)
 
bool is_socket_ready (int fd) const
 Check if there's data available on a socket without blocking This function is thread-safe for reading, but should be called after select() has run.
 
void wake_loop_threadsafe ()
 Wake the main event loop from a FreeRTOS task Thread-safe, can be called from task context to immediately wake select() IMPORTANT: NOT safe to call from ISR context (socket operations not ISR-safe)
 

Protected Member Functions

void register_component_ (Component *comp)
 
void calculate_looping_components_ ()
 
void add_looping_components_by_state_ (bool match_loop_done)
 
void disable_component_loop_ (Component *component)
 
void enable_component_loop_ (Component *component)
 
void enable_pending_loops_ ()
 
void activate_looping_component_ (uint16_t index)
 
void before_loop_tasks_ (uint32_t loop_start_time)
 
void after_loop_tasks_ ()
 
void feed_wdt_arch_ ()
 
void yield_with_select_ (uint32_t delay_ms)
 Perform a delay while also monitoring socket file descriptors for readiness.
 
void setup_wake_loop_threadsafe_ ()
 
void drain_wake_notifications_ ()
 

Protected Attributes

friend Component
 
Componentcurrent_component_ {nullptr}
 
const char * comment_ {nullptr}
 
const char * compilation_time_ {nullptr}
 
FixedVector< Component * > looping_components_ {}
 
std::vector< int > socket_fds_
 
int wake_socket_fd_ {-1}
 
std::string name_
 
std::string friendly_name_
 
size_t dump_config_at_ {SIZE_MAX}
 
uint32_t last_loop_ {0}
 
uint32_t loop_component_start_time_ {0}
 
int max_fd_ {-1}
 
uint16_t loop_interval_ {16}
 
uint16_t looping_components_active_end_ {0}
 
uint16_t current_loop_index_ {0}
 
uint8_t app_state_ {0}
 
bool name_add_mac_suffix_
 
bool in_loop_ {false}
 
volatile bool has_pending_enable_loop_requests_ {false}
 
bool socket_fds_changed_ {false}
 
fd_set base_read_fds_ {}
 
fd_set read_fds_ {}
 
StaticVector< Component *, ESPHOME_COMPONENT_COUNT > components_ {}
 
StaticVector< Device *, ESPHOME_DEVICE_COUNT > devices_ {}
 
StaticVector< Area *, ESPHOME_AREA_COUNT > areas_ {}
 
StaticVector< binary_sensor::BinarySensor *, ESPHOME_ENTITY_BINARY_SENSOR_COUNT > binary_sensors_ {}
 
StaticVector< switch_::Switch *, ESPHOME_ENTITY_SWITCH_COUNT > switches_ {}
 
StaticVector< button::Button *, ESPHOME_ENTITY_BUTTON_COUNT > buttons_ {}
 
StaticVector< event::Event *, ESPHOME_ENTITY_EVENT_COUNT > events_ {}
 
StaticVector< sensor::Sensor *, ESPHOME_ENTITY_SENSOR_COUNT > sensors_ {}
 
StaticVector< text_sensor::TextSensor *, ESPHOME_ENTITY_TEXT_SENSOR_COUNT > text_sensors_ {}
 
StaticVector< fan::Fan *, ESPHOME_ENTITY_FAN_COUNT > fans_ {}
 
StaticVector< cover::Cover *, ESPHOME_ENTITY_COVER_COUNT > covers_ {}
 
StaticVector< climate::Climate *, ESPHOME_ENTITY_CLIMATE_COUNT > climates_ {}
 
StaticVector< light::LightState *, ESPHOME_ENTITY_LIGHT_COUNT > lights_ {}
 
StaticVector< number::Number *, ESPHOME_ENTITY_NUMBER_COUNT > numbers_ {}
 
StaticVector< datetime::DateEntity *, ESPHOME_ENTITY_DATE_COUNT > dates_ {}
 
StaticVector< datetime::TimeEntity *, ESPHOME_ENTITY_TIME_COUNT > times_ {}
 
StaticVector< datetime::DateTimeEntity *, ESPHOME_ENTITY_DATETIME_COUNT > datetimes_ {}
 
StaticVector< select::Select *, ESPHOME_ENTITY_SELECT_COUNT > selects_ {}
 
StaticVector< text::Text *, ESPHOME_ENTITY_TEXT_COUNT > texts_ {}
 
StaticVector< lock::Lock *, ESPHOME_ENTITY_LOCK_COUNT > locks_ {}
 
StaticVector< valve::Valve *, ESPHOME_ENTITY_VALVE_COUNT > valves_ {}
 
StaticVector< media_player::MediaPlayer *, ESPHOME_ENTITY_MEDIA_PLAYER_COUNT > media_players_ {}
 
StaticVector< alarm_control_panel::AlarmControlPanel *, ESPHOME_ENTITY_ALARM_CONTROL_PANEL_COUNT > alarm_control_panels_ {}
 
StaticVector< update::UpdateEntity *, ESPHOME_ENTITY_UPDATE_COUNT > updates_ {}
 

Detailed Description

Definition at line 101 of file application.h.

Member Function Documentation

◆ activate_looping_component_()

void esphome::Application::activate_looping_component_ ( uint16_t index)
protected

Definition at line 405 of file application.cpp.

◆ add_looping_components_by_state_()

void esphome::Application::add_looping_components_by_state_ ( bool match_loop_done)
protected

Definition at line 367 of file application.cpp.

◆ after_loop_tasks_()

void esphome::Application::after_loop_tasks_ ( )
protected

Definition at line 513 of file application.cpp.

◆ before_loop_tasks_()

void esphome::Application::before_loop_tasks_ ( uint32_t loop_start_time)
protected

Definition at line 483 of file application.cpp.

◆ calculate_looping_components_()

void esphome::Application::calculate_looping_components_ ( )
protected

Definition at line 343 of file application.cpp.

◆ disable_component_loop_()

void esphome::Application::disable_component_loop_ ( Component * component)
protected

Definition at line 376 of file application.cpp.

◆ drain_wake_notifications_()

void esphome::Application::drain_wake_notifications_ ( )
inlineprotected

Definition at line 630 of file application.h.

◆ enable_component_loop_()

void esphome::Application::enable_component_loop_ ( Component * component)
protected

Definition at line 413 of file application.cpp.

◆ enable_pending_loops_()

void esphome::Application::enable_pending_loops_ ( )
protected

Definition at line 430 of file application.cpp.

◆ feed_wdt()

void IRAM_ATTR HOT esphome::Application::feed_wdt ( uint32_t time = 0)

Definition at line 205 of file application.cpp.

◆ feed_wdt_arch_()

void esphome::Application::feed_wdt_arch_ ( )
protected

◆ get_app_state()

uint8_t esphome::Application::get_app_state ( ) const
inline

Definition at line 311 of file application.h.

◆ get_area()

const char * esphome::Application::get_area ( ) const
inline

Get the area of this Application set by pre_setup().

Definition at line 247 of file application.h.

◆ get_areas()

const auto & esphome::Application::get_areas ( )
inline

Definition at line 336 of file application.h.

◆ get_binary_sensors()

auto & esphome::Application::get_binary_sensors ( ) const
inline

Definition at line 339 of file application.h.

◆ get_comment()

std::string esphome::Application::get_comment ( ) const
inline

Get the comment of this Application set by pre_setup().

Definition at line 258 of file application.h.

◆ get_comment_ref()

StringRef esphome::Application::get_comment_ref ( ) const
inline

Get the comment as StringRef (avoids allocation)

Definition at line 260 of file application.h.

◆ get_compilation_time()

std::string esphome::Application::get_compilation_time ( ) const
inline

Definition at line 264 of file application.h.

◆ get_compilation_time_ref()

StringRef esphome::Application::get_compilation_time_ref ( ) const
inline

Get the compilation time as StringRef (for API usage)

Definition at line 266 of file application.h.

◆ get_current_component()

Component * esphome::Application::get_current_component ( )
inline

Definition at line 135 of file application.h.

◆ get_devices()

const auto & esphome::Application::get_devices ( )
inline

Definition at line 324 of file application.h.

◆ GET_ENTITY_METHOD() [1/21]

esphome::Application::GET_ENTITY_METHOD ( alarm_control_panel::AlarmControlPanel ,
alarm_control_panel ,
alarm_control_panels  ) const &
inline

Definition at line 413 of file application.h.

◆ GET_ENTITY_METHOD() [2/21]

esphome::Application::GET_ENTITY_METHOD ( binary_sensor::BinarySensor ,
binary_sensor ,
binary_sensors  ) const &
inline

Definition at line 340 of file application.h.

◆ GET_ENTITY_METHOD() [3/21]

esphome::Application::GET_ENTITY_METHOD ( button::Button ,
button ,
buttons  ) const &
inline

Definition at line 348 of file application.h.

◆ GET_ENTITY_METHOD() [4/21]

esphome::Application::GET_ENTITY_METHOD ( climate::Climate ,
climate ,
climates  ) const &
inline

Definition at line 372 of file application.h.

◆ GET_ENTITY_METHOD() [5/21]

esphome::Application::GET_ENTITY_METHOD ( cover::Cover ,
cover ,
covers  ) const &
inline

Definition at line 364 of file application.h.

◆ GET_ENTITY_METHOD() [6/21]

esphome::Application::GET_ENTITY_METHOD ( datetime::DateEntity ,
date ,
dates  ) const &
inline

Definition at line 380 of file application.h.

◆ GET_ENTITY_METHOD() [7/21]

esphome::Application::GET_ENTITY_METHOD ( datetime::DateTimeEntity ,
datetime ,
datetimes  ) const &
inline

Definition at line 388 of file application.h.

◆ GET_ENTITY_METHOD() [8/21]

esphome::Application::GET_ENTITY_METHOD ( datetime::TimeEntity ,
time ,
times  ) const &
inline

Definition at line 384 of file application.h.

◆ GET_ENTITY_METHOD() [9/21]

esphome::Application::GET_ENTITY_METHOD ( event::Event ,
event ,
events  ) const &
inline

Definition at line 418 of file application.h.

◆ GET_ENTITY_METHOD() [10/21]

esphome::Application::GET_ENTITY_METHOD ( fan::Fan ,
fan ,
fans  ) const &
inline

Definition at line 360 of file application.h.

◆ GET_ENTITY_METHOD() [11/21]

esphome::Application::GET_ENTITY_METHOD ( light::LightState ,
light ,
lights  ) const &
inline

Definition at line 368 of file application.h.

◆ GET_ENTITY_METHOD() [12/21]

esphome::Application::GET_ENTITY_METHOD ( lock::Lock ,
lock ,
locks  ) const &
inline

Definition at line 400 of file application.h.

◆ GET_ENTITY_METHOD() [13/21]

esphome::Application::GET_ENTITY_METHOD ( media_player::MediaPlayer ,
media_player ,
media_players  ) const &
inline

Definition at line 408 of file application.h.

◆ GET_ENTITY_METHOD() [14/21]

esphome::Application::GET_ENTITY_METHOD ( number::Number ,
number ,
numbers  ) const &
inline

Definition at line 376 of file application.h.

◆ GET_ENTITY_METHOD() [15/21]

esphome::Application::GET_ENTITY_METHOD ( select::Select ,
select ,
selects  ) const &
inline

Definition at line 396 of file application.h.

◆ GET_ENTITY_METHOD() [16/21]

esphome::Application::GET_ENTITY_METHOD ( sensor::Sensor ,
sensor ,
sensors  ) const &
inline

Definition at line 352 of file application.h.

◆ GET_ENTITY_METHOD() [17/21]

esphome::Application::GET_ENTITY_METHOD ( switch_::Switch ,
switch ,
switches  ) const &
inline

Definition at line 344 of file application.h.

◆ GET_ENTITY_METHOD() [18/21]

esphome::Application::GET_ENTITY_METHOD ( text::Text ,
text ,
texts  ) const &
inline

Definition at line 392 of file application.h.

◆ GET_ENTITY_METHOD() [19/21]

esphome::Application::GET_ENTITY_METHOD ( text_sensor::TextSensor ,
text_sensor ,
text_sensors  ) const &
inline

Definition at line 356 of file application.h.

◆ GET_ENTITY_METHOD() [20/21]

esphome::Application::GET_ENTITY_METHOD ( update::UpdateEntity ,
update ,
updates  )

◆ GET_ENTITY_METHOD() [21/21]

esphome::Application::GET_ENTITY_METHOD ( valve::Valve ,
valve ,
valves  ) const &
inline

Definition at line 404 of file application.h.

◆ get_friendly_name()

const std::string & esphome::Application::get_friendly_name ( ) const
inline

Get the friendly name of this Application set by pre_setup().

Definition at line 244 of file application.h.

◆ get_loop_component_start_time()

uint32_t IRAM_ATTR HOT esphome::Application::get_loop_component_start_time ( ) const
inline

Get the cached time in milliseconds from when the current component started its loop execution.

Definition at line 269 of file application.h.

◆ get_loop_interval()

uint32_t esphome::Application::get_loop_interval ( ) const
inline

Definition at line 291 of file application.h.

◆ get_name()

const std::string & esphome::Application::get_name ( ) const
inline

Get the name of this Application set by pre_setup().

Definition at line 241 of file application.h.

◆ is_name_add_mac_suffix_enabled()

bool esphome::Application::is_name_add_mac_suffix_enabled ( ) const
inline

Definition at line 262 of file application.h.

◆ is_socket_ready()

bool esphome::Application::is_socket_ready ( int fd) const

Check if there's data available on a socket without blocking This function is thread-safe for reading, but should be called after select() has run.

Definition at line 574 of file application.cpp.

◆ loop()

void esphome::Application::loop ( )

Make a loop iteration. Call this in your loop() function.

Definition at line 136 of file application.cpp.

◆ pre_setup()

void esphome::Application::pre_setup ( const std::string & name,
const std::string & friendly_name,
const char * comment,
const char * compilation_time,
bool name_add_mac_suffix )
inline

Definition at line 103 of file application.h.

◆ reboot()

void esphome::Application::reboot ( )

Definition at line 220 of file application.cpp.

◆ register_alarm_control_panel()

void esphome::Application::register_alarm_control_panel ( alarm_control_panel::AlarmControlPanel * a_alarm_control_panel)
inline

Definition at line 212 of file application.h.

◆ register_area()

void esphome::Application::register_area ( Area * area)
inline

Definition at line 131 of file application.h.

◆ register_binary_sensor()

void esphome::Application::register_binary_sensor ( binary_sensor::BinarySensor * binary_sensor)
inline

Definition at line 138 of file application.h.

◆ register_button()

void esphome::Application::register_button ( button::Button * button)
inline

Definition at line 152 of file application.h.

◆ register_climate()

void esphome::Application::register_climate ( climate::Climate * climate)
inline

Definition at line 168 of file application.h.

◆ register_component()

template<class C >
C * esphome::Application::register_component ( C * c)
inline

Reserve space for components to avoid memory fragmentation.

Register the component in this Application instance.

Definition at line 228 of file application.h.

◆ register_component_()

void esphome::Application::register_component_ ( Component * comp)
protected

Definition at line 62 of file application.cpp.

◆ register_cover()

void esphome::Application::register_cover ( cover::Cover * cover)
inline

Definition at line 164 of file application.h.

◆ register_date()

void esphome::Application::register_date ( datetime::DateEntity * date)
inline

Definition at line 180 of file application.h.

◆ register_datetime()

void esphome::Application::register_datetime ( datetime::DateTimeEntity * datetime)
inline

Definition at line 188 of file application.h.

◆ register_device()

void esphome::Application::register_device ( Device * device)
inline

Definition at line 128 of file application.h.

◆ register_event()

void esphome::Application::register_event ( event::Event * event)
inline

Definition at line 218 of file application.h.

◆ register_fan()

void esphome::Application::register_fan ( fan::Fan * state)
inline

Definition at line 160 of file application.h.

◆ register_light()

void esphome::Application::register_light ( light::LightState * light)
inline

Definition at line 172 of file application.h.

◆ register_lock()

void esphome::Application::register_lock ( lock::Lock * a_lock)
inline

Definition at line 200 of file application.h.

◆ register_media_player()

void esphome::Application::register_media_player ( media_player::MediaPlayer * media_player)
inline

Definition at line 208 of file application.h.

◆ register_number()

void esphome::Application::register_number ( number::Number * number)
inline

Definition at line 176 of file application.h.

◆ register_select()

void esphome::Application::register_select ( select::Select * select)
inline

Definition at line 196 of file application.h.

◆ register_sensor()

void esphome::Application::register_sensor ( sensor::Sensor * sensor)
inline

Definition at line 144 of file application.h.

◆ register_socket_fd()

bool esphome::Application::register_socket_fd ( int fd)

Register/unregister a socket file descriptor to be monitored for read events.

These functions update the fd_set used by select() in the main loop. WARNING: These functions are NOT thread-safe. They must only be called from the main loop. NOTE: File descriptors >= FD_SETSIZE (typically 10 on ESP) will be rejected with an error.

Returns
true if registration was successful, false if fd exceeds limits

Definition at line 519 of file application.cpp.

◆ register_switch()

void esphome::Application::register_switch ( switch_::Switch * a_switch)
inline

Definition at line 148 of file application.h.

◆ register_text()

void esphome::Application::register_text ( text::Text * text)
inline

Definition at line 192 of file application.h.

◆ register_text_sensor()

void esphome::Application::register_text_sensor ( text_sensor::TextSensor * sensor)
inline

Definition at line 156 of file application.h.

◆ register_time()

void esphome::Application::register_time ( datetime::TimeEntity * time)
inline

Definition at line 184 of file application.h.

◆ register_update()

void esphome::Application::register_update ( update::UpdateEntity * update)
inline

Definition at line 222 of file application.h.

◆ register_valve()

void esphome::Application::register_valve ( valve::Valve * valve)
inline

Definition at line 204 of file application.h.

◆ run_powerdown_hooks()

void esphome::Application::run_powerdown_hooks ( )

Definition at line 244 of file application.cpp.

◆ run_safe_shutdown_hooks()

void esphome::Application::run_safe_shutdown_hooks ( )

Definition at line 235 of file application.cpp.

◆ safe_reboot()

void esphome::Application::safe_reboot ( )

Definition at line 227 of file application.cpp.

◆ schedule_dump_config()

void esphome::Application::schedule_dump_config ( )
inline

Definition at line 293 of file application.h.

◆ set_current_component()

void esphome::Application::set_current_component ( Component * component)
inline

Definition at line 134 of file application.h.

◆ set_loop_interval()

void esphome::Application::set_loop_interval ( uint32_t loop_interval)
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

Note: This method is not called by ESPHome core code. It is only used by lambda functions in YAML configurations or by external components.

Parameters
loop_intervalThe interval in milliseconds to run the core loop at. Defaults to 16 milliseconds.

Definition at line 287 of file application.h.

◆ setup()

void esphome::Application::setup ( )

Set up all the registered components. Call this at the end of your setup() function.

Definition at line 76 of file application.cpp.

◆ setup_wake_loop_threadsafe_()

void esphome::Application::setup_wake_loop_threadsafe_ ( )
protected

Definition at line 646 of file application.cpp.

◆ teardown_components()

void esphome::Application::teardown_components ( uint32_t timeout_ms)

Teardown all components with a timeout.

Parameters
timeout_msMaximum time to wait for teardown in milliseconds

Definition at line 250 of file application.cpp.

◆ unregister_socket_fd()

void esphome::Application::unregister_socket_fd ( int fd)

Definition at line 546 of file application.cpp.

◆ wake_loop_threadsafe()

void esphome::Application::wake_loop_threadsafe ( )

Wake the main event loop from a FreeRTOS task Thread-safe, can be called from task context to immediately wake select() IMPORTANT: NOT safe to call from ISR context (socket operations not ISR-safe)

Definition at line 700 of file application.cpp.

◆ yield_with_select_()

void esphome::Application::yield_with_select_ ( uint32_t delay_ms)
protected

Perform a delay while also monitoring socket file descriptors for readiness.

Definition at line 585 of file application.cpp.

Field Documentation

◆ alarm_control_panels_

StaticVector<alarm_control_panel::AlarmControlPanel *, ESPHOME_ENTITY_ALARM_CONTROL_PANEL_COUNT> esphome::Application::alarm_control_panels_ {}
protected

Definition at line 612 of file application.h.

◆ app_state_

uint8_t esphome::Application::app_state_ {0}
protected

Definition at line 529 of file application.h.

◆ areas_

StaticVector<Area *, ESPHOME_AREA_COUNT> esphome::Application::areas_ {}
protected

Definition at line 551 of file application.h.

◆ base_read_fds_

fd_set esphome::Application::base_read_fds_ {}
protected

Definition at line 540 of file application.h.

◆ binary_sensors_

StaticVector<binary_sensor::BinarySensor *, ESPHOME_ENTITY_BINARY_SENSOR_COUNT> esphome::Application::binary_sensors_ {}
protected

Definition at line 554 of file application.h.

◆ buttons_

StaticVector<button::Button *, ESPHOME_ENTITY_BUTTON_COUNT> esphome::Application::buttons_ {}
protected

Definition at line 560 of file application.h.

◆ climates_

StaticVector<climate::Climate *, ESPHOME_ENTITY_CLIMATE_COUNT> esphome::Application::climates_ {}
protected

Definition at line 578 of file application.h.

◆ comment_

const char* esphome::Application::comment_ {nullptr}
protected

Definition at line 480 of file application.h.

◆ compilation_time_

const char* esphome::Application::compilation_time_ {nullptr}
protected

Definition at line 481 of file application.h.

◆ Component

friend esphome::Application::Component
protected

Definition at line 449 of file application.h.

◆ components_

StaticVector<Component *, ESPHOME_COMPONENT_COUNT> esphome::Application::components_ {}
protected

Definition at line 545 of file application.h.

◆ covers_

StaticVector<cover::Cover *, ESPHOME_ENTITY_COVER_COUNT> esphome::Application::covers_ {}
protected

Definition at line 575 of file application.h.

◆ current_component_

Component* esphome::Application::current_component_ {nullptr}
protected

Definition at line 479 of file application.h.

◆ current_loop_index_

uint16_t esphome::Application::current_loop_index_ {0}
protected

Definition at line 526 of file application.h.

◆ dates_

StaticVector<datetime::DateEntity *, ESPHOME_ENTITY_DATE_COUNT> esphome::Application::dates_ {}
protected

Definition at line 587 of file application.h.

◆ datetimes_

StaticVector<datetime::DateTimeEntity *, ESPHOME_ENTITY_DATETIME_COUNT> esphome::Application::datetimes_ {}
protected

Definition at line 593 of file application.h.

◆ devices_

StaticVector<Device *, ESPHOME_DEVICE_COUNT> esphome::Application::devices_ {}
protected

Definition at line 548 of file application.h.

◆ dump_config_at_

size_t esphome::Application::dump_config_at_ {SIZE_MAX}
protected

Definition at line 513 of file application.h.

◆ events_

StaticVector<event::Event *, ESPHOME_ENTITY_EVENT_COUNT> esphome::Application::events_ {}
protected

Definition at line 563 of file application.h.

◆ fans_

StaticVector<fan::Fan *, ESPHOME_ENTITY_FAN_COUNT> esphome::Application::fans_ {}
protected

Definition at line 572 of file application.h.

◆ friendly_name_

std::string esphome::Application::friendly_name_
protected

Definition at line 510 of file application.h.

◆ has_pending_enable_loop_requests_

volatile bool esphome::Application::has_pending_enable_loop_requests_ {false}
protected

Definition at line 532 of file application.h.

◆ in_loop_

bool esphome::Application::in_loop_ {false}
protected

Definition at line 531 of file application.h.

◆ last_loop_

uint32_t esphome::Application::last_loop_ {0}
protected

Definition at line 516 of file application.h.

◆ lights_

StaticVector<light::LightState *, ESPHOME_ENTITY_LIGHT_COUNT> esphome::Application::lights_ {}
protected

Definition at line 581 of file application.h.

◆ locks_

StaticVector<lock::Lock *, ESPHOME_ENTITY_LOCK_COUNT> esphome::Application::locks_ {}
protected

Definition at line 602 of file application.h.

◆ loop_component_start_time_

uint32_t esphome::Application::loop_component_start_time_ {0}
protected

Definition at line 517 of file application.h.

◆ loop_interval_

uint16_t esphome::Application::loop_interval_ {16}
protected

Definition at line 524 of file application.h.

◆ looping_components_

FixedVector<Component *> esphome::Application::looping_components_ {}
protected

Definition at line 500 of file application.h.

◆ looping_components_active_end_

uint16_t esphome::Application::looping_components_active_end_ {0}
protected

Definition at line 525 of file application.h.

◆ max_fd_

int esphome::Application::max_fd_ {-1}
protected

Definition at line 520 of file application.h.

◆ media_players_

StaticVector<media_player::MediaPlayer *, ESPHOME_ENTITY_MEDIA_PLAYER_COUNT> esphome::Application::media_players_ {}
protected

Definition at line 608 of file application.h.

◆ name_

std::string esphome::Application::name_
protected

Definition at line 509 of file application.h.

◆ name_add_mac_suffix_

bool esphome::Application::name_add_mac_suffix_
protected

Definition at line 530 of file application.h.

◆ numbers_

StaticVector<number::Number *, ESPHOME_ENTITY_NUMBER_COUNT> esphome::Application::numbers_ {}
protected

Definition at line 584 of file application.h.

◆ read_fds_

fd_set esphome::Application::read_fds_ {}
protected

Definition at line 541 of file application.h.

◆ selects_

StaticVector<select::Select *, ESPHOME_ENTITY_SELECT_COUNT> esphome::Application::selects_ {}
protected

Definition at line 596 of file application.h.

◆ sensors_

StaticVector<sensor::Sensor *, ESPHOME_ENTITY_SENSOR_COUNT> esphome::Application::sensors_ {}
protected

Definition at line 566 of file application.h.

◆ socket_fds_

std::vector<int> esphome::Application::socket_fds_
protected

Definition at line 502 of file application.h.

◆ socket_fds_changed_

bool esphome::Application::socket_fds_changed_ {false}
protected

Definition at line 535 of file application.h.

◆ switches_

StaticVector<switch_::Switch *, ESPHOME_ENTITY_SWITCH_COUNT> esphome::Application::switches_ {}
protected

Definition at line 557 of file application.h.

◆ text_sensors_

StaticVector<text_sensor::TextSensor *, ESPHOME_ENTITY_TEXT_SENSOR_COUNT> esphome::Application::text_sensors_ {}
protected

Definition at line 569 of file application.h.

◆ texts_

StaticVector<text::Text *, ESPHOME_ENTITY_TEXT_COUNT> esphome::Application::texts_ {}
protected

Definition at line 599 of file application.h.

◆ times_

StaticVector<datetime::TimeEntity *, ESPHOME_ENTITY_TIME_COUNT> esphome::Application::times_ {}
protected

Definition at line 590 of file application.h.

◆ updates_

StaticVector<update::UpdateEntity *, ESPHOME_ENTITY_UPDATE_COUNT> esphome::Application::updates_ {}
protected

Definition at line 615 of file application.h.

◆ valves_

StaticVector<valve::Valve *, ESPHOME_ENTITY_VALVE_COUNT> esphome::Application::valves_ {}
protected

Definition at line 605 of file application.h.

◆ wake_socket_fd_

int esphome::Application::wake_socket_fd_ {-1}
protected

Definition at line 504 of file application.h.


The documentation for this class was generated from the following files: