Home Assistant

Fan

The fan integration allows you to control and monitor fan devices.

Building block integration

This fan is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.

A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this fan building block to provide entities, services, and other functionality that you can use in your automations or dashboards.

If one of your integrations features this building block, this page documents the functionality the fan building block offers.

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

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 the fan device. Available preset modes are defined by the integration that supplies the fan entity to Home Assistant. For example, the ESPHome Speed Fan component provides three available presets by default: Low, Medium, and High.

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. See a similar example under fan.turn_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.

Automation example

automation:
  trigger:
    platform: time
    at: "07:15:00"
  action:
    - service: fan.turn_off
      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