Test if divisible by: divisibleby

The divisibleby test checks whether a number is evenly divisible by another number (the remainder is zero). It returns true if the division has no remainder and false otherwise. Use value is divisibleby(num) to perform the check.

This is useful for creating patterns in loops, such as applying different formatting to every third or fifth item. It can also be used with select and reject to filter lists of numbers based on divisibility.

Usage

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

{% if 10 is divisibleby(5) %}
  Divisible by 5
{% endif %}

Divisible by 5

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.

divisibleby(
    value: int,
    num: int,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• Both inputs must be integers. Floats raise an error unless converted with int first.
• Dividing by zero 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.

Check various values

Test whether numbers are divisible by a given divisor.

{{ 12 is divisibleby(3) }}
{{ 12 is divisibleby(5) }}
{{ 100 is divisibleby(10) }}

true
false
true

Filter multiples from a list

Use select to find all numbers in a list that are multiples of a given number.

{{ range(1, 21) | select("divisibleby", 4) | list }}

[4, 8, 12, 16, 20]

Apply alternating row styles in a loop

Use divisibleby to create a pattern every N iterations in a loop.

{% for i in range(1, 7) %}
  {{ i }}{% if i is divisibleby(3) %} (group boundary){% endif %}
{% endfor %}

1
2
3 (group boundary)
4
5
6 (group boundary)

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:

• Test if even: even - Tests whether a number is even.

• Test if odd: odd - Tests whether a number is odd.

• Convert to integer: int - Converts a value to an integer, with an optional default if conversion fails.

• Convert to float: float - Converts a value to a floating-point number, with an optional default if conversion fails.