ESPHome  2024.11.0
Public Member Functions | Protected Attributes
esphome::light::DimRelativeAction< Ts > Class Template Reference

#include <automation.h>

Inheritance diagram for esphome::light::DimRelativeAction< Ts >:
esphome::Action< Ts... >

Public Member Functions

 DimRelativeAction (LightState *parent)
 
 TEMPLATABLE_VALUE (float, relative_brightness) TEMPLATABLE_VALUE(uint32_t
 
transition_length void play (Ts... x) override
 
void set_min_max_brightness (float min, float max)
 
void set_limit_mode (LimitMode limit_mode)
 
- 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

LightStateparent_
 
float min_brightness_ {0.0}
 
float max_brightness_ {1.0}
 
LimitMode limit_mode_ {LimitMode::CLAMP}
 
- 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::light::DimRelativeAction< Ts >

Definition at line 70 of file automation.h.

Constructor & Destructor Documentation

◆ DimRelativeAction()

template<typename... Ts>
esphome::light::DimRelativeAction< Ts >::DimRelativeAction ( LightState parent)
inlineexplicit

Definition at line 72 of file automation.h.

Member Function Documentation

◆ play()

template<typename... Ts>
transition_length void esphome::light::DimRelativeAction< Ts >::play ( Ts...  x)
inlineoverridevirtual

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

Definition at line 77 of file automation.h.

◆ set_limit_mode()

template<typename... Ts>
void esphome::light::DimRelativeAction< Ts >::set_limit_mode ( LimitMode  limit_mode)
inline

Definition at line 98 of file automation.h.

◆ set_min_max_brightness()

template<typename... Ts>
void esphome::light::DimRelativeAction< Ts >::set_min_max_brightness ( float  min,
float  max 
)
inline

Definition at line 93 of file automation.h.

◆ TEMPLATABLE_VALUE()

template<typename... Ts>
esphome::light::DimRelativeAction< Ts >::TEMPLATABLE_VALUE ( float  ,
relative_brightness   
)

Field Documentation

◆ limit_mode_

template<typename... Ts>
LimitMode esphome::light::DimRelativeAction< Ts >::limit_mode_ {LimitMode::CLAMP}
protected

Definition at line 104 of file automation.h.

◆ max_brightness_

template<typename... Ts>
float esphome::light::DimRelativeAction< Ts >::max_brightness_ {1.0}
protected

Definition at line 103 of file automation.h.

◆ min_brightness_

template<typename... Ts>
float esphome::light::DimRelativeAction< Ts >::min_brightness_ {0.0}
protected

Definition at line 102 of file automation.h.

◆ parent_

template<typename... Ts>
LightState* esphome::light::DimRelativeAction< Ts >::parent_
protected

Definition at line 101 of file automation.h.


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