esphome::light::AddressableLambdaLightEffect Class Reference

#include <addressable_light_effect.h>

Inheritance diagram for esphome::light::AddressableLambdaLightEffect:

Public Member Functions
	AddressableLambdaLightEffect (const std::string &name, std::function< void(AddressableLight &, Color, bool initial_run)> f, uint32_t update_interval)
void	start () override
void	apply (AddressableLight &it, const Color &current_color) override
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)
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
std::function< void(AddressableLight &, Color, bool initial_run)>	f_
uint32_t	update_interval_
uint32_t	last_run_ {0}
bool	initial_run_
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 58 of file addressable_light_effect.h.

Constructor & Destructor Documentation

AddressableLambdaLightEffect()

esphome::light::AddressableLambdaLightEffect::AddressableLambdaLightEffect ( const std::string & name, std::function< void(AddressableLight &, Color, bool initial_run)> f, uint32_t update_interval )

inline

Definition at line 60 of file addressable_light_effect.h.

Member Function Documentation

apply()

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

inlineoverridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 65 of file addressable_light_effect.h.

start()

void esphome::light::AddressableLambdaLightEffect::start ( )

inlineoverridevirtual

Reimplemented from esphome::light::LightEffect.

Definition at line 64 of file addressable_light_effect.h.

Field Documentation

f_

std::function<void(AddressableLight &, Color, bool initial_run)> esphome::light::AddressableLambdaLightEffect::f_

protected

Definition at line 76 of file addressable_light_effect.h.

initial_run_

bool esphome::light::AddressableLambdaLightEffect::initial_run_

protected

Definition at line 79 of file addressable_light_effect.h.

last_run_

uint32_t esphome::light::AddressableLambdaLightEffect::last_run_ {0}

protected

Definition at line 78 of file addressable_light_effect.h.

update_interval_

uint32_t esphome::light::AddressableLambdaLightEffect::update_interval_

protected

Definition at line 77 of file addressable_light_effect.h.

---

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

• esphome/components/light/addressable_light_effect.h