Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

[fan] Tidy up name/id (#4144)

Browse Source
This commit is contained in:
Jesse Hills 2024-08-14 14:48:47 +12:00 committed by GitHub
parent d24b5602bf
commit f01798fede
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 2 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/fan/binary.rst
View File

@ -27,13 +27,10 @@ Configuration variables:
- **output** (**Required**, :ref:`config-id`): The id of the - **output** (**Required**, :ref:`config-id`): The id of the
binary output component to use for this fan. 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 - **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. :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 - **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. :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>`. - All other options from :ref:`Fan Component <config-fan>`.
See Also See Also

2
components/fan/hbridge.rst
View File

@ -46,8 +46,6 @@ Configuration variables:
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. The value is used - **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`` 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``. will allow 1% increments in the output. Defaults to ``100``.
- **name** (**Required**, string): The name for this fan.
- **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`). - **preset_modes** (*Optional*): A list of preset modes for this fan. Preset modes can be used in automations (i.e. `on_preset_set`).
- All other options from :ref:`Fan Component <config-fan>`. - All other options from :ref:`Fan Component <config-fan>`.

3
components/fan/index.rst
View File

@ -26,7 +26,8 @@ Base Fan Configuration
Configuration variables: Configuration variables:
- **name** (**Required**, string): The name of the fan. - **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
- **name** (*Optional*, string): The name of the fan. At least one of **id** and **name** must be specified.
.. note:: .. note::

2
components/fan/speed.rst
View File

@ -23,7 +23,6 @@ supports speed settings.
Configuration variables: Configuration variables:
------------------------ ------------------------
- **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. - **output** (**Required**, :ref:`config-id`): The id of the :ref:`float output <output>` to use for this fan.
- **oscillation_output** (*Optional*, :ref:`config-id`): The id of the - **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. :ref:`output <output>` to use for the oscillation state of this fan. Default is empty.
@ -32,7 +31,6 @@ Configuration variables:
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. The value is used - **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`` 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``. will allow 1% increments in the output. Defaults to ``100``.
- **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`). - **preset_modes** (*Optional*): A list of preset modes for this fan. Preset modes can be used in automations (i.e. `on_preset_set`).
- All other options from :ref:`Fan Component <config-fan>`. - All other options from :ref:`Fan Component <config-fan>`.

2
components/fan/template.rst
View File

@ -25,8 +25,6 @@ The ``template`` fan platform lets you create a fan interface using only trigger
Configuration variables: Configuration variables:
------------------------ ------------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (*Optional*, string): The name for this fan.
- **has_direction** (*Optional*, boolean): Indicates if there should be a control for direction. Default is ``false``. - **has_direction** (*Optional*, boolean): Indicates if there should be a control for direction. Default is ``false``.
- **has_oscillating** (*Optional*, boolean): Indicates if there should be a control for oscillating. Default is ``false``. - **has_oscillating** (*Optional*, boolean): Indicates if there should be a control for oscillating. Default is ``false``.
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. Default is only on/off. - **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. Default is only on/off.

2
components/fan/tuya.rst
View File

@ -49,8 +49,6 @@ Based on this, you can create the fan as follows:
Configuration variables: Configuration variables:
------------------------ ------------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the fan.
- **speed_datapoint** (**Required**, int): The datapoint id number of the fan speed. - **speed_datapoint** (**Required**, int): The datapoint id number of the fan speed.
- **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch. - **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch.
- **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation - **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation