:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: worldsemi,ws2812-pulse-io
.. _dtbinding_worldsemi_ws2812_pulse_io:

worldsemi,ws2812-pulse-io
#########################

.. sidebar:: Overview

   :Name: ``worldsemi,ws2812-pulse-io``
   :Vendor: :ref:`Worldsemi Co., Limited <dt_vendor_worldsemi>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=worldsemi,ws2812-pulse-io>` using
               this compatible
   :Driver: :zephyr_file:`drivers/led_strip/ws2812_pulse_io.c`

Description
***********



.. code-block:: none

   Worldsemi WS2812 LED strip, pulse_io binding

   Drives a WS2812 (or compatible) LED strip through a pulse_io
   controller channel in CELL mode.

Examples
********

.. code-block:: dts

   / {
         led_strip: ws2812 {
             compatible = "worldsemi,ws2812-pulse-io";
             pulse-ios = <&rmt 0>;
             chain-length = <1>;
             color-mapping = <LED_COLOR_ID_GREEN
                              LED_COLOR_ID_RED
                              LED_COLOR_ID_BLUE>;
         };
   };


Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``pulse-ios``
           - ``phandle-array``
           - .. code-block:: none

                pulse_io controller and transmit channel driving the strip
                data line. The pin is routed through the controller pinctrl
                state.



             This property is **required**.

         * - ``reset-delay``
           - ``int``
           - .. code-block:: none

                Minimum delay to wait (in microseconds) to make sure that the strip has
                latched the signal. If omitted, a default value of 8 microseconds is used.
                This default is good for the WS2812 controllers. Note that despite the
                WS2812 datasheet states that a 50 microseconds delay is required, it seems
                6 microseconds is enough. The default is set to 8 microseconds just to be
                safe.



             Default value: ``8``

         * - ``chain-length``
           - ``int``
           - .. code-block:: none

                The number of devices in the daisy-chain.



             This property is **required**.

         * - ``color-mapping``
           - ``array``
           - .. code-block:: none

                Channel to color mapping (or pixel order).

                For example a GRB channel to color mapping would be

                   color-mapping = <LED_COLOR_ID_GREEN
                                    LED_COLOR_ID_RED
                                    LED_COLOR_ID_BLUE>;



             This property is **required**.



   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "worldsemi,ws2812-pulse-io" compatible.

      (None)