core/homeassistant/components/fan/services.yaml

56 lines
1.3 KiB
YAML
Raw Normal View History

# Describes the format for available fan services
set_speed:
description: Sets fan speed.
fields:
entity_id:
description: Name(s) of the entities to set
example: 'fan.living_room'
speed:
description: Speed setting
example: 'low'
turn_on:
description: Turns fan on.
fields:
entity_id:
description: Names(s) of the entities to turn on
example: 'fan.living_room'
speed:
description: Speed setting
example: 'high'
turn_off:
description: Turns fan off.
fields:
entity_id:
description: Names(s) of the entities to turn off
example: 'fan.living_room'
oscillate:
description: Oscillates the fan.
fields:
entity_id:
description: Name(s) of the entities to oscillate
example: 'fan.desk_fan'
oscillating:
description: Flag to turn on/off oscillation
example: True
toggle:
description: Toggle the fan on/off.
fields:
entity_id:
description: Name(s) of the entities to toggle
2019-10-07 17:41:26 +00:00
example: 'fan.living_room'
set_direction:
description: Set the fan rotation.
fields:
entity_id:
description: Name(s) of the entities to set
example: 'fan.living_room'
direction:
2018-05-13 12:41:42 +00:00
description: The direction to rotate. Either 'forward' or 'reverse'
example: 'forward'