esphome-docs/components/light/beken_spi_led_strip.rst

60 lines
1.7 KiB
ReStructuredText

Beken SPI LED Strip
===================
.. seo::
:description: Instructions for setting up addressable lights like NEOPIXEL on a Beken chip using the SPI DMA interface.
:image: color_lens.svg
This is a component using the Beken SPI DMA interface to drive addressable LED strips.
.. warning::
Only works on pin P16, which is not available on many tuya modules.
.. code-block:: yaml
light:
- platform: beken_spi_led_strip
rgb_order: GRB
pin: P16
num_leds: 30
chipset: ws2812
name: "My Light"
Configuration variables
-----------------------
- **pin** (**Required**, :ref:`config-pin`): The pin for the data line of the light.
- **num_leds** (**Required**, int): The number of LEDs in the strip.
- **chipset** (**Required**, enum): The chipset to apply known timings from.
- ``WS2812``
- ``SK6812``
- ``APA106``
- ``SM16703``
- **rgb_order** (**Required**, string): The RGB order of the strip.
- ``RGB``
- ``RBG``
- ``GRB``
- ``GBR``
- ``BGR``
- ``BRG``
- **is_rgbw** (*Optional*, boolean): Set to ``true`` if the strip is RGBW. Defaults to ``false``.
- **is_wrgb** (*Optional*, boolean): Set to ``true`` if the strip is WRGB. Defaults to ``false``.
- **max_refresh_rate** (*Optional*, :ref:`config-time`):
A time interval used to limit the number of commands a light can handle per second. For example
16ms will limit the light to a refresh rate of about 60Hz. Defaults to sending commands as quickly as
changes are made to the lights.
- All other options from :ref:`Light <config-light>`.
See Also
--------
- :doc:`/components/light/index`
- :doc:`/components/power_supply`
- :apiref:`beken_spi_led_strip/beken_spi_led_strip.h`
- :ghedit:`Edit`