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

Change friendly names of all photovoltaic entities to "PV …" #131179

Closed
wants to merge 1 commit into from

Conversation

NoRi2909
Copy link
Contributor

There are two groups of "solar" production entities, one for photovotaic and one for thermal solar production, in the vicare integration.

Currently they both have completely identical friendly names labeling them both as "Solar …".
This leads to confusion and makes it impossible to keep them apart.

This PR fixes this by giving all photovoltaic entities friendly names that begin with "PV …".

In addition the 'circulation_pump' entity is renamed as "Heating circulation pump" to clearly differentiate it from the "DHW circulation pump".

Otherwise many will misunderstand these, in German for example a "Zirkulationspumpe" is always for DHW, while the "Heating circulation pump" is called "Heizkreisumwälzpumpe" or just "Heizkreispumpe".

Proposed change

Change "Solar …" to "PV …" on all 'photovoltaic' keys.
Add "Heating …" to the 'circulation_pump' entity.

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:

There are two groups of "solar" production entities, one for photovotaic and one for thermal solar production in the vicare integration.

Currently they both have identical friendly names labeling them as "Solar …". This leads to confusion and make it impossible to keep them apart.

This PR fixes this by all photovoltaic entities friendly names that begin with "PV …".

In addition the 'circulation_pump' entity  is renamed as "Heating circulation pump" to clearly differentiate it from the "DHW circulation pump".

Otherwise many will misunderstand these, in German for example a "Zirkulationspumpe" is always for DHW, while the "Heating circulation pump" is called "Heizkreisumwälzpumpe" or just "Heizkreispumpe".
@home-assistant
Copy link

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

Code owner commands

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

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.

Hi there @NoRi2909 👋

CI is failing. Also, considering the branch name of your PR, is seems like this was done in the browser, if that is the case, this wouldn't be acceptable.

This changes logic in this integration, for which one locally needs to ensure the changes are correct and tested in a local development environment. The unit tests should pass before you'd open a PR.

Please pull this locally, test your changes and adapt the unit tests to make the CI pass.

../Frenck

@home-assistant home-assistant bot marked this pull request as draft November 21, 2024 17:26
@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.

@NoRi2909
Copy link
Contributor Author

@frenck Currently I can only do my PRs in the browser, so I'm afraid I cannot heat that problem in my own.

Didn't know that changing the frienly names interferes with the logic.

@CFenner
Copy link
Contributor

CFenner commented Nov 21, 2024

The test snapshots for the circulation pump are named by the entity names, as this changed, the snapshots are no longer found during testing. Please also adjust the names in the snapshots.

@frenck
Copy link
Member

frenck commented Nov 21, 2024

The test snapshots for the circulation pump are named by the entity names, as this changed, the snapshots are no longer found during testing. Please also adjust the names in the snapshots.

Snapshots should never be manually touched.

@frenck
Copy link
Member

frenck commented Nov 21, 2024

@frenck Currently I can only do my PRs in the browser, so I'm afraid I cannot heat that problem in my own.

Didn't know that changing the frienly names interferes with the logic.

In that case, we have to close this PR; as we cannot accept PRs in these state. They should be tested and passing CI.

Nevertheless, thanks for being willing to contribute 👍

../Frenck

@frenck frenck closed this Nov 21, 2024
@NoRi2909
Copy link
Contributor Author

Sorry for my mistakes here, still learning all the details of github etc.

@CFenner perhaps you can do a working PR with the suggested changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename photovoltaic entities to "PV" to differentiate from thermal Solar
3 participants