User Manual of MIP HikAssistant Plug-ins · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation and Loading 2.1 Installing Plug-ins Purpose: Before you can do any other

User Manual of MIP HikAssistant Plug-ins

MIP HikAssistant Plug-ins

User Manual


User Manual

COPYRIGHT © 2017 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


i

Contents Chapter 1 Overview .............................................................................................................................. 1

1.1 Description........................................................................................................................... 1

1.2 Scopes .................................................................................................................................. 1

1.3 Running Environment .......................................................................................................... 1

Chapter 2 Installation and Loading ....................................................................................................... 2

2.1 Installing Plug-ins ................................................................................................................. 2

2.2 (Optional) Checking Running Status .................................................................................... 4

2.3 Loading Plug-ins ................................................................................................................... 5

Chapter 3 Adding Hikvision Device....................................................................................................... 7

Chapter 4 Metadata ........................................................................................................................... 12

4.1 Setting Metadata Parameters ............................................................................................ 12

4.1.1 Enabling Metadata Function ..................................................................................... 12

4.1.2 Adding Metadata Service .......................................................................................... 13

4.1.3 Linking Device to Service ........................................................................................... 18

4.2 Displaying Metadata .......................................................................................................... 19

Chapter 5 Alarm ................................................................................................................................. 22

5.1 Setting Alarm Parameters .................................................................................................. 22

5.1.1 Enabling Alarm Function ........................................................................................... 22

5.1.2 Adding Event ............................................................................................................. 23

5.1.3 Adding Alarm ............................................................................................................. 25

5.2 Receiving Alarm ................................................................................................................. 27


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 and receive the

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 Hivision 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

1.3 Running Environment

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

software are required.


2

Chapter 2 Installation and Loading

2.1 Installing Plug-ins

Purpose:

Before you can do any other operations, such as displaying metadata and receive alarm information of

Hikvision devices via Milestone XProtect Smart Client, you should install the MIP HikAssistant plug-ins.

The plug-ins contains three components that realize different functions (see details below), and they

are provided through three 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.

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.

HikAssistantPlugin: Used to configure metadata display parameters and alarm parameters. It

should be installed in the PC running with Milestone XProtect Management 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.

2. Click Next to start the installation wizard.

3. Click Next to choose the installation location.


3

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.


4

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.

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.


5

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.

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.


6


7

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.


8

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.


9

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.


10

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.


11


12

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.

The added devices will list on the Configuration page. You can know whether the device supports

metadata function, and view the IP address, port No., channel No., metadata port No., and

metadata function status of the device.

2. (Optional) Click Communication Port No. field at the top of Configuration page to edit the port

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.

4. Check the checkbox(es) to select device(s) that support metadata function.

5. (Optional) Click the text field in Metadata Port No. column of the selected device(s) to edit the


13

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.

3. Click Add Hardware in the drop-down list to open Add Hardware wizard page.


14

4. Select the hardware detection method as Manual and click Next to continue.

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.


15

7. Check MIP Driver checkbox under Other to select drives to use when scanning for service, and

click Next to continue.

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.


16

10. Click Next to connect system to metadata service after detecting succeeded.

11. Click Next after succeeded to select the metadata port and set name template.


17

12. Click Next to select group(s) for the added metadata service.

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.


18

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.

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.


19

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.


20

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, or 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.

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.


21


22

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

Hardware 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:


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 will turn to Enabled in Status column.


23

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:


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.


24

5. Input the event type name or description.

Note: 12 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


25

Object Removal Stopped

People Counting Detection People Counting

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.


26

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.


27

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.


28

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

Smart Client.


29

Documents

User Manual of MIP HikAssistant Plug-ins · User Manual of MIP HikAssistant Plug-ins 2 Chapter 2 Installation and Loading 2.1 Installing Plug-ins Purpose: Before you can do any other