CVEDIA-RT Integration with Piko¶
The integration of CVEDIA-RT with Nx Witness server from Network Optix (and any of its flavours) is facilitated through a plugin that can run on various platforms. The CVEDIA-RT plugin enables powerful analytics capabilities in your Nx Witness system, enhancing the effectiveness of your surveillance operations.
This guide will take you through the process of setting up and using this integration.
The CVEDIA Box, though an optional part of the setup, provides a powerful and streamlined solution for deploying the Nx Witness server and the CVEDIA-RT plugin in a hardware-optimized environment. Follow the steps in the 'Box set-up' section if you are using a CVEDIA Box.
- Unpack the box and connect it to your router (via Lan) and electricity.
- Allow a couple of minutes for the box’s software to load and for the status indicator light stops flashing.
- Make sure that the computer you plan to use for operating the box and the box itself are both connected to the same network.
Local Setup without CVEDIA Box¶
Using a admin powershell:
Enable remote signed scripts execution:
Run VMS setup script:
.\vms_setup.ps1 -u <address>
.\vms_setup.ps1 -u https://bin.cvedia.com/...
This will automatically download and install all required components.
The URL to use after the
-u argument will be delivered to you by email.
Different NX Flavors
CVEDIA-RT supports additional NX flavors that you can install by sending
-f <value>. Replace
<value> with one of the following key:
metafor NX Meta
hanwhafor Wisenet WAVE,
digitalwatchdogfor DW Spectrum
pikofor Piko VMS
Example installing Piko as VMS instead of NX (default):
.\vms_setup.ps1 -f piko -u https://bin.cvedia.com/...
You can find other options by calling help:
Get-Help .\vms_setup.ps1 -Full
Some versions of windows may block or flag random
.dll files from our install process. If CVEDIA-RT installs and doesn't start, we recommend disabling Windows Defender before installing it.
Unpack the .tar.gz file and call
The URL to download the .tar.gz file will be delivered to you by email.
This will run the NX Witness server.
Different NX Flavors
CVEDIA-RT supports the following NX flavors:
- Nx Witness (default):
- Nx Meta:
- Wisenet WAVE:
- DW Spectrum:
./run.sh --help for additional information.
Connecting to the VMS Server¶
Download and install the Nx Witness client from this link. You may download a differerent flavor of NX, but the following steps do not change.
If you're running a different flavor of NX the setup process is the same, except for the client you will download.
Run the Nx Witness application, a
pendingstatus will show up:
Click on it, then click
Setup New System
Adding a new device¶
Locate the list of servers on the left side of the application, and right-click on the one we just connected (eg. CVEDIA-RT) to add a new camera.
Paste the URL of your camera or RTSP device into the address bar, enter login, password, and port if required, set as default if needed and when ready, click on search.
If you have IP cameras connected to your network, you can use the "Subnet Scan" option.
Locate the device to be added to the list of found devices.
Click on the
Add all Devicesbutton.
Once ready, the camera will be shown as added and the add devices window can be closed to return to the main window of Nx Witness.
Note that a new device is now shown underneath the server name on the left side of the screen.
Double-click on the new device to open the viewer.
For more information on the camera setup in Nx Witness application, please check the official manual: NX Witness User Manual
Activating CVEDIA-RT Plugin License¶
To activate the CVEDIA-RT Plugin license, you may need to access the System Administration settings of the Nx Witness application. From there, you can add the license for the plugin:
Click on the top-left icon with 3 horizontal lines, to access the System Administration window.
Go to the
Pluginsection and select the CVEDIA-RT plugin if it's not already selected.
Insert the license key in the first available slot and cick the
Please wait a few seconds until the
Statusfield is updated.
Statusfield will inform you that the license is valid and active. In case of errors, it will inform you of the failing reason, such as network issues, invalid license key, etc...
Each license is configured with a maximum number of concurrent cameras where the analytics will run.
If you need to increase this limit, you can obtain a new license with the additional streams and add it in one of the empty slots.
License Deactivation and Tranfser¶
Once a license is activated, it gets bound to the specific device on which the plugin is running (the NX Withness server).
If you need to replace the device, you should deactivate the license before using it on a different device.
To deactivate a license is enough to remove it from the text field and click the
Apply button. Wait a few seconds until the
Status field is updated.
Enabling the CVEDIA-RT Plugin¶
Right-click on the video stream and select the camera settings option.
Navigate to the plugins section of the camera settings window and enable the CVEDIA-RT plugin.
As shown in the red banner at the bottom of the screen, the analytics will work only when the camera is being viewed or when the recording is enabled.
From the left menu you can now configure the analytics of your choice.
Configure one of the analytics. For example draw an area in the Intrusion Detection.
OKto save the settings.
Go to the
OBJECTtab on the top right to preview the detected objects:
To generate events, you need to define the camera rules in NX Witness. Right-click on the camera and click on
Camera Rules, and add a new rule based on
Monitor the events in the events tab.
If you create a rule that has a
Bookmark as an action, you can easily jump to the recorded event.
Don't forget to enable the recording in the
Camera Settings. This requires an Nx Witness license, but you can easily activate a trial one.
Once you activate the recording, you can set days and hours. To save on space you can choose the
Objects Only or
Objects + Low-Res modality.
Once CVEDIA-RT plugin is enabled, you can check if it's running and which hardware it's using.
Show statistics in the plugin
Then, open the camera and go into
Objects tab within NX, and you will see a large info panel:
This panel shows as follows:
Engine version: CVEDIA-RT engine version
Plugin: NX integration plugin version
Solution: CVEDIA-RT solution version
AI frame-rate: Should be always above
10for analytics to perform correctly
AI latency: miliseconds spent doing inference, should be less than
100 msfor analytics to perform correctly
Camera frame-rate: Camera source frame rate, should always be above
10for analytics to perform correctly
Run time: Runtime of CVEDIA-RT instance
# frames processed: Number of frames processed by our analytics
Accelerator: Accelerator(s) type and ultilization percentage (when available)
AI Model: Model(s) in use and accelerator(s) used to run it, some examples of accelerators are:
rknn: Running on Rockchip NPU
tensorrt: Running on NVIDIA GPU
openvino.CPU: Running on Intel CPU
openvino.GNA: Running on Intel GNA
openvino.GPU: Running on Intel GPU
hailo: Running on hailo
mnn: Running on CPU
Licenses: Number of CVEDIA-RT streams licenses in use / total number of licenses available
Each analytics allows you to configure some operational options, such as the area of the line used to trigger events, and some other related parameters.
All the analytics offer the ability to specify for each area or line what type of objects to detect between Person, Animal, Vehicle, or Unknown motion.
An analytic is active only if at least one area or one line is defined.
You can enable multiple analytics at the same time. This will not impact on the performance of the system.
Upgrading an existing install on windows¶
2023.5.9 release there's no automatic plugin update process. To upgrade your current install you need to do follow this manual process:
- Download CVEDIA-RT .zip release
- Extract and rename the folder
- Stop your VMS service
- Open your VMS server install folder, for example
C:\Program Files\Network Optix\Nx Witness\MediaServer\plugins
- Copy and overwrite
cvedianxpluginfolder with the one you just extracted and renamed
- Start VMS service
To check that CVEDIA-RT plugin is working, you can go to the camera settings, if the plugin shows up it means it's working.
If you're upgrading from
2023.5.x and newer you must add and validate a CVEDIA-RT license, please ask support if you need a trial version.