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

Use right state class for volume and timestamp sensor in bthome #107675

Merged
merged 1 commit into from Jan 20, 2024

Conversation

jpbede
Copy link
Member

@jpbede jpbede commented Jan 9, 2024

Proposed change

bthome uses the wrong state class for sensors with the device class timestamp and volume. Noticed this while doing #107639

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 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Jan 9, 2024

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

Code owner commands

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

@Ernst79
Copy link
Contributor

Ernst79 commented Jan 9, 2024

Looks good to me

@gjohansson-ST
Copy link
Member

Isn't this messing with people's LTS if we just change it?

@@ -316,7 +315,7 @@
key=f"{BTHomeSensorDeviceClass.VOLUME}_{Units.VOLUME_LITERS}",
Copy link
Contributor

Choose a reason for hiding this comment

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

Since volume can be both a "total" (amount of water which has flowed through a pipe) and a measurement (amount of water in a gas tank), please add comments explaining which one this is. Or could it be both since bthome allows to create your own sensors?
If it's the latter, I think bthome needs to differentiate between those two, and/or make it clear which one a bthome volume sensor represents because they are not quite the same thing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I checked the bthome documentation (https://bthome.io/format/), I think this should be the stored amount of volume, as the volume flow rate is below. So we need to keep the state class and change the device class to VOLUME_STORAGE.

Copy link
Contributor

Choose a reason for hiding this comment

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

volume flow rate is in m3/hr, that is something different.

I think we have to create two different sensors in https://github.com/Bluetooth-Devices/bthome-ble

A VOLUME_STORAGE sensor with and SensorStateClass measurement
A VOLUME sensor with UoM Liter and SensorStateClass total

Copy link
Contributor

Choose a reason for hiding this comment

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

My proposal would be that you use SensorStateClass total for the current VOLUME sensor. The VOLUME_STORAGE sensor can be added later in a different PR. I have made an issue on the bthome repo here for that request. Bluetooth-Devices/bthome-ble#100

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok perfect, thanks for creating the issue in the bthome repo. Than this PR is fine. I spoke to @emontnemery about the LTS and that would be fine as the LTS have been wrong since the beginning.

Copy link
Contributor

@Ernst79 Ernst79 Jan 10, 2024

Choose a reason for hiding this comment

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

@jpbede jpbede marked this pull request as draft January 10, 2024 12:57
@jpbede jpbede marked this pull request as ready for review January 10, 2024 20:12
@Ernst79 Ernst79 mentioned this pull request Jan 10, 2024
20 tasks
@jpbede jpbede merged commit c2820e3 into home-assistant:dev Jan 20, 2024
23 checks passed
@jpbede jpbede deleted the bthome-fix-state-classes branch January 20, 2024 15:03
@github-actions github-actions bot locked and limited conversation to collaborators Jan 21, 2024
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.

None yet

4 participants