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

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

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.1.5
+Version: 0.1.7
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
 License-Expression: MIT
+Project-URL: Homepage, https://github.com/nirsimetri/onvif-python
 Project-URL: Documentation, https://deepwiki.com/nirsimetri/onvif-python
 Project-URL: Changelog, https://github.com/nirsimetri/onvif-python/releases
 Keywords: onvif,Camera,onvif-python,ip-camera,cctv,soap,surveillance,cctv cameras,soap-client,onvif-client,onvif-library,onvif-specifications
@@ -40,7 +41,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.7-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 +93,33 @@ 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()
+
+# Or with
+# Discover with search filter by types or scopes (case-insensitive substring match)
+devices = discovery.discover(search="Profile/Streaming")
+
+# 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 +136,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 +155,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 +165,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 +198,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.
@@ -211,11 +237,12 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 <summary><b>1. Direct CLI</b></summary> 
 
 ```bash
-usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password PASSWORD] [--discover] [--timeout TIMEOUT] [--https] [--no-verify]
-             [--no-patch] [--interactive] [--debug] [--wsdl WSDL] [--cache {all,db,mem,none}] [--health-check-interval HEALTH_CHECK_INTERVAL] [--version]
+usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password PASSWORD] [--discover] [--search SEARCH] [--timeout TIMEOUT] [--https]
+             [--no-verify] [--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.7
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -232,6 +259,8 @@ options:
   --password PASSWORD, -p PASSWORD
                         Password for authentication
   --discover, -d        Discover ONVIF devices on the network using WS-Discovery
+  --search SEARCH, -s SEARCH
+                        Filter discovered devices by types or scopes (case-insensitive substring match)
   --timeout TIMEOUT     Connection timeout in seconds (default: 10)
   --https               Use HTTPS instead of HTTP
   --no-verify           Disable SSL certificate verification
@@ -251,6 +280,11 @@ Examples:
   onvif media GetProfiles --discover --username admin
   onvif -d -i
 
+  # Discover with filtering
+  onvif --discover --search ptz --interactive
+  onvif -d -s "C210" -i
+  onvif -d -s "audio_encoder" -u admin -p admin123 -i
+
   # Direct command execution
   onvif devicemgmt GetCapabilities Category=All --host 192.168.1.17 --port 8000 --username admin --password admin123
   onvif ptz ContinuousMove ProfileToken=Profile_1 Velocity={"PanTilt": {"x": -0.1, "y": 0}} --host 192.168.1.17 --port 8000 --username admin --password admin123
@@ -272,7 +306,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell Commands - v0.1.5
+ONVIF Interactive Shell — v0.1.7
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:
@@ -405,6 +439,10 @@ onvif --discover --username admin --password admin123 --interactive
 # Short form
 onvif -d -u admin -p admin123 -i
 
+# Discover with search filter
+onvif --discover --search "C210" --interactive
+onvif -d -s ptz -u admin -p admin123 -i
+
 # Discover and interactive (will prompt for credentials)
 onvif -d -i
 ```

{onvif_python-0.1.5 → onvif_python-0.1.7}/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.7-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,33 @@ 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()
+
+# Or with
+# Discover with search filter by types or scopes (case-insensitive substring match)
+devices = discovery.discover(search="Profile/Streaming")
+
+# 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 +97,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 +116,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 +126,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 +159,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.
@@ -173,11 +198,12 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 <summary><b>1. Direct CLI</b></summary> 
 
 ```bash
-usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password PASSWORD] [--discover] [--timeout TIMEOUT] [--https] [--no-verify]
-             [--no-patch] [--interactive] [--debug] [--wsdl WSDL] [--cache {all,db,mem,none}] [--health-check-interval HEALTH_CHECK_INTERVAL] [--version]
+usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password PASSWORD] [--discover] [--search SEARCH] [--timeout TIMEOUT] [--https]
+             [--no-verify] [--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.7
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -194,6 +220,8 @@ options:
   --password PASSWORD, -p PASSWORD
                         Password for authentication
   --discover, -d        Discover ONVIF devices on the network using WS-Discovery
+  --search SEARCH, -s SEARCH
+                        Filter discovered devices by types or scopes (case-insensitive substring match)
   --timeout TIMEOUT     Connection timeout in seconds (default: 10)
   --https               Use HTTPS instead of HTTP
   --no-verify           Disable SSL certificate verification
@@ -213,6 +241,11 @@ Examples:
   onvif media GetProfiles --discover --username admin
   onvif -d -i
 
+  # Discover with filtering
+  onvif --discover --search ptz --interactive
+  onvif -d -s "C210" -i
+  onvif -d -s "audio_encoder" -u admin -p admin123 -i
+
   # Direct command execution
   onvif devicemgmt GetCapabilities Category=All --host 192.168.1.17 --port 8000 --username admin --password admin123
   onvif ptz ContinuousMove ProfileToken=Profile_1 Velocity={"PanTilt": {"x": -0.1, "y": 0}} --host 192.168.1.17 --port 8000 --username admin --password admin123
@@ -234,7 +267,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell Commands - v0.1.5
+ONVIF Interactive Shell — v0.1.7
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:
@@ -367,6 +400,10 @@ onvif --discover --username admin --password admin123 --interactive
 # Short form
 onvif -d -u admin -p admin123 -i
 
+# Discover with search filter
+onvif --discover --search "C210" --interactive
+onvif -d -s ptz -u admin -p admin123 -i
+
 # Discover and interactive (will prompt for credentials)
 onvif -d -i
 ```

{onvif_python-0.1.5 → onvif_python-0.1.7}/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.7}/onvif/cli/interactive.py

@@ -191,7 +191,7 @@ class InteractiveShell(cmd.Cmd):
             "  / __ \\/ | / / |  / /  _/ ____/",
             " / / / /  |/ /| | / // // /_    ",
             "/ /_/ / /|  / | |/ // // __/    ",
-            "\\____/_/ |_/  |___/___/_/  v0.1.5",
+            "\\____/_/ |_/  |___/___/_/  v0.1.7",
             "                                ",
         ]
 
@@ -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 — v0.1.7', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
 
 {colorize('Basic Commands:', 'yellow')}
   capabilities, caps       - Show device capabilities