ESPHome  2022.9.1
Public Member Functions | Protected Attributes
esphome::light::AddressableColorWipeEffect Class Reference

#include <addressable_light_effect.h>

Inheritance diagram for esphome::light::AddressableColorWipeEffect:
esphome::light::AddressableLightEffect esphome::light::LightEffect

Public Member Functions

 AddressableColorWipeEffect (const std::string &name)
 
void set_colors (const std::vector< AddressableColorWipeEffectColor > &colors)
 
void set_add_led_interval (uint32_t add_led_interval)
 
void set_reverse (bool reverse)
 
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
 
- 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 Attributes

std::vector< AddressableColorWipeEffectColorcolors_
 
size_t at_color_ {0}
 
uint32_t last_add_ {0}
 
uint32_t add_led_interval_ {}
 
size_t leds_added_ {0}
 
bool reverse_ {}
 
- Protected Attributes inherited from esphome::light::LightEffect
LightStatestate_ {nullptr}
 
std::string name_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::light::AddressableLightEffect
AddressableLightget_addressable_ () const
 

Detailed Description

Definition at line 104 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableColorWipeEffect()

esphome::light::AddressableColorWipeEffect::AddressableColorWipeEffect ( const std::string &  name)
inlineexplicit

Definition at line 106 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

void esphome::light::AddressableColorWipeEffect::apply ( AddressableLight it,
const Color current_color 
)
inlineoverridevirtual

◆ set_add_led_interval()

void esphome::light::AddressableColorWipeEffect::set_add_led_interval ( uint32_t  add_led_interval)
inline

Definition at line 108 of file addressable_light_effect.h.

◆ set_colors()

void esphome::light::AddressableColorWipeEffect::set_colors ( const std::vector< AddressableColorWipeEffectColor > &  colors)
inline

Definition at line 107 of file addressable_light_effect.h.

◆ set_reverse()

void esphome::light::AddressableColorWipeEffect::set_reverse ( bool  reverse)
inline

Definition at line 109 of file addressable_light_effect.h.

Field Documentation

◆ add_led_interval_

uint32_t esphome::light::AddressableColorWipeEffect::add_led_interval_ {}
protected

Definition at line 143 of file addressable_light_effect.h.

◆ at_color_

size_t esphome::light::AddressableColorWipeEffect::at_color_ {0}
protected

Definition at line 141 of file addressable_light_effect.h.

◆ colors_

std::vector<AddressableColorWipeEffectColor> esphome::light::AddressableColorWipeEffect::colors_
protected

Definition at line 140 of file addressable_light_effect.h.

◆ last_add_

uint32_t esphome::light::AddressableColorWipeEffect::last_add_ {0}
protected

Definition at line 142 of file addressable_light_effect.h.

◆ leds_added_

size_t esphome::light::AddressableColorWipeEffect::leds_added_ {0}
protected

Definition at line 144 of file addressable_light_effect.h.

◆ reverse_

bool esphome::light::AddressableColorWipeEffect::reverse_ {}
protected

Definition at line 145 of file addressable_light_effect.h.


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