ESPHome 2025.7.1
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)
 
void reserve_components (size_t count)
 Reserve space for components to avoid memory fragmentation.
 
void reserve_binary_sensor (size_t count)
 
void reserve_switch (size_t count)
 
void reserve_button (size_t count)
 
void reserve_sensor (size_t count)
 
void reserve_text_sensor (size_t count)
 
void reserve_fan (size_t count)
 
void reserve_cover (size_t count)
 
void reserve_climate (size_t count)
 
void reserve_light (size_t count)
 
void reserve_number (size_t count)
 
void reserve_date (size_t count)
 
void reserve_time (size_t count)
 
void reserve_datetime (size_t count)
 
void reserve_select (size_t count)
 
void reserve_text (size_t count)
 
void reserve_lock (size_t count)
 
void reserve_valve (size_t count)
 
void reserve_media_player (size_t count)
 
void reserve_alarm_control_panel (size_t count)
 
void reserve_event (size_t count)
 
void reserve_update (size_t count)
 
void reserve_area (size_t count)
 
void reserve_device (size_t count)
 
template<class C >
C * register_component (C *c)
 Register the component in this Application instance.
 
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().
 
bool is_name_add_mac_suffix_enabled () const
 
std::string get_compilation_time () const
 
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 std::vector< Device * > & get_devices ()
 
const std::vector< Area * > & get_areas ()
 
const std::vector< binary_sensor::BinarySensor * > & get_binary_sensors ()
 
 GET_ENTITY_METHOD (binary_sensor::BinarySensor, binary_sensor, binary_sensors) const std
 
 GET_ENTITY_METHOD (switch_::Switch, switch, switches) const std
 
 GET_ENTITY_METHOD (button::Button, button, buttons) const std
 
 GET_ENTITY_METHOD (sensor::Sensor, sensor, sensors) const std
 
 GET_ENTITY_METHOD (text_sensor::TextSensor, text_sensor, text_sensors) const std
 
 GET_ENTITY_METHOD (fan::Fan, fan, fans) const std
 
 GET_ENTITY_METHOD (cover::Cover, cover, covers) const std
 
 GET_ENTITY_METHOD (light::LightState, light, lights) const std
 
 GET_ENTITY_METHOD (climate::Climate, climate, climates) const std
 
 GET_ENTITY_METHOD (number::Number, number, numbers) const std
 
 GET_ENTITY_METHOD (datetime::DateEntity, date, dates) const std
 
 GET_ENTITY_METHOD (datetime::TimeEntity, time, times) const std
 
 GET_ENTITY_METHOD (datetime::DateTimeEntity, datetime, datetimes) const std
 
 GET_ENTITY_METHOD (text::Text, text, texts) const std
 
 GET_ENTITY_METHOD (select::Select, select, selects) const std
 
 GET_ENTITY_METHOD (lock::Lock, lock, locks) const std
 
 GET_ENTITY_METHOD (valve::Valve, valve, valves) const std
 
 GET_ENTITY_METHOD (media_player::MediaPlayer, media_player, media_players) const std
 
 GET_ENTITY_METHOD (alarm_control_panel::AlarmControlPanel, alarm_control_panel, alarm_control_panels) const std
 
 GET_ENTITY_METHOD (event::Event, event, events) const std
 
 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.
 

Protected Member Functions

void register_component_ (Component *comp)
 
void calculate_looping_components_ ()
 
void disable_component_loop_ (Component *component)
 
void enable_component_loop_ (Component *component)
 
void enable_pending_loops_ ()
 
void activate_looping_component_ (uint16_t index)
 
void feed_wdt_arch_ ()
 
void yield_with_select_ (uint32_t delay_ms)
 Perform a delay while also monitoring socket file descriptors for readiness.
 

Protected Attributes

friend Component
 
Componentcurrent_component_ {nullptr}
 
const char * comment_ {nullptr}
 
