ESPHome  1.15.2
Public Member Functions | Protected Attributes
esphome::Trigger< Ts > Class Template Reference

#include <automation.h>

Public Member Functions

void trigger (Ts... x)
 Inform the parent automation that the event has triggered. More...
 
void set_automation_parent (Automation< Ts... > *automation_parent)
 
void stop_action ()
 Stop any action connected to this trigger. More...
 
bool is_action_running ()
 Returns true if any action connected to this trigger is running. More...
 

Protected Attributes

Automation< Ts... > * automation_parent_ {nullptr}
 

Detailed Description

template<typename... Ts>
class esphome::Trigger< Ts >

Definition at line 51 of file automation.h.

Member Function Documentation

◆ is_action_running()

template<typename... Ts>
bool esphome::Trigger< Ts >::is_action_running ( )
inline

Returns true if any action connected to this trigger is running.

Definition at line 68 of file automation.h.

◆ set_automation_parent()

template<typename... Ts>
void esphome::Trigger< Ts >::set_automation_parent ( Automation< Ts... > *  automation_parent)
inline

Definition at line 59 of file automation.h.

◆ stop_action()

template<typename... Ts>
void esphome::Trigger< Ts >::stop_action ( )
inline

Stop any action connected to this trigger.

Definition at line 62 of file automation.h.

◆ trigger()

template<typename... Ts>
void esphome::Trigger< Ts >::trigger ( Ts...  x)
inline

Inform the parent automation that the event has triggered.

Definition at line 54 of file automation.h.

Field Documentation

◆ automation_parent_

template<typename... Ts>
Automation<Ts...>* esphome::Trigger< Ts >::automation_parent_ {nullptr}
protected

Definition at line 75 of file automation.h.


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