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

#include <base_automation.h>

Inheritance diagram for esphome::ForCondition< Ts >:
esphome::Condition< Ts... > esphome::Component

Public Member Functions

 ForCondition (Condition<> *condition)
 
 TEMPLATABLE_VALUE (uint32_t, time)
 
void loop () override
 
float get_setup_priority () const override
 
bool check_internal ()
 
bool check (Ts... x) override
 
- Public Member Functions inherited from esphome::Condition< Ts... >
bool check_tuple (const std::tuple< Ts... > &tuple)
 Call check with a tuple of values as parameter. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. 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
 

Protected Attributes

Conditioncondition_
 
uint32_t last_inactive_ {0}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Condition< Ts... >
bool check_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
- 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...
 

Detailed Description

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

Definition at line 58 of file base_automation.h.

Constructor & Destructor Documentation

◆ ForCondition()

template<typename... Ts>
esphome::ForCondition< Ts >::ForCondition ( Condition<> *  condition)
inlineexplicit

Definition at line 60 of file base_automation.h.

Member Function Documentation

◆ check()

template<typename... Ts>
bool esphome::ForCondition< Ts >::check ( Ts...  x)
inlineoverridevirtual

Implements esphome::Condition< Ts... >.

Definition at line 73 of file base_automation.h.

◆ check_internal()

template<typename... Ts>
bool esphome::ForCondition< Ts >::check_internal ( )
inline

Definition at line 66 of file base_automation.h.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 65 of file base_automation.h.

◆ loop()

template<typename... Ts>
void esphome::ForCondition< Ts >::loop ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file base_automation.h.

◆ TEMPLATABLE_VALUE()

template<typename... Ts>
esphome::ForCondition< Ts >::TEMPLATABLE_VALUE ( uint32_t  ,
time   
)

Field Documentation

◆ condition_

template<typename... Ts>
Condition* esphome::ForCondition< Ts >::condition_
protected

Definition at line 80 of file base_automation.h.

◆ last_inactive_

template<typename... Ts>
uint32_t esphome::ForCondition< Ts >::last_inactive_ {0}
protected

Definition at line 81 of file base_automation.h.


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