This script replicates Hue scenes for Home Assistant. Each scene has five different colors represented by XY values. These colors are distributed randomly on the participating lights (must support XY or RGB color modes) -- each light gets a different color.

The script can run in two modes, selectable at runtime, corresponding to setting lights once or repeatedly. If repeat_delay is specified at the start of the script, it runs continuously, with the specified delay in between rounds. In this case, the end of the script is determined by the stop_when_lights_turn_off parameter: If set to true, the script turns off when one of the participating lights is turned off. If set to false, the script runs until it is turned off.

If repeat_delay is left empty or set to 0:00:00, lights are set once and the script ends.

The script has various configuration options, described below.

Usage

The intended setup is to instantiate the blueprint for each area in which it will be run. To facilitate daily use, you can define buttons as pre-defined action call. To launch the scene "Savanna sunset" as a dynamic scene, you can define a mushroom card like this:

type: custom:mushroom-template-card
primary: Savanna sunset
picture: /local/hue/Savanna sunset.jpg
tap_action:
  action: call-service
  service: script.hue_like_scenes
  target: {}
  data:
    scene: Savanna sunset

If called as part of another script, make sure to use the action script.turn_on, so that it runs in the background (see here):

action: script.turn_on
data:
  variables:
    scene: Savanna sunset
metadata: {}
target:
  entity_id: script.hue_like_scenes

Changelog

3.4

• You can now specify a label, which will then be added to all participating lights. This requires Spook to be installed, which can be done via HACS. Assigning a label makes it easier to control the brightness of the participating lights. It is best to use one label per script, and not to use these labels for anything else, because the script first removes the label from all entities.
• For specifying your own scene, it is no longer necessary to also specify a brightness (i.e., you can omit the "b" key in the object).
• Specifying your own scene is no longer a required argument.

3.3

• When launching the script, it is now possible to specify your own colors. If the script is called with specified colors, the scene changes to "Special: My scene". There is no limit on the number of colors. It is probably the best use to define a button to call the script with specific colors. The YAML code for such a call looks like this:

  tap_action:
    action: perform-action
    perform_action: ENTITY_ID_OF_THE_SCRIPT
    target: {}
    data:
      scene: "Special: My scene"
      repeat_delay:
        hours: 0
        minutes: 0
        seconds: 30
      onlyonlights: false
      use_scene_brightness: false
      brightness: 100
      my_scene:
        c:
          - - 0.2361
            - 0.2152
          - - 0.2557
            - 0.2325
        b: 0.6
  

  Note: This may not be the final form of the feature. If possible, it would be cool to specify your own scenes as part of the blueprint instantiation.

3.2

• Newer scene categories added (Daily, Halloween, Race day, Romantic, Winter holidays). Thanks @Glennmen!
• Updated format for storing scene information.

3.1.1

• Fixed a bug that sometimes set small brightness values to zero because of rounding. Thanks @Glennmen!

3.1

• The list of scenes that are offered can now also be restricted as part of the blueprint setup. I.e., if you know that some scenes will never be needed, you can deselect them, and they will not be shown in the dropdown. They can still be selected as part of an action call.
• Default scenes (Bright, Concentrate, Cool bright, Dimmed, Energize, Nightlight, Read, Relax, Rest) will now also be applied to bulbs that don't support colors, but only color temperature. In addition, there is a toggle setting in the blueprint to always include non-color bulbs for all scenes.

3.0

• Added default Hue scenes (Bright, Concentrate, Cool bright, Dimmed, Energize, Nightlight, Read, Relax, Rest).
• Scene selection dropdown now shows scene set (Cozy, Defaults, Dreamy, Futuristic, Lush, Luxurious, Party vibes, Peaceful, Pure, Refreshing, Serenity, Sunrise). When launching the script (e.g. as an action), users can use the simple name as before, or a combination of set and scene name (e.g., Cozy: Savanna sunset).
• The script now includes pre-defined brightness settings. When starting, one now has three options: a) Define a brightness value, b) use the scene-defined value, and c) leave the brightness as it is.
• As part of the blueprint input settings, it is now possible to also set default values for the script. All script fields can be specified, and the script can then be run without any arguments (e.g., if you're mostly using one scene, you can set it as default).
• Fixed a bug for non-dynamic scenes

2.5.1

• Fixed a bug in assigning first colors for colorloop.

2.5

• Added input stop_when_lights_turn_off to allow running the script continuously.
• Added scene "Colorloop", which iterates over the entire color wheel. Colorloop uses hs color scheme, and only changes the hue value without touch the saturation.
• Re-added a scene consisting of random colors. Note that random colors are selected once when the script starts and then distributed over the lights.
• Added input debug to generate debug messages in the log.

2.4

• It is now possible to also specify devices. If a device has multiple entities from the light domain, all will be added individually.

2.3

• Selecting the lights is now done via proper lists, and no longer relies on parsing json
• New scene: Malibu pink
• Description of the scene field is shorter
• Added a report entity field. This can be a input_text entity and whenever a scene is set, the scene name is written into the entity.

2.2

• Transition time is now a blueprint field.
• Repeat delay now has a default value of two minutes.
• Fixed bug in duration format.

2.1

• The blueprint now contains all the Hue color scenes that are listed here.

2.0

• Made into a blueprint. Intended use case: Instantiate blueprint for each area (then they can run independently in parallel).
• Supports loop mode, a.k.a. dynamic scenes
• Can exclude lights by manufacturer
• Select lights by labels

Scene images

The images used in the Hue app to represent a scene use creative commons licenses. The following is a list of (some) scenes and image sources:

• Savanna Sunset: https://www.flickr.com/photos/ladydragonflyherworld/6293722846
• Majestic Morning: https://unsplash.com/photos/aerial-photo-of-foggy-trees-and-mountains-dbu1zrkZZuo
• Horizon: https://www.pexels.com/photo/rocks-on-water-2261500/
• Tropical Twilight: https://www.flickr.com/photos/130079987@N02/16342014082
• Crocus: https://unsplash.com/photos/close-up-photo-of-purple-petaled-flower-hB_xgEXucQs