Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation on identifiers and connections #1571

Open
rytilahti opened this issue Dec 7, 2022 · 1 comment
Open

Clarify documentation on identifiers and connections #1571

rytilahti opened this issue Dec 7, 2022 · 1 comment

Comments

@rytilahti
Copy link
Member

https://developers.home-assistant.io/docs/device_registry_index/#automatic-registration-through-an-entity

A device will be matched up with an existing device via supplied identifiers or connections, like serial numbers or MAC addresses. If identifiers and connections are provided, the device registry will first try to match by identifiers.

This could use some clarification on how these are used and which ones should be set, my understanding is that:

  • Identifiers can be anything from hardware-based identifiers (like serial numbers) to config entry ids
  • Connections are network-based identifiers such as mac or zigbee addresses

The example on the linked page uses confusingly self.unique_id as a representative for the hue serial number (based on the comment), and does not list any connections that could be useful to exemplify the usage.

@rytilahti rytilahti changed the title Clarify Clarify documentation on identifiers and connections Dec 7, 2022
@ViViDboarder
Copy link

Thanks. I'm still confused if I should be using connections because it's listed under Manual Registration in that documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants