ESPHome  1.15.2
Public Member Functions
esphome::DelayAction< Ts > Class Template Reference

#include <base_automation.h>

Inheritance diagram for esphome::DelayAction< Ts >:
esphome::Action< Ts... > esphome::Component

Public Member Functions

 DelayAction ()=default
 
 TEMPLATABLE_VALUE (uint32_t, delay) void play_complex(Ts... x) override
 
float get_setup_priority () const override
 
void play (Ts... x) override
 
void stop () override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void play_complex (Ts... x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running. More...
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (Ts... x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
void stop_next_ ()
 
bool is_running_next_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed. More...
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 

Detailed Description

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

Definition at line 105 of file base_automation.h.

Constructor & Destructor Documentation

◆ DelayAction()

template<typename... Ts>
esphome::DelayAction< Ts >::DelayAction ( )
explicitdefault

Member Function Documentation

◆ get_setup_priority()

template<typename... Ts>
float esphome::DelayAction< Ts >::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 116 of file base_automation.h.

◆ play()

template<typename... Ts>
void esphome::DelayAction< Ts >::play ( Ts...  x)
inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 118 of file base_automation.h.

◆ stop()

template<typename... Ts>
void esphome::DelayAction< Ts >::stop ( )
inlineoverridevirtual

Reimplemented from esphome::Action< Ts... >.

Definition at line 121 of file base_automation.h.

◆ TEMPLATABLE_VALUE()

template<typename... Ts>
esphome::DelayAction< Ts >::TEMPLATABLE_VALUE ( uint32_t  ,
delay   
)
inlineoverride

Definition at line 109 of file base_automation.h.


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