ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::wled::WLEDLightEffect Class Reference

#include <wled_light_effect.h>

Inheritance diagram for esphome::wled::WLEDLightEffect:
esphome::light::AddressableLightEffect esphome::light::LightEffect

Public Member Functions

 WLEDLightEffect (const std::string &name)
 
void start () override
 
void stop () override
 
void apply (light::AddressableLight &it, const Color &current_color) override
 
void set_port (uint16_t port)
 
void set_sync_group_mask (uint8_t mask)
 
void set_blank_on_start (bool blank)
 
- Public Member Functions inherited from esphome::light::AddressableLightEffect
 AddressableLightEffect (const std::string &name)
 
void start_internal () override
 
void apply () override
 
- 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. More...
 
void init_internal (LightState *state)
 

Protected Member Functions

void blank_all_leds_ (light::AddressableLight &it)
 
bool parse_frame_ (light::AddressableLight &it, const uint8_t *payload, uint16_t size)
 
bool parse_notifier_frame_ (light::AddressableLight &it, const uint8_t *payload, uint16_t size)
 
bool parse_warls_frame_ (light::AddressableLight &it, const uint8_t *payload, uint16_t size)
 
bool parse_drgb_frame_ (light::AddressableLight &it, const uint8_t *payload, uint16_t size)
 
bool parse_drgbw_frame_ (light::AddressableLight &it, const uint8_t *payload, uint16_t size)
 
bool parse_dnrgb_frame_ (light::AddressableLight &it, const uint8_t *payload, uint16_t size)
 
- Protected Member Functions inherited from esphome::light::AddressableLightEffect
AddressableLight * get_addressable_ () const
 

Protected Attributes

uint16_t port_ {0}
 
std::unique_ptr< UDP > udp_
 
uint32_t blank_at_ {0}
 
uint32_t dropped_ {0}
 
uint8_t sync_group_mask_ {0}
 
bool blank_on_start_ {true}
 
- Protected Attributes inherited from esphome::light::LightEffect
LightState * state_ {nullptr}
 
std::string name_
 

Detailed Description

Definition at line 16 of file wled_light_effect.h.

Constructor & Destructor Documentation

◆ WLEDLightEffect()

esphome::wled::WLEDLightEffect::WLEDLightEffect ( const std::string &  name)

Definition at line 31 of file wled_light_effect.cpp.

Member Function Documentation

◆ apply()

void esphome::wled::WLEDLightEffect::apply ( light::AddressableLight &  it,
const Color &  current_color 
)
overridevirtual

Implements esphome::light::AddressableLightEffect.

Definition at line 59 of file wled_light_effect.cpp.

◆ blank_all_leds_()

void esphome::wled::WLEDLightEffect::blank_all_leds_ ( light::AddressableLight &  it)
protected

Definition at line 52 of file wled_light_effect.cpp.

◆ parse_dnrgb_frame_()

bool esphome::wled::WLEDLightEffect::parse_dnrgb_frame_ ( light::AddressableLight &  it,
const uint8_t *  payload,
uint16_t  size 
)
protected

Definition at line 253 of file wled_light_effect.cpp.

◆ parse_drgb_frame_()

bool esphome::wled::WLEDLightEffect::parse_drgb_frame_ ( light::AddressableLight &  it,
const uint8_t *  payload,
uint16_t  size 
)
protected

Definition at line 208 of file wled_light_effect.cpp.

◆ parse_drgbw_frame_()

bool esphome::wled::WLEDLightEffect::parse_drgbw_frame_ ( light::AddressableLight &  it,
const uint8_t *  payload,
uint16_t  size 
)
protected

Definition at line 230 of file wled_light_effect.cpp.

◆ parse_frame_()

bool esphome::wled::WLEDLightEffect::parse_frame_ ( light::AddressableLight &  it,
const uint8_t *  payload,
uint16_t  size 
)
protected

Definition at line 91 of file wled_light_effect.cpp.

◆ parse_notifier_frame_()

bool esphome::wled::WLEDLightEffect::parse_notifier_frame_ ( light::AddressableLight &  it,
const uint8_t *  payload,
uint16_t  size 
)
protected

Definition at line 156 of file wled_light_effect.cpp.

◆ parse_warls_frame_()

bool esphome::wled::WLEDLightEffect::parse_warls_frame_ ( light::AddressableLight &  it,
const uint8_t *  payload,
uint16_t  size 
)
protected

Definition at line 185 of file wled_light_effect.cpp.

◆ set_blank_on_start()

void esphome::wled::WLEDLightEffect::set_blank_on_start ( bool  blank)
inline

Definition at line 25 of file wled_light_effect.h.

◆ set_port()

void esphome::wled::WLEDLightEffect::set_port ( uint16_t  port)
inline

Definition at line 23 of file wled_light_effect.h.

◆ set_sync_group_mask()

void esphome::wled::WLEDLightEffect::set_sync_group_mask ( uint8_t  mask)
inline

Definition at line 24 of file wled_light_effect.h.

◆ start()

void esphome::wled::WLEDLightEffect::start ( )
overridevirtual

Reimplemented from esphome::light::LightEffect.

Definition at line 33 of file wled_light_effect.cpp.

◆ stop()

void esphome::wled::WLEDLightEffect::stop ( )
overridevirtual

Reimplemented from esphome::light::AddressableLightEffect.

Definition at line 43 of file wled_light_effect.cpp.

Field Documentation

◆ blank_at_

uint32_t esphome::wled::WLEDLightEffect::blank_at_ {0}
protected

Definition at line 38 of file wled_light_effect.h.

◆ blank_on_start_

bool esphome::wled::WLEDLightEffect::blank_on_start_ {true}
protected

Definition at line 41 of file wled_light_effect.h.

◆ dropped_

uint32_t esphome::wled::WLEDLightEffect::dropped_ {0}
protected

Definition at line 39 of file wled_light_effect.h.

◆ port_

uint16_t esphome::wled::WLEDLightEffect::port_ {0}
protected

Definition at line 36 of file wled_light_effect.h.

◆ sync_group_mask_

uint8_t esphome::wled::WLEDLightEffect::sync_group_mask_ {0}
protected

Definition at line 40 of file wled_light_effect.h.

◆ udp_

std::unique_ptr<UDP> esphome::wled::WLEDLightEffect::udp_
protected

Definition at line 37 of file wled_light_effect.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13