mip hikassistant plug-ins and... · 2018. 5. 23. · user manual of mip hikassistant plug-ins 2...

42
User Manual of MIP HikAssistant Plug-ins MIP HikAssistant Plug-ins User Manual

Upload: others

Post on 03-Jan-2021

6 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

MIP HikAssistant Plug-ins

User Manual

Page 2: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

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

Page 3: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

i

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

Page 4: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

1

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.3 Running Environment

The software and hardware environment which can install and run the Milestone XProtect client

software are required.

Note: Milestone XProtect client software installed in 32-bit system is not supported.

Page 5: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

2

Chapter 2 Installation, Loading, and

Uninstallation

2.1 Installing Plug-ins

Purpose:

Before you can do any other operations, such as displaying metadata, perform fisheye expansion,

receive ANPR, or alarm information of Hikvision devices via Milestone XProtect Smart Client, you

should install the MIP HikAssistant plug-ins. The plug-ins contains five components that realize

different functions (see details below), and they are provided through five installation packages, so

you can install the components in different paths or computers as required.

HikAssistantService: Provides basic service for the Hikvision device and Milestone server

interaction at the background. It should be installed in the computer running with Milestone

XProtect servers.

HikAssistantPlugin: Used to configure metadata display parameters, ANPR parameters, and alarm

parameters in the Management Client. It should be installed in the PC running with Milestone

XProtect Management Client.

HikMetadataPlugin: Helps to display metadata of Hikvision devices on live view or playback via

Smart Client. It should be installed in the PC running with Milestone XProtect Smart Client.

HikANPRPlugin: Used to receive ANPR information of Hikvision devices via the Smart Client. It

should be installed in the PC running with Milestone XProtect Smart Client.

HikFisheyePlugin: Provides fisheye expansion function to get the fisheye view during live view or

playback in the Smart Client. It should be installed in the PC running with Milestone XProtect

Smart Client.

Note: You cannot install the MIP HikAssistant plug-ins when running the Milestone XProtect client

software. Here we only take installing HikAssistantService as an example.

Steps:

1. Double-click the executable program file of HikAssistantService to enter the welcome page of the

InstallShield Wizard.

Page 6: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

3

2. Click Next to start the installation wizard.

3. Click Next to choose the installation location.

Note:

For Milestone XProtect client software 2017 R2, when installing the HikAssistantPlugin,

HikANPRPlugin, and HikMetadataPlugin, the installation location must be the default

path of C:\Program Files\Milestone\MIPPlugins defined by the client software. For

other versions of Milestone client software, contact the Milestone technical support to

get the default installation location of the plug-ins.

When installing the HikFisheyePlugin, the installation location must be in the

installation directory of Milestone XProtect Smart Client.

Page 7: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

4

4. Click Change… to select a proper directory to install the HikAssistantService and click Next.

5. Click Install to start the installation.

You can click Back to review or change any of the installation settings.

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.

Page 8: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

5

2.2 (Optional) Checking Running Status

Purpose:

You can check the running status of HikAssistantService to make sure the service of MIP HikAssistant

plug-ins is running before any other operations.

Steps:

1. Right-click Computer on the PC installed with the HikAssistantService.

2. Click Manage on the right-click menu to open Computer Management page.

3. Unfold the Services and Applications and click Services to show all services of this computer.

4. Find the HikAssistantService in the service list and check the status.

Page 9: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

6

5. (Optional) Double-click the HikAssistantService and select an operation (such as stopping,

pausing, resuming, restarting, and so on) in the right-click menu to change the status.

2.3 Loading Plug-ins

Purpose:

After installing the MIP HikAssistant plug-ins, you should log in to the Milestone XProtect client

software to load the HikMetadatPlugin and HikAssistantPlugin.

Before you start:

Install the Milestone XProtect client software. See the User Manual of Milestone XProtect VMS and

User Manual of Milestone XProtect Smart Client for details.

Steps:

1. Double-click Milestone XProtect Management Client or Milestone XProtect Smart Client to run

the client software.

2. Log in to home page of the client software.

The HikMetadataPlugin and HikAssistantPlugin will be automatically loaded.

Note: For the login of client software, refer to the User Manual of Milestone XProtect VMS and

User Manual of Milestone XProtect Smart Client.

Page 10: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

7

2.4 Uninstalling Plug-ins

Purpose:

MIP HikAssistant plug-ins provides uninstallation wizard for users to uninstall any of the installed

plug-ins. And you can keep the history configuration files to restore the previous settings for the next

time installation. Here we take uninstalling the HikAssistantService as an example.

Before you start:

Stop the service or stop running the plug-in which needs to be uninstalled.

Steps:

1. Double-click the executable program file of HikAssistantService to enter the welcome page of the

Page 11: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

8

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.

3. Click OK to start uninstalling the service.

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 service or plug-in is open.

4. Click Finish if completed.

The following prompt dialog appears.

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.

Page 12: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

