Merge pull request #485 from custom-components/sensor_entity_description

Add SensorEntityDescription to BLE monitor

Author: Ernst79

custom_components/ble_monitor/__init__.py

@@ -139,7 +139,7 @@ def parse_data(self, data):
             adpayload_start += adstuct_size
 
         # check for monitored device trackers
-        if mac.lower() in self.tracker_whitelist:
+        if mac in self.tracker_whitelist:
             tracker_data = {
                 "is connected": True,
                 "mac": ''.join('{:02X}'.format(x) for x in mac),

custom_components/ble_monitor/binary_sensor.py

@@ -100,7 +100,7 @@ def parse_atc(self, data, source_mac, rssi):
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and atc_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and atc_mac not in self.sensor_whitelist:
         return None
 
     try:

custom_components/ble_monitor/ble_parser/__init__.py

@@ -43,7 +43,7 @@ def parse_brifit(self, data, source_mac, rssi):
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and brifit_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and brifit_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(brifit_mac))
         return None
 

custom_components/ble_monitor/ble_parser/atc.py

@@ -87,7 +87,7 @@ def parse_govee(self, data, source_mac, rssi):
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and govee_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and govee_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(govee_mac))
         return None
 

custom_components/ble_monitor/ble_parser/brifit.py

@@ -87,7 +87,7 @@ def parse_inode(self, data, source_mac, rssi):
     self.lpacket_ids[inode_mac] = packet_id
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and inode_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and inode_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(inode_mac))
         return None
 

custom_components/ble_monitor/ble_parser/govee.py

@@ -74,7 +74,7 @@ def parse_kegtron(self, data, source_mac, rssi):
             return None
 
         # check for MAC presence in sensor whitelist, if needed
-        if self.discovery is False and kegtron_mac.lower() not in self.sensor_whitelist:
+        if self.discovery is False and kegtron_mac not in self.sensor_whitelist:
             _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(kegtron_mac))
             return None
 

custom_components/ble_monitor/ble_parser/inode.py

@@ -99,7 +99,7 @@ def parse_miscale(self, data, source_mac, rssi):
             return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and miscale_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and miscale_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(miscale_mac))
         return None
 

custom_components/ble_monitor/ble_parser/kegtron.py

@@ -64,7 +64,7 @@ def parse_qingping(self, data, source_mac, rssi):
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and qingping_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and qingping_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(qingping_mac))
         return None
 

custom_components/ble_monitor/ble_parser/miscale.py

@@ -192,7 +192,7 @@ def parse_ruuvitag(self, data, source_mac, rssi):
             batt = 0
         result["battery"] = round(batt, 1)
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and ruuvitag_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and ruuvitag_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(ruuvitag_mac))
         return None
     if version < 5:

custom_components/ble_monitor/ble_parser/qingping.py

@@ -32,22 +32,23 @@
         "humidity"
     ]
 }
-    
+
+
 def decode_values(mfg_data: bytes, device_type_id: int) -> dict:
     pack_params = SENSORPUSH_PACK_PARAMS.get(device_type_id, None)
     if pack_params is None:
         _LOGGER.error("SensorPush device type id %d unknown" % device_type_id)
         return {}
-        
+
     values = {}
-    
+
     packed_values = 0
-    for i in range(1,len(mfg_data)):
-        packed_values += mfg_data[i] << (8 * (i-1))
-    
+    for i in range(1, len(mfg_data)):
+        packed_values += mfg_data[i] << (8 * (i - 1))
+
     mod = 1
     div = 1
-    for i in range(0,len(pack_params)):
+    for i in range(0, len(pack_params)):
         vp = pack_params[i]
         min_value = vp[0]
         max_value = vp[1]
@@ -60,15 +61,15 @@ def decode_values(mfg_data: bytes, device_type_id: int) -> dict:
             value = value / 100.0
         values[data_type] = value
         div *= int((max_value - min_value) / step + step / 2.0) + 1
-        
+
     return values
 
 
 def parse_sensorpush(self, data, source_mac, rssi):
     result = {"firmware": "SensorPush"}
     sensorpush_mac = source_mac
     device_type = None
-    
+
     # SensorPush puts encoded data in manufacturer data (0xFF)
     adpayload_start = 0
     adpayload_size = len(data)
@@ -97,7 +98,7 @@ def parse_sensorpush(self, data, source_mac, rssi):
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and sensorpush_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and sensorpush_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(sensorpush_mac))
         return None
 

custom_components/ble_monitor/ble_parser/ruuvitag.py

@@ -23,6 +23,10 @@ def parse_teltonika(self, data, source_mac, rssi):
                     device_type = "Blue Puck T"
                 elif dev_type == "PUCK_TH":
                     device_type = "Blue Puck RHT"
+                elif dev_type[0:3] == "C T":
+                    device_type = "Blue Coin T"
+                elif dev_type[0:3] == "P T":
+                    device_type = "Blue Puck T"
                 else:
                     device_type = None
             elif adstuct_type == 0x16 and adstuct_size > 4:
@@ -41,15 +45,16 @@ def parse_teltonika(self, data, source_mac, rssi):
     if device_type is None:
         if self.report_unknown == "Teltonika":
             _LOGGER.info(
-                "BLE ADV from UNKNOWN Teltonika DEVICE: RSSI: %s, MAC: %s, ADV: %s",
+                "BLE ADV from UNKNOWN Teltonika DEVICE: RSSI: %s, MAC: %s, DEVICE TYPE: %s, ADV: %s",
                 rssi,
                 to_mac(source_mac),
+                dev_type,
                 data.hex()
             )
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and teltonika_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and teltonika_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(teltonika_mac))
         return None
 

custom_components/ble_monitor/ble_parser/sensorpush.py

@@ -58,7 +58,7 @@ def parse_thermoplus(self, data, source_mac, rssi):
         return None
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and thermoplus_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and thermoplus_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(thermoplus_mac))
         return None
 

custom_components/ble_monitor/ble_parser/teltonika.py

@@ -4,6 +4,8 @@
 import struct
 from Cryptodome.Cipher import AES
 
+from homeassistant.util import datetime
+
 _LOGGER = logging.getLogger(__name__)
 
 # Device type dictionary
@@ -46,6 +48,8 @@
     0x04E6: "YLYK01YL-VENFAN",
     0x03BF: "YLYB01YL-BHFRC",
     0x03B6: "YLKG07YL/YLKG08YL",
+    0x069E: "ZNMS16LM",
+    0x069F: "ZNMS17LM",
 }
 
 # Structured objects for data conversions
@@ -61,17 +65,146 @@
 P_STRUCT = struct.Struct("<H")
 BUTTON_STRUCT = struct.Struct("<BBB")
 
+# Definition of lock messages
+BLE_LOCK_ERROR = {
+    0xC0DE0000: "frequent unlocking with incorrect password",
+    0xC0DE0001: "frequent unlocking with wrong fingerprints",
+    0xC0DE0002: "operation timeout (password input timeout)",
+    0xC0DE0003: "lock picking",
+    0xC0DE0004: "reset button is pressed",
+    0xC0DE0005: "the wrong key is frequently unlocked",
+    0xC0DE0006: "foreign body in the keyhole",
+    0xC0DE0007: "the key has not been taken out",
+    0xC0DE0008: "error NFC frequently unlocks",
+    0xC0DE0009: "timeout is not locked as required",
+    0xC0DE000A: "failure to unlock frequently in multiple ways",
+    0xC0DE000B: "unlocking the face frequently fails",
+    0xC0DE000C: "failure to unlock the vein frequently",
+    0xC0DE000D: "hijacking alarm",
+    0xC0DE000E: "unlock inside the door after arming",
+    0xC0DE000F: "palmprints frequently fail to unlock",
+    0xC0DE0010: "the safe was moved",
+    0xC0DE1000: "the battery level is less than 10%",
+    0xC0DE1001: "the battery is less than 5%",
+    0xC0DE1002: "the fingerprint sensor is abnormal",
+    0xC0DE1003: "the accessory battery is low",
+    0xC0DE1004: "mechanical failure",
+    0xC0DE1005: "the lock sensor is faulty",
+}
+
+BLE_LOCK_ACTION = {
+    0b0000: [0, "unlock outside the door"],
+    0b0001: [1, "lock"],
+    0b0010: [1, "turn on anti-lock"],
+    0b0011: [0, "turn off anti-lock"],
+    0b0100: [0, "unlock inside the door"],
+    0b0101: [1, "lock inside the door"],
+    0b0110: [1, "turn on child lock"],
+    0b0111: [0, "turn off child lock"],
+    0b1000: [1, "lock outside the door"],
+    0b1111: [0, "abnormal"],
+}
+
+BLE_LOCK_METHOD = {
+    0b0000: "bluetooth",
+    0b0001: "password",
+    0b0010: "biometrics",
+    0b0011: "key",
+    0b0100: "turntable",
+    0b0101: "nfc",
+    0b0110: "one-time password",
+    0b0111: "two-step verification",
+    0b1001: "Homekit",
+    0b1000: "coercion",
+    0b1010: "manual",
+    0b1011: "automatic",
+    0b1111: "abnormal"
+}
+
 
 # Advertisement conversion of measurement data
 # https://iot.mi.com/new/doc/embedded-development/ble/object-definition
 def obj0003(xobj):
     return {"motion": xobj[0], "motion timer": xobj[0]}
 
 
+def obj0006(xobj):
+    if len(xobj) == 5:
+        key_id = xobj[0:4]
+        match_byte = xobj[4]
+        if key_id == b'\x00\x00\x00\x00':
+            key_id = "administrator"
+        elif key_id == b'\xff\xff\xff\xff':
+            key_id = "unknown operator"
+        else:
+            key_id = int.from_bytes(key_id, 'little')
+        if match_byte == 0x00:
+            result = "match successful"
+        elif match_byte == 0x01:
+            result = "match failed"
+        elif match_byte == 0x02:
+            result = "timeout"
+        elif match_byte == 0x033:
+            result = "low quality (too light, fuzzy)"
+        elif match_byte == 0x04:
+            result = "insufficient area"
+        elif match_byte == 0x05:
+            result = "skin is too dry"
+        elif match_byte == 0x06:
+            result = "skin is too wet"
+        else:
+            result = None
+
+        fingerprint = 1 if match_byte == 0x00 else 0
+
+        return {
+            "fingerprint": fingerprint,
+            "result": result,
+            "key id": key_id,
+        }
+    else:
+        return {}
+
+
 def obj0010(xobj):
     return {"toothbrush mode": xobj[1]}
 
 
+def obj000b(xobj):
+    if len(xobj) == 9:
+        action = xobj[0] & 0x0F
+        method = xobj[0] >> 4
+        key_id = int.from_bytes(xobj[1:5], 'little')
+        timestamp = int.from_bytes(xobj[5:], 'little')
+
+        timestamp = datetime.fromtimestamp(timestamp).isoformat()
+
+        # all keys except Bluetooth have only 65536 values
+        error = BLE_LOCK_ERROR.get(key_id)
+        if error is None and method > 0:
+            key_id &= 0xFFFF
+        elif error:
+            key_id = hex(key_id)
+
+        if action not in BLE_LOCK_ACTION or method not in BLE_LOCK_METHOD:
+            return {}
+
+        lock = BLE_LOCK_ACTION[action][0]
+        action = BLE_LOCK_ACTION[action][1]
+        method = BLE_LOCK_METHOD[method]
+
+        return {
+            "lock": lock,
+            "action": action,
+            "method": method,
+            "error": error,
+            "key id": key_id,
+            "timestamp": timestamp,
+        }
+    else:
+        return {}
+
+
 def obj000f(xobj):
     if len(xobj) == 3:
         (value,) = LIGHT_STRUCT.unpack(xobj + b'\x00')
@@ -318,7 +451,23 @@ def obj1018(xobj):
 
 
 def obj1019(xobj):
-    return {"opening": xobj[0]}
+    open = xobj[0]
+    if open == 0:
+        opening = 1
+        status = "opened"
+    elif open == 1:
+        opening = 0
+        status = "closed"
+    elif open == 2:
+        opening = 1
+        status = "closing timeout"
+    elif open == 3:
+        opening = 1
+        status = "device reset"
+    else:
+        opening = 0
+        status = None
+    return {"opening": opening, "status": status}
 
 
 def obj100a(xobj):
@@ -354,7 +503,9 @@ def obj2000(xobj):
 # {dataObject_id: (converter}
 xiaomi_dataobject_dict = {
     0x0003: obj0003,
+    0x0006: obj0006,
     0x0010: obj0010,
+    0x000B: obj000b,
     0x000F: obj000f,
     0x1001: obj1001,
     0x1004: obj1004,
@@ -458,7 +609,7 @@ def parse_xiaomi(self, data, source_mac, rssi):
         sinfo += ', Standard certification'
 
     # check for MAC presence in sensor whitelist, if needed
-    if self.discovery is False and xiaomi_mac.lower() not in self.sensor_whitelist:
+    if self.discovery is False and xiaomi_mac not in self.sensor_whitelist:
         _LOGGER.debug("Discovery is disabled. MAC: %s is not whitelisted!", to_mac(xiaomi_mac))
         return None