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 ZHA metering summation received sensor #107576

Merged

Conversation

jeverley
Copy link
Contributor

@jeverley jeverley commented Jan 8, 2024

Proposed change

Introduce a sensor for exposing the 'current_summ_received' attribute from Zigbee's Metering cluster.
This is similar in function to summation delivered, however shows energy received into the meter (i.e. exported back to the grid).

image

This is particularly useful with the Energy dashboard for configuring a 'Return to grid' sensor:

image

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

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

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 home-assistant bot added integration: zha new-feature small-pr PRs with less than 30 lines. labels Jan 8, 2024
@home-assistant home-assistant bot marked this pull request as draft January 8, 2024 19:03
@home-assistant
Copy link

home-assistant bot commented Jan 8, 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
Copy link

home-assistant bot commented Jan 8, 2024

Hey there @dmulcahey, @Adminiuga, @puddly, @TheJulianJES, mind taking a look at this pull request as it has been labeled with an integration (zha) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zha 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 zha Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@jeverley jeverley marked this pull request as ready for review January 8, 2024 19:06
@jeverley jeverley changed the title Zha metering summation received Sensor for exposing Summation Received attribute from Zigbee Metering cluster Jan 8, 2024
Copy link
Contributor

@dmulcahey dmulcahey left a comment

Choose a reason for hiding this comment

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

Good to merge when CI passes

@dmulcahey
Copy link
Contributor

@jeverley you need to update the zha device list in tests to account for the new entities. Let me know if you need assistance.

@jeverley
Copy link
Contributor Author

@jeverley you need to update the zha device list in tests to account for the new entities. Let me know if you need assistance.

Thanks @dmulcahey, I will get that sorted.

@jeverley
Copy link
Contributor Author

@jeverley you need to update the zha device list in tests to account for the new entities. Let me know if you need assistance.

This should now be resolved.

@jeverley jeverley force-pushed the zha_metering_summation_received branch from 31c7867 to d1c55e2 Compare January 23, 2024 11:22
@TheJulianJES TheJulianJES changed the title Sensor for exposing Summation Received attribute from Zigbee Metering cluster Add ZHA metering summation received sensor Jan 24, 2024
@dmulcahey dmulcahey merged commit af1ba4b into home-assistant:dev Jan 24, 2024
23 checks passed
@dmulcahey
Copy link
Contributor

thanks for the contribution!

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