core/homeassistant/components/light/services.yaml

96 lines
2.0 KiB
YAML
Raw Normal View History

2015-09-27 06:17:04 +00:00
# Describes the format for available light services
turn_on:
description: Turn a light on
fields:
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'
2015-09-27 06:17:04 +00:00
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'
white_value:
description: Number between 0..255 indicating level of white
example: '250'
2015-09-27 06:17:04 +00:00
brightness:
description: Number between 0..255 indicating brightness
example: 120
profile:
description: Name of a light profile to use
example: relax
flash:
description: If the light should flash
values:
- short
- long
effect:
description: Light effect
values:
- colorloop
- random
2015-09-27 06:17:04 +00:00
turn_off:
description: Turn a light off
fields:
entity_id:
description: Name(s) of entities to turn off
example: 'light.kitchen'
transition:
description: Duration in seconds it takes to get to next state
example: 60
flash:
description: If the light should flash
values:
- short
- long
toggle:
description: Toggles a light
fields:
entity_id:
description: Name(s) of entities to toggle
example: 'light.kitchen'
transition:
description: Duration in seconds it takes to get to next state
example: 60
hue_activate_scene:
description: Activate a hue scene stored in the hue hub
fields:
group_name:
description: Name of hue group/room from the hue app
example: "Living Room"
scene_name:
description: Name of hue scene from the hue app
example: "Energize"