Document entity translation_key property (#1558)

This commit is contained in:
Erik Montnemery 2022-12-01 09:34:29 +01:00 committed by GitHub
parent 09aaca301b
commit f1212b221d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -76,6 +76,7 @@ Properties should always only return information from memory and not do I/O (lik
| has_entity_name | boolean | | Return `True` if the entity's `name` property represents the entity itself (required for new integrations). This is explained in more detail below.
| name | string | `None` | Name of the entity |
| should_poll | boolean | `True` | Should Home Assistant check with the entity for an updated state. If set to `False`, entity will need to notify Home Assistant of new updates by calling one of the [schedule update methods](integration_fetching_data.md#push-vs-poll). |
| translation_key | string | `None` | A key for looking up translations of the entity's state in [`entity` section of the integration's `strings.json`](docs/internationalization/core#state-of-entities).
| unique_id | string | `None` | A unique identifier for this entity. Needs to be unique within a platform (ie `light.hue`). Should not be configurable by the user or be changeable. [Learn more.](entity_registry_index.md#unique-id-requirements) |
:::warning