-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
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
Add sensor unit of measurement validation for device classes #84366
Conversation
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
@@ -453,6 +478,74 @@ class SensorStateClass(StrEnum): | |||
SensorDeviceClass.WIND_SPEED: SpeedConverter, | |||
} | |||
|
|||
DEVICE_CLASS_UNITS: dict[SensorDeviceClass, set[type[StrEnum] | str | None]] = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to have the same validation for number entities?
And would it make sense to have this dict shared somewhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have no validations on numbers whatsoever at this point. But yes, we can add more validation there too.
I suggest doing that at a later point.
Essentially, those are not the same device classes... (we can enforce keeping them in sync though)
UnitOfVolume.CUBIC_METERS, | ||
}, | ||
SensorDeviceClass.HUMIDITY: {PERCENTAGE}, | ||
SensorDeviceClass.ILLUMINANCE: {LIGHT_LUX, "lm"}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if lm
should be kept here. Lumen is a unit of Luminous flux
, not a unit of Illuminance
I have opened an architecture discussion about it in home-assistant/architecture#843
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is not adding something new, the discussion is fine, but it doesn't have to block this.
Proposed change
This PR adds validation for the units of measurement used by sensor entities when those entities have a device class.
Device classes limit their use of units, as documented in our end-user and developer documentation.
The idea is that this would help with strange/inconsistent occurrences and reduce the need to watch out for these things in code reviews.
In the future (e.g., 2023.6), we could change this to raise instead of a warning. Each warning is currently logged just once.
Example warning;
2022-12-21 13:08:06.195 WARNING (MainThread) [homeassistant.components.sensor] Entity sensor.today_energy (<class 'homeassistant.components.demo.sensor.DemoSumSensor'>) is using native unit of measurement 'cows' which is not a valid unit for the device class ('energy') it is using; Please update your configuration if your entity is manually configured, otherwise create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+demo%22
Type of change
Additional information
Checklist
black --fast homeassistant tests
)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest
.requirements_all.txt
.Updated by running
python3 -m script.gen_requirements_all
..coveragerc
.To help with the load of incoming pull requests: