esphome-docs/components/fan/speed.rst

49 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Speed Fan
=========
2018-11-14 22:12:27 +01:00
.. seo::
:description: Instructions for setting up speed-controllable fans.
:image: fan.svg
2018-11-14 22:12:27 +01:00
2018-06-01 18:10:00 +02:00
The ``speed`` fan platform lets you represent any float :ref:`output` as a fan that
2018-05-13 11:37:02 +02:00
supports speed settings.
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
fan:
- platform: speed
2018-10-20 15:10:26 +02:00
output: my_output_1
2018-05-13 11:37:02 +02:00
name: "Living Room Fan"
Configuration variables:
2018-08-24 22:44:01 +02:00
------------------------
2018-05-13 11:37:02 +02:00
2024-02-25 19:22:50 +01:00
- **name** (*Optional*, string): The name for this fan.
- **output** (**Required**, :ref:`config-id`): The id of the :ref:`float output <output>` to use for this fan.
2018-06-01 18:10:00 +02:00
- **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.
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. The value is used
to calculate the percentages for each speed. E.g. ``2`` means that you have 50% and 100% while ``100``
will allow 1% increments in the output. Defaults to ``100``.
2018-06-01 18:10:00 +02:00
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **preset_modes** (*Optional*): A list of preset modes for this fan. Preset modes can be used in automations (i.e. `on_preset_set`).
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/fan/index`
- :doc:`/components/output/ledc`
- :doc:`/components/output/esp8266_pwm`
- :doc:`/components/output/pca9685`
- :apiref:`fan/fan_state.h`
- :ghedit:`Edit`