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

#include <base_light_effects.h>

Inheritance diagram for esphome::light::StrobeLightEffect:
esphome::light::LightEffect

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. More...
 
virtual void start_internal ()
 
virtual void stop ()
 Called when this effect is about to be removed. 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

std::vector< StrobeLightEffectColorcolors_
 
uint32_t last_switch_ {0}
 
size_t at_color_ {0}
 
- Protected Attributes inherited from esphome::light::LightEffect
LightStatestate_ {nullptr}
 
std::string name_
 

Detailed Description

Definition at line 156 of file base_light_effects.h.

Constructor & Destructor Documentation

◆ StrobeLightEffect()

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

Definition at line 158 of file base_light_effects.h.

Member Function Documentation

◆ apply()

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

Implements esphome::light::LightEffect.

Definition at line 159 of file base_light_effects.h.

◆ set_colors()

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

Definition at line 183 of file base_light_effects.h.

Field Documentation

◆ at_color_

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

Definition at line 188 of file base_light_effects.h.

◆ colors_

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

Definition at line 186 of file base_light_effects.h.

◆ last_switch_

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

Definition at line 187 of file base_light_effects.h.


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