Test if in sequence: in

The in test checks whether a value is contained in a given sequence (list, tuple, or string). It returns true if the value is found and false otherwise. Use value is in(sequence) to perform the check.

This test is useful when you want to check if an entityAn 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] state matches one of several possible values, or when filtering collections. While you can use Python’s in operator directly in conditions (if state in ["on", "off"]), the in test can be used with filters like select and reject that expect a test name.

Usage

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

{% if "on" is in(["on", "off", "idle"]) %}
  Found in list
{% endif %}

Found in list

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.

in(
    value: Any,
    seq: Sequence,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• String membership is case-sensitive. "ON" is in(["on", "off"]) is false.
• On a string, this checks for substring presence rather than whole-word matching.
• Unlike Python’s in operator, this is a Jinja test, so it works as a filter argument in select and reject.

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 if state is one of several values

Verify that a sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] state matches an expected set of values.

{% set state = states("climate.thermostat") %}
{% if state is in(["heat", "cool", "auto"]) %}
  Climate is active: {{ state }}
{% else %}
  Climate is idle
{% endif %}

Climate is active: heat

Check for substring in a string

The in test also works with strings, checking for substring membership.

{{ "error" is in("Connection error occurred") }}

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:

• Test equality: eq - Tests if two values are equal. Also known as equalto or ==.

• Check if value contains another: contains - Tests if a value contains another value. Works with strings, lists, and dictionaries.

• Test if sequence: sequence - Tests whether a value is a sequence (list, tuple, or string).

• Filter items by test: select - Filters a list, keeping only items that pass a given test.