esphome::light::DimRelativeAction< HasTransitionLength, Ts > Class Template Reference

#include <automation.h>

Inheritance diagram for esphome::light::DimRelativeAction< HasTransitionLength, Ts >:

Data Structures
struct	NoTransition

Public Member Functions
	DimRelativeAction (LightState *parent)
	TEMPLATABLE_VALUE (float, relative_brightness) template< typename V > void set_transition_length(V value)
void	play (const 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 (const Ts &...x)
virtual void	stop_complex ()
virtual bool	is_running ()
	Check if this or any of the following actions are currently running.
int	num_running_total ()
	The total number of actions that are currently running in this plus any of the following actions in the chain.

Protected Attributes
LightState *	parent_
float	min_brightness_ {0.0}
float	max_brightness_ {1.0}
LimitMode	limit_mode_ {LimitMode::CLAMP}
std::conditional_t< HasTransitionLength, TemplatableFn< uint32_t, Ts... >, NoTransition >	transition_length_ {}
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.

Additional Inherited Members
Protected Member Functions inherited from esphome::Action< Ts... >
void	play_next_ (const Ts &...x)
void	play_next_tuple_ (const std::tuple< Ts... > &tuple, std::index_sequence< S... >)
void	play_next_tuple_ (const std::tuple< Ts... > &tuple)
virtual void	stop ()
void	stop_next_ ()
bool	is_running_next_ ()

Detailed Description

template<bool HasTransitionLength, typename... Ts>
class esphome::light::DimRelativeAction< HasTransitionLength, Ts >

Definition at line 62 of file automation.h.

Constructor & Destructor Documentation

DimRelativeAction()

template<bool HasTransitionLength, typename... Ts>

esphome::light::DimRelativeAction< HasTransitionLength, Ts >::DimRelativeAction ( LightState * parent )

inlineexplicit

Definition at line 64 of file automation.h.

Member Function Documentation

play()

template<bool HasTransitionLength, typename... Ts>

void esphome::light::DimRelativeAction< HasTransitionLength, Ts >::play ( const Ts &... x )

inlineoverridevirtual

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

Definition at line 72 of file automation.h.

set_limit_mode()

template<bool HasTransitionLength, typename... Ts>

void esphome::light::DimRelativeAction< HasTransitionLength, Ts >::set_limit_mode ( LimitMode limit_mode )

inline

Definition at line 95 of file automation.h.

set_min_max_brightness()

template<bool HasTransitionLength, typename... Ts>

void esphome::light::DimRelativeAction< HasTransitionLength, Ts >::set_min_max_brightness ( float min, float max )

inline

Definition at line 90 of file automation.h.

TEMPLATABLE_VALUE()

template<bool HasTransitionLength, typename... Ts>

esphome::light::DimRelativeAction< HasTransitionLength, Ts >::TEMPLATABLE_VALUE ( float , relative_brightness  )

inline

Definition at line 66 of file automation.h.

Field Documentation

limit_mode_

template<bool HasTransitionLength, typename... Ts>

LimitMode esphome::light::DimRelativeAction< HasTransitionLength, Ts >::limit_mode_ {LimitMode::CLAMP}

protected

Definition at line 101 of file automation.h.

max_brightness_

template<bool HasTransitionLength, typename... Ts>

float esphome::light::DimRelativeAction< HasTransitionLength, Ts >::max_brightness_ {1.0}

protected

Definition at line 100 of file automation.h.

min_brightness_

template<bool HasTransitionLength, typename... Ts>

float esphome::light::DimRelativeAction< HasTransitionLength, Ts >::min_brightness_ {0.0}

protected

Definition at line 99 of file automation.h.

parent_

template<bool HasTransitionLength, typename... Ts>

LightState* esphome::light::DimRelativeAction< HasTransitionLength, Ts >::parent_

protected

Definition at line 98 of file automation.h.

transition_length_

template<bool HasTransitionLength, typename... Ts>

std::conditional_t<HasTransitionLength, TemplatableFn<uint32_t, Ts...>, NoTransition> esphome::light::DimRelativeAction< HasTransitionLength, Ts >::transition_length_ {}

protected

Definition at line 104 of file automation.h.

---

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

• esphome/components/light/automation.h