Format of the services updated. (#4781)

This commit is contained in:
Sebastian Muszynski 2018-03-06 22:01:12 +01:00 committed by Fabian Affolter
parent 66b39210b1
commit 69005f54a3
3 changed files with 13 additions and 14 deletions

View File

@ -71,7 +71,7 @@ name:
## {% linkable_title Platform Services %}
### {% linkable_title Service fan/xiaomi_miio_set_buzzer_on %}
### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_on` %}
Turn the buzzer on.
@ -79,7 +79,7 @@ Turn the buzzer on.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
### {% linkable_title Service fan/xiaomi_miio_set_buzzer_off %}
### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_off` %}
Turn the buzzer off.
@ -87,7 +87,7 @@ Turn the buzzer off.
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
### {% linkable_title Service fan/xiaomi_miio_set_led_on %}
### {% linkable_title Service `fan.xiaomi_miio_set_led_on` %}
Turn the led on.
@ -95,7 +95,7 @@ Turn the led on.
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
### {% linkable_title Service fan/xiaomi_miio_set_led_off %}
### {% linkable_title Service `fan.xiaomi_miio_set_led_off` %}
Turn the led off.
@ -103,7 +103,7 @@ Turn the led off.
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
### {% linkable_title Service fan/xiaomi_miio_set_child_lock_on %}
### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_on` %}
Turn the child lock on.
@ -111,7 +111,7 @@ Turn the child lock on.
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
### {% linkable_title Service fan/xiaomi_miio_set_child_lock_off %}
### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_off` %}
Turn the child lock off.
@ -119,7 +119,7 @@ Turn the child lock off.
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
### {% linkable_title Service fan/xiaomi_miio_set_led_brightness %}
### {% linkable_title Service `fan.xiaomi_miio_set_led_brightness` %}
Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off).
@ -128,7 +128,7 @@ Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off).
| `entity_id` | yes | Only act on a specific air purifier. Else targets all. |
| `brightness` | no | Brightness, between 0 and 2. |
### {% linkable_title Service fan/xiaomi_miio_set_favorite_level %}
### {% linkable_title Service `fan.xiaomi_miio_set_favorite_level` %}
Set the favorite level of the operation mode "favorite".

View File

@ -37,7 +37,7 @@ Configuration variables:
## {% linkable_title Platform Services %}
### Service fan/xiaomi_miio_set_scene
### {% linkable_title Service `light.xiaomi_miio_set_scene` %}
Set one of the 4 available fixed scenes.

View File

@ -60,7 +60,7 @@ services to access the remote control mode of the robot. These are:
- `xiaomi_remote_control_move`
- `xiaomi_remote_control_move_step`
### {% linkable_title Service `vacuum/xiaomi_remote_control_start` %}
### {% linkable_title Service `vacuum.xiaomi_remote_control_start` %}
Start the remote control mode of the robot. You can then move it with
`remote_control_move`; when done, call `remote_control_stop`.
@ -69,7 +69,7 @@ Start the remote control mode of the robot. You can then move it with
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific robot; default targets all |
### {% linkable_title Service `vacuum/xiaomi_remote_control_stop` %}
### {% linkable_title Service `vacuum.xiaomi_remote_control_stop` %}
Exit the remote control mode of the robot.
@ -77,7 +77,7 @@ Exit the remote control mode of the robot.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific robot; default targets all |
### {% linkable_title Service `vacuum/xiaomi_remote_control_move` %}
### {% linkable_title Service `vacuum.xiaomi_remote_control_move` %}
Remote control the robot. Please ensure you first set it in remote control
mode with `remote_control_start`.
@ -89,8 +89,7 @@ mode with `remote_control_start`.
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
| `duration` | no | The number of seconds that the robot should move for |
### {% linkable_title Service `vacuum/xiaomi_remote_control_move_step` %}
### {% linkable_title Service `vacuum.xiaomi_remote_control_move_step` %}
Enter remote control mode, make one move, stop, and exit remote control mode.