8000 Add HomeLink integration by ryanjones-gentex · Pull Request #136460 · home-assistant/core · GitHub
[go: up one dir, main page]

Skip to content

Add HomeLink integration #136460

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

Open
wants to merge 71 commits into
base: dev
Choose a base branch
from

Conversation

ryanjones-gentex
Copy link
@ryanjones-gentex ryanjones-gentex 8000 commented Jan 24, 2025

Breaking change

Proposed change

Add custom integration for HomeLink devices to interact with Home Assistant.

This integration is dependent on the homelink-home-assistant python package, which has been added to the appropriate requirements files. The code for the package is hosted here: https://github.com/Gentex-Corporation/homelink-home-assistant

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 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:

Copy link
@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @ryanjones-gentex

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@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.

Copy link
Member
@zweckj zweckj left a comment

Choose a reason for hiding this comment

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

thanks for taking the time to contribute that integration!
Before we can get started with the actual review process there is one thing to sort out: We require our 3rd party libraries to be hosted in public repositories, with an OSI approved license and tagged releases, which get deployed to PyPi through CICD. I wasn't able to find the source code of the library (as in the actual repo, not pypi), can you point me to it?

@home-assistant home-assistant bot marked this pull request as draft January 24, 2025 20:02
@ryanjones-gentex
Copy link
Author

thanks for taking the time to contribute that integration! Before we can get started with the actual review process there is one thing to sort out: We require our 3rd party libraries to be hosted in public repositories, with an OSI approved license and tagged releases, which get deployed to PyPi through CICD. I wasn't able to find the source code of the library (as in the actual repo, not pypi), can you point me to it?

@zweckj I have updated the PR description to point to the public repo for our Python package code. Here's a direct link: https://github.com/Gentex-Corporation/homelink-home-assistant

@ryanjones-gentex ryanjones-gentex marked this pull request as ready for review January 28, 2025 18:52
@home-assistant home-assistant bot requested a review from zweckj January 28, 2025 18:52
@ryanjones-gentex ryanjones-gentex force-pushed the feature/homelink-integration branch from ef4b132 to 9a5072f Compare January 30, 2025 14:10
"user": {
"data": {
"email": "Email Address",
"password": "Password"
Copy link
Contributor

Choose a reason for hiding this comment

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

You can replace these two with common strings, too:
"[%key:common::config_flow::data::email%]"
"[%key:common::config_flow::data::password%]"
Saves us translators a bit of work. ;-)

Copy link
Author

Choose a reason for hiding this comment

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

Thanks @NoRi2909, I've made the change here, does this also need to change for the data_description fields further down?

Copy link
@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hello @ryanjones-gentex,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting "Author Name" and "email@address.com" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

8000
@home-assistant home-assistant bot marked this pull request as draft February 4, 2025 20:51
Copy link
@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hello @ryanjones-gentex,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting "Author Name" and "email@address.com" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@ryanjones-gentex ryanjones-gentex marked this pull request as ready for review March 25, 2025 12:48
@ryanjones-gentex ryanjones-gentex requested a review from a team as a code owner March 25, 2025 12:48
@home-assistant home-assistant bot requested a review from zweckj March 25, 2025 12:48
Comment on lines +51 to +52
self.last_sync_timestamp = None
self.last_sync_id = None
Copy link
Member

Choose a reason for hiding this comment

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

missing types

@home-assistant home-assistant bot marked this pull request as draft April 7, 2025 18:53
@ryanjones-gentex ryanjones-gentex marked this pull request as ready for review May 1, 2025 18:15
@home-assistant home-assistant bot requested a review from zweckj May 1, 2025 18:15
@ryanjones-gentex
Copy link
Author
ryanjones-gentex commented May 15, 2025
< F438 tbody class="d-block">

@zweckj Are there any more changes you'd like us to make for the integration (once we fix the MyPy issue in the pipeline)?

@zweckj
Copy link
Member
zweckj commented May 16, 2025

I'm not comfortable reviewing this further, because

  • I'm no expert at MQTT integrations
  • I'm not sure if you are abusing the OAuth component

so someone from the core team needs to take it from here

@ryanjones-gentex
Copy link
Author

so someone from the core team needs to take it from here

@zweckj is there anything else we need to do for a core team member to review this PR? This is our first time going through adding an integration and we want to make sure we're doing everything we can to comply with the process.

@zweckj
Copy link
Member
zweckj commented May 29, 2025

no, it's just waiting for now unfortunately

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
0