Convert to tuple: tuple

The tuple template function converts a collection (like a list) into a tuple. A tuple is similar to a list but is immutable, meaning its contents cannot be changed after creation. This can be useful when you need a hashable, fixed sequence of values.

Tuples are useful in specific situations where you need an immutable sequence. For example, some template operations or comparisons work better with tuples, and tuples can be used as dictionary keys because they are hashable (unlike lists). In most day-to-day Home Assistant templatesA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more], lists work fine, but tuple is available when you need this specific data type.

Usage

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

{{ tuple([1, 2, 3]) }}

(1, 2, 3)

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 = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.

The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any

tuple(
    value: list,
) -> tuple

Function parameters

The following parameters can be provided to this function.

Good to know

• Tuples are immutable. Once created, you cannot append to or modify them. Use a list if you need to change items later.
• Most Home Assistant template work does not need tuples. Reach for them when you need a hashable value to use as a dictionary key or set member.

Try it yourself

Ready to test this? Open Settings > 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.

Convert a list of coordinates to a tuple

Create a fixed coordinate pair from a list.

{{ tuple([52.5, 13.4]) }}

(52.5, 13.4)

Use a tuple for comparison

Tuples can be compared directly, which is useful for checking if a set of values matches an expected combination.

{{ tuple([1, 2, 3]) == tuple([1, 2, 3]) }}

true

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:

• Convert to set: set - Converts an iterable to a set, removing duplicate values.

• Flatten nested lists: flatten - Flattens nested lists into a single flat list.