AN 190 Security Expert - Hikvision - Integration Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 12

Schneider Electric

Hikvision Integration with Security Expert


Application Note
AN-190
July 2021
Legal Information
The Schneider Electric brand and any registered trademarks of Schneider Electric Industries
SAS referred to in this manual are the sole property of Schneider Electric SA and its
subsidiaries. They may not be used for any purpose without the owner's permission, given in
writing. This manual and its content are protected, within the meaning of the French intellectual
property code (Code de la propriété intellectuelle français, referred to hereafter as "the Code"),
under the laws of copyright covering texts, drawings and models, as well as by trademark law.
You agree not to reproduce, other than for your own personal, noncommercial use as defined in
the Code, all or part of this manual on any medium whatsoever without Schneider Electric's
permission, given in writing. You also agree not to establish any hypertext links to this manual or
its content. Schneider Electric does not grant any right or license for the personal and
noncommercial use of the manual or its content, except for a non-exclusive license to consult it
on an "as is" basis, at your own risk. All other rights are reserved.
Electrical equipment should be installed, operated, serviced and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out
of the use of this material.
As standards, specifications and designs change from time to time, please ask for confirmation
of the information given in this publication.
Trademarks and registered trademarks are the property of their respective owners.
Hikvision Integration with Security Expert

Contents
Introduction 4
Integration Architecture 4
Feature Support 5
Prerequisites 5

Installing the Video Service 7


Check the Services are Running 7

Programming Cameras in Security Expert 8


Port Settings 8
Adding the DVR 8
Adding the Camera(s) 8
Linking a Camera to a Record 9
Including a Camera in a Status Page 9
Programming Camera Actions 10
Send PTZ Command on Event 10
Pop Up Camera Window on Event 10
The Camera Window 11

July 2021 3
Hikvision Integration with Security Expert Introduction

Introduction
The Security Expert Hikvision Video Service provides a seamless integration between Security
Expert and a Hikvision DVR system, enabling you to control cameras and view live and
historical video footage from a single, easy-to-use interface.
Cameras can be linked to doors, inputs, outputs and areas, allowing you to easily retrieve
footage based on any change of status, such as when a PIR is triggered or a door is opened. An
automatic popup can display a live video stream on any door event, allowing you to see when
someone is at the door or when a door has been forced open.
The included high level interface (HLI) enables the communication of PTZ triggers and alarm
interfaces back to the DVR, providing bi-directional exchange of information. If desired, VMS
events such as Motion Detected can be monitored directly in Security Expert.
The following instructions outline how to install the Hikvision Video Integration service and
configure the DVRs, cameras, and doors within Security Expert.

Integration Architecture
In this integration Security Expert communicates direcly with each DVR via the integration's
video service. This service monitors the two systems and sends any camera commands from
Security Expert to the DVR, and continuously transfers any events triggered in the DVR system
to Security Expert.

Video Service

Service Port DVR Port

Security Expert Server DVR

Ports
As shown in the diagram above, the video service communicates with Security Expert via the
Service Port, and with the DVR via the DVR Port. These ports are configured in the Security
Expert DVR programming.
The DVR port is determined by the DVR configuration. If required, the service port can be
customized when installing the video service. It is recommended to use the default ports where
possible.

The default ports can be found in the Port Settings section of the Security Expert
DVR programming instructions.

July 2021 4
Hikvision Integration with Security Expert Introduction

Feature Support
This integration enables you to:
l View live video footage from programmed cameras.
l View historic and archived video footage.
l Embed cameras into a status page.
l Link a camera to a door, input, output or area.
l View live or archived video footage directly from an event associated with a camera.
l Automatically launch a camera view window when specific types of events occur.
l Send PTZ preset commands to the VMS in response to a Security Expert event filter.
l View the following HLI events directly within Security Expert:
l Sensor Alarm
l Illegal Operation
l Record Abnormal
l Unknown Alarm
l Low Disk Space
l Motion Detected

Prerequisites
Software Requirements
All prerequisite software must be installed and operational, unless otherwise stated.

Software Version Notes


Security
Expert 4.3.264 or higher
software

This service must be installed on the Security Expert


server and every client machine that will use this
Security integration.
Expert
1.0.0.0 or higher This service is available in both 32-bit (x86) and 64-bit
Hikvision
(x64) versions.
Video Service
This document includes instructions for installing this
service below (see page 7).

This integration has been tested with Hikvision SDK


5.2.3.3 (x64) and versions 5.2.3.3 (x64) and 5.3.2.15 (x86). Integration
Hikvision SDK
5.3.2.15 (x86) with systems operating different SDK versions may
require additional testing.

The Security Expert integration communicates with the


Hikvision DVR via the Hikvision SDK. Therefore, this
Hikvision VMS N/A integration is compatible with any Hikvision system
that is supported by the connected DVR(s). For a list of
compatible devices visit the Hikvision website.

Microsoft .NET
4.6.2 or higher
Framework

Supported cameras are determined by the Hikvision system.

July 2021 5
Hikvision Integration with Security Expert Introduction

It is the responsibility of the installation professional to verify the version of the proposed third-
party system and supported components with the version listed in this document. Schneider
Electric will not accept responsibility for the failure to verify integrated system versions and
requirements.

Security Expert Licensing Requirements

License Order Code Notes


1 license required per camera programmed in Security
Expert.
A single camera is included with the Security Expert
standard or starter license.
Security Expert The base Security Expert license includes an
SX-CAM-10
Camera License unlimited number of DVRs and DVR HLIs. HLIs allow
bi-directional communication between Security Expert
and the DVR system. Note that this is separate to the
live and archived video display that is covered by a
camera license.

Time Settings
DVR integrations rely on the time being accurately configured for both the hardware and the
operating systems used in a site.
To ensure the system is keeping precise time, all devices should be set to synchronize with the
same NTP time server. NTP servers work by sending accurate time information periodically to
the system. Many corporate organizations have an NTP server running on the internal network,
allowing you to simply enter the relevant IP address. Alternatively, you could use any public
NTP server. Finding an NTP server relevant to your region is usually as simple as a quick web
search.
The same time server should be used for the workstations, DVRs and controllers within the site.
You can configure the time server for each computer in the Windows Date and Time settings,
and set a time server for the controller in the Sites | Controllers | Time Update settings in
Security Expert.

July 2021 6
Hikvision Integration with Security Expert Installing the Video Service

Installing the Video Service


The Security Expert Hikvision Video Service must be installed on the server and each client
machine that uses the integration. You must have administrator rights on each computer to
complete the installation.
1. Run the Security Expert Hikvision Video Service.exe file to launch the Security Expert
Hikvision Video service install wizard and click Next.
2. Select Complete for the installation type then click Next.
3. Click Install.
4. Enter the Service Port Number to be used for the integration (18000 is the default) and
click Next.
5. Click Finish.
6. If the Windows Defender Firewall is on, you will see a Windows Security Alert popup
indicating that some features of the integration service have been blocked.
To allow the service to function, check the boxes to allow the service to communicate on
Domain networks and Private networks (or as appropriate for your installation). Then click
Allow Access.

Check the Services are Running


The services used by the integration must be running for Security Expert to be able to
communicate with the Hikvision system.
1. Open the Services snap-in by:
l Pressing the Windows + R keys
l Typing services.msc into the search bar and pressing Enter
2. Scroll down and locate Security Expert Hikvision Video Service.
3. Ensure the service has started automatically (check the Status column to confirm that it's
'Running'). If not, right-click the service and select Start.
4. Ensure Security Expert DVR Service B is running.

July 2021 7
Hikvision Integration with Security Expert Programming Cameras in Security Expert

Programming Cameras in Security Expert


Port Settings
To configure the DVR in Security Expert you will need to enter the DVR Port and Service Port
settings, as described in the Integration Architecture section. It is recommended to use the
default ports where possible.
l Default DVR Port: 8000
l Default Service Port: 18000

Adding the DVR


From the main menu, navigate to Monitoring | Setup | DVRs. Add a DVR record and configure
the following options:
1. Enter the IP Address and DVR Port of the DVR.
The DVR port will depend on the configuration of the DVR itself.
2. Set the DVR Type to Custom.
3. Set the Service Port that was configured during the video service installation. This option is
only visible once the DVR Type is set to Custom.
The service port must be defined for the integration to work correctly. If necessary, it can
be changed in the config file for the service.
4. Enable the Monitor Events from this DVR/NVR option to start logging HLI events from
the DVR in Security Expert. The operator can right click any HLI event to view the footage
archived at the time the event was logged.
For camera motion events, the Monitor Events option must be enabled in the camera
settings in Security Expert. Note that motion detection must also be enabled for that
camera in the DVR system.
5. If required, enable the Connect to this DVR/NVR On Start Up option. When this option is
enabled, Security Expert will send a login request to the DVR when the client starts up.
Otherwise, Security Expert will not connect to the DVR until it needs to request a camera
list or footage.
6. If logging in to the DVR requires authentication, enable Logon Required and enter the
Username and Password required to access the DVR.

Adding the Camera(s)


Once the DVR has been configured, you can add a record for each of the installed cameras,
enabling you to view live and historical (archived) video feeds directly from a status page or floor
plan.
1. From the main menu, navigate to Monitoring | Setup | Cameras. Add a new camera with a
descriptive name.
2. Set the Type to DVR and select the DVR you created earlier.
3. On the DVR Camera Name row, select the [...] button to open the Select Camera window.
4. The window should display a list of cameras connected to the selected DVR. Highlight the
camera you want to use and click Select.
5. Set the required display options:
l Show Sidebar Controls in Status Page: When this option is enabled, PTZ controls
are displayed by default when the camera feed is viewed on a status page. When this
option is disabled the control sidebar can be opened but will not be displayed by default.

July 2021 8
Hikvision Integration with Security Expert Programming Cameras in Security Expert

l Stretch Image: When this option is enabled the camera image will be stretched to fill
the tile where it is displayed. This may not preserve the aspect ratio.
l Floor Plan: The floor plan the camera belongs to. This allows you to right click on a
camera event in the event log and open the floor plan associated with the camera.
6. Enable the Monitor Events option if you wish to log HLI events from the DVR system.
This setting must be used in conjunction with the Monitor Events from this DVR option of
the DVR record. It enables certain camera events, such as motion detected, to be logged
from the DVR/NVR. The operator can then right click the event and select the camera to
view the footage archived from the time the event was logged.

Linking a Camera to a Record


Linking a camera to a record enables you to view a live or archived feed by right clicking a record
or any associated event. Cameras can be linked to doors, inputs, outputs or areas, allowing you
to track any status changes, such as when a PIR is triggered or an area is disarmed.
If an event has a camera associated with it, a small yellow camera icon appears to the left of the
event. Right-clicking the event allows you to view the archived footage from the camera at the
time the event was logged.
If the door auto camera popup settings are enabled, Security Expert will automatically display a
window with the live camera feed whenever a door event is triggered, or if a door is forced open.
1. Select the door, input, output or area you wish to link the camera to (from the appropriate
Programming menu).
2. In the General tab, scroll down to Graphics. Set the Camera which is monitoring that
physical space.
For doors, you can set a Camera (Entry) and Camera (Exit). Depending on where the
camera is located, you may wish to use the same camera for both entry and exit, or select a
different camera for each.
3. For doors, you can set the following Auto Popup Options:
l Auto Camera Popup on Any Door Event: When enabled, displays a popup window
showing a live camera feed when any door event is triggered.
l Auto Camera Popup on Door Forced Event: When enabled, displays a popup
window showing a live camera feed when a forced door event is triggered.
l Select the Camera to be displayed in the popup window.
4. Save your changes.
5. To view the camera feed, right click on the record in the programming window or status list
and click the Camera button. Right click any events associated with that record to view
either live footage or archived footage from the time of the event.

Including a Camera in a Status Page


