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 lumen from Illuminance units #84386

Merged
merged 6 commits into from
Dec 27, 2022

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Dec 21, 2022

Breaking change

For developpers only: lm is no longer allowed as a unit for sensors with Illuminance device class.

Proposed change

Linked to home-assistant/architecture#843

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
  • 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:

@epenet epenet requested a review from a team as a code owner December 21, 2022 15:55
@home-assistant home-assistant bot added cla-signed core deprecation Indicates a breaking change to happen in the future integration: number integration: sensor small-pr PRs with less than 30 lines. Quality Scale: internal labels Dec 21, 2022
@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 issue.
  • @home-assistant rename Awesome new title Change the title of the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign sensor Removes the current integration label and assignees on the issue, add the integration domain after the command.

@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 issue.
  • @home-assistant rename Awesome new title Change the title of the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign number Removes the current integration label and assignees on the issue, add the integration domain after the command.

@epenet epenet changed the title Remove lumen from Illumination units Remove lumen from Illuminance units Dec 21, 2022
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.

The affected integrations need to be cleaned up too.

These are (as it seems):

  • Plugwise
  • Xiaomi Miio
  • HomeKit

Additionally, our custom test component uses "lm" as a unit of measurement for this device class, which needs to be adjusted too.

@MartinHjelmare
Copy link
Member

Here's another one:

UnitOfMeasurement(
unit="lm",
aliases={"lum", "lumen"},
device_classes={SensorDeviceClass.ILLUMINANCE},
),

@epenet
Copy link
Contributor Author

epenet commented Dec 27, 2022

Not sure how to cleanup tuya. Should I be removing the whole UnitOfMeasurement entry? Or should I just be clearing the device_classes set?

@frenck
Copy link
Member

frenck commented Dec 27, 2022

Not sure how to cleanup tuya. Should I be removing the whole UnitOfMeasurement entry? Or should I just be clearing the device_classes set?

Yup! 👍

@epenet
Copy link
Contributor Author

epenet commented Dec 27, 2022

Not sure how to cleanup tuya. Should I be removing the whole UnitOfMeasurement entry? Or should I just be clearing the device_classes set?

Yup! 👍

Was that a "yup" to remove the whole UnitOfMeasurement entry? (as I did)
Or was that a "yup" to only clear the device_classes set? (in which case I need to bring the UnitOfMeasurement entry back in)

@frenck
Copy link
Member

frenck commented Dec 27, 2022

The "yup" was the removal, your last commit is correct 👍

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.

Thanks, @epenet 👍

@frenck frenck merged commit 4c8e3aa into home-assistant:dev Dec 27, 2022
@epenet epenet deleted the Illumination-units branch December 27, 2022 13:41
@github-actions github-actions bot locked and limited conversation to collaborators Dec 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core deprecation Indicates a breaking change to happen in the future integration: number integration: sensor Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants