esphome::light::AddressableLightEffect Class Reference

#include <addressable_light_effect.h>

Inheritance diagram for esphome::light::AddressableLightEffect:

Public Member Functions
	AddressableLightEffect (const std::string &name)
void	start_internal () override
void	stop () override
virtual void	apply (AddressableLight &it, const Color &current_color)=0
void	apply () override
Public Member Functions inherited from esphome::light::LightEffect
	LightEffect (std::string name)
virtual void	start ()
	Initialize this LightEffect. Will be called once after creation. More...
const std::string &	get_name ()
virtual void	init ()
	Internal method called by the LightState when this light effect is registered in it. More...
void	init_internal (LightState *state)

Protected Member Functions
AddressableLight *	get_addressable_ () const

Additional Inherited Members
Protected Attributes inherited from esphome::light::LightEffect
LightState *	state_ {nullptr}
std::string	name_

Detailed Description

Definition at line 31 of file addressable_light_effect.h.

Constructor & Destructor Documentation

AddressableLightEffect()

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

inlineexplicit

Definition at line 33 of file addressable_light_effect.h.

Member Function Documentation

apply() [1/2]

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

pure virtual

Implemented in esphome::light::AddressableFlickerEffect, esphome::light::AddressableFireworksEffect, esphome::light::AddressableRandomTwinkleEffect, esphome::light::AddressableTwinkleEffect, esphome::light::AddressableScanEffect, esphome::light::AddressableColorWipeEffect, esphome::light::AddressableRainbowLightEffect, esphome::light::AddressableLambdaLightEffect, esphome::wled::WLEDLightEffect, esphome::e131::E131AddressableLightEffect, and esphome::adalight::AdalightLightEffect.

apply() [2/2]

void esphome::light::AddressableLightEffect::apply ( )

inlineoverridevirtual

Implements esphome::light::LightEffect.

Definition at line 41 of file addressable_light_effect.h.

get_addressable_()

AddressableLight* esphome::light::AddressableLightEffect::get_addressable_ ( ) const

inlineprotected

Definition at line 48 of file addressable_light_effect.h.

start_internal()

void esphome::light::AddressableLightEffect::start_internal ( )

inlineoverridevirtual

Reimplemented from esphome::light::LightEffect.

Definition at line 34 of file addressable_light_effect.h.

stop()

void esphome::light::AddressableLightEffect::stop ( )

inlineoverridevirtual

Reimplemented from esphome::light::LightEffect.

Reimplemented in esphome::wled::WLEDLightEffect.

Definition at line 39 of file addressable_light_effect.h.

---

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

• /opt/build/esphome/esphome/components/light/addressable_light_effect.h