ESPHome  2024.6.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput Class Reference

#include <led_strip.h>

Inheritance diagram for esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput:
esphome::light::AddressableLight esphome::light::LightOutput esphome::Component

Public Member Functions

void setup () override
 
void write_state (light::LightState *state) override
 
float get_setup_priority () const override
 
int32_t size () const override
 
light::LightTraits get_traits () override
 
void set_pin (uint8_t pin)
 
void set_num_leds (uint32_t num_leds)
 
void set_is_rgbw (bool is_rgbw)
 
void set_max_refresh_rate (float interval_us)
 
void set_pio (int pio_num)
 
void set_program (const pio_program_t *program)
 
void set_init_function (init_fn init)
 
void set_chipset (Chipset chipset)
 
void set_rgb_order (RGBOrder rgb_order)
 
void clear_effect_data () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::light::AddressableLight
ESPColorView operator[] (int32_t index) const
 
ESPColorView get (int32_t index)
 
ESPRangeView range (int32_t from, int32_t to)
 
ESPRangeView all ()
 
ESPRangeIterator begin ()
 
ESPRangeIterator end ()
 
void shift_left (int32_t amnt)
 
void shift_right (int32_t amnt)
 
bool is_effect_active () const
 
void set_effect_active (bool effect_active)
 
std::unique_ptr< LightTransformercreate_default_transition () override
 
void set_correction (float red, float green, float blue, float white=1.0f)
 
void setup_state (LightState *state) override
 
void update_state (LightState *state) override
 
void schedule_show ()
 
void set_power_supply (power_supply::PowerSupply *power_supply)
 
void call_setup () override
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

light::ESPColorView get_view_internal (int32_t index) const override
 
size_t get_buffer_size_ () const
 
- Protected Member Functions inherited from esphome::light::AddressableLight
void mark_shown_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

uint8_t * buf_ {nullptr}
 
uint8_t * effect_data_ {nullptr}
 
uint8_t pin_
 
uint32_t num_leds_
 
bool is_rgbw_
 
pio_hw_t * pio_
 
uint sm_
 
uint dma_chan_
 
dma_channel_config dma_config_
 
RGBOrder rgb_order_ {ORDER_RGB}
 
Chipset chipset_ {CHIPSET_CUSTOM}
 
uint32_t last_refresh_ {0}
 
float max_refresh_rate_
 
const pio_program_t * program_
 
init_fn init_
 
- Protected Attributes inherited from esphome::light::AddressableLight
bool effect_active_ {false}
 
ESPColorCorrection correction_ {}
 
power_supply::PowerSupplyRequester power_
 
LightStatestate_parent_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 60 of file led_strip.h.

Member Function Documentation

◆ clear_effect_data()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::clear_effect_data ( )
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 85 of file led_strip.h.

◆ dump_config()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 175 of file led_strip.cpp.

◆ get_buffer_size_()

size_t esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::get_buffer_size_ ( ) const
inlineprotected

Definition at line 96 of file led_strip.h.

◆ get_setup_priority()

float esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 184 of file led_strip.cpp.

◆ get_traits()

light::LightTraits esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::get_traits ( )
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 67 of file led_strip.h.

◆ get_view_internal()

light::ESPColorView esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::get_view_internal ( int32_t  index) const
overrideprotectedvirtual

Implements esphome::light::AddressableLight.

Definition at line 132 of file led_strip.cpp.

◆ set_chipset()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_chipset ( Chipset  chipset)
inline

Definition at line 83 of file led_strip.h.

◆ set_init_function()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_init_function ( init_fn  init)
inline

Definition at line 81 of file led_strip.h.

◆ set_is_rgbw()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_is_rgbw ( bool  is_rgbw)
inline

Definition at line 75 of file led_strip.h.

◆ set_max_refresh_rate()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_max_refresh_rate ( float  interval_us)
inline

Definition at line 77 of file led_strip.h.

◆ set_num_leds()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_num_leds ( uint32_t  num_leds)
inline

Definition at line 74 of file led_strip.h.

◆ set_pin()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_pin ( uint8_t  pin)
inline

Definition at line 73 of file led_strip.h.

◆ set_pio()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_pio ( int  pio_num)
inline

Definition at line 79 of file led_strip.h.

◆ set_program()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_program ( const pio_program_t *  program)
inline

Definition at line 80 of file led_strip.h.

◆ set_rgb_order()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::set_rgb_order ( RGBOrder  rgb_order)
inline

Definition at line 84 of file led_strip.h.

◆ setup()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 27 of file led_strip.cpp.

◆ size()

int32_t esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::size ( ) const
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 66 of file led_strip.h.

◆ write_state()

void esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::write_state ( light::LightState state)
overridevirtual

Implements esphome::light::LightOutput.

Definition at line 115 of file led_strip.cpp.

Field Documentation

◆ buf_

uint8_t* esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::buf_ {nullptr}
protected

Definition at line 98 of file led_strip.h.

◆ chipset_

Chipset esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::chipset_ {CHIPSET_CUSTOM}
protected

Definition at line 111 of file led_strip.h.

◆ dma_chan_

uint esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::dma_chan_
protected

Definition at line 107 of file led_strip.h.

◆ dma_config_

dma_channel_config esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::dma_config_
protected

Definition at line 108 of file led_strip.h.

◆ effect_data_

uint8_t* esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::effect_data_ {nullptr}
protected

Definition at line 99 of file led_strip.h.

◆ init_

init_fn esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::init_
protected

Definition at line 117 of file led_strip.h.

◆ is_rgbw_

bool esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::is_rgbw_
protected

Definition at line 103 of file led_strip.h.

◆ last_refresh_

uint32_t esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::last_refresh_ {0}
protected

Definition at line 113 of file led_strip.h.

◆ max_refresh_rate_

float esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::max_refresh_rate_
protected

Definition at line 114 of file led_strip.h.

◆ num_leds_

uint32_t esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::num_leds_
protected

Definition at line 102 of file led_strip.h.

◆ pin_

uint8_t esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::pin_
protected

Definition at line 101 of file led_strip.h.

◆ pio_

pio_hw_t* esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::pio_
protected

Definition at line 105 of file led_strip.h.

◆ program_

const pio_program_t* esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::program_
protected

Definition at line 116 of file led_strip.h.

◆ rgb_order_

RGBOrder esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::rgb_order_ {ORDER_RGB}
protected

Definition at line 110 of file led_strip.h.

◆ sm_

uint esphome::rp2040_pio_led_strip::RP2040PIOLEDStripLightOutput::sm_
protected

Definition at line 106 of file led_strip.h.


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