81 lines
1.6 KiB
YAML
81 lines
1.6 KiB
YAML
# Describes the format for available vacuum services
|
|
|
|
turn_on:
|
|
name: Turn on
|
|
description: Start a new cleaning task.
|
|
target:
|
|
|
|
turn_off:
|
|
name: Turn off
|
|
description: Stop the current cleaning task and return to home.
|
|
target:
|
|
|
|
stop:
|
|
name: Stop
|
|
description: Stop the current cleaning task.
|
|
target:
|
|
|
|
locate:
|
|
name: Locate
|
|
description: Locate the vacuum cleaner robot.
|
|
target:
|
|
|
|
start_pause:
|
|
name: Start/Pause
|
|
description: Start, pause, or resume the cleaning task.
|
|
target:
|
|
|
|
start:
|
|
name: Start
|
|
description: Start or resume the cleaning task.
|
|
target:
|
|
|
|
pause:
|
|
name: Pause
|
|
description: Pause the cleaning task.
|
|
target:
|
|
|
|
return_to_base:
|
|
name: Return to base
|
|
description: Tell the vacuum cleaner to return to its dock.
|
|
target:
|
|
|
|
clean_spot:
|
|
name: Clean spot
|
|
description: Tell the vacuum cleaner to do a spot clean-up.
|
|
target:
|
|
|
|
send_command:
|
|
name: Send command
|
|
description: Send a raw command to the vacuum cleaner.
|
|
target:
|
|
fields:
|
|
command:
|
|
name: Command
|
|
description: Command to execute.
|
|
required: true
|
|
example: "set_dnd_timer"
|
|
selector:
|
|
text:
|
|
params:
|
|
name: Parameters
|
|
description: Parameters for the command.
|
|
example: '{ "key": "value" }'
|
|
selector:
|
|
object:
|
|
|
|
set_fan_speed:
|
|
name: Set fan speed
|
|
description: Set the fan speed of the vacuum cleaner.
|
|
target:
|
|
fields:
|
|
fan_speed:
|
|
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"
|
|
selector:
|
|
text:
|