Actions

Difference between revisions of "Integration with Milestone XProtect (IP CCTV)"

From Zenitel Wiki

(Matrix function)
 
(167 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Situation==
+
{{A}}
When a master station is receiving [[Call Request]]s from a [[substation]], an event can be activated to control the Milestone IP Video surveillance system. Using the AlphaCom's EDO port the system allows for a few simple events to control cameras located in association with a station. When scrolling the queue, the event handler transmits commands related to the selected station. In this way the picture on the monitor will follow the queue navigation on the master station.
+
{{obsolete}}
 +
For integration with Milestone, please see:
 +
* [[Milestone XProtect - ICX-AlphaCom Integration]]
 +
* [[Milestone XProtect - IC-Edge Integration]]
  
If any new call requests are received while in conversation, this will not influence on the active image. When the conversation is cancelled, and there are still calls in the queue, the image assosiated to the first station in queue will be displayed.
+
----
  
 +
'''Note:''' The Milestone version described in this article is obsolete. Please refer to the following articles:
 +
* Integration with [[Milestone XProtect - Expert and Corporate]]
 +
* Integration with [[Milestone XProtect - Professional and Enterprise]]
 +
----
  
 +
This article describes how to interface the AlphaComE with the [http://www.milestonesys.com/ | Milestone XProtect Professional IP Video platform]. XProtect Professional is a product for small to mid-sized installations, supporting up to 64 cameras simultaneously.<br> Milestone also has products which support many more cameras.
 +
[[Image:Milestone config example.png|thumb|400px|AlphaCom and Milestone integration]]
 +
==Feature==
 +
When a master station receives [[Call Request]] from a substation, or when a conversation is made, action strings can be sent from the AlphaCom to the Milestone IP Video surveillance system using the AlphaCom's [[EDO|EDO port]]. Using the [[Event Handler]], a few simple events allows control of cameras located in association with a substation. When scrolling the queue, a command related to the selected station is transmitted. In this way the picture on the monitor will follow the queue navigation on the master station.
 +
 +
If any new call requests are received while in conversation, this will not influence on the active image. When the conversation is cancelled, and there are still calls in the queue, the image associated to the first station in queue will be displayed.
 +
 +
 +
Software requirement:
 +
* [[downloads|AMC 10.56 or higher]]
 +
* [[downloads|AlphaPro 11.1.3.0 or higher]]
 +
* Milestone XProtect Professional ver.7 or 8
  
 
== Configuration of  Milestone XProtect ==
 
== Configuration of  Milestone XProtect ==
 +
[[Image:Milestone config example 2.png|left|thumb|500px|Example: Server and the Smart Client are running on the same PC (i.e. same IP address)]]
 +
<br style="clear:both;" />
 +
It is assumed that a Milestone XProtect system is already installed and up and running. The latest Milestone XProtect Professional and Smart client can be downloaded from Milestone [http://www.milestonesys.com/supportandservices/support/downloads/ here].
 +
 +
===Default TCP port usage===
 +
* TCP port 1234: Between AlphaCom and the Milestone XProtect Server
 +
* TCP port 80: Between the Server and the Smart Client
 +
* TCP port 12345: Used for transferring Matrix-triggered images from the Server to the Smart Client view
 +
 +
===Defining new cameras===
 +
[[Image:Milestone add camera.png|left|thumb|500px|Using the Administrator tool to add a new camera]]
 +
<br style="clear:both;" />
 +
To add a new camera:
 +
* The PC and the camera must have IP addresses belonging to the same subnet
 +
* start the '''Administrator''' tool and select '''Add Device'''
 +
* Enter the IP address of the camera, then '''Next'''
 +
* Enter the password for the camera (e.g. "root" for Axis cameras), and select "Auto Detect Type", then '''Next'''
 +
* Now the camera should be detected, press '''Next'''
 +
* Enter a suitable name, then '''Finnish'''
 +
 +
===Setting up a Smart Client user===
 +
The ''Smart Client'' provides remote users with access to the Milestone Image Server.
 +
====Create a user====
 +
[[Image:Milestone New User.png|left|thumb|500px|Image Server Administrator: Adding a new user]]
 +
<br style="clear:both;" />
 +
 +
* Start the '''Image Server Administrator''' application. The Image Server is the service handling Smart Client access to the Milestone XProtect Professional system.
 +
* Under "User Administration" select "Full access for all users" and press the button "User Setup"
 +
* Press '''Add Basic User''', and enter a Username (say 'Peter') and a Password (say '6789')
 +
* The server is by default using port 80, this can be changed in the '''Port''' field under "Server Configuration"
 +
<br style="clear:both;" />
 +
 +
====Smart Client Login====
 +
[[Image:Smart Client login.png|left|thumb|500px|Smart Client login]]
 +
<br style="clear:both;" />
 +
 +
Start the '''Smart Client''' application, and specify your login information in the following fields:
 +
*'''Server address:''' Enter the IP address and port number of the server (for example http//:10.5.101.112:80). The Server and the Smart Client may run on the same PC, which is typical for a single user or when used for demos. If they do run on the same PC, use the IP address 127.0.0.1 (i.e. http//:127.0.0.1:80).
 +
* '''Authentication''': Select ''Basic Authentication''
 +
* '''User name''': Enter the username created in the Image Server Administrator, e.g. 'Peter'
 +
* '''Password''': Enter the password created in the Image Server Administrator, e.g. '6789'
 +
<br style="clear:both;" />
  
 
===Matrix function===
 
===Matrix function===
[[Image:Nilestone Matrix setup.png|thumb|Matrix configuration on server]]
+
[[Image:Nilestone Matrix setup.png|left|thumb|500px|Matrix configuration on server]]
It is assumed that a Milestone XProtect system is already installed and up and running, with some cameras defined and a Smart Client set up for picture viewing.
+
<br style="clear:both;" />
 +
 
 +
The Matrix function must be configured, as this function is required in order to have live images automatically presented on the required monitor when defined events occur. The Matrix function allows distributed viewing of live video from any camera on any monitor on a network operating with XProtect Professional. A computer on which Matrix-triggered video can be displayed is known as a Matrix recipient. Being able to view Matrix-triggered video requires that either a Smart Client or the dedicated Matrix Monitor software is installed on the user’s computer. This can be a separate computer, or it can be the same computer as running the server.
  
The Matrix function is required in order to have live images automatically presented on the required monitor when defined events occur. The Matrix function allows distributed viewing of live video from any camera on any monitor on a network operating with XProtect Professional. A computer on which Matrix-triggered video can be displayed is known as a Matrix recipient. Being able to view Matrix-triggered video requires that either a Smart Client or the dedicated Matrix Monitor software is installed on the user’s computer.
+
[[Image:SC Matrix setup.png|left|thumb|500px|Smart Client setup as Matrix recepient]]
 +
<br style="clear:both;" />
  
In the '''Administrator''' window select the '''Matrix''' button. The ''Config'' tab lets you define individual computers on which it should be possible to view Matrix-triggered content. Enable 'Milestone XProtect Matrix', and enter name, IP address of the matrix recepient, the port number (default 12345) and a password. You might have to open for this port in your Windows firewall.
+
A Matrix recepient (e.g. a Smart Client) must be defined in the XProtect Professional surveillance system server. Start the '''Administrator''' application, and select the '''Matrix''' button. The ''Config'' tab lets you define individual computers on which it should be possible to view Matrix-triggered content. Enable 'Milestone XProtect Matrix', and enter name, IP address of the matrix recepient, the port number (default 12345) and a password.  
 
<br style="clear:both;" />
 
<br style="clear:both;" />
[[Image:SC Matrix setup.png|thumb|Smart Client setup as Matrix recepient]]
+
To make the Smart Client work as a matrix recepient, start the '''Smart Client''' application and select the tab '''Setup'''. In the ''System Overview'' selection drag and drop the Matrix icon to the main window. While the main window is in focus, click the button '''Connection Settings''' in the ''Properties'' selection, and enter port numer 12345 and the same password as you entered in the Matrix setup in the Administrator program.
+
To make the Smart Client work as a matrix recepient, start the '''Smart Client''' application and select the tab '''Setup'''. In the ''Views'' right click on the ''Shared'' view and add New Group. Once the new group is created, right click and add New View and select the dimensions wanted. In the ''System Overview'' selection drag and drop the Matrix icon to the main window. While the main window is in focus, click the button '''Connection Settings''' in the ''Properties'' selection, and enter port number 12345 and the same password as you entered in the Matrix setup in the Administrator program.
 +
 
 
<br style="clear:both;" />
 
<br style="clear:both;" />
  
Line 23: Line 88:
  
 
==== Create Generic Events ====
 
==== Create Generic Events ====
[[Image:Milestone Add new event.png|thumb|An event which is triggered when receiving the string "Cam101" from the AlphaCom]]
+
EDO strings from the AlphaCom is used to control the pictures in the monitor. When a string sent from the AlphaCom is recognized by the Milestone server, the correct camera should show up in the monitor. We need to decide what string to use for each camera. Here is an example, which is used in this article:
We want to use EDO strings from the AlphaCom to control the pictures in the monitor. When a string sent from the AlphaCom is recognized by the Milestone, we want the correct camera to show up in the monitor. We need to decide what string to use for each camera. Here is a suggestion:
+
[[Image:Milestone Add new event.png|left|thumb|500px|The event "EntranceEvent" will be triggered when receiving the string "Cam101" from the AlphaComE]]
 +
<br style="clear:both;" />
  
 
{| border="1"
 
{| border="1"
Line 32: Line 98:
 
! style="background:#ffdead;" width="100" |Station dir.no
 
! style="background:#ffdead;" width="100" |Station dir.no
 
|-
 
|-
| Cam101 || align=center | Entrance || align=center | EntranceEvent || align=center |101
+
| Cam107 || align=center | Entrance || align=center | EntranceEvent || align=center |107
 
|-
 
|-
| Cam102 || align=center | Backdoor|| align=center | BackdoorEvent || align=center |102
+
| Cam108 || align=center | Backdoor|| align=center | BackdoorEvent || align=center |108
 
|-
 
|-
| Cam103 || align=center | Corridor|| align=center | CorridorEvent || align=center |103
+
| Cam109 || align=center | Corridor|| align=center | CorridorEvent || align=center |109
 
|-
 
|-
 
| CamOff || align=center | All|| align=center | DisconnectEvent || align=center | All stations
 
| CamOff || align=center | All|| align=center | DisconnectEvent || align=center | All stations
 
|-
 
|-
 
|}
 
|}
 +
Note that the EDO string is using the directory number of the station related to the camera, i.e. the camera of station 108 is triggered by the string "Cam108". This is convenient, as it simplifies the event handler programming in AlphaCom.
  
Create generic events in Milestone by selecting '''Administrator''' -> '''Generic Events''', and 'Add new event'. Add a new event for each camera.
+
The "CamOff" event is used to disconnect cameras from the monitor when there is no conversations and the call queue is empty.
 +
 
 +
Create generic events in Milestone by selecting '''Administrator''' -> '''Generic Events''', and 'Add new event'. Enter an 'Event name' and an 'Event message' according to the table above (or your own table). Add a new event for each camera.
 
<br style="clear:both;" />
 
<br style="clear:both;" />
  
 
==== Automatic Matrix Display on Events ====
 
==== Automatic Matrix Display on Events ====
[[Image:Milestone Matrix event.png|thumb|Define events]]
 
 
 
In the '''Administrator''' -> '''Matrix''' window, the ''Event'' tab is used for configuring the automatic sending of live video based on predefined events; it lets you define exactly which events and cameras to use. You define this on a per-Matrix recipient basis.
 
In the '''Administrator''' -> '''Matrix''' window, the ''Event'' tab is used for configuring the automatic sending of live video based on predefined events; it lets you define exactly which events and cameras to use. You define this on a per-Matrix recipient basis.
 
# In the '''Matrix''' window highlight the Matrix recipient, and select ''Event'' tab
 
# In the '''Matrix''' window highlight the Matrix recipient, and select ''Event'' tab
Line 53: Line 120:
 
#Now right-click the event to select which action should take place when the event occurs. Here, select 'Connect'.
 
#Now right-click the event to select which action should take place when the event occurs. Here, select 'Connect'.
 
#Right-click the action to select which camera to apply the action on
 
#Right-click the action to select which camera to apply the action on
# Repeat as required
+
# Repeat 1 to 5 as required
 +
[[Image:Milestone Matrix event.png|left|thumb|500px|Define events]]
 +
<br style="clear:both;" />
 +
 
 +
'''NOTE:''' For the changes to take effect, you have to quit the Administrator program by pressing the '''Exit''' button.
 
<br style="clear:both;" />
 
<br style="clear:both;" />
  
 
==AlphaCom configuration==
 
==AlphaCom configuration==
 +
=== Configure the Master station for Call Queueing===
 
A number of different station types can be used for call queuing. The station should use the [[Mail Queue Operation|763x codes]] for queue navigation. These directory numbers should be assigned to [[DAK]] keys. The station should be prepared for call queue operation, how to do this depends on the station type used:
 
A number of different station types can be used for call queuing. The station should use the [[Mail Queue Operation|763x codes]] for queue navigation. These directory numbers should be assigned to [[DAK]] keys. The station should be prepared for call queue operation, how to do this depends on the station type used:
 
* [[TouchLine station used for Call Queing]]
 
* [[TouchLine station used for Call Queing]]
Line 62: Line 134:
 
* [[Control Room Master IV|CRM IV station]]
 
* [[Control Room Master IV|CRM IV station]]
  
=== Communication setup ===
+
=== TCP/IP Communication setup ===
====EDO setup====
+
In AlphaPro, '''Exchange & System''' -> '''Serial Ports''', the EDO port must be configured to communiate with the computer running the Milestone XProtect server:
 +
[[Image:Milestone EDO config.PNG|left|thumb|500px|EDO port setup. Server IP address is 10.5.101.151, using port 1234]]
 +
<br style="clear:both;" />
 +
 
 +
* Port type: TCP/IP Client
 +
* IP address: The IP address of the Milestone XProtect server
 +
* Port: 1234
 +
* Enable "Connect at AlphaCom write, disconnect after each write"
  
[[Image:EDO setup Milestone.png|thumb|EDO setup. Select 'TCP/IP Client' mode, and specify the IP Address of the Milestone server, and the TCP port number]]
+
The Milestone XProtect Server is by default using TCP port 1234 for generic events. If required this port number can be modified from Milestone XProtect Administrator, '''I/O Setup''' -> '''Advanced''' -> '''Alert port'''.  
From AlphaPro, '''Exchange & System''' -> '''Serial Ports''', the EDO port must be configured to communiate with the computer running the Milestone XProtect server. The MileStone XProtect is by default using TCP port 1234 for generic events. If required this port number can be modified from Milestone XProtect Administrator, '''I/O Setup''' -> '''Advanced''' -> '''Alert port'''. The Windows firewall might have to be opened for this port.
 
  
====TCP/IP disconnection after data is sent====
+
'''Note!''' You might have to open TCP port 1234 in the Windows firewall of the computer running the Milestone server.
[[Image:TCP disconnect after send.png|thumb|Event which causes TCP disconnection on EDO port 1 after transmission]]
 
The Milestone XProtect server requires that the TCP/IP connection is disconnected after every transmission. The AlphaCom has an option to tear down the TCP connection after data is sent. To set this option an event must be used which writes to the relevant parameter into the AMC-IP memory at exchange startup. Create an event 27, subevent 65, When Change To: ON, Action: $SNV Q48 W5 W3 W6 W1 W0 W6 W4.
 
  
Include all substations with cameras in [[UDP group]] 2.
+
(Windows XP: Start > Control Panel > Windows Firewall > Exceptions tab > Add Port: Select port type '''TCP'''. Name: Milestone. Port number: '''1234''')
 +
<br style="clear:both;" />
  
 +
=== Event Handler configuration ===
 +
'''UDP Groups:'''
 +
* Include all substations with cameras in [[UDP group]] 2.
 +
<br>
 +
'''Event Handler configuration:'''<br>
 
The [[Event Handler]] is used to transmit commands through the EDO port to the Milestone IP Video system.  
 
The [[Event Handler]] is used to transmit commands through the EDO port to the Milestone IP Video system.  
  
A [[UDD]] is used to store the conversation status of the master station. 0 = no conversation, 1 = conversation. The index of the UDD is equal to the physical nymber of the master station. The UDD is checked when call requests are received or deleted. If there is a conversation active no commands should be transmitted. In addition UDD 600 is set if there is any priority mails in the queue at all.
+
In [[AlphaPro]], go to [[Exchange_%26_System_%28AlphaPro%29#Events|Exchange and System -> Events]], press Insert and create the following events:
  
 +
------------
 +
'''Event 1''' - An [[UDD]] is used to store the busy/free status of the master station. 0 = free, 1 = in conversation. The index of the UDD is equal to the physical number of the master station. The UDD is checked when call requests are received or deleted. If the station is in use, cameras should not be turned on (i.e. no commands should be transmitted).
 +
{|
 +
|-
 +
|width="100pt"|'''Event Owner''':
 +
|width="400pt"|The Master Station
 +
|-
 +
|'''Event type''': || [[Conversation Outgoing (Event Type)|08 - Conversation Outgoing]]
 +
|-
 +
|'''When change to''': || ON or OFF
 +
|-
 +
|'''When related to''': || All
 +
|-
 +
|'''Action''': || '''wudd|WUDD %1.phy %chg(1,0)'''
 +
|-
 +
|}
  
In [[AlphaPro]], go to [[Exchange_%26_System_%28AlphaPro%29#Events|Exchange and System -> Events]], press Insert and create the following events:
 
 
------------
 
------------
'''Event 1''' - When a conversation is made from the master station to the substation, set the conversation status in the UDD, and transmit camera commands to the IP Video system. Also check if the camera is not already active due to other events.
+
'''Event 2''' - When a conversation is made from the master station to a substation w. camera, transmit command "CamXXX" to the IP Video system, where XXX = the directory number of the substation.
 
{|  
 
{|  
 
|-
 
|-
 
|width="100pt"|'''Event Owner''':
 
|width="100pt"|'''Event Owner''':
|width="400pt"|The Master Station (or a [[UDP group]] of master stations)
+
|width="400pt"|The Master Station
 
|-
 
|-
 
|'''Event type''': || [[Conversation Outgoing (Event Type)|08 - Conversation Outgoing]]
 
|'''Event type''': || [[Conversation Outgoing (Event Type)|08 - Conversation Outgoing]]
Line 95: Line 192:
 
|'''When related to''': || Stations w. UDP, Id: 2
 
|'''When related to''': || Stations w. UDP, Id: 2
 
|-
 
|-
|'''Action''': || [[wudd|WUDD %1.phy 1]]
+
|'''Action''': || [[EDO]] 1 "Cam%2.dir"  
|-
 
| &nbsp; || [[IF/ENDIF|IF %udd(%2.phy)]]
 
|-
 
| &nbsp; || [[STOP]]
 
|-
 
| &nbsp; || [[IF/ENDIF|ENDIF]]
 
|-
 
| &nbsp; || [[EDO]] 1 "Cam%2.dir"
 
 
|-
 
|-
 
|}
 
|}
  
 
---------------
 
---------------
'''Event 2''' - When the conversation between the master and substation cancels, reset the conversation status (UDD), switch off the camera, and activate the MAILQ_NAVIG command. This command will step to the first in the queue, and re-trigger the '23 - New Current Mail' event.
+
'''Event 3''' - When the conversation between the master and any station cancels, switch off the camera ("CamOff"), and activate the MAILQ_NAVIG command. The MAILQ_NAVIG command will step to the first in the queue, and re-trigger the '23 - New Current Mail' event.
 
{|  
 
{|  
 
|-
 
|-
 
|width="100pt"|'''Event Owner''':
 
|width="100pt"|'''Event Owner''':
|width="400pt"|The Master Station (or a UDP group of master stations)
+
|width="400pt"|The Master Station
 
|-
 
|-
 
|'''Event type''': || 08 - Conversation Outgoing
 
|'''Event type''': || 08 - Conversation Outgoing
Line 120: Line 209:
 
|'''When change to''': || OFF
 
|'''When change to''': || OFF
 
|-
 
|-
|'''When related to''': || Stations w. UDP: Id 2
+
|'''When related to''': || All
 
|-
 
|-
|'''Action''': || [[wudd|WUDD %1.phy 0]]
+
|'''Action''': || [[EDO]] 1 "CamOff"
|-
 
| &nbsp; || [[wudd|WUDD %2.phy 0]]
 
 
|-
 
|-
 
| &nbsp; || [[MAILQ NAVIG|$MAILQ_NAVIG L%1.dir 2]]
 
| &nbsp; || [[MAILQ NAVIG|$MAILQ_NAVIG L%1.dir 2]]
|-
 
| &nbsp; || [[EDO]] 1 "cam off"
 
 
|-
 
|-
 
|}
 
|}
Line 134: Line 219:
 
------------------
 
------------------
  
'''Event 3''' - When receiving a Call Request or scrolling the queue, and the master station is not in conversation, activate the camera assosiated with the selected substation. Also set a UDD for the substation with the active camera.
+
'''Event 4''' - When receiving a Call Request or scrolling the queue, and the master station is not busy, activate the camera assosiated with the selected substation.
 
{|  
 
{|  
 
|-
 
|-
 
|width="100pt"|'''Event Owner''':
 
|width="100pt"|'''Event Owner''':
|width="400pt"|The Master Station (or a UDP group of master stations)
+
|width="400pt"|The Master Station
 
|-
 
|-
 
|'''Event type''': || [[New Current Mail (Event Type)|23 - New Current Mail]]
 
|'''Event type''': || [[New Current Mail (Event Type)|23 - New Current Mail]]
Line 154: Line 239:
 
| &nbsp; || [[IF/ENDIF|ENDIF]]
 
| &nbsp; || [[IF/ENDIF|ENDIF]]
 
|-
 
|-
| &nbsp; || [[EDO]] 1 "cam %2.phy on"
+
| &nbsp; || [[EDO]] 1 "Cam%2.dir"
 
|-
 
|-
| &nbsp; || [[wudd|WUDD %2.phy 1]]
+
|}
 +
 
 +
------------------
 +
 
 +
'''Event 5''' - The Priority Mail Present - OFF event is triggered when the queue of the master station is empty. The queue can become empty because the delete code 7630 has been dialled, in that case the cameras should be turned off. Or the queue can become empty because of call back to the last substation in queue, in that case we want the camera to remain on until the conversation is cancelled. We start a 0.5 second timer, and check if the master station is in conversation when the timer times out:
 +
{|
 +
|-
 +
|width="100pt"|'''Event Owner''':
 +
|width="400pt"|The Master Station
 +
|-
 +
|'''Event type''': || [[Priority Mail Present (Event Type) |06 - Priority Mail Present]]
 +
|-
 +
|'''When change to''': || OFF
 +
|-
 +
|'''Action''': || [[SET_TIMER|$ST L%1.dir w5 L9999]]
 
|-
 
|-
 
|}
 
|}
Line 162: Line 261:
 
------------------
 
------------------
  
'''Event 4''' - When a queue entry is deleted or scrolled away from, and the master station is not in conversation, switch off the camera:
+
'''Event 6''' - Half a second after the queue was empty, check if the station is in conversation, if not switch off the camera:
 
{|  
 
{|  
 
|-
 
|-
 
|width="100pt"|'''Event Owner''':
 
|width="100pt"|'''Event Owner''':
|width="400pt"|The Master Station (or a UDP group of master stations)
+
|width="400pt"|The Master Station
 
|-
 
|-
|'''Event type''': || [[New Current Mail (Event Type)|23 - New Current Mail]]
+
|'''Event type''': || [[Event Timeout (Event Type) |21 - Event Timeout]]
 
|-
 
|-
 
|'''Subevent''': || 0
 
|'''Subevent''': || 0
 
|-
 
|-
|'''When change to''': || OFF
+
|'''When change to''': || ON
 
|-
 
|-
|'''When related to''': || Stations w. UDP, Id: 2
+
|'''When related to''': || Directory number: 9999
 
|-
 
|-
 
|'''Action''': || [[IF/ENDIF|IF %udd(%1.phy)]]
 
|'''Action''': || [[IF/ENDIF|IF %udd(%1.phy)]]
Line 182: Line 281:
 
| &nbsp; || [[IF/ENDIF|ENDIF]]
 
| &nbsp; || [[IF/ENDIF|ENDIF]]
 
|-
 
|-
| &nbsp; || [[IF/ENDIF|IF %udd(%2.phy)]]
+
| &nbsp; || [[EDO]] 1 "CamOff"
|-
 
| &nbsp; || [[STOP]]
 
|-
 
| &nbsp; || [[IF/ENDIF|ENDIF]]
 
|-
 
| &nbsp; || [[EDO]] 1 "cam off"
 
 
|-
 
|-
 
|}
 
|}
  
------------------
+
== Related links and articles ==
 +
*  [{{SERVER}}/alphawiki/downloads/GenericEventTest.exe Generic_Event_tester]
 +
* Integration with [[Milestone XProtect - Expert and Corporate]]
 +
* Integration with [[Milestone XProtect - Professional and Enterprise]]
  
  
[[Category:Applications]]
+
[[Category:Discontinued Products]]

Latest revision as of 08:50, 16 August 2022

AlphaCom icon 300px.png
Obsolete icon This product is discontinued!


For integration with Milestone, please see:


Note: The Milestone version described in this article is obsolete. Please refer to the following articles:


This article describes how to interface the AlphaComE with the | Milestone XProtect Professional IP Video platform. XProtect Professional is a product for small to mid-sized installations, supporting up to 64 cameras simultaneously.
Milestone also has products which support many more cameras.

AlphaCom and Milestone integration

Feature

When a master station receives Call Request from a substation, or when a conversation is made, action strings can be sent from the AlphaCom to the Milestone IP Video surveillance system using the AlphaCom's EDO port. Using the Event Handler, a few simple events allows control of cameras located in association with a substation. When scrolling the queue, a command related to the selected station is transmitted. In this way the picture on the monitor will follow the queue navigation on the master station.

If any new call requests are received while in conversation, this will not influence on the active image. When the conversation is cancelled, and there are still calls in the queue, the image associated to the first station in queue will be displayed.


Software requirement:

Configuration of Milestone XProtect

Example: Server and the Smart Client are running on the same PC (i.e. same IP address)


It is assumed that a Milestone XProtect system is already installed and up and running. The latest Milestone XProtect Professional and Smart client can be downloaded from Milestone here.

Default TCP port usage

  • TCP port 1234: Between AlphaCom and the Milestone XProtect Server
  • TCP port 80: Between the Server and the Smart Client
  • TCP port 12345: Used for transferring Matrix-triggered images from the Server to the Smart Client view

Defining new cameras

Using the Administrator tool to add a new camera


To add a new camera:

  • The PC and the camera must have IP addresses belonging to the same subnet
  • start the Administrator tool and select Add Device
  • Enter the IP address of the camera, then Next
  • Enter the password for the camera (e.g. "root" for Axis cameras), and select "Auto Detect Type", then Next
  • Now the camera should be detected, press Next
  • Enter a suitable name, then Finnish

Setting up a Smart Client user

The Smart Client provides remote users with access to the Milestone Image Server.

Create a user

Image Server Administrator: Adding a new user


  • Start the Image Server Administrator application. The Image Server is the service handling Smart Client access to the Milestone XProtect Professional system.
  • Under "User Administration" select "Full access for all users" and press the button "User Setup"
  • Press Add Basic User, and enter a Username (say 'Peter') and a Password (say '6789')
  • The server is by default using port 80, this can be changed in the Port field under "Server Configuration"


Smart Client Login

Smart Client login


Start the Smart Client application, and specify your login information in the following fields:

  • Server address: Enter the IP address and port number of the server (for example http//:10.5.101.112:80). The Server and the Smart Client may run on the same PC, which is typical for a single user or when used for demos. If they do run on the same PC, use the IP address 127.0.0.1 (i.e. http//:127.0.0.1:80).
  • Authentication: Select Basic Authentication
  • User name: Enter the username created in the Image Server Administrator, e.g. 'Peter'
  • Password: Enter the password created in the Image Server Administrator, e.g. '6789'


Matrix function

Matrix configuration on server


The Matrix function must be configured, as this function is required in order to have live images automatically presented on the required monitor when defined events occur. The Matrix function allows distributed viewing of live video from any camera on any monitor on a network operating with XProtect Professional. A computer on which Matrix-triggered video can be displayed is known as a Matrix recipient. Being able to view Matrix-triggered video requires that either a Smart Client or the dedicated Matrix Monitor software is installed on the user’s computer. This can be a separate computer, or it can be the same computer as running the server.

Smart Client setup as Matrix recepient


A Matrix recepient (e.g. a Smart Client) must be defined in the XProtect Professional surveillance system server. Start the Administrator application, and select the Matrix button. The Config tab lets you define individual computers on which it should be possible to view Matrix-triggered content. Enable 'Milestone XProtect Matrix', and enter name, IP address of the matrix recepient, the port number (default 12345) and a password.

To make the Smart Client work as a matrix recepient, start the Smart Client application and select the tab Setup. In the Views right click on the Shared view and add New Group. Once the new group is created, right click and add New View and select the dimensions wanted. In the System Overview selection drag and drop the Matrix icon to the main window. While the main window is in focus, click the button Connection Settings in the Properties selection, and enter port number 12345 and the same password as you entered in the Matrix setup in the Administrator program.


Events

Create Generic Events

EDO strings from the AlphaCom is used to control the pictures in the monitor. When a string sent from the AlphaCom is recognized by the Milestone server, the correct camera should show up in the monitor. We need to decide what string to use for each camera. Here is an example, which is used in this article:

The event "EntranceEvent" will be triggered when receiving the string "Cam101" from the AlphaComE


EDO string/Event message Camera Event name Station dir.no
Cam107 Entrance EntranceEvent 107
Cam108 Backdoor BackdoorEvent 108
Cam109 Corridor CorridorEvent 109
CamOff All DisconnectEvent All stations

Note that the EDO string is using the directory number of the station related to the camera, i.e. the camera of station 108 is triggered by the string "Cam108". This is convenient, as it simplifies the event handler programming in AlphaCom.

The "CamOff" event is used to disconnect cameras from the monitor when there is no conversations and the call queue is empty.

Create generic events in Milestone by selecting Administrator -> Generic Events, and 'Add new event'. Enter an 'Event name' and an 'Event message' according to the table above (or your own table). Add a new event for each camera.

Automatic Matrix Display on Events

In the Administrator -> Matrix window, the Event tab is used for configuring the automatic sending of live video based on predefined events; it lets you define exactly which events and cameras to use. You define this on a per-Matrix recipient basis.

  1. In the Matrix window highlight the Matrix recipient, and select Event tab
  2. Right-click the Matrix recipient and select 'Generic', then select one of the predefined Generic events
  3. Now right-click the event to select which action should take place when the event occurs. Here, select 'Connect'.
  4. Right-click the action to select which camera to apply the action on
  5. Repeat 1 to 5 as required
Define events


NOTE: For the changes to take effect, you have to quit the Administrator program by pressing the Exit button.

AlphaCom configuration

Configure the Master station for Call Queueing

A number of different station types can be used for call queuing. The station should use the 763x codes for queue navigation. These directory numbers should be assigned to DAK keys. The station should be prepared for call queue operation, how to do this depends on the station type used:

TCP/IP Communication setup

In AlphaPro, Exchange & System -> Serial Ports, the EDO port must be configured to communiate with the computer running the Milestone XProtect server:

EDO port setup. Server IP address is 10.5.101.151, using port 1234


  • Port type: TCP/IP Client
  • IP address: The IP address of the Milestone XProtect server
  • Port: 1234
  • Enable "Connect at AlphaCom write, disconnect after each write"

The Milestone XProtect Server is by default using TCP port 1234 for generic events. If required this port number can be modified from Milestone XProtect Administrator, I/O Setup -> Advanced -> Alert port.

Note! You might have to open TCP port 1234 in the Windows firewall of the computer running the Milestone server.

(Windows XP: Start > Control Panel > Windows Firewall > Exceptions tab > Add Port: Select port type TCP. Name: Milestone. Port number: 1234)

Event Handler configuration

UDP Groups:

  • Include all substations with cameras in UDP group 2.


Event Handler configuration:
The Event Handler is used to transmit commands through the EDO port to the Milestone IP Video system.

In AlphaPro, go to Exchange and System -> Events, press Insert and create the following events:


Event 1 - An UDD is used to store the busy/free status of the master station. 0 = free, 1 = in conversation. The index of the UDD is equal to the physical number of the master station. The UDD is checked when call requests are received or deleted. If the station is in use, cameras should not be turned on (i.e. no commands should be transmitted).

Event Owner: The Master Station
Event type: 08 - Conversation Outgoing
When change to: ON or OFF
When related to: All
Action: WUDD %1.phy %chg(1,0)

Event 2 - When a conversation is made from the master station to a substation w. camera, transmit command "CamXXX" to the IP Video system, where XXX = the directory number of the substation.

Event Owner: The Master Station
Event type: 08 - Conversation Outgoing
Subevent: 0
When change to: ON
When related to: Stations w. UDP, Id: 2
Action: EDO 1 "Cam%2.dir"

Event 3 - When the conversation between the master and any station cancels, switch off the camera ("CamOff"), and activate the MAILQ_NAVIG command. The MAILQ_NAVIG command will step to the first in the queue, and re-trigger the '23 - New Current Mail' event.

Event Owner: The Master Station
Event type: 08 - Conversation Outgoing
Subevent: 0
When change to: OFF
When related to: All
Action: EDO 1 "CamOff"
  $MAILQ_NAVIG L%1.dir 2

Event 4 - When receiving a Call Request or scrolling the queue, and the master station is not busy, activate the camera assosiated with the selected substation.

Event Owner: The Master Station
Event type: 23 - New Current Mail
Subevent: 0
When change to: ON
When related to: Stations w. UDP, Id: 2
Action: IF %udd(%1.phy)
  STOP
  ENDIF
  EDO 1 "Cam%2.dir"

Event 5 - The Priority Mail Present - OFF event is triggered when the queue of the master station is empty. The queue can become empty because the delete code 7630 has been dialled, in that case the cameras should be turned off. Or the queue can become empty because of call back to the last substation in queue, in that case we want the camera to remain on until the conversation is cancelled. We start a 0.5 second timer, and check if the master station is in conversation when the timer times out:

Event Owner: The Master Station
Event type: 06 - Priority Mail Present
When change to: OFF
Action: $ST L%1.dir w5 L9999

Event 6 - Half a second after the queue was empty, check if the station is in conversation, if not switch off the camera:

Event Owner: The Master Station
Event type: 21 - Event Timeout
Subevent: 0
When change to: ON
When related to: Directory number: 9999
Action: IF %udd(%1.phy)
  STOP
  ENDIF
  EDO 1 "CamOff"

Related links and articles