From 96b7fc9a754cbfa1b8146b37f848f9031337db0d Mon Sep 17 00:00:00 2001 From: Trevor Schirmer <24777085+TrevorSchirmer@users.noreply.github.com> Date: Sun, 22 Sep 2024 10:01:46 -0400 Subject: [PATCH] Add mm/s and in/s As Unit Of Speed (#125044) Co-authored-by: J. Nick Koston --- homeassistant/components/sensor/const.py | 4 ++-- homeassistant/const.py | 2 ++ homeassistant/util/unit_conversion.py | 4 ++++ homeassistant/util/unit_system.py | 2 ++ tests/components/sensor/test_websocket_api.py | 2 ++ tests/util/test_unit_conversion.py | 14 ++++++++++++++ tests/util/test_unit_system.py | 12 ++++++++++++ 7 files changed, 38 insertions(+), 2 deletions(-) diff --git a/homeassistant/components/sensor/const.py b/homeassistant/components/sensor/const.py index de30678d9fa..da0b48a23a0 100644 --- a/homeassistant/components/sensor/const.py +++ b/homeassistant/components/sensor/const.py @@ -350,8 +350,8 @@ class SensorDeviceClass(StrEnum): """Generic speed. Unit of measurement: `SPEED_*` units or `UnitOfVolumetricFlux` - - SI /metric: `mm/d`, `mm/h`, `m/s`, `km/h` - - USCS / imperial: `in/d`, `in/h`, `ft/s`, `mph` + - SI /metric: `mm/d`, `mm/h`, `m/s`, `km/h`, `mm/s` + - USCS / imperial: `in/d`, `in/h`, `in/s`, `ft/s`, `mph` - Nautical: `kn` - Beaufort: `Beaufort` """ diff --git a/homeassistant/const.py b/homeassistant/const.py index aaffcc9aa84..257fcd2bfd2 100644 --- a/homeassistant/const.py +++ b/homeassistant/const.py @@ -1273,10 +1273,12 @@ class UnitOfSpeed(StrEnum): BEAUFORT = "Beaufort" FEET_PER_SECOND = "ft/s" + INCHES_PER_SECOND = "in/s" METERS_PER_SECOND = "m/s" KILOMETERS_PER_HOUR = "km/h" KNOTS = "kn" MILES_PER_HOUR = "mph" + MILLIMETERS_PER_SECOND = "mm/s" _DEPRECATED_SPEED_FEET_PER_SECOND: Final = DeprecatedConstantEnum( diff --git a/homeassistant/util/unit_conversion.py b/homeassistant/util/unit_conversion.py index dd6d300a2c1..0f2f6464ed8 100644 --- a/homeassistant/util/unit_conversion.py +++ b/homeassistant/util/unit_conversion.py @@ -337,9 +337,11 @@ class SpeedConverter(BaseUnitConverter): UnitOfVolumetricFlux.MILLIMETERS_PER_DAY: _DAYS_TO_SECS / _MM_TO_M, UnitOfVolumetricFlux.MILLIMETERS_PER_HOUR: _HRS_TO_SECS / _MM_TO_M, UnitOfSpeed.FEET_PER_SECOND: 1 / _FOOT_TO_M, + UnitOfSpeed.INCHES_PER_SECOND: 1 / _IN_TO_M, UnitOfSpeed.KILOMETERS_PER_HOUR: _HRS_TO_SECS / _KM_TO_M, UnitOfSpeed.KNOTS: _HRS_TO_SECS / _NAUTICAL_MILE_TO_M, UnitOfSpeed.METERS_PER_SECOND: 1, + UnitOfSpeed.MILLIMETERS_PER_SECOND: 1 / _MM_TO_M, UnitOfSpeed.MILES_PER_HOUR: _HRS_TO_SECS / _MILE_TO_M, UnitOfSpeed.BEAUFORT: 1, } @@ -348,11 +350,13 @@ class SpeedConverter(BaseUnitConverter): UnitOfVolumetricFlux.INCHES_PER_HOUR, UnitOfVolumetricFlux.MILLIMETERS_PER_DAY, UnitOfVolumetricFlux.MILLIMETERS_PER_HOUR, + UnitOfSpeed.INCHES_PER_SECOND, UnitOfSpeed.FEET_PER_SECOND, UnitOfSpeed.KILOMETERS_PER_HOUR, UnitOfSpeed.KNOTS, UnitOfSpeed.METERS_PER_SECOND, UnitOfSpeed.MILES_PER_HOUR, + UnitOfSpeed.MILLIMETERS_PER_SECOND, UnitOfSpeed.BEAUFORT, } diff --git a/homeassistant/util/unit_system.py b/homeassistant/util/unit_system.py index 98cfb2f1368..02a115e10c1 100644 --- a/homeassistant/util/unit_system.py +++ b/homeassistant/util/unit_system.py @@ -258,6 +258,7 @@ METRIC_SYSTEM = UnitSystem( ("pressure", UnitOfPressure.INHG): UnitOfPressure.HPA, # Convert non-metric speeds except knots to km/h ("speed", UnitOfSpeed.FEET_PER_SECOND): UnitOfSpeed.KILOMETERS_PER_HOUR, + ("speed", UnitOfSpeed.INCHES_PER_SECOND): UnitOfSpeed.MILLIMETERS_PER_SECOND, ("speed", UnitOfSpeed.MILES_PER_HOUR): UnitOfSpeed.KILOMETERS_PER_HOUR, ( "speed", @@ -330,6 +331,7 @@ US_CUSTOMARY_SYSTEM = UnitSystem( ("pressure", UnitOfPressure.MMHG): UnitOfPressure.INHG, # Convert non-USCS speeds, except knots, to mph ("speed", UnitOfSpeed.METERS_PER_SECOND): UnitOfSpeed.MILES_PER_HOUR, + ("speed", UnitOfSpeed.MILLIMETERS_PER_SECOND): UnitOfSpeed.INCHES_PER_SECOND, ("speed", UnitOfSpeed.KILOMETERS_PER_HOUR): UnitOfSpeed.MILES_PER_HOUR, ( "speed", diff --git a/tests/components/sensor/test_websocket_api.py b/tests/components/sensor/test_websocket_api.py index 6f4eeb252e2..b1dafa04c94 100644 --- a/tests/components/sensor/test_websocket_api.py +++ b/tests/components/sensor/test_websocket_api.py @@ -36,11 +36,13 @@ async def test_device_class_units( "ft/s", "in/d", "in/h", + "in/s", "km/h", "kn", "m/s", "mm/d", "mm/h", + "mm/s", "mph", ] } diff --git a/tests/util/test_unit_conversion.py b/tests/util/test_unit_conversion.py index 8342aa732f8..2408914f256 100644 --- a/tests/util/test_unit_conversion.py +++ b/tests/util/test_unit_conversion.py @@ -431,6 +431,20 @@ _CONVERTED_VALUE: dict[ 708661.42, UnitOfVolumetricFlux.INCHES_PER_HOUR, ), + # 5 m/s * 1000 = 5000 mm/s + ( + 5, + UnitOfSpeed.METERS_PER_SECOND, + 5000, + UnitOfSpeed.MILLIMETERS_PER_SECOND, + ), + # 5 m/s รท 0.0254 = 196.8503937 in/s + ( + 5, + UnitOfSpeed.METERS_PER_SECOND, + 5 / 0.0254, + UnitOfSpeed.INCHES_PER_SECOND, + ), # 5000 in/h / 39.3701 in/m / 3600 s/h = 0.03528 m/s ( 5000, diff --git a/tests/util/test_unit_system.py b/tests/util/test_unit_system.py index 15500777212..316a9ead17a 100644 --- a/tests/util/test_unit_system.py +++ b/tests/util/test_unit_system.py @@ -413,6 +413,11 @@ def test_get_unit_system_invalid(key: str) -> None: UnitOfSpeed.FEET_PER_SECOND, UnitOfSpeed.KILOMETERS_PER_HOUR, ), + ( + SensorDeviceClass.SPEED, + UnitOfSpeed.INCHES_PER_SECOND, + UnitOfSpeed.MILLIMETERS_PER_SECOND, + ), ( SensorDeviceClass.SPEED, UnitOfSpeed.MILES_PER_HOUR, @@ -520,6 +525,7 @@ UNCONVERTED_UNITS_METRIC_SYSTEM = { UnitOfSpeed.KILOMETERS_PER_HOUR, UnitOfSpeed.KNOTS, UnitOfSpeed.METERS_PER_SECOND, + UnitOfSpeed.MILLIMETERS_PER_SECOND, UnitOfVolumetricFlux.MILLIMETERS_PER_DAY, UnitOfVolumetricFlux.MILLIMETERS_PER_HOUR, ), @@ -661,6 +667,11 @@ def test_metric_converted_units(device_class: SensorDeviceClass) -> None: ), (SensorDeviceClass.SPEED, UnitOfVolumetricFlux.INCHES_PER_DAY, None), (SensorDeviceClass.SPEED, UnitOfVolumetricFlux.INCHES_PER_HOUR, None), + ( + SensorDeviceClass.SPEED, + UnitOfSpeed.MILLIMETERS_PER_SECOND, + UnitOfSpeed.INCHES_PER_SECOND, + ), (SensorDeviceClass.SPEED, "very_fast", None), # Test volume conversion (SensorDeviceClass.VOLUME, UnitOfVolume.CUBIC_METERS, UnitOfVolume.CUBIC_FEET), @@ -729,6 +740,7 @@ UNCONVERTED_UNITS_US_SYSTEM = { UnitOfSpeed.FEET_PER_SECOND, UnitOfSpeed.KNOTS, UnitOfSpeed.MILES_PER_HOUR, + UnitOfSpeed.INCHES_PER_SECOND, UnitOfVolumetricFlux.INCHES_PER_DAY, UnitOfVolumetricFlux.INCHES_PER_HOUR, ),