Get all floors: floors

The floors template function returns a list of all 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] IDs in your Home Assistant instance. Each floor you’ve created in Home Assistant has a unique ID, and this function gives you all of them.

This is useful when you want to loop through every floor in your home and do something with it. For example, you could check which floors have lights on, count how many areasAn 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] are on each floor, or build a summary of activity across your entire home. Since floors can be added or removed at any time, using floors() ensures your 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 reflect your current setup.

Usage

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

{{ floors() }}

[
  "ground_floor",
  "first_floor",
  "basement",
]

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.

floors() -> list[str]

Good to know

• Returns floor IDs, not names. Pair with floor_name to display names.
• The order is not guaranteed, so sort before display if you need a stable ordering.

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 how many floors you have

A convenient way to see how many floors are set up in your Home Assistant instance.

{{ floors() | count }}

3

List all floor names

Loop through all floors and display their names using floor_name.

{% for floor_id in floors() %}
  {{ floor_name(floor_id) }}
{% endfor %}

Ground Floor
First Floor
Basement

Count lights on per floor

Build a summary of how many lights are on across each floor. This loops through all floors, gathers the 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] on each one using floor_entities, and counts the active lights.

{% for id in floors() %}
  {% set lights = floor_entities(id)
    | select("match", "light.")
    | select("is_state", "on")
    | list %}
  {% if lights | count > 0 %}
    {{ floor_name(id) }}: {{ lights | count }} lights on
  {% endif %}
{% endfor %}

Ground Floor: 5 lights on
First Floor: 2 lights on

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 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 areas on a floor: floor_areas - Returns a list of area IDs that belong to a given floor.

• Get entities on a floor: floor_entities - Returns a list of entity IDs for all entities on a given floor.

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