Test if odd: odd

The odd test checks whether an integer is odd (not divisible by 2). It returns true for odd numbers and false for even numbers.

Like even, this test is commonly used in loops to apply alternating styles or logic. It can also be used with select and reject to filter lists of numbers based on whether they are odd.

Usage

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

{% if 3 is odd %}
  It is odd
{% endif %}

It is odd

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.

odd(
    value: int,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• Zero is even, not odd.
• The input must be an integer. Floats or strings raise an error unless converted first.

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 numbers

{{ 3 is odd }}
{{ 8 is odd }}
{{ 1 is odd }}

true
false
true

Filter odd numbers from a list

Use select to extract only odd numbers from a range.

{{ range(1, 11) | select("odd") | list }}

[1, 3, 5, 7, 9]

Count odd-valued sensors

Count how many sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more] in a group have odd integer values.

{% set values = [
  states("sensor.counter_a") | int(0),
  states("sensor.counter_b") | int(0),
  states("sensor.counter_c") | int(0)
] %}
{{ values | select("odd") | list | count }} sensors have odd values

2 sensors have odd values

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 divisible by: divisibleby - Tests whether a number is divisible by another number.

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