Add Locks to Xiaomi-BLE (#111156)

home-assistant · Mar 10, 2024 · e91a38e · e91a38e
1 parent e631224
commit e91a38e
Show file tree

Hide file tree

Showing 11 changed files with 451 additions and 16 deletions.
diff --git a/homeassistant/components/xiaomi_ble/binary_sensor.py b/homeassistant/components/xiaomi_ble/binary_sensor.py
@@ -42,6 +42,10 @@
         key=XiaomiBinarySensorDeviceClass.LIGHT,
         device_class=BinarySensorDeviceClass.LIGHT,
     ),
+    XiaomiBinarySensorDeviceClass.LOCK: BinarySensorEntityDescription(
+        key=XiaomiBinarySensorDeviceClass.LOCK,
+        device_class=BinarySensorDeviceClass.LOCK,
+    ),
     XiaomiBinarySensorDeviceClass.MOISTURE: BinarySensorEntityDescription(
         key=XiaomiBinarySensorDeviceClass.MOISTURE,
         device_class=BinarySensorDeviceClass.MOISTURE,
@@ -62,6 +66,16 @@
         key=XiaomiBinarySensorDeviceClass.SMOKE,
         device_class=BinarySensorDeviceClass.SMOKE,
     ),
+    ExtendedBinarySensorDeviceClass.ANTILOCK: BinarySensorEntityDescription(
+        key=ExtendedBinarySensorDeviceClass.ANTILOCK,
+    ),
+    ExtendedBinarySensorDeviceClass.ARMED: BinarySensorEntityDescription(
+        key=ExtendedBinarySensorDeviceClass.ARMED,
+        icon="mdi:shield-check",
+    ),
+    ExtendedBinarySensorDeviceClass.CHILDLOCK: BinarySensorEntityDescription(
+        key=ExtendedBinarySensorDeviceClass.CHILDLOCK,
+    ),
     ExtendedBinarySensorDeviceClass.DEVICE_FORCIBLY_REMOVED: BinarySensorEntityDescription(
         key=ExtendedBinarySensorDeviceClass.DEVICE_FORCIBLY_REMOVED,
         device_class=BinarySensorDeviceClass.PROBLEM,
@@ -74,6 +88,10 @@
         key=ExtendedBinarySensorDeviceClass.DOOR_STUCK,
         device_class=BinarySensorDeviceClass.PROBLEM,
     ),
+    ExtendedBinarySensorDeviceClass.FINGERPRINT: BinarySensorEntityDescription(
+        key=ExtendedBinarySensorDeviceClass.FINGERPRINT,
+        icon="mdi:fingerprint",
+    ),
     ExtendedBinarySensorDeviceClass.KNOCK_ON_THE_DOOR: BinarySensorEntityDescription(
         key=ExtendedBinarySensorDeviceClass.KNOCK_ON_THE_DOOR,
     ),

diff --git a/homeassistant/components/xiaomi_ble/const.py b/homeassistant/components/xiaomi_ble/const.py
@@ -20,13 +20,21 @@
 XIAOMI_BLE_EVENT: Final = "xiaomi_ble_event"
 
 EVENT_CLASS_BUTTON: Final = "button"
+EVENT_CLASS_CUBE: Final = "cube"
 EVENT_CLASS_DIMMER: Final = "dimmer"
+EVENT_CLASS_ERROR: Final = "error"
+EVENT_CLASS_FINGERPRINT: Final = "fingerprint"
+EVENT_CLASS_LOCK: Final = "lock"
 EVENT_CLASS_MOTION: Final = "motion"
-EVENT_CLASS_CUBE: Final = "cube"
 
 BUTTON: Final = "button"
 CUBE: Final = "cube"
 DIMMER: Final = "dimmer"
+ERROR: Final = "error"
+FINGERPRINT: Final = "fingerprint"
+LOCK: Final = "lock"
+LOCK_FINGERPRINT = "lock_fingerprint"
+MOTION_DEVICE: Final = "motion_device"
 DOUBLE_BUTTON: Final = "double_button"
 TRIPPLE_BUTTON: Final = "tripple_button"
 REMOTE: Final = "remote"
