Get entities in an area: area_entities

The area_entities template function returns a list of entity IDs that belong to a given areaAn area in Home Assistant is a logical grouping of devices and entities that are meant to match areas (or rooms) in the physical world: your home. For example, the living room area groups devices and entities in your living room. [Learn more]. You can specify the area by its name (like “Living Room”) or by its internal ID. It gives you all 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] that have been assigned to that area in Home Assistant.

This is useful when you want to work with all entities in a room at once, without having to list each one by hand. For example, you could turn off every light in the bedroom at bedtime, check if any window in the house is open, or count how many motion sensors are currently active on a floorA floor in Home Assistant is a logical grouping of areas that are meant to match the physical floors in your home. Devices & entities are not assigned to floors but to areas. Floors can be used in automations and scripts as a target for actions. For example, to turn off all the lights on the downstairs floor when you go to bed. [Learn more]. As you add or remove devicesA device is a model representing a physical or logical unit that contains entities. from an area in Home Assistant, the list automatically updates, so your automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] and 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] always stay in sync with your actual setup.

Usage

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

{{ area_entities("Living Room") }}

[
  "light.living_room_ceiling",
  "sensor.living_room_temperature",
  "binary_sensor.living_room_motion",
]

{{ "Living Room" | area_entities }}

[
  "light.living_room_ceiling",
  "sensor.living_room_temperature",
  "binary_sensor.living_room_motion",
]

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.

area_entities(
    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 entities or when the name does not match. It does not raise an error.
• Includes both entities assigned directly to the area and entities inherited from devices in that area.
• The names used in the lookup are case-sensitive, so "Living Room" and "living room" are not the same.

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.

Count the lights that are on in an area

Want to know how many lights are currently on in a room? This combines area_entities with filters to narrow down to lights and count the ones that are on.

{{
  area_entities("Kitchen")
  | select("match", "light.")
  | select("is_state", "on")
  | list
  | count
}}

3

Check if any motion sensor is active in an area

This checks whether any motion sensor in the hallway is currently detecting motion. Useful as a conditionConditions are an optional part of an automation that will prevent an action from firing if they are not met. [Learn more] in automations.

{{
  area_entities("Hallway")
  | select("match", "binary_sensor.")
  | 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 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.

• Get devices in an area: area_devices - Returns a list of device IDs associated with a given area.