ESPHome  2024.7.2
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 194 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableTwinkleEffect()

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

Definition at line 196 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

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

◆ set_progress_interval()

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

Definition at line 227 of file addressable_light_effect.h.

◆ set_twinkle_probability()

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

Definition at line 226 of file addressable_light_effect.h.

Field Documentation

◆ last_progress_

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

Definition at line 232 of file addressable_light_effect.h.

◆ progress_interval_

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

Definition at line 231 of file addressable_light_effect.h.

◆ twinkle_probability_

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

Definition at line 230 of file addressable_light_effect.h.

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