esphome-docs/components/output/sm2235.rst

SM2235 LED driver
==================

.. seo::
    :description: Instructions for setting up SM2235 LED drivers in ESPHome.
    :keywords: SM2235

.. _sm2235-component:

Component/Hub
-------------

The SM2235 component represents a SM2235 LED driver chain in
ESPHome. Communication is done with two GPIO pins (DATA and CLK).

To use the channels of this components, you first need to setup the
global ``sm2235`` hub and give it an id, and then define the
:ref:`individual output channels <sm2235-output>`.

.. code-block:: yaml

    # Example configuration entry
    sm2235:
      data_pin: GPIO4
      clock_pin: GPIO5
      max_power_color_channels: 9
      max_power_white_channels: 9

Configuration variables:
************************

-  **data_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin used for DATA.
-  **clock_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin which CLK is
   connected to.
-  **id** (*Optional*, :ref:`config-id`): The id to use for
   this ``sm2235`` component. Use this if you have multiple SM2235 chains
   connected at the same time.
-  **max_power_color_channels** (*Optional*, int 0-15): Adjusts the current supplied to the
   color channels, higher is more power.  Default is 2 per SM2235 datasheet. See table below.
-  **max_power_white_channels** (*Optional*, int 0-15): Adjusts the current supplied to the
   white channels, higher is more power.  Default is 4 per SM2235 datasheet. See table below.

.. note::

    The LED driver may be able to tolerate more power than
    the bulb is designed to handle, start with lower values
    and increase slowly, comparing to a stock bulb to verify
    what is safe for your model.

+---------------------------------+-----------------+
| max_power_white_channels value  | actual current  |
+=================================+=================+
| 0                               | 5 mA            |
+---------------------------------+-----------------+
| 1                               | 10 mA           |
+---------------------------------+-----------------+
| 2                               | 15 mA           |
+---------------------------------+-----------------+
| 3                               | 20 mA           |
+---------------------------------+-----------------+
| 4                               | 25 mA (default) |
+---------------------------------+-----------------+
| 5                               | 30 mA           |
+---------------------------------+-----------------+
| 6                               | 35 mA           |
+---------------------------------+-----------------+
| 7                               | 40 mA           |
+---------------------------------+-----------------+
| 8                               | 45 mA           |
+---------------------------------+-----------------+
| 9                               | 50 mA           |
+---------------------------------+-----------------+
| 10                              | 55 mA           |
+---------------------------------+-----------------+
| 11                              | 60 mA           |
+---------------------------------+-----------------+
| 12                              | 65 mA           |
+---------------------------------+-----------------+
| 13                              | 70 mA           |
+---------------------------------+-----------------+
| 14                              | 75 mA           |
+---------------------------------+-----------------+
| 15                              | 80 mA           |
+---------------------------------+-----------------+

+---------------------------------+-----------------+
| max_power_color_channels value  | actual current  |
+=================================+=================+
| 0                               | 4 mA            |
+---------------------------------+-----------------+
| 1                               | 8 mA            |
+---------------------------------+-----------------+
| 2                               | 12 mA (default) |
+---------------------------------+-----------------+
| 3                               | 16 mA           |
+---------------------------------+-----------------+
| 4                               | 20 mA           |
+---------------------------------+-----------------+
| 5                               | 24 mA           |
+---------------------------------+-----------------+
| 6                               | 28 mA           |
+---------------------------------+-----------------+
| 7                               | 32 mA           |
+---------------------------------+-----------------+
| 8                               | 36 mA           |
+---------------------------------+-----------------+
| 9                               | 40 mA           |
+---------------------------------+-----------------+
| 10                              | 44 mA           |
+---------------------------------+-----------------+
| 11                              | 48 mA           |
+---------------------------------+-----------------+
| 12                              | 52 mA           |
+---------------------------------+-----------------+
| 13                              | 56 mA           |
+---------------------------------+-----------------+
| 14                              | 60 mA           |
+---------------------------------+-----------------+
| 15                              | 64 mA           |
+---------------------------------+-----------------+

.. _sm2235-output:

Output
------

The SM2235 output component exposes a SM2235 channel of a global
:ref:`sm2235-component` as a float output.

.. code-block:: yaml

    # Individual outputs
    output:
      - platform: sm2235
        id: output_red
        channel: 1

Configuration variables:
************************

- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **channel** (**Required**, int): Chose the channel of the SM2235 chain of
  this output component.
- **sm2235_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
  :ref:`sm2235-component`.
  Use this if you have multiple SM2235 chains you want to use at the same time.
- All other options from :ref:`Output <config-output>`.

.. note::

    This driver does support enabling of both the color and the white channels
    at the same time, but it is not encourage. Therefore, the :ref:`rgbw_color_interlock`
    should be set to true when using this driver for safest operation.

See Also
--------

- :doc:`/components/output/index`
- :doc:`/components/output/esp8266_pwm`
- :doc:`/components/output/sm2135`
- :doc:`/components/output/sm2335`
- :doc:`/components/light/rgb`
- :doc:`/components/light/rgbw`
- :doc:`/components/light/rgbww`
- :doc:`/components/power_supply`
- :apiref:`output/sm2235_output_component.h`
- :ghedit:`Edit`