Professional Documents
Culture Documents
Mip Hikassistant Plug-Ins (Face Application) : User Manual
Mip Hikassistant Plug-Ins (Face Application) : User Manual
Mip Hikassistant Plug-Ins (Face Application) : User Manual
User Manual
MIP HikAssistant Plug-ins (Face Application) User Manual
Legal Information
User Manual
©2019 Hangzhou Hikvision Digital Technology Co., Ltd.
About this Manual
This Manual is subject to domestic and international copyright protection. Hangzhou Hikvision
Digital Technology Co., Ltd. ("Hikvision") reserves all rights to this manual. This manual cannot be
reproduced, changed, translated, or distributed, partially or wholly, by any means, without the
prior written permission of Hikvision.
Please use this user manual under the guidance of professionals.
Trademarks
and other Hikvision marks are the property of Hikvision and are
registered trademarks or the subject of applications for the same by Hikvision and/or its affiliates.
Other trademarks mentioned in this manual are the properties of their respective owners. No right
of license is given to use such trademarks without express permission.
Disclaimer
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, HIKVISION MAKES NO WARRANTIES,
EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS MANUAL.
HIKVISION DOES NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE
USE OF THE MANUAL, OR THE CORRECTNESS, ACCURACY, OR RELIABILITY OF INFORMATION
CONTAINED HEREIN. YOUR USE OF THIS MANUAL AND ANY RELIANCE ON THIS MANUAL SHALL BE
WHOLLY AT YOUR OWN RISK AND RESPONSIBILITY.
REGARDING TO THE PRODUCT WITH INTERNET ACCESS, THE USE OF PRODUCT SHALL BE WHOLLY
AT YOUR OWN RISKS. HIKVISION SHALL NOT TAKE ANY RESPONSIBILITIES FOR ABNORMAL
OPERATION, PRIVACY LEAKAGE OR OTHER DAMAGES RESULTING FROM CYBER ATTACK, HACKER
ATTACK, VIRUS INSPECTION, OR OTHER INTERNET SECURITY RISKS; HOWEVER, HIKVISION WILL
PROVIDE TIMELY TECHNICAL SUPPORT IF REQUIRED.
SURVEILLANCE LAWS VARY BY JURISDICTION. PLEASE CHECK ALL RELEVANT LAWS IN YOUR
JURISDICTION BEFORE USING THIS PRODUCT IN ORDER TO ENSURE THAT YOUR USE CONFORMS
THE APPLICABLE LAW. HIKVISION SHALL NOT BE LIABLE IN THE EVENT THAT THIS PRODUCT IS USED
WITH ILLEGITIMATE PURPOSES.
IN THE EVENT OF ANY CONFLICTS BETWEEN THIS MANUAL AND THE APPLICABLE LAW, THE LATER
PREVAILS.
i
MIP HikAssistant Plug-ins (Face Application) User Manual
Contents
Chapter 1 Overview .................................................................................................................... 1
1.1 Introduction ........................................................................................................................... 1
1.2 Runtime Environment ............................................................................................................ 1
1.3 Product Scopes ...................................................................................................................... 1
1.4 Update History ....................................................................................................................... 3
Chapter 2 Installation and Uninstallation .................................................................................... 4
2.1 Install Plug-ins ........................................................................................................................ 4
2.1.1 Install Service Plug-in .................................................................................................... 4
2.1.2 Install Face Application Plug-in on Management Client ................................................ 9
2.1.3 Install Face Application Plug-in on Smart Client .......................................................... 15
2.2 Uninstall Plug-ins ................................................................................................................. 21
Chapter 3 Log in to Milestone Server ........................................................................................ 25
Chapter 4 Add Hikvision Device ................................................................................................ 27
Chapter 5 Face Alarm ............................................................................................................... 32
5.1 Enable Face Alarm Receiving ............................................................................................... 32
5.2 Add Face Event Type ............................................................................................................ 33
5.3 Set Face Event Linkage ......................................................................................................... 35
5.4 Receive Face Alarm .............................................................................................................. 37
Chapter 6 Face Picture Search ................................................................................................... 39
6.1 Search by Conditions ........................................................................................................... 39
6.2 Search by Picture ................................................................................................................. 40
ii
MIP HikAssistant Plug-ins (Face Application) User Manual
Chapter 1 Overview
MIP HikAssistant plug-ins are provided by Hikvision for the Milestone Integration Platform SDK.
They can provide basic service for the interaction between Hikvision devices and the Milestone
server, convert the data in Hikvision protocol format to Milestone-defined format, and analyze the
data obtained from the Milestone server.
1.1 Introduction
The face applications include face capture, face picture comparison, and face picture search. The
captured face pictures and face picture comparison results can be triggered as face alarms and
uploaded by Hikvision cameras (including capture cameras and DeepinView series cameras), and
then you can receive them on Milestone XProtect Smart Client. For captured face pictures stored in
the face recognition server, you can search for the face pictures by specific conditions, or upload a
local face picture and set the similarity to search by picture.
Note
Milestone XProtect client software cannot be installed in the computer running with 32-bit
operating system. For details about the supported running environment, refer to the User Manual
of Milestone XProtect VMS.
1
MIP HikAssistant Plug-ins (Face Application) User Manual
2
MIP HikAssistant Plug-ins (Face Application) User Manual
3
MIP HikAssistant Plug-ins (Face Application) User Manual
HikAssistantService
This plug-in provides basic service for the interaction between Hikvision devices (including cameras
and face recognition servers) and the Milestone server at the background.
HikAssistantConfig
This plug-in contains Face Application component which is a dynamic link library for configuring
face alarm receiving parameters on Milestone XProtect Management Client. It should be installed
in the computer running with Milestone XProtect Management Client, and it should be used with
the Face Application component in HikAssistantCtrl in pairs.
HikAssistantCtrl
This plug-in contains Face Application component that provides face applications of receiving face
capture and face picture comparison alarms of Hikvision cameras, and searching for face pictures
on Milestone XProtect Smart Client. It should be installed in the computer running with Milestone
XProtect Smart Client, and it should be used with the Face Application component in
HikAssistantCtrl in pairs.
Note
The MIP HikAssistant plug-ins cannot be installed when the Milesone XProtect client software is
running.
4
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
The HikAssistantService component will be checked by default and cannot be unchecked.
5
MIP HikAssistant Plug-ins (Face Application) User Manual
6
MIP HikAssistant Plug-ins (Face Application) User Manual
7
MIP HikAssistant Plug-ins (Face Application) User Manual
After starting installation, the progress bar will appear to show the installation status, and you
can click Cancel to cancel the installation if needed.
8
MIP HikAssistant Plug-ins (Face Application) User Manual
9
MIP HikAssistant Plug-ins (Face Application) User Manual
10
MIP HikAssistant Plug-ins (Face Application) User Manual
11
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
When installing the face application plug-in on the Milestone XProtect client software 2017 R3,
the installation location must be the default path of C:\Program Files\Milestone\MIPPlugins
defined by the client software. For other versions of the Milestone XProtect client software,
contact the Milestone technical support to get the default installation location of the plug-ins.
12
MIP HikAssistant Plug-ins (Face Application) User Manual
13
MIP HikAssistant Plug-ins (Face Application) User Manual
After starting installation, the progress bar will appear to show the installation status, and you
can click Cancel to cancel the installation if needed.
14
MIP HikAssistant Plug-ins (Face Application) User Manual
What to do next
Double-click Milestone XProtect Management Client to run the client software, and the installed
face application plug-in will be loaded automatically.
15
MIP HikAssistant Plug-ins (Face Application) User Manual
16
MIP HikAssistant Plug-ins (Face Application) User Manual
17
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
When installing the face application plug-in on the Milestone XProtect client software 2017 R3,
the installation location must be the default path of C:\Program Files\Milestone\MIPPlugins
defined by the client software. For other versions of the Milestone XProtect client software,
contact the Milestone technical support to get the default installation location of the plug-ins.
18
MIP HikAssistant Plug-ins (Face Application) User Manual
19
MIP HikAssistant Plug-ins (Face Application) User Manual
After starting installation, the progress bar will appear to show the installation status, and you
can click Cancel to cancel the installation if needed.
20
MIP HikAssistant Plug-ins (Face Application) User Manual
What to do next
Double-click Milestone XProtect Smart Client to run the client software, and the installed face
application plug-in will be loaded automatically.
21
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
If you are prompted to reboot the computer to complete the uninstallation, please ignore the
prompt which may be caused by the following reasons:
• The service or plug-in is still running when uninstalling.
• The installation directory folder of the plug-in is open.
After starting uninstallation, the progress bar will appear to show the uninstallation status.
22
MIP HikAssistant Plug-ins (Face Application) User Manual
23
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
The history configuration files are kept under the original directory of the uninstalled plug-in.
When you install the plug-in again, the saved history configuration files will be automatically
loaded to restore the previous settings.
24
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
Multiple users using HikAssistantService cannot log in to the same Milestone server
simultaneously.
1. Right-click on the in the system tray of the task bar and click Configuration to open the
Configuration dialog.
2. Optional: Input the listening port No. in the Port field and click Save to save the settings.
3. Input the IP address, user name, and password of the Milestone server in the corresponding
fields and select the authentication mode.
4. Click Login.
25
MIP HikAssistant Plug-ins (Face Application) User Manual
26
MIP HikAssistant Plug-ins (Face Application) User Manual
27
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
The recommended drivers are Hikvision.
28
MIP HikAssistant Plug-ins (Face Application) User Manual
29
MIP HikAssistant Plug-ins (Face Application) User Manual
30
MIP HikAssistant Plug-ins (Face Application) User Manual
31
MIP HikAssistant Plug-ins (Face Application) User Manual
32
MIP HikAssistant Plug-ins (Face Application) User Manual
4. Optional: Enter IP address, port No., user name, and password, and click Save to add a face
recognition server to HikAssistantService.
Note
• If you want to search face pictures by conditions or by picture on Milestone XProtect Smart
Client, this step is required.
• For capture cameras, the face recognition server can help realize the face picture comparison.
But the comparison list library must be configured for the server via web access. For details
about the configuration of the comparison list library, refer to the user manual of the face
recognition server.
33
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
You should set the event type names for different event types according to the names in the
Event Type Name column of the following table.
Table 5-1 Event Types and Event Type Names for Face Applications
Event Type Event Type Name
Face Detection Face Detection Started
Face Detection Stopped
Face Capture Face Capture
Face Picture Comparison Face Comparison
34
MIP HikAssistant Plug-ins (Face Application) User Manual
35
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
You can repeat the above steps to add multiple sources.
36
MIP HikAssistant Plug-ins (Face Application) User Manual
4) Optional: Select the added camera on the right panel and click Remove to remove the
camera.
5) Click OK to save the selection and close the dialog.
37
MIP HikAssistant Plug-ins (Face Application) User Manual
The captured face thumbnails of all cameras are listed under the live view window. You can click
or to view the previous or next thumbnails.
38
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
The Similarity option in the Attributes field is not available when searching by conditions.
4. Optional: Set the start time or end time to search for the face pictures captured in this time
period.
5. Click Select camera to select camera(s).
6. Click Search to start searching for face pictures by conditions.
The matched face pictures in the library are listed at the middle of the page.
39
MIP HikAssistant Plug-ins (Face Application) User Manual
40
MIP HikAssistant Plug-ins (Face Application) User Manual
Note
The Similarity option in the Attributes field is selected and turns to required.
4. Set the value of the similarity.
Note
If the similarity between the uploaded local face picture and the face pictures in the library is
larger than the configured threshold (by default, it is 80%), the matched face pictures in the
library will be filtered.
5. Optional: Set other options, including age, gender, wear glasses or not, and smile or not, in the
Attributes field as the search conditions.
6. Optional: Set the start time or end time to search for the face pictures captured in this time
period.
7. Click Select camera to select camera(s).
8. Click Search to start searching by picture.
The matched face pictures in the library are listed at the middle of the page.
41
UD14564C