@@ -40,7 +48,6 @@
 BUTTON_PRESS_DOUBLE_LONG: Final = "button_press_double_long"
 DOUBLE_BUTTON_PRESS_DOUBLE_LONG: Final = "double_button_press_double_long"
 TRIPPLE_BUTTON_PRESS_DOUBLE_LONG: Final = "tripple_button_press_double_long"
-MOTION_DEVICE: Final = "motion_device"
 
 
 class XiaomiBleEvent(TypedDict):

diff --git a/homeassistant/components/xiaomi_ble/device_trigger.py b/homeassistant/components/xiaomi_ble/device_trigger.py
@@ -32,12 +32,19 @@
     DOMAIN,
     DOUBLE_BUTTON,
     DOUBLE_BUTTON_PRESS_DOUBLE_LONG,
+    ERROR,
     EVENT_CLASS,
     EVENT_CLASS_BUTTON,
     EVENT_CLASS_CUBE,
     EVENT_CLASS_DIMMER,
+    EVENT_CLASS_ERROR,
+    EVENT_CLASS_FINGERPRINT,
+    EVENT_CLASS_LOCK,
     EVENT_CLASS_MOTION,
     EVENT_TYPE,
+    FINGERPRINT,
+    LOCK,
+    LOCK_FINGERPRINT,
     MOTION,
     MOTION_DEVICE,
     REMOTE,
@@ -62,6 +69,51 @@
         "rotate_left_pressed",
         "rotate_right_pressed",
     ],
+    ERROR: [
+        "frequent_unlocking_with_incorrect_password",
+        "frequent_unlocking_with_wrong_fingerprints",
+        "operation_timeout_password_input_timeout",
+        "lock_picking",
+        "reset_button_is_pressed",
+        "the_wrong_key_is_frequently_unlocked",
+        "foreign_body_in_the_keyhole",
+        "the_key_has_not_been_taken_out",
+        "error_nfc_frequently_unlocks",
+        "timeout_is_not_locked_as_required",
+        "failure_to_unlock_frequently_in_multiple_ways",
+        "unlocking_the_face_frequently_fails",
+        "failure_to_unlock_the_vein_frequently",
+        "hijacking_alarm",
+        "unlock_inside_the_door_after_arming",
+        "palmprints_frequently_fail_to_unlock",
+        "the_safe_was_moved",
+        "the_battery_level_is_less_than_10_percent",
+        "the_battery_level_is_less_than_5_percent",
+        "the_fingerprint_sensor_is_abnormal",
+        "the_accessory_battery_is_low",
+        "mechanical_failure",
+        "the_lock_sensor_is_faulty",
+    ],
+    FINGERPRINT: [
+        "match_successful",
+        "match_failed",
+        "low_quality_too_light_fuzzy",
+        "insufficient_area",
+        "skin_is_too_dry",
+        "skin_is_too_wet",
+    ],
+    LOCK: [
+        "lock_outside_the_door",
+        "unlock_outside_the_door",
+        "lock_inside_the_door",
+        "unlock_inside_the_door",
+        "locked",
+        "turn_on_antilock",
+        "release_the_antilock",
+        "turn_on_child_lock",
+        "turn_off_child_lock",
+        "abnormal",
+    ],
     MOTION_DEVICE: ["motion_detected"],
 }
 
@@ -71,6 +123,10 @@
     DIMMER: ["dimmer"],
     DOUBLE_BUTTON: ["button_left", "button_right"],
     TRIPPLE_BUTTON: ["button_left", "button_middle", "button_right"],
+    ERROR: ["error"],
+    FINGERPRINT: ["fingerprint"],
+    LOCK: ["lock"],
+    MOTION: ["motion"],
     REMOTE: [
         "button_on",
         "button_off",
@@ -106,7 +162,6 @@
         "button_increase_wind_speed",
         "button_decrease_wind_speed",
     ],
-    MOTION: ["motion"],
 }
 
 
@@ -150,6 +205,26 @@ class TriggerModelData:
         event_types=EVENT_TYPES[TRIPPLE_BUTTON],
         triggers=TRIGGERS_BY_TYPE[BUTTON_PRESS_DOUBLE_LONG],
     ),
