: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:: pwm-leds
.. _dtbinding_pwm_leds:

pwm-leds
########

Vendor: :ref:`Generic or vendor-independent <dt_no_vendor>`

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`drivers/led/led_pwm.c`.

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



.. code-block:: none

   Group of PWM-controlled LEDs.

   Each LED is defined in a child node of the pwm-leds node.

Properties
**********

Top level properties
====================

No top-level properties.

Child node properties
=====================

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

   * - Name
     - Type
     - Details

   * - ``pwms``
     - ``phandle-array``
     - .. code-block:: none

          Reference to a PWM instance.

          The period field is used by the set_brightness function of the LED API.
          Its value should at least be greater that 100 nanoseconds (for a full
          brigtness granularity) and lesser than 50 milliseconds (average visual
          persistence time of the human eye). Typical values for the PWM period
          are 10 or 20 milliseconds.



       This property is **required**.

   * - ``label``
     - ``string``
     - .. code-block:: none

          Human readable string describing the LED. It can be used by an
          application to identify this LED or to retrieve its number/index
          (i.e. child node number) on the parent device.



       See :ref:`zephyr:dt-important-props` for more information.