9

Chapter 3 Adding Hikvision Device

Purpose:

Before you can start any other operations, you should add the Hikvision devices to the Milestone

XProtect client software.

Steps:

1. Log in to Milestone XProtect Management Client.

2. Click Recording ServersServers in the Site Navigation panel to show the organization list of

Recording Server.

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.

Page 13: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

10

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.

Page 14: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

11

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.

Page 15: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

12

13. Click Next to select group(s) for the added device component(s).

14. Click Finish.

The added device will display in the recording server organization list, and you can view the

properties and preview of the linked camera.

Page 16: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

13

Page 17: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

14

Chapter 4 Metadata

4.1 Setting Metadata Parameters

Purpose:

Before you can display the metadata information of Hikvision devices on the live view or play via

Milestone XProtect Smart Client, you should enable metadata function, add metadata service for the

device, and link device to the added metadata service.

Before you start:

Install the HikAssistantPlugin in the PC running with Milestone XProtect Management Client, and load

the plug-in to the management client.

4.1.1 Enabling Metadata Function

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.

Page 18: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

15

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.

4.1.2 Adding Metadata Service

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.

Page 19: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

16

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.

Page 20: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

17

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.

Page 21: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

18

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.

Page 22: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

19

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.

Page 23: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

20

13. Click Finish.

The added service will display in the recording server organization list, and you can view the

properties.

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.

4.1.3 Linking Device to Service

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.

Page 24: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

21

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.

Page 25: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

22

5. Select the metadata service of the camera on the left panel.

Note: The metadata service port should correspond to the camera metadata port.

6. Click Add to add the selected metadata service to the right panel.

7. (Optional) Select an added metadata service on the right panel and click Remove to remove the

added one.

8. Click OK to save the selections and go back to Properties page.

9. Click at the top of Site Navigation panel to save the settings and link the selected metadata

service to the camera.

4.2 Displaying Metadata

Purpose:

After setting the metadata parameters for Hikvision device, you can start displaying the metadata

information on the live view or playback via Milestone XProtect Smart Client.

Before you start:

Install the HikMetadataPlugin in the PC running with Milestone XProtect Smart Client, and load

the plug-in.

Log in to the device via Web page and configure the VCA rule. For configuring VCA rules, refer to

the User Manual of the device.

Steps:

1. Click at the upper-right corner of Smart Client home page to open Settings page.

2. Click HikMetadata Options tab on the left navigation panel.

Page 26: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

23

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.

Page 27: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

24

Page 28: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

25

Chapter 5 Alarm

5.1 Setting Alarm Parameters

Purpose:

To receive alarm information of Hikvision devices via Smart Client, you should set the alarm

parameters first, including enabling alarm function, adding events, and adding alarms.

Before you start:

Install the HikAssistantPlugin in the PC running with Milestone XProtect Management Client, and

load the plug-in.

Add the Hikvision device to the Milestone XProtect client software. See Chapter 3 Adding

Hikvision Device for details.

5.1.1 Enabling Alarm Function

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.

4. Check the checkbox(es) to select device(s).

5. Click Enable to enable the alarm function of the selected device(s).

The alarm function status of the device turns to Enabled in Status column.

Page 29: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

26

6. (Optional) Check the checkbox(es) of device(s) with alarm function enabled, and click Disable to

disable the function.

5.1.2 Adding Event

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.

Page 30: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

27

5. Input the event type name or description.

Note: 15 event types are available and the event type names are predefined, you should set the

name according to the names in the Event Type Name column of the following table:

Event Type Event Type Name

Video Tampering Detection Video Tampering Started

Video Tampering Stopped

Face Detection Face Detection Started

Face Detection Stopped

Defocus Detection Defocus Started

Defocus Stopped

Audio Exception Detection Audio Exception Started

Audio Exception Stopped

Scene Change Detection Scene Change Started

Scene Change Stopped

Intrusion Detection Intrusion Started

Intrusion Stopped

Line Crossing Detection Line Crossing Started

Line Crossing Stopped

Region Entrance Detection Region Entrance Started

Region Entrance Stopped

Region Exiting Detection Region Exiting Started

Region Exiting Stopped

Unattended Baggage Detection Unattended Baggage Started

Unattended Baggage Stopped

Object Removal Detection Object Removal Started

Page 31: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

28

Object Removal Stopped

People Counting Detection People Counting

ANPR Function ANPR

Temperature Alarm Temperature Alarm

Temperature Pre-alarm Temperature Pre-alarm

6. Click at the top of Site Navigation panel to save the settings.

5.1.3 Adding Alarm

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.

Page 32: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

29

4. Input the alarm name and instructions as desired.

5. Select the major type and minor type of triggering event.

Note: The minor type field will be activated after selecting the major type. And the selectable

minor types are added in Chapter 5.1.2 Adding Event.

6. Click Select… in the Sources field to open Select Sources dialog and select the triggering sources.

