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

Use library fork for ViCare integration #124107

Merged
merged 7 commits into from
Aug 19, 2024
Merged

Conversation

CFenner
Copy link
Contributor

@CFenner CFenner commented Aug 17, 2024

Proposed change

This changes the API library used in ViCare integration to a new one created from a fork.

Over the last ~9 months I provided several PRs to the original library. Some of them got merged, others where not, and since December last year there was no new version release. I tried to reach the maintainers via PR comment and via Discord but got no response over the last months.

Bildschirmfoto 2024-08-17 um 23 00 39

Now we have some kind of urgency as there is one bug in the library and mid of September some of the datapoints in the API will be deleted and replaced with others.

CFenner/PyViCare@2.32.0...v0.2.1

Changes:

  • fix getter for dhw gas consumption
  • expose hysteresis data points
  • expose device ID of room sensors
  • expose ventilation mode and preset on heat pumps
  • switch deprecated data points for bufferCylinder and dhwCylinder
  • handle TCU300 as gateway

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:

@MartinHjelmare MartinHjelmare changed the title use library fork for ViCare integration Use library fork for ViCare integration Aug 17, 2024
@@ -11,5 +11,5 @@
"documentation": "https://www.home-assistant.io/integrations/vicare",
"iot_class": "cloud_polling",
"loggers": ["PyViCare"],
"requirements": ["PyViCare==2.32.0"]
"requirements": ["PyViCare-neo==0.2.1"]
Copy link
Member

Choose a reason for hiding this comment

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

If you're not planning to contribute back changes to upstream you should ask GitHub to disconnect your fork from its upstream. That way it's clear to the community that it's a separate project going forward.

Copy link
Member

@MartinHjelmare MartinHjelmare Aug 17, 2024

Choose a reason for hiding this comment

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

Please add a description to the PR of the due diligence that has been done to continue working with upstream project before labeling the project as unmaintained.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please add a description to the PR of the due diligence that has been done

done, I hope that is enough.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Original owner of the lib just responded and agreed to transfer the repo to a dedicated org where we can share the ownership.
Hope it's not a big deal to change back once the repo is transferred, release is setup and the bugfixes are cherry-picked.

Copy link
Member

Choose a reason for hiding this comment

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

That's fine. You can link to this discussion thread in the future PR that changes back the library.

@CFenner CFenner marked this pull request as ready for review August 19, 2024 15:12
@MartinHjelmare MartinHjelmare merged commit de82f21 into home-assistant:dev Aug 19, 2024
40 checks passed
@CFenner CFenner deleted the neo branch August 20, 2024 07:26
@github-actions github-actions bot locked and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Viessmann ViCare Integration: Missing device_class for energy sensors
2 participants