Choose a random value: random

The random filter chooses a random item from a list. This is Home Assistant’s override of the built-in random filter, with one important difference: it produces a new random value every time the template is evaluated, rather than caching the result.

This is useful when you want to add variety to your automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]. For example, you might want to pick a random color for a light, choose a random greeting message for a notificationYou can use notifications to send messages, pictures, and more, to devices. [Learn more], or select a random playlist to play on a media player. Because the value changes with each evaluation, you get a genuinely different result each time the template runs.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{{ ["red", "green", "blue"] | random }}

green

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically. Function parameters without a default are required.

random(
    values: list,
) -> Any

Function parameters

The following parameters can be provided to this function.

Context-dependent evaluation

Unlike many other template functions, random is context-dependent. This means the result is not cached between evaluations. Each time the template is rendered, a new random choice is made.

{{ ["morning", "afternoon", "evening"] | random }}

afternoon

Good to know

• A new random value is picked every time the template is rendered, so template entities using random re-evaluate and change often.
• Calling random twice in a single template returns two independent picks, which can surprise you if you expect the same value.
• An empty list raises an error.

Try it yourself

Ready to test this? Open Developer tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own 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].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Random light color

Pick a random color for a light from a predefined list.

action:
  - action: light.turn_on
    target:
      entity_id: light.living_room
    data:
      color_name: >
        {{ ["red", "blue", "green", "purple", "orange"] | random }}

Random notification message

Send a different motivational message each time an automation triggers.

action:
  - action: notify.mobile
    data:
      message: >
        {{
          [
            "Have a great day!",
            "Remember to stay hydrated!",
            "You're doing awesome!",
            "Time to stretch!"
          ] | random
        }}

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Related template functions

These functions work well alongside this one:

• Randomly shuffle a list: shuffle - Randomly shuffles the items in a list.