esphome::e131::E131AddressableLightEffect Class Reference

#include <e131_addressable_light_effect.h>

Inheritance diagram for esphome::e131::E131AddressableLightEffect:

Public Member Functions
	E131AddressableLightEffect (const char *name)
void	start () override
void	stop () override
void	apply (light::AddressableLight &it, const Color &current_color) override
int	get_data_per_universe () const
int	get_lights_per_universe () const
int	get_first_universe () const
int	get_last_universe () const
int	get_universe_count () const
void	set_first_universe (int universe)
void	set_channels (E131LightChannels channels)
void	set_e131 (E131Component *e131)
Public Member Functions inherited from esphome::light::AddressableLightEffect
	AddressableLightEffect (const char *name)
void	start_internal () 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)
const char *	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
bool	process_ (int universe, const E131Packet &packet)
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
int	first_universe_ {0}
int	last_universe_ {0}
E131LightChannels	channels_ {E131_RGB}
E131Component *	e131_ {nullptr}
Protected Attributes inherited from esphome::light::LightEffect
LightState *	state_ {nullptr}
const char *	name_

Detailed Description

Definition at line 14 of file e131_addressable_light_effect.h.

Constructor & Destructor Documentation

E131AddressableLightEffect()

esphome::e131::E131AddressableLightEffect::E131AddressableLightEffect

(

const char *

name

)

Definition at line 12 of file e131_addressable_light_effect.cpp.

Member Function Documentation

apply()

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

overridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 44 of file e131_addressable_light_effect.cpp.

get_data_per_universe()

int esphome::e131::E131AddressableLightEffect::get_data_per_universe

(

)

const

Definition at line 14 of file e131_addressable_light_effect.cpp.

get_first_universe()

int esphome::e131::E131AddressableLightEffect::get_first_universe

(

)

const

Definition at line 18 of file e131_addressable_light_effect.cpp.

get_last_universe()

int esphome::e131::E131AddressableLightEffect::get_last_universe

(

)

const

Definition at line 20 of file e131_addressable_light_effect.cpp.

get_lights_per_universe()

int esphome::e131::E131AddressableLightEffect::get_lights_per_universe

(

)

const

Definition at line 16 of file e131_addressable_light_effect.cpp.

get_universe_count()

int esphome::e131::E131AddressableLightEffect::get_universe_count

(

)

const

Definition at line 22 of file e131_addressable_light_effect.cpp.

process_()

bool esphome::e131::E131AddressableLightEffect::process_ ( int universe, const E131Packet & packet )

protected

Definition at line 48 of file e131_addressable_light_effect.cpp.

set_channels()

void esphome::e131::E131AddressableLightEffect::set_channels ( E131LightChannels channels )

inline

Definition at line 29 of file e131_addressable_light_effect.h.

set_e131()

void esphome::e131::E131AddressableLightEffect::set_e131 ( E131Component * e131 )

inline

Definition at line 30 of file e131_addressable_light_effect.h.

set_first_universe()

void esphome::e131::E131AddressableLightEffect::set_first_universe ( int universe )

inline

Definition at line 28 of file e131_addressable_light_effect.h.

start()

void esphome::e131::E131AddressableLightEffect::start ( )

overridevirtual

Reimplemented from esphome::light::LightEffect.

Definition at line 28 of file e131_addressable_light_effect.cpp.

stop()

void esphome::e131::E131AddressableLightEffect::stop ( )

overridevirtual

Reimplemented from esphome::light::AddressableLightEffect.

Definition at line 36 of file e131_addressable_light_effect.cpp.

Field Documentation

channels_

E131LightChannels esphome::e131::E131AddressableLightEffect::channels_ {E131_RGB}

protected

Definition at line 37 of file e131_addressable_light_effect.h.

e131_

E131Component* esphome::e131::E131AddressableLightEffect::e131_ {nullptr}

protected

Definition at line 38 of file e131_addressable_light_effect.h.

first_universe_

int esphome::e131::E131AddressableLightEffect::first_universe_ {0}

protected

Definition at line 35 of file e131_addressable_light_effect.h.

last_universe_

int esphome::e131::E131AddressableLightEffect::last_universe_ {0}

protected

Definition at line 36 of file e131_addressable_light_effect.h.

---

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

• esphome/components/e131/e131_addressable_light_effect.h
• esphome/components/e131/e131_addressable_light_effect.cpp