ESPHome 2026.1.0-dev
Loading...
Searching...
No Matches
application.h
Go to the documentation of this file.
1#pragma once
2
3#include <algorithm>
4#include <ctime>
5#include <limits>
6#include <span>
7#include <string>
8#include <vector>
12#include "esphome/core/hal.h"
19
20#ifdef USE_DEVICES
21#include "esphome/core/device.h"
22#endif
23#ifdef USE_AREAS
24#include "esphome/core/area.h"
25#endif
26
27#ifdef USE_SOCKET_SELECT_SUPPORT
28#include <sys/select.h>
29#ifdef USE_WAKE_LOOP_THREADSAFE
30#include <lwip/sockets.h>
31#endif
32#endif // USE_SOCKET_SELECT_SUPPORT
33
34#ifdef USE_BINARY_SENSOR
36#endif
37#ifdef USE_SENSOR
39#endif
40#ifdef USE_SWITCH
42#endif
43#ifdef USE_BUTTON
45#endif
46#ifdef USE_TEXT_SENSOR
48#endif
49#ifdef USE_FAN
51#endif
52#ifdef USE_CLIMATE
54#endif
55#ifdef USE_LIGHT
57#endif
58#ifdef USE_COVER
60#endif
61#ifdef USE_NUMBER
63#endif
64#ifdef USE_DATETIME_DATE
66#endif
67#ifdef USE_DATETIME_TIME
69#endif
70#ifdef USE_DATETIME_DATETIME
72#endif
73#ifdef USE_TEXT
75#endif
76#ifdef USE_SELECT
78#endif
79#ifdef USE_LOCK
81#endif
82#ifdef USE_VALVE
84#endif
85#ifdef USE_MEDIA_PLAYER
87#endif
88#ifdef USE_ALARM_CONTROL_PANEL
90#endif
91#ifdef USE_WATER_HEATER
93#endif
94#ifdef USE_EVENT
96#endif
97#ifdef USE_UPDATE
99#endif
100
101namespace esphome {
102
103// Teardown timeout constant (in milliseconds)
104// For reboots, it's more important to shut down quickly than disconnect cleanly
105// since we're not entering deep sleep. The only consequence of not shutting down
106// cleanly is a warning in the log.
107static const uint32_t TEARDOWN_TIMEOUT_REBOOT_MS = 1000; // 1 second for quick reboot
108
110 public:
111 void pre_setup(const std::string &name, const std::string &friendly_name, bool name_add_mac_suffix) {
112 arch_init();
113 this->name_add_mac_suffix_ = name_add_mac_suffix;
114 if (name_add_mac_suffix) {
115 // MAC address length: 12 hex chars + null terminator
116 constexpr size_t mac_address_len = 13;
117 // MAC address suffix length (last 6 characters of 12-char MAC address string)
118 constexpr size_t mac_address_suffix_len = 6;
119 char mac_addr[mac_address_len];
121 const char *mac_suffix_ptr = mac_addr + mac_address_suffix_len;
122 this->name_ = make_name_with_suffix(name, '-', mac_suffix_ptr, mac_address_suffix_len);
123 if (!friendly_name.empty()) {
124 this->friendly_name_ = make_name_with_suffix(friendly_name, ' ', mac_suffix_ptr, mac_address_suffix_len);
125 }
126 } else {
127 this->name_ = name;
128 this->friendly_name_ = friendly_name;
129 }
130 }
131
132#ifdef USE_DEVICES
133 void register_device(Device *device) { this->devices_.push_back(device); }
134#endif
135#ifdef USE_AREAS
136 void register_area(Area *area) { this->areas_.push_back(area); }
137#endif
138
141
142#ifdef USE_BINARY_SENSOR
144 this->binary_sensors_.push_back(binary_sensor);
145 }
146#endif
147
148#ifdef USE_SENSOR
149 void register_sensor(sensor::Sensor *sensor) { this->sensors_.push_back(sensor); }
150#endif
151
152#ifdef USE_SWITCH
153 void register_switch(switch_::Switch *a_switch) { this->switches_.push_back(a_switch); }
154#endif
155
156#ifdef USE_BUTTON
157 void register_button(button::Button *button) { this->buttons_.push_back(button); }
158#endif
159
160#ifdef USE_TEXT_SENSOR
161 void register_text_sensor(text_sensor::TextSensor *sensor) { this->text_sensors_.push_back(sensor); }
162#endif
163
164#ifdef USE_FAN
165 void register_fan(fan::Fan *state) { this->fans_.push_back(state); }
166#endif
167
168#ifdef USE_COVER
169 void register_cover(cover::Cover *cover) { this->covers_.push_back(cover); }
170#endif
171
172#ifdef USE_CLIMATE
173 void register_climate(climate::Climate *climate) { this->climates_.push_back(climate); }
174#endif
175
176#ifdef USE_LIGHT
177 void register_light(light::LightState *light) { this->lights_.push_back(light); }
178#endif
179
180#ifdef USE_NUMBER
181 void register_number(number::Number *number) { this->numbers_.push_back(number); }
182#endif
183
184#ifdef USE_DATETIME_DATE
185 void register_date(datetime::DateEntity *date) { this->dates_.push_back(date); }
186#endif
187
188#ifdef USE_DATETIME_TIME
189 void register_time(datetime::TimeEntity *time) { this->times_.push_back(time); }
190#endif
191
192#ifdef USE_DATETIME_DATETIME
193 void register_datetime(datetime::DateTimeEntity *datetime) { this->datetimes_.push_back(datetime); }
194#endif
195
196#ifdef USE_TEXT
197 void register_text(text::Text *text) { this->texts_.push_back(text); }
198#endif
199
200#ifdef USE_SELECT
201 void register_select(select::Select *select) { this->selects_.push_back(select); }
202#endif
203
204#ifdef USE_LOCK
205 void register_lock(lock::Lock *a_lock) { this->locks_.push_back(a_lock); }
206#endif
207
208#ifdef USE_VALVE
209 void register_valve(valve::Valve *valve) { this->valves_.push_back(valve); }
210#endif
211
212#ifdef USE_MEDIA_PLAYER
213 void register_media_player(media_player::MediaPlayer *media_player) { this->media_players_.push_back(media_player); }
214#endif
215
216#ifdef USE_ALARM_CONTROL_PANEL
218 this->alarm_control_panels_.push_back(a_alarm_control_panel);
219 }
220#endif
221
222#ifdef USE_WATER_HEATER
223 void register_water_heater(water_heater::WaterHeater *water_heater) { this->water_heaters_.push_back(water_heater); }
224#endif
225
226#ifdef USE_EVENT
227 void register_event(event::Event *event) { this->events_.push_back(event); }
228#endif
229
230#ifdef USE_UPDATE
231 void register_update(update::UpdateEntity *update) { this->updates_.push_back(update); }
232#endif
233
235
237 template<class C> C *register_component(C *c) {
238 static_assert(std::is_base_of<Component, C>::value, "Only Component subclasses can be registered");
239 this->register_component_((Component *) c);
240 return c;
241 }
242
244 void setup();
245
247 void loop();
248
250 const std::string &get_name() const { return this->name_; }
251
253 const std::string &get_friendly_name() const { return this->friendly_name_; }
254
256 const char *get_area() const {
257#ifdef USE_AREAS
258 // If we have areas registered, return the name of the first one (which is the top-level area)
259 if (!this->areas_.empty() && this->areas_[0] != nullptr) {
260 return this->areas_[0]->get_name();
261 }
262#endif
263 return "";
264 }
265
268 void get_comment_string(std::span<char, ESPHOME_COMMENT_SIZE> buffer) {
269 ESPHOME_strncpy_P(buffer.data(), ESPHOME_COMMENT_STR, buffer.size());
270 buffer[buffer.size() - 1] = '\0';
271 }
272
274 std::string get_comment() {
275 char buffer[ESPHOME_COMMENT_SIZE];
276 this->get_comment_string(buffer);
277 return std::string(buffer);
278 }
279
281
283 static constexpr size_t BUILD_TIME_STR_SIZE = 26;
284
286 constexpr uint32_t get_config_hash() { return ESPHOME_CONFIG_HASH; }
287
289 constexpr uint32_t get_config_version_hash() { return fnv1a_hash_extend(ESPHOME_CONFIG_HASH, ESPHOME_VERSION); }
290
292 constexpr time_t get_build_time() { return ESPHOME_BUILD_TIME; }
293
296 void get_build_time_string(std::span<char, BUILD_TIME_STR_SIZE> buffer);
297
299 // Remove before 2026.7.0
300 ESPDEPRECATED("Use get_build_time_string() instead. Removed in 2026.7.0", "2026.1.0")
301 std::string get_compilation_time() {
302 char buf[BUILD_TIME_STR_SIZE];
303 this->get_build_time_string(buf);
304 return std::string(buf);
305 }
306
308 inline uint32_t IRAM_ATTR HOT get_loop_component_start_time() const { return this->loop_component_start_time_; }
309
326 void set_loop_interval(uint32_t loop_interval) {
327 this->loop_interval_ = std::min(loop_interval, static_cast<uint32_t>(std::numeric_limits<uint16_t>::max()));
328 }
329
330 uint32_t get_loop_interval() const { return static_cast<uint32_t>(this->loop_interval_); }
331
333
334 void feed_wdt(uint32_t time = 0);
335
336 void reboot();
337
338 void safe_reboot();
339
341
342 void run_powerdown_hooks();
343
348 void teardown_components(uint32_t timeout_ms);
349
350 uint8_t get_app_state() const { return this->app_state_; }
351
352// Helper macro for entity getter method declarations
353#ifdef USE_DEVICES
354#define GET_ENTITY_METHOD(entity_type, entity_name, entities_member) \
355 entity_type *get_##entity_name##_by_key(uint32_t key, uint32_t device_id, bool include_internal = false) { \
356 for (auto *obj : this->entities_member##_) { \
357 if (obj->get_object_id_hash() == key && obj->get_device_id() == device_id && \
358 (include_internal || !obj->is_internal())) \
359 return obj; \
360 } \
361 return nullptr; \
362 }
363 const auto &get_devices() { return this->devices_; }
364#else
365#define GET_ENTITY_METHOD(entity_type, entity_name, entities_member) \
366 entity_type *get_##entity_name##_by_key(uint32_t key, bool include_internal = false) { \
367 for (auto *obj : this->entities_member##_) { \
368 if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal())) \
369 return obj; \
370 } \
371 return nullptr; \
372 }
373#endif // USE_DEVICES
374#ifdef USE_AREAS
375 const auto &get_areas() { return this->areas_; }
376#endif
377#ifdef USE_BINARY_SENSOR
378 auto &get_binary_sensors() const { return this->binary_sensors_; }
379 GET_ENTITY_METHOD(binary_sensor::BinarySensor, binary_sensor, binary_sensors)
380#endif
381#ifdef USE_SWITCH
382 auto &get_switches() const { return this->switches_; }
384#endif
385#ifdef USE_BUTTON
386 auto &get_buttons() const { return this->buttons_; }
388#endif
389#ifdef USE_SENSOR
390 auto &get_sensors() const { return this->sensors_; }
392#endif
393#ifdef USE_TEXT_SENSOR
394 auto &get_text_sensors() const { return this->text_sensors_; }
395 GET_ENTITY_METHOD(text_sensor::TextSensor, text_sensor, text_sensors)
396#endif
397#ifdef USE_FAN
398 auto &get_fans() const { return this->fans_; }
400#endif
401#ifdef USE_COVER
402 auto &get_covers() const { return this->covers_; }
404#endif
405#ifdef USE_LIGHT
406 auto &get_lights() const { return this->lights_; }
408#endif
409#ifdef USE_CLIMATE
410 auto &get_climates() const { return this->climates_; }
412#endif
413#ifdef USE_NUMBER
414 auto &get_numbers() const { return this->numbers_; }
416#endif
417#ifdef USE_DATETIME_DATE
418 auto &get_dates() const { return this->dates_; }
420#endif
421#ifdef USE_DATETIME_TIME
422 auto &get_times() const { return this->times_; }
424#endif
425#ifdef USE_DATETIME_DATETIME
426 auto &get_datetimes() const { return this->datetimes_; }
428#endif
429#ifdef USE_TEXT
430 auto &get_texts() const { return this->texts_; }
432#endif
433#ifdef USE_SELECT
434 auto &get_selects() const { return this->selects_; }
436#endif
437#ifdef USE_LOCK
438 auto &get_locks() const { return this->locks_; }
440#endif
441#ifdef USE_VALVE
442 auto &get_valves() const { return this->valves_; }
444#endif
445#ifdef USE_MEDIA_PLAYER
446 auto &get_media_players() const { return this->media_players_; }
447 GET_ENTITY_METHOD(media_player::MediaPlayer, media_player, media_players)
448#endif
449
450#ifdef USE_ALARM_CONTROL_PANEL
451 auto &get_alarm_control_panels() const { return this->alarm_control_panels_; }
452 GET_ENTITY_METHOD(alarm_control_panel::AlarmControlPanel, alarm_control_panel, alarm_control_panels)
453#endif
454
455#ifdef USE_WATER_HEATER
456 auto &get_water_heaters() const { return this->water_heaters_; }
457 GET_ENTITY_METHOD(water_heater::WaterHeater, water_heater, water_heaters)
458#endif
459
460#ifdef USE_EVENT
461 auto &get_events() const { return this->events_; }
463#endif
464
465#ifdef USE_UPDATE
466 auto &get_updates() const { return this->updates_; }
468#endif
469
470 Scheduler scheduler;
471
473#ifdef USE_SOCKET_SELECT_SUPPORT
478 bool register_socket_fd(int fd);
479 void unregister_socket_fd(int fd);
482 bool is_socket_ready(int fd) const;
483
484#ifdef USE_WAKE_LOOP_THREADSAFE
489#endif
490#endif
491
492 protected:
493 friend Component;
494
495 void register_component_(Component *comp);
496
498 void add_looping_components_by_state_(bool match_loop_done);
499
500 // These methods are called by Component::disable_loop() and Component::enable_loop()
501 // Components should not call these directly - use this->disable_loop() or this->enable_loop()
502 // to ensure component state is properly updated along with the loop partition
506 void activate_looping_component_(uint16_t index);
507 void before_loop_tasks_(uint32_t loop_start_time);
508 void after_loop_tasks_();
509
511
513 void yield_with_select_(uint32_t delay_ms);
514
515#if defined(USE_SOCKET_SELECT_SUPPORT) && defined(USE_WAKE_LOOP_THREADSAFE)
516 void setup_wake_loop_threadsafe_(); // Create wake notification socket
517 inline void drain_wake_notifications_(); // Read pending wake notifications in main loop (hot path - inlined)
518#endif
519
520 // === Member variables ordered by size to minimize padding ===
521
522 // Pointer-sized members first
524
525 // std::vector (3 pointers each: begin, end, capacity)
526 // Partitioned vector design for looping components
527 // =================================================
528 // Components are partitioned into [active | inactive] sections:
529 //
530 // looping_components_: [A, B, C, D | E, F]
531 // ^
532 // looping_components_active_end_ (4)
533 //
534 // - Components A,B,C,D are active and will be called in loop()
535 // - Components E,F are inactive (disabled/failed) and won't be called
536 // - No flag checking needed during iteration - just loop 0 to active_end_
537 // - When a component is disabled, it's swapped with the last active component
538 // and active_end_ is decremented
539 // - When a component is enabled, it's swapped with the first inactive component
540 // and active_end_ is incremented
541 // - This eliminates branch mispredictions from flag checking in the hot loop
543#ifdef USE_SOCKET_SELECT_SUPPORT
544 std::vector<int> socket_fds_; // Vector of all monitored socket file descriptors
545#ifdef USE_WAKE_LOOP_THREADSAFE
546 int wake_socket_fd_{-1}; // Shared wake notification socket for waking main loop from tasks
547#endif
548#endif
549
550 // std::string members (typically 24-32 bytes each)
551 std::string name_;
552 std::string friendly_name_;
553
554 // size_t members
555 size_t dump_config_at_{SIZE_MAX};
556
557 // 4-byte members
558 uint32_t last_loop_{0};
560
561#ifdef USE_SOCKET_SELECT_SUPPORT
562 int max_fd_{-1}; // Highest file descriptor number for select()
563#endif
564
565 // 2-byte members (grouped together for alignment)
566 uint16_t loop_interval_{16}; // Loop interval in ms (max 65535ms = 65.5 seconds)
567 uint16_t looping_components_active_end_{0}; // Index marking end of active components in looping_components_
568 uint16_t current_loop_index_{0}; // For safe reentrant modifications during iteration
569
570 // 1-byte members (grouped together to minimize padding)
571 uint8_t app_state_{0};
573 bool in_loop_{false};
575
576#ifdef USE_SOCKET_SELECT_SUPPORT
577 bool socket_fds_changed_{false}; // Flag to rebuild base_read_fds_ when socket_fds_ changes
578#endif
579
580#ifdef USE_SOCKET_SELECT_SUPPORT
581 // Variable-sized members
582 fd_set base_read_fds_{}; // Cached fd_set rebuilt only when socket_fds_ changes
583 fd_set read_fds_{}; // Working fd_set for select(), copied from base_read_fds_
584#endif
585
586 // StaticVectors (largest members - contain actual array data inline)
588
589#ifdef USE_DEVICES
591#endif
592#ifdef USE_AREAS
594#endif
595#ifdef USE_BINARY_SENSOR
597#endif
598#ifdef USE_SWITCH
600#endif
601#ifdef USE_BUTTON
603#endif
604#ifdef USE_EVENT
606#endif
607#ifdef USE_SENSOR
609#endif
610#ifdef USE_TEXT_SENSOR
612#endif
613#ifdef USE_FAN
615#endif
616#ifdef USE_COVER
618#endif
619#ifdef USE_CLIMATE
621#endif
622#ifdef USE_LIGHT
624#endif
625#ifdef USE_NUMBER
627#endif
628#ifdef USE_DATETIME_DATE
630#endif
631#ifdef USE_DATETIME_TIME
633#endif
634#ifdef USE_DATETIME_DATETIME
636#endif
637#ifdef USE_SELECT
639#endif
640#ifdef USE_TEXT
642#endif
643#ifdef USE_LOCK
645#endif
646#ifdef USE_VALVE
648#endif
649#ifdef USE_MEDIA_PLAYER
651#endif
652#ifdef USE_ALARM_CONTROL_PANEL
655#endif
656#ifdef USE_WATER_HEATER
658#endif
659#ifdef USE_UPDATE
661#endif
662};
663
665extern Application App; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
666
667#if defined(USE_SOCKET_SELECT_SUPPORT) && defined(USE_WAKE_LOOP_THREADSAFE)
668// Inline implementations for hot-path functions
669// drain_wake_notifications_() is called on every loop iteration
670
671// Small buffer for draining wake notification bytes (1 byte sent per wake)
672// Size allows draining multiple notifications per recvfrom() without wasting stack
673static constexpr size_t WAKE_NOTIFY_DRAIN_BUFFER_SIZE = 16;
674
676 // Called from main loop to drain any pending wake notifications
677 // Must check is_socket_ready() to avoid blocking on empty socket
678 if (this->wake_socket_fd_ >= 0 && this->is_socket_ready(this->wake_socket_fd_)) {
679 char buffer[WAKE_NOTIFY_DRAIN_BUFFER_SIZE];
680 // Drain all pending notifications with non-blocking reads
681 // Multiple wake events may have triggered multiple writes, so drain until EWOULDBLOCK
682 // We control both ends of this loopback socket (always write 1 byte per wake),
683 // so no error checking needed - any errors indicate catastrophic system failure
684 while (lwip_recvfrom(this->wake_socket_fd_, buffer, sizeof(buffer), 0, nullptr, nullptr) > 0) {
685 // Just draining, no action needed - wake has already occurred
686 }
687 }
688}
689#endif // defined(USE_SOCKET_SELECT_SUPPORT) && defined(USE_WAKE_LOOP_THREADSAFE)
690
691} // namespace esphome
StaticVector< switch_::Switch *, ESPHOME_ENTITY_SWITCH_COUNT > switches_
StaticVector< light::LightState *, ESPHOME_ENTITY_LIGHT_COUNT > lights_
void setup()
Set up all the registered components. Call this at the end of your setup() function.
uint32_t get_loop_interval() const
StaticVector< valve::Valve *, ESPHOME_ENTITY_VALVE_COUNT > valves_
void register_fan(fan::Fan *state)
void wake_loop_threadsafe()
Wake the main event loop from a FreeRTOS task Thread-safe, can be called from task context to immedia...
void register_button(button::Button *button)
GET_ENTITY_METHOD(select::Select, select, selects) auto &get_locks() const
const std::string & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
StaticVector< datetime::TimeEntity *, ESPHOME_ENTITY_TIME_COUNT > times_
GET_ENTITY_METHOD(fan::Fan, fan, fans) auto &get_covers() const
void register_light(light::LightState *light)
const auto & get_areas()
void register_binary_sensor(binary_sensor::BinarySensor *binary_sensor)
uint16_t looping_components_active_end_
void set_current_component(Component *component)
Component * get_current_component()
StaticVector< binary_sensor::BinarySensor *, ESPHOME_ENTITY_BINARY_SENSOR_COUNT > binary_sensors_
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...
void register_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel)
GET_ENTITY_METHOD(datetime::TimeEntity, time, times) auto &get_datetimes() const
StaticVector< select::Select *, ESPHOME_ENTITY_SELECT_COUNT > selects_
GET_ENTITY_METHOD(climate::Climate, climate, climates) auto &get_numbers() const
static constexpr size_t BUILD_TIME_STR_SIZE
Size of buffer required for build time string (including null terminator)
void register_update(update::UpdateEntity *update)
StaticVector< Area *, ESPHOME_AREA_COUNT > areas_
void register_media_player(media_player::MediaPlayer *media_player)
std::string get_comment()
Get the comment of this Application as a string.
GET_ENTITY_METHOD(valve::Valve, valve, valves) auto &get_media_players() const
StaticVector< fan::Fan *, ESPHOME_ENTITY_FAN_COUNT > fans_
std::vector< int > socket_fds_
void register_number(number::Number *number)
GET_ENTITY_METHOD(water_heater::WaterHeater, water_heater, water_heaters) auto &get_events() const
GET_ENTITY_METHOD(update::UpdateEntity, update, updates) Scheduler scheduler
void set_loop_interval(uint32_t loop_interval)
Set the target interval with which to run the loop() calls.
StaticVector< Component *, ESPHOME_COMPONENT_COUNT > components_
GET_ENTITY_METHOD(alarm_control_panel::AlarmControlPanel, alarm_control_panel, alarm_control_panels) auto &get_water_heaters() const
void register_climate(climate::Climate *climate)
void pre_setup(const std::string &name, const std::string &friendly_name, bool name_add_mac_suffix)
StaticVector< datetime::DateEntity *, ESPHOME_ENTITY_DATE_COUNT > dates_
void register_cover(cover::Cover *cover)
void get_build_time_string(std::span< char, BUILD_TIME_STR_SIZE > buffer)
Copy the build time string into the provided buffer Buffer must be BUILD_TIME_STR_SIZE bytes (compile...
StaticVector< media_player::MediaPlayer *, ESPHOME_ENTITY_MEDIA_PLAYER_COUNT > media_players_
GET_ENTITY_METHOD(text::Text, text, texts) auto &get_selects() const
StaticVector< update::UpdateEntity *, ESPHOME_ENTITY_UPDATE_COUNT > updates_
void register_water_heater(water_heater::WaterHeater *water_heater)
void register_area(Area *area)
Component * current_component_
GET_ENTITY_METHOD(datetime::DateEntity, date, dates) auto &get_times() const
void register_datetime(datetime::DateTimeEntity *datetime)
GET_ENTITY_METHOD(light::LightState, light, lights) auto &get_climates() const
void drain_wake_notifications_()
void register_time(datetime::TimeEntity *time)
void enable_component_loop_(Component *component)
uint32_t loop_component_start_time_
GET_ENTITY_METHOD(media_player::MediaPlayer, media_player, media_players) auto &get_alarm_control_panels() const
StaticVector< climate::Climate *, ESPHOME_ENTITY_CLIMATE_COUNT > climates_
constexpr uint32_t get_config_hash()
Get the config hash as a 32-bit integer.
GET_ENTITY_METHOD(text_sensor::TextSensor, text_sensor, text_sensors) auto &get_fans() const
void disable_component_loop_(Component *component)
const char * get_area() const
Get the area of this Application set by pre_setup().
bool is_name_add_mac_suffix_enabled() const
void activate_looping_component_(uint16_t index)
const auto & get_devices()
StaticVector< cover::Cover *, ESPHOME_ENTITY_COVER_COUNT > covers_
StaticVector< lock::Lock *, ESPHOME_ENTITY_LOCK_COUNT > locks_
std::string friendly_name_
void register_switch(switch_::Switch *a_switch)
ESPDEPRECATED("Use get_build_time_string() instead. Removed in 2026.7.0", "2026.1.0") std
Get the build time as a string (deprecated, use get_build_time_string() instead)
const std::string & get_name() const
Get the name of this Application set by pre_setup().
void register_lock(lock::Lock *a_lock)
StaticVector< event::Event *, ESPHOME_ENTITY_EVENT_COUNT > events_
void teardown_components(uint32_t timeout_ms)
Teardown all components with a timeout.
void register_event(event::Event *event)
void register_valve(valve::Valve *valve)
FixedVector< Component * > looping_components_
void add_looping_components_by_state_(bool match_loop_done)
void register_sensor(sensor::Sensor *sensor)
StaticVector< alarm_control_panel::AlarmControlPanel *, ESPHOME_ENTITY_ALARM_CONTROL_PANEL_COUNT > alarm_control_panels_
void get_comment_string(std::span< char, ESPHOME_COMMENT_SIZE > buffer)
Copy the comment string into the provided buffer Buffer must be ESPHOME_COMMENT_SIZE bytes (compile-t...
volatile bool has_pending_enable_loop_requests_
GET_ENTITY_METHOD(datetime::DateTimeEntity, datetime, datetimes) auto &get_texts() const
GET_ENTITY_METHOD(sensor::Sensor, sensor, sensors) auto &get_text_sensors() const
StaticVector< text_sensor::TextSensor *, ESPHOME_ENTITY_TEXT_SENSOR_COUNT > text_sensors_
StaticVector< datetime::DateTimeEntity *, ESPHOME_ENTITY_DATETIME_COUNT > datetimes_
GET_ENTITY_METHOD(switch_::Switch, switch, switches) auto &get_buttons() const
GET_ENTITY_METHOD(binary_sensor::BinarySensor, binary_sensor, binary_sensors) auto &get_switches() const
void register_text_sensor(text_sensor::TextSensor *sensor)
constexpr uint32_t get_config_version_hash()
Get the config hash extended with ESPHome version.
uint16_t current_loop_index_
StaticVector< button::Button *, ESPHOME_ENTITY_BUTTON_COUNT > buttons_
StaticVector< text::Text *, ESPHOME_ENTITY_TEXT_COUNT > texts_
void register_select(select::Select *select)
void feed_wdt(uint32_t time=0)
C * register_component(C *c)
Reserve space for components to avoid memory fragmentation.
void before_loop_tasks_(uint32_t loop_start_time)
void loop()
Make a loop iteration. Call this in your loop() function.
void register_text(text::Text *text)
void register_device(Device *device)
void unregister_socket_fd(int fd)
GET_ENTITY_METHOD(event::Event, event, events) auto &get_updates() const
StaticVector< water_heater::WaterHeater *, ESPHOME_ENTITY_WATER_HEATER_COUNT > water_heaters_
GET_ENTITY_METHOD(cover::Cover, cover, covers) auto &get_lights() const
bool register_socket_fd(int fd)
Register/unregister a socket file descriptor to be monitored for read events.
StaticVector< Device *, ESPHOME_DEVICE_COUNT > devices_
StaticVector< number::Number *, ESPHOME_ENTITY_NUMBER_COUNT > numbers_
void calculate_looping_components_()
auto & get_binary_sensors() const
constexpr time_t get_build_time()
Get the build time as a Unix timestamp.
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 yield_with_select_(uint32_t delay_ms)
Perform a delay while also monitoring socket file descriptors for readiness.
uint8_t get_app_state() const
GET_ENTITY_METHOD(number::Number, number, numbers) auto &get_dates() const
GET_ENTITY_METHOD(lock::Lock, lock, locks) auto &get_valves() const
StaticVector< sensor::Sensor *, ESPHOME_ENTITY_SENSOR_COUNT > sensors_
GET_ENTITY_METHOD(button::Button, button, buttons) auto &get_sensors() const
void register_component_(Component *comp)
void register_date(datetime::DateEntity *date)
Fixed-capacity vector - allocates once at runtime, never reallocates This avoids std::vector template...
Definition helpers.h:184
Minimal static vector - saves memory by avoiding std::vector overhead.
Definition helpers.h:132
Base class for all binary_sensor-type classes.
Base class for all buttons.
Definition button.h:25
ClimateDevice - This is the base class for all climate integrations.
Definition climate.h:181
Base class for all cover devices.
Definition cover.h:112
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition light_state.h:91
Base class for all locks.
Definition lock.h:111
Base-class for all numbers.
Definition number.h:29
Base-class for all selects.
Definition select.h:30
Base-class for all sensors.
Definition sensor.h:43
Base class for all switches.
Definition switch.h:39
Base-class for all text inputs.
Definition text.h:24
Base class for all valve devices.
Definition valve.h:106
const Component * component
Definition component.cpp:37
bool state
Definition fan.h:0
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
constexpr uint32_t fnv1a_hash_extend(uint32_t hash, const char *str)
Extend a FNV-1a hash with additional string data.
Definition helpers.h:391
void arch_init()
Definition core.cpp:37
void get_mac_address_into_buffer(std::span< char, MAC_ADDRESS_BUFFER_SIZE > buf)
Get the device MAC address into the given buffer, in lowercase hex notation.
Definition helpers.cpp:704
Application App
Global storage of Application pointer - only one Application can exist.
std::string make_name_with_suffix(const char *name, size_t name_len, char sep, const char *suffix_ptr, size_t suffix_len)
Optimized string concatenation: name + separator + suffix (const char* overload) Uses a fixed stack b...
Definition helpers.cpp:259