1) (Optional) Select a source type in the Type filter field.

2) Unfold the source list in the Groups tab and select an added camera in the list.

3) Click Add to add the selected camera to the right panel.

Note: You can repeat the above steps to add multiple sources.

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.

7. (Optional) Set other alarm parameters, such as alarm activation period, operator actions, and so

on, see User Manual of Milestone XProtect VMS for details.

8. Click at the top of Site Navigation panel to add the alarm and save the settings.

Page 33: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

30

5.2 Receiving Alarm

Purpose:

After setting the alarm parameters, the devices configured with alarm rules will automatically send

the alarm information to the Milestone XProtect Smart Client once the alarm is triggered, and you can

log in to the Smart Client to receive the alarms and view the alarm details.

Before you start:

Log in to the device via Web page and configure the event or alarm rules. For configuring event or

alarm rules, refer to the User Manual of the device.

Steps:

1. Log in to Milestone XProtect Smart Client.

2. Click the Alarm Manager tab on the home page to enter alarm management page.

The triggered and received alarm will list in the bottom panel.

3. Double-click the alarm in the list to open alarm details dialog.

You can check the alarm information and the linked alarm video.

Page 34: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

31

Note: For more operations of Alarm Manager, refer to the User Manual of Milestone XProtect

Smart Client.

Page 35: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

32

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.

6.1 Setting ANPR Parameters

Purpose:

To receive ANPR information of Hikvision devices via Smart Client, you should set the ANPR

parameters first, including enabling ANPR function, configuring license plate list, adding ANPR event,

and adding ANPR alarm.

Note: For adding ANPR event and ANPR alarm, refer to Chapter 5.1.2 Adding Event and Chapter 5.1.3

Adding Alarm.

Before you start:

Install the HikAssistantPlugin in the PC running with Milestone XProtect Management Client, and

load the plug-ins.

Add the Hikvision device with ANPR function to the Milestone XProtect client software. See

Chapter 3 Adding Hikvision Device for details.

6.1.1 Enabling ANPR Function

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.

Page 36: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

33

4. Check the checkbox(es) to select device(s).

5. (Optional) Click Port field to edit the port No. as required.

Note: By default, the port No. is 8000.

6. Click Enable to enable the ANPR function of the selected device(s).

The ANPR function status of the device turns to Enabled in Service Status column.

7. (Optional) Check the checkbox(es) of device(s) with ANPR function enabled, and click Disable to

disable the function.

6.1.2 Configuring License Plate List

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.

Page 37: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

34

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’

Page 38: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

35

information. Then import the filled template.

8. (Optional) Select an added license plate and click Remove to remove the license plate from the

list.

9. (Optional) Click Export to export the list to the local PC.

6.2 Receiving ANPR Alarm

Purpose:

After enabling ANPR function and configuring license plate list in the Milestone XProtect Management

Client, the ANPR camera configured with ANPR alarm rules will automatically send ANPR information

to the Milestone XProtect Smart Client once the alarm is triggered. You can log in to the Smart Client

to receive the real-time ANPR alarms, view the alarm details, and search for the history alarms.

Before you start:

Install the HikANPRPlugin in the PC running with Milestone XProtect Smart Client, and load the

plug-ins.

Log in to the ANPR camera via Web page and configure the event or alarm rules, for details, refer

to the user manual of ANPR camera.

Steps:

1. Log in to Milestone XProtect Smart Client.

2. Click ANPR tab to enter ANPR alarm center.

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.

Page 39: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

36

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.

Page 40: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

37

Chapter 7 Fisheye Expansion

Purpose:

You can realize the fisheye expansion in the Milestone XProtect Smart Client during the live view or

playback of Hikvision fisheye cameras in fisheye mode, PTZ mode, or panorama mode via the

HikFisheyePlugin.

Before you start:

Install the HikFisheyePlugin in the PC running with Milestone XProtect Smart Client, and load the

plug-in.

Add the Hikvision fisheye camera to the Milestone XProtect Management Client. See Chapter 3

Adding Hikvision Device for details.

Steps:

1. Log in to Milestone XProtect Smart Client.

2. Start the live view or playback of the added fisheye camera.

Note: For the detailed operations of live view or playback on Smart Client, refer to the User

Manual of Milestone XProtect Smart Client.

3. Move the cursor to the display window and click on the appeared toolbar to open Fisheye

Expansion window.

Note: Make sure the video stream for live view or playback is normally obtained, otherwise, the

fisheye expansion exception may occur.

4. Select the mounting type.

Note: Different mounting types are different according to different cameras, and which also

correspond to different expanding modes.

5. Select the expanding mode, including fisheye mode, panorama mode, dual-180° panorama mode,

Page 41: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

38

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.

Page 42: MIP HikAssistant Plug-ins and... · 2018. 5. 23. · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation, Loading, and Uninstallation 2.1 Installing Plug-ins Purpose:

User Manual of MIP HikAssistant Plug-ins

39