Merge pull request #1321 from custom-components/Garnet-709BT

Add Garnet 709-BTP3 SeeLeveL II Tank Monitor

Author: Ernst79

custom_components/ble_monitor/ble_parser/oras.py

@@ -1,31 +1,87 @@
-"""Parser for Oras BLE advertisements."""
+"""Parser for Oras/Garnet BLE advertisements."""
 import logging
 
 from .helpers import to_mac, to_unformatted_mac
 
 _LOGGER = logging.getLogger(__name__)
 
+SENSOR_TYPE = {
+    0: "fresh tank",
+    1: "black tank",
+    2: "grey tank",
+    3: "lpg tank",
+    4: "lpg tank 2",
+    5: "galley tank",
+    6: "galley tank 2",
+    7: "temperature",
+    8: "temperature probe 2",
+    9: "temperature probe 3",
+    10: "temperature probe 4",
+    11: "chemical tank",
+    12: "chemical tank 2",
+    13: "voltage",
+}
+
 
 def parse_oras(self, data: bytes, mac: str):
-    """Parser for Oras toothbrush."""
+    """Parser for Oras toothbrush or Garnet tank."""
     msg_length = len(data)
-    firmware = "Oras"
-    result = {"firmware": firmware}
-    if msg_length == 22:
+    result = {"mac": to_unformatted_mac(mac)}
+
+    if msg_length == 18:
+        firmware = "Garnet"
+        device_type = "SeeLevel II 709-BTP3"
+
+        sensor_id = data[7]
+        try:
+            sensor_type = SENSOR_TYPE[sensor_id]
+        except ValueError:
+            return None
+
+        try:
+            sensor_data = int(data[8:11].decode("ASCII"))
+        except ValueError:
+            error_code = data[8:11].decode("ASCII")
+            _LOGGER.error(
+                "Garnet SeeLevel II 709-BTP3 is reporting error %s for sensor %s",
+                error_code,
+                sensor_type
+            )
+            return None
+
+        if sensor_id == 13:
+            sensor_data /= 10
+
+        sensor_volume = data[11:14].decode("ASCII")
+        sensor_total = data[14:17].decode("ASCII")
+        sensor_alarm = int(chr(data[17]))
+
+        result.update({
+            sensor_type: sensor_data,
+            "problem": sensor_alarm,
+        })
+        _LOGGER.debug(
+            "BLE ADV from Garnet DEVICE: %s, result: %s, not implemented volume %s, total %s",
+            device_type,
+            result,
+            sensor_volume,
+            sensor_total
+        )
+    elif msg_length == 22:
+        firmware = "Oras"
         device_type = "Electra Washbasin Faucet"
         battery = data[5]
         result.update({"battery": battery})
     else:
-        if self.report_unknown == "Oras":
+        if self.report_unknown in ["Oras", "Garnet"]:
             _LOGGER.info(
-                "BLE ADV from UNKNOWN Oras DEVICE: MAC: %s, ADV: %s",
+                "BLE ADV from UNKNOWN Oras/Garnet DEVICE: MAC: %s, ADV: %s",
                 to_mac(mac),
                 data.hex()
             )
         return None
 
     result.update({
-        "mac": to_unformatted_mac(mac),
         "type": device_type,
         "packet": "no packet id",
         "firmware": firmware,

custom_components/ble_monitor/const.py

@@ -1038,6 +1038,114 @@ class BLEMonitorBinarySensorEntityDescription(
         suggested_display_precision=1,
         state_class=SensorStateClass.MEASUREMENT,
     ),
+    BLEMonitorSensorEntityDescription(
+        key="fresh tank",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="fresh tank",
+        unique_id="fresh_tank_",
+        icon="mdi:storage-tank-outline",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="black tank",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="black tank",
+        unique_id="black_tank_",
+        icon="mdi:storage-tank-outline",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="grey tank",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="grey tank",
+        unique_id="grey_tank_",
+        icon="mdi:storage-tank-outline",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="chemical tank",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="chemical tank",
+        unique_id="chemical_tank_",
+        icon="mdi:chemical-weapon",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="chemical tank 2",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="chemical tank 2",
+        unique_id="chemical_tank_2_",
+        icon="mdi:chemical-weapon",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="lpg tank",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="lpg tank",
+        unique_id="lpg_tank_",
+        icon="mdi:gas-cylinder",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="lpg tank 2",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="lpg tank 2",
+        unique_id="lpg_tank_2_",
+        icon="mdi:gas-cylinder",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="galley tank",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="galley tank",
+        unique_id="galley_tank_",
+        icon="mdi:storage-tank-outline",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    BLEMonitorSensorEntityDescription(
+        key="galley tank 2",
+        sensor_class="MeasuringSensor",
+        update_behavior="Averaging",
+        name="galley tank 2",
+        unique_id="galley_tank_2_",
+        icon="mdi:storage-tank-outline",
+        native_unit_of_measurement=PERCENTAGE,
+        device_class=None,
+        suggested_display_precision=0,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
     BLEMonitorSensorEntityDescription(
         key="aqi",
         sensor_class="MeasuringSensor",
@@ -1922,6 +2030,7 @@ class BLEMonitorBinarySensorEntityDescription(
     'Blustream'               : 'Blustream',
     'BTHome'                  : 'BTHome',
     'CQ60'                    : 'Chef iQ',
+    'SeeLevel II 709-BTP3'    : 'Garnet Instruments Ltd',
     'MI401'                   : 'Grundfos',
     'HHCCJCY10'               : 'HHCC',
     'HolyIOT BLE tracker'     : 'HolyIOT',
@@ -1999,7 +2108,10 @@ class BLEMonitorBinarySensorEntityDescription(
     "acceleration",
     "ambient temperature",
     "battery",
+    "black tank",
     "button",
+    "chemical tank",
+    "chemical tank 2",
     "co2",
     "conductivity",
     "count",
@@ -2011,12 +2123,18 @@ class BLEMonitorBinarySensorEntityDescription(
     "duration",
     "energy",
     "flow",
+    "fresh tank",
+    "galley tank",
+    "galley tank 2",
     "gas",
     "gravity",
+    "grey tank",
     "gyroscope",
     "humidity",
     "illuminance",
     "impedance",
+    "lpg tank",
+    "lpg tank 2",
     "meat temperature",
     "moisture",
     "movement counter",
@@ -2067,6 +2185,7 @@ class BLEMonitorBinarySensorEntityDescription(
     "Blustream",
     "BTHome",
     'Chef iQ',
+    "Garnet",
     "Govee",
     "Grundfos",
     "HHCC",

custom_components/ble_monitor/manifest.json

@@ -14,5 +14,5 @@
     "btsocket>=0.2.0",
     "pyric>=0.1.6.3"
   ],
-  "version": "12.9.3"
+  "version": "12.10.0"
 }

custom_components/ble_monitor/sensor.py

@@ -337,6 +337,7 @@ class BaseSensor(RestoreSensor, SensorEntity):
     # |  |**flow
     # |  |**gas
     # |  |**water
+    # |  |**fresh/grey/black/lpg/galley/chemical tank
     # |--InstantUpdateSensor (Class)
     # |  |**consumable
     # |  |**heart rate

custom_components/ble_monitor/test/test_oras.py

@@ -19,3 +19,37 @@ def test_oras_faucet(self):
         assert sensor_msg["data"]
         assert sensor_msg["battery"] == 100
         assert sensor_msg["rssi"] == -52
+
+    def test_garnet_battery(self):
+        """Test Oras parser for Garnet 709BT battery sensor."""
+        data_string = "043E2102010000adb9a538c1a41502010611ff31010c464e0d31333230303030303030CC"
+        data = bytes(bytearray.fromhex(data_string))
+        # pylint: disable=unused-variable
+        ble_parser = BleParser()
+        sensor_msg, tracker_msg = ble_parser.parse_raw_data(data)
+
+        assert sensor_msg["firmware"] == "Garnet"
+        assert sensor_msg["type"] == "SeeLevel II 709-BTP3"
+        assert sensor_msg["mac"] == "A4C138A5B9AD"
+        assert sensor_msg["packet"] == "no packet id"
+        assert sensor_msg["data"]
+        assert sensor_msg["voltage"] == 13.2
+        assert sensor_msg["problem"] == 0
+        assert sensor_msg["rssi"] == -52
+
+    def test_garnet_black_tank(self):
+        """Test Oras parser for Garnet 709BT black tank sensor."""
+        data_string = "043E2102010000adb9a538c1a41502010611ff31010c464e0120373130303030303030CC"
+        data = bytes(bytearray.fromhex(data_string))
+        # pylint: disable=unused-variable
+        ble_parser = BleParser()
+        sensor_msg, tracker_msg = ble_parser.parse_raw_data(data)
+
+        assert sensor_msg["firmware"] == "Garnet"
+        assert sensor_msg["type"] == "SeeLevel II 709-BTP3"
+        assert sensor_msg["mac"] == "A4C138A5B9AD"
+        assert sensor_msg["packet"] == "no packet id"
+        assert sensor_msg["data"]
+        assert sensor_msg["black tank"] == 71
+        assert sensor_msg["problem"] == 0
+        assert sensor_msg["rssi"] == -52

docs/_devices/Garnet_SeeLevel_II_709-BTP3 .md

@@ -0,0 +1,21 @@
+---
+manufacturer: Garnet
+name: SeeLeveL II 709-BTP3 Tank Monitor
+model: SeeLevel II 709-BTP3
+image: Garnet_Seelevel_709-BTP3.png
+physical_description: Tank Monitor
+broadcasted_properties:
+  - tank
+  - temperature
+  - voltage
+  - rssi
+broadcasted_property_notes:
+  - property: tank
+    note: Level of the tank in percentage of the total volume
+broadcast_rate:
+active_scan:
+encryption_key: false
+custom_firmware:
+notes:
+    - The sensor also broadcasts volume and a total (per tank). These sensors are currently not implemented, as in tests these values stay 0 all the time. If you want to debug these sensors, you can make them visible by enabling debug logging. The values will be logged in the HA logs. Please report back here if these sensors actually report anything, such that we can implement them.
+---