const char * compilation_time_ {nullptr}
 
size_t dump_config_at_ {SIZE_MAX}
 
std::vector< Component * > components_ {}
 
std::vector< Component * > looping_components_ {}
 
std::vector< Device * > devices_ {}
 
std::vector< Area * > areas_ {}
 
std::vector< binary_sensor::BinarySensor * > binary_sensors_ {}
 
std::vector< switch_::Switch * > switches_ {}
 
std::vector< button::Button * > buttons_ {}
 
std::vector< event::Event * > events_ {}
 
std::vector< sensor::Sensor * > sensors_ {}
 
std::vector< text_sensor::TextSensor * > text_sensors_ {}
 
std::vector< fan::Fan * > fans_ {}
 
std::vector< cover::Cover * > covers_ {}
 
std::vector< climate::Climate * > climates_ {}
 
std::vector< light::LightState * > lights_ {}
 
std::vector< number::Number * > numbers_ {}
 
std::vector< datetime::DateEntity * > dates_ {}
 
std::vector< datetime::TimeEntity * > times_ {}
 
std::vector< datetime::DateTimeEntity * > datetimes_ {}
 
std::vector< select::Select * > selects_ {}
 
std::vector< text::Text * > texts_ {}
 
std::vector< lock::Lock * > locks_ {}
 
std::vector< valve::Valve * > valves_ {}
 
std::vector< media_player::MediaPlayer * > media_players_ {}
 
std::vector< alarm_control_panel::AlarmControlPanel * > alarm_control_panels_ {}
 
std::vector< update::UpdateEntity * > updates_ {}
 
std::vector< int > socket_fds_
 
std::string name_
 
std::string friendly_name_
 
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_ {}
 

Detailed Description

Definition at line 97 of file application.h.

Member Function Documentation

◆ activate_looping_component_()

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

Definition at line 325 of file application.cpp.

◆ calculate_looping_components_()

void esphome::Application::calculate_looping_components_ ( )
protected

Definition at line 264 of file application.cpp.

◆ disable_component_loop_()

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

Definition at line 296 of file application.cpp.

◆ enable_component_loop_()

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

Definition at line 333 of file application.cpp.

◆ enable_pending_loops_()

void esphome::Application::enable_pending_loops_ ( )
protected

Definition at line 350 of file application.cpp.

◆ feed_wdt()

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

Definition at line 175 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 369 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 309 of file application.h.

◆ get_areas()

const std::vector< Area * > & esphome::Application::get_areas ( )
inline

Definition at line 386 of file application.h.

◆ get_binary_sensors()

const std::vector< binary_sensor::BinarySensor * > & esphome::Application::get_binary_sensors ( )
inline

Definition at line 389 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 320 of file application.h.

◆ get_compilation_time()

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

Definition at line 324 of file application.h.

◆ get_current_component()

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

Definition at line 126 of file application.h.

◆ get_devices()

const std::vector< Device * > & esphome::Application::get_devices ( )
inline

Definition at line 383 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 465 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 390 of file application.h.

◆ GET_ENTITY_METHOD() [3/21]

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

Definition at line 398 of file application.h.

◆ GET_ENTITY_METHOD() [4/21]

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

Definition at line 422 of file application.h.

◆ GET_ENTITY_METHOD() [5/21]

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

Definition at line 414 of file application.h.

◆ GET_ENTITY_METHOD() [6/21]

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

Definition at line 430 of file application.h.

◆ GET_ENTITY_METHOD() [7/21]

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

Definition at line 438 of file application.h.

◆ GET_ENTITY_METHOD() [8/21]

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

Definition at line 434 of file application.h.

◆ GET_ENTITY_METHOD() [9/21]

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

Definition at line 470 of file application.h.

◆ GET_ENTITY_METHOD() [10/21]

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

Definition at line 410 of file application.h.

◆ GET_ENTITY_METHOD() [11/21]

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

