ESPHome 2025.10.0-dev
Loading...
Searching...
No Matches
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
 
uint32_t get_effect_index () const
 Get effect index specifically for addressable effects.
 
bool is_current_effect () const
 Check if this is the currently running addressable effect.
 
- Public Member Functions inherited from esphome::light::LightEffect
 LightEffect (std::string name)
 
virtual void start ()
 Initialize this LightEffect. Will be called once after creation.
 
const std::string & get_name ()
 
virtual void init ()
 Internal method called by the LightState when this light effect is registered in it.
 
void init_internal (LightState *state)
 
uint32_t get_index () const
 Get the index of this effect in the parent light's effect list.
 
bool is_active () const
 Check if this effect is currently active.
 
LightStateget_light_state () const
 Get a reference to the parent light 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
 
- Protected Member Functions inherited from esphome::light::LightEffect
uint32_t get_index_in_parent_ () const
 Internal method to find this effect's index in the parent light's effect list.
 

Detailed Description

Definition at line 343 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableFlickerEffect()

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

Definition at line 345 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 367 of file addressable_light_effect.h.

◆ set_update_interval()

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

Definition at line 366 of file addressable_light_effect.h.

Field Documentation

◆ intensity_

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

Definition at line 372 of file addressable_light_effect.h.

◆ last_update_

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

Definition at line 371 of file addressable_light_effect.h.

◆ update_interval_

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

Definition at line 370 of file addressable_light_effect.h.


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