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

#include <addressable_light_effect.h>

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

Public Member Functions

 AddressableScanEffect (const std::string &name)
 
void set_move_interval (uint32_t move_interval)
 
void set_scan_width (uint32_t scan_width)
 
void apply (AddressableLight &it, const Color &current_color) override
 
- 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 move_interval_ {}
 
uint32_t scan_width_ {1}
 
uint32_t last_move_ {0}
 
uint32_t at_led_ {0}
 
bool direction_ {true}
 
- 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 148 of file addressable_light_effect.h.

Constructor & Destructor Documentation

◆ AddressableScanEffect()

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

Definition at line 150 of file addressable_light_effect.h.

Member Function Documentation

◆ apply()

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

◆ set_move_interval()

void esphome::light::AddressableScanEffect::set_move_interval ( uint32_t  move_interval)
inline

Definition at line 151 of file addressable_light_effect.h.

◆ set_scan_width()

void esphome::light::AddressableScanEffect::set_scan_width ( uint32_t  scan_width)
inline

Definition at line 152 of file addressable_light_effect.h.

Field Documentation

◆ at_led_

uint32_t esphome::light::AddressableScanEffect::at_led_ {0}
protected

Definition at line 181 of file addressable_light_effect.h.

◆ direction_

bool esphome::light::AddressableScanEffect::direction_ {true}
protected

Definition at line 182 of file addressable_light_effect.h.

◆ last_move_

uint32_t esphome::light::AddressableScanEffect::last_move_ {0}
protected

Definition at line 180 of file addressable_light_effect.h.

◆ move_interval_

uint32_t esphome::light::AddressableScanEffect::move_interval_ {}
protected

Definition at line 178 of file addressable_light_effect.h.

◆ scan_width_

uint32_t esphome::light::AddressableScanEffect::scan_width_ {1}
protected

Definition at line 179 of file addressable_light_effect.h.


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