Get areas on a floor: floor_areas

The floor_areas template function returns a list of 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] IDs that belong to a given 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]. You can specify the floor by its name (like “Ground Floor”) or by its internal ID. It gives you all areas that have been assigned to that floor in Home Assistant.

This is useful when you want to work with all areas on a particular floor at once. For example, you could turn off every light on the ground floor at bedtime, check if any room upstairs has an open window, or count how many rooms are on each floor. As you add or remove areas from a floor 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.

{{ floor_areas("Ground Floor") }}

[
  "living_room",
  "kitchen",
  "hallway",
]

{{ "Ground Floor" | floor_areas }}

[
  "living_room",
  "kitchen",
  "hallway",
]

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

floor_areas(
    floor_id_or_name: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns an empty list when the floor does not exist or has no areas assigned.
• Returns area IDs, not human-readable names. Use area_name to get the names.

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 areas are on a floor

Find out how many areas are assigned to a given floor.

{{ floor_areas("Ground Floor") | count }}

3

List the area names on a floor

Loop through all areas on a floor and display their names using area_name.

{% for area_id in floor_areas("Ground Floor") %}
  {{ area_name(area_id) }}
{% endfor %}

Living Room
Kitchen
Hallway

Check if any area on a floor has motion

Loop through all areas on a floor and check if any has an active motion sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more]. This uses area_entities to get the entities for each area.

{% for area_id in floor_areas("First Floor") %}
  {% if area_entities(area_id)
      | select("match", "binary_sensor.")
      | select("is_state", "on")
      | list
      | count > 0 %}
    Motion in {{ area_name(area_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 entities on a floor: floor_entities - Returns a list of entity IDs for all entities on a given floor.

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

• Get floor name: floor_name - Returns the friendly name of a floor from its ID, area name, device ID, or entity ID.

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

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

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