Change battery_state to low_battery

Author: bouwew

plugwise/constants.py

@@ -258,13 +258,13 @@
 ]
 
 BinarySensorType = Literal[
-    "battery_state",
     "compressor_state",
     "cooling_enabled",
     "cooling_state",
     "dhw_state",
     "flame_state",
     "heating_state",
+    "low_battery",
     "plugwise_notification",
     "secondary_boiler_state",
 ]
@@ -410,13 +410,13 @@ class ModelData(TypedDict):
 class SmileBinarySensors(TypedDict, total=False):
     """Smile Binary Sensors class."""
 
-    battery_state: bool
     compressor_state: bool
     cooling_enabled: bool
     cooling_state: bool
     dhw_state: bool
     flame_state: bool
     heating_state: bool
+    low_battery: bool
     plugwise_notification: bool
     secondary_boiler_state: bool
 

plugwise/data.py

@@ -65,22 +65,22 @@ def _update_gw_devices(self) -> None:
 
             is_battery_low = (
                 mac_list
-                and "battery_state" in device["binary_sensors"]
+                and "low_battery" in device["binary_sensors"]
                 and device["zigbee_mac_address"] in mac_list
                 and (
                     (device["dev_class"] in ("thermo_sensor", "thermostatic_radiator_valve") and device["sensors"]["battery"] < 30)
                     or (device["dev_class"] in ("zone_thermometer", "zone_thermostat") and device["sensors"]["battery"] < 15)
                 )
             )
             if is_battery_low:
-                device["binary_sensors"]["battery_state"] = True
+                device["binary_sensors"]["low_battery"] = True
 
             self._update_for_cooling(device)
 
             remove_empty_platform_dicts(device)
 
     def _detect_low_batteries(self) -> list[str]:
-        """Helper-function updating the battery_state binary_sensor status from a Battery-is-low message."""
+        """Helper-function updating the low-battery binary_sensor status from a Battery-is-low message."""
         mac_address_list: list[str] = []
         mac_pattern = re.compile(r"(?:[0-9A-F]{2}){8}")
         matches = ["Battery", "below"]

plugwise/util.py

@@ -139,7 +139,7 @@ def common_match_cases(
             data[sp_key] = value
 
     if "battery" in data["sensors"]:
-        data["binary_sensors"]["battery_state"] = False
+        data["binary_sensors"]["low_battery"] = False
 
 
 def escape_illegal_xml_characters(xmldata: str) -> str:

tests/data/adam/adam_plus_anna_new.json

@@ -71,7 +71,7 @@
     "zigbee_mac_address": "000D6F000C869B61",
     "vendor": "Plugwise",
     "binary_sensors": {
-        "battery_state": true
+        "low_battery": true
       },
     "sensors": {
       "temperature": 16.5,
@@ -182,7 +182,7 @@
     "zigbee_mac_address": "000D6F000C8FF5EE",
     "vendor": "Plugwise",
     "binary_sensors": {
-        "battery_state": false
+        "low_battery": false
       },
     "sensors": {
       "temperature": 17.6,

tests/data/adam/adam_plus_anna_new_UPDATED_DATA.json

@@ -28,7 +28,7 @@
   },
   "e2f4322d57924fa090fbbc48b3a140dc": {
     "binary_sensors": {
-        "battery_state": false
+        "low_battery": false
       },
     "mode": "off"
   },