Get floor name: floor_name

The floor_name template function returns the friendly, human-readable name of 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]. You can give it a floor ID, an 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] name, an 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] ID, or a deviceA device is a model representing a physical or logical unit that contains entities. ID, and it tells you the name of the floor it belongs to.

This is especially useful for building dynamic messages and notificationsYou can use notifications to send messages, pictures, and more, to devices. [Learn more]. Instead of showing a technical floor ID like ground_floor, you can show the actual name “Ground Floor” that you (or whoever receives the message) recognize. For example, when a leak sensor triggers, your notification can say “Water detected on the Ground Floor” by looking up the floor name of the sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] that triggered.

Usage

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

{{ floor_name("ground_floor") }}

Ground Floor

{{ "ground_floor" | floor_name }}

Ground Floor

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_name(
    lookup_value: str,
) -> str | None

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns None when the lookup value does not match a floor.
• The name changes when you rename the floor, so the output can shift over time.

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.

Get the floor name from an entity

Find out which floor a sensor is on by passing its entity ID.

{{ floor_name("sensor.living_room_temperature") }}

Ground Floor

Use in a notification with the trigger floor

A common pattern: when a sensor triggers an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more], include the floor name in the notification. This works with any triggerA trigger is a set of values or conditions of a platform that are defined to cause an automation to run. [Learn more] that provides trigger.entity_id, such as state or leak triggers.

action:
  - action: notify.mobile
    data:
      title: >
        {{ floor_name(trigger.entity_id) }}
      message: >
        Alert on {{ floor_name(trigger.entity_id) }}

List all floor names

Loop through all floors and display their names.

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

Ground Floor
First Floor
Basement

Show the floor of each area

Build a summary showing which floor each area belongs to, using floor_name as a way to resolve the human-readable floor for each area.

{% for id in areas() %}
  {{ area_name(id) }}: {{ floor_name(id) }}
{% endfor %}

Living Room: Ground Floor
Kitchen: Ground Floor
Bedroom: First Floor

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 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 floors: floors - Returns a list of all floor IDs in your Home Assistant instance.

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