esphome::event::Event Class Reference

#include <event.h>

Inheritance diagram for esphome::event::Event:

Public Member Functions
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.
const char *	get_last_event_type () const
	Return the last triggered event type (pointer to string in types_), or nullptr if no event triggered yet.
void	add_on_event_callback (std::function< void(const std::string &event_type)> &&callback)
Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const
void	set_name (const char *name)
bool	has_own_name () const
std::string	get_object_id () const
void	set_object_id (const char *object_id)
uint32_t	get_object_id_hash ()
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)
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.
Public Member Functions inherited from esphome::EntityBase_DeviceClass
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.

Protected Attributes
CallbackManager< void(const std::string &event_type)>	event_callback_
FixedVector< const char * >	types_
Protected Attributes inherited from esphome::EntityBase
StringRef	name_
const char *	object_id_c_str_ {nullptr}
const char *	icon_c_str_ {nullptr}
uint32_t	object_id_hash_ {}
Device *	device_ {}
struct esphome::EntityBase::EntityFlags	flags_
Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override.

Additional Inherited Members
Protected Member Functions inherited from esphome::EntityBase
StringRef	get_object_id_ref_for_api_ () const
void	calc_object_id_ ()
bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

Detailed Description

Definition at line 25 of file event.h.

Member Function Documentation

add_on_event_callback()

void esphome::event::Event::add_on_event_callback

(

std::function< void(const std::string &event_type)> &&

callback

)

Definition at line 48 of file event.cpp.

get_event_types()

const FixedVector< const char * > & esphome::event::Event::get_event_types ( ) const

inline

Return the event types supported by this event.

Definition at line 45 of file event.h.

get_last_event_type()

const char * esphome::event::Event::get_last_event_type ( ) const

inline

Return the last triggered event type (pointer to string in types_), or nullptr if no event triggered yet.

Definition at line 48 of file event.h.

set_event_types() [1/6]

void esphome::event::Event::set_event_types

(

const FixedVector< const char * > &

event_types

)

Set the event types supported by this event (from FixedVector).

Definition at line 32 of file event.cpp.

set_event_types() [2/6]

void esphome::event::Event::set_event_types ( const FixedVector< std::string > & event_types )

delete

set_event_types() [3/6]

void esphome::event::Event::set_event_types

(

const std::vector< const char * > &

event_types

)

Set the event types supported by this event (from vector).

Definition at line 40 of file event.cpp.

set_event_types() [4/6]

void esphome::event::Event::set_event_types ( const std::vector< std::string > & event_types )

delete

set_event_types() [5/6]

void esphome::event::Event::set_event_types ( std::initializer_list< const char * > event_types )

inline

Set the event types supported by this event (from initializer list).

Definition at line 30 of file event.h.

set_event_types() [6/6]

void esphome::event::Event::set_event_types ( std::initializer_list< std::string > event_types )

delete

trigger()

void esphome::event::Event::trigger

(

const std::string &

event_type

)

Definition at line 11 of file event.cpp.

Field Documentation

event_callback_

CallbackManager<void(const std::string &event_type)> esphome::event::Event::event_callback_

protected

Definition at line 53 of file event.h.

types_

FixedVector<const char *> esphome::event::Event::types_

protected

Definition at line 54 of file event.h.

---

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

• esphome/components/event/event.h
• esphome/components/event/event.cpp