Skip to content

Commit 2321f11

Browse files
Add a hint regarding entity translations and UI vs. backend language (#2707)
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
1 parent bc2542a commit 2321f11

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

docs/core/entity.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,10 @@ Avoid setting an entity's name to a hard coded English string, instead, the name
134134
Some entities are automatically named after their device class, this includes [`binary_sensor`](/docs/core/entity/binary-sensor), [`button`](/docs/core/entity/button), [`number`](/docs/core/entity/number) and [`sensor`](/docs/core/entity/sensor) entities and in many cases don't need to be named.
135135
For example, an unnamed sensor which has its device class set to `temperature` will be named "Temperature".
136136

137+
:::note
138+
If an entity provides translations for the entity name, the used name depends on the system (backend) language at creation time, not the user’s UI language. For example, if your backend is set to German, new entities will be named in German — even if a user later switches their UI to French. Changing the backend language will only affect entities created after the change; existing entities retain their original names.
139+
:::
140+
137141
### `has_entity_name` True (Mandatory for new integrations)
138142

139143
The entity's name property only identifies the data point represented by the entity, and should not include the name of the device or the type of the entity. So for a sensor that represents the power usage of its device, this would be “Power usage”.

0 commit comments

Comments
 (0)