+    ERROR: TriggerModelData(
+        event_class=EVENT_CLASS_ERROR,
+        event_types=EVENT_TYPES[ERROR],
+        triggers=TRIGGERS_BY_TYPE[ERROR],
+    ),
+    LOCK_FINGERPRINT: TriggerModelData(
+        event_class=EVENT_CLASS_FINGERPRINT,
+        event_types=EVENT_TYPES[LOCK] + EVENT_TYPES[FINGERPRINT],
+        triggers=TRIGGERS_BY_TYPE[LOCK] + TRIGGERS_BY_TYPE[FINGERPRINT],
+    ),
+    LOCK: TriggerModelData(
+        event_class=EVENT_CLASS_LOCK,
+        event_types=EVENT_TYPES[LOCK],
+        triggers=TRIGGERS_BY_TYPE[LOCK],
+    ),
+    MOTION_DEVICE: TriggerModelData(
+        event_class=EVENT_CLASS_MOTION,
+        event_types=EVENT_TYPES[MOTION],
+        triggers=TRIGGERS_BY_TYPE[MOTION_DEVICE],
+    ),
     REMOTE: TriggerModelData(
         event_class=EVENT_CLASS_BUTTON,
         event_types=EVENT_TYPES[REMOTE],
@@ -170,11 +245,6 @@ class TriggerModelData:
         event_types=EVENT_TYPES[REMOTE_VENFAN],
         triggers=TRIGGERS_BY_TYPE[BUTTON_PRESS_LONG],
     ),
-    MOTION_DEVICE: TriggerModelData(
-        event_class=EVENT_CLASS_MOTION,
-        event_types=EVENT_TYPES[MOTION],
-        triggers=TRIGGERS_BY_TYPE[MOTION_DEVICE],
-    ),
 }
 
 
@@ -197,6 +267,13 @@ class TriggerModelData:
     "MUE4094RT": TRIGGER_MODEL_DATA[MOTION_DEVICE],
     "XMMF01JQD": TRIGGER_MODEL_DATA[CUBE],
     "YLKG07YL/YLKG08YL": TRIGGER_MODEL_DATA[DIMMER],
+    "DSL-C08": TRIGGER_MODEL_DATA[LOCK],
+    "XMZNMS08LM": TRIGGER_MODEL_DATA[LOCK],
+    "Lockin-SV40": TRIGGER_MODEL_DATA[LOCK_FINGERPRINT],
+    "MJZNMSQ01YD": TRIGGER_MODEL_DATA[LOCK_FINGERPRINT],
+    "XMZNMS04LM": TRIGGER_MODEL_DATA[LOCK_FINGERPRINT],
+    "ZNMS16LM": TRIGGER_MODEL_DATA[LOCK_FINGERPRINT],
+    "ZNMS17LM": TRIGGER_MODEL_DATA[LOCK_FINGERPRINT],
 }
 
 

diff --git a/homeassistant/components/xiaomi_ble/event.py b/homeassistant/components/xiaomi_ble/event.py
@@ -21,6 +21,9 @@
     EVENT_CLASS_BUTTON,
     EVENT_CLASS_CUBE,
     EVENT_CLASS_DIMMER,
+    EVENT_CLASS_ERROR,
+    EVENT_CLASS_FINGERPRINT,
+    EVENT_CLASS_LOCK,
     EVENT_CLASS_MOTION,
     EVENT_PROPERTIES,
     EVENT_TYPE,
@@ -59,6 +62,63 @@
             "rotate_right_pressed",
         ],
     ),
