Random effect

The Random effect action plays a generated, ever-changing color effect on a TP-Link light strip. You set the colors, ranges, and timing, and the light keeps cycling through random combinations within those bounds.

This effect is available on devices that support light effects, such as bulbs and light strips, except for Kasa bulbs. Colors are expressed as HSV sequences, where each value is hue, saturation, and brightness.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To play a random effect from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create to start a new one.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
  4. In the Then do section, select Add action.
  5. Select what you want to control. Under By target (see Targets), select the light strip you want to control.
  6. From the actions shown for that target, select Random effect.
  7. Set the options you want to use.
  8. Select Save.

Options in the UI

Initial states (Required)

The initial HSV sequence to start the effect from.

Backgrounds (Optional)

A list of HSV sequences to use as background colors. Up to 16 entries.

Segments (Optional)

The list of segments to apply the effect to. Use 0 for all segments.

Brightness (Optional)

The initial brightness, from 1 to 100%.

Duration (Optional)

How long the effect runs, in milliseconds. Use 0 to run continuously.

Transition (Optional)

The transition time between colors, in milliseconds.

Fade off (Optional)

The fade-off time when the effect ends, in milliseconds.

Hue range (Optional)

The range of hue values the effect can pick from.

Saturation range (Optional)

The range of saturation values the effect can pick from.

Brightness range (Optional)

The range of brightness values the effect can pick from.

Transition range (Optional)

The range of transition times the effect can pick from, in milliseconds.

Random seed (Optional)

The seed used to generate the random effect.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as tplink.random_effect. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: tplink.random_effect
target:
  entity_id: light.strip
data:
  init_states: [199, 99, 96]
  backgrounds:
    - [199, 89, 50]
    - [160, 50, 50]
    - [180, 100, 50]
  segments: [0, 2, 4, 6, 8]
  brightness: 90
  transition: 2000
  fadeoff: 2000
  hue_range: [340, 360]
  saturation_range: [40, 95]
  brightness_range: [90, 100]
  transition_range: [2000, 6000]
  random_seed: 80

This plays a random effect on light.strip within the given color and timing ranges.

Options in YAML

init_states list Required

The initial HSV sequence to start the effect from.

backgrounds list

A list of HSV sequences to use as background colors. Up to 16 entries.

segments list

The list of segments to apply the effect to. Use 0 for all segments.

brightness integer

The initial brightness, from 1 to 100%.

duration integer

How long the effect runs, in milliseconds, from 0 to 5000. Use 0 to run continuously.

transition integer

The transition time between colors, in milliseconds, from 0 to 6000.

fadeoff integer

The fade-off time when the effect ends, in milliseconds, from 0 to 3000.

hue_range list

The range of hue values the effect can pick from.

saturation_range list

The range of saturation values the effect can pick from.

brightness_range list

The range of brightness values the effect can pick from.

transition_range list

The range of transition times the effect can pick from, in milliseconds.

random_seed integer

The seed used to generate the random effect, from 1 to 600.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching light entity behind that target.

  • Entity: one specific light entity, such as light.living_room.
  • Device: every light entity that belongs to a device.
  • Area: every light entity in a room or area.
  • Floor: every light entity on a floor.
  • Label: every light entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

  • Light effects are only available on supported devices, such as bulbs and light strips. Kasa bulbs do not support them.
  • Colors use HSV sequences, where each value is hue, saturation, and brightness.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: