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

Add Overkiz AtlanticPassAPCDHW #78665

Merged
merged 19 commits into from
Nov 4, 2022

Conversation

nyroDev
Copy link
Contributor

@nyroDev nyroDev commented Sep 17, 2022

Breaking change

Proposed change

Implement Overkiz AtlanticPassAPCDHW, a Water Heater entity provided by Atlantic.
This entity is generally attached to an Atlantic heat pump.

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

Tested on my water heater, change of operation mode is working correctly.

I also added the async_execute_commands in the Overkiz executor in order to be able to execute multiple commands at once.
I did it because the regular web interface of Somfy do that.
I already addad a pull request #78659 who add the exact same multiple commands

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:

Fixes #80375

@probot-home-assistant
Copy link

Hey there @iMicknl, @vlebourl, @tetienne, 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!
(message by CodeOwnersMention)

Copy link
Contributor

@bachya bachya left a comment

Choose a reason for hiding this comment

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

Looks great! Small item.

@nyroDev nyroDev marked this pull request as draft September 29, 2022 09:55
@nyroDev nyroDev marked this pull request as ready for review October 4, 2022 07:13
@nyroDev
Copy link
Contributor Author

nyroDev commented Oct 4, 2022

Undraft this PR in favor of creating another PR #79576 for async_execute_commands

@nyroDev
Copy link
Contributor Author

nyroDev commented Oct 5, 2022

@bachya I don't know when you write "still in progress?", but no, I think this PR is ready for merging if reviewers are ok with it.
The code is no fully functional.
It was marked a draft in order to wait for a new PR #79576
I updated this PR to make it work without it for now, and I will update this entity on the other PR to optimize multiple calls afterwards

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 quick comments to get you started. It is hard to review since codecov is adding comments on every line, so not very readable currently.

By the way, you may also join our Discord where all developers are if you are looking for some guidance / brainstorm sometimes.

@bachya bachya added the smash Indicator this PR is close to finish for merging or closing label Oct 5, 2022
@nyroDev
Copy link
Contributor Author

nyroDev commented Oct 6, 2022

Because I'm adding a new type of entity (water heater), Should I do a PR for the documentation to update this file:
https://github.com/home-assistant/home-assistant.io/blob/8e7d6ef9aba3663697c4c9addf266e90be0155d4/source/_integrations/overkiz.markdown

And if I should do it, when should I do it?
Before or after this PR is merged?

And in this documentation PR, should I also update the Somfy integration as well?
https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/somfy.markdown

@vlebourl
Copy link
Contributor

https://github.com/home-assistant/home-assistant.io/blob/8e7d6ef9aba3663697c4c9addf266e90be0155d4/source/_integrations/overkiz.markdown

Let me get corrected if I'm wrong, but I believe you do have to update the doc concurrently and add the link to the PR in the Additional information section of the description at the top.

@nyroDev
Copy link
Contributor Author

nyroDev commented Oct 16, 2022

https://github.com/home-assistant/home-assistant.io/blob/8e7d6ef9aba3663697c4c9addf266e90be0155d4/source/_integrations/overkiz.markdown

Let me get corrected if I'm wrong, but I believe you do have to update the doc concurrently and add the link to the PR in the Additional information section of the description at the top.

Yes, I've done the PR in the next branch for the doc as required.
I've updated the original comment here and linked to this PR from the documentation PR

Copy link
Member

@Quentame Quentame left a comment

Choose a reason for hiding this comment

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

Some comments otherwise looks good !

Copy link
Member

@Quentame Quentame left a comment

Choose a reason for hiding this comment

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

Make sure this PR contains the latest ha-tahoma feature/fix

@nyroDev
Copy link
Contributor Author

nyroDev commented Nov 4, 2022

Make sure this PR contains the latest ha-tahoma feature/fix

@Quentame As far as I know, this very specific entity was not supported in ha-tahoma.
See https://github.com/iMicknl/ha-tahoma/blob/master/custom_components/tahoma/water_heater.py#L17

When this PR is merged and another one in pyoverkiz, I'm willing to rewrite supported water heater device in ha-tahoma here.

Copy link
Member

@Quentame Quentame left a comment

Choose a reason for hiding this comment

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

Nice job !
Thanks 🎉

@Quentame
Copy link
Member

Quentame commented Nov 4, 2022

@nyroDev Can you explain what is a AtlanticPassAPCDHW device IRL in the "Proposed change" section of the description of the PR ?

As it will be used for the release notes, it will be more understandable for everyone.

@Quentame Quentame merged commit ddbfed3 into home-assistant:dev Nov 4, 2022
@nyroDev
Copy link
Contributor Author

nyroDev commented Nov 4, 2022

@nyroDev Can you explain what is a AtlanticPassAPCDHW device IRL in the "Proposed change" section of the description of the PR ?

As it will be used for the release notes, it will be more understandable for everyone.

@Quentame Updated, is that ok for you?

@Quentame
Copy link
Member

Quentame commented Nov 4, 2022

@nyroDev Can you explain what is a AtlanticPassAPCDHW device IRL in the "Proposed change" section of the description of the PR ?
As it will be used for the release notes, it will be more understandable for everyone.

@Quentame Updated, is that ok for you?

Nice ! 👌

@nyroDev nyroDev deleted the overkiz/atlantic_pass_apcdhw branch November 4, 2022 09:49
@github-actions github-actions bot locked and limited conversation to collaborators Nov 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed integration: overkiz new-feature new-integration smash Indicator this PR is close to finish for merging or closing
Projects
None yet
6 participants