Test device attribute: is_device_attr

The is_device_attr template function checks whether a specific attribute of a deviceA device is a model representing a physical or logical unit that contains entities. matches a given value. It returns true or false. This is the device-level equivalent of is_state_attr, working with the device registry instead of entity states.

This is useful when you want to make decisions in automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] or templatesA 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] based on device properties. For example, you could check if a device is made by a specific manufacturer, runs a particular firmware version, or matches a certain model. You might use it to apply different logic depending on the hardware vendor, or to trigger an alert when a device’s software version doesn’t match the expected value after an update.

Usage

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

{{ is_device_attr("a1b2c3d4e5f6a1b2c3d4e5f6", "manufacturer", "Philips") }}

true

{% if "a1b2c3d4e5f6a1b2c3d4e5f6" is is_device_attr("manufacturer", "Philips") %}
  This is a Philips device!
{% endif %}

This is a Philips device!

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_device_attr(
    device_or_entity_id: str,
    attr_name: str,
    attr_value: Any,
) -> bool

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns false (not an error) when the device or attribute does not exist.
• The device or entity ID must be text. If it’s None, the template fails with the error Must provide a device or entity ID.
• String comparison is case-sensitive. is_device_attr(id, "manufacturer", "philips") does not match "Philips".
• Accepts either a device ID or an entity ID. With an entity ID, the device is resolved first.

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 device is a specific model

Verify that a device matches an expected model, for example to apply model-specific logic in an automation.

{{ is_device_attr("light.living_room", "model", "LCA001") }}

true

Use in an automation condition

Only run the rest of the automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] if the device is from a specific manufacturer.

condition:
  - condition: template
    value_template: >
      {{ is_device_attr("sensor.front_door", "manufacturer", "Aqara") }}

Check firmware version across devices in an area

Combine with area_devices to find devices in an area that are running a specific firmware version.

{% for dev_id in area_devices("Living Room") %}
  {% if is_device_attr(dev_id, "sw_version", "1.104.2") %}
    {{ device_name(dev_id) }}
  {% endif %}
{% endfor %}

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 device attribute: device_attr - Returns the value of a specific attribute from a device.

• Get a device ID: device_id - Returns the device ID for a given entity ID or device name.

• Get a device name: device_name - Returns the name of a device from a device ID or entity ID.

• Get entities for a device: device_entities - Returns a list of entity IDs associated with a given device.