home-assistant/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-12-10 00:30:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

Clarify unique ID limitations in FAQ (#38992)

Browse Source
This commit is contained in:
Franck Nijhof 2025-05-13 06:20:28 +02:00 committed by GitHub
parent 73e788f228
commit 3dc3df81ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/_faq/unique_id.markdown
View File

@ -10,7 +10,7 @@ If you try to access the configuration dialog for an entity in your Home Assista
This means that this entity does not have a unique identification, e.g., a serial number or another identifier that is guaranteed to be static and never changes. As a result, the normal editing process that allows you to change various settings through the user interface (such as the entity ID, icon, friendly name, etc.) is not possible here. This means that this entity does not have a unique identification, e.g., a serial number or another identifier that is guaranteed to be static and never changes. As a result, the normal editing process that allows you to change various settings through the user interface (such as the entity ID, icon, friendly name, etc.) is not possible here.
Typically, you'll see this when you create entities manually using YAML, but it can also appear if the integration that provides this entity, cannot determine a unique ID. This however is not an error, but just a limitation of the integration you use. A few selected integrations (such as [`template`](/integrations/template/) and [`mqtt`](/integrations/mqtt/)) allow the user to define a unique ID. Typically, you'll see this when you create entities manually using YAML, but it can also appear if the integration that provides this entity cannot determine a unique ID. This is not an error, but rather a limitation of the integration you use. A few selected integrations (such as [`template`](/integrations/template/) and [`mqtt`](/integrations/mqtt/)) allow you to define a unique ID.
### Used where? ### Used where?
@ -36,4 +36,12 @@ Typically, you'll see this when you create entities manually using YAML, but it
In case your entity has no unique ID and therefore cannot be changed through the UI, there are some [manual customization options](/docs/configuration/customizing-devices) directly through YAML files. In case your entity has no unique ID and therefore cannot be changed through the UI, there are some [manual customization options](/docs/configuration/customizing-devices) directly through YAML files.
### Can I add a unique ID myself?
No, as an end-user, you cannot add a unique ID to an entity that doesn't have one. Unique IDs are a feature that must be provided by the integration itself. This is because the unique ID needs to be persistent across restarts and should consistently identify the same physical device or service.
If an integration currently doesn't provide unique IDs for its entities, this means the integration could potentially be modernized to include this capability. However, providing unique IDs is not currently a mandatory requirement for all integrations.
The Home Assistant project always welcomes code contributions to enhance integrations with this capability. If you're interested in improving an integration to provide unique IDs, you can contribute code to the Home Assistant project. For more information on contributing, please visit the [developer documentation](https://developers.home-assistant.io/docs/development_index).
In case you want to read more about unique IDs, head over to this [developer documentation page](https://developers.home-assistant.io/docs/entity_registry_index/). In case you want to read more about unique IDs, head over to this [developer documentation page](https://developers.home-assistant.io/docs/entity_registry_index/).