Doco for hbridge component (#733)
bringing christmas lights into esphome
This commit is contained in:
parent
9ad506f538
commit
137f80ce69
|
@ -0,0 +1,59 @@
|
|||
H-bridge Light
|
||||
==============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up a hbridge light.
|
||||
:image: brightness-medium.png
|
||||
|
||||
The ``hbridge`` light platform creates a dual color brightness controlled light from two
|
||||
:ref:`float output component <output>`.
|
||||
|
||||
.. figure:: images/hbridge-ui.png
|
||||
:align: center
|
||||
:width: 40.0%
|
||||
|
||||
H-bridge lights are very common for Christmas lighting and they use 2 wires for a bunch of LEDs.
|
||||
The pins are switched alternatively to allow two sets of lights to operate.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
|
||||
# Specify the two pins of the h-bridge as PWM pins
|
||||
output:
|
||||
- platform: esp8266_pwm
|
||||
id: pina
|
||||
pin: GPIO12
|
||||
- platform: esp8266_pwm
|
||||
id: pinb
|
||||
pin: GPIO14
|
||||
|
||||
# Create a light using the hbridge
|
||||
light:
|
||||
- platform: hbridge
|
||||
id: mainlight
|
||||
name: "Hbridge Lights"
|
||||
pin_a: pina
|
||||
pin_b: pinb
|
||||
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- **name** (**Required**, string): The name of the light.
|
||||
- **pin_a** (**Required**, :ref:`config-id`): The id of the first float :ref:`output` to use for this light.
|
||||
- **pin_b** (**Required**, :ref:`config-id`): The id of the second float :ref:`output` to use for this light.
|
||||
- All other options from :ref:`Light <config-light>`.
|
||||
|
||||
.. note::
|
||||
|
||||
As we are switching the h-bridge in software, the light may glitch every so often when other tasks run on the MCU.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/light/index`
|
||||
- :doc:`/components/output/esp8266_pwm`
|
||||
- :apiref:`hbridge/light/hbridge_light.h`
|
||||
- :ghedit:`Edit`
|
Binary file not shown.
After Width: | Height: | Size: 9.1 KiB |
|
@ -235,6 +235,8 @@ Light Components
|
|||
Tuya Dimmer, components/light/tuya, tuya.png
|
||||
Custom Light, components/light/custom, language-cpp.svg
|
||||
|
||||
H-bridge Light, components/light/hbridge, brightness-medium.svg
|
||||
|
||||
Looking for WS2811 and similar individually addressable lights? Have a look at the
|
||||
:doc:`FastLED Light </components/light/fastled>`.
|
||||
|
||||
|
|
Loading…
Reference in New Issue