Merge pull request #1489 from custom-components/XMOSB01XS

Add Xiaomi Human Presence Occupancy Sensor XMOSB01XS

Author: Ernst79

custom_components/ble_monitor/ble_parser/xiaomi.py

@@ -53,6 +53,7 @@
  0x045C: "V-SK152",
  0x040A: "WX08ZM",
  0x04E1: "XMMF01JQD",
+ 0x4683: "XMOSB01XS",
  0x1203: "XMWSDJ04MMC",
  0x1949: "XMWXKG01YL",
  0x2387: "XMWXKG01LM",
@@ -820,15 +821,19 @@ def obj4840(xobj):
 def obj484e(xobj, device_type=None):
  """Occupancy Status"""
  (occupancy,) = struct.unpack("<B", xobj)
- if occupancy == 0:
- # For ES3: if this is the only data object (no motion/illuminance), treat as motion clear
- # For other devices: no motion is being taken care of by the timer in HA
- if device_type == "ES3":
- return {"motion": 0}
+ # For ES3 and XMOSB01XS: This sensor is being treated as an occupancy sensor
+ if device_type in ["ES3", "XMOSB01XS"]:
+ if occupancy == 0:
+ return {"occupancy": 0}
  else:
- return {}
+ return {"occupancy": 1}
  else:
- return {"motion": 1, "motion timer": 1}
+ # For other devices: This sensor is being treated as a motion sensor and will be using the timer in
+ # of ble_monitor to set "no motion" state
+ if occupancy == 0:
+ return {}
+ else:
+ return {"motion": 1, "motion timer": 1}
 
 
 def obj484f(xobj):
@@ -849,6 +854,18 @@ def obj4850(xobj):
  return {"motion time": motion_time}
 
 
+def obj4851(xobj):
+ """From miot-spec: has-someone-duration: uint8: 2 - 2 minutes, 5 - 5 minutes (not used)"""
+ (duration,) = struct.unpack("<I", xobj)
+ return {"duration occupancy detected": duration}
+
+
+def obj4852(xobj):
+ """From miot-spec: no-one-duration: uint8: 2/5/10/30 - 2/5/10/30 minutes (not used)"""
+ (duration,) = struct.unpack("<I", xobj)
+ return {"duration no occupancy detected": duration}
+
+
 def obj4a01(xobj):
  """Low Battery"""
  low_batt = xobj[0]
@@ -1332,6 +1349,8 @@ def obj6e16(xobj):
  0x484e: obj484e,
  0x484f: obj484f,
  0x4850: obj4850,
+ 0x4851: obj4851,
+ 0x4852: obj4852,
  0x4a01: obj4a01,
  0x4a08: obj4a08,
  0x4a0c: obj4a0c,

custom_components/ble_monitor/const.py

@@ -2324,14 +2324,14 @@ class BLEMonitorBinarySensorEntityDescription(
  'CQ60' : 'Chef iQ',
  'SeeLevel II 709-BTP3' : 'Garnet Instruments Ltd',
  'MI401' : 'Grundfos',
- 'Genisys75xx': 'Beckett',
- 'GenisysOil': 'Beckett',
- 'Iot7653': 'Beckett',
- 'Genisys7505': 'Beckett',
- 'LegacyGenisys': 'Beckett',
- 'Iot7652': 'Beckett',
- 'BeckettLinkPro': 'Beckett',
- 'GenisysGas': 'Beckett',
+ 'Genisys75xx' : 'Beckett',
+ 'GenisysOil' : 'Beckett',
+ 'Iot7653' : 'Beckett',
+ 'Genisys7505' : 'Beckett',
+ 'LegacyGenisys' : 'Beckett',
+ 'Iot7652' : 'Beckett',
+ 'BeckettLinkPro' : 'Beckett',
+ 'GenisysGas' : 'Beckett',
  'HHCCJCY10' : 'HHCC',
  'HolyIOT BLE tracker' : 'HolyIOT',
  'JTYJGD03MI' : 'Honeywell',
@@ -2364,6 +2364,7 @@ class BLEMonitorBinarySensorEntityDescription(
  'MJWSD06MMC' : 'Xiaomi',
  'MMC-W505' : 'Xiaomi',
  'SJWS01LM' : 'Xiaomi',
+ 'XMOSB01XS' : 'Xiaomi',
  'RS1BB' : 'Linptech',
  'ES3' : 'Linptech',
 }

custom_components/ble_monitor/manifest.json

@@ -14,5 +14,5 @@
  "btsocket>=0.3.0",
  "pyric>=0.1.6.3"
  ],
- "version": "13.7.1"
+ "version": "13.8.0"
 }

custom_components/ble_monitor/test/test_xiaomi_parser.py

@@ -957,7 +957,7 @@ def test_linptech_ES3_illuminance(self):
  assert sensor_msg["illuminance"] == 173.0
  assert sensor_msg["rssi"] == -58
 
- def test_linptech_ES3_motion(self):
+ def test_linptech_ES3_occupancy(self):
  """Test Xiaomi parser for linptech ES3."""
  self.aeskeys = {}
  data_string = "043E290201000176c3c738c1a41D020106191695fe5859fb50da76c3c738c1a4aabc4c16000000c60c1646C6"
@@ -980,12 +980,11 @@ def test_linptech_ES3_motion(self):
  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["occupancy"] == 1
  assert sensor_msg["rssi"] == -58
 
  def test_linptech_ES3_data_only_motion_clear(self):
- """Test Xiaomi parser for linptech ES3 data-only frame (implicit motion clear)."""
+ """Test Xiaomi parser for linptech ES3 data-only frame."""
  self.aeskeys = {}
  # This is a real data-only frame for ES3 with MAC A4:C1:38:A4:88:8A
  data_string = "043e29020100018a88a438c1a41d020106191695fe5859fb50328a88a438c1a4458a85b796000048fe13bac6"
@@ -1008,7 +1007,7 @@ def test_linptech_ES3_data_only_motion_clear(self):
  assert sensor_msg["mac"] == "A4C138A4888A"
  assert sensor_msg["packet"] == 50
  assert sensor_msg["data"]
- assert sensor_msg["motion"] == 0 # Should be implicitly set to 0 for data-only frames
+ assert sensor_msg["occupancy"] == 0 # Should be implicitly set to 0 for data-only frames
  assert sensor_msg["rssi"] == -58
 
  def test_MJZNZ018H_bed_occupancy(self):

docs/_devices/Linptech ES3.md

@@ -6,18 +6,15 @@ image: Linptech_ES3.png
 physical_description:
 broadcasted_properties:
  - illuminance
- - motion
+ - occupancy
  - 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`.
+notes:
 ---

docs/_devices/Xiaomi_XMOSB01XS.md

@@ -0,0 +1,20 @@
+---
+manufacturer: Xiaomi
+name: Xiaomi Mijia Human Body Occupancy Sensor
+model: XMOSB01XS
+image: Xiaomi_XMOSB01XS.png
+physical_description:
+broadcasted_properties:
+ - illuminance
+ - occupancy
+ - battery
+ - rssi
+broadcasted_property_notes:
+ - property: illuminance
+ note: is measured in lux.
+broadcast_rate: See Notes
+active_scan:
+encryption_key: Yes
+custom_firmware:
+notes:
+---