Get translated attribute value: state_attr_translated
The state_attr_translated template function returns the value 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]’s attribute translated into your configured language. While state_attr returns the raw attribute value, this function returns the localized version shown in the interface.
This is useful when you display attribute values that have been translated by integrationsIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], such as HVAC modes, fan modes, or preset names. For example, if your Home Assistant is set to French, state_attr_translated("climate.living_room", "hvac_action") might return “Chauffage” instead of heating.
Usage
Here’s how to use this template function. Copy any example and adjust it to your setup.
{{ state_attr_translated("climate.living_room", "hvac_action") }}
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_attr_translated(
entity_id: str,
attribute: str,
) -> Any
Function parameters
The following parameters can be provided to this function.
Good to know
- Returns
Nonewhen the entity or attribute does not exist. - Only attributes that integrations provide translations for are localized. Unsupported attributes fall back to the raw value.
- The output depends on the Home Assistant user language, not a fixed locale.
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.
Show the translated HVAC action
Display the current action of a climate 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] in your language.
The heater is currently: {{ state_attr_translated(
"climate.living_room", "hvac_action") }}
The heater is currently: Heating
Show the translated fan mode
Show a media player’s or climate device’s mode in a friendly, localized way.
Fan mode: {{ state_attr_translated("climate.bedroom", "fan_mode") }}
Fan mode: Automatic
Build a localized status message
Combine the translated state with the translated attribute to build a status line in your language.
{% set entity = "climate.living_room" %}
The thermostat is {{ state_translated(entity) }} and {{
state_attr_translated(entity, "preset_mode") | lower }}.
The thermostat is Heat and eco.
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.
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:
-
Get state attribute: state_attr - Returns the value of a specific attribute from an entity’s state.
-
Get translated state: state_translated - Returns the translated state value of an entity in your configured language.
-
Get entity state: states - Returns the state value of an entity, or lets you iterate over all entity states.