esphome::light::StrobeLightEffect Class Reference

#include <base_light_effects.h>

Inheritance diagram for esphome::light::StrobeLightEffect:

Public Member Functions
	StrobeLightEffect (const std::string &name)
void	apply () override
void	set_colors (const std::vector< StrobeLightEffectColor > &colors)
Public Member Functions inherited from esphome::light::LightEffect
	LightEffect (std::string name)
virtual void	start ()
	Initialize this LightEffect. Will be called once after creation.
virtual void	start_internal ()
virtual void	stop ()
	Called when this effect is about to be removed.
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
std::vector< StrobeLightEffectColor >	colors_
uint32_t	last_switch_ {0}
size_t	at_color_ {0}
Protected Attributes inherited from esphome::light::LightEffect
LightState *	state_ {nullptr}
std::string	name_

Additional Inherited Members
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 164 of file base_light_effects.h.

Constructor & Destructor Documentation

StrobeLightEffect()

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

inlineexplicit

Definition at line 166 of file base_light_effects.h.

Member Function Documentation

apply()

void esphome::light::StrobeLightEffect::apply ( )

inlineoverridevirtual

Implements esphome::light::LightEffect.

Definition at line 167 of file base_light_effects.h.

set_colors()

void esphome::light::StrobeLightEffect::set_colors ( const std::vector< StrobeLightEffectColor > & colors )

inline

Definition at line 191 of file base_light_effects.h.

Field Documentation

at_color_

size_t esphome::light::StrobeLightEffect::at_color_ {0}

protected

Definition at line 196 of file base_light_effects.h.

colors_

std::vector<StrobeLightEffectColor> esphome::light::StrobeLightEffect::colors_

protected

Definition at line 194 of file base_light_effects.h.

last_switch_

uint32_t esphome::light::StrobeLightEffect::last_switch_ {0}

protected

Definition at line 195 of file base_light_effects.h.

---

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

• esphome/components/light/base_light_effects.h