Get entities on a floor: floor_entities

The floor_entities template function returns a list of 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 for all entities on 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 gathers entities from every 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] assigned to that floor, giving you a single flat list.

This is useful when you want to work with all entities across an entire floor at once, without having to loop through each area individually. For example, you could turn off every light on the upstairs floor at bedtime, count how many sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more] are active on the ground floor, or check if any window on a particular floor is open. As you add or remove devicesA device is a model representing a physical or logical unit that contains entities. and 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.

Usage

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

{{ floor_entities("Ground Floor") }}

[
  "light.living_room_ceiling",
  "sensor.living_room_temperature",
  "light.kitchen_counter",
  "sensor.kitchen_humidity",
  "light.hallway",
]

{{ "Ground Floor" | floor_entities }}

[
  "light.living_room_ceiling",
  "sensor.living_room_temperature",
  "light.kitchen_counter",
  "sensor.kitchen_humidity",
  "light.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 default are required.

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

Function parameters

The following parameters can be provided to this function.

Good to know

• Entities without an area (or whose area is not assigned to a floor) are not included.
• The result aggregates entities across every area on the floor, including entities inherited from devices in those areas.

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 across a floor

Want to know how many lights are currently on across an entire floor? This filters the floor’s entities down to lights and counts the ones that are on.

{{
  floor_entities("Ground Floor")
  | select("match", "light.")
  | select("is_state", "on")
  | list
  | count
}}

3

Check if any window is open on a floor

This checks whether any window sensor on the first floor is currently open. 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, for example to prevent turning on the heating if a window is open upstairs.

{{
  floor_entities("First Floor")
  | select("match", "binary_sensor.")
  | select("is_state", "on")
  | list
  | count > 0
}}

true

Turn off all lights on a floor

Use floor_entities in an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] action to turn off every light on a given floor. This is handy for a “goodnight” routine that shuts down an entire floor.

action:
  - action: light.turn_off
    target:
      entity_id: >
        {{
          floor_entities("First Floor")
          | select("match", "light.")
          | list
        }}

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