The following is an NVR integration that integration that requires an integration license and may require additional support than a standard SureView integration.
Important Note: HikVision also supports RTSP Live Streaming and Email/SMTP alarms using "Standards Based Integrations" - If the only required features for a project are Live Video and Alarms then using the Standards Based approach may be preferable than the more advanced and feature rich "Native Integration"
Integration Summary
What is HikVision? HikVision provide a wide range of video equipment but it is most commonly deployed as an NVR
Integration Description: The Integration is a native NVR integration that allows a user to view live camera and perform remote tasks such as PTZ control, relay activation/deactivation, perform audio communication. A variety of this functionality can be used via the SureView platform, Please see the features list for a full breakdown of this.
Supported Features
- Live Video
- PTZ Control (including Presets)
- Audio
- Alarms (via standard email protocols)
Components and Communication
From |
To |
Port |
Use |
SureView OpsLink+ Server |
HikVision NVR |
8000 |
Server Port (default port) |
SureView OpsLink+ Server |
HikVision NVR |
554* |
Live Video RTSP |
SureView OpsLink+ Server |
cloudlink.sureviewops.com |
443 TCP |
Connection to SureView Ops |
SureView OpsLink+ Server |
download.sureviewsystems.com |
443 TCP |
SureView Software Updates and install packages |
* Please note that the RTSP port configured on the device must be the same port used to access the stream externally. This integration connects to the device to determine the port to be used
Prerequisites
Recommended: Ops Link+
Ops Link Setup
Configuration
The following are the steps required to configured HikVision work with the Sureview.
Before you begin
Before you configure your Hikvision system to work with Sureview make sure you have the following:
- An Ops Link+ installed on to the local network
- All required ports configured (see Components and Communication)
- Username and password of your HikVision Recorder(s)
Hikvision - Identify the correct video ports
- Login to the HikVision Device's web interface
- Go to the "Configuration" section
- Go to the "Network" section
- "Go to the "Port" section
- Make a note of the two ports:
RTSP Port (default 554)
Server Port (default 8000)
SureView Device Setup
Note: HikVision is an advanced integration and must be configured using the using advanced "Device Setup" page and the "Device Configuration" feature
Field | Value |
Title | The friendly name of the Hikvision you are connecting to |
Area | The Area/site that the HikVision devices/cameras will be added to |
Type | Select " HikVision (On-Premise)" |
Ops Link | The name of your connected OpsLink+ server |
Host | The local IP address of the Hikvision (from the perspective of the OpsLink+ server) |
Port | The Server Port of your HikVision. (Default 8000) |
Username | Your Hikvision username |
Password | Your Hikvision password |
Enable Sub Stream: |
false = use main stream |
Camera Numbers
When setting up cameras their camera number ("input1") needs to be configured based on the type of camera channel. Analogue Cameras start at "1" and IP Cameras start at "101"
Analogue Camera 1 = Sureview Camera 1
Analogue Camera 2 = Sureview Camera 2
Analogue Camera 3 = Sureview Camera 3
IP Camera 1 = Sureview Camera 101
IP Camera 2 = Sureview Camera 102
IP Camera 3 = Sureview Camera 103
You can check the numbering of your cameras in the HikVision's native / web interface.
- Login to HikVision
- Go To Configuration
- Go to Video/Audio
- Click the camera drop down to see the list of your connected cameras and their numbers
In the example below
[A2] = Analogue 2 = SureView Camera (Input1): 2
[A3] = Analogue 3 = SureView Camera (Input1): 3
[A4] = Analogue 4 = SureView Camera (Input1): 4
[A5] = Analogue 5 = SureView Camera (Input1): 5
[D1] = Digital (IP camera) 1 = SureView Camera (Input1): 101
Important
500 Action 'CameraStartLive()' failed: Error: Channel number error. There is no corresponding channel number on the device
If you see the above error when trying to connect to a camera (this will be shown in the health history in the Status section) - this likely means you have entered the wrong Camera Input Number during Setup
Double check your camera numbers, making sure they match the format described above. With Analogue Cameras using the "Input1" values 1,2,3 etc and Digital/IP Cameras using the "Input1" values 101,102,103
Enabling PTZ
To enable operator controlled "Physical PTZ" navigate to the Cameras section and edit the individual camera. Within the Editing Camera box click the "PTZ" checkbox and Save
Adding Presets
To add operator controlled "Physical PTZ Presets" navigate to the Cameras section and edit the individual camera. Within the Editing Camera box click "Add New Preset" and create your Preset Position and Name. Press Save when complete
Using PTZ & Presets
- Open the Camera window/cell (e.g. in Media Matrix when processing an event)
- Click on the Cog icon in the corner of the camera window (hover over the live camera view to display it)
- Untick "Digital PTZ" - You can now click on the sides of the camera view to control the Physical PTZ of the camera
- To use Presets, click on the "Preset" drop-down and select the required Preset - The camera will automatically move to that preset.
Adding Audio Channels
Audio channels are automatically added by Get Configuration but if you need to add any manually you can follow the steps below
Note: The audio channel on “Input1: 0, Input2:-1” i used to transmit audio to any speakers (Tannoy) plugged directly into the Hikvision NVR/DVR
- In the "Device Setup" screen Edit the device
- Click "Audio" in the side bar
- Click the Add Audio button and configure the audio channel as required
Email Alarms
Email Example
This is an automatically generated e-mail from your IPC.
EVENT TYPE: Motion Detection
EVENT TIME: 2017-10-30,19:19:46
IPC NAME: IP CAMERA
CHANNEL NAME: Camera 01
CHANNEL NUMBER: 1
IPC S/N: DS-2CD2T25FD-I5WSGLE20170829AACH825182127
Basic SureView Alarm Setup
Basic Alarms - This is a simple configuration that will associate one HikVision alarming device to one individual alarm point.
- Login to SureView and navigate to the "Alarms" setup screen
- Make sure that the "Smtp Alarms" tab is selecterd
- Click "Add Alarm" - Complete the fields and press Add
Description Alarm Name
(Required)The friendly name for this alarm. This is the name that will be shown to the operator when it is triggered along with the subject of the email alarm (which includes the alarming channel number)
Recommended: The HikVision Device Name or Identifier
Area
(required)What Area is this alarm associated with. Linked Cameras
(Optional)You can link this alarm with specific cameras so that the cameras you choose popup automatically when an Operator opens this alarm. (See Video Device Setup) Action Plan
(Optional)An alarm can (optionally) be associated with an Action Plan. This will provide the operator with a set of instructions that they will be required to follow when processing this alarm. Alarm Decoder Leave Blank Priority
(Required)This is an indication of how important this alarm is. The higher the number, the more important the alarm.
Recommended: 100
Note: Priority 1000 (one thousand) and above should be reserved for your most serious alarms that require immediate attention from your operatorsGrouping
(Required)This allows you to decide how you want multiple instances of this alarm to be grouped when it goes into the Alarm Processing Queue. The options are:
-
By Area
Multiple separate alarms that are triggered for the same Area will be grouped together for the operator to process as a single event.
-
By Alarm
Multiple instances of this specific alarm will will be grouped together for the operator to process as a single event.
-
Not Grouped
This alarm will never be grouped with any other. Each time it's triggered it will come into the Alarm Processing Queue as a separate, individual alarm event.
Recommended: By Area
-
By Area
- Search for your newly created alarm point
- Copy the unique email address - this is what you will enter into the HikVision Alarm Setup
Advanced SureView Alarm Setup
Advances Alarms - This is a customer decoder which allows you to seperate out individual alarming cameras/channels/detectors for advanced alarm management.
The Advanced Decoder uses "Regular Expressions" (or RegEx) to match against the individual alarming channels. The below information is provided as a guide however varying HikVision devices and models may have different alarming text requiring adjustemnts to the decoder. SureView does not gaurntee that the below RegExes will be compatible with all HikVision devices.
It's recommended that anyone using the decoder functionality spends time familiarisng themsleves with Regular Expressions - https://regexone.com/
Create the Decoder
Important: A seperate decoder is required per individual alarming Hikvision Device
- Login to SureView and navigate to the "Alarms" setup screen
- Click on the "Alarm Decoder" Tab
- Click "Add Alarm Decoder" and complete the following values
Title | Area / Device Name - Hikvision Decoder |
Response Regex |
(CAMERA|ALARM|Channel) NAME\(NUM\):\s+(?<CameraName>[^\r\n]+)\((?<type>A|D)?(?<rc>\d+) |
Event Regex |
EVENT TYPE:\s+(?<ec>[^\r\n]+) |
Default Area | The Area (site) of your Hikvision device |
Default Action Plan | Select your preferred Action Plan or leave blank |
Default Grouping | Select your preferred Default Grouping Recommended "By Area" |
Default Priority | Enter your preferred default priority Recommended: 100 |
Add the Event Types
Optional step - Event Types allow for greater flexibility and reporting but do not need be included for the decoder to function.
If your decoder is not already open:
- Login to SureView and navigate to the "Alarms" setup screen
- Click on the "Alarm Decoder" Tab
- Edit the required Decoder
- Add / Edit the Event Types as needed
The Exact Event Types may depend on your individual hikvision and alarm setup. Below are some examples
Event Type Name | Event Code | Default Priority | Default Grouping |
Motion Detected | Motion Detected | 100 | Inherit |
Add your Alarm Points
Important: In this section you will add an alarm point for each individual channel / detector
- Login to SureView and navigate to the "Alarms" setup screen
- Make sure that the "Smtp Alarms" tab is selecterd
- Click "Add Alarm" - Complete the fields and press Add
Description Alarm Name
(Required)The friendly name for this alarm. This is the name that will be shown to the operator when it is triggered along with the subject of the email alarm (which includes the alarming channel number)
Recommended: The HikVision Device Name or Identifier
Area
(required)What Area is this alarm associated with. Linked Cameras
(Optional)You can link this alarm with specific cameras so that the cameras you choose popup automatically when an Operator opens this alarm. (See Video Device Setup) Action Plan
(Optional)An alarm can (optionally) be associated with an Action Plan. This will provide the operator with a set of instructions that they will be required to follow when processing this alarm. Alarm Decoder Select the required Alarm Decoder
Important: This must be the specific decoder for the specific HikVision Device
Response Code Enter the Camera / Channel / Detector Number Priority
(Required)This is an indication of how important this alarm is. The higher the number, the more important the alarm.
Recommended: 100
Note: Priority 1000 (one thousand) and above should be reserved for your most serious alarms that require immediate attention from your operatorsGrouping
(Required)This allows you to decide how you want multiple instances of this alarm to be grouped when it goes into the Alarm Processing Queue. The options are:
-
By Area
Multiple separate alarms that are triggered for the same Area will be grouped together for the operator to process as a single event.
-
By Alarm
Multiple instances of this specific alarm will will be grouped together for the operator to process as a single event.
-
Not Grouped
This alarm will never be grouped with any other. Each time it's triggered it will come into the Alarm Processing Queue as a separate, individual alarm event.
Recommended: By Area
-
By Area
- Repeat these steps for each HikVision Alarming Channel / Camera/ Detector
- Search for your newly created alarm points - the Email Address should all be the same (One unqique address per HikVision Device / Decoder)
- Copy the unique email address - this is what you will enter into the HikVision Alarm Setup
HikVision Configuration
Note: Exact steps may differ between HikVision versions
- Log in to the device's web interface and select 'Configuration'.
- Go to the Network Configuration - Email Section
- Enter the "Direct to Ops" SMTP Server Details - See SMTP Support Page
- In the TO/From Address: Enter the unique email address provided by either the "Basic SureView Alarm Setup" or "Advanced SureView Alarm Setup"
- Enable "Attached Image" to include an alarm snapshot or clicp
- Configure your alarming cameras / detectors as required - Making sure to select "Send Email" as the alarming option.
Troubleshooting
500 Action 'CameraStartLive()' failed: Error: Channel number error. There is no corresponding channel number on the device
If you see the above error when trying to connect to a camera (this will be shown in the health history in the Status section) - this likely means you have entered the wrong Camera Input Number during Setup
Double check your camera "Input" numbers in sureview, making sure they match the SureView format
Analogue Cameras shoud be numbered 1,2,3 etc
Digital/IP Cameras numbered 101,102,103
Comments
0 comments
Please sign in to leave a comment.