ONVIF
uniflow.plugin.onvif •
Category: Security & Video •
Version: v1.0.27
ONVIF Plugin Reference Manual
1. Overview
Plugin Name: ONVIF
Type: Security & Video
Identifier: uniflow.plugin.onvif
Description
Integration with ONVIF-compatible cameras for snapshots, PTZ, and streams.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| Camera IP/Hostname: | Specifies the camera ip/hostname. |
| Username: | Specifies the username. |
| Password: | Specifies the password (secure). |
3. Exposed Routes & Data Types
The following routes are available in the Uniflow catalog for this plugin:
| Display Name | Route ID | Kind | Category | Access | Data Type |
|---|---|---|---|---|---|
| Take Snapshot | onvif:cmd:take_snapshot | Value | Commands | Write | Json |
| Save Snapshot to Folder | onvif:snapshot:save | Value | Media | Write | Json |
| Start Edge Recording (SD Card) | onvif:cmd:start_edge_recording | Value | Commands | Write | Json |
| Stop Edge Recording (SD Card) | onvif:cmd:stop_edge_recording | Value | Commands | Write | Json |
| Start Local Recording (Server) | onvif:cmd:start_local_recording | Value | Commands | Write | Json |
| Stop Local Recording (Server) | onvif:cmd:stop_local_recording | Value | Commands | Write | Json |
| Reboot Camera | onvif:cmd:reboot | Value | Commands | Write | Json |
| Disable Media Profile | onvif:cmd:disable_media_profile | Value | Commands | Write | Json |
| Enable Media Profile | onvif:cmd:enable_media_profile | Value | Commands | Write | Json |
| Absolute Move | onvif:cmd:ptz_absolute_move | Value | PTZ | Write | Json |
| Relative Move | onvif:cmd:ptz_relative_move | Value | PTZ | Write | Json |
| Go to Preset | onvif:cmd:ptz_goto_preset | Value | PTZ | Write | Json |
Route Parameters: Take Snapshot
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Save Snapshot to Folder
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Start Edge Recording (SD Card)
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Stop Edge Recording (SD Card)
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Start Local Recording (Server)
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Stop Local Recording (Server)
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Reboot Camera
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Disable Media Profile
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Enable Media Profile
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Absolute Move
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Relative Move
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: Go to Preset
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from ONVIF, add the corresponding Input Node in the Rule Editor and select the desired property from the catalog. Link its output to any logical comparison or directly to an Action Node.
Scenario B: Triggering Actions
If the plugin supports writable properties or actions, use an Action Node in the Rule Editor. Configure the Target property to point to the ONVIF action, and supply any required parameters mapping from your rule's logic.