From eb37441a88b7c59a5156602c3fa02a2b6201f8f1 Mon Sep 17 00:00:00 2001
From: Anders Melchiorsen <amelchio@nogoto.net>
Date: Sun, 23 Apr 2017 01:39:54 +0200
Subject: [PATCH] Update light.lifx.markdown

Add description of the light effects added in home-assistant/home-assistant#7145
---
 source/_components/light.lifx.markdown | 74 ++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)

diff --git a/source/_components/light.lifx.markdown b/source/_components/light.lifx.markdown
index 36c7a03b0dc..e104ef21df4 100644
--- a/source/_components/light.lifx.markdown
+++ b/source/_components/light.lifx.markdown
@@ -26,3 +26,77 @@ light:
 Configuration variables:
 
 - **server** (*Optional*): Your server address. Only needed if using more than one network interface. Omit if you are unsure.
+
+
+## Light effects
+
+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:
+```yaml
+automation:
+  - alias: ...
+    trigger:
+      # ...
+    action:
+      - service: light.turn_on
+        data:
+          entity_id: light.office, light.kitchen
+          effect: lifx_effect_breathe
+```
+
+However, if you want to fully control a light effect, you have to use its dedicated service call, like this:
+```yaml
+script:
+  colorloop_start:
+    alias: 'Start colorloop'
+    sequence:
+      - service: light.lifx_effect_colorloop
+        data:
+          entity_id: group.livingroom
+          brightness: 255
+          period: 10
+          spread: 30
+          change: 35
+```
+
+The available light effects and their options are listed below.
+
+### {% linkable_title Service `light.lifx_effect_breathe` %}
+
+Run a breathe effect by fading to a color and back.
+
+| Service data attribute | Description |
+| ---------------------- | ----------- |
+| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
+| `color_name` | A color name such as `red` or `green`.
+| `rgb_color` | A list containing three integers representing the RGB color you want the light to be.
+| `brightness` | Integer between 0 and 255 for how bright the color should be.
+| `period` | The duration of a single breathe.
+| `cycles` | The total number of breathes.
+| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
+
+### {% linkable_title Service `light.lifx_effect_pulse` %}
+
+Run a flash effect by quickly changing to a color and then back.
+
+| Service data attribute | Description |
+| ---------------------- | ----------- |
+| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
+| `color_name` | A color name such as `red` or `green`.
+| `rgb_color` | A list containing three integers representing the RGB color you want the light to be.
+| `brightness` | Integer between 0 and 255 for how bright the color should be.
+| `period` | The duration of a single pulse.
+| `cycles` | The total number of pulses.
+| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
+
+### {% linkable_title Service `light.lifx_effect_colorloop` %}
+
+Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors.
+
+| Service data attribute | Description |
+| ---------------------- | ----------- |
+| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
+| `brightness` | Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light.
+| `period` | Duration (in seconds) between the start of a new color change.
+| `change` | Hue movement per period, in degrees on a color wheel (ranges from 0 to 359).
+| `spread` | Total hue covered by participating lights, in degrees on a color wheel (ranges from 0 to 359).
+| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).