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-16 05:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update config entry Unique ID Requirements (#834)

Browse Source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
J. Nick Koston 2021-03-05 10:12:08 -10:00 committed by GitHub
parent 9a097c26ff
commit 8429ec2fb5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/config_entries_config_flow_handler.md
View File

@ -85,11 +85,11 @@ await self._async_handle_discovery_without_unique_id()
### Unique ID Requirements
A Unique ID is used to match a config entry to the underlying device or api. The Unique ID must be stable and should not be able to be changed by the user. The Unique ID can be used to update the config entry data when device access details change. For example, for devices that communicate over the local network, if the IP address changes due a new DHCP assignment, the integration can use the Unique ID to update the host using the following code snippet:
A Unique ID is used to match a config entry to the underlying device or API. The Unique ID must be stable and should not be able to be changed by the user. The Unique ID can be used to update the config entry data when device access details change. For example, for devices that communicate over the local network, if the IP address changes due to a new DHCP assignment, the integration can use the Unique ID to update the host using the following code snippet:
```
await self.async_set_unique_id(serial_number)
self._abort_if_unique_id_configured({CONF_HOST: host, CONF_PORT: port})
self._abort_if_unique_id_configured(updates={CONF_HOST: host, CONF_PORT: port})
```
#### Example acceptable sources for a unique ID
@ -113,6 +113,8 @@ A Unique ID is used to match a config entry to the underlying device or api. The
- IP Address
- Device Name
- Hostname
- URL
### Unignoring