Add custom effects docs for tplink (#22126)

This commit is contained in:
J. Nick Koston 2022-03-30 06:41:14 -10:00 committed by GitHub
parent 162bb0bb22
commit f9b96d9156
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -76,3 +76,91 @@ There is currently support for the following device types within Home Assistant:
- KL430
Other bulbs may also work, but with limited color temperature range (2700-5000). If you find a bulb isn't reaching the full-color temperature boundaries, submit a bug report to [python-kasa](https://github.com/python-kasa/python-kasa).
### Random Effect - Service `tplink.random_effect`
The light strips allow setting a random effect.
| Service data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | The entity_id of the light strip to set the effect on |
| `init_states` | Initial HSV sequence |
| `backgrounds` | List of HSV sequences (Max 16) |
| `segments` | List of segments (0 for all) |
| `brightness` | Initial brightness |
| `duration` | Duration |
| `transition` | Transition |
| `fadeoff` | Fade off |
| `hue_range` | Range of hue |
| `saturation_range` | Range of saturation |
| `brightness_range` | Range of brightness |
| `transition_range` | Range of transition |
| `random_seed` | Random seed |
```yaml
#Example Service Call
service: tplink.random_effect
target:
entity_id:
- light.strip
data:
init_states: 199,99,96
backgrounds:
- - 199
- 89
- 50
- - 160
- 50
- 50
- - 180
- 100
- 50
segments: 0, 2, 4, 6, 8
brightness: 90
transition: 2000
fadeoff: 2000
hue_range: 340, 360
saturation_range: 40, 95
brightness_range: 90, 100
transition_range: 2000, 6000
random_seed: 80
```
### Seqeuence Effect - Service `tplink.sequence_effect`
The light strips allow setting a sequence effect.
| Service data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | The entity_id of the light strip to set the effect on |
| `sequence` | List of HSV sequences (Max 16) |
| `segments` | List of segments (0 for all) |
| `brightness` | Initial brightness |
| `duration` | Duration |
| `transition` | Transition |
| `spread` | Speed of spread |
| `direction` | Direction |
```yaml
#Example Service Call
service: tplink.sequence_effect
target:
entity_id:
- light.strip
data:
sequence:
- - 340
- 20
- 50
- - 20
- 50
- 50
- - 0
- 100
- 50
segments: 0, 2, 4, 6, 8
brightness: 80
transition: 2000
spread: 1
direction: 1
```