|
| void | trigger (const std::string &event_type) |
| |
| void | set_event_types (std::initializer_list< const char * > event_types) |
| | Set the event types supported by this event (from initializer list).
|
| |
| void | set_event_types (const FixedVector< const char * > &event_types) |
| | Set the event types supported by this event (from FixedVector).
|
| |
| void | set_event_types (const std::vector< const char * > &event_types) |
| | Set the event types supported by this event (from vector).
|
| |
| void | set_event_types (std::initializer_list< std::string > event_types)=delete |
| |
| void | set_event_types (const FixedVector< std::string > &event_types)=delete |
| |
| void | set_event_types (const std::vector< std::string > &event_types)=delete |
| |
| const FixedVector< const char * > & | get_event_types () const |
| | Return the event types supported by this event.
|
| |
| StringRef | get_last_event_type () const |
| | Return the last triggered event type, or empty StringRef if no event triggered yet.
|
| |
| const char * | get_event_type (uint8_t index) const |
| | Return event type by index, or nullptr if index is out of bounds.
|
| |
| uint8_t | get_last_event_type_index () const |
| | Return index of last triggered event type, or max uint8_t if no event triggered yet.
|
| |
| bool | has_event () const |
| | Check if an event has been triggered.
|
| |
| void | add_on_event_callback (std::function< void(const std::string &event_type)> &&callback) |
| |
| const StringRef & | get_name () const |
| |
| void | set_name (const char *name) |
| |
| void | set_name (const char *name, uint32_t object_id_hash) |
| | Set name with pre-computed object_id hash (avoids runtime hash calculation) Use hash=0 for dynamic names that need runtime calculation.
|
| |
| bool | has_own_name () const |
| |
| ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t | get_object_id_hash () |
| |
| StringRef | get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const |
| | Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
|
| |
| size_t | write_object_id_to (char *buf, size_t buf_size) const |
| | Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
|
| |
| bool | is_internal () const |
| |
| void | set_internal (bool internal) |
| |
| bool | is_disabled_by_default () const |
| |
| void | set_disabled_by_default (bool disabled_by_default) |
| |
| EntityCategory | get_entity_category () const |
| |
| void | set_entity_category (EntityCategory entity_category) |
| |
| ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void | set_icon (const char *icon) |
| |
| StringRef | get_icon_ref () const |
| |
| uint32_t | get_device_id () const |
| |
| void | set_device (Device *device) |
| |
| Device * | get_device () const |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| uint32_t | get_preference_hash () |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| ESPDEPRECATED("Use get_device_class_ref() instead for better performance (avoids string copy). Will be removed in " "ESPHome 2026.5.0", "2025.11.0") std void | set_device_class (const char *device_class) |
| | Get the device class, using the manual override if set.
|
| |
| StringRef | get_device_class_ref () const |
| | Get the device class as StringRef.
|
| |
Definition at line 27 of file event.h.
Public Member Functions inherited from esphome::EntityBase
1.12.0