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 10:56:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Align documented fan attributes with implementation (#1920)

Browse Source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Erik Montnemery 2023-09-19 19:44:35 +02:00 committed by GitHub
parent 6dc1130eb3
commit aec0b612fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,14 +13,13 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| current_direction | str | `None` | Return the current direction of the fan |
| is_on | boolean | `None` |Return true if the entity is on |
| oscillating | boolean | None | Return true if the fan is oscillating |
| 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 |
| supported_features | int | 0 | Flag supported features |
| 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. |
| current_direction | <code>str &#124; None</code> | `None` | The current direction of the fan. |
| is_on | <code>bool &#124; None</code> | `None` | True if the fan is on. |
| oscillating | <code>bool &#124; None</code> | `None` | True if the fan is oscillating. |
| percentage | <code>int &#124; None</code> | `0` | The current speed percentage. Must be a value between 0 (off) and 100. |
| preset_mode | <code>str &#124; None</code> | `None` | The current preset_mode. One of the values in `preset_modes` or `None` if no preset is active. |
| preset_modes | <code>list[str] &#124; None</code> | `None` | The list of supported preset_modes. This is an arbitrary list of str and should not contain any speeds. |
| speed_count | `int` | 100 | The number of speeds the fan supports. |
### Preset Modes