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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.1.4
+Version: 0.1.5
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -38,9 +38,9 @@ Dynamic: license-file
 
 # ONVIF Python
 
-[![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-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.4-orange?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.5-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)
@@ -212,10 +212,10 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 
 ```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}] [--version]
+             [--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.4
+ONVIF Terminal Client — v0.1.5
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -241,6 +241,8 @@ options:
   --wsdl WSDL           Custom WSDL directory path
   --cache {all,db,mem,none}
                         Caching mode for ONVIFClient (default: all). 'all': memory+disk, 'db': disk-only, 'mem': memory-only, 'none': disabled.
+  --health-check-interval HEALTH_CHECK_INTERVAL, -hci HEALTH_CHECK_INTERVAL
+                        Health check interval in seconds for interactive mode (default: 10)
   --version, -v         Show ONVIF CLI version and exit
 
 Examples:
@@ -270,7 +272,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell Commands - v0.1.4
+ONVIF Interactive Shell Commands - v0.1.5
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:
@@ -282,6 +284,7 @@ Basic Commands:
 
 Navigation Commands:
   <service>                - Enter service mode (e.g., devicemgmt, media)
+  <service> <argument>     - Enter service mode with argument (e.g. pullpoint SubscriptionRef=<value>)
   cd <service>             - Enter service mode (alias)
   ls                       - List commands/services/methods in grid format
   up                       - Exit current service mode (go up one level)
@@ -301,6 +304,7 @@ Method Execution:
 Data Management:
   store <name>             - Store last result with a name
   show <name>              - Show stored data
+  show <name>[0]           - Show element at index (for lists)
   show <name>.attribute    - Show specific attribute
   show                     - List all stored data
   rm <name>                - Remove stored data by name
@@ -368,6 +372,27 @@ If you omit the username or password, you will be prompted to enter them securel
 > [!IMPORTANT]
 > You can see all the other commands available in the interactive shell by trying it out directly. The interactive shell runs periodic background health checks to detect connection loss. It uses silent TCP pings to avoid interrupting your work and will automatically exit if the device is unreachable, similar to an SSH session.
 
+**Command Chaining with `&&`:**
+
+The CLI supports chaining multiple commands in a single line using the `&&` operator, allowing you to execute sequential operations efficiently:
+
+```bash
+# Enter service and execute method in one line
+192.168.1.17:8000 > media && GetProfiles && store profiles
+
+# Chain multiple method calls
+192.168.1.17:8000 > devicemgmt && GetDeviceInformation && store device_info
+
+# Complex workflow
+192.168.1.17:8000 > media && GetProfiles && store profiles && up && imaging && GetImagingSettings VideoSourceToken=$profiles[0].VideoSourceConfiguration.SourceToken
+```
+
+This feature is particularly useful for:
+- Quick operations without entering service mode
+- Scripting repetitive tasks
+- Testing workflows
+- Automating multi-step procedures
+
 **2. Device Discovery (WS-Discovery)**
 
 The CLI includes automatic ONVIF device discovery using the WS-Discovery protocol. This feature allows you to find all ONVIF-compliant devices on your local network without knowing their IP addresses beforehand.
@@ -491,7 +516,7 @@ The `ONVIFClient` class provides various configuration options to customize the
 
 | Parameter | Type | Required | Default | Description |
 |-----------|------|----------|---------|-------------|
-| `cache` | `CacheMode` | ❌ No | `CacheMode.ALL` | WSDL caching strategy (see [Cache Modes](#cache-modes) below) |
+| `cache` | `CacheMode` | ❌ No | `CacheMode.ALL` | WSDL caching strategy (see **Cache Modes** below) |
 
 </details>
 

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

@@ -1,8 +1,8 @@
 # ONVIF Python
 
-[![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-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.4-orange?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.5-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)
@@ -174,10 +174,10 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 
 ```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}] [--version]
