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.

Sign up for GitHub

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

Jump to bottom

Add serial_number to device registry entries #102334

Merged
merged 5 commits into from Oct 22, 2023
Merged

Add serial_number to device registry entries #102334

merged 5 commits into from Oct 22, 2023

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Oct 19, 2023 •
edited

Proposed change

Add serial_number to device registry entries

The serial number can be displayed in the device card in frontend

The "identifiers" set which is part of device registry entries can't be used for this purpose because:

  • they are globally unique
  • we have no idea what they are, it could be a serial number, but it could also be anything else used by the backing integration

Developer documentation: home-assistant/developers.home-assistant#1477

Note: This is a rebased version of #77713

#77713 was reverted by #79139 because there was an idea that we would like to add additional attributes and collect them in some sub data structure with device meta data.
However, the specific case with serial numbers was brought up again in home-assistant/architecture#987, and there's no consensus on any additional attributes.

After a discussion with @edenhaus, @MartinHjelmare and @frenck, we concluded serial number is wanted and we should add it without any bigger architecture change to the device registry.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@emontnemery emontnemery requested a review from a team as a code owner October 19, 2023 15:08
@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (config) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of config can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign config Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@bdraco
Copy link
Member

bdraco commented Oct 19, 2023 •
edited

The serial number can be displayed in the device card in frontend

Users have trouble identifying which device is which when integration don't provide a name (because they do not have a useful one in the data source), and only a mac address or serial number. This will be very helpful in figuring out which device is which if we also include the mac in the UI

bdraco
bdraco reviewed Oct 19, 2023
View reviewed changes
tests/helpers/test_device_registry.py Outdated
entry = registry.async_get_or_create(
config_entry_id=mock_config_entry.entry_id,
connections={("Zigbee", "01.23.45.67.89")},
identifiers={("serial", "12:34:56:AB:CD:EF")},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice if the serial didn't look like a mac address in the test as it initially confused me

@bdraco
Copy link
Member

bdraco commented Oct 19, 2023 •
edited

The code LGTM, but I don't follow why the first version was reverted in #79139. I am missing some context

@emontnemery
Copy link
Contributor Author

The code LGTM, but I don't follow why the first version was reverted in #79139. I am missing some context

Sorry about that, I added some context to the PR description

bdraco
bdraco approved these changes Oct 20, 2023
View reviewed changes
Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM except for uptime needs it snapshot regenerated

MartinHjelmare
MartinHjelmare approved these changes Oct 20, 2023
View reviewed changes
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need a frontend PR before merge or are we good to merge?

frenck
frenck approved these changes Oct 22, 2023
View reviewed changes
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

I think we can merge this without having a frontend part at this point.
Will make a task for the frontend team to pick up.

../Frenck

@frenck frenck merged commit 1621310 into dev Oct 22, 2023
53 checks passed
@frenck frenck deleted the device_registry_serial_number_2 branch October 22, 2023 13:14
@github-actions github-actions bot locked and limited conversation to collaborators Oct 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck approved these changes

@bdraco bdraco bdraco approved these changes

@MartinHjelmare MartinHjelmare MartinHjelmare approved these changes

@joostlek joostlek joostlek approved these changes

@epenet epenet Awaiting requested review from epenet epenet is a code owner

@Jc2k Jc2k Awaiting requested review from Jc2k Jc2k is a code owner

@elupus elupus Awaiting requested review from elupus elupus is a code owner

Assignees
No one assigned
Labels
by-code-owner cla-signed core Hacktoberfest has-tests integration: config Quality Scale: internal
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@emontnemery @bdraco @frenck @MartinHjelmare @joostlek