# LED Strip Driver [![Component Registry](]( This driver is designed for addressable LEDs like [WS2812](, where each LED is controlled by a single data line. ## Backend Controllers ### The [RMT]( Peripheral This is the most economical way to drive the LEDs because it only consumes one RMT channel, leaving other channels free to use. However, the memory usage increases dramatically with the number of LEDs. If the RMT hardware can't be assist by DMA, the driver will going into interrupt very frequently, thus result in a high CPU usage. What's worse, if the RMT interrupt is delayed or not serviced in time (e.g. if Wi-Fi interrupt happens on the same CPU core), the RMT transaction will be corrupted and the LEDs will display incorrect colors. If you want to use RMT to drive a large number of LEDs, you'd better to enable the DMA feature if possible. [^1] #### Allocate LED Strip Object with RMT Backend ```c #define BLINK_GPIO 0 led_strip_handle_t led_strip; /* LED strip initialization with the GPIO and pixels number*/ led_strip_config_t strip_config = { .strip_gpio_num = BLINK_GPIO, // The GPIO that connected to the LED strip's data line .max_leds = 1, // The number of LEDs in the strip, .led_pixel_format = LED_PIXEL_FORMAT_GRB, // Pixel format of your LED strip .led_model = LED_MODEL_WS2812, // LED strip model .flags.invert_out = false, // whether to invert the output signal (useful when your hardware has a level inverter) }; led_strip_rmt_config_t rmt_config = { .clk_src = RMT_CLK_SRC_DEFAULT, // different clock source can lead to different power consumption .resolution_hz = 10 * 1000 * 1000, // 10MHz .flags.with_dma = false, // whether to enable the DMA feature }; ESP_ERROR_CHECK(led_strip_new_rmt_device(&strip_config, &rmt_config, &led_strip)); ``` You can create multiple LED strip objects with different GPIOs and pixel numbers. The backend driver will automatically allocate the RMT channel for you if there is more available. [^1]: The DMA feature is not available on all ESP chips. Please check the data sheet before using it.


## 2.3.0 - Support configurable RMT channel size by setting `mem_block_symbols` ## 2.2.0 - Support for 4 components RGBW leds (SK6812): - in led_strip_config_t new fields led_pixel_format, controlling byte format (LED_PIXEL_FORMAT_GRB, LED_PIXEL_FORMAT_GRBW) led_model, used to configure bit timing (LED_MODEL_WS2812, LED_MODEL_SK6812) - new API led_strip_set_pixel_rgbw - new interface type set_pixel_rgbw ## 2.1.0 - Support DMA feature, which offloads the CPU by a lot when it comes to drive a bunch of LEDs - Support various RMT clock sources - Acquire and release the power management lock before and after each refresh - New driver flag: `invert_out` which can invert the led control signal by hardware ## 2.0.0 - Reimplemented the driver using the new RMT driver (`driver/rmt_tx.h`) ## 1.0.0 - Initial driver version, based on the legacy RMT driver (`driver/rmt.h`)

readme of led_strip_rmt_ws2812 example

# LED Strip Example (RMT backend + WS2812) This example demonstrates how to blink the WS2812 LED using the [led_strip]( component. ## How to Use Example ### Hardware Required * A development board with Espressif SoC * A USB cable for Power supply and programming * WS2812 LED strip ### Configure the Example Before project configuration and build, be sure to set the correct chip target using ` set-target <chip_name>`. Then assign the proper GPIO in the [source file](main/led_strip_rmt_ws2812_main.c). If your led strip has multiple LEDs, don't forget update the number. ### Build and Flash Run ` -p PORT build flash monitor` to build, flash and monitor the project. (To exit the serial monitor, type ``Ctrl-]``.) See the [Getting Started Guide]( for full steps to configure and use ESP-IDF to build projects. ## Example Output ```text I (299) gpio: GPIO[8]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0 I (309) example: Created LED strip object with RMT backend I (309) example: Start blinking LED strip ```


Supports all targets

License: Apache-2.0

To add this component to your project, run: add-dependency "espressif/led_strip^2.3.2"

or download archive


  • ESP-IDF >=5.0
  • Examples:


    more details


    • Downloaded in total
      Downloaded in total 466.5k times
    • Downloaded this version
      This version: 28.0k times


    espressif/led_strip version: 2.3.2 |