uiprotect 1.12.0__py3-none-any.whl → 1.13.0__py3-none-any.whl

uiprotect/api.py

@@ -228,6 +228,7 @@ class BaseApiClient:
 
     @property
     def ws_url(self) -> str:
+        """Get Websocket URL."""
         url = f"wss://{self._host}"
         if self._port != 443:
             url += f":{self._port}"
@@ -267,7 +268,7 @@ class BaseApiClient:
 
         if self._websocket is None:
             self._websocket = Websocket(
-                self.ws_url,
+                self.get_websocket_url,
                 _auth,
                 verify=self._verify_ssl,
                 timeout=self._ws_timeout,
@@ -626,9 +627,6 @@ class BaseApiClient:
             self._websocket = None
 
         websocket = await self.get_websocket()
-        # important to make sure WS URL is always current
-        websocket.url = self.ws_url
-
         if not websocket.is_connected:
             self._last_ws_status = False
             with contextlib.suppress(
@@ -638,6 +636,10 @@ class BaseApiClient:
             ):
                 await websocket.connect()
 
+    def get_websocket_url(self) -> str:
+        """Get Websocket URL."""
+        return self.ws_url
+
     async def async_disconnect_ws(self) -> None:
         """Disconnect from Websocket."""
         if self._websocket is None:
@@ -861,10 +863,6 @@ class ProtectApiClient(BaseApiClient):
             models=self._subscribed_models,
             ignore_stats=self._ignore_stats,
         )
-        # update websocket URL after every message to ensure the latest last_update_id
-        if self._websocket is not None:
-            self._websocket.url = self.ws_url
-
         if processed_message is None:
             return
 

uiprotect/data/base.py

@@ -61,6 +61,9 @@ RECENT_EVENT_MAX = timedelta(seconds=30)
 EVENT_PING_INTERVAL = timedelta(seconds=3)
 EVENT_PING_INTERVAL_SECONDS = EVENT_PING_INTERVAL.total_seconds()
 
+_EMPTY_EVENT_PING_BACK: dict[Any, Any] = {}
+
+
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -788,7 +791,7 @@ class ProtectModelWithId(ProtectModel):
 
     def _emit_message(self, updated: dict[str, Any]) -> None:
         """Emits fake WS message for ProtectApiClient to process."""
-        if updated == {}:
+        if _is_ping_back := updated is _EMPTY_EVENT_PING_BACK:
             _LOGGER.debug("Event ping callback started for %s", self.id)
 
         if self.model is None:
@@ -817,7 +820,9 @@ class ProtectModelWithId(ProtectModel):
 
         message = self._api.bootstrap.process_ws_packet(
             WSPacket(action_frame.packed + data_frame.packed),
+            is_ping_back=_is_ping_back,
         )
+
         if message is not None:
             self._api.emit_message(message)
 
@@ -876,7 +881,7 @@ class ProtectDeviceModel(ProtectModelWithId):
         self._callback_ping = loop.call_later(
             EVENT_PING_INTERVAL_SECONDS,
             self._emit_message,
-            {},
+            _EMPTY_EVENT_PING_BACK,
         )
 
     async def set_name(self, name: str | None) -> None:

uiprotect/data/bootstrap.py

@@ -451,7 +451,15 @@ class Bootstrap(ProtectBaseObject):
         action: dict[str, Any],
         data: dict[str, Any],
         ignore_stats: bool,
+        is_ping_back: bool,
     ) -> WSSubscriptionMessage | None:
+        """
+        Process a device update packet.
+
+        If is_ping_back is True, the packet is an empty packet
+        that was generated internally as a result of an event
+        that will expire and result in a state change.
+        """
         remove_keys = (
             STATS_AND_IGNORE_DEVICE_KEYS if ignore_stats else IGNORE_DEVICE_KEYS
         )
@@ -462,7 +470,7 @@ class Bootstrap(ProtectBaseObject):
         if model_type is ModelType.CAMERA and "lastMotion" in data:
             del data["lastMotion"]
         # nothing left to process
-        if not data:
+        if not data and not is_ping_back:
             self._create_stat(packet, None, True)
             return None
 
@@ -476,6 +484,12 @@ class Bootstrap(ProtectBaseObject):
 
         obj = devices[action_id]
         data = obj.unifi_dict_to_dict(data)
+
+        if not data and not is_ping_back:
+            # nothing left to process
+            self._create_stat(packet, None, True)
+            return None
+
         old_obj = obj.copy()
         obj = obj.update_from_dict(deepcopy(data))
 
@@ -513,6 +527,7 @@ class Bootstrap(ProtectBaseObject):
         packet: WSPacket,
         models: set[ModelType] | None = None,
         ignore_stats: bool = False,
+        is_ping_back: bool = False,
     ) -> WSSubscriptionMessage | None:
         """Process a WS packet."""
         action = packet.action_frame.data
@@ -521,17 +536,16 @@ class Bootstrap(ProtectBaseObject):
             action = deepcopy(action)
             data = deepcopy(data)
 
-        new_update_id: str = action["newUpdateId"]
+        new_update_id: str | None = action["newUpdateId"]
         if new_update_id is not None:
             self.last_update_id = new_update_id
 
         model_key: str = action["modelKey"]
-        if model_key not in ModelType.values_set():
+        if (model_type := ModelType.from_string(model_key)) is ModelType.UNKNOWN:
             _LOGGER.debug("Unknown model type: %s", model_key)
             self._create_stat(packet, None, True)
             return None
 
-        model_type = ModelType.from_string(model_key)
         if models and model_type not in models:
             self._create_stat(packet, None, True)
             return None
@@ -540,7 +554,7 @@ class Bootstrap(ProtectBaseObject):
         if action_action == "remove":
             return self._process_remove_packet(model_type, packet)
 
-        if not data:
+        if not data and not is_ping_back:
             self._create_stat(packet, None, True)
             return None
 
@@ -552,11 +566,7 @@ class Bootstrap(ProtectBaseObject):
                     return self._process_nvr_update(packet, data, ignore_stats)
                 if model_type in ModelType.bootstrap_models_types_and_event_set:
                     return self._process_device_update(
-                        model_type,
-                        packet,
-                        action,
-                        data,
-                        ignore_stats,
+                        model_type, packet, action, data, ignore_stats, is_ping_back
                     )
         except (ValidationError, ValueError) as err:
             self._handle_ws_error(action, err)

uiprotect/websocket.py

@@ -45,7 +45,7 @@ class Websocket:
 
     def __init__(
         self,
-        url: str,
+        get_url: Callable[[], str],
         auth_callback: CALLBACK_TYPE,
         *,
         timeout: int = 30,
@@ -53,7 +53,7 @@ class Websocket:
         verify: bool = True,
     ) -> None:
         """Init Websocket."""
-        self.url = url
+        self.get_url = get_url
         self.timeout_interval = timeout
         self.backoff = backoff
         self.verify = verify
@@ -85,14 +85,15 @@ class Websocket:
         return True
 
     async def _websocket_loop(self, start_event: asyncio.Event) -> None:
-        _LOGGER.debug("Connecting WS to %s", self.url)
+        url = self.get_url()
+        _LOGGER.debug("Connecting WS to %s", url)
         self._headers = await self._auth(self._should_reset_auth)
 
         session = self._get_session()
         # catch any and all errors for Websocket so we can clean up correctly
         try:
             self._ws_connection = await session.ws_connect(
-                self.url,
+                url,
                 ssl=None if self.verify else False,
                 headers=self._headers,
             )
@@ -104,7 +105,7 @@ class Websocket:
                     break
                 self._reset_timeout()
         except ClientError:
-            _LOGGER.exception("Websocket disconnect error: %s", self.url)
+            _LOGGER.exception("Websocket disconnect error: %s", url)
         finally:
             _LOGGER.debug("Websocket disconnected")
             self._increase_failure()

