Generate a number sequence: range

The range template function generates a sequence of numbers. It works just like Python’s built-in range() function. You can call it with only a stop value to get numbers from 0 up to (but not including) that value, or provide start, stop, and step values for full control over the sequence.

This is one of the most commonly used functions in Home Assistant templates, especially when you need to loop a specific number of times or generate a series of numbered values. For example, you might want to check a set of numbered entities, repeat an action a certain number of times, or build a list of values at regular intervals. Since range produces values lazily, you may need to pipe it through | list to see the full output.

Usage

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

{{ range(5) | list }}

[0, 1, 2, 3, 4]

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.

range(
    stop: int,
) -> generator[int]

range(
    start: int,
    stop: int,
    step: int = 1,
) -> generator[int]

Function parameters

The following parameters can be provided to this function.

Specifying start and stop

Generate numbers starting from a value other than 0.

{{ range(1, 6) | list }}

[1, 2, 3, 4, 5]

Using a step value

Generate every other number or count in custom increments.

{{ range(0, 10, 2) | list }}

[0, 2, 4, 6, 8]

Counting downward

Use a negative step to count backward.

{{ range(5, 0, -1) | list }}

[5, 4, 3, 2, 1]

Good to know

• The stop value is exclusive, so range(1, 5) produces 1, 2, 3, 4.
• Add | list to materialize the range for length checks or printing. A generator cannot be reused.
• A negative step is required to count down. range(5, 0) with the default step returns an empty sequence.

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.

Check a set of numbered entities

Loop through a series of numbered sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more] to find which are active.

{% for i in range(1, 5) %}
  {% set entity = "binary_sensor.zone_" ~ i %}
  {% if is_state(entity, "on") %}
    Zone {{ i }} is active
  {% endif %}
{% endfor %}

Zone 2 is active
Zone 4 is active

Count open windows

Use range with a namespace to count how many numbered window sensors are open.

{% set ns = namespace(count=0) %}
{% for i in range(1, 7) %}
  {% if is_state("binary_sensor.window_" ~ i, "on") %}
    {% set ns.count = ns.count + 1 %}
  {% endif %}
{% endfor %}
{{ ns.count }} windows open

2 windows open

Build a percentage bar

Create a text-based progress indicator from a sensor value.

{% set level = states("sensor.battery_level") | int(0) %}
{% set filled = (level / 10) | round(0) | int %}
[
{%- for i in range(10) -%}
  {% if i < filled %}#{% else %}-{% endif %}
{%- endfor -%}
] {{ level }}%

[######----] 60%

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:

• Combine iterables: zip - Zips multiple iterables together into a list of tuples, pairing elements by position.

• Choose a random value: random - Chooses a random value from a list. Returns a different value each time the template is evaluated.