esphome-docs/components/fan/binary.rst
Jesse Hills 88e315e0e4
Many example yaml tidy-ups (#3821)
* Many example yaml tidy-ups

* Update components/sensor/hlw8012.rst

---------

Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
2024-05-07 00:40:12 -05:00

47 lines
1.2 KiB
ReStructuredText

Binary Fan
==========
.. seo::
:description: Instructions for setting up binary fans.
:image: fan.svg
The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan.
.. figure:: images/fan-ui.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
fan:
- platform: binary
output: fan_output
name: "Living Room Fan"
Configuration variables:
------------------------
- **output** (**Required**, :ref:`config-id`): The id of the
binary output component to use for this fan.
- **name** (**Required**, string): The name for this fan.
- **oscillation_output** (*Optional*, :ref:`config-id`): The id of the
:ref:`output <output>` to use for the oscillation state of this fan. Default is empty.
- **direction_output** (*Optional*, :ref:`config-id`): The id of the
:ref:`output <output>` to use for the direction state of the fan. Default is empty.
- **id** (*Optional*, :ref:`config-id`): Manually specify
the ID used for code generation.
- All other options from :ref:`Fan Component <config-fan>`.
See Also
--------
- :doc:`/components/output/index`
- :doc:`/components/output/gpio`
- :doc:`/components/fan/index`
- :apiref:`fan/fan_state.h`
- :ghedit:`Edit`