esphome::light::AddressableFireworksEffect Class Reference

#include <addressable_light_effect.h>

Inheritance diagram for esphome::light::AddressableFireworksEffect:

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
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)
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.
LightState *	get_light_state () const
	Get a reference to the parent light 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
LightState *	state_ {nullptr}
std::string	name_

Additional Inherited Members
Protected Member Functions inherited from esphome::light::AddressableLightEffect
AddressableLight *	get_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 294 of file addressable_light_effect.h.

Constructor & Destructor Documentation

AddressableFireworksEffect()

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

inlineexplicit

Definition at line 296 of file addressable_light_effect.h.

Member Function Documentation

apply()

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

inlineoverridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 301 of file addressable_light_effect.h.

set_fade_out_rate()

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

inline

Definition at line 333 of file addressable_light_effect.h.

set_spark_probability()

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

inline

Definition at line 331 of file addressable_light_effect.h.

set_update_interval()

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

inline

Definition at line 330 of file addressable_light_effect.h.

set_use_random_color()

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

inline

Definition at line 332 of file addressable_light_effect.h.

start()

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

inlineoverridevirtual

Reimplemented from esphome::light::LightEffect.

Definition at line 297 of file addressable_light_effect.h.

Field Documentation

fade_out_rate_

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

protected

Definition at line 336 of file addressable_light_effect.h.

last_update_

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

protected

Definition at line 338 of file addressable_light_effect.h.

spark_probability_

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

protected

Definition at line 339 of file addressable_light_effect.h.

update_interval_

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

protected

Definition at line 337 of file addressable_light_effect.h.

use_random_color_

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

protected

Definition at line 340 of file addressable_light_effect.h.

---

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

• esphome/components/light/addressable_light_effect.h