2026.4.1
Home ▸ Template functions

Get floor ID: floor_id

The floor_id template function returns the unique floor ID for a given floor name, 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, deviceA device is a model representing a physical or logical unit that contains entities. ID, or 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. Every 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] in Home Assistant has an internal ID that stays the same even if you rename the floor, and this function lets you look it up.

This is useful when you need the floor ID to pass to other floor functions like floor_areas or floor_entities, or when you want to find out which floor a particular entity, device, or area belongs to. For example, you could use it in an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] to determine which floor a motion sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] is on and then act on all devices on that floor.

Usage

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

TemplateA 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] 
{{ floor_id("Ground Floor") }}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
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_id(
    lookup_value: str,
) -> str | None

Function parameters

The following parameters can be provided to this function.

lookup_value string Required

The floor name, area name, entity ID, or device ID to look up. If a floor name is given, the matching floor ID is returned. If an area name, entity ID, or device ID is given, the floor ID of the floor that area, entity, or device belongs to is returned.

Good to know

  • Returns None when the lookup value does not match a floor, or when the area, entity, or device is not assigned to a floor.
  • An entity gets its floor through its area, so an entity with no area returns None.

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.

Find the floor of an entity

Look up which floor a specific entity belongs to.

TemplateA 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] 
{{ floor_id("sensor.living_room_temperature") }}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
ground_floor

Find the floor of an area

Look up which floor a specific area is assigned to by passing its name.

TemplateA 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] 
{{ floor_id("Kitchen") }}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
ground_floor

Group areas by floor

Combine floor_id with areas to find out which areas belong to each floor.

TemplateA 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] 
{% for area_id in areas() %}
  {{ area_name(area_id) }} is on {{ floor_name(floor_id(area_id)) }}
{% endfor %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
Living Room is on Ground Floor
Kitchen is on Ground Floor
Bedroom is on 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.

Tip

AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.

Related template functions

These functions work well alongside this one: