ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
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 char *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 char *name)
 
void start_internal () override
 
void apply () override
 
uint32_t get_effect_index () const
 Get effect index specifically for addressable effects.
 
bool is_current_effect () const
 Check if this is the currently running addressable effect.
 
- Public Member Functions inherited from esphome::light::LightEffect
 LightEffect (const char *name)
 
StringRef get_name () const
 Returns the name of this effect.
 
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 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 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.
 

Protected Attributes

uint16_t port_ {0}
 
std::unique_ptr< UDP > udp_
 
optional< uint32_t > blank_start_ {}
 
uint32_t blank_timeout_ {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}
 
const char * name_
 

Detailed Description

Definition at line 16 of file wled_light_effect.h.

Constructor & Destructor Documentation

◆ WLEDLightEffect()

esphome::wled::WLEDLightEffect::WLEDLightEffect ( const char * 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 60 of file wled_light_effect.cpp.

◆ blank_all_leds_()

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

Definition at line 53 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 256 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 211 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 233 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 92 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 159 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 188 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 44 of file wled_light_effect.cpp.

Field Documentation

◆ blank_on_start_

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

Definition at line 42 of file wled_light_effect.h.

◆ blank_start_

optional<uint32_t> esphome::wled::WLEDLightEffect::blank_start_ {}
protected

Definition at line 38 of file wled_light_effect.h.

◆ blank_timeout_

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

Definition at line 39 of file wled_light_effect.h.

◆ dropped_

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

Definition at line 40 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 41 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.12.0