+    EVENT_CLASS_ERROR: EventEntityDescription(
+        key=EVENT_CLASS_ERROR,
+        translation_key="error",
+        event_types=[
+            "frequent_unlocking_with_incorrect_password",
+            "frequent_unlocking_with_wrong_fingerprints",
+            "operation_timeout_password_input_timeout",
+            "lock_picking",
+            "reset_button_is_pressed",
+            "the_wrong_key_is_frequently_unlocked",
+            "foreign_body_in_the_keyhole",
+            "the_key_has_not_been_taken_out",
+            "error_nfc_frequently_unlocks",
+            "timeout_is_not_locked_as_required",
+            "failure_to_unlock_frequently_in_multiple_ways",
+            "unlocking_the_face_frequently_fails",
+            "failure_to_unlock_the_vein_frequently",
+            "hijacking_alarm",
+            "unlock_inside_the_door_after_arming",
+            "palmprints_frequently_fail_to_unlock",
+            "the_safe_was_moved",
+            "the_battery_level_is_less_than_10_percent",
+            "the_battery_is_less_than_5_percent",
+            "the_fingerprint_sensor_is_abnormal",
+            "the_accessory_battery_is_low",
+            "mechanical_failure",
+            "the_lock_sensor_is_faulty",
+        ],
+    ),
+    EVENT_CLASS_FINGERPRINT: EventEntityDescription(
+        key=EVENT_CLASS_FINGERPRINT,
+        translation_key="fingerprint",
+        event_types=[
+            "match_successful",
+            "match_failed",
+            "low_quality_too_light_fuzzy",
+            "insufficient_area",
+            "skin_is_too_dry",
+            "skin_is_too_wet",
+        ],
+    ),
+    EVENT_CLASS_LOCK: EventEntityDescription(
+        key=EVENT_CLASS_LOCK,
+        translation_key="lock",
+        event_types=[
+            "lock_outside_the_door",
+            "unlock_outside_the_door",
+            "lock_inside_the_door",
+            "unlock_inside_the_door",
+            "locked",
+            "turn_on_antilock",
+            "release_the_antilock",
+            "turn_on_child_lock",
+            "turn_off_child_lock",
+            "abnormal",
+        ],
+    ),
     EVENT_CLASS_MOTION: EventEntityDescription(
         key=EVENT_CLASS_MOTION,
         translation_key="motion",

diff --git a/homeassistant/components/xiaomi_ble/manifest.json b/homeassistant/components/xiaomi_ble/manifest.json
@@ -24,5 +24,5 @@
   "dependencies": ["bluetooth_adapters"],
   "documentation": "https://www.home-assistant.io/integrations/xiaomi_ble",
   "iot_class": "local_push",
-  "requirements": ["xiaomi-ble==0.25.2"]
+  "requirements": ["xiaomi-ble==0.26.1"]
 }
diff --git a/homeassistant/components/xiaomi_ble/sensor.py b/homeassistant/components/xiaomi_ble/sensor.py
@@ -132,23 +132,31 @@
         state_class=SensorStateClass.MEASUREMENT,
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
-    # Used for e.g. consumable sensor on WX08ZM and M1S-T500
+    # E.g. consumable sensor on WX08ZM and M1S-T500
     (ExtendedSensorDeviceClass.CONSUMABLE, Units.PERCENTAGE): SensorEntityDescription(
         key=str(ExtendedSensorDeviceClass.CONSUMABLE),
         native_unit_of_measurement=PERCENTAGE,
         state_class=SensorStateClass.MEASUREMENT,
     ),
-    # Used for score after brushing with a toothbrush
+    # Score after brushing with a toothbrush
     (ExtendedSensorDeviceClass.SCORE, None): SensorEntityDescription(
         key=str(ExtendedSensorDeviceClass.SCORE),
         state_class=SensorStateClass.MEASUREMENT,
     ),
-    # Used for counting during brushing
+    # Counting during brushing
     (ExtendedSensorDeviceClass.COUNTER, Units.TIME_SECONDS): SensorEntityDescription(
         key=str(ExtendedSensorDeviceClass.COUNTER),
         native_unit_of_measurement=UnitOfTime.SECONDS,
         state_class=SensorStateClass.MEASUREMENT,
     ),
+    # Key id for locks and fingerprint readers
+    (ExtendedSensorDeviceClass.KEY_ID, None): SensorEntityDescription(
+        key=str(ExtendedSensorDeviceClass.KEY_ID), icon="mdi:identifier"
+    ),
+    # Lock method for locks
+    (ExtendedSensorDeviceClass.LOCK_METHOD, None): SensorEntityDescription(
+        key=str(ExtendedSensorDeviceClass.LOCK_METHOD), icon="mdi:key-variant"
+    ),
 }