Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-10-31 08:31:29 +01:00
Code Issues Projects Releases Wiki Activity

Fan no off cycle action (#3283)

Browse Source 
Co-authored-by: H. Árkosi Róbert <robreg@zsurob.hu>
This commit is contained in:
Jordan W. Cobb 2023-10-19 03:02:32 -04:00 committed by GitHub
parent ee97ed1127
commit c8387c83fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/fan/index.rst
View File

@ -137,14 +137,22 @@ Configuration options:
``fan.cycle_speed`` Action
--------------------------
Increments through speed levels of the fan with the given ID when executed. If the fan's speed level is set to maximum when executed, turns fan off.
Increments through speed levels of the fan with the given ID when executed. If the fan's speed level is set to maximum when executed, fan will cycle off unless ``off_speed_cycle`` is set to ``false``.
.. code-block:: yaml
on_...:
then:
- fan.cycle_speed: fan_1
- fan.cycle_speed:
id: fan_1
off_speed_cycle: true
# Shorthand:
- fan.cycle_speed:: fan_1
Configuration options:
- **id** (**Required**, :ref:`config-id`): The ID of the fan.
- **off_speed_cycle** (*Optional*, boolean, :ref:`templatable <config-templatable>`): Determines if the fan will cycle off after cycling though its highest speed. Can be ``true`` or ``false``. If ``false`` fan will cycle to its lowest speed instead of turning off. Defaults to ``true``.
.. _fan-is_on_condition:
.. _fan-is_off_condition: