uiprotect 6.4.0__tar.gz → 6.6.0__tar.gz

{uiprotect-6.4.0 → uiprotect-6.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 6.4.0
+Version: 6.6.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 Author: UI Protect Maintainers

{uiprotect-6.4.0 → uiprotect-6.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiprotect"
-version = "6.4.0"
+version = "6.6.0"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = ["UI Protect Maintainers <ui@koston.org>"]
 readme = "README.md"
@@ -50,7 +50,7 @@ propcache = ">=0.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7,<9"
-pytest-cov = ">=3,<6"
+pytest-cov = ">=3,<7"
 aiosqlite = ">=0.20.0"
 asttokens = "^2.4.1"
 pytest-asyncio = ">=0.23.7,<0.25.0"
@@ -76,7 +76,7 @@ mkdocs-material-extensions = "^1.3.1"
 pymdown-extensions = "^10.8.1"
 mkdocs-git-revision-date-localized-plugin = "^1.2.6"
 mkdocs-include-markdown-plugin = "^6.1.1"
-mkdocstrings = ">=0.25.1,<0.27.0"
+mkdocstrings = ">=0.25.1,<0.28.0"
 mkdocstrings-python = "^1.10.3"
 
 [tool.semantic_release]

{uiprotect-6.4.0 → uiprotect-6.6.0}/src/uiprotect/data/bootstrap.py

@@ -98,6 +98,14 @@ CAMERA_EVENT_ATTR_MAP: dict[EventType, tuple[str, str]] = {
         "last_smart_audio_detect_event_id",
     ),
     EventType.RING: ("last_ring", "last_ring_event_id"),
+    EventType.NFC_CARD_SCANNED: (
+        "last_nfc_card_scanned",
+        "last_nfc_card_scanned_event_id",
+    ),
+    EventType.FINGERPRINT_IDENTIFIED: (
+        "last_fingerprint_identified",
+        "last_fingerprint_identified_event_id",
+    ),
 }
 
 

{uiprotect-6.4.0 → uiprotect-6.6.0}/src/uiprotect/data/devices.py

@@ -859,6 +859,9 @@ class CameraFeatureFlags(ProtectBaseObject):
     has_vertical_flip: bool | None = None
     # 3.0.22+
     flash_range: Any | None = None
+    # 4.73.71+
+    support_nfc: bool | None = None
+    has_fingerprint_sensor: bool | None = None
 
     focus: PTZRange
     pan: PTZRange
@@ -998,6 +1001,10 @@ class Camera(ProtectMotionDeviceModel):
 
     # not directly from UniFi
     last_ring_event_id: str | None = None
+    last_nfc_card_scanned_event_id: str | None = None
+    last_nfc_card_scanned: datetime | None = None
+    last_fingerprint_identified_event_id: str | None = None
+    last_fingerprint_identified: datetime | None = None
     last_smart_detect: datetime | None = None
     last_smart_audio_detect: datetime | None = None
     last_smart_detect_event_id: str | None = None
@@ -1018,6 +1025,10 @@ class Camera(ProtectMotionDeviceModel):
     def _get_excluded_changed_fields(cls) -> set[str]:
         return super()._get_excluded_changed_fields() | {
             "last_ring_event_id",
+            "last_nfc_card_scanned",
+            "last_nfc_card_scanned_event_id",
+            "last_fingerprint_identified",
+            "last_fingerprint_identified_event_id",
             "last_smart_detect",
             "last_smart_audio_detect",
             "last_smart_detect_event_id",
@@ -1086,6 +1097,10 @@ class Camera(ProtectMotionDeviceModel):
         pop_dict_tuple(
             data,
             (
+                "lastFingerprintIdentified",
+                "lastFingerprintIdentifiedEventId",
+                "lastNfcCardScanned",
+                "lastNfcCardScannedEventId",
                 "lastRingEventId",
                 "lastSmartDetect",
                 "lastSmartAudioDetect",
@@ -1148,6 +1163,23 @@ class Camera(ProtectMotionDeviceModel):
             return None
         return self._api.bootstrap.events.get(last_smart_detect_event_id)
 
+    @property
+    def last_nfc_card_scanned_event(self) -> Event | None:
+        if (
+            last_nfc_card_scanned_event_id := self.last_nfc_card_scanned_event_id
+        ) is None:
+            return None
+        return self._api.bootstrap.events.get(last_nfc_card_scanned_event_id)
+
+    @property
+    def last_fingerprint_identified_event(self) -> Event | None:
+        if (
+            last_fingerprint_identified_event_id
+            := self.last_fingerprint_identified_event_id
+        ) is None:
+            return None
+        return self._api.bootstrap.events.get(last_fingerprint_identified_event_id)
+
     @property
     def hdr_mode_display(self) -> Literal["auto", "off", "always"]:
         """Get HDR mode similar to how Protect interface works."""

{uiprotect-6.4.0 → uiprotect-6.6.0}/src/uiprotect/data/nvr.py

@@ -136,6 +136,32 @@ class EventThumbnailAttribute(ProtectBaseObject):
     val: str
 
 
+class NfcMetadata(ProtectBaseObject):
+    nfc_id: str
+    user_id: str
+
+    @classmethod
+    @cache
+    def _get_unifi_remaps(cls) -> dict[str, str]:
+        return {
+            **super()._get_unifi_remaps(),
+            "nfcId": "nfc_id",
+            "userId": "user_id",
+        }
+
+
+class FingerprintMetadata(ProtectBaseObject):
+    ulp_id: str | None = None
+
+    @classmethod
+    @cache
+    def _get_unifi_remaps(cls) -> dict[str, str]:
+        return {
+            **super()._get_unifi_remaps(),
+            "ulpId": "ulp_id",
+        }
+
+
 class EventThumbnailAttributes(ProtectBaseObject):
     color: EventThumbnailAttribute | None = None
     vehicle_type: EventThumbnailAttribute | None = None
@@ -195,6 +221,9 @@ class EventMetadata(ProtectBaseObject):
     license_plate: LicensePlateMetadata | None = None
     # requires 2.11.13+
     detected_thumbnails: list[EventDetectedThumbnail] | None = None
+    # requires 5.1.34+
+    nfc: NfcMetadata | None = None
+    fingerprint: FingerprintMetadata | None = None
 
     _collapse_keys: ClassVar[SetStr] = {
         "lightId",

{uiprotect-6.4.0 → uiprotect-6.6.0}/src/uiprotect/data/types.py

@@ -201,6 +201,8 @@ class EventType(str, ValuesEnumMixin, enum.Enum):
     POOR_CONNECTION = "poorConnection"
     STREAM_RECOVERY = "streamRecovery"
     MOTION = "motion"
+    NFC_CARD_SCANNED = "nfcCardScanned"
+    FINGERPRINT_IDENTIFIED = "fingerprintIdentified"
     RECORDING_DELETED = "recordingDeleted"
     SMART_AUDIO_DETECT = "smartAudioDetect"
     SMART_DETECT = "smartDetectZone"
@@ -274,6 +276,8 @@ class EventType(str, ValuesEnumMixin, enum.Enum):
     def device_events() -> list[str]:
         return [
             EventType.MOTION.value,
+            EventType.NFC_CARD_SCANNED.value,
+            EventType.FINGERPRINT_IDENTIFIED.value,
             EventType.RING.value,
             EventType.SMART_DETECT.value,
             EventType.SMART_AUDIO_DETECT.value,

{uiprotect-6.4.0 → uiprotect-6.6.0}/src/uiprotect/websocket.py

@@ -10,6 +10,7 @@ from enum import Enum
 from http import HTTPStatus
 from typing import Any, Optional
 
+import aiohttp
 from aiohttp import (
     ClientError,
     ClientSession,
@@ -125,7 +126,10 @@ class Websocket:
         # catch any and all errors for Websocket so we can clean up correctly
         try:
             self._ws_connection = await session.ws_connect(
-                url, ssl=self.verify, headers=self._headers, timeout=self.timeout
+                url,
+                ssl=self.verify,
+                headers=self._headers,
+                timeout=aiohttp.ClientWSTimeout(ws_close=self.timeout),
             )
             while True:
                 msg = await self._ws_connection.receive(self.receive_timeout)