jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-06-17 15:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify fan preset_mode property (#1057)

Browse Source 
* Clarify fan preset_mode property

* Update fan.md

* Update fan.md
This commit is contained in:
Erik Montnemery 2021-09-20 13:57:20 +02:00 committed by GitHub
parent 657150b90a
commit ea7ec3b932
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/core/entity/fan.md
View File

@ -23,14 +23,14 @@ FanEntity does not support attribute shorthand for [property implementation](../
| percentage | int | None | Return the current speed percentage. Must be a value between 0 (off) and 100 | | percentage | int | None | Return the current speed percentage. Must be a value between 0 (off) and 100 |
| speed_count | int | 100 | The number of speeds the fan supports | | speed_count | int | 100 | The number of speeds the fan supports |
| supported_features | int | 0 | Flag supported features | | supported_features | int | 0 | Flag supported features |
| preset_mode | str | None | Return the current preset_mode. One of the values in preset_modes. | | preset_mode | str | None | Return the current preset_mode. One of the values in `preset_modes` or `None` if no preset is active. |
| preset_modes | list | None | Get the list of available preset_modes. This is an arbitrary list of str and should not contain any speeds. | | preset_modes | list | None | Get the list of available preset_modes. This is an arbitrary list of str and should not contain any speeds. |
### Preset Modes ### Preset Modes
A fan may have preset modes that automatically control the percentage speed or other functionality. Common examples include `auto`, `smart`, `whoosh`, `eco`, and `breeze`. A fan may have preset modes that automatically control the percentage speed or other functionality. Common examples include `auto`, `smart`, `whoosh`, `eco`, and `breeze`. If no preset mode is set, the `preset_mode` property must be set to `None`.
Manually setting a speed must disable a preset mode. If it is possible to set a percentage speed manually without disabling the preset mode, create a switch or service to represent the mode. Manually setting a speed must disable any set preset mode. If it is possible to set a percentage speed manually without disabling the preset mode, create a switch or service to represent the mode.
## Deprecated Properties ## Deprecated Properties