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

Energy distance units #136933

Merged
merged 10 commits into from
Jan 31, 2025
Merged

Conversation

jschlyter
Copy link
Contributor

@jschlyter jschlyter commented Jan 30, 2025

Proposed change

Add an energy_distance sensor device class with support for unit conversion between metric and US customary energy consumption units by distance, including their inverses (Europe normally uses energy per distance whereas US/UK uses distance per energy). The following units should be supported:

  • kWh/100km
  • mi/kWh
  • km/kWh

Discussed in home-assistant/architecture#1163

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:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (sensor) you are listed as a code owner for? Thanks!

Code owner commands

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

@home-assistant
Copy link

Hey there @home-assistant/core, @Shulyaka, mind taking a look at this pull request as it has been labeled with an integration (number) you are listed as a code owner for? Thanks!

Code owner commands

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

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (recorder) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of recorder 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 recorder 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/sensor/strings.json Outdated Show resolved Hide resolved
homeassistant/components/sensor/strings.json Outdated Show resolved Hide resolved
homeassistant/components/sensor/strings.json Outdated Show resolved Hide resolved
homeassistant/util/unit_conversion.py Outdated Show resolved Hide resolved
@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.

@home-assistant home-assistant bot marked this pull request as draft January 30, 2025 19:16
@jschlyter jschlyter marked this pull request as ready for review January 30, 2025 19:45
@home-assistant home-assistant bot requested a review from abmantis January 30, 2025 19:45
@jschlyter
Copy link
Contributor Author

Ping @fredriklj, please review for https://github.com/CJNE/ha-porscheconnect

@abmantis
Copy link
Contributor

The tests are failing:

FAILED tests/util/test_unit_conversion.py::test_all_converters[EnergyDistanceConverter] - AssertionError: converter is not present in _GET_UNIT_RATIO

homeassistant/util/unit_conversion.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 31, 2025 10:05
Copy link
Contributor

@epenet epenet left a comment

Choose a reason for hiding this comment

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

My concerns have been addressed

@jschlyter jschlyter marked this pull request as ready for review January 31, 2025 10:41
@home-assistant home-assistant bot requested review from abmantis and epenet January 31, 2025 10:41
@abmantis
Copy link
Contributor

Thanks!

@abmantis abmantis merged commit 84ae476 into home-assistant:dev Jan 31, 2025
46 checks passed
@jschlyter jschlyter deleted the energy_distance_units branch January 31, 2025 15:34
@github-actions github-actions bot locked and limited conversation to collaborators Feb 1, 2025
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.

4 participants