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

Generic ZHA Zeroconf discovery #126294

Merged
merged 14 commits into from
Nov 21, 2024

Conversation

puddly
Copy link
Contributor

@puddly puddly commented Sep 19, 2024

Proposed change

I'm introducing a new service type: _zigbee-coordinator._tcp.local.. This will allow all future TCP coordinators to be supported without an explicit PR to ZHA. The only expected properties are radio_type (one of ezsp, znp, etc.) and serial_number (must be unique per device and not derived from any Zigbee information, like the Ethernet MAC address). The service name will be shown as-is.

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 Ruff (ruff format 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

Code owners of zha 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 zha Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@puddly
Copy link
Contributor Author

puddly commented Sep 19, 2024

CC @tube0013

@puddly
Copy link
Contributor Author

puddly commented Oct 2, 2024

@Hedda In the future, please do not ask other projects to implement draft PRs. This code isn't done or in a final form and now I have to communicate with other developers to change the schema.

@puddly puddly force-pushed the puddly/zha-generic-zeroconf branch from d80edde to 32bdbcc Compare October 30, 2024 16:23
@puddly puddly marked this pull request as ready for review October 30, 2024 16:24
@puddly puddly added this to the 2024.11.0b0 milestone Oct 30, 2024
@edenhaus edenhaus removed this from the 2024.11.0b0 milestone Oct 30, 2024
@puddly
Copy link
Contributor Author

puddly commented Oct 30, 2024

Thanks for the review! I've addressed both comments and reworked unit tests to properly increase coverage.

@puddly puddly marked this pull request as ready for review October 30, 2024 19:37
homeassistant/components/zha/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/zha/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/zha/config_flow.py Outdated Show resolved Hide resolved
@bdraco
Copy link
Member

bdraco commented Oct 30, 2024

Maybe register it here as well https://www.iana.org/form/ports-services

@puddly
Copy link
Contributor Author

puddly commented Oct 30, 2024

@bdraco ah, good point. It's already registered but there's no info about what keys are allowed, nor any public references to devices actually using it 😅.

I'll see what I can dig up.

@puddly
Copy link
Contributor Author

puddly commented Oct 30, 2024

Marking as draft until I hear back from a few people. If there's an existing and active registration we'll have to rename this. If not, we'll continue with this name.

@puddly puddly marked this pull request as draft October 30, 2024 21:20
@puddly
Copy link
Contributor Author

puddly commented Nov 19, 2024

_zigbee-gateway's format is undocumented and I'm unable to get any information about it. I'm moving to _zigbee-coordinator to avoid issues down the line.

@puddly puddly marked this pull request as ready for review November 19, 2024 18:31
tests/components/zha/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/zha/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/zha/test_config_flow.py Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 20, 2024 10:44
@puddly puddly marked this pull request as ready for review November 20, 2024 17:25
@puddly
Copy link
Contributor Author

puddly commented Nov 20, 2024

Looks like CI is having some issues right now. Thanks for the review, @abmantis. I think I've addressed your review comments.

@frenck frenck merged commit 50fdbe9 into home-assistant:dev Nov 21, 2024
29 of 30 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 22, 2024
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.

9 participants