Only enable WSAs for events/notify/pullpoint services (#31)

Author: bdraco

onvif/client.py

@@ -252,6 +252,7 @@ def __init__(
         binding_key="",
         read_timeout: Optional[int] = None,
         write_timeout: Optional[int] = None,
+        enable_wsa: bool = False,
     ) -> None:
         if not _path_isfile(url):
             raise ONVIFError("%s doesn`t exist!" % url)
@@ -296,6 +297,7 @@ def __init__(
         self.ws_client: Optional[AsyncServiceProxy] = None
         self.create_type: Optional[Callable] = None
         self.loop = asyncio.get_event_loop()
+        self._enable_wsa = enable_wsa
 
     async def setup(self):
         """Setup the transport."""
@@ -307,11 +309,15 @@ async def setup(self):
         self.document = await self.loop.run_in_executor(
             None, _cached_document, self.url
         )
+        # Some cameras never return a response to GetCapabilities if WS-Addressing is enabled
+        # but some cameras require WS-Addressing to be enabled for PullPoint or events to work
+        # so we have a flag to enable/disable it which can be changed per service.
+        plugins = [WsAddressingPlugin()] if self._enable_wsa else []
         self.zeep_client_authless = ZeepAsyncClient(
             wsdl=self.document,
             transport=self.transport,
             settings=settings,
-            plugins=[WsAddressingPlugin()],
+            plugins=plugins,
         )
         self.ws_client_authless = self.zeep_client_authless.create_service(
             binding_name, self.xaddr
@@ -321,7 +327,7 @@ async def setup(self):
             wsse=wsse,
             transport=self.transport,
             settings=settings,
-            plugins=[WsAddressingPlugin()],
+            plugins=plugins,
         )
         self.ws_client = self.zeep_client.create_service(binding_name, self.xaddr)
         namespace = binding_name[binding_name.find("{") + 1 : binding_name.find("}")]
@@ -404,8 +410,10 @@ async def setup(self) -> ONVIFService:
         #
         # If this fails this is OK as it just means we will switch
         # to webhook later when the first notification is received.
+        # WSAs enabled per
+        # https://github.com/home-assistant/core/issues/83524 https://github.com/home-assistant/core/issues/45513
         service = await self._device.create_onvif_service(
-            "pullpoint", port_type="NotificationConsumer"
+            "pullpoint", port_type="NotificationConsumer", enable_wsa=True
         )
         self._operation = service.document.bindings[service.binding_name].get(
             "PullMessages"
@@ -649,6 +657,7 @@ async def create_onvif_service(
         port_type: Optional[str] = None,
         read_timeout: Optional[int] = None,
         write_timeout: Optional[int] = None,
+        enable_wsa: bool = False,
     ) -> ONVIFService:
         """Create ONVIF service client"""
         name = name.lower()
@@ -687,6 +696,7 @@ async def create_onvif_service(
             binding_key=binding_key,
             read_timeout=read_timeout,
             write_timeout=write_timeout,
+            enable_wsa=enable_wsa,
         )
         await service.setup()
 
@@ -715,8 +725,12 @@ async def create_deviceio_service(self) -> ONVIFService:
         return await self.create_onvif_service("deviceio")
 
     async def create_events_service(self) -> ONVIFService:
-        """Service creation helper."""
-        return await self.create_onvif_service("events")
+        """Service creation helper.
+
+        WSAs enabled per
+        https://github.com/home-assistant/core/issues/83524 https://github.com/home-assistant/core/issues/45513
+        """
+        return await self.create_onvif_service("events", enable_wsa=True)
 
     async def create_analytics_service(self) -> ONVIFService:
         """Service creation helper."""
@@ -735,23 +749,38 @@ async def create_replay_service(self) -> ONVIFService:
         return await self.create_onvif_service("replay")
 
     async def create_pullpoint_service(self) -> ONVIFService:
-        """Service creation helper."""
+        """Service creation helper.
+
+        WSAs enabled per
+        https://github.com/home-assistant/core/issues/83524 https://github.com/home-assistant/core/issues/45513
+        """
         return await self.create_onvif_service(
             "pullpoint",
             port_type="PullPointSubscription",
             read_timeout=_PULLPOINT_TIMEOUT,
             write_timeout=_PULLPOINT_TIMEOUT,
+            enable_wsa=True,
         )
 
     async def create_notification_service(self) -> ONVIFService:
-        """Service creation helper."""
-        return await self.create_onvif_service("notification")
+        """Service creation helper.
+
+        WSAs enabled per
+        https://github.com/home-assistant/core/issues/83524 https://github.com/home-assistant/core/issues/45513
+        """
+        return await self.create_onvif_service("notification", enable_wsa=True)
 
     async def create_subscription_service(
         self, port_type: Optional[str] = None
     ) -> ONVIFService:
-        """Service creation helper."""
-        return await self.create_onvif_service("subscription", port_type=port_type)
+        """Service creation helper.
+
+        WSAs enabled per
+        https://github.com/home-assistant/core/issues/83524 https://github.com/home-assistant/core/issues/45513
+        """
+        return await self.create_onvif_service(
+            "subscription", port_type=port_type, enable_wsa=True
+        )
 
     async def create_receiver_service(self) -> ONVIFService:
         """Service creation helper."""