mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-09 18:36:29 +00:00
added fan doc (#229)
* added fan doc * Fix methods formatting * Formatting
This commit is contained in:
parent
c1898d87f4
commit
d05ac6be94
@ -3,7 +3,7 @@ title: Fan Entity
|
||||
sidebar_label: Fan
|
||||
---
|
||||
|
||||
> This entry is incomplete. Contribution welcome.
|
||||
A fan entity is a device that controls the different vetors of your fan susch as speed, direction and oscillation. Derive enitity platforms from ['homeassistant.components.fan.FanDevice'](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/fan/__init__.py).
|
||||
|
||||
## Properties
|
||||
|
||||
@ -11,6 +11,86 @@ sidebar_label: Fan
|
||||
|
||||
| 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 |
|
||||
| speed | str | None | Return the current speed |
|
||||
| speed_list | list | None| Get the list of available speeds |
|
||||
| state_attributes | dict | None | Return optional state attributes |
|
||||
| supported_features | int | None | Flag supported features |
|
||||
|
||||
|
||||
## Supported Features
|
||||
|
||||
| Constant | Description |
|
||||
|----------|--------------------------------------|
|
||||
| 'SUPPORT_DIRECTION' | The fan supports changing the direction of it.
|
||||
| 'SUPPORT_SET_SPEED' | The fan supports setting the speed.
|
||||
| 'SUPPORT_OSCILLATE' | The fan supports oscillation.
|
||||
|
||||
|
||||
|
||||
## Methods
|
||||
|
||||
### Set direction
|
||||
|
||||
Only implement this method if the flag `SUPPORT_DIRECTION` is set.
|
||||
|
||||
```python
|
||||
class FanEntity(ToggleEntity):
|
||||
# Implement one of these methods.
|
||||
|
||||
def set_direction(self, direction: str) -> None:
|
||||
"""Set the direction of the fan."""
|
||||
|
||||
async def async_set_direction(self, direction: str):
|
||||
"""Set the direction of the fan."""
|
||||
```
|
||||
|
||||
### Set speed
|
||||
|
||||
Only implement this method if the flag `SUPPORT_SET_SPEED` is set.
|
||||
|
||||
```python
|
||||
class FanEntity(ToggleEntity):
|
||||
# Implement one of these methods.
|
||||
|
||||
def set_speed(self, speed: str) -> None:
|
||||
"""Set the speed of the fan."""
|
||||
|
||||
async def async_set_speed(self, speed: str):
|
||||
"""Set the speed of the fan."""
|
||||
```
|
||||
|
||||
### Turn on
|
||||
|
||||
```python
|
||||
class FanEntity(ToggleEntity):
|
||||
# Implement one of these methods.
|
||||
|
||||
def turn_on(self, speed: str = None, **kwargs) -> None:
|
||||
"""Turn on the fan."""
|
||||
|
||||
async def async_turn_on(self, speed: str = None, **kwargs):
|
||||
"""Turn on the fan."""
|
||||
```
|
||||
|
||||
### Oscillate
|
||||
|
||||
Only implement this method if the flag `SUPPORT_OSCILLATE` is set.
|
||||
|
||||
```python
|
||||
class FanEntity(ToggleEntity):
|
||||
# Implement one of these methods.
|
||||
|
||||
def oscillate(self, oscillating: bool) -> None:
|
||||
"""Oscillate the fan."""
|
||||
|
||||
def async_oscillate(self, oscillating: bool):
|
||||
"""Oscillate the fan."""
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user