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

Fix Rainbird unique to use a more reliable source (mac address) #101603

Merged
merged 14 commits into from
Nov 12, 2023

Conversation

allenporter
Copy link
Contributor

@allenporter allenporter commented Oct 7, 2023

Proposed change

Update rainbird unique id selection to use the mac address rather than the serial number, which is sometimes zero. This would have been a better fix for #101168 to handle the zero serial number case in hindsight.

The config flow will now exclusively use the rainbird mac address, which seems to be broadly supported according to testing from the community in allenporter/pyrainbird#270 -- but just incase, we still keep the serial number around in the config entry. We still additionally dedup config entries on unique host/pass given the mix of prior types of unique ids.

Existing config entries that have no unique id (created using the logic in 2023.10.X that skips setting unique id for serial "0") are fixed in the setup to use the mac address. Existing unique ids that use the serial number are left alone.

This is not scheduled for a patch release, since it is a larger change than the previous unique id fixes.

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

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:

@home-assistant
Copy link

home-assistant bot commented Oct 7, 2023

Hey there @konikvranik, mind taking a look at this pull request as it has been labeled with an integration (rainbird) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of rainbird 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 rainbird Removes the current integration label and assignees on the pull request, add the integration domain after the command.

homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft October 10, 2023 08:59
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@allenporter allenporter marked this pull request as ready for review October 14, 2023 18:00
@allenporter allenporter marked this pull request as draft October 16, 2023 05:10
@allenporter allenporter marked this pull request as ready for review November 8, 2023 05:46
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainbird/__init__.py Outdated Show resolved Hide resolved
tests/components/rainbird/test_init.py Show resolved Hide resolved
tests/components/rainbird/test_init.py Outdated Show resolved Hide resolved
tests/components/rainbird/test_init.py Outdated Show resolved Hide resolved
tests/components/rainbird/test_init.py Outdated Show resolved Hide resolved
tests/components/rainbird/test_init.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 8, 2023 10:24
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
@allenporter allenporter marked this pull request as ready for review November 9, 2023 03:43
@MartinHjelmare MartinHjelmare marked this pull request as draft November 9, 2023 09:22
@allenporter allenporter marked this pull request as ready for review November 11, 2023 07:32
@home-assistant home-assistant bot marked this pull request as draft November 11, 2023 09:31
@allenporter allenporter marked this pull request as ready for review November 12, 2023 04:03
@MartinHjelmare MartinHjelmare merged commit 2565056 into home-assistant:dev Nov 12, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Nov 13, 2023
@allenporter allenporter added this to the 2023.11.3 milestone Nov 14, 2023
@frenck frenck modified the milestone: 2023.11.3 Nov 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants