Improve advanced Z-Wave battery discovery (home-assistant#147127)

Author: MartinHjelmare

homeassistant/components/zwave_js/binary_sensor.py

@@ -318,12 +318,37 @@ class PropertyZWaveJSEntityDescription(BinarySensorEntityDescription):
 
 
 # Mappings for boolean sensors
-BOOLEAN_SENSOR_MAPPINGS: dict[int, BinarySensorEntityDescription] = {
-    CommandClass.BATTERY: BinarySensorEntityDescription(
-        key=str(CommandClass.BATTERY),
+BOOLEAN_SENSOR_MAPPINGS: dict[tuple[int, int | str], BinarySensorEntityDescription] = {
+    (CommandClass.BATTERY, "backup"): BinarySensorEntityDescription(
+        key="battery_backup",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
+    (CommandClass.BATTERY, "disconnected"): BinarySensorEntityDescription(
+        key="battery_disconnected",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
+    (CommandClass.BATTERY, "isLow"): BinarySensorEntityDescription(
+        key="battery_is_low",
         device_class=BinarySensorDeviceClass.BATTERY,
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
+    (CommandClass.BATTERY, "lowFluid"): BinarySensorEntityDescription(
+        key="battery_low_fluid",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
+    (CommandClass.BATTERY, "overheating"): BinarySensorEntityDescription(
+        key="battery_overheating",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
+    (CommandClass.BATTERY, "rechargeable"): BinarySensorEntityDescription(
+        key="battery_rechargeable",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
 }
 
 
@@ -432,8 +457,9 @@ def __init__(
 
         # Entity class attributes
         self._attr_name = self.generate_name(include_value_name=True)
+        primary_value = self.info.primary_value
         if description := BOOLEAN_SENSOR_MAPPINGS.get(
-            self.info.primary_value.command_class
+            (primary_value.command_class, primary_value.property_)
         ):
             self.entity_description = description
 

homeassistant/components/zwave_js/const.py

@@ -139,7 +139,10 @@
 ADDON_SLUG = "core_zwave_js"
 
 # Sensor entity description constants
-ENTITY_DESC_KEY_BATTERY = "battery"
+ENTITY_DESC_KEY_BATTERY_LEVEL = "battery_level"
+ENTITY_DESC_KEY_BATTERY_LIST_STATE = "battery_list_state"
+ENTITY_DESC_KEY_BATTERY_MAXIMUM_CAPACITY = "battery_maximum_capacity"
+ENTITY_DESC_KEY_BATTERY_TEMPERATURE = "battery_temperature"
 ENTITY_DESC_KEY_CURRENT = "current"
 ENTITY_DESC_KEY_VOLTAGE = "voltage"
 ENTITY_DESC_KEY_ENERGY_MEASUREMENT = "energy_measurement"

homeassistant/components/zwave_js/discovery.py

@@ -913,7 +913,6 @@ class ZWaveDiscoverySchema:
         hint="numeric_sensor",
         primary_value=ZWaveValueDiscoverySchema(
             command_class={
-                CommandClass.BATTERY,
                 CommandClass.ENERGY_PRODUCTION,
                 CommandClass.SENSOR_ALARM,
                 CommandClass.SENSOR_MULTILEVEL,
@@ -922,6 +921,36 @@ class ZWaveDiscoverySchema:
         ),
         data_template=NumericSensorDataTemplate(),
     ),
+    ZWaveDiscoverySchema(
+        platform=Platform.SENSOR,
+        hint="numeric_sensor",
+        primary_value=ZWaveValueDiscoverySchema(
+            command_class={CommandClass.BATTERY},
+            type={ValueType.NUMBER},
+            property={"level", "maximumCapacity"},
+        ),
+        data_template=NumericSensorDataTemplate(),
+    ),
+    ZWaveDiscoverySchema(
+        platform=Platform.SENSOR,
+        hint="numeric_sensor",
+        primary_value=ZWaveValueDiscoverySchema(
+            command_class={CommandClass.BATTERY},
+            type={ValueType.NUMBER},
+            property={"temperature"},
+        ),
+        data_template=NumericSensorDataTemplate(),
+    ),
+    ZWaveDiscoverySchema(
+        platform=Platform.SENSOR,
+        hint="list",
+        primary_value=ZWaveValueDiscoverySchema(
+            command_class={CommandClass.BATTERY},
+            type={ValueType.NUMBER},
+            property={"chargingStatus", "rechargeOrReplace"},
+        ),
+        data_template=NumericSensorDataTemplate(),
+    ),
     ZWaveDiscoverySchema(
         platform=Platform.SENSOR,
         hint="numeric_sensor",

homeassistant/components/zwave_js/discovery_data_template.py

@@ -133,7 +133,10 @@
 )
 
 from .const import (
-    ENTITY_DESC_KEY_BATTERY,
+    ENTITY_DESC_KEY_BATTERY_LEVEL,
+    ENTITY_DESC_KEY_BATTERY_LIST_STATE,
+    ENTITY_DESC_KEY_BATTERY_MAXIMUM_CAPACITY,
+    ENTITY_DESC_KEY_BATTERY_TEMPERATURE,
     ENTITY_DESC_KEY_CO,
     ENTITY_DESC_KEY_CO2,
     ENTITY_DESC_KEY_CURRENT,
@@ -380,8 +383,31 @@ def find_key_from_matching_set[_T: Enum](
     def resolve_data(self, value: ZwaveValue) -> NumericSensorDataTemplateData:
         """Resolve helper class data for a discovered value."""
 
-        if value.command_class == CommandClass.BATTERY:
-            return NumericSensorDataTemplateData(ENTITY_DESC_KEY_BATTERY, PERCENTAGE)
+        if value.command_class == CommandClass.BATTERY and value.property_ == "level":
+            return NumericSensorDataTemplateData(
+                ENTITY_DESC_KEY_BATTERY_LEVEL, PERCENTAGE
+            )
+        if value.command_class == CommandClass.BATTERY and value.property_ in (
+            "chargingStatus",
+            "rechargeOrReplace",
+        ):
+            return NumericSensorDataTemplateData(
+                ENTITY_DESC_KEY_BATTERY_LIST_STATE, None
+            )
+        if (
+            value.command_class == CommandClass.BATTERY
+            and value.property_ == "maximumCapacity"
+        ):
+            return NumericSensorDataTemplateData(
+                ENTITY_DESC_KEY_BATTERY_MAXIMUM_CAPACITY, PERCENTAGE
+            )
+        if (
+            value.command_class == CommandClass.BATTERY
+            and value.property_ == "temperature"
+        ):
+            return NumericSensorDataTemplateData(
+                ENTITY_DESC_KEY_BATTERY_TEMPERATURE, UnitOfTemperature.CELSIUS
+            )
 
         if value.command_class == CommandClass.METER:
             try:

homeassistant/components/zwave_js/sensor.py

@@ -58,7 +58,10 @@
     ATTR_VALUE,
     DATA_CLIENT,
     DOMAIN,
-    ENTITY_DESC_KEY_BATTERY,
+    ENTITY_DESC_KEY_BATTERY_LEVEL,
+    ENTITY_DESC_KEY_BATTERY_LIST_STATE,
+    ENTITY_DESC_KEY_BATTERY_MAXIMUM_CAPACITY,
+    ENTITY_DESC_KEY_BATTERY_TEMPERATURE,
     ENTITY_DESC_KEY_CO,
     ENTITY_DESC_KEY_CO2,
     ENTITY_DESC_KEY_CURRENT,
@@ -95,17 +98,33 @@
 PARALLEL_UPDATES = 0
 
 
-# These descriptions should include device class.
-ENTITY_DESCRIPTION_KEY_DEVICE_CLASS_MAP: dict[
-    tuple[str, str], SensorEntityDescription
-] = {
-    (ENTITY_DESC_KEY_BATTERY, PERCENTAGE): SensorEntityDescription(
-        key=ENTITY_DESC_KEY_BATTERY,
+# These descriptions should have a non None unit of measurement.
+ENTITY_DESCRIPTION_KEY_UNIT_MAP: dict[tuple[str, str], SensorEntityDescription] = {
+    (ENTITY_DESC_KEY_BATTERY_LEVEL, PERCENTAGE): SensorEntityDescription(
+        key=ENTITY_DESC_KEY_BATTERY_LEVEL,
         device_class=SensorDeviceClass.BATTERY,
         entity_category=EntityCategory.DIAGNOSTIC,
         state_class=SensorStateClass.MEASUREMENT,
         native_unit_of_measurement=PERCENTAGE,
     ),
+    (ENTITY_DESC_KEY_BATTERY_MAXIMUM_CAPACITY, PERCENTAGE): SensorEntityDescription(
+        key=ENTITY_DESC_KEY_BATTERY_MAXIMUM_CAPACITY,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement=PERCENTAGE,
+        entity_registry_enabled_default=False,
+    ),
+    (
+        ENTITY_DESC_KEY_BATTERY_TEMPERATURE,
+        UnitOfTemperature.CELSIUS,
+    ): SensorEntityDescription(
+        key=ENTITY_DESC_KEY_BATTERY_TEMPERATURE,
+        device_class=SensorDeviceClass.TEMPERATURE,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        state_class=SensorStateClass.MEASUREMENT,
+        native_unit_of_measurement=UnitOfTemperature.CELSIUS,
+        entity_registry_enabled_default=False,
+    ),
     (ENTITY_DESC_KEY_CURRENT, UnitOfElectricCurrent.AMPERE): SensorEntityDescription(
         key=ENTITY_DESC_KEY_CURRENT,
         device_class=SensorDeviceClass.CURRENT,
@@ -285,8 +304,14 @@
     ),
 }
 
-# These descriptions are without device class.
+# These descriptions are without unit of measurement.
 ENTITY_DESCRIPTION_KEY_MAP = {
+    ENTITY_DESC_KEY_BATTERY_LIST_STATE: SensorEntityDescription(
+        key=ENTITY_DESC_KEY_BATTERY_LIST_STATE,
+        device_class=SensorDeviceClass.ENUM,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
     ENTITY_DESC_KEY_CO: SensorEntityDescription(
         key=ENTITY_DESC_KEY_CO,
         state_class=SensorStateClass.MEASUREMENT,
@@ -538,7 +563,7 @@ def get_entity_description(
     """Return the entity description for the given data."""
     data_description_key = data.entity_description_key or ""
     data_unit = data.unit_of_measurement or ""
-    return ENTITY_DESCRIPTION_KEY_DEVICE_CLASS_MAP.get(
+    return ENTITY_DESCRIPTION_KEY_UNIT_MAP.get(
         (data_description_key, data_unit),
         ENTITY_DESCRIPTION_KEY_MAP.get(
             data_description_key,
@@ -588,6 +613,10 @@ def async_add_sensor(info: ZwaveDiscoveryInfo) -> None:
             entities.append(
                 ZWaveListSensor(config_entry, driver, info, entity_description)
             )
+        elif info.platform_hint == "list":
+            entities.append(
+                ZWaveListSensor(config_entry, driver, info, entity_description)
+            )
         elif info.platform_hint == "config_parameter":
             entities.append(
                 ZWaveConfigParameterSensor(

tests/components/zwave_js/common.py

@@ -21,7 +21,6 @@
 VOLTAGE_SENSOR = "sensor.smart_plug_with_two_usb_ports_value_electric_consumed_3"
 CURRENT_SENSOR = "sensor.smart_plug_with_two_usb_ports_value_electric_consumed_4"
 SWITCH_ENTITY = "switch.smart_plug_with_two_usb_ports"
-LOW_BATTERY_BINARY_SENSOR = "binary_sensor.multisensor_6_low_battery_level"
 ENABLED_LEGACY_BINARY_SENSOR = "binary_sensor.z_wave_door_window_sensor_any"
 DISABLED_LEGACY_BINARY_SENSOR = "binary_sensor.multisensor_6_any"
 NOTIFICATION_MOTION_BINARY_SENSOR = "binary_sensor.multisensor_6_motion_detection"

tests/components/zwave_js/conftest.py

@@ -199,6 +199,12 @@ def climate_heatit_z_trm3_no_value_state_fixture() -> dict[str, Any]:
     return load_json_object_fixture("climate_heatit_z_trm3_no_value_state.json", DOMAIN)
 
 
+@pytest.fixture(name="ring_keypad_state", scope="package")
+def ring_keypad_state_fixture() -> dict[str, Any]:
+    """Load the Ring keypad state fixture data."""
+    return load_json_object_fixture("ring_keypad_state.json", DOMAIN)
+
+
 @pytest.fixture(name="nortek_thermostat_state", scope="package")
 def nortek_thermostat_state_fixture() -> dict[str, Any]:
     """Load the nortek thermostat node state fixture data."""
@@ -876,6 +882,14 @@ def nortek_thermostat_removed_event_fixture(client) -> Node:
     return Event("node removed", event_data)
 
 
+@pytest.fixture(name="ring_keypad")
+def ring_keypad_fixture(client: MagicMock, ring_keypad_state: NodeDataType) -> Node:
+    """Mock a Ring keypad node."""
+    node = Node(client, copy.deepcopy(ring_keypad_state))
+    client.driver.controller.nodes[node.node_id] = node
+    return node
+
+
 @pytest.fixture(name="integration")
 async def integration_fixture(
     hass: HomeAssistant,