feat: add support for TP972S (#122)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: J. Nick Koston <nick@home-assistant.io>

Author: 3 people

src/thermopro_ble/parser.py

@@ -11,13 +11,13 @@
 
 import logging
 from math import tanh
-from struct import Struct, error as struct_error
+from struct import Struct
 
 from bluetooth_data_tools import short_address
 from bluetooth_sensor_state_data import BluetoothData
 from sensor_state_data import SensorLibrary
 
-from habluetooth import BluetoothServiceInfoBleak
+from habluetooth import BluetoothServiceInfo, BluetoothServiceInfoBleak
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -30,6 +30,7 @@
 
 UNPACK_TEMP_HUMID = Struct("<hB").unpack
 UNPACK_SPIKE_TEMP = Struct("<BHHH").unpack
+UNPACK_SPIKE_PRO_TEMP = Struct("<BHHfffHHH").unpack
 
 
 # TP96x battery values appear to be a voltage reading, probably in millivolts.
@@ -47,7 +48,36 @@ def tp96_battery(voltage: int) -> float:
 class ThermoProBluetoothDeviceData(BluetoothData):
     """Date update for ThermoPro Bluetooth devices."""
 
-    def _start_update(self, service_info: BluetoothServiceInfoBleak) -> None:
+    def _update_sensors(
+        self,
+        probe_one_indexed: int,
+        internal_temp: int,
+        ambient_temp: int,
+        battery_percent: float,
+    ) -> None:
+        self.update_predefined_sensor(
+            SensorLibrary.TEMPERATURE__CELSIUS,
+            internal_temp,
+            key=f"internal_temperature_probe_{probe_one_indexed}",
+            name=f"Probe {probe_one_indexed} Internal Temperature",
+        )
+        self.update_predefined_sensor(
+            SensorLibrary.TEMPERATURE__CELSIUS,
+            ambient_temp,
+            key=f"ambient_temperature_probe_{probe_one_indexed}",
+            name=f"Probe {probe_one_indexed} Ambient Temperature",
+        )
+        self.set_precision(0)
+        self.update_predefined_sensor(
+            SensorLibrary.BATTERY__PERCENTAGE,
+            battery_percent,
+            key=f"battery_probe_{probe_one_indexed}",
+            name=f"Probe {probe_one_indexed} Battery",
+        )
+
+    def _start_update(
+        self, service_info: BluetoothServiceInfo | BluetoothServiceInfoBleak
+    ) -> None:
         """Update from BLE advertisement data."""
         _LOGGER.debug("Parsing thermopro BLE advertisement data: %s", service_info)
         name = service_info.name
@@ -74,56 +104,63 @@ def _start_update(self, service_info: BluetoothServiceInfoBleak) -> None:
             + changed_manufacturer_data[last_id]
         )
 
-        if len(data) < 6:
+        data_length = len(data)
+
+        if data_length == 23 and name.startswith("TP97"):
+            # TP972 has a 23-byte format
+            # It has an internal temp probe and an ambient temp probe
+            (
+                probe_zero_indexed,
+                ambient_temp,
+                battery_voltage,
+                _,  # looks to be part of some temp range (min)
+                internal_temp,
+                _,  # looks to be part of some temp range (max)
+                _,
+                _,
+                _,  # looks like a static id
+            ) = UNPACK_SPIKE_PRO_TEMP(data)
+
+            probe_one_indexed = probe_zero_indexed + 1
+            internal_temp = int(internal_temp) - 54
+            ambient_temp = int(ambient_temp) - 54
+            battery_percent = tp96_battery(battery_voltage)
+            self._update_sensors(
+                probe_one_indexed, internal_temp, ambient_temp, battery_percent
+            )
             return
 
-        if name.startswith(("TP96", "TP97")):
-            # TP96 has a different format
+        if data_length == 7 and name.startswith(("TP96", "TP97")):
+            # TP96 has a different format that is shared with TP970
             # It has an internal temp probe and an ambient temp probe
-            try:
-                (
-                    probe_zero_indexed,
-                    internal_temp,
-                    battery_voltage,
-                    ambient_temp,
-                ) = UNPACK_SPIKE_TEMP(data)
-            except struct_error:
-                _LOGGER.error("Error parsing data from probe: %s", data)
-                return
+            (
+                probe_zero_indexed,
+                internal_temp,
+                battery_voltage,
+                ambient_temp,
+            ) = UNPACK_SPIKE_TEMP(data)
 
             probe_one_indexed = probe_zero_indexed + 1
             internal_temp = internal_temp - 30
             ambient_temp = ambient_temp - 30
             battery_percent = tp96_battery(battery_voltage)
-            self.update_predefined_sensor(
-                SensorLibrary.TEMPERATURE__CELSIUS,
-                internal_temp,
-                key=f"internal_temperature_probe_{probe_one_indexed}",
-                name=f"Probe {probe_one_indexed} Internal Temperature",
-            )
-            self.update_predefined_sensor(
-                SensorLibrary.TEMPERATURE__CELSIUS,
-                ambient_temp,
-                key=f"ambient_temperature_probe_{probe_one_indexed}",
-                name=f"Probe {probe_one_indexed} Ambient Temperature",
-            )
-            self.set_precision(0)
-            self.update_predefined_sensor(
-                SensorLibrary.BATTERY__PERCENTAGE,
-                battery_percent,
-                key=f"battery_probe_{probe_one_indexed}",
-                name=f"Probe {probe_one_indexed} Battery",
+            self._update_sensors(
+                probe_one_indexed, internal_temp, ambient_temp, battery_percent
             )
             return
 
         # TP357S seems to be in 6, TP397 and TP393 in 4
-        battery_byte = data[6] if len(data) == 7 else data[4]
-        if battery_byte in BATTERY_VALUE_TO_LEVEL:
-            self.update_predefined_sensor(
-                SensorLibrary.BATTERY__PERCENTAGE,
-                BATTERY_VALUE_TO_LEVEL[battery_byte],
-            )
+        if data_length >= 6 and name.startswith("TP3"):
+            battery_byte = data[6] if data_length == 7 else data[4]
+            if battery_byte in BATTERY_VALUE_TO_LEVEL:
+                self.update_predefined_sensor(
+                    SensorLibrary.BATTERY__PERCENTAGE,
+                    BATTERY_VALUE_TO_LEVEL[battery_byte],
+                )
+
+            (temp, humi) = UNPACK_TEMP_HUMID(data[1:4])
+            self.update_predefined_sensor(SensorLibrary.TEMPERATURE__CELSIUS, temp / 10)
+            self.update_predefined_sensor(SensorLibrary.HUMIDITY__PERCENTAGE, humi)
+            return
 
-        (temp, humi) = UNPACK_TEMP_HUMID(data[1:4])
-        self.update_predefined_sensor(SensorLibrary.TEMPERATURE__CELSIUS, temp / 10)
-        self.update_predefined_sensor(SensorLibrary.HUMIDITY__PERCENTAGE, humi)
+        _LOGGER.error("Error parsing data from probe: %s", data)