A camera can also be included in a status page for live viewing of video footage while monitoring
a site.
1. Open the Status Page Editor (Monitoring | Setup | Status Page Editor). Select an
existing status page to update, or create a new status page by clicking Add and choosing a
layout.
2. Select the panel where you wish to display the camera and set the Type to Camera.
3. For the Record, select the camera that you wish to display.
4. Save your changes.
5. Navigate to Monitoring | Status Page View to view the camera feed on your status page.
Click the arrow button on the upper right of the panel to display PTZ arrows, which can be
used to pan, tilt and zoom a PTZ camera.

July 2021 9
Hikvision Integration with Security Expert Programming Cameras in Security Expert

You can also include camera HLI events on a status page. You can do this by including a panel
that displays All Events. Alternatively, you can create an event report that displays only camera
HLI events, and display that on the status page:
1. Navigate to Events | Event Filters and create a new event filter which will filter for camera
HLI events.
2. In the Event Types tab, disable Include All Event Types.
3. Click Add and expand the All PC Events section. Scroll down to the Camera events,
select the desired HLI events and drag and drop them onto the main window. Save the event
filter.
4. Navigate to Reports | Setup | Event and create a new event report to display the HLI
events.
5. Add the event filter created above.
6. Finally, to display the event report on a status page, navigate to Monitoring | Setup |
Status Page Editor. Select an existing status page to update or create a new status page.
7. Select a panel and set the Type to Event Windows. For the Record select the event report
created above.
8. Save your changes and navigate to Monitoring | Status Page View to view the events on
your status page. You can right click the events to open the camera window (see next page)
to the time of the event.
Note: Some HLI events require the corresponding camera feature to be enabled in the VMS
(such as motion detection).

Programming Camera Actions


Actions in Security Expert are triggered in response to particular events, as defined by an event
filter. There are two actions related to cameras: sending PTZ commands and popping up a
camera feed window.

Send PTZ Command on Event


Through the HLI, Security Expert can send PTZ commands to connected cameras in response
to particular events. This allows the system to physically move PTZ cameras to preset positions
to get the best view of the situation.
Before you begin, ensure that any cameras have PTZ enabled and the PTZ preset commands
are programmed in the VMS. Note down the Command String for each PTZ preset that you
wish to use. This is usually the name or index of the PTZ preset in the VMS.

See the documentation for your VMS for information on programming PTZ presets and viable
command strings. These cannot be programmed directly in Security Expert.

1. Navigate to Monitoring | Setup | PTZ Commands and create a new PTZ command.
2. Under Configuration, select the Camera which the command will be sent to, and type the
Command String that will be sent to the DVR.
3. Navigate to Events | Actions and create a new action.
4. Set the Event Filter to define the events that will trigger the action. If required, click the
ellipsis [...] button to break out the event filter programming window and create a relevant
event filter.
5. Select the PTZ Command created above.
6. Click Save.

Pop Up Camera Window on Event


Actions can be used to automatically trigger a live popup window when specific events occur,
such as when a door is left open or when an area alarm is triggered.

July 2021 10
Hikvision Integration with Security Expert Programming Cameras in Security Expert

1. Navigate to Events | Actions and create a new action.


2. Set the Type to Popup Camera Window.
3. Set the Event Filter to define the events that will trigger the action. If required, click the
ellipsis [...] button to break out the event filter programming window and create a relevant
event filter.
4. Select which camera to use. You can choose from:
l Default Camera Associated with Event.
l Door Entry Camera.
l Door Exit Camera.
l Select Camera from List.
5. Click Save to create the action.

The Camera Window


The camera window displays a split view showing archived and live camera footage. It can be
opened by right clicking on a record or event associated with a camera.
l The top left pane displays a 5 second looping video centered 2 seconds either side of the
time of the event.
l The top right pane displays a 30 second controllable window centered 15 seconds either
side of the time of the event. Drag the slider to adjust the image to any point within the 30
second period.
l The main lower pane displays the live camera view.
l The Archive View Controls allow you to select any date and time in the past.
l The Live View Controls provide PTZ camera control buttons, allowing you to
physically control a PTZ enabled camera.
l The options on the right provide control over the main view:
Select the tab on the side to switch between the two views as required.

July 2021 11
Schneider Electric
www.schneider-electric.com
© 2021 Schneider Electric. All rights reserved.
July 2021

You might also like