LIFX light effects #7145

amelchio · 2017-04-17T08:25:13Z

Update for users: if you know how, please test this :)

Update for reviewers: the below description covers the first three commits. By quite popular demand I have now added a colorloop effect as well. That took some work, and the PR is now quite big. Let me know if you want some reading guidance.

Description:

This is my first stab at LIFX light effects support. These are intended as short-running effects that are useful for notifications.

Maybe the implementation is controversial, I don’t know :-)

I have chosen not to build on the flash or effect parameters of light.turn_on and light.turn_off because I think those calls are already too overloaded (I can elaborate if you like). Adding in different LIFX specific operations would just make matters even worse.

So I wanted a new service call, but not a generic one like light.effect_start.

The term "light effects" sounds like something collective. In reality, though, each light effect has its own distinct set of parameters. For example, potential blink, fireplace and party effects could have quite different options. Thus, I think it is best to make each effect have its own service call. This avoids the situation of having a bunch of parameters where an unpredictable subset will not make sense in any given situation. It also makes it easier for users to discover all effects and their parameters.

Consequently, even though the two initial effects do share the same parameter set, I have split them into two service calls: light.lifx_effect_breathe and light.lifx_effect_pulse. This matches the API chosen by LIFX, so there is some familiarity for LIFX users: https://api.developer.lifx.com/docs/breathe-effect and https://api.developer.lifx.com/docs/pulse-effect

I have added these service calls only for lifx because I think it is infeasible to implement them without hardware support.

Documentation will follow once the implementation settles down.

Example entry for `configuration.yaml`:

automation:
  - alias: Forgot to close window
    trigger:
      platform: state
      entity_id: binary_sensor.aeotec_zw112_door_window_sensor_6_sensor_1_0
      from: 'off'
      to: 'on'
      for:
        minutes: 30
    action:
      - service: light.lifx_effect_pulse
        data:
          entity_id: light.office, light.kitchen
          color_name: 'blue'
          brightness: 200
          period: 0.25
          cycles: 3

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully.

This will be useful for new methods that also have to find passed in colors.

mention-bot · 2017-04-17T08:25:14Z

@amelchio, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff, @BillyNate and @balloob to be potential reviewers.

houndci-bot · 2017-04-17T08:25:17Z

homeassistant/components/light/lifx.py

+        self.event = asyncio.Event()
+
+    @callback
+    def callback(self,device,message):


missing whitespace after ','

houndci-bot · 2017-04-17T08:25:18Z

homeassistant/components/light/lifx.py

            self.hass.async_add_job(entity.async_update_ha_state())

+class AwaitAioLIFX:


expected 2 blank lines, found 1

This encapsulates the callback and Event that aiolifx needs and thus avoids an explosion of those when new calls are added. The refresh_state is now generally useful, so move it into its own method.

These effects are useful as notifications. They mimic the breathe and pulse effects from the LIFX HTTP API: https://api.developer.lifx.com/docs/breathe-effect https://api.developer.lifx.com/docs/pulse-effect However, this implementation runs locally with the LIFX LAN protocol.

cmsimike · 2017-04-17T14:42:49Z

This looks like it is using the lan protocol (rather than going through the lifx server) for the effects?

amelchio · 2017-04-17T14:45:01Z

@cmsimike That is correct.

cmsimike · 2017-04-17T15:12:01Z

@amelchio thank you!!

Now the color is "full saturation, no brightness". This avoids a lot of temporary white when fading from the "no color" value and into a real color.

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+
+                hsbk = [
+                    int(65535/359*lhue),
+                    int(random.uniform(0.8,1.0)*65535),


missing whitespace after ','

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+            if not light.device:
+                self.lights.remove(light)
+            else:
+                light.effect_data = [ self, light.is_on, light.device.color ]


whitespace after '['
whitespace before ']'

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+            data[ATTR_RGB_COLOR] = [
+                random.randint(100,255),
+                random.randint(100,255),
+                random.randint(100,255),


missing whitespace after ','

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+        if service in (SERVICE_EFFECT_BREATHE, SERVICE_EFFECT_PULSE):
+            data[ATTR_RGB_COLOR] = [
+                random.randint(100,255),
+                random.randint(100,255),


missing whitespace after ','

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+
+        if service in (SERVICE_EFFECT_BREATHE, SERVICE_EFFECT_PULSE):
+            data[ATTR_RGB_COLOR] = [
+                random.randint(100,255),


missing whitespace after ','

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

    return True

+@asyncio.coroutine


expected 2 blank lines, found 1

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+    vol.Optional(ATTR_CHANGE, default=20.0): vol.All(vol.Coerce(float),
+                                                    vol.Clamp(min=0, max=360)),
+    vol.Optional(ATTR_SPREAD, default=30.0): vol.All(vol.Coerce(float),
+                                                    vol.Clamp(min=0, max=360)),


continuation line under-indented for visual indent

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+    vol.Optional(ATTR_PERIOD, default=60.0): vol.All(vol.Coerce(float),
+                                                    vol.Clamp(min=1)),
+    vol.Optional(ATTR_CHANGE, default=20.0): vol.All(vol.Coerce(float),
+                                                    vol.Clamp(min=0, max=360)),


continuation line under-indented for visual indent

houndci-bot · 2017-04-19T22:34:54Z

homeassistant/components/light/lifx.py

+LIFX_EFFECT_COLORLOOP_SCHEMA = LIFX_EFFECT_SCHEMA.extend({
+    ATTR_BRIGHTNESS: vol.All(vol.Coerce(int), vol.Clamp(min=0, max=255)),
+    vol.Optional(ATTR_PERIOD, default=60.0): vol.All(vol.Coerce(float),
+                                                    vol.Clamp(min=1)),


continuation line under-indented for visual indent

houndci-bot · 2017-04-19T22:42:38Z

homeassistant/components/light/lifx.py

+    vol.Optional(ATTR_CHANGE, default=20.0): vol.All(vol.Coerce(float),
+                                                     vol.Clamp(min=0, max=360)),
+    vol.Optional(ATTR_SPREAD, default=30.0): vol.All(vol.Coerce(float),
+                                                     vol.Clamp(min=0, max=360)),


line too long (80 > 79 characters)

houndci-bot · 2017-04-19T22:42:38Z

homeassistant/components/light/lifx.py

+    vol.Optional(ATTR_PERIOD, default=60.0): vol.All(vol.Coerce(float),
+                                                     vol.Clamp(min=1)),
+    vol.Optional(ATTR_CHANGE, default=20.0): vol.All(vol.Coerce(float),
+                                                     vol.Clamp(min=0, max=360)),


line too long (80 > 79 characters)

balloob · 2017-04-20T06:34:03Z

I would just create 1 file for the effects.

The name is actually the easiest way to identify a bulb so just using it as a fallback was a bit odd.

This is a stopgap. When a bit more infrastructure is in place, the intention is to turn the current hue some degrees. This will guarantee a flash color that is both unlike the current color and unlike white.

We have to wait for the bulbs, so let us wait for all of them at once.

The colorloop effect is most impressive if run on many lights. Testing this has revealed the need for an easy way to stop effects on all lights and return to the initial state of each bulb. This new call does just that. Calling turn_on/turn_off could also stop the effect but that would not restore the initial state.

To fade nicely from power off, the breathe effect needs to keep an unchanging hue. So give up on using a static start color and just find the correct hue from the target color. The colorloop effect can start from anything but we use a random color just to keep things a little interesting during power on.

houndci-bot · 2017-04-20T22:14:47Z

homeassistant/components/light/lifx/effects.py

+        data[ATTR_BRIGHTNESS] = 255
+    yield from light.hass.services.async_call(DOMAIN, service, data)
+
+def effect_list():


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:47Z

homeassistant/components/light/lifx/effects.py

+
+    hass.async_add_job(effect.async_perform(**data))
+
+@asyncio.coroutine


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:47Z

homeassistant/components/light/lifx/effects.py

+        descriptions.get(SERVICE_EFFECT_STOP),
+        schema=LIFX_EFFECT_STOP_SCHEMA)
+
+@asyncio.coroutine


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:47Z

homeassistant/components/light/lifx/effects.py

+
+        if devices:
+            yield from start_effect(hass, devices, \
+                service.service, **service.data)


continuation line under-indented for visual indent

houndci-bot · 2017-04-20T22:14:47Z

homeassistant/components/light/lifx/effects.py

+            devices = list(lifx_manager.entities.values())
+
+        if devices:
+            yield from start_effect(hass, devices, \


the backslash is redundant between brackets

houndci-bot · 2017-04-20T22:14:47Z

homeassistant/components/light/lifx/effects.py

+    vol.Optional(ATTR_POWER_ON, default=False): cv.boolean,
+})
+
+def setup(hass, lifx_manager):


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:48Z

homeassistant/components/light/lifx/effects.py

+        data[ATTR_BRIGHTNESS] = 255
+    yield from light.hass.services.async_call(DOMAIN, service, data)
+
+def effect_list():


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:48Z

homeassistant/components/light/lifx/effects.py

+
+    hass.async_add_job(effect.async_perform(**data))
+
+@asyncio.coroutine


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:48Z

homeassistant/components/light/lifx/effects.py

+        descriptions.get(SERVICE_EFFECT_STOP),
+        schema=LIFX_EFFECT_STOP_SCHEMA)
+
+@asyncio.coroutine


expected 2 blank lines, found 1

houndci-bot · 2017-04-20T22:14:48Z

homeassistant/components/light/lifx/effects.py

+
+        if devices:
+            yield from start_effect(hass, devices, \
+                service.service, **service.data)


continuation line under-indented for visual indent

houndci-bot · 2017-04-20T22:14:48Z

homeassistant/components/light/lifx/effects.py

+            devices = list(lifx_manager.entities.values())
+
+        if devices:
+            yield from start_effect(hass, devices, \


the backslash is redundant between brackets

houndci-bot · 2017-04-20T22:14:48Z

homeassistant/components/light/lifx/effects.py

+    vol.Optional(ATTR_POWER_ON, default=False): cv.boolean,
+})
+
+def setup(hass, lifx_manager):


expected 2 blank lines, found 1

amelchio · 2017-04-20T23:15:39Z

@balloob I have moved the effects into their own file now. It’s much better that way, thanks! I also did a little further tweaking so I think it is good to go now.

* Refactor into find_hsbk This will be useful for new methods that also have to find passed in colors. * Add AwaitAioLIFX This encapsulates the callback and Event that aiolifx needs and thus avoids an explosion of those when new calls are added. The refresh_state is now generally useful, so move it into its own method. * Initial effects support for LIFX These effects are useful as notifications. They mimic the breathe and pulse effects from the LIFX HTTP API: https://api.developer.lifx.com/docs/breathe-effect https://api.developer.lifx.com/docs/pulse-effect However, this implementation runs locally with the LIFX LAN protocol. * Saturate LIFX no color value Now the color is "full saturation, no brightness". This avoids a lot of temporary white when fading from the "no color" value and into a real color. * Organize LIFX effects in classes This is to move the setup/restore away from the actual effect, making it quite simple to add additional effects. * Stop running LIFX effects on conflicting service calls Turning the light on/off or starting a new effect will now stop the running effect. * Present default LIFX effects as light.turn_on effects This makes the effects (with default parameters) easily accessible from the UI. * Add LIFX colorloop effect This cycles the HSV colors, so that is added as an internal way to set a color. * Move lifx to its own package and split effects into a separate file * Always show LIFX light name in logs The name is actually the easiest way to identify a bulb so just using it as a fallback was a bit odd. * Compact effect getter * Always use full brightness for random flash color This is a stopgap. When a bit more infrastructure is in place, the intention is to turn the current hue some degrees. This will guarantee a flash color that is both unlike the current color and unlike white. * Clear effects concurrently We have to wait for the bulbs, so let us wait for all of them at once. * Add lifx_effect_stop The colorloop effect is most impressive if run on many lights. Testing this has revealed the need for an easy way to stop effects on all lights and return to the initial state of each bulb. This new call does just that. Calling turn_on/turn_off could also stop the effect but that would not restore the initial state. * Always calculate the initial effect color To fade nicely from power off, the breathe effect needs to keep an unchanging hue. So give up on using a static start color and just find the correct hue from the target color. The colorloop effect can start from anything but we use a random color just to keep things a little interesting during power on. * Fix lint * Update .coveragerc

balloob · 2017-04-21T05:46:37Z

Cherry-picked for 0.43

Add description of the light effects added in home-assistant/core#7145

Refactor into find_hsbk

f032398

This will be useful for new methods that also have to find passed in colors.

homeassistant added cla-signed platform: light.lifx labels Apr 17, 2017

houndci-bot reviewed Apr 17, 2017

View reviewed changes

amelchio force-pushed the lifx-effects branch from 3cdeab9 to a8523ae Compare April 17, 2017 08:27

homeassistant added the cla-signed label Apr 17, 2017

amelchio force-pushed the lifx-effects branch from a8523ae to 11d8923 Compare April 17, 2017 08:59

homeassistant added the cla-signed label Apr 17, 2017

amelchio force-pushed the lifx-effects branch from 11d8923 to 5ba2525 Compare April 17, 2017 09:41

homeassistant added the cla-signed label Apr 17, 2017

balloobbot added the platform label Apr 17, 2017

amelchio added 2 commits April 17, 2017 12:04

Add AwaitAioLIFX

3e05131

This encapsulates the callback and Event that aiolifx needs and thus avoids an explosion of those when new calls are added. The refresh_state is now generally useful, so move it into its own method.

amelchio force-pushed the lifx-effects branch from 5ba2525 to 370df50 Compare April 17, 2017 10:07

homeassistant added the cla-signed label Apr 17, 2017

amelchio changed the title ~~[WIP] LIFX flash effects~~ LIFX flash effects Apr 17, 2017

Saturate LIFX no color value

253c752

Now the color is "full saturation, no brightness". This avoids a lot of temporary white when fading from the "no color" value and into a real color.

homeassistant added the cla-signed label Apr 19, 2017

houndci-bot reviewed Apr 19, 2017

View reviewed changes

amelchio force-pushed the lifx-effects branch from 5b71733 to 8788493 Compare April 19, 2017 22:42

homeassistant added the cla-signed label Apr 19, 2017

houndci-bot reviewed Apr 19, 2017

View reviewed changes

amelchio force-pushed the lifx-effects branch from 8788493 to 0f715af Compare April 19, 2017 22:44

homeassistant added the cla-signed label Apr 19, 2017

amelchio force-pushed the lifx-effects branch from 0f715af to beff3f2 Compare April 19, 2017 23:57

amelchio added 7 commits April 20, 2017 18:49

Move lifx to its own package and split effects into a separate file

2b5fc13

Always show LIFX light name in logs

c9902b6

The name is actually the easiest way to identify a bulb so just using it as a fallback was a bit odd.

Compact effect getter

83fedf4

Always use full brightness for random flash color

9499931

This is a stopgap. When a bit more infrastructure is in place, the intention is to turn the current hue some degrees. This will guarantee a flash color that is both unlike the current color and unlike white.

Clear effects concurrently

6100d51

We have to wait for the bulbs, so let us wait for all of them at once.

balloobbot removed the platform label Apr 20, 2017

houndci-bot reviewed Apr 20, 2017

View reviewed changes

homeassistant added the cla-signed label Apr 20, 2017

amelchio changed the title ~~LIFX flash effects~~ LIFX light effects Apr 20, 2017

amelchio force-pushed the lifx-effects branch from 3366216 to 9e72ac5 Compare April 20, 2017 22:38

homeassistant added the cla-signed label Apr 20, 2017

Fix lint

7ce503c

amelchio force-pushed the lifx-effects branch from 9e72ac5 to 7ce503c Compare April 20, 2017 23:00

homeassistant added the cla-signed label Apr 20, 2017

Update .coveragerc

ddf0181

balloob added this to the 0.43 milestone Apr 21, 2017

balloob merged commit d4b0850 into home-assistant:dev Apr 21, 2017

balloob mentioned this pull request Apr 22, 2017

0.43 #7197

Merged

amelchio added a commit to home-assistant/home-assistant.io that referenced this pull request Apr 22, 2017

Update light.lifx.markdown

eb37441

Add description of the light effects added in home-assistant/core#7145

balloob mentioned this pull request May 5, 2017

0.44 #7444

Merged

home-assistant locked and limited conversation to collaborators Aug 12, 2017

ghost added integration: lifx and removed platform: light.lifx labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LIFX light effects #7145

LIFX light effects #7145

amelchio commented Apr 17, 2017 •

edited

Loading

mention-bot commented Apr 17, 2017

houndci-bot Apr 17, 2017

houndci-bot Apr 17, 2017

cmsimike commented Apr 17, 2017

amelchio commented Apr 17, 2017

cmsimike commented Apr 17, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

houndci-bot Apr 19, 2017

balloob commented Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

houndci-bot Apr 20, 2017

amelchio commented Apr 20, 2017

balloob commented Apr 21, 2017

		self.hass.async_add_job(entity.async_update_ha_state())

		class AwaitAioLIFX:


		hass.async_add_job(effect.async_perform(**data))

		@asyncio.coroutine

LIFX light effects #7145

LIFX light effects #7145

Conversation

amelchio commented Apr 17, 2017 • edited Loading

Description:

Example entry for configuration.yaml:

Checklist:

mention-bot commented Apr 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmsimike commented Apr 17, 2017

amelchio commented Apr 17, 2017

cmsimike commented Apr 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Apr 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amelchio commented Apr 20, 2017

balloob commented Apr 21, 2017

amelchio commented Apr 17, 2017 •

edited

Loading

Example entry for `configuration.yaml`: