ESPHome  2024.5.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::e131::E131AddressableLightEffect Class Reference

#include <e131_addressable_light_effect.h>

Inheritance diagram for esphome::e131::E131AddressableLightEffect:
esphome::light::AddressableLightEffect esphome::light::LightEffect

Public Member Functions

 E131AddressableLightEffect (const std::string &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 std::string &name)
void start_internal () override
void stop () override
void apply () override
- 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. More...
void init_internal (LightState *state)

Protected Member Functions

bool process_ (int universe, const E131Packet &packet)
- Protected Member Functions inherited from esphome::light::AddressableLightEffect
AddressableLightget_addressable_ () const

Protected Attributes

int first_universe_ {0}
int last_universe_ {0}
E131LightChannels channels_ {E131_RGB}
E131Componente131_ {nullptr}
- Protected Attributes inherited from esphome::light::LightEffect
LightStatestate_ {nullptr}
std::string name_

Detailed Description

Definition at line 14 of file e131_addressable_light_effect.h.

Constructor & Destructor Documentation

◆ E131AddressableLightEffect()

esphome::e131::E131AddressableLightEffect::E131AddressableLightEffect ( const std::string &  name)

Definition at line 11 of file e131_addressable_light_effect.cpp.

Member Function Documentation

◆ apply()

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

◆ get_data_per_universe()

int esphome::e131::E131AddressableLightEffect::get_data_per_universe ( ) const

Definition at line 13 of file e131_addressable_light_effect.cpp.

◆ get_first_universe()

int esphome::e131::E131AddressableLightEffect::get_first_universe ( ) const

Definition at line 17 of file e131_addressable_light_effect.cpp.

◆ get_last_universe()

int esphome::e131::E131AddressableLightEffect::get_last_universe ( ) const

Definition at line 19 of file e131_addressable_light_effect.cpp.

◆ get_lights_per_universe()

int esphome::e131::E131AddressableLightEffect::get_lights_per_universe ( ) const

Definition at line 15 of file e131_addressable_light_effect.cpp.

◆ get_universe_count()

int esphome::e131::E131AddressableLightEffect::get_universe_count ( ) const

Definition at line 21 of file e131_addressable_light_effect.cpp.

◆ process_()

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

Definition at line 47 of file e131_addressable_light_effect.cpp.

◆ set_channels()

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

Definition at line 29 of file e131_addressable_light_effect.h.

◆ set_e131()

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

Definition at line 30 of file e131_addressable_light_effect.h.

◆ set_first_universe()

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

Definition at line 28 of file e131_addressable_light_effect.h.

◆ start()

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

Reimplemented from esphome::light::LightEffect.

Definition at line 27 of file e131_addressable_light_effect.cpp.

◆ stop()

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

Reimplemented from esphome::light::LightEffect.

Definition at line 35 of file e131_addressable_light_effect.cpp.

Field Documentation

◆ channels_

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

Definition at line 37 of file e131_addressable_light_effect.h.

◆ e131_

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

Definition at line 38 of file e131_addressable_light_effect.h.

◆ first_universe_

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

Definition at line 35 of file e131_addressable_light_effect.h.

◆ last_universe_

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

Definition at line 36 of file e131_addressable_light_effect.h.

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