ESPHome 2026.5.3
Loading...
Searching...
No Matches
esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput Class Reference

#include <led_strip.h>

Inheritance diagram for esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput:
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_inverted (bool inverted)
 
void set_num_leds (uint16_t num_leds)
 
void set_is_rgbw (bool is_rgbw)
 
void set_is_wrgb (bool is_wrgb)
 
void set_use_dma (bool use_dma)
 
void set_use_psram (bool use_psram)
 
void set_max_refresh_rate (uint32_t interval_us)
 Set a maximum refresh rate in µs as some lights do not like being updated too often.
 
void set_led_params (uint32_t bit0_high, uint32_t bit0_low, uint32_t bit1_high, uint32_t bit1_low, uint32_t reset_time_high, uint32_t reset_time_low)
 
void set_rgb_order (RGBOrder rgb_order)
 
void set_rmt_symbols (uint32_t rmt_symbols)
 
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::light::LightOutput
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
void mark_failed (const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const char *name, uint32_t length=5000)
 Set warning status flag and automatically clear it after a timeout.
 
void status_momentary_error (const char *name, uint32_t length=5000)
 Set error status flag and automatically clear it after a timeout.
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

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
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time
 
ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)
 
 ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

uint8_t * buf_ {nullptr}
 
uint8_t * effect_data_ {nullptr}
 
LedParams params_
 
rmt_channel_handle_t channel_ {nullptr}
 
rmt_encoder_handle_t encoder_ {nullptr}
 
uint8_t * rmt_buf_ {nullptr}
 
rmt_symbol_word_t * rmt_buf_ {nullptr}
 
uint32_t rmt_symbols_ {48}
 
uint8_t pin_
 
uint16_t num_leds_
 
bool is_rgbw_ {false}
 
bool is_wrgb_ {false}
 
bool use_dma_ {false}
 
bool use_psram_ {false}
 
bool invert_out_ {false}
 
RGBOrder rgb_order_ {ORDER_RGB}
 
uint32_t last_refresh_ {0}
 
optional< uint32_tmax_refresh_rate_ {}
 
- Protected Attributes inherited from esphome::light::AddressableLight
ESPColorCorrection correction_ {}
 
LightStatestate_parent_ {nullptr}
 
power_supply::PowerSupplyRequester power_
 
bool effect_active_ {false}
 
- Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t initial_wait_time
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t max_attempts
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint32_t initial_wait_time
 
uint32_t uint8_t max_attempts
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint8_t max_attempts
 
uint8_t std::function< RetryResult(uint8_t)> && f
 
uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 

Detailed Description

Definition at line 33 of file led_strip.h.

Member Function Documentation

◆ clear_effect_data()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::clear_effect_data ( )
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 67 of file led_strip.h.

◆ dump_config()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 268 of file led_strip.cpp.

◆ get_buffer_size_()

size_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::get_buffer_size_ ( ) const
inlineprotected

Definition at line 77 of file led_strip.h.

◆ get_setup_priority()

float esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 305 of file led_strip.cpp.

◆ get_traits()

light::LightTraits esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::get_traits ( )
inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 40 of file led_strip.h.

◆ get_view_internal()

light::ESPColorView esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::get_view_internal ( int32_t index) const
overrideprotectedvirtual

Implements esphome::light::AddressableLight.

Definition at line 223 of file led_strip.cpp.

◆ set_inverted()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_inverted ( bool inverted)
inline

Definition at line 51 of file led_strip.h.

◆ set_is_rgbw()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_is_rgbw ( bool is_rgbw)
inline

Definition at line 53 of file led_strip.h.

◆ set_is_wrgb()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_is_wrgb ( bool is_wrgb)
inline

Definition at line 54 of file led_strip.h.

◆ set_led_params()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_led_params ( uint32_t bit0_high,
uint32_t bit0_low,
uint32_t bit1_high,
uint32_t bit1_low,
uint32_t reset_time_high,
uint32_t reset_time_low )

Definition at line 138 of file led_strip.cpp.

◆ set_max_refresh_rate()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_max_refresh_rate ( uint32_t interval_us)
inline

Set a maximum refresh rate in µs as some lights do not like being updated too often.

Definition at line 59 of file led_strip.h.

◆ set_num_leds()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_num_leds ( uint16_t num_leds)
inline

Definition at line 52 of file led_strip.h.

◆ set_pin()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_pin ( uint8_t pin)
inline

Definition at line 50 of file led_strip.h.

◆ set_rgb_order()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_rgb_order ( RGBOrder rgb_order)
inline

Definition at line 64 of file led_strip.h.

◆ set_rmt_symbols()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_rmt_symbols ( uint32_t rmt_symbols)
inline

Definition at line 65 of file led_strip.h.

◆ set_use_dma()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_use_dma ( bool use_dma)
inline

Definition at line 55 of file led_strip.h.

◆ set_use_psram()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_use_psram ( bool use_psram)
inline

Definition at line 56 of file led_strip.h.

◆ setup()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 65 of file led_strip.cpp.

◆ size()

int32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::size ( ) const
inlineoverridevirtual

Implements esphome::light::AddressableLight.

Definition at line 39 of file led_strip.h.

◆ write_state()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::write_state ( light::LightState * state)
overridevirtual

Implements esphome::light::LightOutput.

Definition at line 159 of file led_strip.cpp.

Field Documentation

◆ buf_

uint8_t* esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::buf_ {nullptr}
protected

Definition at line 79 of file led_strip.h.

◆ channel_

rmt_channel_handle_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::channel_ {nullptr}
protected

Definition at line 82 of file led_strip.h.

◆ effect_data_

uint8_t* esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::effect_data_ {nullptr}
protected

Definition at line 80 of file led_strip.h.

◆ encoder_

rmt_encoder_handle_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::encoder_ {nullptr}
protected

Definition at line 83 of file led_strip.h.

◆ invert_out_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::invert_out_ {false}
protected

Definition at line 96 of file led_strip.h.

◆ is_rgbw_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::is_rgbw_ {false}
protected

Definition at line 92 of file led_strip.h.

◆ is_wrgb_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::is_wrgb_ {false}
protected

Definition at line 93 of file led_strip.h.

◆ last_refresh_

uint32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::last_refresh_ {0}
protected

Definition at line 100 of file led_strip.h.

◆ max_refresh_rate_

optional<uint32_t> esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::max_refresh_rate_ {}
protected

Definition at line 101 of file led_strip.h.

◆ num_leds_

uint16_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::num_leds_
protected

Definition at line 91 of file led_strip.h.

◆ params_

LedParams esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::params_
protected

Definition at line 81 of file led_strip.h.

◆ pin_

uint8_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::pin_
protected

Definition at line 90 of file led_strip.h.

◆ rgb_order_

RGBOrder esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rgb_order_ {ORDER_RGB}
protected

Definition at line 98 of file led_strip.h.

◆ rmt_buf_ [1/2]

uint8_t* esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rmt_buf_ {nullptr}
protected

Definition at line 85 of file led_strip.h.

◆ rmt_buf_ [2/2]

rmt_symbol_word_t* esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rmt_buf_ {nullptr}
protected

Definition at line 87 of file led_strip.h.

◆ rmt_symbols_

uint32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rmt_symbols_ {48}
protected

Definition at line 89 of file led_strip.h.

◆ use_dma_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::use_dma_ {false}
protected

Definition at line 94 of file led_strip.h.

◆ use_psram_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::use_psram_ {false}
protected

Definition at line 95 of file led_strip.h.


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