core/homeassistant/components/fan/services.yaml

207 lines
5.4 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
exampl: 'fan.living_room'
set_direction:
description: Set the fan rotation.
fields:
entity_id:
description: Name(s) of the entities to toggle
example: 'fan.living_room'
direction:
description: The direction to rotate
example: 'left'
dyson_set_night_mode:
description: Set the fan in night mode.
fields:
entity_id:
description: Name(s) of the entities to enable/disable night mode
example: 'fan.living_room'
night_mode:
description: Night mode status
example: true
xiaomi_miio_set_buzzer_on:
description: Turn the buzzer on.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_buzzer_off:
description: Turn the buzzer off.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_led_on:
description: Turn the led on.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_led_off:
description: Turn the led off.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_child_lock_on:
description: Turn the child lock on.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_child_lock_off:
description: Turn the child lock off.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_favorite_level:
description: Set the favorite level.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
level:
description: Level, between 0 and 16.
example: 1
xiaomi_miio_set_led_brightness:
description: Set the led brightness.
fields:
entity_id:
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
brightness:
description: Brightness (0 = Bright, 1 = Dim, 2 = Off)
example: 1
Xiaomi MiIO Fan: Xiaomi Air Humidifier integration (#12627) * Device support for the Xiaomi Air Humidifier. * Requirements updated. * "continuation line under-indented for visual indent" fixed. * Make hound happy. * Inadvertently added light.xiaomi_miio component removed from PR. * Service descriptions added. * One of the pylint errors fixed. * Redundancy removed. * pylint: disable=no-self-use added. The method signature is important here. * Pylint fixed. * Use a unique data key per domain. * Review incorporated. * Map of available attributes added. * Pylint fixed. Attribute "volume" added. * Don't use the support flag bit mask as model identifier. Determine support features and attributes at the constructor. Use starred expressions at dicts instead of copies. * Blank line removed. * Use Async / await syntax. * Make hound happy. * Xiaomi Air Humidifier CA support added. * Duplicate method removed. * Air Purifier V3 support added. * Don't abuse the system property supported_features anymore. * python-miio version bumped. * Clean-up. * Additional supported features refactoring completed. * Additional supported features renamed properly. * Unique id added. * Device unavailable handling improved. * Refactoring. * Missed const updated. * Incomplete Air Humidifier CA support fixed. * Review incorporated * The Air Humidifier CA supports the operation mode "auto" - the standard version doesn't * Attributes are part of the common set already * Revert "Attributes are part of the common set already" This reverts commit 40b443eba0e2fc55075479fd540f977fbf4b704a. * Comment added * Service description of the set_dry_{on,off} service added * Typo fixed
2018-03-24 22:04:43 +00:00
xiaomi_miio_set_auto_detect_on:
description: Turn the auto detect on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_auto_detect_off:
description: Turn the auto detect off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_learn_mode_on:
description: Turn the learn mode on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_learn_mode_off:
description: Turn the learn mode off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_volume:
description: Set the sound volume.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
volume:
description: Volume, between 0 and 100.
example: 50
xiaomi_miio_reset_filter:
description: Reset the filter lifetime and usage.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_extra_features:
description: Manipulates a storage register which advertises extra features. The Mi Home app evaluates the value. A feature called "turbo mode" is unlocked in the app on value 1.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
features:
description: Integer, known values are 0 (default) and 1 (turbo mode).
example: 1
xiaomi_miio_set_target_humidity:
description: Set the target humidity.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
humidity:
description: Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80.
example: 50
xiaomi_miio_set_dry_on:
description: Turn the dry mode on.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'
xiaomi_miio_set_dry_off:
description: Turn the dry mode off.
fields:
entity_id:
description: Name of the xiaomi miio entity.
example: 'fan.xiaomi_miio_device'