Test if true: true

The true test checks whether a value is true. It performs a strict identity check, meaning only the boolean value true passes. Values like 1, true, or non-empty strings do not match.

This is useful when you need to verify that a value is specifically the boolean true and not merely a truthy value. In Home Assistant, 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] attributes can be actual booleans, and this test lets you check for an exact true value without accidentally matching other truthy types.

Usage

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

As a test
{% if true is true %}
  It is true
{% endif %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".)
It is true

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.

true(
    value: Any,
) -> bool

Function parameters

The following parameters can be provided to this test.

value any Required

The value to test. Returns true only if the value is the boolean true.

Good to know

  • This is a strict identity check. Truthy values like 1, "yes", or a non-empty list do not pass. Use boolean if you want looser matching.
  • The string "true" is not the boolean true. Entity states are always strings, so comparing a state with this test always returns false.

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.

Strict boolean check

Only the boolean true passes; truthy values like 1 or true do not.

TemplateA 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]
{{ true is true }}
{{ 1 is true }}
{{ "true" is true }}
Result (booleanA value that is either true or false. Used for on/off states, yes/no conditions, and similar binary choices.)
true
false
false

Verify a boolean attribute

Check that 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] attribute is specifically true.

TemplateA 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]
{% set locked = state_attr("lock.front_door", "is_jammed") %}
{% if locked is true %}
  Door is jammed!
{% endif %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".)
Door is jammed!

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.

Tip

AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.

Related template functions

These functions work well alongside this one: