Get devices in an area: area_devices

The area_devices template function returns a list of device IDs that belong to a given areaAn area in Home Assistant is a logical grouping of devices and entities that represents a room or space in your home, such as the living room, kitchen, or garage. [Learn more]. You can specify the area by its name or by its internal ID. While area_entities gives you individual 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] IDs, area_devices gives you the devicesA device is a model representing a physical or logical unit that contains entities. themselves.

This is useful when you need to work at the device level rather than the entity level. For example, you might want to count how many physical devices are in a room, check if a specific device is assigned to an area, or loop through all devices to find their attributes. Each device can have multiple entities, so the device list is typically shorter than the entity list for the same area.

Usage

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

{{ area_devices("Living Room") }}

[
  "a1b2c3d4e5f6a1b2c3d4e5f6",
  "f6e5d4c3b2a1f6e5d4c3b2a1",
]

{{ "Living Room" | area_devices }}

[
  "a1b2c3d4e5f6a1b2c3d4e5f6",
  "f6e5d4c3b2a1f6e5d4c3b2a1",
]

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

area_devices(
    area_name_or_id: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns an empty list when the area has no devices or when the name does not match. It does not raise an error.
• A device can only belong to one area. Entities assigned directly to an area but not through a device are not included here.
• The list contains device IDs, not entity IDs. Use device_entities to get entities from each device.

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.

Count how many devices are in a room

Find out how many physical devices are assigned to an area.

{{ area_devices("Kitchen") | count }}

5

Get the name of each device in an area

Loop through all devices in an area and display their names using device_name.

{% for device_id in area_devices("Living Room") %}
  {{ device_name(device_id) }}
{% endfor %}

Check if any device in an area has a firmware update

Combine area_devices with entity lookups to see if any device in a room has a pending update.

{{
  area_devices("Office")
  | map("device_entities")
  | sum(start=[])
  | select("match", "update.")
  | select("is_state", "on")
  | list
  | count > 0
}}

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:

• Get entities in an area: area_entities - Returns a list of entity IDs associated with a given area.

• Get all areas: areas - Returns a list of all area IDs in your Home Assistant instance.

• Get area ID: area_id - Returns the area ID for a given area name, entity ID, or device ID.

• Get area name: area_name - Returns the friendly name of an area from its ID, entity ID, or device ID.