Add holyiot

Author: Ernst79

custom_components/ble_monitor/ble_parser/__init__.py

@@ -16,6 +16,7 @@
 from .helpers import to_mac, to_unformatted_mac
 from .bthome import parse_bthome
 from .hhcc import parse_hhcc
+from .holyiot import parse_holyiot
 from .hormann import parse_hormann
 from .ibeacon import parse_ibeacon
 from .inkbird import parse_inkbird
@@ -207,6 +208,10 @@ def parse_advertisement(
                         # UUID16 = User Data and Bond Management (used by BTHome)
                         sensor_data = parse_bthome(self, service_data, uuid16, mac, rssi)
                         break
+                    elif uuid16 == 0x5242:
+                        # UUID16 = HolyIOT
+                        sensor_data = parse_holyiot(self, service_data, mac, rssi)
+                        break
                     elif uuid16 in [0xAA20, 0xAA21, 0xAA22] and local_name == "ECo":
                         # UUID16 = Relsib
                         sensor_data = parse_relsib(self, service_data, mac, rssi)

custom_components/ble_monitor/ble_parser/holyiot.py

@@ -0,0 +1,69 @@
+"""Parser for HolyIOT BLE advertisements"""
+import logging
+from struct import unpack
+
+from .helpers import (
+    to_mac,
+    to_unformatted_mac,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def parse_holyiot(self, data, source_mac, rssi):
+    """HolyIOT parser"""
+    msg_length = len(data)
+    firmware = "HolyIOT"
+    result = {"firmware": firmware}
+
+    if msg_length == 17:
+        device_type = "HolyIOT BLE tracker"
+        holyiot_mac = data[6:12]
+        if holyiot_mac != source_mac:
+            _LOGGER.debug(
+                "HolyIOT MAC address doesn't match data MAC address. Data: %s with source mac: %s and HolyIOT mac: %s",
+                data.hex(),
+                source_mac,
+                holyiot_mac,
+            )
+            return None
+        batt = data[5]
+        meas_type = data[14]
+        meas_value, = unpack(">H", data[15:17])
+
+        if meas_type == 4:
+            measurement_type = "vibration"
+        elif meas_type == 6:
+            measurement_type = "remote single press"
+        else:
+            return None
+        result.update(
+            {
+                measurement_type: meas_value,
+                "battery": batt
+            }
+        )
+    else:
+        if self.report_unknown == "HolyIOT":
+            _LOGGER.info(
+                "BLE ADV from UNKNOWN HolyIOT DEVICE: RSSI: %s, MAC: %s, ADV: %s",
+                rssi,
+                to_mac(source_mac),
+                data.hex()
+            )
+        return None
+
+    # check for MAC presence in sensor whitelist, if needed
+    if self.discovery is False and holyiot_mac.lower() not in self.sensor_whitelist:
+        _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(holyiot_mac))
+        return None
+
+    result.update({
+        "rssi": rssi,
+        "mac": to_unformatted_mac(holyiot_mac),
+        "type": device_type,
+        "packet": "no packet id",
+        "firmware": firmware,
+        "data": True
+    })
+    return result

custom_components/ble_monitor/const.py

@@ -304,6 +304,16 @@ class BLEMonitorBinarySensorEntityDescription(
         device_class=None,
         force_update=False,
     ),
+    BLEMonitorBinarySensorEntityDescription(
+        key="vibration",
+        sensor_class="BaseBinarySensor",
+        update_behavior="Instantly",
+        name="ble vibration",
+        unique_id="vi_",
+        icon="mdi:vibration",
+        device_class=BinarySensorDeviceClass.VIBRATION,
+        force_update=True,
+    ),
     BLEMonitorBinarySensorEntityDescription(
         key="dropping",
         sensor_class="BaseBinarySensor",
@@ -1290,6 +1300,7 @@ class BLEMonitorBinarySensorEntityDescription(
     'K6 Sensor Beacon'        : [["temperature", "humidity", "acceleration", "voltage", "battery", "rssi"], [], []],
     'DSL-C08'                 : [["battery", "rssi", "voltage"], [], ["lock", "childlock"]],
     'SmartDry cloth dryer'    : [["temperature", "humidity", "voltage", "battery", "shake", "rssi"], [], ["switch"]],
+    'HolyIOT BLE tracker'     : [["battery", "rssi"], [], ["remote single press", "vibration"]],
 }
 
 # Sensor manufacturer dictionary
@@ -1420,6 +1431,7 @@ class BLEMonitorBinarySensorEntityDescription(
     'Acconeer XM122'          : 'Acconeer',
     'K6 Sensor Beacon'        : 'KKM',
     'SmartDry cloth dryer'    : 'SmartDry',
+    'HolyIOT BLE tracker'     : 'HolyIOT',
 }
 
 

custom_components/ble_monitor/manifest.json

@@ -14,5 +14,5 @@
     "btsocket>=0.2.0",
     "pyric>=0.1.6.3"
   ],
-  "version": "12.0.0"
+  "version": "12.0.1-beta"
 }

custom_components/ble_monitor/test/test_holyiot.py

@@ -0,0 +1,22 @@
+"""The tests for the HolyIOT ble_parser."""
+from ble_monitor.ble_parser import BleParser
+
+
+class TestHolyIOT:
+    """Tests for the HolyIOT parser"""
+    def test_holyiot(self):
+        """Test HolyIOT parser for BLE tracker mini."""
+        data_string = "043e49020102018ef1f645b5c63d0201061AFF4C0002159976AED5F58C49AF85EBD0AC7281E3F6271B4CB9240D0962696E2D747261636B657200101642524164C6B545F6F18E0606060000CC"
+        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"] == "HolyIOT"
+        assert sensor_msg["type"] == "HolyIOT BLE tracker"
+        assert sensor_msg["mac"] == "C6B545F6F18E"
+        assert sensor_msg["packet"] == "no packet id"
+        assert sensor_msg["data"]
+        assert sensor_msg["battery"] == 100
+        assert not sensor_msg["remote single press"]
+        assert sensor_msg["rssi"] == -52