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

#include <addressable_light_effect.h>

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

Public Member Functions

 AddressableTwinkleEffect (const std::string &name)
 
void apply (AddressableLight &addressable, const Color &current_color) override
 
void set_twinkle_probability (float twinkle_probability)
 
void set_progress_interval (uint32_t progress_interval)
 
- 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

float twinkle_probability_ {0.05f}
 
uint32_t progress_interval_ {4}
 
uint32_t last_progress_ {0}
 
- 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 185 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableTwinkleEffect()

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

Definition at line 187 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

void esphome::light::AddressableTwinkleEffect::apply ( AddressableLight addressable,
const Color current_color 
)
inlineoverridevirtual

◆ set_progress_interval()

void esphome::light::AddressableTwinkleEffect::set_progress_interval ( uint32_t  progress_interval)
inline

Definition at line 218 of file addressable_light_effect.h.

◆ set_twinkle_probability()

void esphome::light::AddressableTwinkleEffect::set_twinkle_probability ( float  twinkle_probability)
inline

Definition at line 217 of file addressable_light_effect.h.

Field Documentation

◆ last_progress_

uint32_t esphome::light::AddressableTwinkleEffect::last_progress_ {0}
protected

Definition at line 223 of file addressable_light_effect.h.

◆ progress_interval_

uint32_t esphome::light::AddressableTwinkleEffect::progress_interval_ {4}
protected

Definition at line 222 of file addressable_light_effect.h.

◆ twinkle_probability_

float esphome::light::AddressableTwinkleEffect::twinkle_probability_ {0.05f}
protected

Definition at line 221 of file addressable_light_effect.h.


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