i-PRO Extension Software User Guide
- June 16, 2024
- i-PRO
Table of Contents
i-PRO Extension Software
Specifications
- Product: Web Guide Extension software (AI Processing Relay)
- Version: 4.0
Introduction
The Web Guide Extension software (AI Processing Relay) is a product that allows you to add AI functionality to a camera already installed. It receives MJPEG data from other cameras, performs AI processing with AI Extension Software, and can perform alarm reception and image search with i-PRO Active Guard.
Features
- Receives MJPEG data from other cameras
- Performs AI processing with AI Extension Software
- Performs alarm reception and image search with i-PRO Active Guard
Installation Conditions
The installation conditions of the product are as follows:
- The linked cameras should support MJPEG data transmission.
- The angle of view and other installation conditions of the linked cameras should be to the requirements of each application.
- The AI detection performance depends on the image quality of the linked camera. It is recommended to test the operation with the actual camera before use.
Introduction
This manual explains how to install the Extension software AI Processing Relay (hereinafter referred to as “this product”) on the cameras and the settings required prior to starting operation. Since this product is intended to be installed and used with a camera, please be sure to read the instruction manual of your camera as well. In addition, some of the screens shown in this manual may differ from the screens shown depending on your camera model and the version of “i-PRO Configuration Tool” (hereinafter referred to as “iCT”) or “i-PRO Active Guard”.
Product Overview
- This product is software for more convenient use of AI network cameras (sold separately). This product can perform AI processing on video from cameras that do not have AI functions by installing this product on the camera, configuring the camera to work with this product, and configuring extension software.
- This product is guaranteed to work with the WV-S71300-F3. The recommended camera to be linked to this product is a camera manufactured by i-PRO. If the linked camera supports MJPEG data (stream) transmission via HTTP or HTTPS, this product can receive MJPEG and perform AI processing. AI processing is handled by the extension software installed in the WV-S71300-F3. These extension software are required separately. This product can be used in combination with the following extension software:
- AI-VMD (AI Video Motion Detection)
- AI People detection
- AI Vehicle Detection
- AI Occupancy Detection
The extension software outputs the Onvif Event Stream and Best Shot as AI processing results. i- PRO Active Guard is required to operate this product.
- One other camera can be connected to one WV-S71300-F3 with this product installed.
Features
- This product can receive MJPEG data from other cameras, perform AI processing with AI Extension Software, and perform alarm reception and image search with i-PRO Active Guard. This product can be used when you want to add an AI function to a camera already installed.
- Installation conditions of the product
- This product receives MJPEG data from the linked camera and processes AI by extension software installed in the WV-S71300-F3. Installation conditions of the linked cameras, such as angle of view, are under the installation conditions of each application. AI detection performance depends on the image quality of the linked camera. Please confirm operation with the actual camera before use.
Precautions
- This product must be used with the latest firmware for WV-S71300-F3.
- The WV-S71300-F3 with this product installed cannot perform AI processing on its video using the extension software.
- One WV-S71300-F3 with this product installed is required for one camera. 2 or more cameras cannot be connected to this product simultaneously.
- Up to two extension software can be installed on WV-S71300-F3 in addition to this product.
- A command to acquire MJPEG data from the linked camera is required. The resolution and frame rate that can be processed by this product are 1920×1080@5fps or 1280×720@5fps.
- When this product is installed on WV-S71300-F3, the processing of extension software installed on WV-S71300-F3 may stop until this product is properly configured. Once the settings of this product are completed and MJPEG data is received from the linked camera, the extension software will operate correctly.
- If this product is uninstalled, restart WV-S71300-F3. Extension software installed on WV-S71300-F3 will not work properly.
Preparation
The flow up to operation is as follows. This chapter describes 1), 2), and 3).
- Install this product.
- Install this product
- Install extension software.
- Install extension software to be linked with this product
- Configure a camera to be linked with this product.
- Configure a camera to be linked to this product
- Start operation
Install this product
-
Access the product’s download site and download [AI Processing Relay].
For the download site of this product, please refer to the following:- Click here for downloads
- Do not use spaces or multi-byte characters in the destination directory name.
-
Select “Setup” > “Detailed setting” > “Ext. software” > “Software mng.” on the WV- S71300-F3.
Preparation
- Install extension software to be linked with this product
- Click the “Choose File” button and select the downloaded “AIProcessingRelay_vXXX.ext”.
- Confirm that “Install new Ext. software” is selected and click “Execute”. Installation of the software starts. When the installation is complete, AI Processing Relay is added to the Extension software list and the Ext. software screen.
- Do not turn off the camera during installation.
- Do not perform any operation during installation until the installation is completed.
Install extension software to be linked with this product
This product performs AI processing in conjunction with the following applications. Please refer to the manuals of each extension software for installation instructions.
- AI-VMD (AI Video Motion Detection)
- AI People detection
- AI Vehicle Detection
- AI Occupancy Detection
Configure a camera to be linked to this product
Configure the settings for the camera to be linked to this product. Please
refer to the manual of the camera for the setting method. Set the following
items.
- Set the stream to output MJPEG data.
- Set the resolution of the MJPEG data to 1920×1080 or 1280×720.
- Set the frame rate of the MJPEG data to 5fps
Basic settings
Configure this product
-
After installing the “AI Processing Relay”, an entry for “AI Processing Relay” will be added to the “Ext. software” tab of the “Setup” > “Detailed setting” page of the WV-S71300-F3.
-
Click the “Setup” button to open the setting screen.
-
Enter information about the camera to be linked to this product.
-
Camera username
Enter the username that has been set for the camera to be linked. Default setting: blank -
Camera Password
Enter the camera password that has been set for the camera to be linked. Default setting: blank -
Protocol
Select the protocol used to access the linked camera from this product. Default setting: HTTP -
IP address
Enter the IP address assigned to the camera to be linked. Default setting: blank -
Port number
Enter the port number of the protocol to be used for the linked camera.
Default setting: blank -
Http Jpeg stream URL
Enter the command to receive the MJPEG data from the linked camera.
Enter the command after the IP address of the camera.
Do not enter a leading “/”. The leading “/” will be automatically completed by this product.
In the case of a multi-sensor camera, please include the channel specification in the command.
Default setting: blank
Example: i-PRO camera (single-lens camera) cgi- bin/mjpeg?stream=1&frame=5- Channel
Enter the channel of the camera to be linked, using a number between 1 and 4. Enter 1 if the camera to be linked is a single-lens camera. If the camera to be linked is a multi-sensor camera, enter the channel to acquire MJPEG data. The information entered in this field is used when connecting to the i-PRO Active Guard.
Default setting: 1
-
Enter the information for the camera to be linked, not the information for the WV-S71300-F3, in the configuration fields for this product.
-
-
Press the “Set” button
-
Enter username and password
An alert will appear asking you to enter a username and password. Enter the username and password for the camera to be linked and press the “Sign in” button.
- The username and password entered for the alert must be the username and password of the camera to be linked, not the username and password of the WV-S71300-F3.
-
- The results received from the linked cameras are displayed in the Result column.
-
Http jpeg stream full URL
Displays the URL to receive MJPEG data from the linked camera. -
Received image
The image of MJPEG data received from the linked camera is displayed. The image is updated at 1 fps regardless of the received frame rate. -
Resolution
The resolution of the MJPEG data received from the linked camera is displayed. The resolution of the camera to be linked must be set to 1920×1080 or 1280×720. -
Framerate
Displays the frame rate of the MJPEG data received from the linked camera. 4.0 to 6.0 is the recommended value. If the recommended value is not displayed, change the frame rate of the linked camera to 5fps. If the value displayed in Framerate is lower than the recommended value even after setting the frame rate of the linking camera to 5fps, lower the bit rate of the MJPEG data from the linking camera.
-
The WV-S71300-F3 should be used in its default settings.
Configure extension software to be linked with this product
Please refer to the manual of each extension software to set up the software.
An alert may appear when opening the extension software screen. Enter the
username and password of the camera to be linked to the alert. The live image
of the linked camera will be displayed on the configuration screen of the
extension software.
- The username and password for the alert must be the username and password of the camera to be linked, not the username and password of the WV-S71300-F3.
- AI-VMD Mode selection should be set to “Normal angle mode”.
- iCT does not display the live image of the linked camera. Please set the area settings, etc. from the link displayed in iCT.
Configure i-PRO Active Guard
Refer to the i-PRO Active Guard manual for i-PRO Active Guard settings.
Only the contents related to the linkage of this product are explained below.
- Click “Camera Registration”.
- Select “Add” – “Add AI Processing Relay App”.
- Enter the IP address and authentication information for the camera in which this product is installed, and click “Check” and “Register”.
- Click “Restart” to restart the i-PRO Active Guard server.
The following settings must be made in advance.
Configure this product
Registration of cameras to be linked with this product to VMS. However,
cameras installed this product do not need to register to VMS.
Configure i-PRO Active Guard for VMS to receive AI-VMD and AI Occupancy
Detection alarms
If you use Genetec / Milestone VMS, you need to configure the following
settings to notify alarms. i-PRO Active Guard will notify Genetec / Milestone
VMS of the AI-VMD and AI Occupancy Detection alarms by making the following
settings. If you use Video Insight VMS, you do not need the following
settings.
-
Open i-PRO Active Guard’s VMS server screen and press the “Add” button.
-
Press the “Test” button after entering the VMS information. When “Success” is displayed, press the “Save” button.
-
Type
Select Genetec Security Center or Milestone XProtect. -
IP address
Enter the IP address of Genetec Security Center or Milestone XProtect. -
WEB API Port
Enter the port number of the Genetec Security Center or Milestone XProtect. -
Notification Port (Milestone XProtect only)
Enter the Milestone XProtect notification port number. -
SSL
Select On to enable SSL connection or Off to disable SSL connection. -
User Name
Enter the User Name for Genetec Security Center or Milestone XProtect. -
Password
Enter your Genetec Security Center or Milestone XProtect password. -
Type
Select Genetec Security Center or Milestone XProtect. -
IP address
Enter the IP address of Genetec Security Center or Milestone XProtect. -
WEB API Port
Enter the port number of the Genetec Security Center or Milestone XProtect. -
Notification Port (Milestone XProtect only)
Enter the Milestone XProtect notification port number. -
SSL
Select On to enable SSL connection or Off to disable SSL connection. -
User Name
Enter the User Name for Genetec Security Center or Milestone XProtect. -
Password
Enter your Genetec Security Center or Milestone XProtect password.
Specifications
Required environment and PC specifications
It is recommended to use a display that can display in 1980 x 1080 Image
capture size. For the specifications of the PC used to configure the camera,
please read the manual for the WV-S71300-F3 and the camera to be linked.
About this product
| Item | Description |
|---|---|
| Input | 1ch |
Input format from
the camera to be linked
| MJPEG 1920×1080@5fps or MJPEG 1280×720@5fps
Linked cameras| – i-PRO H.265 camera
– Other Company Camera
Extension software| – Up to 2 can be operated simultaneously.
– Supported extension software: AI-VMD / AI People detection / AI Vehicle detection / AI Occupancy detection
Supported systems| Video Insight / Genetec / Milestone / ASM300 with i-PRO Active Guard
Note:
- For “ASM300 with i-PRO Active Guard” supports only i-PRO cameras.
- For “Video Insight with i-PRO Active Guard”, AI Occupancy Detection alarms are not supported because they do not go through i-PRO Active Guard.
Supported functions with AI Processing Relay for each system
Video Insight with i-PRO Active Guard
| AI-VMD| AI People
Detection
| AI Vehicle
Detection
| AI Occupancy
Detection
---|---|---|---|---
Alarm
Management
| ✓| ✓| ✓| N/A
Similarity Search| –| ✓| ✓| –
Statistics
Dashboard
| ✓| ✓| ✓| ✓
Genetec / Milestone with i-PRO Active Guard
| AI-VMD| AI People
Detection
| AI Vehicle
Detection
| AI Occupancy
Detection
---|---|---|---|---
Alarm
Management
| ✓| ✓| ✓| ✓
Similarity Search| –| ✓| ✓| –
Statistics
Dashboard
| ✓| ✓| ✓| ✓
ASM300 with i-PRO Active Guard ( only i-PRO Camera is supportted )
| AI-VMD| AI People
Detection
| AI Vehicle
Detection
| AI Occupancy
Detection
---|---|---|---|---
Alarm
Management
| ✓| ✓| ✓| ✓
Similarity Search| –| ✓| ✓| –
Statistics
Dashboard
| ✓| ✓| ✓| ✓
Camera to install this product
WV-S71300-F3 is recommended for the camera to install this product.
Linked cameras
The camera to be linked must support MJPEG 1920×1080@5fps or MJPEG
1280×720@5fps output. In addition, a command to receive MJPEG data is
required. Examples of MJPEG commands from various companies are shown below.
The following commands are not guaranteed to work with all cameras. Please
check the operation of your camera before use.
Manufac
turer
| MJPEG command example
(Http Jpeg stream URL)
| Full URL (Http jpeg stream
full URL)
| Camera setting
---|---|---|---
i-PRO| cgi-bin/mjpeg? stream=1&frame=5| http://
https://
| Open the Image/Audio > Image settings screen of the i-PRO camera and make the following settings:
– Refresh interval (JPEG): 5fps
– JPEG(1) > Image capture size: 1920×1080 or
1280×720
Advidia| video/mjpeg/stream1| http://
Example: Setup > Security > NetworkSecurity > Authentication > HTTP
Authentication = None
AXIS| axis-cgi/mjpg/video.cgi? resolution=1920×1080&fps=5|
http://
https://
|
Manufac
turer
| MJPEG command example
(Http Jpeg stream URL)
| Full URL (Http jpeg stream
full URL)
| Camera setting
---|---|---|---
Hanwha| stw-cgi/video.cgi? msubmenu=stream&action= view&Profile=1&CodecType
=MJPEG&Resolution=1920 x1080&FrameRate=5
| http://
/stw-cgi/video.cgi? msubmenu=stream&action= view&Profile=1&CodecType
=MJPEG&Resolution=1920 x1080&FrameRate=5
or
https://
=MJPEG&Resolution=1920
x1080&FrameRate=5
| This command is used when MJPEG is set as Profile 1 on a Hanwha camera.
VIVOTEK| video1s1.mjpg| http://
/video1s1.mjpg or
https://
|
JPEG one-shot mode
JPEG one-shot mode continuously receives JPEG images from the linked camera
and performs AI processing on the received images. Although MJPEG is
recommended for this product, if your camera does not support MJPEG CGI, try
the JPEG one shot mode. Please complete the installation of the AI Processing
Relay before following the steps below.
-
Enter the following CGI to enable JPEG one-shot mode
http:///cgi-bin/adam.cgi?
methodName=setApplicationPreference&appName=AiEncoderApp&pre fType=Integer&prefName=OneShot&value=1
value=1 : JPEG one-shot mode on
value=0: JPEG one-shot mode off -
Configure AI Processing Relay concerning 3.1 Configure this product.
For “Http Jpeg stream URL”, enter the command to receive JPEG one shot.
Example: i-PRO camera (single-lens camera) cgi-bin/camera?stream=1 -
(3) If an image is displayed in the Result column, the JPEG one-shot mode is working.
-
In JPEG one-shot mode, a still image is displayed on the AI-VMD and AI Occupancy Detection demo screens.
-
AI processing in JPEG one-shot mode may not reach the recommended frame rate of 5 fps due to frequent communication with the liked camera.
Examples of JPEG one shot commands from various companies are shown below. The following commands are not guaranteed to work with all cameras. Please check the operation of your camera before use.
Manufac
turer
| MJPEG command example
(Http Jpeg stream URL)
| Full URL (Http jpeg stream
full URL)
| Camera setting
---|---|---|---
Bosch| snap.jpg| http://
https://
/snap.jpg
|
Avigilon| media/cam0/still.jpg| http://
/media/cam0/still.jpg or
https://
/media/cam0/still.jpg
|
Trademarks and Registered Commercial Code
- Internet Explorer and Microsoft Edge are registered trademarks or trademarks of Microsoft Corporation in the United States and other countries.
- Google Chrome is a trademark of Google LLC.
- Firefox is a trademark of the Mozilla Foundation in the United States and other countries.
- ONVIF is a trademark of ONVIF Inc.
Open Source Software
This product uses the following open-source software. See “Open Source Software” for the corresponding license statement.
Software
name
| License Name
---|---
libjpeg- turbo| The IJG (Independent JPEG Group) License, which is listed in
README.ijg The Modified （3-clause） BSD License
The zlib License
Open Source Software
The Modified (3-clause) BSD License
Copyright (C)2009-2023 D. R. Commander. All Rights Reserved.
Copyright (C)2015 Viktor Szathmáry. All Rights Reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the libjpeg-turbo Project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
“AS IS”, AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Copyright
Transferring, copying, disassembling, decompiling, or reverse-engineering the
software contained in this product is prohibited. Exporting any software
contained in this product in violation of export laws and regulations is also
prohibited.
Disclaimer
- This product is designed to obtain images for surveillance of a specific area. This product is not intended to prevent crimes by itself.
- Under no circumstances will we be held responsible for any of the following:
- Any incidental, special or consequential damage or damage arising directly or indirectly in connection with this product
- Any inconvenience, damage, or damage incurred due to the inability of an image to be displayed or recorded or the loss of recorded information due to any reason including failure or failure of this product
- Failure or inconvenience, damage, or damage caused by a system combined with a third party device
- Claims or claims for damages caused by breaches of privacy by individuals or groups that have become a subject as a result of the use of surveillance images and records that have become public due to some reason (including use with User Authentication Off).
- The stored information is lost for some reason (including when this product is initialized due to forgetting the authentication information such as username and password)