ONVIF Video

Definitions

PTZ — Pan-Tilt-Zoom. PTZ describes the movement capability of cameras.

ONVIF — Open Network Video Interface Forum. An open industry forum that provides a standardized interface for IP-based security products

Setup

See the Data Servers page for information on configuring driver communication.

Important: The Asset Multi-Select configuration is not applicable for this system.

Prerequisites


Software	Minimum Version
IPFusion — ONVIF Video	1.3
.NET Framework	4.7.2

When completing your setup, be sure to have the ONVIF documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.


Purpose	Default Value	Configurable
Camera Asset	80	Yes
Dataserver	9003	Yes
Debug Tools	9575	No

Assets

Camera

This asset represents an ONVIF compliant camera.

Required Property Grid Fields


Address	The host address of the camera.
Camera Stream	If your camera has multiple streams available, you cam select to display the Primary stream or a Substream.
Port	The port number for camera communications.
Username	The username for authenticating with the camera.
Password	The password for authenticating with the camera.

View all properties

Supported States


Normal	The asset is online and in its default state.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Mask	Mask the asset's true state.
Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.
Auxiliary Toggle	Toggles the auxiliary output on and off.
PTZ Down	Moves the camera down.
PTZ Up	Moves the camera up.
PTZ Left	Moves the camera left.
PTZ Right	Moves the camera right.
Zoom In	Zooms the camera in.
Zoom Out	Zooms the camera out.
Stop PTZ	Stops all PTZ movement.
PTZ Preset	Moves the camera to a defined preset setting. Preset Number — The ID of the preset configured in the ONVIF system.

Note: For PTZ motion controls, PTZ speed property is a number that represents the speed of motion for the camera when moving.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Trigger Camera Preset

Table 1. Parameters
Preset ID	The ID of the preset command. Note: This command only accepts integer values. If a string value is required, please use the camera asset PTZ preset command instead.
Asset ID	The ID of the camera asset to execute the PTZ command on.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.