Merge pull request #1444 from custom-components/linp_es3

Add Linptech Human Presence Sensor ES3

Author: Ernst79

custom_components/ble_monitor/ble_parser/xiaomi.py

@@ -81,6 +81,7 @@
     0x3F4C: "PS1BB",
     0x3A61: "KS1",
     0x3E17: "KS1BP",
+    0x50FB: "ES3",
     0x5DB1: "MBS17"
 }
 
@@ -815,6 +816,34 @@ def obj4840(xobj):
     return {"pressure not present time set": duration}
 
 
+def obj484e(xobj):
+    """Occupancy Status"""
+    (occupancy,) = struct.unpack("<B", xobj)
+    if occupancy == 0:
+        # no motion is being taken care of by the timer in HA
+        return {}
+    else:
+        return {"motion": 1, "motion timer": 1}
+
+
+def obj484f(xobj):
+    """Time in minutes of no motion (not used, we use 484e)"""
+    if len(xobj) == 1:
+        (no_motion_time,) = struct.unpack("<B", xobj)
+        # minutes of no motion (not used, we use motion timer in obj4a08)
+        # 0 = motion detected
+        return {"motion": 1 if no_motion_time == 0 else 0, "no motion time": no_motion_time}
+    else:
+        return {}
+
+
+def obj4850(xobj):
+    """Time in minutes with motion (not used, we use 484e)"""
+    (motion_time,) = struct.unpack("<B", xobj)
+    # minutes with motion (not used, we use motion timer in obj484e)
+    return {"motion time": motion_time}
+
+
 def obj4a01(xobj):
     """Low Battery"""
     low_batt = xobj[0]
@@ -1270,6 +1299,9 @@ def obj5a16(xobj):
     0x483e: obj483e,
     0x483f: obj483f,
     0x4840: obj4840,
+    0x484e: obj484e,
+    0x484f: obj484f,
+    0x4850: obj4850,
     0x4a01: obj4a01,
     0x4a08: obj4a08,
     0x4a0c: obj4a0c,

custom_components/ble_monitor/const.py

@@ -2232,6 +2232,7 @@ class BLEMonitorBinarySensorEntityDescription(
     'MMC-W505'                : 'Xiaomi',
     'SJWS01LM'                : 'Xiaomi',
     'RS1BB'                   : 'Linptech',
+    'ES3'                     : 'Linptech',
 }
 
 

custom_components/ble_monitor/test/test_xiaomi_parser.py

@@ -931,6 +931,59 @@ def test_linptech_HS1BB_illuminance_motion(self):
         assert sensor_msg["illuminance"] == 228.0
         assert sensor_msg["rssi"] == -58
 
+    def test_linptech_ES3_illuminance(self):
+        """Test Xiaomi parser for linptech ES3."""
+        self.aeskeys = {}
+        data_string = "043E260201000176c3c738c1a41a020106161695fe4859fb50d986d27e8f5313e900000030ad6da8C6"
+        data = bytes(bytearray.fromhex(data_string))
+
+        aeskey = "b26295a7a08fbac306c8706ade7f0fe4"
+
+        is_ext_packet = True if data[3] == 0x0D else False
+        mac = (data[8 if is_ext_packet else 7:14 if is_ext_packet else 13])[::-1]
+        mac_address = mac.hex()
+        p_mac = bytes.fromhex(mac_address.replace(":", "").lower())
+        p_key = bytes.fromhex(aeskey.lower())
+        self.aeskeys[p_mac] = p_key
+        # pylint: disable=unused-variable
+        ble_parser = BleParser(aeskeys=self.aeskeys)
+        sensor_msg, tracker_msg = ble_parser.parse_raw_data(data)
+
+        assert sensor_msg["firmware"] == "Xiaomi (MiBeacon V5 encrypted)"
+        assert sensor_msg["type"] == "ES3"
+        assert sensor_msg["mac"] == "A4C138C7C376"
+        assert sensor_msg["packet"] == 217
+        assert sensor_msg["data"]
+        assert sensor_msg["illuminance"] == 173.0
+        assert sensor_msg["rssi"] == -58
+
+    def test_linptech_ES3_motion(self):
+        """Test Xiaomi parser for linptech ES3."""
+        self.aeskeys = {}
+        data_string = "043E290201000176c3c738c1a41D020106191695fe5859fb50da76c3c738c1a4aabc4c16000000c60c1646C6"
+        data = bytes(bytearray.fromhex(data_string))
+
+        aeskey = "b26295a7a08fbac306c8706ade7f0fe4"
+
+        is_ext_packet = True if data[3] == 0x0D else False
+        mac = (data[8 if is_ext_packet else 7:14 if is_ext_packet else 13])[::-1]
+        mac_address = mac.hex()
+        p_mac = bytes.fromhex(mac_address.replace(":", "").lower())
+        p_key = bytes.fromhex(aeskey.lower())
+        self.aeskeys[p_mac] = p_key
+        # pylint: disable=unused-variable
+        ble_parser = BleParser(aeskeys=self.aeskeys)
+        sensor_msg, tracker_msg = ble_parser.parse_raw_data(data)
+
+        assert sensor_msg["firmware"] == "Xiaomi (MiBeacon V5 encrypted)"
+        assert sensor_msg["type"] == "ES3"
+        assert sensor_msg["mac"] == "A4C138C7C376"
+        assert sensor_msg["packet"] == 218
+        assert sensor_msg["data"]
+        assert sensor_msg["motion"] == 1
+        assert sensor_msg["motion timer"] == 1
+        assert sensor_msg["rssi"] == -58
+
     def test_MJZNZ018H_bed_occupancy(self):
         """Test Xiaomi parser for MJZNZ018H bed occupancy sensor."""
         self.aeskeys = {}

docs/_devices/Linptech ES3.md

@@ -0,0 +1,23 @@
+---
+manufacturer: Linptech
+name: Linptech Human Presence Sensor
+model: ES3
+image: Linptech_ES3.png
+physical_description:
+broadcasted_properties:
+  - illuminance
+  - motion
+  - battery
+  - rssi
+broadcasted_property_notes:
+  - property: illuminance
+    note: is measured in lux.
+  - property: motion
+    note: Motion state is ‘motion detected’ or ‘clear’.
+broadcast_rate: See Notes
+active_scan:
+encryption_key: Yes
+custom_firmware:
+notes: >
+  - You can use the [reset_timer](configuration_params#reset_timer) option if you want to use a different time to set the sensor to `motion clear`.
+---