Skip to content

Document brightness step for light.turn_on #11973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
Feb 5, 2020
Merged

Document brightness step for light.turn_on #11973

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9763822
Document brightness step
balloob Feb 4, 2020
436fc08
Clarify light.toggle service
balloob Feb 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions source/_integrations/light.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Most lights do not support all attributes. You can check the integration documen
| `color_name` | yes | A human-readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/css-color-3/#svg-color) are supported.
| `brightness` | yes | Integer between 0 and 255 for how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light.
| `brightness_pct`| yes | Alternatively, you can specify brightness in percent (a number between 0 and 100), where 0 means the light is off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light.
| `brightness_step` | yes | Change brightness by an amount. Should be between -255..255.
| `brightness_step_pct` | yes | Change brightness by a percentage. Should be between -100..100.
| `flash` | yes | Tell light to flash, can be either value `short` or `long`.
| `effect`| yes | Applies an effect such as `colorloop` or `random`.

Expand Down Expand Up @@ -87,7 +89,6 @@ Turns one or multiple lights off.

### Service `light.toggle`

Toggles the state of one or multiple lights using [groups]({{site_root}}/integrations/group/).
Takes the same arguments as [`turn_on`](#service-lightturn_on) service.
Toggles the state of one or multiple lights. Takes the same arguments as [`turn_on`](#service-lightturn_on) service.

*Note*: If `light.toggle` is used for a group of lights, it will toggle the individual state of each light.
*Note*: If `light.toggle` is used for a group of lights, it will toggle the individual state of each light. If you want the lights to be treated as a single light, use [Light Groups](/integrations/light.group/) instead.