Update example (fixes #13834) (#13839)

This commit is contained in:
Fabian Affolter 2018-04-13 08:50:58 +02:00 committed by GitHub
parent 22a1b99e57
commit 3906250c9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,93 +4,93 @@ turn_on:
description: Start a new cleaning task. description: Start a new cleaning task.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' 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: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
stop: stop:
description: Stop the current cleaning task. description: Stop the current cleaning task.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
locate: locate:
description: Locate the vacuum cleaner robot. description: Locate the vacuum cleaner robot.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' 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: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' 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: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' 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: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' 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.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
command: command:
description: Command to execute. description: Command to execute.
example: 'set_dnd_timer' example: 'set_dnd_timer'
params: params:
description: Parameters for the command. description: Parameters for the command.
example: '[22,0,6,0]' example: '{ "key": "value" }'
set_fan_speed: set_fan_speed:
description: Set the fan speed of the vacuum cleaner. description: Set the fan speed of the vacuum cleaner.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' 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. description: Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium' or by percentage, between 0 and 100.
example: 'low' example: 'low'
xiaomi_remote_control_start: xiaomi_remote_control_start:
description: Start remote control of the vacuum cleaner. You can then move it with `remote_control_move`, when done call `remote_control_stop`. description: Start remote control of the vacuum cleaner. You can then move it with `remote_control_move`, when done call `remote_control_stop`.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
xiaomi_remote_control_stop: xiaomi_remote_control_stop:
description: Stop remote control mode of the vacuum cleaner. description: Stop remote control mode of the vacuum cleaner.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
xiaomi_remote_control_move: xiaomi_remote_control_move:
description: Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`. description: Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
velocity: velocity:
description: Speed, between -0.29 and 0.29. description: Speed, between -0.29 and 0.29.
@ -106,7 +106,7 @@ xiaomi_remote_control_move_step:
description: Remote control the vacuum cleaner, only makes one move and then stops. description: Remote control the vacuum cleaner, only makes one move and then stops.
fields: fields:
entity_id: entity_id:
description: Name of the botvac entity. description: Name of the vacuum entity.
example: 'vacuum.xiaomi_vacuum_cleaner' example: 'vacuum.xiaomi_vacuum_cleaner'
velocity: velocity:
description: Speed, between -0.29 and 0.29. description: Speed, between -0.29 and 0.29.