#include <addressable_light_effect.h>

Inheritance diagram for esphome::light::AddressableRainbowLightEffect:

Public Member Functions
	AddressableRainbowLightEffect (const std::string &name)

void	apply (AddressableLight &it, const Color &current_color) override

void	set_speed (uint32_t speed)

void	set_width (uint16_t width)

Public Member Functions inherited from esphome::light::AddressableLightEffect
	AddressableLightEffect (const std::string &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 (std::string name)

virtual void	start ()
	Initialize this LightEffect. Will be called once after creation.

const std::string &	get_name ()

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 Attributes
uint32_t	speed_ {10}

uint16_t	width_ {50}

Protected Attributes inherited from esphome::light::LightEffect
LightState *	state_ {nullptr}

std::string	name_

Additional Inherited Members
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.

Detailed Description

Definition at line 82 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableRainbowLightEffect()

esphome::light::AddressableRainbowLightEffect::AddressableRainbowLightEffect ( const std::string & name )

inlineexplicit

Definition at line 84 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

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

inlineoverridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 85 of file addressable_light_effect.h.

◆ set_speed()

void esphome::light::AddressableRainbowLightEffect::set_speed ( uint32_t speed )

inline

Definition at line 98 of file addressable_light_effect.h.

◆ set_width()

void esphome::light::AddressableRainbowLightEffect::set_width ( uint16_t width )

inline

Definition at line 99 of file addressable_light_effect.h.

Field Documentation

◆ speed_

uint32_t esphome::light::AddressableRainbowLightEffect::speed_ {10}

protected

Definition at line 102 of file addressable_light_effect.h.

◆ width_

uint16_t esphome::light::AddressableRainbowLightEffect::width_ {50}

protected

Definition at line 103 of file addressable_light_effect.h.

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

esphome/components/light/addressable_light_effect.h

Public Member Functions

Protected Attributes

Additional Inherited Members