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

Remove duplicate sensors on single phase HomeWizard meters #104493

Merged
merged 2 commits into from
Nov 26, 2023
Merged

Conversation

frenck
Copy link
Member

@frenck frenck commented Nov 25, 2023

Breaking change

HomeWizard HWE-SKE (the wall plugs), SDM230, and SDM630 provided duplicate sensors for energy import and export: A total and a tariff of 1. As there is only a single tariff available on those, the total and tariff 1 are always the same. To clean this up, tariff 1 has been removed.

If you used this sensor in your energy dashboard, you will need to configure your energy dashboard to use the total import/export sensor instead.

Proposed change

The HomeWizard devices that monitor a single phase have some oddness in the user experience.

Tests have been updated to reflect the changes and the snapshots now show the effective difference of these changes.

These devices provide duplicate sensors for both energy export and import. A total and a tariff 1 sensor; however, as there is always a single tariff, it causes them to be the same.

This causes duplicate data to be logged and causes confusion on which sensor to use. This PR ensures the tariff 1 import/export sensors are only created if a second tariff exists, resulting in them not being created anymore on SDM/SKT devices.

A backward, incompatible change is highlighted in the breaking change section of this PR description.

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 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

Code owners of homewizard 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 homewizard 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.

homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 25, 2023 10:47
@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.

@frenck frenck marked this pull request as ready for review November 25, 2023 10:48
@home-assistant home-assistant bot requested a review from jbouwh November 25, 2023 10:48
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

Sorry, it took me some time to understand how this works.
Looks good to me now :-)
Thnx @frenck 👍

Copy link
Contributor

@DCSBL DCSBL left a comment

Choose a reason for hiding this comment

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

When testing with the suggested changes applied in an actual Home Assistant instance, I get the same result that this PR initially tries to fix.

I can't figure out why Pytest does not agree, it can't find sensor.device_total_energy_import...

homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
@frenck frenck marked this pull request as draft November 26, 2023 09:40
Copy link
Contributor

@DCSBL DCSBL 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 👍 Just a minor doc-thingy but that should be it!

homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/homewizard/sensor.py Outdated Show resolved Hide resolved
@frenck frenck marked this pull request as ready for review November 26, 2023 10:36
@home-assistant home-assistant bot requested review from jbouwh and DCSBL November 26, 2023 10:36
@frenck frenck merged commit 32eab2c into dev Nov 26, 2023
20 checks passed
@frenck frenck deleted the frenck-2023-1470 branch November 26, 2023 10:42
@DCSBL
Copy link
Contributor

DCSBL commented Nov 26, 2023

Nice!

Should we do this with active_power + active_power_l1 too (for HWE-SKT and SDM-230)?

@github-actions github-actions bot locked and limited conversation to collaborators Nov 27, 2023
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.

3 participants