Definition at line 418 of file application.h.

◆ GET_ENTITY_METHOD() [12/21]

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

Definition at line 450 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 458 of file application.h.

◆ GET_ENTITY_METHOD() [14/21]

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

Definition at line 426 of file application.h.

◆ GET_ENTITY_METHOD() [15/21]

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

Definition at line 446 of file application.h.

◆ GET_ENTITY_METHOD() [16/21]

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

Definition at line 402 of file application.h.

◆ GET_ENTITY_METHOD() [17/21]

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

Definition at line 394 of file application.h.

◆ GET_ENTITY_METHOD() [18/21]

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

Definition at line 442 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 406 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 454 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 306 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 327 of file application.h.

◆ get_loop_interval()

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

Definition at line 349 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 303 of file application.h.

◆ is_name_add_mac_suffix_enabled()

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

Definition at line 322 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 453 of file application.cpp.

◆ loop()

void esphome::Application::loop ( )

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

Definition at line 94 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 99 of file application.h.

◆ reboot()

void esphome::Application::reboot ( )

Definition at line 190 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 203 of file application.h.

◆ register_area()

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

Definition at line 122 of file application.h.

◆ register_binary_sensor()

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

Definition at line 129 of file application.h.

◆ register_button()

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

Definition at line 143 of file application.h.

◆ register_climate()

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

Definition at line 159 of file application.h.

◆ register_component()

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

Register the component in this Application instance.

Definition at line 290 of file application.h.

◆ register_component_()

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

Definition at line 34 of file application.cpp.

◆ register_cover()

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

Definition at line 155 of file application.h.

◆ register_date()

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

Definition at line 171 of file application.h.

◆ register_datetime()

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

Definition at line 179 of file application.h.

◆ register_device()

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

Definition at line 119 of file application.h.

◆ register_event()

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

Definition at line 209 of file application.h.

◆ register_fan()

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

Definition at line 151 of file application.h.

◆ register_light()

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

Definition at line 163 of file application.h.

◆ register_lock()

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

Definition at line 191 of file application.h.

◆ register_media_player()

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

Definition at line 199 of file application.h.

◆ register_number()

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

Definition at line 167 of file application.h.

◆ register_select()

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

Definition at line 187 of file application.h.

◆ register_sensor()

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

Definition at line 135 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 404 of file application.cpp.

◆ register_switch()

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

Definition at line 139 of file application.h.

◆ register_text()

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

Definition at line 183 of file application.h.

◆ register_text_sensor()

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

Definition at line 147 of file application.h.

◆ register_time()

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

Definition at line 175 of file application.h.

◆ register_update()

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

Definition at line 213 of file application.h.

◆ register_valve()

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

Definition at line 195 of file application.h.

◆ reserve_alarm_control_panel()

void esphome::Application::reserve_alarm_control_panel ( size_t count)
inline

Definition at line 274 of file application.h.

◆ reserve_area()

void esphome::Application::reserve_area ( size_t count)
inline

Definition at line 283 of file application.h.

◆ reserve_binary_sensor()

void esphome::Application::reserve_binary_sensor ( size_t count)
inline

Definition at line 220 of file application.h.

◆ reserve_button()

void esphome::Application::reserve_button ( size_t count)
inline

Definition at line 226 of file application.h.

◆ reserve_climate()

void esphome::Application::reserve_climate ( size_t count)
inline

Definition at line 241 of file application.h.

◆ reserve_components()

void esphome::Application::reserve_components ( size_t count)
inline

Reserve space for components to avoid memory fragmentation.

Definition at line 217 of file application.h.

◆ reserve_cover()

void esphome::Application::reserve_cover ( size_t count)
inline

Definition at line 238 of file application.h.

◆ reserve_date()

void esphome::Application::reserve_date ( size_t count)
inline

Definition at line 250 of file application.h.

◆ reserve_datetime()

void esphome::Application::reserve_datetime ( size_t count)
inline

