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

Align zeroconf matching with ZeroconfServiceInfo #62133

Merged
merged 5 commits into from
Dec 19, 2021

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Dec 16, 2021

Breaking change

Currently zeroconf matching only allows matching the macaddress
model, and manufacturer properties along with the name from
the ZeroconfServiceInfo. Since properties are arbitrarily
defined by the zeroconf service, the list of named properties
has grown over time.

Matching now allows for any arbitrarily defined property

All property matches must be lowercase, wildcards are supported

Replaces #62001

The top level keys model, manufacturer, and macaddress
are now deprecated from the manifest.json file and should
be moved into a properties dict.

Example:

-    {"type":"_airplay._tcp.local.","model":"appletv*"}
+    {"type":"_airplay._tcp.local.","properties":{"model":"appletv*"}}

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)
  • 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
  • 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

Currently zeroconf matching only allows matching the macaddress
model and manufacturer properties along with the name from
the ZeroconfServiceInfo. Since properties are arbitrarily
defined by the zeroconf service, the list of named properties
has grown over time.

Matching now allows for any arbitrarily defined property

All property matches must be lowercase, wildcards are supported
@probot-home-assistant
Copy link

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

@probot-home-assistant
Copy link

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

@probot-home-assistant
Copy link

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

@probot-home-assistant
Copy link

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

@probot-home-assistant
Copy link

Hey there @escoand, @chemelli74, mind taking a look at this pull request as it has been labeled with an integration (samsungtv) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@project-bot project-bot bot added this to Needs review in Dev Dec 16, 2021
@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Dec 16, 2021
bdraco added a commit to home-assistant/developers.home-assistant that referenced this pull request Dec 16, 2021
@bdraco bdraco marked this pull request as ready for review December 17, 2021 01:30
@bdraco bdraco requested a review from a team as a code owner December 17, 2021 01:30
Copy link
Member

@Kane610 Kane610 left a comment

Choose a reason for hiding this comment

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

Looks good for Axis integration

Dev automation moved this from By Code Owner to Reviewer approved Dec 17, 2021
homeassistant/loader.py Outdated Show resolved Hide resolved
@bdraco
Copy link
Member Author

bdraco commented Dec 19, 2021

Thanks. This unblocks the HomePod support for apple_tv

@bdraco bdraco merged commit 615872a into home-assistant:dev Dec 19, 2021
Dev automation moved this from Reviewer approved to Done Dec 19, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Dec 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

6 participants