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

Support HitachiAirToAirHeatPump (hlrrwifi:HLinkMainController) in Overkiz integration #95706

Closed

Conversation

dotvav
Copy link
Contributor

@dotvav dotvav commented Jul 2, 2023

Proposed change

Add support for the HitachiAirToAirHeatPump (hlrrwifi:HLinkMainController) climate entity, ported from
https://github.com/iMicknl/ha-tahoma/blob/master/custom_components/tahoma/climate_devices/hitachi_air_to_air_heat_pump.py.

Fixes #85781

This PR is a continuation of #81743 to passe mypy and fix bugs.

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

home-assistant bot commented Jul 2, 2023

Hi @dotvav

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

home-assistant bot commented Jul 2, 2023

Hey there @iMicknl, @vlebourl, @tetienne, @nyroDev, mind taking a look at this pull request as it has been labeled with an integration (overkiz) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of overkiz 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 overkiz Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@dotvav
Copy link
Contributor Author

dotvav commented Jul 2, 2023

This PR was tested on my hlrrwifi:HLRRWifiBridge devices. I was not able to test any device on the OVP protocol.

Copy link
Contributor

@iMicknl iMicknl left a comment

Choose a reason for hiding this comment

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

Some small changes to start with. I am not a huge fan of the _global_control() function, I think it can be simplified. Or otherwise split between OVP and HLRRWIFI if they are significant different.

@home-assistant home-assistant bot marked this pull request as draft July 4, 2023 17:23
@home-assistant
Copy link

home-assistant bot commented Jul 4, 2023

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.

@dotvav dotvav marked this pull request as ready for review July 8, 2023 12:14
@home-assistant home-assistant bot requested a review from iMicknl July 8, 2023 12:14
@dotvav dotvav force-pushed the overkiz-hitachi-air-heat-pump branch from 12e1b90 to a6eb155 Compare July 15, 2023 07:17
@dotvav
Copy link
Contributor Author

dotvav commented Aug 5, 2023

Hi @vlebourl, @tetienne, @nyroDev. A review from one of you would be great. @iMicknl has made a review already, but since he authored a majority of the code, it would be better if someone else gives it another look. Thanks!

Copy link
Contributor

@tetienne tetienne 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 to me. Have you well tested the behavior using your own device?

@home-assistant
Copy link

Hello @dotvav,

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! ❤️

@dotvav
Copy link
Contributor Author

dotvav commented Oct 8, 2023

This PR now includes only the devices on the HLRRWIFI protocol. It has been eby myself on my device, and 2 other users. I will make a separate PR for the devices on the OVP protocol when they have been succesfully tested end to end.

@frenck frenck marked this pull request as draft October 12, 2023 10:17
@dotvav dotvav marked this pull request as ready for review October 14, 2023 06:40
@home-assistant home-assistant bot requested a review from iMicknl October 14, 2023 06:40
Copy link
Contributor

@iMicknl iMicknl 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. 2 minor comments, and please rebase. Such a complex device, but happy that it works well and code is understandable.

FAN_SILENT: OverkizCommandParam.SILENT,
}

# We need to make all state strings lowercase, since Hi Kumo server returns capitalized strings for some states. (without a clear pattern)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# We need to make all state strings lowercase, since Hi Kumo server returns capitalized strings for some states. (without a clear pattern)

Seems the code that this comment was describing is not present anymore.

@home-assistant home-assistant bot marked this pull request as draft November 7, 2023 16:35
@dotvav dotvav closed this Nov 11, 2023
@dotvav dotvav force-pushed the overkiz-hitachi-air-heat-pump branch from 58f2e1e to d9f2740 Compare November 11, 2023 14:10
@github-actions github-actions bot locked and limited conversation to collaborators Nov 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants