ESPHome  2024.11.3
Public Member Functions | Protected Attributes
esphome::light::AddressableFlickerEffect Class Reference

#include <addressable_light_effect.h>

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

Public Member Functions

 AddressableFlickerEffect (const std::string &name)
 
void apply (AddressableLight &it, const Color &current_color) override
 
void set_update_interval (uint32_t update_interval)
 
void set_intensity (float intensity)
 
- 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

uint32_t update_interval_ {16}
 
uint32_t last_update_ {0}
 
uint8_t intensity_ {13}
 
- 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 336 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableFlickerEffect()

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

Definition at line 338 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

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

◆ set_intensity()

void esphome::light::AddressableFlickerEffect::set_intensity ( float  intensity)
inline

Definition at line 360 of file addressable_light_effect.h.

◆ set_update_interval()

void esphome::light::AddressableFlickerEffect::set_update_interval ( uint32_t  update_interval)
inline

Definition at line 359 of file addressable_light_effect.h.

Field Documentation

◆ intensity_

uint8_t esphome::light::AddressableFlickerEffect::intensity_ {13}
protected

Definition at line 365 of file addressable_light_effect.h.

◆ last_update_

uint32_t esphome::light::AddressableFlickerEffect::last_update_ {0}
protected

Definition at line 364 of file addressable_light_effect.h.

◆ update_interval_

uint32_t esphome::light::AddressableFlickerEffect::update_interval_ {16}
protected

Definition at line 363 of file addressable_light_effect.h.


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