Definition at line 256 of file application.h.

◆ reserve_device()

void esphome::Application::reserve_device ( size_t count)
inline

Definition at line 286 of file application.h.

◆ reserve_event()

void esphome::Application::reserve_event ( size_t count)
inline

Definition at line 277 of file application.h.

◆ reserve_fan()

void esphome::Application::reserve_fan ( size_t count)
inline

Definition at line 235 of file application.h.

◆ reserve_light()

void esphome::Application::reserve_light ( size_t count)
inline

Definition at line 244 of file application.h.

◆ reserve_lock()

void esphome::Application::reserve_lock ( size_t count)
inline

Definition at line 265 of file application.h.

◆ reserve_media_player()

void esphome::Application::reserve_media_player ( size_t count)
inline

Definition at line 271 of file application.h.

◆ reserve_number()

void esphome::Application::reserve_number ( size_t count)
inline

Definition at line 247 of file application.h.

◆ reserve_select()

void esphome::Application::reserve_select ( size_t count)
inline

Definition at line 259 of file application.h.

◆ reserve_sensor()

void esphome::Application::reserve_sensor ( size_t count)
inline

Definition at line 229 of file application.h.

◆ reserve_switch()

void esphome::Application::reserve_switch ( size_t count)
inline

Definition at line 223 of file application.h.

◆ reserve_text()

void esphome::Application::reserve_text ( size_t count)
inline

Definition at line 262 of file application.h.

◆ reserve_text_sensor()

void esphome::Application::reserve_text_sensor ( size_t count)
inline

Definition at line 232 of file application.h.

◆ reserve_time()

void esphome::Application::reserve_time ( size_t count)
inline

Definition at line 253 of file application.h.

◆ reserve_update()

void esphome::Application::reserve_update ( size_t count)
inline

Definition at line 280 of file application.h.

◆ reserve_valve()

void esphome::Application::reserve_valve ( size_t count)
inline

Definition at line 268 of file application.h.

◆ run_powerdown_hooks()

void esphome::Application::run_powerdown_hooks ( )

Definition at line 214 of file application.cpp.

◆ run_safe_shutdown_hooks()

void esphome::Application::run_safe_shutdown_hooks ( )

Definition at line 205 of file application.cpp.

◆ safe_reboot()

void esphome::Application::safe_reboot ( )

Definition at line 197 of file application.cpp.

◆ schedule_dump_config()

void esphome::Application::schedule_dump_config ( )
inline

Definition at line 351 of file application.h.

◆ set_current_component()

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

Definition at line 125 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 345 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 48 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 220 of file application.cpp.

◆ unregister_socket_fd()

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

Definition at line 426 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 464 of file application.cpp.

Field Documentation

◆ alarm_control_panels_

std::vector<alarm_control_panel::AlarmControlPanel *> esphome::Application::alarm_control_panels_ {}
protected

Definition at line 608 of file application.h.

◆ app_state_

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

Definition at line 636 of file application.h.

◆ areas_

std::vector<Area *> esphome::Application::areas_ {}
protected

Definition at line 548 of file application.h.

◆ base_read_fds_

fd_set esphome::Application::base_read_fds_ {}
protected

Definition at line 645 of file application.h.

◆ binary_sensors_

std::vector<binary_sensor::BinarySensor *> esphome::Application::binary_sensors_ {}
protected

Definition at line 551 of file application.h.

◆ buttons_

std::vector<button::Button *> esphome::Application::buttons_ {}
protected

Definition at line 557 of file application.h.

◆ climates_

std::vector<climate::Climate *> esphome::Application::climates_ {}
protected

Definition at line 575 of file application.h.

◆ comment_

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

Definition at line 517 of file application.h.

◆ compilation_time_

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

Definition at line 518 of file application.h.

◆ Component

friend esphome::Application::Component
protected

Definition at line 494 of file application.h.

◆ components_

std::vector<Component *> esphome::Application::components_ {}
protected

Definition at line 524 of file application.h.

◆ covers_

std::vector<cover::Cover *> esphome::Application::covers_ {}
protected

Definition at line 572 of file application.h.

◆ current_component_

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

Definition at line 516 of file application.h.

◆ current_loop_index_

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

Definition at line 633 of file application.h.

◆ dates_

std::vector<datetime::DateEntity *> esphome::Application::dates_ {}
protected

Definition at line 584 of file application.h.

◆ datetimes_

std::vector<datetime::DateTimeEntity *> esphome::Application::datetimes_ {}
protected

Definition at line 590 of file application.h.

◆ devices_

std::vector<Device *> esphome::Application::devices_ {}
protected

Definition at line 545 of file application.h.

◆ dump_config_at_

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

Definition at line 521 of file application.h.

◆ events_

std::vector<event::Event *> esphome::Application::events_ {}
protected

Definition at line 560 of file application.h.

◆ fans_

std::vector<fan::Fan *> esphome::Application::fans_ {}
protected

Definition at line 569 of file application.h.

◆ friendly_name_

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

Definition at line 620 of file application.h.

◆ has_pending_enable_loop_requests_

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

Definition at line 639 of file application.h.

◆ in_loop_

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

Definition at line 638 of file application.h.

◆ last_loop_

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

Definition at line 623 of file application.h.

◆ lights_

std::vector<light::LightState *> esphome::Application::lights_ {}
protected

Definition at line 578 of file application.h.

◆ locks_

std::vector<lock::Lock *> esphome::Application::locks_ {}
protected

Definition at line 599 of file application.h.

◆ loop_component_start_time_

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

Definition at line 624 of file application.h.

◆ loop_interval_

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

Definition at line 631 of file application.h.

◆ looping_components_

std::vector<Component *> esphome::Application::looping_components_ {}
protected

Definition at line 542 of file application.h.

◆ looping_components_active_end_

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

Definition at line 632 of file application.h.

◆ max_fd_

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

Definition at line 627 of file application.h.

◆ media_players_

std::vector<media_player::MediaPlayer *> esphome::Application::media_players_ {}
protected

Definition at line 605 of file application.h.

◆ name_

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

Definition at line 619 of file application.h.

◆ name_add_mac_suffix_

bool esphome::Application::name_add_mac_suffix_
protected

Definition at line 637 of file application.h.

◆ numbers_

std::vector<number::Number *> esphome::Application::numbers_ {}
protected

Definition at line 581 of file application.h.

◆ read_fds_

fd_set esphome::Application::read_fds_ {}
protected

Definition at line 646 of file application.h.

◆ selects_

std::vector<select::Select *> esphome::Application::selects_ {}
protected

Definition at line 593 of file application.h.

◆ sensors_

std::vector<sensor::Sensor *> esphome::Application::sensors_ {}
protected

Definition at line 563 of file application.h.

◆ socket_fds_

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

Definition at line 615 of file application.h.

◆ socket_fds_changed_

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

Definition at line 642 of file application.h.

◆ switches_

std::vector<switch_::Switch *> esphome::Application::switches_ {}
protected

Definition at line 554 of file application.h.

◆ text_sensors_

std::vector<text_sensor::TextSensor *> esphome::Application::text_sensors_ {}
protected

Definition at line 566 of file application.h.

◆ texts_

std::vector<text::Text *> esphome::Application::texts_ {}
protected

Definition at line 596 of file application.h.

◆ times_

std::vector<datetime::TimeEntity *> esphome::Application::times_ {}
protected

Definition at line 587 of file application.h.

◆ updates_

std::vector<update::UpdateEntity *> esphome::Application::updates_ {}
protected

Definition at line 611 of file application.h.

◆ valves_

std::vector<valve::Valve *> esphome::Application::valves_ {}
protected

Definition at line 602 of file application.h.


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