ESPHome  2022.9.2
Public Member Functions | Protected Attributes
esphome::deep_sleep::EnterDeepSleepAction< Ts > Class Template Reference

#include <deep_sleep_component.h>

Inheritance diagram for esphome::deep_sleep::EnterDeepSleepAction< Ts >:
esphome::Action< Ts... >

Public Member Functions

 EnterDeepSleepAction (DeepSleepComponent *deep_sleep)
 
 TEMPLATABLE_VALUE (uint32_t, sleep_duration)
 
void set_until (uint8_t hour, uint8_t minute, uint8_t second)
 
void set_time (time::RealTimeClock *time)
 
void play (Ts... x) 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...
 

Protected Attributes

DeepSleepComponentdeep_sleep_
 
optional< uint8_t > hour_
 
optional< uint8_t > minute_
 
optional< uint8_t > second_
 
time::RealTimeClocktime_
 
- 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...
 

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)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Detailed Description

template<typename... Ts>
class esphome::deep_sleep::EnterDeepSleepAction< Ts >

Definition at line 50 of file deep_sleep_component.h.

Constructor & Destructor Documentation

◆ EnterDeepSleepAction()

template<typename... Ts>
esphome::deep_sleep::EnterDeepSleepAction< Ts >::EnterDeepSleepAction ( DeepSleepComponent deep_sleep)
inline

Definition at line 123 of file deep_sleep_component.h.

Member Function Documentation

◆ play()

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

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

Definition at line 136 of file deep_sleep_component.h.

◆ set_time()

template<typename... Ts>
void esphome::deep_sleep::EnterDeepSleepAction< Ts >::set_time ( time::RealTimeClock time)
inline

Definition at line 133 of file deep_sleep_component.h.

◆ set_until()

template<typename... Ts>
void esphome::deep_sleep::EnterDeepSleepAction< Ts >::set_until ( uint8_t  hour,
uint8_t  minute,
uint8_t  second 
)
inline

Definition at line 127 of file deep_sleep_component.h.

◆ TEMPLATABLE_VALUE()

template<typename... Ts>
esphome::deep_sleep::EnterDeepSleepAction< Ts >::TEMPLATABLE_VALUE ( uint32_t  ,
sleep_duration   
)

Field Documentation

◆ deep_sleep_

template<typename... Ts>
DeepSleepComponent* esphome::deep_sleep::EnterDeepSleepAction< Ts >::deep_sleep_
protected

Definition at line 183 of file deep_sleep_component.h.

◆ hour_

template<typename... Ts>
optional<uint8_t> esphome::deep_sleep::EnterDeepSleepAction< Ts >::hour_
protected

Definition at line 185 of file deep_sleep_component.h.

◆ minute_

template<typename... Ts>
optional<uint8_t> esphome::deep_sleep::EnterDeepSleepAction< Ts >::minute_
protected

Definition at line 186 of file deep_sleep_component.h.

◆ second_

template<typename... Ts>
optional<uint8_t> esphome::deep_sleep::EnterDeepSleepAction< Ts >::second_
protected

Definition at line 187 of file deep_sleep_component.h.

◆ time_

template<typename... Ts>
time::RealTimeClock* esphome::deep_sleep::EnterDeepSleepAction< Ts >::time_
protected

Definition at line 189 of file deep_sleep_component.h.


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