|
| void | trigger (const char *event_type) |
| | Trigger an event; the type is matched against the configured types by string compare.
|
| |
| void | trigger (const std::string &event_type) |
| |
| void | set_event_types_static (const char *const *event_types, size_t count) |
| | Codegen only: points at a table that outlives the event (see ConstVector::assign_static).
|
| |
| void | set_event_types (std::initializer_list< const char * > event_types) |
| | Runtime lists are copied; the strings must still outlive the event.
|
| |
| void | set_event_types (const EventTypes &event_types) |
| | Copy the event types of another event, for components that wrap one.
|
| |
| void | set_event_types (const FixedVector< const char * > &event_types) |
| |
| void | set_event_types (std::initializer_list< std::string > event_types)=delete |
| |
| void | set_event_types (const FixedVector< std::string > &event_types)=delete |
| |
| const EventTypes & | 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.
|
| |
| template<typename F > |
| void | add_on_event_callback (F &&callback) |
| |
| | ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const |
| | The name is in flash here; the first call makes a RAM copy that is kept for the life of the device.
|
| |
| StringRef | get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE > buffer) const |
| | Get the name of this Entity, copied out of flash into buffer.
|
| |
| | ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const |
| |
| const StringRef & | get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE >) const |
| |
| bool | name_equals (const StringRef &other) const |
| |
| const ProgmemStringRef & | get_name_progmem () const |
| | The name as stored, for consumers that read flash themselves (e.g. API progmem fields).
|
| |
| size_t | write_name_to (char *buf, size_t buf_size) const |
| | Copy the name into buf (null terminated), returns its length.
|
| |
| const LogString * | get_log_name () const |
| | Get the name for a "%s" log argument (LOG_STR_ARG).
|
| |
| bool | has_own_name () const |
| |
| uint32_t | get_object_id_hash () const |
| |
| 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 |
| |
| EntityCategory | get_entity_category () const |
| |
| const char * | get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const |
| |
| ProgmemStringRef | get_device_class_progmem () const |
| | The device class as stored (in flash on ESP8266), for consumers that read flash themselves.
|
| |
| StringRef | get_unit_of_measurement_ref () const |
| |
| const char * | get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const |
| |
| ProgmemStringRef | get_icon_progmem () const |
| | The icon as stored (in flash on ESP8266), for consumers that read flash themselves.
|
| |
| uint32_t | get_device_id () const |
| |
| Device * | get_device () const |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| | ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash() |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| template<typename T > |
| ESPPreferenceObject | make_entity_preference (uint32_t version=0) |
| | Create a preference object for storing this entity's state/settings.
|
| |
| template<typename T > |
| ESPPreferenceObject | make_entity_preference (uint32_t version, bool in_flash) |
| | As make_entity_preference(), stored in flash or RTC memory where the backend supports the choice.
|
| |
Definition at line 23 of file event.h.
Public Member Functions inherited from esphome::EntityBase
1.12.0