Académique Documents
Professionnel Documents
Culture Documents
User Manual
COPYRIGHT © 2018 Hangzhou Hikvision Digital Technology Co., Ltd.
ALL RIGHTS RESERVED.
Any and all information, including, among others, wordings, pictures, graphs are the properties of
Hangzhou Hikvision Digital Technology Co., Ltd. or its subsidiaries (hereinafter referred to be
“Hikvision”). This user manual (hereinafter referred to be “the Manual”) cannot be reproduced,
changed, translated, or distributed, partially or wholly, by any means, without the prior written
permission of Hikvision. Unless otherwise stipulated, Hikvision does not make any warranties,
guarantees or representations, express or implied, regarding to the Manual.
About this Manual
This Manual is applicable to MIP HikAssistant plug-ins.
The Manual includes instructions for using and managing the product. Pictures, charts, images and all
other information hereinafter are for description and explanation only. The information contained in
the Manual is subject to change, without notice, due to firmware updates or other reasons. Please
find the latest version in the company website (http://overseas.hikvision.com/en/).
Please use this user manual under the guidance of professionals.
Trademarks Acknowledgement
and other Hikvision’s trademarks and logos are the properties of Hikvision in various
jurisdictions. Other trademarks and logos mentioned below are the properties of their respective
owners.
Legal Disclaimer
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE PRODUCT DESCRIBED, WITH ITS
HARDWARE, SOFTWARE AND FIRMWARE, IS PROVIDED “AS IS”, WITH ALL FAULTS AND ERRORS, AND
HIKVISION MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION,
MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, AND
NON-INFRINGEMENT OF THIRD PARTY. IN NO EVENT WILL HIKVISION, ITS DIRECTORS, OFFICERS,
EMPLOYEES, OR AGENTS BE LIABLE TO YOU FOR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, OR
INDIRECT DAMAGES, INCLUDING, AMONG OTHERS, DAMAGES FOR LOSS OF BUSINESS PROFITS,
BUSINESS INTERRUPTION, OR LOSS OF DATA OR DOCUMENTATION, IN CONNECTION WITH THE USE
OF THIS PRODUCT, EVEN IF HIKVISION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
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
User Manual of MIP HikAssistant Plug-ins
Contents
Chapter 1 Overview ........................................................................................................................ 1
1.1 Description ..................................................................................................................... 1
1.2 Scopes ............................................................................................................................ 1
1.3 Running Environment ..................................................................................................... 1
Chapter 2 Installation, Loading, and Uninstallation .......................................................................... 2
2.1 Installing Plug-ins ............................................................................................................ 2
2.2 (Optional) Checking Running Status ................................................................................ 5
2.3 Loading Plug-ins.............................................................................................................. 6
2.4 Uninstalling Plug-ins ....................................................................................................... 7
Chapter 3 Adding Hikvision Device .................................................................................................. 9
Chapter 4 Metadata...................................................................................................................... 14
4.1 Setting Metadata Parameters........................................................................................ 14
4.1.1 Enabling Metadata Function ................................................................................. 14
4.1.2 Adding Metadata Service ...................................................................................... 15
4.1.3 Linking Device to Service ....................................................................................... 20
4.2 Displaying Metadata ..................................................................................................... 22
Chapter 5 Alarm ........................................................................................................................... 25
5.1 Setting Alarm Parameters ............................................................................................. 25
5.1.1 Enabling Alarm Function ....................................................................................... 25
5.1.2 Adding Event ........................................................................................................ 26
5.1.3 Adding Alarm ........................................................................................................ 28
5.2 Receiving Alarm ............................................................................................................ 30
Chapter 6 ANPR ............................................................................................................................ 32
6.1 Setting ANPR Parameters .............................................................................................. 32
6.1.1 Enabling ANPR Function........................................................................................ 32
6.1.2 Configuring License Plate List ................................................................................ 33
6.2 Receiving ANPR Alarm .................................................................................................. 35
Chapter 7 Fisheye Expansion......................................................................................................... 37
i
User Manual of MIP HikAssistant Plug-ins
Chapter 1 Overview
1.1 Description
MIP HikAssistant plug-ins is provided by Hikvision for the Milestone Integration Platform SDK. It can
provide basic service for the interaction between Hikvision devices and Milestone server, convert the
data in Hikvision protocol format to Milestone defined format, and analysis the data obtained from
Milestone server. It can also help to display the metadata on live view or playback, realize fisheye
expansion function, configure ANPR parameters, and receive ANPR and alarm information of Hikvision
devices via Milestone XProtect Smart Client.
1.2 Scopes
The available Milestone products are the client software of Milestone XProtect series with Corporate
version.
The following Hikvision devices are available:
Thermal Imaging Camera with Version 5.4.2 or Above
Network Camera or Network Speed Dome with Version 5.5.0 or Above
ANPR Camera with Version 5.4.5: DS-2CD4A26FWD-IZS/P (2.8 mm to 12 mm)
Traffic Camera: iDS-2CD9371-AS
1
User Manual of MIP HikAssistant Plug-ins
2
User Manual of MIP HikAssistant Plug-ins
3
User Manual of MIP HikAssistant Plug-ins
4. Click Change… to select a proper directory to install the HikAssistantService and click Next.
After starting, the progress bar will appear to show the installation status, and you can click
Cancel to cancel the installation if needed.
6. Click Finish to complete the installation after the progress is ended.
The installed HikAssistantService will automatically start running.
4
User Manual of MIP HikAssistant Plug-ins
5
User Manual of MIP HikAssistant Plug-ins
6
User Manual of MIP HikAssistant Plug-ins
InstallShield Wizard.
2. Select Remove and click Next, or open Control Panel of the PC and click Programs and
FeaturesHikAssistantServiceUninstall to open the following dialog.
5. (Optional) Click Yes to keep the configuration files for next application.
Note: The history configuration files are kept under the original directory of uninstalled service or
plug-in. When you install the service or plug-in again, the saved history configuration files will be
automatically loaded to restore the previous settings.
8
User Manual of MIP HikAssistant Plug-ins
3. Select a PC in the organization list and click Action at the upper-left corner of home page to
unfold the drop-down list.
4. Click Add Hardware in the drop-down list to open Add Hardware wizard page.
9
User Manual of MIP HikAssistant Plug-ins
5. Select the hardware detection method as Manual and click Next to continue.
6. Click Add at the right to specify the user name and password of the device.
7. Input the user name and password, and click Next to continue.
8. Check ONVIF checkboxes to select drives to use when scanning for device, and then click Next to
continue.
10
User Manual of MIP HikAssistant Plug-ins
9. Set the information (including IP address, port No., and hardware model) for the device that you
want to add.
You can click Add at the right to set information for multiple devices with same user name and
password.
Note: The hardware model should be Auto-detect.
10. Click Next to start detecting the added device.
11. Click Next to connect system to device and get the device information.
12. Click Next to select the component(s) of the device and set the name template.
11
User Manual of MIP HikAssistant Plug-ins
13. Click Next to select group(s) for the added device component(s).
12
User Manual of MIP HikAssistant Plug-ins
13
User Manual of MIP HikAssistant Plug-ins
Chapter 4 Metadata
Purpose:
After adding the Hikvision device, you should enable its metadata function to upload the real-time
metadata information to Milestone server.
Steps:
1. Click MIP Plug-insHikvisionVideo in the Site Navigation panel to open Configuration page of
HikAssistantPlugin.
2. (Optional) Edit the communication port number for the HikAssistantService to communicate with
the HikAssistantPlugin.
Note: Editing the communication port is not suggested.
3. Click Metadata tab to enter metadata configuration page.
14
User Manual of MIP HikAssistant Plug-ins
The added devices will list on the metadata configuration page. You can know whether the device
supports metadata function, and view the IP address, port number, channel No., metadata port
No., and metadata function status of the device.
4. Check the checkbox(es) to select device(s) that support metadata function.
5. (Optional) Click the text field in Metadata Port column of the selected device(s) to edit the port
for Milestone servers to get metadata from device(s).
6. Click Enable to enable the metadata function of the selected device(s).
The metadata function status of the device will turn to Enabled in Status column.
7. (Optional) Check the checkbox(es) of device(s) with metadata function enabled and click Disable
to disable the function.
Purpose:
To get the metadata information of different devices, you should add a metadata service for each
added device.
Before you start:
Add the Hikvision device and get the metadata port No. of the device. See Chapter 3 Adding
Hardware for details.
Enable the metadata function of added devices. See Chapter 4.1.1 Enabling Metadata Function
for details.
Steps:
1. Click Recording ServersServers in the Site Navigation panel to show the organization list of
Recording Server.
2. Select the PC in the organization list and click Action at the upper-left corner of home page to
unfold the drop-down list.
15
User Manual of MIP HikAssistant Plug-ins
3. Click Add Hardware in the drop-down list to open Add Hardware wizard page.
4. Select the hardware detection method as Manual and click Next to continue.
16
User Manual of MIP HikAssistant Plug-ins
5. Click Add at the right to specify the user name and password of metadata service.
6. Input the user name and password, and click Next to continue.
Note: The user name and password of metadata services are root and password, respectively.
7. Check MIP Driver checkbox under Other to select drives to use when scanning for service, and
click Next to continue.
17
User Manual of MIP HikAssistant Plug-ins
8. Set the information (including IP address, port No., and hardware model) for the metadata
service.
You can click Add at the right to set information for multiple services with same user name and
password.
Notes:
The IP address of metadata service is that of the PC installed with HikMetadataPlugin.
The port No. of metadata service is the metadata port No. of the added device, see Chapter
4.1.1 Enabling Metadata Function for details.
The hardware model should be selected as MIP Driver.
9. Click Next to start detecting the specified metadata service.
10. Click Next to connect system to metadata service after detecting succeeded.
18
User Manual of MIP HikAssistant Plug-ins
11. Click Next after succeeded to select the metadata port and set name template.
12. Click Next to select group(s) for the added metadata service.
19
User Manual of MIP HikAssistant Plug-ins
You can also click DevicesMetadata in the Site Navigation panel to check the added metadata
services.
Note: To distinguish the metadata services of different hardware devices but with same IP
address, you’d better rename the metadata service with the IP address of linked hardware device
in the Name field of Properties panel.
Purpose:
After enabling the metadata function of the added device and adding the metadata service, you
should link the device to the added metadata service.
Steps:
1. Click DevicesCameras in the Site Navigation panel to show camera organization list, properties
and preview.
20
User Manual of MIP HikAssistant Plug-ins
2. Unfold the camera organization list and select a camera to display its properties.
3. Click Client tab at the bottom of Properties page to enter the Client settings page.
4. Click on the Related metadata field to open Select devices dialog and click Recording
Servers tab to show the added metadata services.
21
User Manual of MIP HikAssistant Plug-ins
22
User Manual of MIP HikAssistant Plug-ins
3. Unfold the device list on the Groups panel and select a device.
4. Click Add to add the selected device to the right panel.
Note: You can repeat the above steps to add multiple devices.
5. (Optional) Select an added device on the right panel and click Remove to remove the device.
6. Click Close to save the settings and go back to Live View or Playback page.
7. Start the live view or playback of device(s) which configured with metadata.
The metadata information (red/green frame or target moving route, and blue line/frame) of the
device(s) will display on the video of live view or playback.
Notes:
Red Frame: Marks the real-time target with alarm triggered, and it only appears in live view.
Green Frame: Marks the real-time target without triggering alarm.
Target Moving Route: Marks the moving route of real-time target with or without alarm
triggered in red or green color.
Blue Line/Frame: Configured rule line or frame.
If the metadata option of Smart Client is configured before setting metadata parameters on
Management Client, the metadata information will not be displayed. You must restart the
Smart Client to take effect.
For the detailed operations of live view or playback on Smart Client, refer to the User
Manual of Milestone XProtect Smart Client.
23
User Manual of MIP HikAssistant Plug-ins
24
User Manual of MIP HikAssistant Plug-ins
Chapter 5 Alarm
Purpose:
Enable the alarm function of the device to send the triggered alarm information to Milestone XProtect
client software.
Steps:
1. Log in to Milestone XProtect Management Client.
2. Click MIP Plug-insHikvisionVideo in the Site Navigation panel to open Configuration page of
HikAssistantPlugin.
3. Click Alarm tab to enter alarm configuration page.
25
User Manual of MIP HikAssistant Plug-ins
6. (Optional) Check the checkbox(es) of device(s) with alarm function enabled, and click Disable to
disable the function.
Purpose:
Add different event types as the alarm triggering events.
Steps:
1. Log in to Milestone XProtect Management Client.
2. Click Rules and EventsAnalytics Events in the Site Navigation panel to open adding event page.
3. Select the root organization in the Analytics Event panel and click Action at the upper-left corner
to unfold the drop-down list.
4. Click Add New… to add an event type and active the Properties panel.
26
User Manual of MIP HikAssistant Plug-ins
27
User Manual of MIP HikAssistant Plug-ins
Purpose:
After adding event types, you should add alarm and set the parameters, such as alarm name,
triggering event, triggering source, and so on.
Steps:
1. Click AlarmsAlarm Definitions in the Site Navigation panel to open alarm settings page.
2. Select the root organization in the Alarm Definitions panel and click Action at the upper-left
corner to unfold the drop-down list.
3. Click Add New… to add an alarm and active the Properties panel.
28
User Manual of MIP HikAssistant Plug-ins
29
User Manual of MIP HikAssistant Plug-ins
30
User Manual of MIP HikAssistant Plug-ins
Note: For more operations of Alarm Manager, refer to the User Manual of Milestone XProtect
Smart Client.
31
User Manual of MIP HikAssistant Plug-ins
Chapter 6 ANPR
Purpose:
The ANPR (Automatic Number Plate Recognition) function provides an intelligent yet highly intuitive
solution for parking lot or traffic management. This function helps to recognize the license plate of
passed vehicle or captured vehicle picture, and then define the pass rule or configure list to control
the entrance and entry of vehicles. The HikANPRPlugin is used to configure the ANPR parameters and
get the ANPR information of Hikvision devices in the Milestone XProtect Management Client and
Milestone XProtect Smart Client.
Purpose:
Enable the ANPR function of the device to send the ANPR information to Milestone XProtect client
software.
Steps:
1. Log in to Milestone XProtect Management Client.
2. Click MIP Plug-insHikvisionVideo in the Site Navigation panel to open Configuration page of
HikAssistantPlugin.
3. Click ANPR tab to enter ANPR configuration page.
32
User Manual of MIP HikAssistant Plug-ins
Purpose:
HikAssistantPlugin provides three pre-defined lists to manage the license plates and control the
vehicle passing according to the ANPR results. You can choose the lists to take effect and edit their
name as desired, and then add license plate information to the different lists or directly import
multiple license plates. You can also export the license plate lists to the local PC.
Steps:
1. Log in to Milestone XProtect Management Client.
2. Click MIP Plug-insHikvisionVideo in the Site Navigation panel to open Configuration page of
HikAssistantPlugin.
3. Click ANPR tab to enter ANPR configuration page.
The License Plate List panel displays on the right.
33
User Manual of MIP HikAssistant Plug-ins
4. Select a list from the drop-down list on the License Plate List panel.
5. Check Enable to take effect.
6. (Optional) Edit the list name as desired.
7. Click Add to add the license plate to the selected list or click Import to add license plates in batch.
Note: Before importing multiple license plates, you should click Download template on the
Import dialog to download the list template, and fill in the template with the license plates’
34
User Manual of MIP HikAssistant Plug-ins
The ANPR alarms are listed in the Alarms panel at the bottom of ANPR alarm center. You can
check the alarm time, matched list (if matched), license plate number, alarm source, vehicle color,
and country.
3. Click an ANPR alarm in the list to show the recognized license plate information (including image
contained vehicle and license plate, license plate picture, license plate number, and alarm details)
and related alarm video above the Alarms panel.
4. (Optional) Add the remarks for the recognized license plate.
5. (Optional) Drag the timeline to view the alarm video, or click / to reverse play/play the
video, or click / to play the video by reverse single frame/single frame.
35
User Manual of MIP HikAssistant Plug-ins
6. (Optional) Unfold the filter panel to set the filters or select the quick filter at the left of Alarms
panel to search for the ANPR alarms as desired.
Note: You can also receive the ANPR alarm in the Alarm Manager, see Chapter 5.3 Receiving Alarm for
details.
36
User Manual of MIP HikAssistant Plug-ins
360° panorama mode, and PTZ mode for live view or playback.
Fisheye: The whole wide-angle view of the camera is displayed. This view mode is called
Fisheye because it approximates the vision of a fish’s convex eye. The lens produces
curvilinear images of a large area, while distorting the perspective and angles of objects in
the image.
Panorama/Dual-180o Panorama/360o Panorama: The distorted fisheye image is
transformed to normal perspective image by some calibration methods.
PTZ: This view mode is the close-up view of some defined area in the fisheye view or
panorama view, and it supports the electronic PTZ function, which is also called e-PTZ. Each
PTZ view is marked on the fisheye view and panorama view with a specific navigation box.
You can drag the navigation box to adjust the PTZ view, or drag the PTZ view to adjust the
view to the desired angle.
6. (Optional) Click in the lower-right corner of Fisheye Expansion window or right-click on the
window and select Full Screen to display the video in full screen mode.
38
User Manual of MIP HikAssistant Plug-ins
39