Get translated state: state_translated

The state_translated template function returns the state of 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] translated into the language configured in Home Assistant. While states returns the raw English state value (like on, off, heating), this function returns the localized version shown in the interface.

This is useful when you want to include entity states in notificationsYou can use notifications to send messages, pictures, and more, to devices. [Learn more] or dashboard text that should match your configured language. For example, if your Home Assistant is set to German, state_translated("climate.living_room") might return “Heizen” instead of heating.

Usage

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

{{ state_translated("climate.living_room") }}

Heating

{{ "climate.living_room" | state_translated }}

Heating

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.

state_translated(
    entity_id: str,
) -> str

Function parameters

The following parameters can be provided to this function.

Good to know

• The returned text depends on the language configured in Home Assistant, so comparing the result against a fixed English word like "heating" will fail once the language changes. Use states for comparisons and reserve state_translated for display.
• Translations come from the entity’s integration. Entities without translated states fall back to the raw state value.

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.

Use in a notification

Send a notification with the climate state in your configured language.

action:
  - action: notify.mobile
    data:
      message: >
        The living room climate is
        {{ state_translated("climate.living_room") }}

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 entity state: states - Returns the state value of an entity, or lets you iterate over all entity states.

• Get translated attribute value: state_attr_translated - Returns the translated value of a specific attribute from an entity’s state.

• Test entity state: is_state - Tests if an entity is in a specific state.