home-assistant.io/source/_integrations/lifx.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_config_flow, ha_domain

title	description	ha_category	ha_iot_class	ha_release	ha_config_flow	ha_domain
LIFX	Instructions on how to integrate LIFX into Home Assistant.	Light	Local Polling	0.81	true	lifx

The lifx integration allows you to integrate your LIFX into Home Assistant.

Please note, the lifx integration does not support Windows. The lifx_legacy light platform (supporting basic functionality) can be used instead.

You can configure the LIFX integration by going to the integrations page inside the configuration panel.

Set state

The LIFX bulbs allow a change of color and brightness even when they are turned off. This way you can control the light during the day so its settings are correct when events for turning on are received, for example from motion detectors or external buttons.

The normal light.turn_on call cannot be used for this because it always turns the power on. Thus, LIFX has its own service call that allows color changes without affecting the current power state.

Service lifx.set_state

Change the light to a new state.

Service data attribute	Description
entity_id	String or list of strings that point at entity_ids of lights. Use entity_id: all to target all.
transition	Duration (in seconds) for the light to fade to the new state.
zones	List of integers for the zone numbers to affect (each LIFX Z strip has 8 zones, starting at 0).
infrared	Automatic infrared level (0..255) when light brightness is low (for compatible bulbs).
power	Turn the light on (True) or off (False). Leave out to keep the power as it is.
...	Use color_name, brightness etc. from light.turn_on to specify the new state.

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 service, for example like this:

automation:
  - alias: ...
    trigger:
      # ...
    action:
      - service: light.turn_on
        data:
          entity_id: light.office, light.kitchen
          effect: lifx_effect_pulse

However, if you want to fully control a light effect, you have to use its dedicated service call, like this:

script:
  colorloop_start:
    alias: 'Start colorloop'
    sequence:
      - service: 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.

Service lifx.effect_pulse

Run a flash effect by changing to a color and then back.

Service data attribute	Description
entity_id	String or list of strings that point at entity_ids of lights. Use entity_id: all to target 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 (in seconds).
cycles	The total number of pulses.
mode	The way to change between colors. Valid modes: blink (default - direct transition to new color for 'period' time with original color between cycles), breathe (color fade transition to new color and back to original), ping (short pulse of new color), strobe (light turns off between color changes), solid(light does not return to original color between cycles).
power_on	Set this to False to skip the effect on lights that are turned off (defaults to True).

Service 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_ids of lights. Use entity_id: all to target 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 starting a new color change.
transition	Duration (in seconds) where lights are actively changing color.
change	Hue movement per period, in degrees on a color wheel (ranges from 0 to 359).
spread	Maximum color difference between 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).

Service lifx.effect_stop

Run an effect that does nothing, thereby stopping any other effect that might be running.

Service data attribute	Description
entity_id	String or list of strings that point at entity_ids of lights. Use entity_id: all to target all.

Advanced configuration

There are some manual configuration options available. These are only needed with unusual network setups where automatic configuration does not find your LIFX devices.

# Example configuration.yaml entry
lifx:
  light:
    - server: IP_ADDRESS
      port: 56700
      broadcast: IP_ADDRESS

{% configuration %} server: description: Your server address. Will listen on all interfaces if omitted. required: false type: string port: description: The UDP port for discovery. Will listen on a random port if omitted. required: false type: integer broadcast: description: The broadcast address for discovering lights. Can also set this to the IP address of a bulb to skip discovery. required: false type: string {% endconfiguration %}