Pelco Edge Analytics Milestone MIP Plugin – User Manual
Operating Manual
Pelco Analytics on the edge integration
03.02.2014
© 2013 by EET Security / DFR-CH
1
Pelco Edge Analytics Milestone MIP Plugin – User Manual
1
General behavior of this Document ................................................................................................ 3
2
Pelco Edge Analytics MIP Plugin for the XProtect Event Server...................................................... 4
3
2.1
Installation of the Pelco Edge Analytics Plugin for the XProtect Event Server ....................... 4
2.2
Configuration of the Pelco Edge Analytics Plugin for the XProtect Event Server ................... 5
2.2.1
Prepare your Milestone XProtect System ....................................................................... 6
2.2.2
License ............................................................................................................................. 7
2.2.3
Device and Event configuration ...................................................................................... 7
2.3
Create an Alarm Definition related to the Triggered Manual Event / or Analytics Event ..... 11
2.4
View the Alarms using the Smart Client and Analytics Event ............................................... 12
Pelco Edge Analytics Overlay MIP Plugin for the XProtect Smart Client ....................................... 13
3.1
Installation of the Pelco Edge Analytics Overlay Plugin for the XProtect Smart Client ......... 13
3.2
Configuration of the Pelco Edge Analytics Overlay Plugin for the XProtect Smart Client..... 15
3.3
View the Alarms using the Smart Client with the Smart Analytics Overlay Plugin ............... 15
3.3.1
Live mode: ..................................................................................................................... 15
3.3.2
Playback mode / Instant playback: ................................................................................ 16
3.3.3
Alarm-Manager: ............................................................................................................ 16
3.4
03.02.2014
Temperature Data trending .................................................................................................. 17
© 2013 by EET Security / DFR-CH
2
Pelco Edge Analytics Milestone MIP Plugin – User Manual
1 General behavior of this Document
This document is targeting integrators and users of the Pelco Anayltics integration for Milestone
XProtect VMS.
The SmartSoftware plugins from EET Security are deeply integrated into the Milestone XProtect VMS
Platform and don’t need any additional Software. MIP (Milestone Integration Platform) Plugins are
dynamically loaded from the Milestone Applications and Services, which allows a simple installation
and configuration. This document describes how to setup and configure your System to enable the
Pelco Device Analytics in your Milestone VMS.
The Architecture of the MIP Plugin is as follows:
The “Smart Pelco Analytics” integration consists of two different Plugins for the Milestone VMS. One
is installed on the Server side for the configuration and retrieval of events and is running inside the
Milestone Event Server. The other one is for drawing overlays in the Smart Client, dependent of the
Pelco device you are using.
The Installer SS_ER_SmartPelcoAnalytics_vX_X_RX_Setup.exe includes all the necessary Files and
installers for both plugins.
03.02.2014
© 2013 by EET Security / DFR-CH
3
Pelco Edge Analytics Milestone MIP Plugin – User Manual
2 Pelco Edge Analytics MIP Plugin for the XProtect Event Server
The following chapters describes how to install, configure and use the Server side XProtect Event
Server Plugin, which gets the Analytics events from your Pelco Device and converts them into a
Milestone XProtect format.
2.1 Installation of the Pelco Edge Analytics Plugin for the XProtect Event
Server
The installation of the Plugin is packed into a Setup Wizard, which will setup everything needed in
your Environment. The Setup Wizard will do the following job:
-
It installs the Plugin directly on the Master Server when you are using XProtect Express,
Professional or Enterprise.
It adds the Smart Analytics Overlay Smart Client Plugin to the Milestone Download Manager
If you are using XProtect Corporate, then the installer must been run on the XProtect
Corporate Management Client PC and on the XProtect Event Server.
It will Stop and Restart the Event Server Service to activate the Plugin in the Event Server
It will add the rule “Pelco Analytics UPnP Receiver Port” to your Windows Firewall to allow
incoming connections on TCP port 49732
The installer will copy the Plugin files into the following Directory:
o
o
%ProgramFiles%\Milestone\MIPPlugins\ER.EventServer.EdgeAnalytics
%ProgramFiles (x86)%\Milestone\MIPPlugins\ER.EventServer.EdgeAnalytics
The Event Server MIP Plugin is dynamically loaded and used by the following XProtect Applications:
XProtect Application:
Event Server
Description:
The Event Server will load the plugin which is
fetching the Analytics Events from the Pelco
Camera and triggers the configured Manual Event
in the XProtect Server.
This Manual Event can then be used for creating
an Alarm definition.
XProtect Version:
All
Management
Application
The Management Application loads the Plugin to
provide the configuration GUI.
Express,
Professional,
Enterprise
Management Client
The Management Application loads the Plugin to
provide the configuration GUI.
Corporate
03.02.2014
© 2013 by EET Security / DFR-CH
4
Pelco Edge Analytics Milestone MIP Plugin – User Manual
2.2 Configuration of the Pelco Edge Analytics Plugin for the XProtect Event
Server
After the installation you can start your XProtect Management
Application. After the first start you will find a new Entry under
“MIP Plug-Ins” called “Device Analytics Events”.
03.02.2014
© 2013 by EET Security / DFR-CH
5
Pelco Edge Analytics Milestone MIP Plugin – User Manual
2.2.1
Prepare your Milestone XProtect System
First of all, you need to add your Pelco Device to the configuration. To do that you need to prepare
the following:



Add your Pelco Device to your XProtect Server
Create the Manual Events (User-defined Events) to be triggered from the Events of this
Device.
Create the Analytics Events to be triggered from the Events of this Device.
This will allow detailed information about your Alarm including overlay drawings, dependent
on the Analytics Events coming from your device. Using Analytics Events provides the Meta
data in the Alarm Manager of your Smart Client.

If you are using Pelco
Thermography cameras with
temperature monitoring
values, we recommend to
change the Event Server
settings “Keep events for: ” to
your desired value (eg. 30
days)

If you are using Pelco Thermography cameras, you also have to check your Firewall to allow
incoming connections on TCP port 49732 (Event Server).
03.02.2014
© 2013 by EET Security / DFR-CH
6
Pelco Edge Analytics Milestone MIP Plugin – User Manual
2.2.2
License
If you select the “Device Analytics Events” entry you can manage your License:
2.2.3
Device and Event configuration
When everything is configured, you can select the “Pelco
Device Analytics” entry.
03.02.2014
© 2013 by EET Security / DFR-CH
7
Pelco Edge Analytics Milestone MIP Plugin – User Manual
Press “Add” to
enter the device
configuration:
You can directly
import the
configuration data
by selecting the
desired Camera
from the DropDown
List.
Open the Pelco Analytics Configuration in a separate Window to create the Analytics Events (if not
already done).
03.02.2014
© 2013 by EET Security / DFR-CH
8
Pelco Edge Analytics Milestone MIP Plugin – User Manual
With “Start Event Scan” you can check the connection to the Device and listen for Events.
If an Event from the Camera is received, it will automatically appear in the List. Using a Pelco
Thermography Camera with temperature monitoring, all monitored Zones will appear automatically
in the List.
You now can select a Manual Event from the Dropdown list of this Entry and/or configure if you want
to send an Event of the type AnalyticsEvent with a specific name. For each Zone a specific Color and
Overlay Text Position can be selected (the Overlay Text position is just used for the temperature
monitoring values.)
Note:
If you add analytics events from your Pelco Device manually, the Zone Name and behavior /
Analytics Event Type must exactly match the one in your device configuration! Otherwise the
alarms will not be forwarded to your Milestone VMS.
03.02.2014
© 2013 by EET Security / DFR-CH
9
Pelco Edge Analytics Milestone MIP Plugin – User Manual
By pressing “Apply” this Pelco Analytics Device is added to your Configuration.
After pressing “Save and load” the new Configuration is stored on the Server and the Process running
in the Event Server is informed about the Configuration change.
03.02.2014
© 2013 by EET Security / DFR-CH
10
Pelco Edge Analytics Milestone MIP Plugin – User Manual
2.3 Create an Alarm Definition related to the Triggered Manual Event / or
Analytics Event
03.02.2014
© 2013 by EET Security / DFR-CH
11
Pelco Edge Analytics Milestone MIP Plugin – User Manual
2.4 View the Alarms using the Smart Client and Analytics Event
If you use Analytics Events, you will see the Meta data received from the camera drawn on the
recorded Image. This enables the operator to verify the Alarm.
03.02.2014
© 2013 by EET Security / DFR-CH
12
Pelco Edge Analytics Milestone MIP Plugin – User Manual
3 Pelco Edge Analytics Overlay MIP Plugin for the XProtect Smart
Client
The following Chapter describes, how to install configure and use the advanced overlay plugin for the
Smart Client. With this plugin you are able to show detected alarms directly in the Smart Client as an
overlay drawing in real time or in playback mode. This is useful to have an immediate indication for
security purposes or to show the values of a Pelco Thermography camera with temperature
monitoring.
3.1 Installation of the Pelco Edge Analytics Overlay Plugin for the XProtect
Smart Client
The installation of the Plugin is packed into a Setup Wizard, which will do everything needed in your
Client Environment. This installer file is added during the Server Installation Setup to the Milestone
Download Manager and is available from the Internal XProtect VMS Download page:
Address for Milestone XProtect SMB – Express, Professional and Enterprise:

