-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for H-Bridge Switch (#4233)
* Add docs for H-Bridge Switch * optimistic mode * Update hbridge.rst --------- Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
- Loading branch information
Showing
4 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
H-bridge Switch | ||
=============== | ||
|
||
.. seo:: | ||
:description: Instructions for setting up H-Bridge controlled switches (or relays). | ||
:image: hbridge-relay.jpg | ||
|
||
The ``hbridge`` switch platform allows you to drive an *h-bridge* controlled latching relay. | ||
|
||
.. figure:: images/hbridge-relay.png | ||
:align: center | ||
:width: 50.0% | ||
|
||
Omron G6CK-2117P relay module. | ||
|
||
.. code-block:: yaml | ||
# Example configuration entry | ||
switch: | ||
- platform: hbridge | ||
id: my_relay | ||
name: "Relay" | ||
on_pin: GPIOXX | ||
off_pin: GPIOXX | ||
pulse_length: 50ms | ||
wait_time: 50ms | ||
Configuration variables: | ||
------------------------ | ||
|
||
- **on_pin** (**Required**, :ref:`config-pin_schema`): The GPIO pin to pulse to turn on the switch. | ||
- **off_pin** (**Required**, :ref:`config-pin_schema`): The GPIO pin to pulse to turn off the switch. | ||
- **pulse_length** (*Optional*, :ref:`config-time`): The length in milliseconds of the pulse sent on ``on_pin`` and ``off_pin`` to change switch state. Defaults to ``100 ms``. | ||
- **wait_time** (*Optional*, :ref:`config-time`): The time in milliseconds to delay between pulses on ``off_pin`` and ``on_pin``. Defaults to no delay. | ||
- **optimistic** (*optional*, boolean): Whether to operate in optimistic mode - when in this mode, | ||
any command sent to the switch will immediately update the reported state. Defaults to ``false``, and the reported state updates only at the end of the pulse. | ||
|
||
- All other options from :ref:`Switch Component <config-switch>`. | ||
|
||
See Also | ||
-------- | ||
|
||
- :doc:`/components/output/index` | ||
- :doc:`/components/switch/index` | ||
- :apiref:`hbridge/switch/hbridge_switch.h` | ||
- :ghedit:`Edit` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters