Содержание

1 iRidium for Onvif
2 Description

iRidium for Onvif

A set of tools to create interfaces to control equipment and IP-cameras on thebasis of Onvif protocol.

documentation was updated on 17.5.2022

Description

ONVIF (Open Network Video Interface Forum) is an international organization that develops standardized protocols for interactoin of different equipment and software that are part of security systems (IP-cameras, IP-coders, video recorders, access controllers, etc.).

iRidium for Onvif allows a control panel (iOS, Android, Windows, Mac) to connect to IP-cameras supporing Onvif protocol.

Connection

iRidium connects to IP-cameras supporting Onvif protocol via a local network. Interaction with equipment is done by means of HTTP requests.

Work in iRidium

Create a new project and add Onvif driver to it with the help of a scanner or entering data manually.

Scanning devices

There are two types of scanners : Scan Onvif Network (it scans the network and offers to choose a device among the found ones) and Scan Onvif Device (it offers to enter the IP, login and password to search for a device).

Scan Onvif Network

1 Click Scan > Scan Onvif Network in the Devices window in the created project:

2 Enter a required camera and its supported functions to add it to the project:

If a camera has a password, the app will offer you to enter a login and password to connect to equipment.

Scan Onvif Device

1 Click Scan > Scan Onvif Device in the Devices window in the created project:

2 Enter the IP-address, the login and the password of the camera:

3 Indicate required subdevices (supported functions) to add them to a project:

If the scanner can't find equipment, check that a required port on a PC is free and make another attempt to scan devices.

Setting Driver

When the network is scanned, the driver settings are filled in automatically:

Log Level - the level of logging;
Host - IP-address of the camera;
Port - port;
Login / Password - login and password to access a camera;
Wait for Connect (ms) - time to wait for connection;
Wait for Data (ms) - time to wait for feedback from equipment;
SSL - a type of encrypting;
Service Path - a path to the device serivce (filled in automatically during scanning).

Setting Subdevices

Name - the name of a subdevice;
Driver Type - a type of driver (Onvif);
Service Type - a type of subdevice (Streaming Profile, PTZ);
Service Path - a path to the device service (filled in automatically during scanning);
Profile Token - the token of a profile (filled in automatically during scanning).

Commands & Feedbacks

Feedback channels (Streaming Profile subdevice) have the following additional settings:

Name - the name of a feedback channel;
Request Type - a type of a feedback channel (Stream URI, Snapshot URI);
Refresh Interval (sec.) - an interval to update the stream / image (sec.);
Stream Type - a type of stream video (RTP-Unicast, RTP-Multicast);
Protocol - protocol (UDP, TCP, RTSP, HTTP).

Devices

When a camera is added with the help of a scanner, all settings of commands and feedback channels are set automatically. Only feedback settings of the Streaming Profilesubdevice can be changed. Added commands and feedback channels of a subdevice can't be deleted. Control is done by means of sending a value to a command (Send number, Send string, send value from object).

Streaming Profile

Feedbacks

Feedback	Expected values	Description
Stream URI	A link to stream video	Feedback is a link to stream video. It can be used an an image for a graphic item in the Studio to display a video stream from the camera in real time.
Snapshot URI	A link to an updatable picture	Feedback is a link to an updatable image. It can be used an an image for a graphic item in the Studio to get a snapshot from the camera.

PTZ

Commands

Command	Input values	Description
PTZ Continuous	Value	Changes of the camera position by the parameters set in the PTZ X, PTZ Y, PTZ Zoom channels in relation to the the current camera position.
PTZ Absolute	Value	Changes of the current camera position by the concrete parameters set in the PTZ X, PTZ Y, PTZ Zoom channels
PTZ X	Value (float)	Set the X coordinate to send PTZ Continuous or PTZ Absolute commands.
PTZ Y	Value (float)	Set the Y coordinate to send PTZ Continuous or PTZ Absolute command.
PTZ Zoom	Value (float)	Set the value of zooming in / out of the camera to send PTZ Continuous or PTZ Absolute commands.
PTZ X Speed	Value (float)	Set the speed of movement along the X axis for the PTZ Absolute command.
PTZ Y Speed	Value (float)	Set the speed of movement along the Y axis for the PTZ Absolute command.
PTZ Zoom Speed	Value (float)	Set the speed of zooming in/out for the PTZ Absolute command.
PTZ Stop	Value	It stops change of position but only after sending PTZ Continuous command. Without the command the camera will change position all the time.
PTZ Go Home	Value	Change of camera position to home coordinates. The coordinates are set in the Onvif Device Manager app.

Feedbacks

Feedback	Expected values	Description
PTZ X	Value (float)	The current value of the PTZ X parameter.
PTZ Y	Value (float)	The current value of the PTZ Y parameter.
PTZ Zoom	Value (float)	The current value of the PTZ Zoom parameter.
PTZ X Speed	Value (float)	The current value of the PTZ X Speed parameter.
PTZ Y Speed	Value (float)	The current value of the PTZ Y Speed parameter.
PTZ Zoom Speed	Value (float)	The current value of the PTZ Zoom Speed parameter.

Setting Commands and Feedback Channels

To control equipment it is required to set commands (Commands) and feedback channels (Feedbacks). To send a command, drag'n'drop it on a graphic item and enter a value to send. To display feedback drag'n'drop a feedback channel on a graphic item and choose how to output or display a value.

Read more about work with graphic items in the "Types of graphic items" article.