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

Disable energy report based operations with API lib upgrade #109832

Merged

Conversation

vilppuvuorinen
Copy link
Contributor

@vilppuvuorinen vilppuvuorinen commented Feb 6, 2024

Breaking change

The daily energy sensors have been removed to prevent being throttled by the external API. This mostly affects ATW devices.

For ATA devices this sensor is also removed, however, the total energy consumed (if your device supports that), remains available. The latter supports long-term statistics, which also provides insights into daily energy usage via the energy dashboard or using statistic card.

Proposed change

Upgrade pymelcloud to remove energy report based operations. This change breaks daily energy consumption for ATW devices, but help prevent throttling. The API lib returns always None now which is a valid return value according to the existing type annotations. See commit for details vilppuvuorinen/pymelcloud@a4a586a

Changelog: https://github.com/vilppuvuorinen/pymelcloud/blob/v2.5.x/CHANGELOG.md#259---2024-02-06

vilppuvuorinen/pymelcloud@8756c36...33a827b

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Copy link
Member

@frenck frenck 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 the PR @vilppuvuorinen 👍

This is a breaking change, so let's write some text for the end-user in the breaking change section of the PR (which will be used for the release notes).

We should also clean up the sensors for this. If we keep them, they will be stale/orphaned basically. So, let's remove the call and the sensor descriptions for these.

../Frenck

@home-assistant
Copy link

home-assistant bot commented Feb 6, 2024

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.

@home-assistant home-assistant bot marked this pull request as draft February 6, 2024 21:01
@frenck frenck marked this pull request as ready for review February 7, 2024 05:50
@home-assistant home-assistant bot requested a review from frenck February 7, 2024 05:50
@frenck
Copy link
Member

frenck commented Feb 7, 2024

I've taken the liberty to make the adjustments.

Copy link
Member

@frenck frenck 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, but could use a second pair of eyes, as I made adjustments too.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@frenck frenck merged commit 5521a39 into home-assistant:dev Feb 7, 2024
53 checks passed
frenck added a commit that referenced this pull request Feb 7, 2024
Co-authored-by: Franck Nijhof <git@frenck.dev>
@github-actions github-actions bot locked and limited conversation to collaborators Feb 8, 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.

None yet

5 participants