esphome::light::AddressableColorWipeEffect Class Reference

#include <addressable_light_effect.h>

Inheritance diagram for esphome::light::AddressableColorWipeEffect:

Public Member Functions
	AddressableColorWipeEffect (const char *name)
void	set_colors (const AddressableColorWipeEffectColor *colors, size_t count, Color *random_colors)
	Codegen only: point at the generated flash table of colors, which must outlive the effect.
void	set_add_led_interval (uint32_t add_led_interval)
void	set_reverse (bool reverse)
void	apply (AddressableLight &it, const Color &current_color) override
Public Member Functions inherited from esphome::light::AddressableLightEffect
	AddressableLightEffect (const char *name)
void	start_internal () override
void	stop () override
void	apply () override
uint32_t	get_effect_index () const
	Get effect index specifically for addressable effects.
bool	is_current_effect () const
	Check if this is the currently running addressable effect.
Public Member Functions inherited from esphome::light::LightEffect
	LightEffect (const char *name)
virtual void	start ()
	Initialize this LightEffect. Will be called once after creation.
StringRef	get_name () const
	Returns the name of this effect.
virtual void	init ()
	Internal method called by the LightState when this light effect is registered in it.
void	init_internal (LightState *state)
uint32_t	get_index () const
	Get the index of this effect in the parent light's effect list.
bool	is_active () const
	Check if this effect is currently active.
LightState *	get_light_state () const
	Get a reference to the parent light state.

Protected Member Functions
AddressableColorWipeEffectColor	entry_ (size_t index) const
Color	color_of_ (const AddressableColorWipeEffectColor &entry) const
Protected Member Functions inherited from esphome::light::AddressableLightEffect
AddressableLight *	get_addressable_ () const
Protected Member Functions inherited from esphome::light::LightEffect
uint32_t	get_index_in_parent_ () const
	Internal method to find this effect's index in the parent light's effect list.

Protected Attributes
ConstVector< AddressableColorWipeEffectColor >	colors_
Color *	random_colors_ {nullptr}
size_t	at_color_ {0}
uint32_t	last_add_ {0}
uint32_t	add_led_interval_ {}
size_t	leds_added_ {0}
bool	reverse_ {}
Protected Attributes inherited from esphome::light::LightEffect
LightState *	state_ {nullptr}
const char *	name_

Detailed Description

Definition at line 119 of file addressable_light_effect.h.

Constructor & Destructor Documentation

AddressableColorWipeEffect()

esphome::light::AddressableColorWipeEffect::AddressableColorWipeEffect ( const char * name )

inlineexplicit

Definition at line 121 of file addressable_light_effect.h.

Member Function Documentation

apply()

void esphome::light::AddressableColorWipeEffect::apply ( AddressableLight & it, const Color & current_color )

inlineoverridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 130 of file addressable_light_effect.h.

color_of_()

Color esphome::light::AddressableColorWipeEffect::color_of_ ( const AddressableColorWipeEffectColor & entry ) const

inlineprotected

Definition at line 174 of file addressable_light_effect.h.

entry_()

AddressableColorWipeEffectColor esphome::light::AddressableColorWipeEffect::entry_ ( size_t index ) const

inlineprotected

Definition at line 169 of file addressable_light_effect.h.

set_add_led_interval()

void esphome::light::AddressableColorWipeEffect::set_add_led_interval ( uint32_t add_led_interval )

inline

Definition at line 128 of file addressable_light_effect.h.

set_colors()

void esphome::light::AddressableColorWipeEffect::set_colors ( const AddressableColorWipeEffectColor * colors, size_t count, Color * random_colors )

inline

Codegen only: point at the generated flash table of colors, which must outlive the effect.

Random colors keep their current value in a RAM array, one slot per random entry.

Definition at line 124 of file addressable_light_effect.h.

set_reverse()

void esphome::light::AddressableColorWipeEffect::set_reverse ( bool reverse )

inline

Definition at line 129 of file addressable_light_effect.h.

Field Documentation

add_led_interval_

uint32_t esphome::light::AddressableColorWipeEffect::add_led_interval_ {}

protected

Definition at line 184 of file addressable_light_effect.h.

at_color_

size_t esphome::light::AddressableColorWipeEffect::at_color_ {0}

protected

Definition at line 182 of file addressable_light_effect.h.

colors_

ConstVector<AddressableColorWipeEffectColor> esphome::light::AddressableColorWipeEffect::colors_

protected

Definition at line 180 of file addressable_light_effect.h.

last_add_

uint32_t esphome::light::AddressableColorWipeEffect::last_add_ {0}

protected

Definition at line 183 of file addressable_light_effect.h.

leds_added_

size_t esphome::light::AddressableColorWipeEffect::leds_added_ {0}

protected

Definition at line 185 of file addressable_light_effect.h.

random_colors_

Color* esphome::light::AddressableColorWipeEffect::random_colors_ {nullptr}

protected

Definition at line 181 of file addressable_light_effect.h.

reverse_

bool esphome::light::AddressableColorWipeEffect::reverse_ {}

protected

Definition at line 186 of file addressable_light_effect.h.

---

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

• esphome/components/light/addressable_light_effect.h