+             [--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.4
+ONVIF Terminal Client — v0.1.5
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -203,6 +203,8 @@ options:
   --wsdl WSDL           Custom WSDL directory path
   --cache {all,db,mem,none}
                         Caching mode for ONVIFClient (default: all). 'all': memory+disk, 'db': disk-only, 'mem': memory-only, 'none': disabled.
+  --health-check-interval HEALTH_CHECK_INTERVAL, -hci HEALTH_CHECK_INTERVAL
+                        Health check interval in seconds for interactive mode (default: 10)
   --version, -v         Show ONVIF CLI version and exit
 
 Examples:
@@ -232,7 +234,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell Commands - v0.1.4
+ONVIF Interactive Shell Commands - v0.1.5
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:
@@ -244,6 +246,7 @@ Basic Commands:
 
 Navigation Commands:
   <service>                - Enter service mode (e.g., devicemgmt, media)
+  <service> <argument>     - Enter service mode with argument (e.g. pullpoint SubscriptionRef=<value>)
   cd <service>             - Enter service mode (alias)
   ls                       - List commands/services/methods in grid format
   up                       - Exit current service mode (go up one level)
@@ -263,6 +266,7 @@ Method Execution:
 Data Management:
   store <name>             - Store last result with a name
   show <name>              - Show stored data
+  show <name>[0]           - Show element at index (for lists)
   show <name>.attribute    - Show specific attribute
   show                     - List all stored data
   rm <name>                - Remove stored data by name
@@ -330,6 +334,27 @@ If you omit the username or password, you will be prompted to enter them securel
 > [!IMPORTANT]
 > You can see all the other commands available in the interactive shell by trying it out directly. The interactive shell runs periodic background health checks to detect connection loss. It uses silent TCP pings to avoid interrupting your work and will automatically exit if the device is unreachable, similar to an SSH session.
 
+**Command Chaining with `&&`:**
+
+The CLI supports chaining multiple commands in a single line using the `&&` operator, allowing you to execute sequential operations efficiently:
+
+```bash
+# Enter service and execute method in one line
+192.168.1.17:8000 > media && GetProfiles && store profiles
+
+# Chain multiple method calls
+192.168.1.17:8000 > devicemgmt && GetDeviceInformation && store device_info
+
+# Complex workflow
+192.168.1.17:8000 > media && GetProfiles && store profiles && up && imaging && GetImagingSettings VideoSourceToken=$profiles[0].VideoSourceConfiguration.SourceToken
+```
+
+This feature is particularly useful for:
+- Quick operations without entering service mode
+- Scripting repetitive tasks
+- Testing workflows
+- Automating multi-step procedures
+
 **2. Device Discovery (WS-Discovery)**
 
 The CLI includes automatic ONVIF device discovery using the WS-Discovery protocol. This feature allows you to find all ONVIF-compliant devices on your local network without knowing their IP addresses beforehand.
@@ -453,7 +478,7 @@ The `ONVIFClient` class provides various configuration options to customize the
 
 | Parameter | Type | Required | Default | Description |
 |-----------|------|----------|---------|-------------|
-| `cache` | `CacheMode` | ❌ No | `CacheMode.ALL` | WSDL caching strategy (see [Cache Modes](#cache-modes) below) |
+| `cache` | `CacheMode` | ❌ No | `CacheMode.ALL` | WSDL caching strategy (see **Cache Modes** below) |
 
 </details>
 

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

@@ -18,6 +18,7 @@ from ..utils.exceptions import ONVIFOperationException
 from .utils import (
     parse_json_params,
     get_service_methods,
+    get_service_required_args,
     get_device_available_services,
     colorize,
     format_capabilities_as_services,
@@ -172,6 +173,13 @@ class InteractiveShell(cmd.Cmd):
         if hasattr(args, "no_patch") and args.no_patch:
             options_info.append(f"  ZeepPatcher   : {colorize('Disabled', 'red')}")
 
+        if (
+            hasattr(args, "health_check_interval") and args.health_check_interval != 10
+        ):  # 10 is default
+            options_info.append(
+                f"  Health Check  : every {colorize(f'{args.health_check_interval}s', 'yellow')}"
+            )
+
         # Format options info
         options_display = ""
         if options_info:
@@ -183,7 +191,7 @@ class InteractiveShell(cmd.Cmd):
             "  / __ \\/ | / / |  / /  _/ ____/",
             " / / / /  |/ /| | / // // /_    ",
             "/ /_/ / /|  / | |/ // // __/    ",
-            "\\____/_/ |_/  |___/___/_/  v0.1.4",
+            "\\____/_/ |_/  |___/___/_/  v0.1.5",
             "                                ",
         ]
 
@@ -223,8 +231,11 @@ class InteractiveShell(cmd.Cmd):
 
     def _periodic_health_check(self):
         """Periodically checks device connection using TCP or TLS depending on mode."""
+        # Get health check interval from args, default to 10 seconds
+        health_check_interval = getattr(self.args, "health_check_interval", 10)
+
         # Wait before first check to allow intro to finish
-        self._stop_health_check.wait(10.0)
+        self._stop_health_check.wait(health_check_interval)
 
         while not self._stop_health_check.is_set():
             sock = None
@@ -236,6 +247,7 @@ class InteractiveShell(cmd.Cmd):
                 # If HTTPS, perform a short TLS handshake check
                 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
 
@@ -279,7 +291,7 @@ class InteractiveShell(cmd.Cmd):
                     sock.close()
 
             # Wait before next check or stop signal
-            self._stop_health_check.wait(5.0)  # Check every 5 seconds
+            self._stop_health_check.wait(health_check_interval)
 
     def _handle_connection_error(self, e):
         """Handle connection errors by notifying the user and exiting."""
@@ -549,8 +561,17 @@ class InteractiveShell(cmd.Cmd):
 
     def default(self, line):
         """Handle unknown commands"""
-        # Check if it's a service call using device-specific services
-        if line in get_device_available_services(self.client):
+        available_services = get_device_available_services(self.client)
+
+        # Check if it's a service call (with or without arguments)
+        # Extract first word to check if it's a service name
+        first_word = line.split()[0] if line.split() else line
+
+        if first_word in available_services:
+            return self.do_enter_service(line)
+
+        # Check if the whole line (without arguments) is a service
+        if line in available_services:
             return self.do_enter_service(line)
 
         # Check if it's a method call in service context
@@ -721,8 +742,13 @@ class InteractiveShell(cmd.Cmd):
             else:
                 print(f"{colorize('Error:', 'red')} {e}")
 
-    def do_enter_service(self, service_name):
-        """Enter service mode"""
+    def do_enter_service(self, line):
+        """Enter service mode with optional arguments for services that require them"""
+        # Parse service name and arguments
+        parts = line.split(None, 1)
+        service_name = parts[0] if parts else ""
+        args_str = parts[1] if len(parts) > 1 else ""
+
         available_services = get_device_available_services(self.client)
         if service_name not in available_services:
             print(f"{colorize('Error:', 'red')} Unknown service '{service_name}'")
@@ -731,7 +757,63 @@ class InteractiveShell(cmd.Cmd):
             return
 
         try:
-            service = getattr(self.client, service_name)()
+            # Check if this service requires arguments
+            required_args = get_service_required_args(service_name)
+
+            if required_args:
+                # Service requires arguments
+                if not args_str:
+                    # No arguments provided, show help
+                    print(
+                        f"{colorize('Error:', 'red')} Service '{service_name}' requires arguments"
+                    )
+                    print(
+                        f"{colorize('Usage:', 'yellow')} {service_name} {' '.join([f'{arg}=<value>' for arg in required_args])}"
+                    )
+                    print(
+                        f"{colorize('Example:', 'yellow')} {service_name} {required_args[0]}=$subscription"
+                    )
+                    return
+
+                # Parse arguments
+                try:
+                    parsed_args = parse_json_params(args_str)
+                except Exception as e:
+                    print(f"{colorize('Error parsing arguments:', 'red')} {e}")
+                    return
+
+                # Check if all required arguments are provided
+                missing_args = [arg for arg in required_args if arg not in parsed_args]
+                if missing_args:
+                    print(
+                        f"{colorize('Error:', 'red')} Missing required arguments: {', '.join(missing_args)}"
+                    )
+                    print(
+                        f"{colorize('Usage:', 'yellow')} {service_name} {' '.join([f'{arg}=<value>' for arg in required_args])}"
+                    )
+                    return
+
+                # Resolve stored references in arguments
+                for arg_name in required_args:
+                    arg_value = parsed_args[arg_name]
+                    if isinstance(arg_value, str) and arg_value.startswith("$"):
+                        # Resolve stored reference
+                        reference = arg_value[1:]  # Remove $ prefix
+                        resolved_value = self._resolve_stored_reference(reference)
+                        if resolved_value is None:
+                            print(
+                                f"{colorize('Error:', 'red')} Could not resolve reference '{arg_value}'"
+                            )
+                            return
+                        parsed_args[arg_name] = resolved_value
+
+                # Call service method with arguments
+                service_method = getattr(self.client, service_name)
+                service = service_method(**parsed_args)
+            else:
+                # Service doesn't require arguments
+                service = getattr(self.client, service_name)()
+
             self.current_service = service
             self.current_service_name = service_name
             self.update_prompt()
@@ -756,6 +838,10 @@ class InteractiveShell(cmd.Cmd):
 
         except Exception as e:
             print(f"{colorize('Error entering service:', 'red')} {e}")
+            if self.args.debug:
+                import traceback
+
+                traceback.print_exc()
 
     def do_ls(self, line):
         """List available commands/services like TAB completion"""
@@ -843,7 +929,7 @@ class InteractiveShell(cmd.Cmd):
             print(
                 f"{colorize('Error:', 'red')} You must be in a service mode to use 'type'."
             )
-            print(f"Enter a service first (e.g., {colorize('d', 'yellow')})")
+            print(f"Enter a service first (e.g., {colorize('devicemgmt', 'yellow')})")
             return
 
         if not operation_name:
@@ -1191,6 +1277,14 @@ class InteractiveShell(cmd.Cmd):
         if hasattr(self.args, "no_patch") and self.args.no_patch:
             options_info.append(f"  ZeepPatcher   : {colorize('Disabled', 'red')}")
 
+        if (
+            hasattr(self.args, "health_check_interval")
+            and self.args.health_check_interval != 10
+        ):  # 10 is default
+            options_info.append(
+                f"  Health Check  : every {colorize(f'{self.args.health_check_interval}s', 'yellow')}"
+            )
+
         # Format options info
         options_display = ""
         if options_info:
@@ -1300,7 +1394,7 @@ class InteractiveShell(cmd.Cmd):
             super().do_help(line)
         else:
             help_text = f"""
-{colorize('ONVIF Interactive Shell Commands - v0.1.4', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
+{colorize('ONVIF Interactive Shell Commands - v0.1.5', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
 
 {colorize('Basic Commands:', 'yellow')}
   capabilities, caps       - Show device capabilities
@@ -1311,6 +1405,7 @@ class InteractiveShell(cmd.Cmd):
 
 {colorize('Navigation Commands:', 'yellow')}
   <service>                - Enter service mode (e.g., devicemgmt, media)
+  <service> <argument>     - Enter service mode with argument (e.g. pullpoint SubscriptionRef=<value>)
   cd <service>             - Enter service mode (alias)
   ls                       - List commands/services/methods in grid format
   up                       - Exit current service mode (go up one level)

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

@@ -16,7 +16,7 @@ def create_parser():
     """Create argument parser for ONVIF CLI"""
     parser = argparse.ArgumentParser(
         prog="onvif",
-        description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v0.1.4\nhttps://github.com/nirsimetri/onvif-python",
+        description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v0.1.5\nhttps://github.com/nirsimetri/onvif-python",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog=f"""
 Examples:
@@ -93,6 +93,13 @@ Examples:
         help="Caching mode for ONVIFClient (default: all). "
         "'all': memory+disk, 'db': disk-only, 'mem': memory-only, 'none': disabled.",
     )
+    parser.add_argument(
+        "--health-check-interval",
+        "-hci",
+        type=int,
+        default=10,
+        help="Health check interval in seconds for interactive mode (default: 10)",
+    )
 
     # Service and method (for direct command execution)
     parser.add_argument(
@@ -131,7 +138,7 @@ def main():
 
     # Show ONVIF CLI version
     if args.version:
-        print(colorize("0.1.4", "yellow"))
+        print(colorize("0.1.5", "yellow"))
         sys.exit(0)
 
     # Validate arguments early (before discovery)
@@ -151,14 +158,14 @@ def main():
         devices = discover_devices(timeout=4, prefer_https=args.https)
 
         if not devices:
-            print(f"\n{colorize('No ONVIF devices discovered. Exiting.', 'red')}")
+            print(colorize("No ONVIF devices discovered. Exiting.", "red"))
             sys.exit(1)
 
         # Let user select a device
         selected = select_device_interactive(devices)
 
         if selected is None:
-            print(f"{colorize('Device selection cancelled.', 'cyan')}")
+            print(colorize("Device selection cancelled.", "cyan"))
             sys.exit(0)
 
         # Set host, port, and HTTPS from selected device
@@ -523,10 +530,10 @@ def select_device_interactive(devices: list) -> Optional[Tuple[str, int, bool]]:
                     selected.get("use_https", False),
                 )
             else:
-                print(f"{colorize('Invalid selection. Please try again.', 'red')}")
+                print(colorize("Invalid selection. Please try again.", "red"))
 
         except ValueError:
-            print(f"{colorize('Invalid input. Please enter a number.', 'red')}")
+            print(colorize("Invalid input. Please enter a number.", "red"))
         except (EOFError, KeyboardInterrupt):
             return None