jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-26 22:37:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/fan.markdown
Franck Nijhof 1ca5f87fd7
Sync codebase with docs for 0.117
2020-10-28 18:25:25 +01:00

3.0 KiB
Raw Blame History

title description ha_category ha_release ha_iot_class ha_quality_scale ha_domain
Fan Instructions on how to setup Fan devices within Home Assistant.
Fan
0.27 internal fan

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. You can check which services are available for your fan(s) under Developer Tools -> 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

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

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

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.