mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-07 09:43:08 +01:00
90 lines
3.5 KiB
ReStructuredText
90 lines
3.5 KiB
ReStructuredText
Neopixelbus Light
|
|
=================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up Neopixel addressable lights.
|
|
:image: color_lens.png
|
|
|
|
The ``neopixelbus`` light platform allows you to create RGB lights
|
|
in ESPHome for an individually addressable lights like NeoPixel or WS2812.
|
|
|
|
It is very similar to the :doc:`fastled` platform.
|
|
in fact most addressable lights are supported through both light platforms. The
|
|
difference is that they use different libraries: While the fastled platform uses
|
|
the `FastLED <https://github.com/FastLED/FastLED>`__ library, this integration uses
|
|
the `NeoPixelBus <https://github.com/Makuna/NeoPixelBus/>`__ library internally.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
light:
|
|
- platform: neopixelbus
|
|
type: GRB
|
|
pin: GPIO23
|
|
num_leds: 60
|
|
name: "NeoPixel Light"
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
**Base Options:**
|
|
|
|
- **name** (**Required**, string): The name of the light.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
|
|
**Type Options:**
|
|
|
|
- **type** (*Optional*, string): The type of light. This is used to specify
|
|
if it is an RGBW or RGB light and in which order the colors are. Defaults to
|
|
``GRB``. Change this if you have lights with white value and/or the colors are in the wrong order.
|
|
- **variant** (*Optional*, string): The chipset variant. You can read more about these
|
|
`here <https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neopixel-led-model-specific-methods>`__
|
|
(some of the info on that page is not entirely correct).
|
|
One of these values:
|
|
|
|
- ``800KBPS`` (default)
|
|
- ``400KBPS``
|
|
- ``WS2812X``
|
|
- ``SK6812``
|
|
- ``WS2813`` (same as ``WS2812X``)
|
|
- ``WS2812`` (same as ``800KBPS``)
|
|
- ``LC8812`` (same as ``SK6812``)
|
|
|
|
- **method** (*Optional*, string): The method to transmit the data with. You can read
|
|
more about these here: `ESP32 <https://github.com/Makuna/NeoPixelBus/wiki/ESP32-NeoMethods>`__,
|
|
`ESP8266 <https://github.com/Makuna/NeoPixelBus/wiki/ESP8266-NeoMethods>`__
|
|
|
|
- ``ESP8266_DMA`` (default for ESP8266, only on pin GPIO3)
|
|
- ``ESP8266_UART0`` (only on pin GPIO1)
|
|
- ``ESP8266_UART1`` (only on pin GPIO2)
|
|
- ``ESP8266_ASYNC_UART0`` (only on pin GPIO1)
|
|
- ``ESP8266_ASYNC_UART1`` (only on pin GPIO2)
|
|
- ``ESP32_I2S_0``
|
|
- ``ESP32_I2S_1`` (default for ESP32)
|
|
- ``BIT_BANG`` (can flicker a bit)
|
|
|
|
- **num_leds** (**Required**, int): The number of LEDs attached.
|
|
- **invert** (*Optional*, boolean): Invert data output, for use with n-type transistor. Defaults to ``no``.
|
|
|
|
**Pin Options:** Some chipsets have two data pins to connect, others only have one.
|
|
If you have one line, only specify ``pin``, otherwise specify both ``clock_pin`` and ``data_pin``.
|
|
|
|
- **pin** (**Required**, :ref:`config-pin`): The pin for the data line of the light.
|
|
- **clock_pin** (**Required**, :ref:`config-pin`): The pin for the clock line of the light, for two-pin lights.
|
|
- **data_pin** (**Required**, :ref:`config-pin`): The pin for the data line of the light, for two-pin lights.
|
|
|
|
**Advanced Options:**
|
|
|
|
- All other options from :ref:`Light <config-light>`.
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`/components/light/index`
|
|
- :doc:`/components/light/fastled`
|
|
- :doc:`/components/power_supply`
|
|
- :apiref:`neopixelbus/neopixelbus_light.h`
|
|
- `NeoPixelBus library <https://github.com/Makuna/NeoPixelBus/wiki/ESP8266-NeoMethods>`__
|
|
- :ghedit:`Edit`
|