#include <led_strip.h>

Inheritance diagram for esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput:

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 (uint16_t num_leds)

void	set_is_rgbw (bool is_rgbw)

void	set_is_wrgb (bool is_wrgb)

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. More...

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	set_rmt_channel (rmt_channel_t channel)

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< LightTransformer >	create_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}

rmt_channel_handle_t	channel_ {nullptr}

rmt_encoder_handle_t	encoder_ {nullptr}

rmt_symbol_word_t *	rmt_buf_ {nullptr}

rmt_symbol_word_t	bit0_

rmt_symbol_word_t	bit1_

rmt_symbol_word_t	reset_

uint32_t	rmt_symbols_

rmt_item32_t *	rmt_buf_ {nullptr}

rmt_item32_t	bit0_

rmt_item32_t	bit1_

rmt_item32_t	reset_

rmt_channel_t	channel_ {RMT_CHANNEL_0}

uint8_t	pin_

uint16_t	num_leds_

bool	is_rgbw_

bool	is_wrgb_

bool	use_psram_

RGBOrder	rgb_order_

uint32_t	last_refresh_ {0}

optional< uint32_t >	max_refresh_rate_ {}

Protected Attributes inherited from esphome::light::AddressableLight
bool	effect_active_ {false}

ESPColorCorrection	correction_ {}

power_supply::PowerSupplyRequester	power_

LightState *	state_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 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 69 of file led_strip.h.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 249 of file led_strip.cpp.

◆ get_buffer_size_()

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

inlineprotected

Definition at line 79 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 286 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 204 of file led_strip.cpp.

◆ set_is_rgbw()

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

inline

Definition at line 52 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 53 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 114 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 57 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 51 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 62 of file led_strip.h.

◆ set_rmt_channel()

void esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::set_rmt_channel ( rmt_channel_t channel )

inline

Definition at line 66 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 64 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 54 of file led_strip.h.

◆ setup()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 24 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 135 of file led_strip.cpp.

Field Documentation

◆ bit0_ [1/2]

rmt_symbol_word_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::bit0_

protected

Definition at line 87 of file led_strip.h.

◆ bit0_ [2/2]

rmt_item32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::bit0_

protected

Definition at line 91 of file led_strip.h.

◆ bit1_ [1/2]

rmt_symbol_word_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::bit1_

protected

Definition at line 87 of file led_strip.h.

◆ bit1_ [2/2]

rmt_item32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::bit1_

protected

Definition at line 91 of file led_strip.h.

◆ buf_

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

protected

Definition at line 81 of file led_strip.h.

◆ channel_ [1/2]

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

protected

Definition at line 84 of file led_strip.h.

◆ channel_ [2/2]

rmt_channel_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::channel_ {RMT_CHANNEL_0}

protected

Definition at line 92 of file led_strip.h.

◆ effect_data_

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

protected

Definition at line 82 of file led_strip.h.

◆ encoder_

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

protected

Definition at line 85 of file led_strip.h.

◆ is_rgbw_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::is_rgbw_

protected

Definition at line 97 of file led_strip.h.

◆ is_wrgb_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::is_wrgb_

protected

Definition at line 98 of file led_strip.h.

◆ last_refresh_

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

protected

Definition at line 103 of file led_strip.h.

◆ max_refresh_rate_

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

protected

Definition at line 104 of file led_strip.h.

◆ num_leds_

uint16_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::num_leds_

protected

Definition at line 96 of file led_strip.h.

◆ pin_

uint8_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::pin_

protected

Definition at line 95 of file led_strip.h.

◆ reset_ [1/2]

rmt_symbol_word_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::reset_

protected

Definition at line 87 of file led_strip.h.

◆ reset_ [2/2]

rmt_item32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::reset_

protected

Definition at line 91 of file led_strip.h.

◆ rgb_order_

RGBOrder esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rgb_order_

protected

Definition at line 101 of file led_strip.h.

◆ rmt_buf_ [1/2]

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

protected

Definition at line 86 of file led_strip.h.

◆ rmt_buf_ [2/2]

rmt_item32_t* esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rmt_buf_ {nullptr}

protected

Definition at line 90 of file led_strip.h.

◆ rmt_symbols_

uint32_t esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::rmt_symbols_

protected

Definition at line 88 of file led_strip.h.

◆ use_psram_

bool esphome::esp32_rmt_led_strip::ESP32RMTLEDStripLightOutput::use_psram_

protected

Definition at line 99 of file led_strip.h.

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

/opt/build/esphome/esphome/components/esp32_rmt_led_strip/led_strip.h
/opt/build/esphome/esphome/components/esp32_rmt_led_strip/led_strip.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ clear_effect_data()

◆ dump_config()

◆ get_buffer_size_()

◆ get_setup_priority()

◆ get_traits()

◆ get_view_internal()

◆ set_is_rgbw()

◆ set_is_wrgb()

◆ set_led_params()

◆ set_max_refresh_rate()

◆ set_num_leds()

◆ set_pin()

◆ set_rgb_order()

◆ set_rmt_channel()

◆ set_rmt_symbols()

◆ set_use_psram()

◆ setup()

◆ size()

◆ write_state()

Field Documentation

◆ bit0_ [1/2]

◆ bit0_ [2/2]

◆ bit1_ [1/2]

◆ bit1_ [2/2]

◆ buf_

◆ channel_ [1/2]

◆ channel_ [2/2]

◆ effect_data_

◆ encoder_

◆ is_rgbw_

◆ is_wrgb_

◆ last_refresh_

◆ max_refresh_rate_

◆ num_leds_

◆ pin_

◆ reset_ [1/2]

◆ reset_ [2/2]

◆ rgb_order_

◆ rmt_buf_ [1/2]

◆ rmt_buf_ [2/2]

◆ rmt_symbols_

◆ use_psram_