Add documentation for new yeelight services (#10248)

* Add documentation for new yeelight services

* Remove info about set_scene api call

* ✏️ Tweaks
This commit is contained in:
zewelor 2019-09-09 22:00:02 +02:00 committed by Franck Nijhof
parent bfef45e5db
commit c2d46b9402

View File

@ -156,7 +156,7 @@ Set an operation mode.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on a specific lights. |
| `entity_id` | no | Only act on specific lights. |
| `mode` | no | Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'. |
### Service `yeelight.start_flow`
@ -165,11 +165,62 @@ Start flow with specified transitions
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on a specific lights. |
| `entity_id` | no | Only act on specific lights. |
| `count` | yes | The number of times to run this flow (0 to run forever). |
| `action` | yes | The action to take after the flow stops. Can be 'recover', 'stay', 'off'. Default 'recover' |
| `transitions` | no | Array of transitions. See [examples below](#custom-effects). |
### Service `yeelight.set_color_scene`
Changes the light to the specified RGB color and brightness. If the light is off, it will be turned on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on specific lights. |
| `rgb_color` | no | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets.|
| `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_hsv_scene`
Changes the light to the specified HSV color and brightness. If the light is off, it will be turned on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on specific lights. |
| `hs_color` | no | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. |
| `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_color_temp_scene`
Changes the light to the specified color temperature. If the light is off, it will be turned on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on specific lights. |
| `kelvin` | no | Color temperature in Kelvin. |
| `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_color_flow_scene`
Starts a color flow. Difference between this and [yeelight.start_flow](#service-yeelightstart_flow), this service call uses different Yeelight api call. If the light was off, it will be turned on. There might be some firmware differences, in handling complex flows, etc.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on specific lights. |
| `count` | yes | The number of times to run this flow (0 to run forever). |
| `action` | yes | The action to take after the flow stops. Can be 'recover', 'stay', 'off'. Default 'recover' |
| `transitions` | no | Array of transitions. See [examples below](#custom-effects). |
### Service `yeelight.set_auto_delay_off_scene`
Turns the light on to the specified brightness and sets a timer to turn it back off after the given number of minutes. If the light is off, it will be turned on.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | no | Only act on specific lights. |
| `minutes` | no | The minutes to wait before automatically turning the light off. |
| `brightness` | no | The brightness value to set (1-100). |
## Examples
In this section you find some real-life examples of how to use this light.