onvif-python 0.1.5__tar.gz → 0.1.6__tar.gz

{onvif_python-0.1.5/onvif_python.egg-info → onvif_python-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.1.5
+Version: 0.1.6
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -40,7 +40,7 @@ Dynamic: license-file
 
 [![Codacy grade](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?label=Project%20Quality&logo=codacy)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nirsimetri/onvif-python)
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.5-orange?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.6-orange?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=Downloads&color=red)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 <br>
 [![Build](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml)
@@ -92,9 +92,29 @@ pip install .
 > [!TIP]
 > You can view the complete documentation automatically generated by DeepWiki via the [onvif-python AI Wiki](https://deepwiki.com/nirsimetri/onvif-python) link. We currently do not have an official documentation site. Help us create more examples and helpful documentation by [contributing](https://github.com/nirsimetri/onvif-python?tab=contributing-ov-file).
 
-Below are simple examples to help you get started with the ONVIF Python library. These demonstrate how to connect to an ONVIF-compliant device and retrieve basic device information.
+Below are simple examples to help you get started with the ONVIF Python library. These demonstrate how to discover and connect to ONVIF-compliant devices and retrieve basic device information.
 
-**1. Initialize the ONVIFClient**
+**1. Discover ONVIF Devices (Optional)**
+
+Use `ONVIFDiscovery` (applied at [`>=v0.1.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.6)) to automatically find ONVIF devices on your local network:
+
+```python
+from onvif import ONVIFDiscovery
+
+# Create discovery instance
+discovery = ONVIFDiscovery(timeout=5)
+
+# Discover devices
+devices = discovery.discover()
+
+# Display discovered devices
+for device in devices:
+    print(f"Found device at {device['host']}:{device['port']}")
+    print(f"  Scopes: {device.get('scopes', [])}")
+    print(f"  XAddrs: {device['xaddrs']}")
+```
+
+**2. Initialize the ONVIFClient**
 
 Create an instance of `ONVIFClient` by providing your device's IP address, port, username, and password:
 
@@ -111,7 +131,7 @@ client = ONVIFClient(
 )
 ```
 
-**2. Create Service Instance**
+**3. Create Service Instance**
 
 `ONVIFClient` provides several main services that can be accessed via the following methods:
 
@@ -130,7 +150,7 @@ device = client.devicemgmt()      # Device Management (Core)
 media = client.media()            # Media
 ```
 
-**3. Get Device Information**
+**4. Get Device Information**
 
 Retrieve basic information about the device, such as manufacturer, model, firmware version, and serial number using `devicemgmt()` service:
 
@@ -140,7 +160,7 @@ print(info)
 # Example output: {'Manufacturer': '..', 'Model': '..', 'FirmwareVersion': '..', 'SerialNumber': '..'}
 ```
 
-**4. Get RTSP URL**
+**5. Get RTSP URL**
 
 Retrieve the RTSP stream URL for live video streaming from the device using `media()` service:
 
@@ -173,6 +193,7 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 
 ### Features
 
+- **Device Discovery:** Automatic ONVIF device discovery on local network using WS-Discovery protocol.
 - **Interactive Shell:** A user-friendly shell with tab completion, command history, and colorized output.
 - **Direct Command Execution:** Run ONVIF commands directly from the terminal for scripting and automation.
 - **Automatic Discovery:** Automatically detects available services on the device.
@@ -215,7 +236,7 @@ usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password
              [--no-patch] [--interactive] [--debug] [--wsdl WSDL] [--cache {all,db,mem,none}] [--health-check-interval HEALTH_CHECK_INTERVAL] [--version]
              [service] [method] [params ...]
 
-ONVIF Terminal Client — v0.1.5
+ONVIF Terminal Client — v0.1.6
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -272,7 +293,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell Commands - v0.1.5
+ONVIF Interactive Shell Commands - v0.1.6
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:

{onvif_python-0.1.5 → onvif_python-0.1.6}/README.md

@@ -2,7 +2,7 @@
 
 [![Codacy grade](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?label=Project%20Quality&logo=codacy)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nirsimetri/onvif-python)
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.5-orange?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.6-orange?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=Downloads&color=red)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 <br>
 [![Build](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml)
@@ -54,9 +54,29 @@ pip install .
 > [!TIP]
 > You can view the complete documentation automatically generated by DeepWiki via the [onvif-python AI Wiki](https://deepwiki.com/nirsimetri/onvif-python) link. We currently do not have an official documentation site. Help us create more examples and helpful documentation by [contributing](https://github.com/nirsimetri/onvif-python?tab=contributing-ov-file).
 
-Below are simple examples to help you get started with the ONVIF Python library. These demonstrate how to connect to an ONVIF-compliant device and retrieve basic device information.
+Below are simple examples to help you get started with the ONVIF Python library. These demonstrate how to discover and connect to ONVIF-compliant devices and retrieve basic device information.
 
-**1. Initialize the ONVIFClient**
+**1. Discover ONVIF Devices (Optional)**
+
+Use `ONVIFDiscovery` (applied at [`>=v0.1.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.6)) to automatically find ONVIF devices on your local network:
+
+```python
+from onvif import ONVIFDiscovery
+
+# Create discovery instance
+discovery = ONVIFDiscovery(timeout=5)
+
+# Discover devices
+devices = discovery.discover()
+
+# Display discovered devices
+for device in devices:
+    print(f"Found device at {device['host']}:{device['port']}")
+    print(f"  Scopes: {device.get('scopes', [])}")
+    print(f"  XAddrs: {device['xaddrs']}")
+```
+
+**2. Initialize the ONVIFClient**
 
 Create an instance of `ONVIFClient` by providing your device's IP address, port, username, and password:
 
@@ -73,7 +93,7 @@ client = ONVIFClient(
 )
 ```
 
-**2. Create Service Instance**
+**3. Create Service Instance**
 
 `ONVIFClient` provides several main services that can be accessed via the following methods:
 
@@ -92,7 +112,7 @@ device = client.devicemgmt()      # Device Management (Core)
 media = client.media()            # Media
 ```
 
-**3. Get Device Information**
+**4. Get Device Information**
 
 Retrieve basic information about the device, such as manufacturer, model, firmware version, and serial number using `devicemgmt()` service:
 
@@ -102,7 +122,7 @@ print(info)
 # Example output: {'Manufacturer': '..', 'Model': '..', 'FirmwareVersion': '..', 'SerialNumber': '..'}
 ```
 
-**4. Get RTSP URL**
+**5. Get RTSP URL**
 
 Retrieve the RTSP stream URL for live video streaming from the device using `media()` service:
 
@@ -135,6 +155,7 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 
 ### Features
 
+- **Device Discovery:** Automatic ONVIF device discovery on local network using WS-Discovery protocol.
 - **Interactive Shell:** A user-friendly shell with tab completion, command history, and colorized output.
 - **Direct Command Execution:** Run ONVIF commands directly from the terminal for scripting and automation.
 - **Automatic Discovery:** Automatically detects available services on the device.
@@ -177,7 +198,7 @@ usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password
              [--no-patch] [--interactive] [--debug] [--wsdl WSDL] [--cache {all,db,mem,none}] [--health-check-interval HEALTH_CHECK_INTERVAL] [--version]
              [service] [method] [params ...]
 
-ONVIF Terminal Client — v0.1.5
+ONVIF Terminal Client — v0.1.6
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -234,7 +255,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell Commands - v0.1.5
+ONVIF Interactive Shell Commands - v0.1.6
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:

{onvif_python-0.1.5 → onvif_python-0.1.6}/onvif/__init__.py

@@ -2,7 +2,13 @@
 
 from .client import ONVIFClient
 from .operator import ONVIFOperator, CacheMode
-from .utils import ONVIFWSDL, ONVIFOperationException, ONVIFErrorHandler, ZeepPatcher
+from .utils import (
+    ONVIFWSDL,
+    ONVIFOperationException,
+    ONVIFErrorHandler,
+    ZeepPatcher,
+    ONVIFDiscovery,
+)
 from .cli import main as ONVIFCLI
 
 __all__ = [
@@ -14,4 +20,5 @@ __all__ = [
     "ONVIFErrorHandler",
     "ZeepPatcher",
     "ONVIFCLI",
+    "ONVIFDiscovery",
 ]

{onvif_python-0.1.5 → onvif_python-0.1.6}/onvif/cli/interactive.py

@@ -191,7 +191,7 @@ class InteractiveShell(cmd.Cmd):
             "  / __ \\/ | / / |  / /  _/ ____/",
             " / / / /  |/ /| | / // // /_    ",
             "/ /_/ / /|  / | |/ // // __/    ",
-            "\\____/_/ |_/  |___/___/_/  v0.1.5",
+            "\\____/_/ |_/  |___/___/_/  v0.1.6",
             "                                ",
         ]
 
@@ -240,25 +240,27 @@ class InteractiveShell(cmd.Cmd):
         while not self._stop_health_check.is_set():
             sock = None
             try:
-                sock = socket.create_connection(
-                    (self.args.host, self.args.port), timeout=5.0
-                )
-
-                # If HTTPS, perform a short TLS handshake check
+                # For HTTPS, use ssl.create_connection for proper TLS handling
                 if getattr(self.args, "https", False):
                     context = ssl.create_default_context()
                     context.minimum_version = ssl.TLSVersion.TLSv1_2
                     context.check_hostname = False
                     context.verify_mode = ssl.CERT_NONE
 
-                    with context.wrap_socket(
-                        sock, server_hostname=self.args.host
-                    ) as ssock:
-                        ssock.settimeout(5)
-                        # Try a minimal handshake
-                        ssock.do_handshake()
+                    # Use ssl.create_connection instead of wrapping existing socket
+                    sock = context.wrap_socket(
+                        socket.socket(socket.AF_INET, socket.SOCK_STREAM),
+                        server_hostname=self.args.host,
+                    )
+                    sock.settimeout(5.0)
+                    sock.connect((self.args.host, self.args.port))
+                else:
+                    # For HTTP, simple TCP connection check
+                    sock = socket.create_connection(
+                        (self.args.host, self.args.port), timeout=5.0
+                    )
 
-                # If we reach here, the connection (and TLS if applicable) succeeded
+                # Connection successful
                 pass
 
             except (
@@ -368,7 +370,7 @@ class InteractiveShell(cmd.Cmd):
 
         return parts
 
-    def _display_grid(self, items, force_recalc=False):
+    def _display_grid(self, items):
         """Display items in grid format matching TAB completion (vertical layout)"""
         if not items:
             return
@@ -393,7 +395,7 @@ class InteractiveShell(cmd.Cmd):
 
         # Column width calculation: use same algorithm as cmd.Cmd.columnize()
         # Python's columnize uses: maxlen + 2 if maxlen > 0 else 2
-        col_width = longest_length + 1 if longest_length > 0 else 2
+        col_width = longest_length + 2 if longest_length > 0 else 2
 
         # Calculate number of columns that fit
         num_cols = max(1, term_width // col_width)
@@ -661,28 +663,17 @@ class InteractiveShell(cmd.Cmd):
                     print("^C")
                     line = ""
 
-            # Handle TAB completion on empty line
-            if line == "\t":
-                print()  # Newline before grid
-                if self.current_service:
-                    self._display_grid(get_service_methods(self.current_service))
-                else:
-                    services = get_device_available_services(self.client)
-                    commands = self.base_commands
-                    self._display_grid(services + commands)
-                line = ""  # Reset line to show prompt again
-
             line = self.precmd(line)
             stop = self.onecmd(line)
             stop = self.postcmd(stop, line)
 
-    def columnize(self, list, displaywidth=80):
+    def columnize(self, items, displaywidth=80):
         """Override columnize to use grid format for TAB completion"""
-        if not list:
+        if not items:
             return
 
         # Use our grid display for TAB completion with coloring enabled
-        self._display_grid(list, force_recalc=True)
+        self._display_grid(items)
 
     def print_topics(self, header, cmds, cmdlen, maxcol):
         """Override print_topics to use grid format for TAB completion"""
@@ -694,7 +685,7 @@ class InteractiveShell(cmd.Cmd):
             self.stdout.write("%s\n" % str(header))
 
         # Use our grid display for TAB completion with coloring enabled
-        self._display_grid(cmds, force_recalc=True)
+        self._display_grid(cmds)
 
     def do_capabilities(self, line):
         """Show device capabilities in service format"""
@@ -933,7 +924,7 @@ class InteractiveShell(cmd.Cmd):
             return
 
         if not operation_name:
-            print(f"Usage: {colorize('type <operation_name>', 'yellow')}")
+            print("Usage: type <operation_name>")
             return
 
         if not hasattr(self.current_service, operation_name):
@@ -1394,7 +1385,7 @@ class InteractiveShell(cmd.Cmd):
             super().do_help(line)
         else:
             help_text = f"""
-{colorize('ONVIF Interactive Shell Commands - v0.1.5', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
+{colorize('ONVIF Interactive Shell Commands - v0.1.6', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
 
 {colorize('Basic Commands:', 'yellow')}
   capabilities, caps       - Show device capabilities

{onvif_python-0.1.5 → onvif_python-0.1.6}/onvif/cli/main.py

@@ -8,6 +8,7 @@ from typing import Any, Optional, Tuple
 
 from ..client import ONVIFClient
 from ..operator import CacheMode
+from ..utils.discovery import ONVIFDiscovery
 from .interactive import InteractiveShell
 from .utils import parse_json_params, colorize
 
@@ -16,7 +17,7 @@ def create_parser():
     """Create argument parser for ONVIF CLI"""
     parser = argparse.ArgumentParser(
         prog="onvif",
-        description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v0.1.5\nhttps://github.com/nirsimetri/onvif-python",
+        description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v0.1.6\nhttps://github.com/nirsimetri/onvif-python",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog=f"""
 Examples:
@@ -138,7 +139,7 @@ def main():
 
     # Show ONVIF CLI version
     if args.version:
-        print(colorize("0.1.5", "yellow"))
+        print(colorize("0.1.6", "yellow"))
         sys.exit(0)
 
     # Validate arguments early (before discovery)
@@ -287,36 +288,10 @@ def discover_devices(timeout: int = 4, prefer_https: bool = False) -> list:
     Returns:
         List of discovered devices with connection info
     """
-    import socket
-    import uuid
-    import xml.etree.ElementTree as ET
-    import struct
-
-    WS_DISCOVERY_PORT = 3702
-    WS_DISCOVERY_ADDRESS_IPv4 = "239.255.255.250"
-
-    # WS-Discovery Probe message
-    WS_DISCOVERY_PROBE_MESSAGE = (
-        '<?xml version="1.0" encoding="UTF-8"?>'
-        '<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" '
-        'xmlns:tds="http://www.onvif.org/ver10/device/wsdl" '
-        'xmlns:tns="http://schemas.xmlsoap.org/ws/2005/04/discovery" '
-        'xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">'
-        "<soap:Header>"
-        "<wsa:Action>http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe</wsa:Action>"
-        "<wsa:MessageID>urn:uuid:{uuid}</wsa:MessageID>"
-        "<wsa:To>urn:schemas-xmlsoap-org:ws:2005:04:discovery</wsa:To>"
-        "</soap:Header>"
-        "<soap:Body>"
-        "<tns:Probe>"
-        "<tns:Types>tds:Device</tns:Types>"
-        "</tns:Probe>"
-        "</soap:Body>"
-        "</soap:Envelope>"
-    )
-
-    # Get local network interface
+    # Get local network interface for display
     try:
+        import socket
+
         s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         s.connect(("8.8.8.8", 80))
         local_ip = s.getsockname()[0]
@@ -328,134 +303,9 @@ def discover_devices(timeout: int = 4, prefer_https: bool = False) -> list:
     print(f"Network interface: {colorize(local_ip, 'white')}")
     print(f"Timeout: {timeout}s\n")
 
-    probe_uuid = str(uuid.uuid4())
-    probe = WS_DISCOVERY_PROBE_MESSAGE.format(uuid=probe_uuid)
-
-    responses = []
-
-    try:
-        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
-        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-        sock.bind((local_ip, 0))
-        sock.settimeout(timeout)
-
-        ttl = struct.pack("b", 1)
-        sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl)
-
-        sock.sendto(
-            probe.encode("utf-8"), (WS_DISCOVERY_ADDRESS_IPv4, WS_DISCOVERY_PORT)
-        )
-
-        while True:
-            try:
-                data, addr = sock.recvfrom(8192)
-                response = data.decode("utf-8", errors="ignore").strip()
-
-                if response and len(response) > 10:
-                    if response.startswith("<?xml") or response.startswith("<"):
-                        responses.append({"xml": response, "address": addr[0]})
-
-            except socket.timeout:
-                break
-            except Exception:
-                break
-
-        sock.close()
-
-    except Exception as e:
-        print(f"{colorize('Error during discovery:', 'red')} {e}")
-        return []
-
-    # Parse responses
-    devices = []
-    namespaces = {
-        "soap": "http://www.w3.org/2003/05/soap-envelope",
-        "wsa": "http://schemas.xmlsoap.org/ws/2004/08/addressing",
-        "wsd": "http://schemas.xmlsoap.org/ws/2005/04/discovery",
-        "d": "http://schemas.xmlsoap.org/ws/2005/04/discovery",
-    }
-
-    for resp in responses:
-        try:
-            root = ET.fromstring(resp["xml"])
-            probe_match = root.find(".//d:ProbeMatch", namespaces) or root.find(
-                ".//wsd:ProbeMatch", namespaces
-            )
-
-            if probe_match is None:
-                continue
-
-            device_info = {
-                "epr": "",
-                "types": [],
-                "scopes": [],
-                "xaddrs": [],
-                "host": None,
-                "port": 80,
-                "use_https": False,  # Auto-detect HTTPS from XAddrs
-            }
-
-            epr = probe_match.find(".//wsa:EndpointReference/wsa:Address", namespaces)
-            if epr is not None:
-                device_info["epr"] = epr.text
-
-            types_elem = probe_match.find(".//d:Types", namespaces) or probe_match.find(
-                ".//wsd:Types", namespaces
-            )
-            if types_elem is not None and types_elem.text:
-                device_info["types"] = types_elem.text.split()
-
-            scopes_elem = probe_match.find(
-                ".//d:Scopes", namespaces
-            ) or probe_match.find(".//wsd:Scopes", namespaces)
-            if scopes_elem is not None and scopes_elem.text:
-                device_info["scopes"] = scopes_elem.text.split()
-
-            xaddrs_elem = probe_match.find(
-                ".//d:XAddrs", namespaces
-            ) or probe_match.find(".//wsd:XAddrs", namespaces)
-            if xaddrs_elem is not None and xaddrs_elem.text:
-                device_info["xaddrs"] = xaddrs_elem.text.split()
-
-                # Extract host, port, and protocol from XAddrs
-                # Use prefer_https parameter to decide which XAddr to use
-                if device_info["xaddrs"]:
-                    # Select XAddr based on prefer_https flag
-                    if prefer_https:
-                        # Try to find HTTPS XAddr first if prefer_https=True
-                        https_xaddr = next(
-                            (
-                                x
-                                for x in device_info["xaddrs"]
-                                if x.startswith("https://")
-                            ),
-                            None,
-                        )
-                        xaddr = https_xaddr or device_info["xaddrs"][0]
-                    else:
-                        # Use first XAddr (usually HTTP) if prefer_https=False
-                        xaddr = device_info["xaddrs"][0]
-
-                    if "://" in xaddr:
-                        # Detect protocol
-                        protocol = xaddr.split("://")[0]
-                        device_info["use_https"] = protocol == "https"
-
-                        # Extract host and port
-                        parts = xaddr.split("://")[1].split("/")[0]
-                        if ":" in parts:
-                            device_info["host"] = parts.split(":")[0]
-                            device_info["port"] = int(parts.split(":")[1])
-                        else:
-                            device_info["host"] = parts
-                            # Set default port based on protocol
-                            device_info["port"] = 443 if protocol == "https" else 80
-
-            if device_info["host"]:
-                devices.append(device_info)
-
-        except Exception:
-            continue
+    # Use ONVIFDiscovery class
+    discovery = ONVIFDiscovery(timeout=timeout)
+    devices = discovery.discover(prefer_https=prefer_https)
 
     return devices
 

{onvif_python-0.1.5 → onvif_python-0.1.6}/onvif/utils/__init__.py

@@ -5,6 +5,7 @@ from .exceptions import ONVIFOperationException
 from .zeep import ZeepPatcher
 from .xml_capture import XMLCapturePlugin
 from .error_handlers import ONVIFErrorHandler
+from .discovery import ONVIFDiscovery
 
 
 __all__ = [
@@ -13,4 +14,5 @@ __all__ = [
     "ZeepPatcher",
     "XMLCapturePlugin",
     "ONVIFErrorHandler",
+    "ONVIFDiscovery",
 ]