esphome-docs/components/light/spi_led_strip.rst

SPI LED Strip Light
===================

.. seo::
    :description: Instructions for setting up SPI LED RGB lights in ESPHome.
    :image: ../components/light/images/apa102.jpg

The ``spi_led_strip`` light platform drives one or more SPI interfaced RGB LEDs. These LEDs are often used in strips, where
each LED is individually addressable. This component requires an SPI interface to be configured.

This component has been tested with APA102 LEDs and the P9813 LED driver. It should also work with HD107 and SK9822 type
LEDs, or any others with a similar interface - SPI, 8 bits per colour and BGR ordering.

.. figure:: images/apa102.jpg
    :align: center
    :width: 75.0%

.. code-block:: yaml

    # Example configuration entry
    light:
      - platform: spi_led_strip
        num_leds: 30
        id: rgb_led
        name: "RGB LED Strip"
        data_rate: 1MHz

Color Correction
----------------

It is often favourable to calibrate/correct the color produced by an LED strip light as the
perceived intensity of different colors will generally vary. This can be done by using
``color_correct`` to adjust the relative brightness of the RGB components.

Configuration variables:
------------------------

- **name** (**Required**, string): The name of the light.
- **num_leds** (*Optional*, int): The number of LEDs attached. The default is 1.
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz``, ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz`` (default), ``200kHz``, ``75kHz`` or ``1kHz``.
- All other options from :ref:`Light <config-light>`.

You may also need to configure an ``output`` GPIO pin to control power to the LEDs, depending on your hardware. The
APA102 and friends do not have a ``CS`` input, and are write-only so the SPI ``miso`` pin should not be specified.

See Also
--------

.. figure:: images/rgb-detail.jpg
    :align: center
    :width: 75.0%

- :doc:`/components/light/index`
- :doc:`/components/output/ledc`
- :doc:`/components/output/esp8266_pwm`
- :doc:`/components/output/pca9685`
- :doc:`/components/output/tlc59208f`
- :doc:`/components/output/my9231`
- :doc:`/components/output/sm16716`
- :apiref:`rgb/rgb_light_output.h`
- :ghedit:`Edit`
SPI RGB LED component description (#3147) * APA102 description * Add note about miso * Rename apa102 to spi_rgb_led * Rename to spi_led_strip * Update TOC, add reference to SPI LED Strip in Fastled doc. * More cross-refs * Add image * Resize image * Format. * Formatting... 2023-09-11 04:20:15 +02:00			`SPI LED Strip Light`
			`===================`

			`.. seo::`
			`:description: Instructions for setting up SPI LED RGB lights in ESPHome.`
			`:image: ../components/light/images/apa102.jpg`

			The ``spi_led_strip`` light platform drives one or more SPI interfaced RGB LEDs. These LEDs are often used in strips, where
			`each LED is individually addressable. This component requires an SPI interface to be configured.`

Many example yaml tidy-ups (#3821) * Many example yaml tidy-ups * Update components/sensor/hlw8012.rst --------- Co-authored-by: Keith Burzinski <kbx81x@gmail.com> 2024-05-07 07:40:12 +02:00			`This component has been tested with APA102 LEDs and the P9813 LED driver. It should also work with HD107 and SK9822 type`
Update spi_led_strip.rst (#3408) Mention that the component also supports the `P9813` LED driver. 2023-11-28 11:06:58 +01:00			`LEDs, or any others with a similar interface - SPI, 8 bits per colour and BGR ordering.`
SPI RGB LED component description (#3147) * APA102 description * Add note about miso * Rename apa102 to spi_rgb_led * Rename to spi_led_strip * Update TOC, add reference to SPI LED Strip in Fastled doc. * More cross-refs * Add image * Resize image * Format. * Formatting... 2023-09-11 04:20:15 +02:00
			`.. figure:: images/apa102.jpg`
			`:align: center`
			`:width: 75.0%`

			`.. code-block:: yaml`

			`# Example configuration entry`
			`light:`
			`- platform: spi_led_strip`
			`num_leds: 30`
			`id: rgb_led`
			`name: "RGB LED Strip"`
			`data_rate: 1MHz`

			`Color Correction`
			`----------------`

			`It is often favourable to calibrate/correct the color produced by an LED strip light as the`
			`perceived intensity of different colors will generally vary. This can be done by using`
			``color_correct`` to adjust the relative brightness of the RGB components.

			`Configuration variables:`
			`------------------------`

			`- name (Required, string): The name of the light.`
			`- num_leds (Optional, int): The number of LEDs attached. The default is 1.`
			- effects (Optional, list): A list of :ref:`light effects <light-effects>` to use for this light.
			- id (Optional, :ref:`config-id`): Manually specify the ID used for code generation.
			- data_rate (Optional): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz``, ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz`` (default), ``200kHz``, ``75kHz`` or ``1kHz``.
			- All other options from :ref:`Light <config-light>`.

			You may also need to configure an ``output`` GPIO pin to control power to the LEDs, depending on your hardware. The
			APA102 and friends do not have a ``CS`` input, and are write-only so the SPI ``miso`` pin should not be specified.

			`See Also`
			`--------`

			`.. figure:: images/rgb-detail.jpg`
			`:align: center`
			`:width: 75.0%`

			- :doc:`/components/light/index`
			- :doc:`/components/output/ledc`
			- :doc:`/components/output/esp8266_pwm`
			- :doc:`/components/output/pca9685`
			- :doc:`/components/output/tlc59208f`
			- :doc:`/components/output/my9231`
			- :doc:`/components/output/sm16716`
			- :apiref:`rgb/rgb_light_output.h`
			- :ghedit:`Edit`