From 7a9f3d272b520c621cbe87ae682bd5cf9d06ae6b Mon Sep 17 00:00:00 2001 From: springstan <46536646+springstan@users.noreply.github.com> Date: Thu, 27 Feb 2020 13:22:51 +0100 Subject: [PATCH] Add available fan services to Integrations/Fan page (#12179) --- source/_integrations/fan.markdown | 100 +++++++++++++++++++++++++++++- 1 file changed, 99 insertions(+), 1 deletion(-) diff --git a/source/_integrations/fan.markdown b/source/_integrations/fan.markdown index 9b1bf7904659..ec68bd0c99a6 100644 --- a/source/_integrations/fan.markdown +++ b/source/_integrations/fan.markdown @@ -8,4 +8,102 @@ ha_release: 0.27 ha_quality_scale: internal --- -The `fan` integration is built for the controlling of fan devices. +The Fan integration allows you to control and monitor Fan devices. + +## Services + +### Fan control services + +Available services: +`fan.set_speed`, `fan.set_direction`, `fan.oscillate`, `fan.turn_on`, `fan.turn_off`, `fan.toggle` + +
+ +Not all fan services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking service developer tool icon **Services**. + +
+ +### Service `fan.set_speed` + +Sets the speed for fan device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. +| `speed` | no | Speed setting + +#### Automation example + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: fan.set_speed + data: + entity_id: fan.kitchen + speed: low +``` + +### Service `fan.set_direction` + +Sets the rotation for fan device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. +| `direction` | no | The direction to rotate. Either `forward` or `reverse` + +#### Automation example + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: fan.set_direction + data: + entity_id: fan.kitchen + direction: forward +``` + +### Service `fan.oscillate` + +Sets the oscillation for fan device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. +| `oscillating` | no | Flag to turn on/off oscillation. Either `True` or `False`. + +#### Automation example + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: fan.oscillate + data: + entity_id: fan.kitchen + oscillating: True +``` + +### Service `fan.turn_on` + +Turn fan device on. This is only supported if the fan device supports being turned off. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. + +### Service `fan.turn_off` + +Turn fan device off. This is only supported if the fan device supports being turned on. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. \ No newline at end of file