ESPHome  2024.6.1
Public Member Functions | Protected Attributes
esphome::event::Event Class Reference

#include <event.h>

Inheritance diagram for esphome::event::Event:
esphome::EntityBase esphome::EntityBase_DeviceClass esphome::template_::TemplateEvent

Public Member Functions

void trigger (const std::string &event_type)
void set_event_types (const std::set< std::string > &event_types)
std::set< std::string > get_event_types () const
void add_on_event_callback (std::function< void(const std::string &event_type)> &&callback)
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_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)
std::string get_icon () const
void set_icon (const char *icon)
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
void set_device_class (const char *device_class)
 Manually set the device class. More...

Protected Attributes

CallbackManager< void(const std::string &event_type)> event_callback_
std::set< std::string > 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_
bool has_own_name_ {false}
bool internal_ {false}
bool disabled_by_default_ {false}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...

Additional Inherited Members

- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
void calc_object_id_ ()

Detailed Description

Definition at line 24 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 19 of file event.cpp.

◆ get_event_types()

std::set<std::string> esphome::event::Event::get_event_types ( ) const

Definition at line 28 of file event.h.

◆ set_event_types()

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

Definition at line 27 of file event.h.

◆ trigger()

void esphome::event::Event::trigger ( const std::string &  event_type)

Definition at line 10 of file event.cpp.

Field Documentation

◆ event_callback_

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

Definition at line 32 of file event.h.

◆ types_

std::set<std::string> esphome::event::Event::types_

Definition at line 33 of file event.h.

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