Introduction
i-PRO Active Guard plug-in is the OSS licensed under the Apache-2.0, which allows to easy integration of the i-PRO Active Guard system with 3rd party VMS client software.
More detail about i-PRO Active Guard
This document is targeted at developer using plug-in and partners that configure and use the system.
For developer, this document shows how to integrate plug-in module.
For partners, this document shows how to configure the system to use the 3rdparty VMS with i-PRO Active Guard system.
The user only needs to change the configuration file on i-PRO Active Guard server depending on the VMS.
This document does not scope VMS side configuration, how to start plug-in and so on.
System structure and features
i-PRO Active Guard plug-in is the software module for VMS client software which includes GUI and HTTP communication between i-PRO Active Guard server for face/people/vehicle search and so on.
Plug-in basic function | OSS user needs to implement |
---|---|
Face search | No |
People search | No |
Vehicle search | No |
License plate search | No |
Playback video | Yes |
Manage watchlist | No |
Export search result(image file or html) | No |
All supported functions and interface are included in dll file "ActiveGuard.OSS.dll".
To integrate plug-in, OSS user needs to implement initialize plug-in module, create workspace, playback video recorded in VMS server, and save configuration for plug-in functions.
Details are shown in Plug-in integration overview
As a whole system, in addition to plug-in integration, VMS server software must and should have the following WebAPI.
- Get camera list registered to VMS server in json format (Mandatory).
- Receive alarm notification from i-PRO Active Guard server to VMS server in XML format.(Optional)
Required hardware and software
Production system
Hardware
- i-PRO camera with AI engine
Software
- 3rd Party VMS software that integrates plug-in module("ActiveGuard.OSS.dll")
- Camera’s extension software (AI Face Detection, AI People Detection, AI Vehicle Detection or Vaxtor LPR/OCR)
- i-PRO Active Guard server software
To use sample application
By using the sample application, you can check the operation of this software before starting development.
With camera and Active Guard server
With camera and i-PRO Active Guard server, you can see many functionalities except for playback video.
Hardware
- i-PRO camera with AI engine
Product selector(check "Edge AI Support" in "Main Features")
Software
- Camera’s extension software (AI Face Detection, AI People Detection, AI Vehicle Detection or Vaxtor LPR/OCR)
- i-PRO Active Guard server software
Without camera and Active Guard server
Without camera and i-PRO Active Guard server, you can see how people/vehilce search and playback video using sample data.
How to use sample application
Development environment
- Visual Studio 2019
- .Net Framework 4.8
- Programming language : C#