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

Dynamically map state class, device class and UoM in ZHA smart energy metering sensor #107685

Merged

Conversation

jpbede
Copy link
Member

@jpbede jpbede commented Jan 9, 2024

Proposed change

Currently, the status class and the device class are statically assigned for the ZHA sensors 'SmartEnergyMetering' and 'SmartEnergySummation', which leads to inadmissible use, e.g. the device class 'Energy' is assigned for a sensor measuring liters.

This PR creates a additional mapping for state class and device class besides the unit of measurement.
Noticed while doing #107639

In addition, these attributes are set in the __init__ to prevent them from being looked up again and again.

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

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Jan 9, 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.

@jpbede jpbede marked this pull request as draft January 11, 2024 06:45
@jpbede jpbede marked this pull request as ready for review January 11, 2024 11:43
@home-assistant home-assistant bot marked this pull request as draft January 11, 2024 12:13
@home-assistant
Copy link

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.

@jpbede jpbede marked this pull request as ready for review January 11, 2024 19:26
@MartinHjelmare MartinHjelmare marked this pull request as draft January 12, 2024 10:58
@jpbede jpbede marked this pull request as ready for review January 12, 2024 12:28
@MartinHjelmare
Copy link
Member

The changed test needs to be reviewed by a code owner. The rest looks good.

@elupus
Copy link
Contributor

elupus commented Jan 14, 2024

@MartinHjelmare i think your review is stale? Still okey with this change?

scale=1000,
),
0x0B: SmartEnergyMeteringEntityDescription(
native_unit_of_measurement="unitless", device_class=None, state_class=None
Copy link
Member

Choose a reason for hiding this comment

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

Side note: unitless is not a valid unit.

Copy link
Member Author

Choose a reason for hiding this comment

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

None would be right?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, but we shouldn't change it now.

tests/components/zha/test_sensor.py Show resolved Hide resolved
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.

Looks good!

@MartinHjelmare MartinHjelmare merged commit 1001483 into home-assistant:dev Jan 16, 2024
23 checks passed
@jpbede jpbede deleted the zha-smart-energy-metering-mapping branch January 17, 2024 07:06
@github-actions github-actions bot locked and limited conversation to collaborators Jan 18, 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.

ZHA water metering devices and device class issue
6 participants