Add documentation for new component BP5758D LED driver. (#2433)
This commit is contained in:
parent
0751e604f7
commit
42baa49565
|
@ -0,0 +1,93 @@
|
|||
BP5758D LED driver
|
||||
==================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up BP5758D LED drivers in ESPHome.
|
||||
:keywords: BP5758D, DoHome G25 Globe bulb
|
||||
|
||||
.. _bp5758d-component:
|
||||
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The BP5758D component represents a BP5758D LED diver 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 ``bp5758d`` hub and give it an id, and then define the
|
||||
:ref:`individual output channels <bp5758d-output>`.
|
||||
It is used in some smart light bulbs:
|
||||
|
||||
- DoHome G25 Globe bulb
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
bp5758d:
|
||||
data_pin: GPIO3
|
||||
clock_pin: GPIO5
|
||||
|
||||
|
||||
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 ``bp5758d`` component. Use this if you have multiple BP5758D chains
|
||||
connected at the same time.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _bp5758d-output:
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
The BP5758D output component exposes a BP5758D channel of a global
|
||||
:ref:`bp5758d-component` as a float output.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
output:
|
||||
- platform: bp5758d
|
||||
id: output_red
|
||||
channel: 2 # Valid values 1-5 to match OUT1-OUT5
|
||||
current: 10 # In mA, valid values 0-90, default 10
|
||||
|
||||
Configuration variables:
|
||||
************************
|
||||
|
||||
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
|
||||
- **channel** (**Required**, int): Chose the channel of the BP5758D chain of
|
||||
this output component. Valid values are 1-5
|
||||
**current** (*Optional*, int): Current in mA, valid values are 0-90, default 10.
|
||||
- **bp5758d_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
|
||||
:ref:`bp5758d-component`.
|
||||
Use this if you have multiple BP5758D 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/light/rgb`
|
||||
- :doc:`/components/light/rgbw`
|
||||
- :doc:`/components/light/rgbww`
|
||||
- :doc:`/components/power_supply`
|
||||
- :ghedit:`Edit`
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg10" width="260" height="61.333" version="1.1"><metadata id="metadata16"/><path id="path2" d="M20.456 1.6h219.3c10.31 0 18.667 8.357 18.667 18.667v20.666c0 10.31-8.358 18.667-18.667 18.667h-219.3c-10.31 0-18.667-8.357-18.667-18.667V20.267C1.79 9.957 10.146 1.6 20.456 1.6z"/><path id="path4" fill="none" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" stroke-width="1.333" d="M20.456 1.6h219.3c10.31 0 18.667 8.357 18.667 18.667v20.666c0 10.31-8.358 18.667-18.667 18.667h-219.3c-10.31 0-18.667-8.357-18.667-18.667V20.267C1.79 9.957 10.146 1.6 20.456 1.6z"/><text style="font-style:normal;font-weight:400;font-size:49.4582px;line-height:1.25;font-family:sans-serif;fill:#fff;fill-opacity:1;stroke:none;stroke-width:1.23645" id="text24" x="35.867" y="46.914" transform="scale(0.95547305,1.046602)" xml:space="preserve"><tspan id="tspan22" x="30.867" y="46.914" style="fill:#fff;stroke-width:1.23645">BP5758D</tspan></text></svg>
|
After Width: | Height: | Size: 1.0 KiB |
|
@ -443,6 +443,7 @@ Output Components
|
|||
Modbus Output, components/output/modbus_controller, modbus.png
|
||||
Custom Output, components/output/custom, language-cpp.svg
|
||||
Template Output, components/output/template, description.svg
|
||||
BP5758D, components/output/bp5758d, bp5758d.svg
|
||||
|
||||
Light Components
|
||||
----------------
|
||||
|
|
Loading…
Reference in New Issue