Area units and conversion between metric and US (#123563)

* area conversions * start work on tests * add number device class * update unit conversions to utilise distance constants * add area unit * update test unit system * update device condition and trigger * update statistic unit converters * further tests work WIP * update test unit system * add missing string translations * fix websocket tests * add deprecated notice * add more missing strings and missing initialisation of unit system * adjust icon and remove strings from scrape and random * Fix acre to meters conversion Co-authored-by: epenet <[email protected]> * Tidy up valid units Co-authored-by: epenet <[email protected]> * fix ordering of area * update order alphabetically * fix broken test * update test_init * Update homeassistant/const.py Co-authored-by: epenet <[email protected]> * remove deprecated unit and fix alphabetical order * change deprecation and add tests, change to millimeter conversion for inches * fix order * re-order defs alphabetically * add measurement as well * update icons * fix up Deprecation of area square meters * Update core integrations to UnitOfArea * update test recorder tests * unit system tests in alphabetical * update snapshot * rebuild * revert alphabetization of functions * other revert of alphabetical order --------- Co-authored-by: epenet <[email protected]>
home-assistant · Nov 21, 2024 · d854940 · d854940
1 parent 9add3a6
commit d854940
Show file tree

Hide file tree

Showing 29 changed files with 394 additions and 47 deletions.
diff --git a/homeassistant/components/ecovacs/sensor.py b/homeassistant/components/ecovacs/sensor.py
@@ -26,11 +26,11 @@
     SensorStateClass,
 )
 from homeassistant.const import (
-    AREA_SQUARE_METERS,
     ATTR_BATTERY_LEVEL,
     CONF_DESCRIPTION,
     PERCENTAGE,
     EntityCategory,
+    UnitOfArea,
     UnitOfTime,
 )
 from homeassistant.core import HomeAssistant
@@ -67,7 +67,7 @@ class EcovacsSensorEntityDescription(
         capability_fn=lambda caps: caps.stats.clean,
         value_fn=lambda e: e.area,
         translation_key="stats_area",
-        native_unit_of_measurement=AREA_SQUARE_METERS,
+        native_unit_of_measurement=UnitOfArea.SQUARE_METERS,
     ),
     EcovacsSensorEntityDescription[StatsEvent](
         key="stats_time",
@@ -84,7 +84,7 @@ class EcovacsSensorEntityDescription(
         value_fn=lambda e: e.area,
         key="total_stats_area",
         translation_key="total_stats_area",
-        native_unit_of_measurement=AREA_SQUARE_METERS,
+        native_unit_of_measurement=UnitOfArea.SQUARE_METERS,
         state_class=SensorStateClass.TOTAL_INCREASING,
     ),
     EcovacsSensorEntityDescription[TotalStatsEvent](

diff --git a/homeassistant/components/number/const.py b/homeassistant/components/number/const.py
@@ -17,6 +17,7 @@
     SIGNAL_STRENGTH_DECIBELS,
     SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
     UnitOfApparentPower,
+    UnitOfArea,
     UnitOfBloodGlucoseConcentration,
     UnitOfConductivity,
     UnitOfDataRate,
@@ -98,6 +99,12 @@ class NumberDeviceClass(StrEnum):
     Unit of measurement: `None`
     """
 
+    AREA = "area"
+    """Area
+
+    Unit of measurement: `UnitOfArea` units
+    """
+
     ATMOSPHERIC_PRESSURE = "atmospheric_pressure"
     """Atmospheric pressure.
 
@@ -434,6 +441,7 @@ class NumberDeviceClass(StrEnum):
 DEVICE_CLASS_UNITS: dict[NumberDeviceClass, set[type[StrEnum] | str | None]] = {
     NumberDeviceClass.APPARENT_POWER: set(UnitOfApparentPower),
     NumberDeviceClass.AQI: {None},
+    NumberDeviceClass.AREA: set(UnitOfArea),
     NumberDeviceClass.ATMOSPHERIC_PRESSURE: set(UnitOfPressure),
     NumberDeviceClass.BATTERY: {PERCENTAGE},
     NumberDeviceClass.BLOOD_GLUCOSE_CONCENTRATION: set(UnitOfBloodGlucoseConcentration),

diff --git a/homeassistant/components/number/icons.json b/homeassistant/components/number/icons.json
@@ -9,6 +9,9 @@
     "aqi": {
       "default": "mdi:air-filter"
     },
+    "area": {
+      "default": "mdi:texture-box"
+    },
     "atmospheric_pressure": {
       "default": "mdi:thermometer-lines"
     },

diff --git a/homeassistant/components/number/strings.json b/homeassistant/components/number/strings.json
@@ -37,6 +37,9 @@
     "aqi": {
       "name": "[%key:component::sensor::entity_component::aqi::name%]"
     },
+    "area": {
+      "name": "[%key:component::sensor::entity_component::area::name%]"
+    },
     "atmospheric_pressure": {
       "name": "[%key:component::sensor::entity_component::atmospheric_pressure::name%]"
     },

diff --git a/homeassistant/components/recorder/statistics.py b/homeassistant/components/recorder/statistics.py
@@ -27,6 +27,7 @@
 from homeassistant.helpers.typing import UNDEFINED, UndefinedType
 from homeassistant.util import dt as dt_util
 from homeassistant.util.unit_conversion import (
+    AreaConverter,
     BaseUnitConverter,
     BloodGlucoseConcentrationConverter,
     ConductivityConverter,
@@ -129,6 +130,7 @@
 
 
 STATISTIC_UNIT_TO_UNIT_CONVERTER: dict[str | None, type[BaseUnitConverter]] = {
+    **{unit: AreaConverter for unit in AreaConverter.VALID_UNITS},
     **{
         unit: BloodGlucoseConcentrationConverter
         for unit in BloodGlucoseConcentrationConverter.VALID_UNITS

diff --git a/homeassistant/components/recorder/websocket_api.py b/homeassistant/components/recorder/websocket_api.py
@@ -16,6 +16,7 @@
 from homeassistant.helpers.json import json_bytes
 from homeassistant.util import dt as dt_util
 from homeassistant.util.unit_conversion import (
+    AreaConverter,
     BloodGlucoseConcentrationConverter,
     ConductivityConverter,
     DataRateConverter,
@@ -55,6 +56,7 @@
 
 UNIT_SCHEMA = vol.Schema(
     {
+        vol.Optional("area"): vol.In(AreaConverter.VALID_UNITS),
         vol.Optional("blood_glucose_concentration"): vol.In(
             BloodGlucoseConcentrationConverter.VALID_UNITS
         ),

diff --git a/homeassistant/components/rituals_perfume_genie/select.py b/homeassistant/components/rituals_perfume_genie/select.py
@@ -9,7 +9,7 @@
 
 from homeassistant.components.select import SelectEntity, SelectEntityDescription
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import AREA_SQUARE_METERS, EntityCategory
+from homeassistant.const import EntityCategory, UnitOfArea
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
@@ -30,7 +30,7 @@ class RitualsSelectEntityDescription(SelectEntityDescription):
     RitualsSelectEntityDescription(
         key="room_size_square_meter",
         translation_key="room_size_square_meter",
-        unit_of_measurement=AREA_SQUARE_METERS,
+        unit_of_measurement=UnitOfArea.SQUARE_METERS,
         entity_category=EntityCategory.CONFIG,
         options=["15", "30", "60", "100"],
         current_fn=lambda diffuser: str(diffuser.room_size_square_meter),

diff --git a/homeassistant/components/roborock/sensor.py b/homeassistant/components/roborock/sensor.py
@@ -25,12 +25,7 @@
     SensorEntity,
     SensorEntityDescription,
 )
-from homeassistant.const import (
-    AREA_SQUARE_METERS,
-    PERCENTAGE,
-    EntityCategory,
-    UnitOfTime,
-)
+from homeassistant.const import PERCENTAGE, EntityCategory, UnitOfArea, UnitOfTime
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.typing import StateType
@@ -131,14 +126,14 @@ def _dock_error_value_fn(properties: DeviceProp) -> str | None:
         translation_key="cleaning_area",
         value_fn=lambda data: data.status.square_meter_clean_area,
         entity_category=EntityCategory.DIAGNOSTIC,
-        native_unit_of_measurement=AREA_SQUARE_METERS,
+        native_unit_of_measurement=UnitOfArea.SQUARE_METERS,
     ),
     RoborockSensorDescription(
         key="total_cleaning_area",
         translation_key="total_cleaning_area",
         value_fn=lambda data: data.clean_summary.square_meter_clean_area,
         entity_category=EntityCategory.DIAGNOSTIC,
-        native_unit_of_measurement=AREA_SQUARE_METERS,
+        native_unit_of_measurement=UnitOfArea.SQUARE_METERS,
     ),
     RoborockSensorDescription(
         key="vacuum_error",

diff --git a/homeassistant/components/romy/sensor.py b/homeassistant/components/romy/sensor.py
@@ -8,10 +8,10 @@
 )
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
-    AREA_SQUARE_METERS,
     PERCENTAGE,
     SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
     EntityCategory,
+    UnitOfArea,
     UnitOfLength,
     UnitOfTime,
 )
@@ -61,7 +61,7 @@
         key="total_area_cleaned",
         translation_key="total_area_cleaned",
         state_class=SensorStateClass.TOTAL,
-        native_unit_of_measurement=AREA_SQUARE_METERS,
+        native_unit_of_measurement=UnitOfArea.SQUARE_METERS,
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
     SensorEntityDescription(

diff --git a/homeassistant/components/roomba/sensor.py b/homeassistant/components/roomba/sensor.py
@@ -12,12 +12,7 @@
     SensorStateClass,
 )
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import (
-    AREA_SQUARE_METERS,
-    PERCENTAGE,
-    EntityCategory,
-    UnitOfTime,
-)
+from homeassistant.const import PERCENTAGE, EntityCategory, UnitOfArea, UnitOfTime
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.typing import StateType
@@ -108,7 +103,7 @@ class RoombaSensorEntityDescription(SensorEntityDescription):
     RoombaSensorEntityDescription(
         key="total_cleaned_area",
         translation_key="total_cleaned_area",
-        native_unit_of_measurement=AREA_SQUARE_METERS,
+        native_unit_of_measurement=UnitOfArea.SQUARE_METERS,
         entity_category=EntityCategory.DIAGNOSTIC,
         value_fn=lambda self: (
             None if (sqft := self.run_stats.get("sqft")) is None else sqft * 9.29

diff --git a/homeassistant/components/sensor/const.py b/homeassistant/components/sensor/const.py
@@ -17,6 +17,7 @@
     SIGNAL_STRENGTH_DECIBELS,
     SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
     UnitOfApparentPower,
+    UnitOfArea,
     UnitOfBloodGlucoseConcentration,
     UnitOfConductivity,
     UnitOfDataRate,
@@ -47,6 +48,7 @@
     dir_with_deprecated_constants,
 )
 from homeassistant.util.unit_conversion import (
+    AreaConverter,
     BaseUnitConverter,
     BloodGlucoseConcentrationConverter,
     ConductivityConverter,
@@ -117,6 +119,12 @@ class SensorDeviceClass(StrEnum):
     Unit of measurement: `None`
     """
 
+    AREA = "area"
+    """Area
+
+    Unit of measurement: `UnitOfArea` units
+    """
+
     ATMOSPHERIC_PRESSURE = "atmospheric_pressure"
     """Atmospheric pressure.
 
@@ -500,6 +508,7 @@ class SensorStateClass(StrEnum):
 STATE_CLASSES: Final[list[str]] = [cls.value for cls in SensorStateClass]
 
 UNIT_CONVERTERS: dict[SensorDeviceClass | str | None, type[BaseUnitConverter]] = {
+    SensorDeviceClass.AREA: AreaConverter,
     SensorDeviceClass.ATMOSPHERIC_PRESSURE: PressureConverter,
     SensorDeviceClass.BLOOD_GLUCOSE_CONCENTRATION: BloodGlucoseConcentrationConverter,
     SensorDeviceClass.CONDUCTIVITY: ConductivityConverter,
@@ -531,6 +540,7 @@ class SensorStateClass(StrEnum):
 DEVICE_CLASS_UNITS: dict[SensorDeviceClass, set[type[StrEnum] | str | None]] = {
     SensorDeviceClass.APPARENT_POWER: set(UnitOfApparentPower),
     SensorDeviceClass.AQI: {None},
+    SensorDeviceClass.AREA: set(UnitOfArea),
     SensorDeviceClass.ATMOSPHERIC_PRESSURE: set(UnitOfPressure),
     SensorDeviceClass.BATTERY: {PERCENTAGE},
     SensorDeviceClass.BLOOD_GLUCOSE_CONCENTRATION: set(UnitOfBloodGlucoseConcentration),
@@ -607,6 +617,7 @@ class SensorStateClass(StrEnum):
 DEVICE_CLASS_STATE_CLASSES: dict[SensorDeviceClass, set[SensorStateClass]] = {
     SensorDeviceClass.APPARENT_POWER: {SensorStateClass.MEASUREMENT},
     SensorDeviceClass.AQI: {SensorStateClass.MEASUREMENT},
+    SensorDeviceClass.AREA: set(SensorStateClass),
     SensorDeviceClass.ATMOSPHERIC_PRESSURE: {SensorStateClass.MEASUREMENT},
     SensorDeviceClass.BATTERY: {SensorStateClass.MEASUREMENT},
     SensorDeviceClass.BLOOD_GLUCOSE_CONCENTRATION: {SensorStateClass.MEASUREMENT},

diff --git a/homeassistant/components/sensor/device_condition.py b/homeassistant/components/sensor/device_condition.py
@@ -35,6 +35,7 @@
 
 CONF_IS_APPARENT_POWER = "is_apparent_power"
 CONF_IS_AQI = "is_aqi"
+CONF_IS_AREA = "is_area"
 CONF_IS_ATMOSPHERIC_PRESSURE = "is_atmospheric_pressure"
 CONF_IS_BATTERY_LEVEL = "is_battery_level"
 CONF_IS_BLOOD_GLUCOSE_CONCENTRATION = "is_blood_glucose_concentration"
@@ -86,6 +87,7 @@
 ENTITY_CONDITIONS = {
     SensorDeviceClass.APPARENT_POWER: [{CONF_TYPE: CONF_IS_APPARENT_POWER}],
     SensorDeviceClass.AQI: [{CONF_TYPE: CONF_IS_AQI}],
+    SensorDeviceClass.AREA: [{CONF_TYPE: CONF_IS_AREA}],
     SensorDeviceClass.ATMOSPHERIC_PRESSURE: [{CONF_TYPE: CONF_IS_ATMOSPHERIC_PRESSURE}],
     SensorDeviceClass.BATTERY: [{CONF_TYPE: CONF_IS_BATTERY_LEVEL}],
     SensorDeviceClass.BLOOD_GLUCOSE_CONCENTRATION: [
@@ -153,6 +155,7 @@
                 [
                     CONF_IS_APPARENT_POWER,
                     CONF_IS_AQI,
+                    CONF_IS_AREA,
                     CONF_IS_ATMOSPHERIC_PRESSURE,
                     CONF_IS_BATTERY_LEVEL,
                     CONF_IS_BLOOD_GLUCOSE_CONCENTRATION,

diff --git a/homeassistant/components/sensor/device_trigger.py b/homeassistant/components/sensor/device_trigger.py
@@ -34,6 +34,7 @@
 
 CONF_APPARENT_POWER = "apparent_power"
 CONF_AQI = "aqi"
+CONF_AREA = "area"
 CONF_ATMOSPHERIC_PRESSURE = "atmospheric_pressure"
 CONF_BATTERY_LEVEL = "battery_level"
 CONF_BLOOD_GLUCOSE_CONCENTRATION = "blood_glucose_concentration"
@@ -85,6 +86,7 @@
 ENTITY_TRIGGERS = {
     SensorDeviceClass.APPARENT_POWER: [{CONF_TYPE: CONF_APPARENT_POWER}],
     SensorDeviceClass.AQI: [{CONF_TYPE: CONF_AQI}],
+    SensorDeviceClass.AREA: [{CONF_TYPE: CONF_AREA}],
     SensorDeviceClass.ATMOSPHERIC_PRESSURE: [{CONF_TYPE: CONF_ATMOSPHERIC_PRESSURE}],
     SensorDeviceClass.BATTERY: [{CONF_TYPE: CONF_BATTERY_LEVEL}],
     SensorDeviceClass.BLOOD_GLUCOSE_CONCENTRATION: [
@@ -153,6 +155,7 @@
                 [
                     CONF_APPARENT_POWER,
                     CONF_AQI,
+                    CONF_AREA,
                     CONF_ATMOSPHERIC_PRESSURE,
                     CONF_BATTERY_LEVEL,
                     CONF_BLOOD_GLUCOSE_CONCENTRATION,

diff --git a/homeassistant/components/sensor/icons.json b/homeassistant/components/sensor/icons.json
@@ -9,6 +9,9 @@
     "aqi": {
       "default": "mdi:air-filter"
     },
+    "area": {
+      "default": "mdi:texture-box"
+    },
     "atmospheric_pressure": {
       "default": "mdi:thermometer-lines"
     },

diff --git a/homeassistant/components/sensor/strings.json b/homeassistant/components/sensor/strings.json
@@ -4,6 +4,7 @@
     "condition_type": {
       "is_apparent_power": "Current {entity_name} apparent power",
       "is_aqi": "Current {entity_name} air quality index",
+      "is_area": "Current {entity_name} area",
       "is_atmospheric_pressure": "Current {entity_name} atmospheric pressure",
       "is_battery_level": "Current {entity_name} battery level",
       "is_blood_glucose_concentration": "Current {entity_name} blood glucose concentration",
@@ -55,6 +56,7 @@
     "trigger_type": {
       "apparent_power": "{entity_name} apparent power changes",
       "aqi": "{entity_name} air quality index changes",
+      "area": "{entity_name} area changes",
       "atmospheric_pressure": "{entity_name} atmospheric pressure changes",
       "battery_level": "{entity_name} battery level changes",
       "blood_glucose_concentration": "{entity_name} blood glucose concentration changes",
@@ -145,6 +147,9 @@
     "aqi": {
       "name": "Air quality index"
     },
+    "area": {
+      "name": "Area"
+    },
     "atmospheric_pressure": {
       "name": "Atmospheric pressure"
     },

diff --git a/homeassistant/components/smartthings/sensor.py b/homeassistant/components/smartthings/sensor.py
@@ -15,11 +15,11 @@
 )
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
-    AREA_SQUARE_METERS,
     CONCENTRATION_PARTS_PER_MILLION,
     LIGHT_LUX,
     PERCENTAGE,
     EntityCategory,
+    UnitOfArea,
     UnitOfElectricPotential,
     UnitOfEnergy,
     UnitOfMass,
@@ -95,7 +95,7 @@ class Map(NamedTuple):
         Map(
             Attribute.bmi_measurement,
             "Body Mass Index",
-            f"{UnitOfMass.KILOGRAMS}/{AREA_SQUARE_METERS}",
+            f"{UnitOfMass.KILOGRAMS}/{UnitOfArea.SQUARE_METERS}",
             None,
             SensorStateClass.MEASUREMENT,
             None,