Update Shelly Neo water valve device class and units (home-assistant#152080)

Author: thecode

homeassistant/components/shelly/const.py

@@ -30,6 +30,7 @@
 
 from homeassistant.components.number import NumberMode
 from homeassistant.components.sensor import SensorDeviceClass
+from homeassistant.const import UnitOfVolumeFlowRate
 
 DOMAIN: Final = "shelly"
 
@@ -287,6 +288,15 @@ class BLEScannerMode(StrEnum):
 ROLE_TO_DEVICE_CLASS_MAP = {
     "current_humidity": SensorDeviceClass.HUMIDITY,
     "current_temperature": SensorDeviceClass.TEMPERATURE,
+    "flow_rate": SensorDeviceClass.VOLUME_FLOW_RATE,
+    "water_pressure": SensorDeviceClass.PRESSURE,
+    "water_temperature": SensorDeviceClass.TEMPERATURE,
+}
+
+# Mapping for units that require conversion to a Home Assistant recognized unit
+# e.g. "m3/min" to "m³/min"
+DEVICE_UNIT_MAP = {
+    "m3/min": UnitOfVolumeFlowRate.CUBIC_METERS_PER_MINUTE,
 }
 
 # We want to check only the first 5 KB of the script if it contains emitEvent()

homeassistant/components/shelly/number.py

@@ -40,6 +40,7 @@
     get_blu_trv_device_info,
     get_device_entry_gen,
     get_virtual_component_ids,
+    get_virtual_component_unit,
 )
 
 PARALLEL_UPDATES = 0
@@ -189,10 +190,7 @@ async def async_set_native_value(self, value: float) -> None:
             config["meta"]["ui"]["view"], NumberMode.BOX
         ),
         step_fn=lambda config: config["meta"]["ui"].get("step"),
-        # If the unit is not set, the device sends an empty string
-        unit=lambda config: config["meta"]["ui"]["unit"]
-        if config["meta"]["ui"]["unit"]
-        else None,
+        unit=get_virtual_component_unit,
         method="number_set",
     ),
     "valve_position": RpcNumberDescription(

homeassistant/components/shelly/sensor.py

@@ -61,6 +61,7 @@
     get_device_uptime,
     get_shelly_air_lamp_life,
     get_virtual_component_ids,
+    get_virtual_component_unit,
     is_rpc_wifi_stations_disabled,
 )
 
@@ -1376,9 +1377,7 @@ def __init__(
     "number": RpcSensorDescription(
         key="number",
         sub_key="value",
-        unit=lambda config: config["meta"]["ui"]["unit"]
-        if config["meta"]["ui"]["unit"]
-        else None,
+        unit=get_virtual_component_unit,
         device_class_fn=lambda config: ROLE_TO_DEVICE_CLASS_MAP.get(config["role"])
         if "role" in config
         else None,

homeassistant/components/shelly/utils.py

@@ -57,6 +57,7 @@
     COMPONENT_ID_PATTERN,
     CONF_COAP_PORT,
     CONF_GEN,
+    DEVICE_UNIT_MAP,
     DEVICES_WITHOUT_FIRMWARE_CHANGELOG,
     DOMAIN,
     FIRMWARE_UNSUPPORTED_ISSUE_ID,
@@ -653,6 +654,15 @@ def get_virtual_component_ids(config: dict[str, Any], platform: str) -> list[str
     return ids
 
 
+def get_virtual_component_unit(config: dict[str, Any]) -> str | None:
+    """Return the unit of a virtual component.
+
+    If the unit is not set, the device sends an empty string
+    """
+    unit = config["meta"]["ui"]["unit"]
+    return DEVICE_UNIT_MAP.get(unit, unit) if unit else None
+
+
 @callback
 def async_remove_orphaned_entities(
     hass: HomeAssistant,

tests/components/shelly/test_sensor.py

@@ -1138,6 +1138,7 @@ async def test_rpc_remove_text_virtual_sensor_when_orphaned(
     ("name", "entity_id", "original_unit", "expected_unit"),
     [
         ("Virtual number sensor", "sensor.test_name_virtual_number_sensor", "W", "W"),
+        ("Unit map", "sensor.test_name_unit_map", "m3/min", "m³/min"),
         (None, "sensor.test_name_number_203", "", None),
     ],
 )