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-07-10 02:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve fan preset mode documentation (#828)

Browse Source
This commit is contained in:
J. Nick Koston 2021-03-04 18:18:47 -10:00 committed by GitHub
parent 806ce20e94
commit 300260c5c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -22,6 +22,12 @@ Properties should always only return information from memory and not do I/O (lik
| 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. |
| 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
A fan may have preset modes that automatically control the percentage speed or other functionality. Common examples include `auto`, `smart`, `whoosh`, `eco`, and `breeze`.
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.
## Deprecated Properties ## Deprecated Properties
The fan entity model has changed to use percentages in the range from 0 (off) to 100 instead The fan entity model has changed to use percentages in the range from 0 (off) to 100 instead