ESPHome  2022.9.1
Public Member Functions | Protected Attributes
esphome::light::AddressableRainbowLightEffect Class Reference

#include <addressable_light_effect.h>

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

Public Member Functions

 AddressableRainbowLightEffect (const std::string &name)
 
void apply (AddressableLight &it, const Color &current_color) override
 
void set_speed (uint32_t speed)
 
void set_width (uint16_t width)
 
- 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)
 
virtual void start ()
 Initialize this LightEffect. Will be called once after creation. 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

uint32_t speed_ {10}
 
uint16_t width_ {50}
 
- 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 74 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableRainbowLightEffect()

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

Definition at line 76 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

void esphome::light::AddressableRainbowLightEffect::apply ( AddressableLight it,
const Color current_color 
)
inlineoverridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 77 of file addressable_light_effect.h.

◆ set_speed()

void esphome::light::AddressableRainbowLightEffect::set_speed ( uint32_t  speed)
inline

Definition at line 90 of file addressable_light_effect.h.

◆ set_width()

void esphome::light::AddressableRainbowLightEffect::set_width ( uint16_t  width)
inline

Definition at line 91 of file addressable_light_effect.h.

Field Documentation

◆ speed_

uint32_t esphome::light::AddressableRainbowLightEffect::speed_ {10}
protected

Definition at line 94 of file addressable_light_effect.h.

◆ width_

uint16_t esphome::light::AddressableRainbowLightEffect::width_ {50}
protected

Definition at line 95 of file addressable_light_effect.h.


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