2015-09-27 06:17:04 +00:00
# Describes the format for available light services
turn_on :
2017-10-30 20:39:12 +00:00
description : Turn a light on.
2015-09-27 06:17:04 +00:00
fields :
entity_id :
description : Name(s) of entities to turn on
2019-10-03 20:28:53 +00:00
example : "light.kitchen"
2015-09-27 06:17:04 +00:00
transition :
description : Duration in seconds it takes to get to next state
example : 60
rgb_color :
2017-10-30 20:39:12 +00:00
description : Color for the light in RGB-format.
2019-10-03 20:28:53 +00:00
example : "[255, 100, 100]"
2016-05-17 07:06:55 +00:00
color_name :
2017-10-30 20:39:12 +00:00
description : A human readable color name.
2019-10-03 20:28:53 +00:00
example : "red"
2018-04-03 23:05:06 +00:00
hs_color :
description : Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.
2019-10-03 20:28:53 +00:00
example : "[300, 70]"
2015-09-27 06:17:04 +00:00
xy_color :
2017-10-30 20:39:12 +00:00
description : Color for the light in XY-format.
2019-10-03 20:28:53 +00:00
example : "[0.52, 0.43]"
2015-10-28 23:12:16 +00:00
color_temp :
2017-10-30 20:39:12 +00:00
description : Color temperature for the light in mireds.
2017-05-17 06:00:46 +00:00
example : 250
kelvin :
2017-10-30 20:39:12 +00:00
description : Color temperature for the light in Kelvin.
2017-05-17 06:00:46 +00:00
example : 4000
2016-09-21 04:26:40 +00:00
white_value :
2017-10-30 20:39:12 +00:00
description : Number between 0..255 indicating level of white.
2019-10-03 20:28:53 +00:00
example : "250"
2015-09-27 06:17:04 +00:00
brightness :
2019-04-03 18:30:03 +00:00
description : Number between 0..255 indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.
2015-09-27 06:17:04 +00:00
example : 120
2017-05-17 06:00:46 +00:00
brightness_pct :
2019-04-03 18:30:03 +00:00
description : Number between 0..100 indicating percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light.
2017-05-17 06:00:46 +00:00
example : 47
2015-09-27 06:17:04 +00:00
profile :
2017-10-30 20:39:12 +00:00
description : Name of a light profile to use.
2015-09-27 06:17:04 +00:00
example : relax
flash :
2019-10-04 15:46:23 +00:00
description : If the light should flash. Valid values are short and long.
example : short
2015-09-27 06:17:04 +00:00
values :
- short
- long
effect :
2017-10-30 20:39:12 +00:00
description : Light effect.
2019-10-04 15:46:23 +00:00
example : random
2015-09-27 06:17:04 +00:00
values :
- colorloop
2015-12-25 03:10:27 +00:00
- random
2015-09-27 06:17:04 +00:00
turn_off :
2017-10-30 20:39:12 +00:00
description : Turn a light off.
2015-09-27 06:17:04 +00:00
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to turn off.
2019-10-03 20:28:53 +00:00
example : "light.kitchen"
2015-09-27 06:17:04 +00:00
transition :
2017-10-30 20:39:12 +00:00
description : Duration in seconds it takes to get to next state.
2015-09-27 06:17:04 +00:00
example : 60
2016-09-04 10:04:12 +00:00
flash :
2019-10-04 15:46:23 +00:00
description : If the light should flash. Valid values are short and long.
example : short
2016-09-04 10:04:12 +00:00
values :
- short
- long
2016-01-16 15:45:05 +00:00
toggle :
2017-10-30 20:39:12 +00:00
description : Toggles a light.
2016-01-16 15:45:05 +00:00
fields :
2019-10-03 20:28:53 +00:00
entity_id :
description : Name(s) of entities to turn on
example : "light.kitchen"
transition :
description : Duration in seconds it takes to get to next state
example : 60
rgb_color :
description : Color for the light in RGB-format.
example : "[255, 100, 100]"
color_name :
description : A human readable color name.
example : "red"
hs_color :
description : Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.
example : "[300, 70]"
xy_color :
description : Color for the light in XY-format.
example : "[0.52, 0.43]"
color_temp :
description : Color temperature for the light in mireds.
example : 250
kelvin :
description : Color temperature for the light in Kelvin.
example : 4000
white_value :
description : Number between 0..255 indicating level of white.
example : "250"
brightness :
description : Number between 0..255 indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.
example : 120
brightness_pct :
description : Number between 0..100 indicating percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light.
example : 47
profile :
description : Name of a light profile to use.
example : relax
flash :
2019-10-04 15:46:23 +00:00
description : If the light should flash. Valid values are short and long.
example : short
2019-10-03 20:28:53 +00:00
values :
- short
- long
effect :
description : Light effect.
2019-10-04 15:46:23 +00:00
example : random
2019-10-03 20:28:53 +00:00
values :
- colorloop
- random
2016-11-18 06:14:06 +00:00
2017-06-27 05:05:32 +00:00
lifx_set_state :
2017-10-30 20:39:12 +00:00
description : Set a color/brightness and possibliy turn the light on/off.
2017-06-27 05:05:32 +00:00
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to set a state on.
2019-10-03 20:28:53 +00:00
example : "light.garage"
"..." :
2017-10-30 20:39:12 +00:00
description : All turn_on parameters can be used to specify a color.
2017-06-27 05:05:32 +00:00
infrared :
2017-10-30 20:39:12 +00:00
description : Automatic infrared level (0..255) when light brightness is low.
2017-06-27 05:05:32 +00:00
example : 255
2017-07-14 02:38:36 +00:00
zones :
2017-10-30 20:39:12 +00:00
description : List of zone numbers to affect (8 per LIFX Z, starts at 0).
2019-10-03 20:28:53 +00:00
example : "[0,5]"
2017-06-27 05:05:32 +00:00
transition :
2017-10-30 20:39:12 +00:00
description : Duration in seconds it takes to get to the final state.
2017-06-27 05:05:32 +00:00
example : 10
power :
description : Turn the light on (True) or off (False). Leave out to keep the power as it is.
example : True
lifx_effect_pulse :
description : Run a flash effect by changing to a color and back.
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to run the effect on.
2019-10-03 20:28:53 +00:00
example : "light.kitchen"
2017-06-27 05:05:32 +00:00
mode :
2019-10-03 20:28:53 +00:00
description : "Decides how colors are changed. Possible values: blink, breathe, ping, strobe, solid."
2017-06-27 05:05:32 +00:00
example : strobe
brightness :
2017-10-30 20:39:12 +00:00
description : Number between 0..255 indicating brightness of the temporary color.
2017-06-27 05:05:32 +00:00
example : 120
color_name :
2017-10-30 20:39:12 +00:00
description : A human readable color name.
2019-10-03 20:28:53 +00:00
example : "red"
2017-06-27 05:05:32 +00:00
rgb_color :
2017-10-30 20:39:12 +00:00
description : The temporary color in RGB-format.
2019-10-03 20:28:53 +00:00
example : "[255, 100, 100]"
2017-06-27 05:05:32 +00:00
period :
2017-10-30 20:39:12 +00:00
description : Duration of the effect in seconds (default 1.0).
2017-06-27 05:05:32 +00:00
example : 3
cycles :
2017-10-30 20:39:12 +00:00
description : Number of times the effect should run (default 1.0).
2017-06-27 05:05:32 +00:00
example : 2
power_on :
2017-10-30 20:39:12 +00:00
description : Powered off lights are temporarily turned on during the effect (default True).
2017-06-27 05:05:32 +00:00
example : False
lifx_effect_colorloop :
description : Run an effect with looping colors.
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to run the effect on.
2019-10-03 20:28:53 +00:00
example : "light.disco1, light.disco2, light.disco3"
2017-06-27 05:05:32 +00:00
brightness :
2017-10-30 20:39:12 +00:00
description : Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light.
2017-06-27 05:05:32 +00:00
example : 120
period :
2017-10-30 20:39:12 +00:00
description : Duration (in seconds) between color changes (default 60).
2017-06-27 05:05:32 +00:00
example : 180
change :
2017-10-30 20:39:12 +00:00
description : Hue movement per period, in degrees on a color wheel (ranges from 0 to 360, default 20).
2017-06-27 05:05:32 +00:00
example : 45
spread :
2017-10-30 20:39:12 +00:00
description : Maximum hue difference between participating lights, in degrees on a color wheel (ranges from 0 to 360, default 30).
2017-06-27 05:05:32 +00:00
example : 0
power_on :
2017-10-30 20:39:12 +00:00
description : Powered off lights are temporarily turned on during the effect (default True).
2017-06-27 05:05:32 +00:00
example : False
lifx_effect_stop :
description : Stop a running effect.
fields :
entity_id :
description : Name(s) of entities to stop effects on. Leave out to stop effects everywhere.
2019-10-03 20:28:53 +00:00
example : "light.bedroom"
2018-01-19 06:52:30 +00:00
xiaomi_miio_set_scene :
description : Set a fixed scene.
fields :
entity_id :
description : Name of the light entity.
2019-10-03 20:28:53 +00:00
example : "light.xiaomi_miio"
2018-01-19 06:52:30 +00:00
scene :
description : Number of the fixed scene, between 1 and 4.
example : 1
2018-02-27 20:27:52 +00:00
xiaomi_miio_set_delayed_turn_off :
description : Delayed turn off.
fields :
entity_id :
description : Name of the light entity.
2019-10-03 20:28:53 +00:00
example : "light.xiaomi_miio"
2018-02-27 20:27:52 +00:00
time_period :
description : Time period for the delayed turn off.
2018-02-27 23:16:49 +00:00
example : "5, '0:05', {'minutes': 5}"