ESPHome  2024.6.1
Public Member Functions | Protected Attributes
esphome::light::AddressableFireworksEffect Class Reference

#include <addressable_light_effect.h>

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

Public Member Functions

 AddressableFireworksEffect (const std::string &name)
void start () override
void apply (AddressableLight &it, const Color &current_color) override
void set_update_interval (uint32_t update_interval)
void set_spark_probability (float spark_probability)
void set_use_random_color (bool random_color)
void set_fade_out_rate (uint8_t fade_out_rate)
- 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)
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

uint8_t fade_out_rate_ {}
uint32_t update_interval_ {}
uint32_t last_update_ {0}
float spark_probability_ {}
bool use_random_color_ {}
- 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 283 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableFireworksEffect()

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

Definition at line 285 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

void esphome::light::AddressableFireworksEffect::apply ( AddressableLight it,
const Color current_color 

◆ set_fade_out_rate()

void esphome::light::AddressableFireworksEffect::set_fade_out_rate ( uint8_t  fade_out_rate)

Definition at line 322 of file addressable_light_effect.h.

◆ set_spark_probability()

void esphome::light::AddressableFireworksEffect::set_spark_probability ( float  spark_probability)

Definition at line 320 of file addressable_light_effect.h.

◆ set_update_interval()

void esphome::light::AddressableFireworksEffect::set_update_interval ( uint32_t  update_interval)

Definition at line 319 of file addressable_light_effect.h.

◆ set_use_random_color()

void esphome::light::AddressableFireworksEffect::set_use_random_color ( bool  random_color)

Definition at line 321 of file addressable_light_effect.h.

◆ start()

void esphome::light::AddressableFireworksEffect::start ( )

Reimplemented from esphome::light::LightEffect.

Definition at line 286 of file addressable_light_effect.h.

Field Documentation

◆ fade_out_rate_

uint8_t esphome::light::AddressableFireworksEffect::fade_out_rate_ {}

Definition at line 325 of file addressable_light_effect.h.

◆ last_update_

uint32_t esphome::light::AddressableFireworksEffect::last_update_ {0}

Definition at line 327 of file addressable_light_effect.h.

◆ spark_probability_

float esphome::light::AddressableFireworksEffect::spark_probability_ {}

Definition at line 328 of file addressable_light_effect.h.

◆ update_interval_

uint32_t esphome::light::AddressableFireworksEffect::update_interval_ {}

Definition at line 326 of file addressable_light_effect.h.

◆ use_random_color_

bool esphome::light::AddressableFireworksEffect::use_random_color_ {}

Definition at line 329 of file addressable_light_effect.h.

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