http://xprotectserveraddress:port/
Address for Milestone XProtect Advanced VMS – Expert and Corporate:

http://XProtectManagementServerAddress:port/Installation
03.02.2014
© 2013 by EET Security / DFR-CH
13
Pelco Edge Analytics Milestone MIP Plugin – User Manual
Download the “ER Smart Pelco Analytics overlay x.x.x.x – Smart Client Plugin” file and follow the
instructions of the Setup Wizard. It will do the following tasks:
-
It installs the Plugin into the MIP Plugins directory of the Smart Client
The installer will copy the Plugin files into the following Directory:
%ProgramFiles%\Milestone\XProtect Smart Client\MIPPlugins\ER.SmartClient.SmartAnalyticsOverlay\
The Smart Analytics Overlay MIP Plugin is dynamically loaded and used by the following XProtect
Applications:
XProtect Application:
Smart Client
03.02.2014
Description:
The Smart Client will load the Plugin dynamically.
© 2013 by EET Security / DFR-CH
XProtect Version:
Smart Client 7.0 or
higher
14
Pelco Edge Analytics Milestone MIP Plugin – User Manual
3.2 Configuration of the Pelco Edge Analytics Overlay Plugin for the
XProtect Smart Client
There is no specific configuration to do in the Smart Client. The Plugin will detect incoming Events
and their source and will show it directly as an overlay in the live/playback mode for each configured
camera in the current displayed view.
3.3 View the Alarms using the Smart Client with the Smart Analytics
Overlay Plugin
3.3.1
Live mode:
To enable and disable the Overlay drawing you can use the button on the bottom of the Camera
View item, or the generic function on the left which disables the overlay drawings for all View items.
03.02.2014
© 2013 by EET Security / DFR-CH
15
Pelco Edge Analytics Milestone MIP Plugin – User Manual
3.3.2
Playback mode / Instant playback:
3.3.3
Alarm-Manager:
In the Alarm-Manager view, there is just the overlay visible, which is related the triggered Alarm:
03.02.2014
© 2013 by EET Security / DFR-CH
16
Pelco Edge Analytics Milestone MIP Plugin – User Manual
3.4 Temperature Data trending
Using the Pelco Edge Analytics Overlay Plugin together with a Pelco Thermography Camera, it is
possible to create Temperature data trending charts which are synchronized with the related
recordings.
 Use the Button “Create Trend Report” on the
left side panel in the Smart Client to open
the Trending Window.
Note:
Please note, that the trending chart is using all data points from the Event Server database.
Temperature values are recorded every 10 seconds.
Loading data and creating the chart can take some time and a big amount of data can slow
down the response time of the resulting chart.
 1 month have approx. 250’000 data points per Zone
03.02.2014
© 2013 by EET Security / DFR-CH
17
Pelco Edge Analytics Milestone MIP Plugin – User Manual
 Use the Thermography camera as source
 Select Start- and End time of the desired period to analyze
 Press Refresh to acquire the data
 Playback Video by clicking into the chart
 Mark a range with the mouse to zoom
into the graph
 Use the button on the left bottom corner
to zoom out.
Use the “Export” functionality to get a *.csv file with all data points for each Zone, a *.csv file which
combines all values and the picture of the actual visible chart.
With the “Print” function it is possible to directly print a short report containing currently selected
Video Image and data, the Chart and min. and max. values for each Zone over the selected Time
period.
03.02.2014
© 2013 by EET Security / DFR-CH
18
Pelco Edge Analytics Milestone MIP Plugin – User Manual
Contact us:
EET Europarts
Bösch 80a
CH-6331 Hünenberg
Tel.: +41 41 785 13 13
mail: [email protected]
web: http://smart.eetsecurity.ch
03.02.2014
© 2013 by EET Security / DFR-CH
19