jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-24 01:36:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add blog post about new entity translations (#1559)

Browse Source
This commit is contained in:
Erik Montnemery 2022-12-01 10:20:20 +01:00 committed by GitHub
parent 0f12f8f772
commit 192a353eba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
blog/2022-12-01-entity_translations.md Normal file
View File

@ -0,0 +1,34 @@
---
author: Erik Montnemery
authorURL: https://github.com/emontnemery
title: "Translating the state of entities"
---
The method for integrations to provide translations for states of its entities under other integrations, for example to translate an integration's sensors has changed.
Integrations should no longer use custom device classes together with a `strings.<platform name>.json` file. Instead, entities should set the `translation_key` property on an entity and include that `translation_key` in the integration's `strings.json`.
:::warning
Pointing to translations via the `translation_key` property is currently only supported for entities with a `unique_id`.
:::
The following example `strings.json` is for a Moon domain `sensor` entity with its `translation_key` property set to `phase`:
```json
{
"entity": {
"sensor": {
"phase": {
"state": {
"new_moon": "New moon",
"first_quarter": "First quarter",
"full_moon": "Full moon",
"last_quarter": "Last quarter"
}
}
}
}
}
```
For more details, see the [`translation`](docs/internationalization/core/#state-of-entities) and [`entity`](docs/core/entity#generic-properties) documentation.