onvif-python 0.0.4__tar.gz → 0.0.5__tar.gz

{onvif_python-0.0.4/onvif_python.egg-info → onvif_python-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.0.4
+Version: 0.0.5
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -41,9 +41,9 @@ Dynamic: license-file
 
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-file)
 [![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.0.4-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.0.5-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.0.4-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.0.5-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=PyPI%20Downloads)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 
 Are you having trouble finding a Python ONVIF library that supports your device?  
@@ -148,32 +148,64 @@ Explore more advanced usage and service-specific operations in the [`examples/`]
 > [!IMPORTANT]
 > If you're new to ONVIF and want to learn more, we highly recommend taking the official free online course provided by ONVIF at [Introduction to ONVIF Course](https://www.onvif.org/about/introduction-to-onvif-course). Please note that we are not endorsed or sponsored by ONVIF, see [Legal Notice](#legal-notice) for details.
 
-## Device Verification: Why Use GetCapabilities First?
+## Service Discovery: Understanding Device Capabilities
 
 > [!WARNING]
-> Before performing any operations on an ONVIF device, it is highly recommended to verify which capabilities and services are available and supported by the device using the `GetCapabilities` method from `devicemgmt()` service instance. This step ensures that your application interacts only with features that the device actually implements, preventing errors and improving compatibility.
+> Before performing any operations on an ONVIF device, it is highly recommended to discover which services are available and supported by the device. This library automatically uses `GetServices` during initialization to discover service endpoints, but you can also query services manually for detailed information including capabilities.
 
-**Why verify device capabilities with GetCapabilities?**
+**Why discover device services?**
 
-- **Device Diversity:** Not all ONVIF devices support every capability or service. Capabilities may vary by manufacturer, model, firmware, or configuration.
-- **Error Prevention:** Attempting to use unsupported features can result in failed requests, exceptions, or undefined behavior.
-- **Dynamic Feature Detection:** Devices may enable or disable capabilities over time (e.g., after firmware updates or configuration changes).
-- **Optimized Integration:** By checking available capabilities, your application can adapt its workflow and UI to match the device's actual features.
+- **Device Diversity:** Not all ONVIF devices support every service. Available services may vary by manufacturer, model, firmware, or configuration.
+- **Error Prevention:** Attempting to use unsupported services can result in failed requests, exceptions, or undefined behavior.
+- **Dynamic Feature Detection:** Devices may enable or disable services over time (e.g., after firmware updates or configuration changes).
+- **Optimized Integration:** By checking available services, your application can adapt its workflow and UI to match the device's actual features.
 
-**How to verify device capabilities:**
+**How service discovery works in this library:**
 
-Call `GetCapabilities` on your `devicemgmt()` instance:
+The `ONVIFClient` automatically calls `GetServices` during initialization to build a service map. This map is used internally to resolve service endpoints:
 
 ```python
 from onvif import ONVIFClient
 
 client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123")
+
+# Access the discovered services
+print(client.services)
+# Example output: [{'Namespace': 'http://www.onvif.org/ver10/device/wsdl', 'XAddr': '...', 'Version': {...}}, ...]
+
+# Check the service map (namespace -> XAddr mapping)
+print(client._service_map)
+# Example output: {'http://www.onvif.org/ver10/media/wsdl': 'http://192.168.1.17:8000/onvif/Media', ...}
+```
+
+**Get detailed service information with capabilities:**
+
+If you need detailed capability information for each service, call `GetServices` with `IncludeCapability=True`:
+
+```python
+device = client.devicemgmt()
+services = device.GetServices(IncludeCapability=True)
+
+for service in services:
+    print(f"Service: {service.Namespace}")
+    print(f"Endpoint: {service.XAddr}")
+    print(f"Version: {service.Version.Major}.{service.Version.Minor}")
+    if hasattr(service, 'Capabilities') and service.Capabilities:
+        print(f"Capabilities: {service.Capabilities}")
+```
+
+**Alternative: Use GetCapabilities for legacy compatibility:**
+
+For backward compatibility or when you need a quick overview of major service categories, you can still use `GetCapabilities`:
+
+```python
 capabilities = client.devicemgmt().GetCapabilities()
 print(capabilities)
-# Example output: {'Media': {'XAddr': 'http://192.168.1.17:8000/onvif/media_service', ...}, 'PTZ': {...}, ...}
+# Example output: {'Media': {'XAddr': '...', ...}, 'PTZ': {...}, 'Events': {...}, ...}
 ```
 
-Review the returned dictionary to determine which capabilities and services (e.g., Media, PTZ, Analytics) are available before invoking further operations.
+> [!TIP]
+> The library handles service discovery automatically, so you typically don't need to call `GetServices` manually unless you need detailed capability information or want to refresh the service list after device configuration changes.
 
 ## Tested Devices
 
@@ -283,6 +315,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    client.events()                    # root binding
    client.pullpoint(subscription)     # sub-binding (dynamic, via SubscriptionReference.Address)
    client.subscription(subscription)  # sub-binding (dynamic, via SubscriptionReference.Address)
+   client.notification()              # sub-binding accessor
    ```
 
 2. **Security (Advanced Security)**
@@ -290,7 +323,6 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    - **Sub-bindings:**
      - `AuthorizationServerBinding`
      - `KeystoreBinding`
-     - `CredentialBinding`
      - `JWTBinding`
      - `Dot1XBinding`
      - `TLSServerBinding`
@@ -300,7 +332,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    ```python
    client.security()                  # root binding
    client.authorizationserver(xaddr)  # sub-binding accessor (requires xAddr)
-   client.keystore(xaddr)
+   client.keystore(xaddr)             # ..
    client.jwt(xaddr)
    client.dot1x(xaddr)
    client.tlsserver(xaddr)
@@ -326,6 +358,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
 
 ## Future Improvements (Stay tuned and star ⭐ this repo)
 
+- [ ] Add ONVIF CLI program to interact directly with ONVIF devices via terminal.
 - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata).
 - [ ] Integrate [xmltodict](https://github.com/martinblech/xmltodict) for simplified XML parsing and conversion.
 - [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.

{onvif_python-0.0.4 → onvif_python-0.0.5}/README.md

@@ -2,9 +2,9 @@
 
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-file)
 [![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.0.4-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.0.5-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.0.4-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.0.5-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=PyPI%20Downloads)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 
 Are you having trouble finding a Python ONVIF library that supports your device?  
@@ -109,32 +109,64 @@ Explore more advanced usage and service-specific operations in the [`examples/`]
 > [!IMPORTANT]
 > If you're new to ONVIF and want to learn more, we highly recommend taking the official free online course provided by ONVIF at [Introduction to ONVIF Course](https://www.onvif.org/about/introduction-to-onvif-course). Please note that we are not endorsed or sponsored by ONVIF, see [Legal Notice](#legal-notice) for details.
 
-## Device Verification: Why Use GetCapabilities First?
+## Service Discovery: Understanding Device Capabilities
 
 > [!WARNING]
-> Before performing any operations on an ONVIF device, it is highly recommended to verify which capabilities and services are available and supported by the device using the `GetCapabilities` method from `devicemgmt()` service instance. This step ensures that your application interacts only with features that the device actually implements, preventing errors and improving compatibility.
+> Before performing any operations on an ONVIF device, it is highly recommended to discover which services are available and supported by the device. This library automatically uses `GetServices` during initialization to discover service endpoints, but you can also query services manually for detailed information including capabilities.
 
-**Why verify device capabilities with GetCapabilities?**
+**Why discover device services?**
 
-- **Device Diversity:** Not all ONVIF devices support every capability or service. Capabilities may vary by manufacturer, model, firmware, or configuration.
-- **Error Prevention:** Attempting to use unsupported features can result in failed requests, exceptions, or undefined behavior.
-- **Dynamic Feature Detection:** Devices may enable or disable capabilities over time (e.g., after firmware updates or configuration changes).
-- **Optimized Integration:** By checking available capabilities, your application can adapt its workflow and UI to match the device's actual features.
+- **Device Diversity:** Not all ONVIF devices support every service. Available services may vary by manufacturer, model, firmware, or configuration.
+- **Error Prevention:** Attempting to use unsupported services can result in failed requests, exceptions, or undefined behavior.
+- **Dynamic Feature Detection:** Devices may enable or disable services over time (e.g., after firmware updates or configuration changes).
+- **Optimized Integration:** By checking available services, your application can adapt its workflow and UI to match the device's actual features.
 
-**How to verify device capabilities:**
+**How service discovery works in this library:**
 
-Call `GetCapabilities` on your `devicemgmt()` instance:
+The `ONVIFClient` automatically calls `GetServices` during initialization to build a service map. This map is used internally to resolve service endpoints:
 
 ```python
 from onvif import ONVIFClient
 
 client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123")
+
+# Access the discovered services
+print(client.services)
+# Example output: [{'Namespace': 'http://www.onvif.org/ver10/device/wsdl', 'XAddr': '...', 'Version': {...}}, ...]
+
+# Check the service map (namespace -> XAddr mapping)
+print(client._service_map)
+# Example output: {'http://www.onvif.org/ver10/media/wsdl': 'http://192.168.1.17:8000/onvif/Media', ...}
+```
+
+**Get detailed service information with capabilities:**
+
+If you need detailed capability information for each service, call `GetServices` with `IncludeCapability=True`:
+
+```python
+device = client.devicemgmt()
+services = device.GetServices(IncludeCapability=True)
+
+for service in services:
+    print(f"Service: {service.Namespace}")
+    print(f"Endpoint: {service.XAddr}")
+    print(f"Version: {service.Version.Major}.{service.Version.Minor}")
+    if hasattr(service, 'Capabilities') and service.Capabilities:
+        print(f"Capabilities: {service.Capabilities}")
+```
+
+**Alternative: Use GetCapabilities for legacy compatibility:**
+
+For backward compatibility or when you need a quick overview of major service categories, you can still use `GetCapabilities`:
+
+```python
 capabilities = client.devicemgmt().GetCapabilities()
 print(capabilities)
-# Example output: {'Media': {'XAddr': 'http://192.168.1.17:8000/onvif/media_service', ...}, 'PTZ': {...}, ...}
+# Example output: {'Media': {'XAddr': '...', ...}, 'PTZ': {...}, 'Events': {...}, ...}
 ```
 
-Review the returned dictionary to determine which capabilities and services (e.g., Media, PTZ, Analytics) are available before invoking further operations.
+> [!TIP]
+> The library handles service discovery automatically, so you typically don't need to call `GetServices` manually unless you need detailed capability information or want to refresh the service list after device configuration changes.
 
 ## Tested Devices
 
@@ -244,6 +276,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    client.events()                    # root binding
    client.pullpoint(subscription)     # sub-binding (dynamic, via SubscriptionReference.Address)
    client.subscription(subscription)  # sub-binding (dynamic, via SubscriptionReference.Address)
+   client.notification()              # sub-binding accessor
    ```
 
 2. **Security (Advanced Security)**
@@ -251,7 +284,6 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    - **Sub-bindings:**
      - `AuthorizationServerBinding`
      - `KeystoreBinding`
-     - `CredentialBinding`
      - `JWTBinding`
      - `Dot1XBinding`
      - `TLSServerBinding`
@@ -261,7 +293,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    ```python
    client.security()                  # root binding
    client.authorizationserver(xaddr)  # sub-binding accessor (requires xAddr)
-   client.keystore(xaddr)
+   client.keystore(xaddr)             # ..
    client.jwt(xaddr)
    client.dot1x(xaddr)
    client.tlsserver(xaddr)
@@ -287,6 +319,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
 
 ## Future Improvements (Stay tuned and star ⭐ this repo)
 
+- [ ] Add ONVIF CLI program to interact directly with ONVIF devices via terminal.
 - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata).
 - [ ] Integrate [xmltodict](https://github.com/martinblech/xmltodict) for simplified XML parsing and conversion.
 - [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.

{onvif_python-0.0.4 → onvif_python-0.0.5}/onvif/__init__.py

@@ -12,6 +12,6 @@ __all__ = [
     "ONVIFWSDL",
     "ONVIFOperationException",
     "apply_patch",
-    "remove_patch", 
+    "remove_patch",
     "is_patched",
-]
+]

{onvif_python-0.0.4 → onvif_python-0.0.5}/onvif/client.py

@@ -41,7 +41,11 @@ from .services import (
     MediaSigning,
 )
 from .operator import CacheMode
-from .utils.zeep import apply_patch as _apply_zeep_patch, remove_patch as _remove_zeep_patch
+from .utils.zeep import (
+    apply_patch as _apply_zeep_patch,
+    remove_patch as _remove_zeep_patch,
+)
+from .utils.wsdl import ONVIFWSDL
 
 
 class ONVIFClient:
@@ -58,13 +62,13 @@ class ONVIFClient:
         apply_patch=True,
     ):
         self.apply_patch = apply_patch
-        
+
         # Apply or remove zeep patch based on user preference
         if apply_patch:
             _apply_zeep_patch()
         else:
             _remove_zeep_patch()
-        
+
         self.common_args = {
             "host": host,
             "port": port,
@@ -80,8 +84,15 @@ class ONVIFClient:
         # Device Management (Core) service is always available
         self._devicemgmt = Device(**self.common_args)
 
-        # Retrieve device capabilities once and reuse
-        self.capabilities = self._devicemgmt.GetCapabilities(Category="All")
+        # Retrieve device services once and create namespace -> XAddr mapping
+        self.services = self._devicemgmt.GetServices(IncludeCapability=False)
+        self._service_map = {}
+        for service in self.services:
+            namespace = getattr(service, "Namespace", None)
+            xaddr = getattr(service, "XAddr", None)
+
+            if namespace and xaddr:
+                self._service_map[namespace] = xaddr
 
         # Lazy init for other services
 
@@ -141,45 +152,49 @@ class ONVIFClient:
         self._authorizationserver = None
         self._mediasigning = None
 
-
     def _get_xaddr(self, service_name: str, service_path: str):
         """
-        Resolve XAddr from GetCapabilities. Fallback to default if not present.
-        Now supports nested Extension with _value_1 dict (after normalized parsing).
+        Resolve XAddr from GetServices based on namespace mapping.
+        Falls back to default URL if service not found.
         """
-        svc = getattr(self.capabilities, service_name, None)
-
-        # Step 1: check direct attribute (e.g. capabilities.Media)
-        if svc and hasattr(svc, "XAddr"):
-            xaddr = svc.XAddr
-        else:
-            # Step 2: try legacy Extension.service_name
-            ext = getattr(self.capabilities, "Extension", None)
-            if ext and hasattr(ext, service_name):
-                svc = getattr(ext, service_name, None)
-                xaddr = getattr(svc, "XAddr", None) if svc else None
-            else:
-                # Step 3: try new-style _value_1 dict inside Extension
-                ext_dict = getattr(ext, "_value_1", {})
-                xaddr = ext_dict.get(service_name, {}).get("XAddr") if isinstance(ext_dict, dict) else None
-
-        if xaddr:
-            parsed = urlparse(xaddr)
-            # Host/port from device
-            device_host = parsed.hostname
-            device_port = parsed.port
-            # Host/port from connection
-            connect_host = self.common_args["host"]
-            connect_port = self.common_args["port"]
-            # if host/port differ, rewrite XAddr to use connection values
-            if (device_host != connect_host) or (device_port != connect_port):
-                protocol = "https" if self.common_args["use_https"] else "http"
-                new_netloc = f"{connect_host}:{connect_port}"
-                rewritten = urlunparse((protocol, new_netloc, parsed.path, "", "", ""))
-                return rewritten
-            return xaddr
-
-        # Fallback default
+        # Get the namespace for this service from WSDL_MAP
+        try:
+            # Try to get the service definition from WSDL_MAP
+            # Most services use ver10, some use ver20
+            service_key = service_name.lower()
+            wsdl_def = None
+
+            # Try ver10 first, then ver20
+            if service_key in ONVIFWSDL.WSDL_MAP:
+                if "ver10" in ONVIFWSDL.WSDL_MAP[service_key]:
+                    wsdl_def = ONVIFWSDL.WSDL_MAP[service_key]["ver10"]
+                elif "ver20" in ONVIFWSDL.WSDL_MAP[service_key]:
+                    wsdl_def = ONVIFWSDL.WSDL_MAP[service_key]["ver20"]
+
+            if wsdl_def:
+                namespace = wsdl_def["namespace"]
+                xaddr = self._service_map.get(namespace)
+
+                if xaddr:
+                    # Rewrite host/port if needed
+                    parsed = urlparse(xaddr)
+                    device_host = parsed.hostname
+                    device_port = parsed.port
+                    connect_host = self.common_args["host"]
+                    connect_port = self.common_args["port"]
+
+                    if (device_host != connect_host) or (device_port != connect_port):
+                        protocol = "https" if self.common_args["use_https"] else "http"
+                        new_netloc = f"{connect_host}:{connect_port}"
+                        rewritten = urlunparse(
+                            (protocol, new_netloc, parsed.path, "", "", "")
+                        )
+                        return rewritten
+                    return xaddr
+        except Exception:
+            pass
+
+        # Fallback to default URL
         protocol = "https" if self.common_args["use_https"] else "http"
         return f"{protocol}://{self.common_args['host']}:{self.common_args['port']}/onvif/{service_path}"
 

{onvif_python-0.0.4 → onvif_python-0.0.5}/onvif/operator.py

@@ -125,7 +125,7 @@ class ONVIFOperator:
 
         try:
             result = func(*args, **kwargs)
-            # Post-process to flatten xsd:any fields if enabled
+            # Post-process to flatten xsd:any fields if enabled (> v0.0.4 patch)
             if self.apply_flatten:
                 return flatten_xsd_any_fields(result)
             return result

{onvif_python-0.0.4 → onvif_python-0.0.5}/onvif/services/devicemgmt.py

@@ -25,7 +25,7 @@ class Device:
         return self.operator.call("GetDeviceInformation")
 
     def SetSystemDateAndTime(
-        self, DateTimeType, DaylightSavings=True, TimeZone=None, UTCDateTime=None
+        self, DateTimeType, DaylightSavings, TimeZone=None, UTCDateTime=None
     ):
         return self.operator.call(
             "SetSystemDateAndTime",