esp-idf/examples/common_components/led_strip/README.md

# LED Strip Component

This directory contains an implementation for addressable LEDs using the RMT peripheral.

It's compatible with:

* [WS2812](http://www.world-semi.com/Certifications/WS2812B.html)
* SK68XX

This component is used as part of the following ESP-IDF examples:
- [Blink Example](../../get-started/blink).
- [LED Strip Example](../../peripherals/rmt/led_strip).

To learn more about how to use this component, please check API Documentation from header file [led_strip.h](./include/led_strip.h).

Please note that this component is not considered to be a part of ESP-IDF stable API. It may change and it may be removed in the future releases.
Get started example update for addressable LED compatibility. Added the RMT/addr LED blink to the example and more detailed README.md Moved component/led_strip to common_components Added missing README file to common_components/led_strip README file update Makefile and Kconfig fixed for led_strip component Fixing end-of-line on main/blink.c Component updated to handle multiple instances Added note on the RMT channel number (ESP32 and ESP32-S2) Removed components folder from rmt/led_strip example and README updated Changed the led_strip_denit function and added ESP32-C3 RMT info on channel configuration Updates on README, Kconfig default settings and configure_led() function added 2021-01-29 13:20:40 -05:00			`# LED Strip Component`

			`This directory contains an implementation for addressable LEDs using the RMT peripheral.`

			`It's compatible with:`

			`* [WS2812](http://www.world-semi.com/Certifications/WS2812B.html)`
			`* SK68XX`

			`This component is used as part of the following ESP-IDF examples:`
			`- [Blink Example](../../get-started/blink).`
			`- [LED Strip Example](../../peripherals/rmt/led_strip).`

			`To learn more about how to use this component, please check API Documentation from header file [led_strip.h](./include/led_strip.h).`

			`Please note that this component is not considered to be a part of ESP-IDF stable API. It may change and it may be removed in the future releases.`