Area units and conversion between metric and US #123563

mikey0000 · 2024-08-11T04:01:36Z

Breaking change

Proposed change

Add Area units and conversions from metric to US customary

home-assistant/architecture#1124

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 the lack of conversion of area squared

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Area square meters docs home-assistant.io#35732
developer docs: Add blog and update number and sensor entity docs developers.home-assistant#2448

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:

Documentation added/updated for www.home-assistant.io

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:

I have reviewed two other open pull requests in this repository.

home-assistant

There is a merge conflict.

home-assistant · 2024-08-11T04:01:41Z

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.

emontnemery · 2024-10-22T10:41:27Z

@mikey0000 CI checks are failing. Please fix that, and then make sure to click the "Ready for review" button to have your PR reviewed.

emontnemery · 2024-10-22T10:49:40Z

@mikey0000 I don't see the rationale for adding the area converter. Which integrations will make use of this? I think there needs to be an approved architecture discussion first. If that's already the case, please link to it.

mikey0000 · 2024-10-22T18:26:32Z

@mikey0000 I don't see the rationale for adding the area converter. Which integrations will make use of this? I think there needs to be an approved architecture discussion first. If that's already the case, please link to it.

All lawn mower integrations use area squared, added the architecture discussion link

emontnemery · 2024-10-23T20:17:59Z

Thanks @mikey0000 for adding the link to the architecture proposal 👍

However, just adding a utility function for converting areas is not enough for integrations - and users - to benefit. You'll also need to add a new sensor device class, and add preferred area units to the metric and us customary unit systems.

Here's an example of a more complete PR, although it did not add preferred conductivity units to the unit systems: #118728
This is an example of a PR adding preferred units to the unit systems: https://github.com/home-assistant/core/pull/90504/files

mikey0000 · 2024-10-23T20:24:04Z

Thanks @mikey0000 for adding the link to the architecture proposal 👍

However, just adding a utility function for converting areas is not enough for integrations - and users - to benefit. You'll also need to add a new sensor device class, and add preferred area units to the metric and us customary unit systems.

Here's an example of a more complete PR, although it did not add preferred conductivity units to the unit systems: #118728 This is an example of a PR adding preferred units to the unit systems: https://github.com/home-assistant/core/pull/90504/files

Thanks, I'll update it. Thanks also for the reply on the Architecture discussion.

homeassistant/util/unit_conversion.py

coderabbitai · 2024-10-23T20:48:21Z

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

emontnemery · 2024-10-24T18:46:24Z

@mikey0000 the architecture proposal is approved 👍
There are quite a lot of places which need to be updated when adding a new sensor device class with unit conversion, feel free to reach out on Discord if anything is unclear. My nick there is @emontnemery

mikey0000 · 2024-10-24T19:02:24Z

@mikey0000 the architecture proposal is approved 👍 There are quite a lot of places which need to be updated when adding a new sensor device class with unit conversion, feel free to reach out on Discord if anything is unclear. My nick there is @emontnemery

Thanks I really appreciate the support, see you in the code owners channel 😄

gjohansson-ST · 2024-11-09T22:24:02Z

Marked the PR as draft as there is quite a bit of conflicts that needs to be sorted.

"tsconfig-paths-webpack-plugin": "^4.1.0",

mikey0000 · 2024-11-09T23:33:13Z

Marked the PR as draft as there is quite a bit of conflicts that needs to be sorted.

Sorted

mikey0000 · 2024-11-10T06:46:59Z

Not sure why one test is timing out.

homeassistant/components/recorder/statistics.py

homeassistant/util/unit_system.py

emontnemery

Nice, thanks @mikey0000 👍

Stale

gjohansson-ST

LGTM 👍

emontnemery · 2024-11-12T07:14:28Z

Please open and link to documentation PRs for:

mikey0000 · 2024-11-12T19:45:46Z

Please open and link to documentation PRs for:

* https://developers.home-assistant.io/docs/core/entity/number

* https://developers.home-assistant.io/docs/core/entity/sensor

* A dev blog post

* https://next.home-assistant.io/integrations/number/

* https://next.home-assistant.io/integrations/sensor/

added

jpbede

Some conflicts appeared, could you have a look?

Stale

area conversions

cad9d37

mikey0000 requested a review from a team as a code owner August 11, 2024 04:01

home-assistant bot previously requested changes Aug 11, 2024

View reviewed changes

home-assistant bot added cla-signed core labels Aug 11, 2024

home-assistant bot marked this pull request as draft August 11, 2024 04:01

mikey0000 changed the title ~~area conversions~~ Area units and conversion between metric and US Aug 11, 2024

mikey0000 and others added 3 commits August 11, 2024 16:03

Merge branch 'dev' into add-square-inches-feet

62bfb22

start work on tests

53ea897

Merge branch 'dev' into add-square-inches-feet

d6c68cf

mikey0000 requested a review from home-assistant[bot] August 14, 2024 02:30

Merge branch 'dev' into add-square-inches-feet

02da0e5

Merge branch 'dev' into add-square-inches-feet

7215ba1

emontnemery reviewed Oct 23, 2024

View reviewed changes

homeassistant/util/unit_conversion.py Outdated Show resolved Hide resolved

add number device class

33f324a

mikey0000 added 5 commits October 24, 2024 10:09

update unit conversions to utilise distance constants

242b84a

add area unit

99c3738

update test unit system

abb8466

update device condition and trigger

3a33cd9

update statistic unit converters

42e0fa4

further tests work WIP

25df0ae

Merge branch 'dev' into add-square-inches-feet

cd5bbc5

"tsconfig-paths-webpack-plugin": "^4.1.0",

mikey0000 marked this pull request as ready for review November 9, 2024 23:32

rebuild

b419724

Merge branch 'dev' into add-square-inches-feet

2fb7e1f

emontnemery reviewed Nov 11, 2024

View reviewed changes

homeassistant/components/recorder/statistics.py Outdated Show resolved Hide resolved

Merge branch 'dev' into add-square-inches-feet

5c6e31a

mikey0000 requested a review from emontnemery November 11, 2024 18:03

emontnemery reviewed Nov 11, 2024

View reviewed changes

homeassistant/util/unit_system.py Show resolved Hide resolved

revert alphabetization of functions

6ccfaa2

emontnemery approved these changes Nov 11, 2024

View reviewed changes

other revert of alphabetical order

57b81ed

gjohansson-ST approved these changes Nov 11, 2024

View reviewed changes

emontnemery added the docs-missing label Nov 12, 2024

This was referenced Nov 12, 2024

Add blog and update number and sensor entity docs home-assistant/developers.home-assistant#2448

Open

Area square meters docs home-assistant/home-assistant.io#35732

Merged

gjohansson-ST removed the docs-missing label Nov 14, 2024

jpbede previously requested changes Nov 14, 2024

View reviewed changes

home-assistant bot marked this pull request as draft November 14, 2024 18:47

Merge branch 'dev' into add-square-inches-feet

4b4adf5

mikey0000 marked this pull request as ready for review November 14, 2024 19:31

home-assistant bot requested review from emontnemery and jpbede November 14, 2024 19:31

emontnemery merged commit d854940 into home-assistant:dev Nov 21, 2024
64 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Area units and conversion between metric and US #123563

Area units and conversion between metric and US #123563

mikey0000 commented Aug 11, 2024 •

edited

Loading

home-assistant bot left a comment

home-assistant bot commented Aug 11, 2024

emontnemery commented Oct 22, 2024

emontnemery commented Oct 22, 2024

mikey0000 commented Oct 22, 2024 •

edited

Loading

emontnemery commented Oct 23, 2024 •

edited

Loading

mikey0000 commented Oct 23, 2024

coderabbitai bot commented Oct 23, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

emontnemery commented Oct 24, 2024

mikey0000 commented Oct 24, 2024

gjohansson-ST commented Nov 9, 2024

mikey0000 commented Nov 9, 2024

mikey0000 commented Nov 10, 2024

emontnemery left a comment

gjohansson-ST left a comment

emontnemery commented Nov 12, 2024

mikey0000 commented Nov 12, 2024

jpbede left a comment

Area units and conversion between metric and US #123563

Area units and conversion between metric and US #123563

Conversation

mikey0000 commented Aug 11, 2024 • edited Loading

Breaking change

Proposed change

Type of change

Additional information

Checklist

home-assistant bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Aug 11, 2024

emontnemery commented Oct 22, 2024

emontnemery commented Oct 22, 2024

mikey0000 commented Oct 22, 2024 • edited Loading

emontnemery commented Oct 23, 2024 • edited Loading

mikey0000 commented Oct 23, 2024

coderabbitai bot commented Oct 23, 2024 • edited Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

emontnemery commented Oct 24, 2024

mikey0000 commented Oct 24, 2024

gjohansson-ST commented Nov 9, 2024

mikey0000 commented Nov 9, 2024

mikey0000 commented Nov 10, 2024

emontnemery left a comment

Choose a reason for hiding this comment

gjohansson-ST left a comment

Choose a reason for hiding this comment

emontnemery commented Nov 12, 2024

mikey0000 commented Nov 12, 2024

jpbede left a comment

Choose a reason for hiding this comment

mikey0000 commented Aug 11, 2024 •

edited

Loading

mikey0000 commented Oct 22, 2024 •

edited

Loading

emontnemery commented Oct 23, 2024 •

edited

Loading

coderabbitai bot commented Oct 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)