home-assistant.io/source/_integrations/fan.markdown

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_percentage, fan.set_preset_mode, fan.set_direction, fan.oscillate, fan.turn_on, fan.turn_off, fan.toggle, fan.increase_speed, fan.decrease_speed

Deprecated services: fan.set_speed

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_percentage

Sets the speed percentage 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.
percentage	no	Percentage speed setting

Automation example

automation:
  trigger:
    platform: time
    at: "07:15:00"
  action:
    - service: fan.set_percentage
      target:
        entity_id: fan.kitchen
      data:
        percentage: 33

Service fan.set_preset_mode

Sets a preset mode 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.
preset_mode	no	The preset mode

Automation example

automation:
  trigger:
    platform: time
    at: "07:15:00"
  action:
    - service: fan.set_preset_mode
      target:
        entity_id: fan.kitchen
      data:
        preset_mode: auto

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
      target:
        entity_id: fan.kitchen
      data:
        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
      target:
        entity_id: fan.kitchen
      data:
        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.
percentage	yes	Percentage speed setting
preset_mode	yes	The preset mode

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.

Deprecated 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
      target:
        entity_id: fan.kitchen
      data:
        speed: low

Service fan.increase_speed

Increases the speed of the 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.
percentage_step	yes	Increase speed by a percentage. Should be between 0..100.

Automation example

automation:
  trigger:
  - platform: device
    device_id: 097cd9f706a86e9163acb64ba7d630da
    domain: lutron_caseta
    type: press
    subtype: raise
  action:
  - service: fan.increase_speed
    target:
      entity_id: fan.dining_room_fan_by_front_door

Service fan.decrease_speed

Decreases the speed of the 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.
percentage_step	yes	Decrease speed by a percentage. Should be between 0..100.

Automation example

automation:
  trigger:
  - platform: device
    device_id: 097cd9f706a86e9163acb64ba7d630da
    domain: lutron_caseta
    type: press
    subtype: lower
  action:
  - service: fan.decrease_speed
    target:
      entity_id: fan.dining_room_fan_by_front_door