jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs with info about the new LIFX paint_theme action (#36931)

Browse Source 
* Update docs with info about the new LIFX paint_theme action

Signed-off-by: Avi Miller <me@dje.li>

* Address Code Rabbit nitpicks and make the palette syntax more explicit

Signed-off-by: Avi Miller <me@dje.li>

* Address Code Rabbit's last nitpick

Signed-off-by: Avi Miller <me@dje.li>

* tiny tweak

---------

Signed-off-by: Avi Miller <me@dje.li>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Avi Miller 2025-01-17 18:56:15 +11:00 committed by GitHub
parent c5312ffce9
commit 4b7cadd676
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_integrations/lifx.markdown
View File

@ -86,7 +86,21 @@ To apply a theme interactively, use the theme selection drop-down box found on t
To apply a theme as part of an automation, use the `select.select_option` action call. You can also apply a theme when calling the `lifx.effect_move` action. See the **Light effects** section below for more details, including how to set a custom theme for that effect.
The following themes are available: `autumn`, `blissful`, `cheerful`, `dream`, `energizing`, `epic`, `exciting`, `focusing`, `halloween`, `hanukkah`, `holly`, `independence_day`, `intense`, `mellow`, `peaceful`, `powerful`, `relaxing`, `santa`, `serene`, `soothing`, `sports`, `spring`, `tranquil`, `warming`.
The following themes are available: `autumn`, `blissful`, `bias_lighting`, `calaveras`, `cheerful`, `christmas`, `dream`, `energizing`, `epic`, `evening`, `exciting`, `fantasy`, `focusing`, `gentle`, `halloween`, `hanukkah`, `holly`, `hygge`, `independence`, `intense`, `love`, `kwanzaa`, `mellow`, `party`, `peaceful`, `powerful`, `proud`, `pumpkin`, `relaxing`, `romance`, `santa`, `serene`, `shamrock`, `soothing`, `spacey`, `sports`, `spring`, `stardust`, `thanksgiving`, `tranquil`, `warming`, `zombie`.
### Action `lifx.paint_theme`
This action allows you to paint either one of the predefined themes listed above, or you can specify a custom palette and create your own theme. Your palette must be a list of at least two colors each defined as a list of four integer values representing hue, saturation, brightness, and kelvin (in that order). See below for the allowed range for each value.
If you provide a value for both `palette` and `theme`, then the palette will override the theme. If neither is provided, the `exciting` theme is used by default.
| Data attribute | Description |
| ---------------------- | ----------- |
| `palette` | (optional, overrides `theme`) a list of 2 to 16 colors defined as a list of values representing hue (0-360), saturation (0-100), brightness (0-100), and kelvin (1500-9000). All four values must be provided for each color. |
| `theme` | (optional, overridden by `palette`) the name of the theme to paint on the target lights. See above for a list of available themes. |
| `transition` | (optional, default: 1 second) duration in seconds to paint the theme across the target lights. |
| `power_on` | (optional, default: True) set this to `False` to prevent lights being turned on before the theme is painted. |
## Light effects
@ -183,11 +197,11 @@ The device will be powered on by default, but this can be overridden by setting
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of matrix lights.
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 1s, max: 25s)
| `palette` | A list of at least 2 and at most 16 HSBK values to use for this effect.
| `theme` | The theme to use for the effect. Must be one of: `autumn`, `blissful`, `cheerful`, `dream`, `energizing`, `epic`, `exciting`, `focusing`, `halloween`, `hanukkah`, `holly`, `independence` `day`, `intense`, `mellow`, `peaceful`, `powerful`, `relaxing`, `santa`, `serene`, `soothing`, `sports`, `spring`, `tranquil`, `warming`.
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true)
| `entity_id` | String or list of strings that point at `entity_id`s of matrix lights. |
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 1s, max: 25s) |
| `palette` | A list of at least 2 and at most 16 HSBK values to use for this effect (optional, overrides theme). |
| `theme` | The theme to use for the effect. See above for a list of available themes (optional, overridden by palette). |
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true) |
### Action `lifx.effect_sky`
@ -242,11 +256,11 @@ The effect will not be visible if all LEDs on the device are set to the same col
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of multizone lights.
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 0.1s, max: 60s)
| `direction` | The direction in which the effect will travel, either "right" or "left" (default: right)
| `theme` | The name of a pre-defined theme to apply to the multizone device before starting the effect.
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true)
| `entity_id` | String or list of strings that point at `entity_id`s of multizone lights. |
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 0.1s, max: 60s) |
| `direction` | The direction in which the effect will travel, either "right" or "left" (default: right) |
| `theme` | The theme to use for the effect. See above for a list of available themes (optional). |
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true) |
### Action `lifx.effect_stop`