core icon indicating copy to clipboard operation
core copied to clipboard

Generic ZHA Zeroconf discovery

Open puddly opened this issue 1 year ago • 2 comments

Proposed change

I'm introducing a new service type: _zigbee-gateway._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). 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!)
  • [x] 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:

puddly avatar Sep 19 '24 22:09 puddly

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.

home-assistant[bot] avatar Sep 19 '24 22:09 home-assistant[bot]

CC @tube0013

puddly avatar Sep 19 '24 22:09 puddly

@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 avatar Oct 02 '24 13:10 puddly

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

Learn more about our pull request process.

home-assistant[bot] avatar Oct 30 '24 17:10 home-assistant[bot]

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

puddly avatar Oct 30 '24 19:10 puddly

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

bdraco avatar Oct 30 '24 21:10 bdraco

@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 avatar Oct 30 '24 21:10 puddly

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 avatar Oct 30 '24 21:10 puddly

_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 avatar Nov 19 '24 16:11 puddly

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

puddly avatar Nov 20 '24 17:11 puddly