{uiprotect-1.12.0.dist-info → uiprotect-1.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 1.12.0
+Version: 1.13.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 License: MIT

{uiprotect-1.12.0.dist-info → uiprotect-1.13.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 uiprotect/__init__.py,sha256=llnQNtiBfwQG8IkQXovvFz4LZeFjrJx7XdmmUhu3a9E,289
 uiprotect/__main__.py,sha256=C_bHCOkv5qj6WMy-6ELoY3Y6HDhLxOa1a30CzmbZhsg,462
-uiprotect/api.py,sha256=t3E1wMja0av6ENtvXJHGv70WC6NCCWbF_wFIJxOLS0I,66463
+uiprotect/api.py,sha256=zVKTMieBqx3EM1sex5zzAj2J2k4pUlQQ_xF8nE6AS5s,66339
 uiprotect/cli/__init__.py,sha256=sSLW9keVQOkgFcMW18HTDjRrt9sJ0KWjn9DJDA6f9Pc,8658
 uiprotect/cli/backup.py,sha256=ZiS7RZnJGKI8TJKLW2cOUzkRM8nyTvE5Ov_jZZGtvSM,36708
 uiprotect/cli/base.py,sha256=zpTm2kyJe_GLixnv3Uadke__iRLh64AEwQzp-2hqS7g,7730
@@ -14,8 +14,8 @@ uiprotect/cli/nvr.py,sha256=TwxEg2XT8jXAbOqv6gc7KFXELKadeItEDYweSL4_-e8,4260
 uiprotect/cli/sensors.py,sha256=fQtcDJCVxs4VbAqcavgBy2ABiVxAW3GXtna6_XFBp2k,8153
 uiprotect/cli/viewers.py,sha256=2cyrp104ffIvgT0wYGIO0G35QMkEbFe7fSVqLwDXQYQ,2171
 uiprotect/data/__init__.py,sha256=OcfuJl2qXfHcj_mdnrHhzZ5tEIZrw8auziX5IE7dn-I,2938
-uiprotect/data/base.py,sha256=apIXKZHL6dbyXTT4C4lkyo4M-Nf_DwsVXoXBL5jcXVo,37574
-uiprotect/data/bootstrap.py,sha256=pAb-JC_AatYPldfefiMqdZ3_6Ftngcmd2asAMw66XLE,21486
+uiprotect/data/base.py,sha256=yzGm5RCeo9AqmgArWC8O7LhBp_Qxz1XSel3xRyhNAbM,37718
+uiprotect/data/bootstrap.py,sha256=wjRFVrv1rOFVDcij6ZYm7dzMe0iz6AqYciQozC-J2TI,21893
 uiprotect/data/convert.py,sha256=8h6Il_DhMkPRDPj9F_rA2UZIlTuchS3BQD24peKpk2A,2185
 uiprotect/data/devices.py,sha256=Nq3bOko5PFf5LvEBoD4JV8kmbq50laRdh3VHMWX7t-0,111809
 uiprotect/data/nvr.py,sha256=XC4NO1c_Mom-hIpzj9ksKFcgKbHd6ToqWjkgzxJ1PJY,47636
@@ -29,9 +29,9 @@ uiprotect/stream.py,sha256=McV3XymKyjn-1uV5jdQHcpaDjqLS4zWyMASQ8ubcyb4,4924
 uiprotect/test_util/__init__.py,sha256=d2g7afa0LSdixQ0kjEDYwafDFME_UlW2LzxpamZ2BC0,18556
 uiprotect/test_util/anonymize.py,sha256=f-8ijU-_y9r-uAbhIPn0f0I6hzJpAkvJzc8UpWihObI,8478
 uiprotect/utils.py,sha256=6OLY8hNiCzk418PjJJIlFW7jjPzVt1vxBKEzBSqMeTk,18418
-uiprotect/websocket.py,sha256=IzDPyqbzrkOMREvahN-e2zdvVD0VABSCWy6jSoCwOT0,7299
-uiprotect-1.12.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
-uiprotect-1.12.0.dist-info/METADATA,sha256=wPRYZLr1EpqqtUnuenaK3Z-iEdmDqA4YnHCvJG5NQAY,10985
-uiprotect-1.12.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-uiprotect-1.12.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
-uiprotect-1.12.0.dist-info/RECORD,,
+uiprotect/websocket.py,sha256=JHI_2EZeRPqPyQopsBZS0dr3tu0HaTiqeLazfBXhW_8,7339
+uiprotect-1.13.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
+uiprotect-1.13.0.dist-info/METADATA,sha256=64mSJs-bol2iFi_YUobezZybOEwOovljmPod2f9ELiw,10985
+uiprotect-1.13.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+uiprotect-1.13.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
+uiprotect-1.13.0.dist-info/RECORD,,