#include <stdint.h>

Include dependency graph for led_strip_types.h:

This graph shows which files directly or indirectly include this file:

Classes
union	led_color_component_format_t
	LED color component format. More...

struct	led_color_component_format_t::format_layout

struct	led_strip_config_t
	LED Strip common configurations The common configurations are not specific to any backend peripheral. More...

struct	led_strip_config_t::led_strip_extra_flags

struct	led_strip_encoder_timings_t
	LED strip encoder timings. More...

Macros
#define	LED_STRIP_COLOR_COMPONENT_FMT_GRB (led_color_component_format_t){.format = {.r_pos = 1, .g_pos = 0, .b_pos = 2, .w_pos = 3, .reserved = 0, .num_components = 3}}
	Helper macros to set the color component format.

#define	LED_STRIP_COLOR_COMPONENT_FMT_GRBW (led_color_component_format_t){.format = {.r_pos = 1, .g_pos = 0, .b_pos = 2, .w_pos = 3, .reserved = 0, .num_components = 4}}

#define	LED_STRIP_COLOR_COMPONENT_FMT_RGB (led_color_component_format_t){.format = {.r_pos = 0, .g_pos = 1, .b_pos = 2, .w_pos = 3, .reserved = 0, .num_components = 3}}

#define	LED_STRIP_COLOR_COMPONENT_FMT_RGBW (led_color_component_format_t){.format = {.r_pos = 0, .g_pos = 1, .b_pos = 2, .w_pos = 3, .reserved = 0, .num_components = 4}}

Enumerations
enum	led_model_t { LED_MODEL_WS2812 , LED_MODEL_SK6812 , LED_MODEL_WS2811 , LED_MODEL_INVALID }
	LED strip model. More...

Class Documentation

◆ led_color_component_format_t

union led_color_component_format_t

Collaboration diagram for led_color_component_format_t:

Class Members
struct format_layout	format	Format layout
uint32_t	format_id	Format ID

struct led_color_component_format_t::format_layout

Class Members
uint32_t	b_pos: 2	Position of the blue channel in the color order: 0~3
uint32_t	g_pos: 2	Position of the green channel in the color order: 0~3
uint32_t	num_components: 3	Number of color components per pixel: 3 or 4. If set to 0, it will fallback to 3
uint32_t	r_pos: 2	Position of the red channel in the color order: 0~3
uint32_t	reserved: 21	Reserved
uint32_t	w_pos: 2	Position of the white channel in the color order: 0~3

struct led_strip_config_t

Collaboration diagram for led_strip_config_t:

Class Members
led_color_component_format_t	color_component_format	Specifies the order of color components in each pixel. Use helper macros like `LED_STRIP_COLOR_COMPONENT_FMT_GRB` to set the format LED strip extra driver flags
struct led_strip_extra_flags	flags	Extra driver flags
led_model_t	led_model	Specifies the LED strip model (e.g., WS2812, SK6812)
uint32_t	max_leds	Maximum number of LEDs that can be controlled in a single strip
int	strip_gpio_num	GPIO number that used by LED strip
led_strip_encoder_timings_t	timings	Encoder timings

struct led_strip_config_t::led_strip_extra_flags

Class Members
uint32_t	invert_out: 1	Invert output signal

struct led_strip_encoder_timings_t