From 42baa49565036c5a47e52a84cfe7fdd8ec1f75d8 Mon Sep 17 00:00:00 2001 From: Cossid <83468485+Cossid@users.noreply.github.com> Date: Thu, 22 Dec 2022 15:24:52 -0600 Subject: [PATCH] Add documentation for new component BP5758D LED driver. (#2433) --- components/output/bp5758d.rst | 93 +++++++++++++++++++++++++++++++++++ images/bp5758d.svg | 1 + index.rst | 1 + 3 files changed, 95 insertions(+) create mode 100644 components/output/bp5758d.rst create mode 100644 images/bp5758d.svg diff --git a/components/output/bp5758d.rst b/components/output/bp5758d.rst new file mode 100644 index 000000000..6cd42d023 --- /dev/null +++ b/components/output/bp5758d.rst @@ -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 `. +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 `): The pin used for DATA. +- **clock_pin** (**Required**, :ref:`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 `. + +.. 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` diff --git a/images/bp5758d.svg b/images/bp5758d.svg new file mode 100644 index 000000000..e0a9d8980 --- /dev/null +++ b/images/bp5758d.svg @@ -0,0 +1 @@ +BP5758D \ No newline at end of file diff --git a/index.rst b/index.rst index 3536fc6b0..617b7a913 100644 --- a/index.rst +++ b/index.rst @@ -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 ----------------