onvif-python 0.1.1__tar.gz → 0.1.3__tar.gz

{onvif_python-0.1.1/onvif_python.egg-info → onvif_python-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.1.1
+Version: 0.1.3
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -39,11 +39,12 @@ 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)
-[![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.1.1-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nirsimetri/onvif-python)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.3-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>
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.1-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)
+[![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)
+[![Upload Python Package](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml/badge.svg)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml)
 
 **This project provides a comprehensive and developer-friendly Python library for working with ONVIF-compliant devices.** It is designed to be reliable, easy to integrate, and flexible enough to support a wide range of ONVIF profiles and services.  
 
@@ -161,7 +162,12 @@ Explore more advanced usage and service-specific operations in the [`examples/`]
 ## ONVIF CLI
 
 > [!NOTE]
-> The CLI is automatically installed when you install the `onvif-python` see [Installation](#installation). This feature has been available since onvif-python version [0.1.0](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.1)
+> The CLI is automatically installed when you install the `onvif-python` see [Installation](#installation). This feature has been available since `onvif-python` version [`0.1.1`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.1).
+
+![Windows](https://img.shields.io/badge/Windows-0078D6?style=plastic&logo=gitforwindows&logoColor=white)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=plastic&logo=linux&logoColor=black)
+![macOS](https://img.shields.io/badge/macOS-1A9FEE?style=plastic&logo=apple&logoColor=black)
+![Raspberry Pi](https://img.shields.io/badge/Raspberry%20Pi-A22846?style=plastic&logo=raspberrypi&logoColor=black)
 
 This library includes a powerful command-line interface (CLI) for interacting with ONVIF devices directly from your terminal. It supports both direct command execution and an interactive shell mode, providing a flexible and efficient way to manage and debug ONVIF devices.
 
@@ -172,7 +178,164 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 - **Automatic Discovery:** Automatically detects available services on the device.
 - **Connection Management:** Supports HTTP/HTTPS, custom timeouts, and SSL verification.
 - **Data Management:** Store results from commands and use them as parameters in subsequent commands.
-- **Cross-Platform:** Works on Windows, macOS, and Linux.
+- **Cross-Platform:** Works on Windows, macOS, Linux, and Raspberry Pi.
+
+### Screenshoot
+
+<table>
+  <tr>
+    <td width="34.2%">
+      <a href="https://github.com/nirsimetri/onvif-python">
+        <img src="https://raw.githubusercontent.com/nirsimetri/onvif-python/refs/heads/main/assets/onvif_cli.png" />
+      </a>
+    </td>
+    <td width="65.8%">
+        <a href="https://github.com/nirsimetri/onvif-python">
+        <img src="https://raw.githubusercontent.com/nirsimetri/onvif-python/refs/heads/main/assets/onvif_operations.png" />
+        </a>
+    </td>
+  </tr>
+  <tr>
+    <th align="center">
+      Onboarding
+    </th>
+    <th align="center">
+      List available operations
+    </th>
+  </tr>
+</table>
+
+### Help Command
+
+<details>
+<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}]
+             [service] [method] [params ...]
+
+ONVIF Terminal Client —
+https://github.com/nirsimetri/onvif-python
+
+positional arguments:
+  service               ONVIF service name (e.g., devicemgmt, media, ptz)
+  method                Service method name (e.g., GetCapabilities, GetProfiles)
+  params                Method parameters as Simple Parameter or JSON string
+
+options:
+  -h, --help            show this help message and exit
+  --host HOST, -H HOST  ONVIF device IP address or hostname
+  --port PORT, -P PORT  ONVIF device port (default: 80)
+  --username USERNAME, -u USERNAME
+                        Username for authentication
+  --password PASSWORD, -p PASSWORD
+                        Password for authentication
+  --discover, -d        Discover ONVIF devices on the network using WS-Discovery
+  --timeout TIMEOUT     Connection timeout in seconds (default: 10)
+  --https               Use HTTPS instead of HTTP
+  --no-verify           Disable SSL certificate verification
+  --no-patch            Disable ZeepPatcher
+  --interactive, -i     Start interactive mode
+  --debug               Enable debug mode with XML capture
+  --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.
+
+Examples:
+  # Discover ONVIF devices on network
+  onvif --discover --username admin --password admin123 --interactive
+  onvif media GetProfiles --discover --username admin
+  onvif -d -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
+
+  # Interactive mode
+  onvif --host 192.168.1.17 --port 8000 --username admin --password admin123 --interactive
+
+  # Prompting for username and password
+  # (if not provided)
+  onvif -H 192.168.1.17 -P 8000 -i
+
+  # Using HTTPS
+  onvif media GetProfiles --host camera.example.com --port 443 --username admin --password admin123 --https
+```
+
+</details>
+
+<details>
+<summary><b>2. Interactive Shell</b></summary> 
+
+```bash
+ONVIF Interactive Shell Commands -
+https://github.com/nirsimetri/onvif-python
+
+Basic Commands:
+  capabilities, caps       - Show device capabilities
+  services                 - Show available services with details
+  info                     - Show connection and device information
+  exit, quit               - Exit the shell
+  shortcuts                - Show available shortcuts
+  help <command>           - Show help for a specific command
+
+Navigation Commands:
+  <service>                - Enter service mode (e.g., devicemgmt, media)
+  cd <service>             - Enter service mode (alias)
+  ls                       - List commands/services/methods in grid format
+  up                       - Exit current service mode (go up one level)
+  pwd                      - Show current service context
+  clear                    - Clear terminal screen
+
+Service Mode Commands:
+  desc <method>            - Show method documentation
+  type <method>            - Show input/output types from WSDL
+
+Method Execution:
+  <method>                 - Execute method without parameters
+  <method> {"param": "value"}  - Execute method with JSON parameters
+  <method> param=value     - Execute method with simple parameters
+
+Data Management:
+  store <name>             - Store last result with a name
+  show <name>              - Show stored data
+  show <name>.attribute    - Show specific attribute
+  show                     - List all stored data
+  rm <name>                - Remove stored data by name
+  cls                      - Clear all stored data
+
+Using Stored Data in Methods:
+  Use $variable syntax to reference stored data in method parameters:
+  - $profiles[0].token                    - Access list element and attribute
+  - $profiles[0].VideoSourceConfiguration.SourceToken
+
+  Example:
+    GetProfiles                           - Get profiles
+    store profiles                        - Store result
+    show profiles[0].token                - Show first profile token
+    GetImagingSettings VideoSourceToken=$profiles[0].VideoSourceConfiguration.SourceToken
+
+Debug Commands:
+  debug                    - Show last SOAP request & response (if --debug enabled)
+
+Tab Completion:
+  Use TAB key for auto-completion of commands, services, and methods
+  Type partial commands to see suggestions
+
+Examples:
+  192.168.1.17:8000 > caps                # Show capabilities
+  192.168.1.17:8000 > dev<TAB>            # Completes to 'devicemgmt'
+  192.168.1.17:8000 > cd devicemgmt       # Enter device management
+  192.168.1.17:8000/devicemgmt > Get<TAB> # Show methods starting with 'Get'
+  192.168.1.17:8000/devicemgmt > GetServices {"IncludeCapability": true}
+  192.168.1.17:8000/devicemgmt > GetServices IncludeCapability=True
+  192.168.1.17:8000/devicemgmt > store services_info
+  192.168.1.17:8000/devicemgmt > up       # Exit service mode
+  192.168.1.17:8000 >                     # Back to root context
+```
+
+</details>
 
 ### Usage
 
@@ -201,9 +364,78 @@ If you omit the username or password, you will be prompted to enter them securel
 | `show <name>` | Display a stored variable |
 | `exit` / `quit` | Exit the shell |
 
-You can see all the commands available in the interactive shell by trying them directly.
+> [!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.
+
+**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.
+
+**Discover and Connect Interactively:**
+```bash
+# Discover devices and enter interactive mode
+onvif --discover --username admin --password admin123 --interactive
+
+# Short form
+onvif -d -u admin -p admin123 -i
+
+# Discover and interactive (will prompt for credentials)
+onvif -d -i
+```
+
+**Discover and Execute Command:**
+```bash
+# Discover devices and execute a command on the selected device
+onvif media GetProfiles --discover --username admin --password admin123
+
+# Short form
+onvif media GetProfiles -d -u admin -p admin123
+```
+
+**How Device Discovery Works:**
+
+1. **Automatic Network Scanning**: Sends a WS-Discovery Probe message to the multicast address `239.255.255.250:3702`
+2. **Device Detection**: Listens for ProbeMatch responses from ONVIF devices (default timeout: 4 seconds)
+3. **Interactive Selection**: Displays a numbered list of discovered devices with their details:
+   - Device UUID (Endpoint Reference)
+   - XAddrs (ONVIF service URLs)
+   - Device Types (e.g., NetworkVideoTransmitter)
+   - Scopes (name, location, hardware, profile information)
+4. **Connection**: Once you select a device, the CLI automatically connects using the discovered host and port
+
+**Example Discovery Output:**
+```
+Discovering ONVIF devices on network...
+Network interface: 192.168.1.100
+Timeout: 4s
+
+Found 2 ONVIF device(s):
+
+[1] 192.168.1.14:2020
+    [id] uuid:3fa1fe68-b915-4053-a3e1-a8294833fe3c
+    [xaddrs] http://192.168.1.14:2020/onvif/device_service
+    [types] tdn:NetworkVideoTransmitter
+    [scopes] [name/C210] [hardware/C210] [Profile/Streaming] [location/Hong Kong]
+
+[2] 192.168.1.17:8000
+    [id] urn:uuid:7d04ff31-61e6-11f0-a00c-6056eef47207
+    [xaddrs] http://192.168.1.17:8000/onvif/device_service
+    [types] dn:NetworkVideoTransmitter tds:Device
+    [scopes] [type/NetworkVideoTransmitter] [location/unknown] [name/IPC_123465959]
+
+Select device number 1-2 or q to quit: 1
+
+Selected: 192.168.1.14:2020
+```
+
+**Notes:**
+
+- Discovery only works on the local network (same subnet)
+- Some networks may block multicast traffic (check firewall settings)
+- The `--host` and `--port` arguments are not required when using `--discover`
+- You can still provide `--username` and `--password` upfront to avoid prompts
 
-**2. Direct Command Execution**
+**3. Direct Command Execution**
 
 You can also execute a single ONVIF command directly. This is useful for scripting or quick checks.
 

{onvif_python-0.1.1 → onvif_python-0.1.3}/README.md

@@ -1,11 +1,12 @@
 # ONVIF Python
 
 [![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.1.1-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nirsimetri/onvif-python)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.3-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>
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.1-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)
+[![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)
+[![Upload Python Package](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml/badge.svg)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-publish.yml)
 
 **This project provides a comprehensive and developer-friendly Python library for working with ONVIF-compliant devices.** It is designed to be reliable, easy to integrate, and flexible enough to support a wide range of ONVIF profiles and services.  
 
@@ -123,7 +124,12 @@ Explore more advanced usage and service-specific operations in the [`examples/`]
 ## ONVIF CLI
 
 > [!NOTE]
-> The CLI is automatically installed when you install the `onvif-python` see [Installation](#installation). This feature has been available since onvif-python version [0.1.0](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.1)
+> The CLI is automatically installed when you install the `onvif-python` see [Installation](#installation). This feature has been available since `onvif-python` version [`0.1.1`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.1).
+
+![Windows](https://img.shields.io/badge/Windows-0078D6?style=plastic&logo=gitforwindows&logoColor=white)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=plastic&logo=linux&logoColor=black)
+![macOS](https://img.shields.io/badge/macOS-1A9FEE?style=plastic&logo=apple&logoColor=black)
+![Raspberry Pi](https://img.shields.io/badge/Raspberry%20Pi-A22846?style=plastic&logo=raspberrypi&logoColor=black)
 
 This library includes a powerful command-line interface (CLI) for interacting with ONVIF devices directly from your terminal. It supports both direct command execution and an interactive shell mode, providing a flexible and efficient way to manage and debug ONVIF devices.
 
@@ -134,7 +140,164 @@ This library includes a powerful command-line interface (CLI) for interacting wi
 - **Automatic Discovery:** Automatically detects available services on the device.
 - **Connection Management:** Supports HTTP/HTTPS, custom timeouts, and SSL verification.
 - **Data Management:** Store results from commands and use them as parameters in subsequent commands.
-- **Cross-Platform:** Works on Windows, macOS, and Linux.
+- **Cross-Platform:** Works on Windows, macOS, Linux, and Raspberry Pi.
+
+### Screenshoot
+
+<table>
+  <tr>
+    <td width="34.2%">
+      <a href="https://github.com/nirsimetri/onvif-python">
+        <img src="https://raw.githubusercontent.com/nirsimetri/onvif-python/refs/heads/main/assets/onvif_cli.png" />
+      </a>
+    </td>
+    <td width="65.8%">
+        <a href="https://github.com/nirsimetri/onvif-python">
+        <img src="https://raw.githubusercontent.com/nirsimetri/onvif-python/refs/heads/main/assets/onvif_operations.png" />
+        </a>
+    </td>
+  </tr>
+  <tr>
+    <th align="center">
+      Onboarding
+    </th>
+    <th align="center">
+      List available operations
+    </th>
+  </tr>
+</table>
+
+### Help Command
+
+<details>
+<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}]
+             [service] [method] [params ...]
+
+ONVIF Terminal Client —
+https://github.com/nirsimetri/onvif-python
+
+positional arguments:
+  service               ONVIF service name (e.g., devicemgmt, media, ptz)
+  method                Service method name (e.g., GetCapabilities, GetProfiles)
+  params                Method parameters as Simple Parameter or JSON string
+
+options:
+  -h, --help            show this help message and exit
+  --host HOST, -H HOST  ONVIF device IP address or hostname
+  --port PORT, -P PORT  ONVIF device port (default: 80)
+  --username USERNAME, -u USERNAME
+                        Username for authentication
+  --password PASSWORD, -p PASSWORD
+                        Password for authentication
+  --discover, -d        Discover ONVIF devices on the network using WS-Discovery
+  --timeout TIMEOUT     Connection timeout in seconds (default: 10)
+  --https               Use HTTPS instead of HTTP
+  --no-verify           Disable SSL certificate verification
+  --no-patch            Disable ZeepPatcher
+  --interactive, -i     Start interactive mode
+  --debug               Enable debug mode with XML capture
+  --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.
+
+Examples:
+  # Discover ONVIF devices on network
+  onvif --discover --username admin --password admin123 --interactive
+  onvif media GetProfiles --discover --username admin
+  onvif -d -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
+
+  # Interactive mode
+  onvif --host 192.168.1.17 --port 8000 --username admin --password admin123 --interactive
+
+  # Prompting for username and password
+  # (if not provided)
+  onvif -H 192.168.1.17 -P 8000 -i
+
+  # Using HTTPS
+  onvif media GetProfiles --host camera.example.com --port 443 --username admin --password admin123 --https
+```
+
+</details>
+
+<details>
+<summary><b>2. Interactive Shell</b></summary> 
+
+```bash
+ONVIF Interactive Shell Commands -
+https://github.com/nirsimetri/onvif-python
+
+Basic Commands:
+  capabilities, caps       - Show device capabilities
+  services                 - Show available services with details
+  info                     - Show connection and device information
+  exit, quit               - Exit the shell
+  shortcuts                - Show available shortcuts
+  help <command>           - Show help for a specific command
+
+Navigation Commands:
+  <service>                - Enter service mode (e.g., devicemgmt, media)
+  cd <service>             - Enter service mode (alias)
+  ls                       - List commands/services/methods in grid format
+  up                       - Exit current service mode (go up one level)
+  pwd                      - Show current service context
+  clear                    - Clear terminal screen
+
+Service Mode Commands:
+  desc <method>            - Show method documentation
+  type <method>            - Show input/output types from WSDL
+
+Method Execution:
+  <method>                 - Execute method without parameters
+  <method> {"param": "value"}  - Execute method with JSON parameters
+  <method> param=value     - Execute method with simple parameters
+
+Data Management:
+  store <name>             - Store last result with a name
+  show <name>              - Show stored data
+  show <name>.attribute    - Show specific attribute
+  show                     - List all stored data
+  rm <name>                - Remove stored data by name
+  cls                      - Clear all stored data
+
+Using Stored Data in Methods:
+  Use $variable syntax to reference stored data in method parameters:
+  - $profiles[0].token                    - Access list element and attribute
+  - $profiles[0].VideoSourceConfiguration.SourceToken
+
+  Example:
+    GetProfiles                           - Get profiles
+    store profiles                        - Store result
+    show profiles[0].token                - Show first profile token
+    GetImagingSettings VideoSourceToken=$profiles[0].VideoSourceConfiguration.SourceToken
+
+Debug Commands:
+  debug                    - Show last SOAP request & response (if --debug enabled)
+
+Tab Completion:
+  Use TAB key for auto-completion of commands, services, and methods
+  Type partial commands to see suggestions
+
+Examples:
+  192.168.1.17:8000 > caps                # Show capabilities
+  192.168.1.17:8000 > dev<TAB>            # Completes to 'devicemgmt'
+  192.168.1.17:8000 > cd devicemgmt       # Enter device management
+  192.168.1.17:8000/devicemgmt > Get<TAB> # Show methods starting with 'Get'
+  192.168.1.17:8000/devicemgmt > GetServices {"IncludeCapability": true}
+  192.168.1.17:8000/devicemgmt > GetServices IncludeCapability=True
+  192.168.1.17:8000/devicemgmt > store services_info
+  192.168.1.17:8000/devicemgmt > up       # Exit service mode
+  192.168.1.17:8000 >                     # Back to root context
+```
+
+</details>
 
 ### Usage
 
@@ -163,9 +326,78 @@ If you omit the username or password, you will be prompted to enter them securel
 | `show <name>` | Display a stored variable |
 | `exit` / `quit` | Exit the shell |
 
-You can see all the commands available in the interactive shell by trying them directly.
+> [!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.
+
+**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.
+
+**Discover and Connect Interactively:**
+```bash
+# Discover devices and enter interactive mode
+onvif --discover --username admin --password admin123 --interactive
+
+# Short form
+onvif -d -u admin -p admin123 -i
+
+# Discover and interactive (will prompt for credentials)
+onvif -d -i
+```
+
+**Discover and Execute Command:**
+```bash
+# Discover devices and execute a command on the selected device
+onvif media GetProfiles --discover --username admin --password admin123
+
+# Short form
+onvif media GetProfiles -d -u admin -p admin123
+```
+
+**How Device Discovery Works:**
+
+1. **Automatic Network Scanning**: Sends a WS-Discovery Probe message to the multicast address `239.255.255.250:3702`
+2. **Device Detection**: Listens for ProbeMatch responses from ONVIF devices (default timeout: 4 seconds)
+3. **Interactive Selection**: Displays a numbered list of discovered devices with their details:
+   - Device UUID (Endpoint Reference)
+   - XAddrs (ONVIF service URLs)
+   - Device Types (e.g., NetworkVideoTransmitter)
+   - Scopes (name, location, hardware, profile information)
+4. **Connection**: Once you select a device, the CLI automatically connects using the discovered host and port
+
+**Example Discovery Output:**
+```
+Discovering ONVIF devices on network...
+Network interface: 192.168.1.100
+Timeout: 4s
+
+Found 2 ONVIF device(s):
+
+[1] 192.168.1.14:2020
+    [id] uuid:3fa1fe68-b915-4053-a3e1-a8294833fe3c
+    [xaddrs] http://192.168.1.14:2020/onvif/device_service
+    [types] tdn:NetworkVideoTransmitter
+    [scopes] [name/C210] [hardware/C210] [Profile/Streaming] [location/Hong Kong]
+
+[2] 192.168.1.17:8000
+    [id] urn:uuid:7d04ff31-61e6-11f0-a00c-6056eef47207
+    [xaddrs] http://192.168.1.17:8000/onvif/device_service
+    [types] dn:NetworkVideoTransmitter tds:Device
+    [scopes] [type/NetworkVideoTransmitter] [location/unknown] [name/IPC_123465959]
+
+Select device number 1-2 or q to quit: 1
+
+Selected: 192.168.1.14:2020
+```
+
+**Notes:**
+
+- Discovery only works on the local network (same subnet)
+- Some networks may block multicast traffic (check firewall settings)
+- The `--host` and `--port` arguments are not required when using `--discover`
+- You can still provide `--username` and `--password` upfront to avoid prompts
 
-**2. Direct Command Execution**
+**3. Direct Command Execution**
 
 You can also execute a single ONVIF command directly. This is useful for scripting or quick checks.
 

{onvif_python-0.1.1 → onvif_python-0.1.3}/onvif/__init__.py

@@ -3,14 +3,7 @@
 from .client import ONVIFClient
 from .operator import ONVIFOperator, CacheMode
 from .utils import ONVIFWSDL, ONVIFOperationException, ONVIFErrorHandler, ZeepPatcher
-
-# CLI module is optional - import only if needed
-try:
-    from .cli import main as ONVIFCLI
-
-    CLI_AVAILABLE = True
-except ImportError:
-    CLI_AVAILABLE = False
+from .cli import main as ONVIFCLI
 
 __all__ = [
     "ONVIFClient",
@@ -20,7 +13,5 @@ __all__ = [
     "ONVIFOperationException",
     "ONVIFErrorHandler",
     "ZeepPatcher",
+    "ONVIFCLI",
 ]
-
-if CLI_AVAILABLE:
-    __all__.append("ONVIFCLI")