Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add selectors to Vacuum service definitions (#46728)

pull/46751/head
Franck Nijhof 2021-02-18 16:13:52 +01:00 committed by GitHub
parent bfa171f802
commit 74720d4afd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
homeassistant/components/vacuum/services.yaml
View File

@ -1,87 +1,70 @@
# Describes the format for available vacuum services # Describes the format for available vacuum services
turn_on: turn_on:
description: Start a new cleaning task. description: Start a new cleaning task
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
turn_off: turn_off:
description: Stop the current cleaning task and return to home. description: Stop the current cleaning task and return to home
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
stop: stop:
description: Stop the current cleaning task. description: Stop the current cleaning task
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
locate: locate:
description: Locate the vacuum cleaner robot. description: Locate the vacuum cleaner robot
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
start_pause: start_pause:
description: Start, pause, or resume the cleaning task. description: Start, pause, or resume the cleaning task
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
start: start:
description: Start or resume the cleaning task. description: Start or resume the cleaning task
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
pause: pause:
description: Pause the cleaning task. description: Pause the cleaning task
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
return_to_base: return_to_base:
description: Tell the vacuum cleaner to return to its dock. description: Tell the vacuum cleaner to return to its dock
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
clean_spot: clean_spot:
description: Tell the vacuum cleaner to do a spot clean-up. description: Tell the vacuum cleaner to do a spot clean-up
fields: target:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
send_command: send_command:
description: Send a raw command to the vacuum cleaner. description: Send a raw command to the vacuum cleaner
target:
fields: fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
command: command:
name: Command
description: Command to execute. description: Command to execute.
required: true
example: "set_dnd_timer" example: "set_dnd_timer"
selector:
text:
params: params:
name: Parameters
description: Parameters for the command. description: Parameters for the command.
example: '{ "key": "value" }' example: '{ "key": "value" }'
selector:
object:
set_fan_speed: set_fan_speed:
description: Set the fan speed of the vacuum cleaner. description: Set the fan speed of the vacuum cleaner
target:
fields: fields:
entity_id:
description: Name of the vacuum entity.
example: "vacuum.xiaomi_vacuum_cleaner"
fan_speed: fan_speed:
description: Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium' or by percentage, between 0 and 100. name: Fan speed
description:
Platform dependent vacuum cleaner fan speed, with speed steps, like
'medium' or by percentage, between 0 and 100.
required: true
example: "low" example: "low"
selector:
text: