Connectors Reference
LIFX make Wi-Fi-enabled LED smart lighting. Deep colors, bright whites, and unique features, effects and integrations make for Smarter Light. Use this connector to control your LIFX.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Move current pattern across Beam or Z Strip |
|
|
List lights |
|
|
Pulse effect by quickly flashing between the given colors |
|
|
Lists scenes |
|
|
ActivateScene (string Scene, ActivateSceneParameterBody body) |
Activate a scene |
|
Set state of the lights |
|
|
Turn off any running effects on the device |
|
|
Set different states on multiple sets of lights |
|
|
Turn off lights if any of them are on, or turn them on if they are all off |
|
|
BreatheEffect (string Lights, BreatheEffectParameterBody body) |
Breathe effect by slowly fading between the given colors |
|
Morph effect on Tiles |
|
|
List of light selectors |
|
|
List of scene selectors |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Move current pattern across Beam or Z Strip
Description: Move current pattern across Beam or Z Strip
Syntax:
LIFX.MoveEffect (string Lights, MoveEffectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Type:MoveEffectResponse
Summary: List lights
Description: List lights
Syntax:
LIFX.ListLights (string Lights)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
Returns:
Type:array of (ListLightsResponseItem)
Summary: Pulse effect by quickly flashing between the given colors
Description: Pulse effect by quickly flashing between the given colors
Syntax:
LIFX.PulseEffect (string Lights, PulseEffectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Type:PulseEffectResponse
Summary: Lists scenes
Description: Lists scenes
Syntax:
LIFX.ListScenes ()
Returns:
Type:ListScenesResponse
Summary: Activate a scene
Description: Activate a scene
Syntax:
LIFX.ActivateScene (string Scene, ActivateSceneParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Scene |
string (Scene) |
The scene to activate |
True |
|
|
body |
|
|
True |
Returns:
Summary: Set state of the lights
Description: Set state of the lights
Syntax:
LIFX.SetState (string Lights, SetStateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Type:SetStateResponse
Summary: Turn off any running effects on the device
Description: Turn off any running effects on the device
Syntax:
LIFX.EffectsOff (string Lights, EffectsOffParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Light or group of lights to apply action to) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Type:EffectsOffResponse
Summary: Set different states on multiple sets of lights
Description: Set different states on multiple sets of lights
Syntax:
LIFX.SetStates (SetStatesParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:SetStatesResponse
Summary: Turn off lights if any of them are on, or turn them on if they are all off
Description: Turn off lights if any of them are on, or turn them on if they are all off
Syntax:
LIFX.TogglePower (string Lights, TogglePowerParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Type:TogglePowerResponse
Summary: Breathe effect by slowly fading between the given colors
Description: Breathe effect by slowly fading between the given colors
Syntax:
LIFX.BreatheEffect (string Lights, BreatheEffectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Morph effect on Tiles
Description: Morph effect on Tiles
Syntax:
LIFX.MorphEffect (string Lights, MorphEffectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Lights |
string (Lights) |
Light or group of lights to apply action to |
True |
|
|
body |
|
|
True |
Returns:
Type:MorphEffectResponse
Summary: List of light selectors
Description: List of light selectors
Syntax:
LIFX.ListDeviceSelectors ()
Returns:
Type:array of (ListDeviceSelectorsResponseItem)
Summary: List of scene selectors
Description: List of scene selectors
Syntax:
LIFX.ListSceneSelectors ()
Returns:
Type:array of (ListSceneSelectorsResponseItem)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
duration |
integer(int32)
|
Time in seconds to transition from current light state to the scene state |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
color |
string
|
The color to use for the breathe effect Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
from_color |
string
|
The color to start the effect from Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
period |
number(double)
|
The time in seconds for one cycle of the effect. |
|
cycles |
number(double)
|
The number of times to repeat the effect. |
|
persist |
boolean
|
True leaves lights with last effect color. Values: [, ] |
|
power_on |
boolean
|
If true, turn the bulb on if it is not already on. Values: [, ] |
|
peak |
number(double)
|
Defines where in a period the target color is at its maximum. Minimum 0.0, maximum 1.0. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
power_off |
boolean
|
Turn the devices all off Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
selector |
string
|
selector |
|
label |
string
|
label |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
uuid |
string
|
uuid |
|
label |
string
|
label |
|
connected |
boolean
|
connected |
|
power |
string
|
power |
|
color |
|
color |
|
brightness |
number(float)
|
brightness |
|
effect |
string
|
effect |
|
group |
|
group |
|
location |
|
location |
|
product |
|
product |
|
last_seen |
string
|
last_seen |
|
seconds_since_seen |
integer(int32)
|
seconds_since_seen |
|
zones |
|
zones |
|
chain |
|
chain |
Summary:
Description: color
Properties:
|
Name |
Type |
Summary |
|
hue |
number(double)
|
hue |
|
saturation |
integer(int32)
|
saturation |
|
kelvin |
integer(int32)
|
kelvin |
Summary:
Description: group
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
name |
string
|
name |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
name |
string
|
name |
Summary:
Description: product
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
identifier |
string
|
identifier |
|
company |
string
|
company |
|
capabilities |
|
capabilities |
Summary:
Description: capabilities
Properties:
|
Name |
Type |
Summary |
|
has_color |
boolean
|
has_color |
|
has_variable_color_temp |
boolean
|
has_variable_color_temp |
|
has_ir |
boolean
|
has_ir |
|
has_chain |
boolean
|
has_chain |
|
has_matrix |
boolean
|
has_matrix |
|
has_multizone |
boolean
|
has_multizone |
|
min_kelvin |
integer(int32)
|
min_kelvin |
|
max_kelvin |
integer(int32)
|
max_kelvin |
Summary:
Description: zones
Properties:
|
Name |
Type |
Summary |
|
count |
integer(int32)
|
count |
|
zones |
array of (ZonesItem)
|
zones |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
brightness |
number(float)
|
brightness |
|
hue |
number(double)
|
hue |
|
kelvin |
integer(int32)
|
kelvin |
|
saturation |
integer(int32)
|
saturation |
|
zone |
integer(int32)
|
zone |
Summary:
Description: chain
Properties:
|
Name |
Type |
Summary |
|
count |
integer(int32)
|
count |
|
children |
array of (ChildrenItem)
|
children |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
height |
integer(int32)
|
height |
|
index |
integer(int32)
|
index |
|
user_x |
integer(int32)
|
user_x |
|
user_y |
integer(int32)
|
user_y |
|
width |
integer(int32)
|
width |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
selector |
string
|
selector |
|
label |
string
|
label |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
period |
integer(int32)
|
How quickly the morph runs in seconds |
|
duration |
integer(int32)
|
How long the animation lasts for in second |
|
palette |
array of (string)
|
Colors |
|
power_on |
boolean
|
Switch light that is off to on before performing the effect Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
direction |
string
|
Move direction, can be forward or backward. Values: [forward, backward] |
|
period |
number(double)
|
The time in seconds for one cycle of the effect. |
|
cycles |
number(float)
|
The number of times to move the pattern across the device |
|
power_on |
boolean
|
Switch any selected device that is off to on before performing the effect Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
color |
string
|
The color to use for the pulse effect Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
from_color |
string
|
The color to start the effect from Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
period |
number(double)
|
The time in seconds for one cycles of the effect. |
|
cycles |
number(double)
|
The number of times to repeat the effect. |
|
persist |
boolean
|
False sets the light back to its previous value when effect ends, if true leave the last effect color Values: [, ] |
|
power_on |
boolean
|
If true, turn the bulb on if it is not already on. Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
power |
string
|
Turn lights on or off Values: [on, off] |
|
color |
string
|
The color to set the light to Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
brightness |
number(double)
|
The brightness level from 0.0 to 1.0. Overrides any brightness set in color (if any). |
|
duration |
number(double)
|
How long in seconds you want the power action to take |
|
infrared |
number(double)
|
The maximum brightness of the infrared channel from 0.0 to 1.0 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
results |
array of (ResultsItem)
|
results |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
status |
string
|
status |
|
label |
string
|
label |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
states |
array of (StatesItem)
|
states |
|
defaults |
|
Default values applied when no specific values set |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
selector |
string
|
Light or group of lights to apply action to |
|
power |
string
|
Turn lights on or off Values: [on, off] |
|
color |
string
|
The color to set the light to Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
brightness |
number(double)
|
The brightness level from 0.0 to 1.0. Overrides any brightness set in color (if any). |
|
duration |
number(double)
|
How long in seconds you want the power action to take |
|
infrared |
number(double)
|
The maximum brightness of the infrared channel from 0.0 to 1.0 |
Summary:
Description: Default values applied when no specific values set
Properties:
|
Name |
Type |
Summary |
|
power |
string
|
Turn lights on or off Values: [on, off] |
|
color |
string
|
The color to set the light to Values: [, kelvin:1500, kelvin:2000, kelvin:2500, kelvin:2750, kelvin:3000, kelvin:3200, kelvin:3500, kelvin:4000, kelvin:4500, kelvin:5000, kelvin:5500, kelvin:6000, kelvin:6500, kelvin:7000, kelvin:7500, kelvin:8000, kelvin:8500, kelvin:9000, red, orange, yellow, green, cyan, blue, purple, pink, red saturation:0.5, orange saturation:0.5, yellow saturation:0.5, green saturation:0.5, cyan saturation:0.5, blue saturation:0.5, purple saturation:0.5, pink saturation:0.5, random] |
|
brightness |
number(double)
|
The brightness level from 0.0 to 1.0. Overrides any brightness set in color (if any). |
|
duration |
number(double)
|
How long in seconds you want the power action to take |
|
infrared |
number(double)
|
The maximum brightness of the infrared channel from 0.0 to 1.0 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
duration |
number(double)
|
The time is seconds to spend performing the power toggle. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |