esphome-docs/components/fan/binary.rst

52 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Binary Fan
==========
2018-11-14 22:12:27 +01:00
.. seo::
:description: Instructions for setting up binary fans.
:image: fan.svg
2018-11-14 22:12:27 +01:00
2018-06-01 18:10:00 +02:00
The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan.
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
.. figure:: images/fan-ui.png
:align: center
:width: 80.0%
2018-05-13 11:37:02 +02:00
.. code-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
output:
- id: fan_output
platform: gpio
pin: GPIO16
2018-05-13 11:37:02 +02:00
fan:
- platform: binary
output: fan_output
2018-05-13 11:37:02 +02:00
name: "Living Room Fan"
2018-05-13 11:37:02 +02:00
Configuration variables:
2018-08-24 22:44:01 +02:00
------------------------
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **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.
2018-06-01 18:10:00 +02:00
- **id** (*Optional*, :ref:`config-id`): Manually specify
the ID used for code generation.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Fan Component <config-fan>`.
2018-06-01 18:10:00 +02:00
See Also
2018-08-24 22:44:01 +02:00
--------
2018-06-01 18:10:00 +02:00
- :doc:`/components/output/index`
- :doc:`/components/output/gpio`
- :doc:`/components/fan/index`
- :apiref:`fan/fan_state.h`
- :ghedit:`Edit`