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 entity unique ids #101168

Merged
merged 5 commits into from
Oct 1, 2023

Conversation

allenporter
Copy link
Contributor

Proposed change

Fix unique ids for rainbird entities as a follow up from #99704 which fixed the config entry unique ids to fix the error message:

2023-09-30 12:37:42.638 ERROR (MainThread) [homeassistant.components.sensor] Platform rainbird does not generate unique IDs. ID 0-raindelay already exists - ignoring sensor.rain_bird_controller_regenverzogerung_l

This happens because it is using the device serial number for the entity unique id, which may be "0". With this PR, only create an entity unique id when there is a config entry unique id. This changes the logic from checking the serial number for existing config entries that may already have a "0" unique id so they keep working as is.

This adds additional tests to verify that the unique ids are not created and the entity names are consistent with the previous names.

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

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.

tests/components/rainbird/test_binary_sensor.py Outdated Show resolved Hide resolved
tests/components/rainbird/test_sensor.py Outdated Show resolved Hide resolved
@allenporter allenporter added this to the 2023.10.0 milestone Oct 1, 2023
@allenporter allenporter merged commit 2d58ab0 into home-assistant:dev Oct 1, 2023
frenck pushed a commit that referenced this pull request Oct 1, 2023
* Fix unique ids for rainbird entities

* Update entity unique id use based on config entry entity id

* Update tests/components/rainbird/test_binary_sensor.py

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Rename all entity_registry variables

* Shorten long comment under line length limits

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
@github-actions github-actions bot locked and limited conversation to collaborators Oct 2, 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.

rainbird integration limit of one rainbird controller
3 participants