Get area name: area_name

The area_name template function returns the friendly, human-readable name of 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]. You can give it an area ID, 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 area 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 area ID like living_room, you can show the actual name “Living Room” that you (or whoever receives the message) recognize. For example, when motion is detected, your notification can say “Motion detected in the Living Room” by looking up the area 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.

{{ area_name("living_room") }}

Living Room

{{ "living_room" | area_name }}

Living Room

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.

area_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 an area, entity, or device.
• When an entity or device has no area assigned, the result is None.
• The name reflects the current area label, so renaming an area updates the output immediately.

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 area name from an entity

Find out which room a sensor is in by passing its entity ID.

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

Living Room

Use in a notification with the trigger area

A very 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 room 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 motion triggers.

action:
  - action: notify.mobile
    data:
      title: >
        {{ area_name(trigger.entity_id) }}
      message: >
        Motion detected in {{ area_name(trigger.entity_id) }}

List all area names

Loop through all areas and display their names.

{% for area_id in areas() %}
  {{ area_name(area_id) }}
{% endfor %}

Living Room
Kitchen
Bedroom
Hallway

List rooms with open windows

A common use case: build a message listing which rooms have open windows or doors. This uses area_name as a filter to convert each open sensor’s entity ID into a room name, then removes duplicates.

{{
  states.binary_sensor
  | selectattr('attributes.device_class', 'in',
      ('window', 'door'))
  | map(attribute='entity_id')
  | select('is_state', 'on')
  | map('area_name')
  | select
  | unique
  | list
  | join(', ')
}}

Kitchen, Bedroom

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 area ID: area_id - Returns the area ID for a given area name, entity ID, or device ID.

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

• Get devices in an area: area_devices - Returns a list of device IDs associated with a given area.

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