Test state attribute: is_state_attr

The is_state_attr template function checks whether a specific attribute of 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] matches a given value. It returns true or false. This is the attribute equivalent of is_state, which checks the main state.

You’ll use this when you need to make decisions based on an entity’s attributes rather than its main state. For example, checking if a light’s color mode is set to color_temp, if a media player’s source is a specific input, or if a deviceA device is a model representing a physical or logical unit that contains entities.‘s battery level is at a certain value. Like is_state, it safely returns false if the entity doesn’t exist.

Usage

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

{{ is_state_attr("light.desk", "color_mode", "color_temp") }}

true

{% if "light.desk" is is_state_attr("color_mode", "color_temp") %}
  Light is in color temperature mode
{% endif %}

Light is in color temperature mode

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 = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.

The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any

is_state_attr(
    entity_id: str,
    attribute: str,
    value: Any,
) -> bool

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns false (not an error) when the entity or attribute does not exist.
• The comparison is type-strict. is_state_attr("light.x", "brightness", "255") is false when the attribute is the integer 255.

Try it yourself

Ready to test this? Open Settings > 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 a media player is playing from a specific source

{{ is_state_attr("media_player.tv", "source", "HDMI 1") }}

true

Use in an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] conditionConditions check whether something is true at that moment, for example, whether a door is closed. You can use them in automations and scripts. If a condition is not met, the actions that come after it in the same sequence do not run. At the top level of an automation or script, this stops the automation or script. [Learn more]

Only proceed if the climate system is in heating mode.

condition:
  - condition: template
    value_template: >
      {{ is_state_attr("climate.living_room", "hvac_action", "heating") }}

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:

• Get state attribute: state_attr - Returns the value of a specific attribute from an entity’s state.

• Test entity state: is_state - Tests if an entity is in a specific state.

• Get entity state: states - Returns the state value of an entity, or lets you iterate over all entity states.

• Check if entity has a value: has_value - Tests if an entity exists and has a valid state (not unavailable or unknown).