You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/light.lifx.markdown
+74Lines changed: 74 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -26,3 +26,77 @@ light:
26
26
Configuration variables:
27
27
28
28
- **server** (*Optional*): Your server address. Only needed if using more than one network interface. Omit if you are unsure.
29
+
30
+
31
+
## Light effects
32
+
33
+
The LIFX platform supports several light effects. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) service, for example like this:
34
+
```yaml
35
+
automation:
36
+
- alias: ...
37
+
trigger:
38
+
# ...
39
+
action:
40
+
- service: light.turn_on
41
+
data:
42
+
entity_id: light.office, light.kitchen
43
+
effect: lifx_effect_breathe
44
+
```
45
+
46
+
However, if you want to fully control a light effect, you have to use its dedicated service call, like this:
47
+
```yaml
48
+
script:
49
+
colorloop_start:
50
+
alias: 'Start colorloop'
51
+
sequence:
52
+
- service: light.lifx_effect_colorloop
53
+
data:
54
+
entity_id: group.livingroom
55
+
brightness: 255
56
+
period: 10
57
+
spread: 30
58
+
change: 35
59
+
```
60
+
61
+
The available light effects and their options are listed below.
62
+
63
+
### {% linkable_title Service `light.lifx_effect_breathe` %}
64
+
65
+
Run a breathe effect by fading to a color and back.
66
+
67
+
| Service data attribute | Description |
68
+
| ---------------------- | ----------- |
69
+
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
70
+
| `color_name` | A color name such as `red` or `green`.
71
+
| `rgb_color` | A list containing three integers representing the RGB color you want the light to be.
72
+
| `brightness` | Integer between 0 and 255 for how bright the color should be.
73
+
| `period` | The duration of a single breathe.
74
+
| `cycles` | The total number of breathes.
75
+
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
76
+
77
+
### {% linkable_title Service `light.lifx_effect_pulse` %}
78
+
79
+
Run a flash effect by quickly changing to a color and then back.
80
+
81
+
| Service data attribute | Description |
82
+
| ---------------------- | ----------- |
83
+
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
84
+
| `color_name` | A color name such as `red` or `green`.
85
+
| `rgb_color` | A list containing three integers representing the RGB color you want the light to be.
86
+
| `brightness` | Integer between 0 and 255 for how bright the color should be.
87
+
| `period` | The duration of a single pulse.
88
+
| `cycles` | The total number of pulses.
89
+
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
90
+
91
+
### {% linkable_title Service `light.lifx_effect_colorloop` %}
92
+
93
+
Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors.
94
+
95
+
| Service data attribute | Description |
96
+
| ---------------------- | ----------- |
97
+
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
98
+
| `brightness` | Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light.
99
+
| `period` | Duration (in seconds) between the start of a new color change.
100
+
| `change` | Hue movement per period, in degrees on a color wheel (ranges from 0 to 359).
101
+
| `spread` | Total hue covered by participating lights, in degrees on a color wheel (ranges from 0 to 359).
102
+
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
0 commit comments