Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add documentation for new component BB1658CJ LED Driver (#2432)

This commit is contained in:
Cossid 2022-12-22 15:39:49 -06:00 committed by GitHub
parent 42baa49565
commit e73edf0fbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 170 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
components/output/bp1658cj.rst Normal file
View File

@ -0,0 +1,168 @@
BP1658CJ LED driver
===================
.. seo::
:description: Instructions for setting up BP1658CJ LED drivers in ESPHome.
:keywords: BP1658CJ, Orein OS0100411267 RGBCT Bulb
.. _bp1658cj-component:
Component/Hub
-------------
The BP1658CJ component represents a BP1658CJ 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 ``bp1658cj`` hub and give it an id, and then define the
:ref:`individual output channels <bp1658cj-output>`.
It is used in some smart light bulbs:
- Orein OS0100411267 RGBCT Bulb
.. code-block:: yaml
# Example configuration entry
bp1658cj:
data_pin: GPIO6
clock_pin: GPIO7
max_power_color_channels: 4 # Valid values 0-15
max_power_white_channels: 6 # Valid values 0-15
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 ``bp1658cj`` component. Use this if you have multiple BP1658CJ 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 BP1658CJ 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 BP1658CJ 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 | 0 mA |
+---------------------------------+-----------------+
| 1 | 5 mA |
+---------------------------------+-----------------+
| 2 | 10 mA |
+---------------------------------+-----------------+
| 3 | 15 mA |
+---------------------------------+-----------------+
| 4 | 20 mA |
+---------------------------------+-----------------+
| 5 | 25 mA |
+---------------------------------+-----------------+
| 6 | 30 mA (default) |
+---------------------------------+-----------------+
| 7 | 35 mA |
+---------------------------------+-----------------+
| 8 | 40 mA |
+---------------------------------+-----------------+
| 9 | 45 mA |
+---------------------------------+-----------------+
| 10 | 50 mA |
+---------------------------------+-----------------+
| 11 | 55 mA |
+---------------------------------+-----------------+
| 12 | 60 mA |
+---------------------------------+-----------------+
| 13 | 65 mA |
+---------------------------------+-----------------+
| 14 | 70 mA |
+---------------------------------+-----------------+
| 15 | 75 mA |
+---------------------------------+-----------------+
+---------------------------------+-----------------+
| max_power_color_channels value | actual current |
+=================================+=================+
| 0 | 0 mA |
+---------------------------------+-----------------+
| 1 | 10 mA |
+---------------------------------+-----------------+
| 2 | 20 mA |
+---------------------------------+-----------------+
| 3 | 30 mA |
+---------------------------------+-----------------+
| 4 | 40 mA (default) |
+---------------------------------+-----------------+
| 5 | 50 mA |
+---------------------------------+-----------------+
| 6 | 60 mA |
+---------------------------------+-----------------+
| 7 | 70 mA |
+---------------------------------+-----------------+
| 8 | 80 mA |
+---------------------------------+-----------------+
| 9 | 90 mA |
+---------------------------------+-----------------+
| 10 | 100 mA |
+---------------------------------+-----------------+
| 11 | 110 mA |
+---------------------------------+-----------------+
| 12 | 120 mA |
+---------------------------------+-----------------+
| 13 | 130 mA |
+---------------------------------+-----------------+
| 14 | 140 mA |
+---------------------------------+-----------------+
| 15 | 150 mA |
+---------------------------------+-----------------+
.. _bp1658cj-output:
Output
------
The BP1658CJ output component exposes a BP1658CJ channel of a global
:ref:`bp1658cj-component` as a float output.
.. code-block:: yaml
# Individual outputs
output:
- platform: bp1658cj
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 BP1658CJ chain of
this output component.
- **bp1658cj_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
:ref:`bp1658cj-component`.
Use this if you have multiple BP1658CJ 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`

1
images/bp1658cj.svg Normal file
View File

@ -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="15.867" y="46.914" style="fill:#fff;stroke-width:1.23645">BP1658CJ</tspan></text></svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.0 KiB

1
index.rst
View File

@ -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
BP1658CJ, components/output/bp1658cj, bp1658cj.svg
BP5758D, components/output/bp5758d, bp5758d.svg
Light Components