View source for Milestone External Generic Event

{{AI}}
==Introduction==
This document shortly describes how to use the External Generic Event in Milestone for starting the video recording on call button activation on a turbine station.<br>
To keep the description short the recording is set to stop after 3 seconds, but of course a new event can also be used.<br>
The usage of the External Generic Event can only be implemented in an ICX-AlphaCom Intercom system as it requires that the controller can send text strings via a TCP/IP connection to the Milestone XProtect Management System.<br>
The document contains the following sections:<br>

*Milestone Setup
*ICX-AlphaCom Setup
*Firewall Setup
*Test

==Milestone Setup==

Start the XProtect Management Client. Select Tools and Options.

[[File:MilestoneExternalGenericEvent_1.jpg|thumb|left|700px|Select the Generic Event Tab]]
<br style="clear:both;" />

<br>
Select the ”Generic Event” tab. Select “New” and define a new “ICX-AlphaCom” connection:
<br>
[[File:MilestoneExternalGenericEvent_2.jpg|thumb|left|700px|Define Event Source Port]]
<br style="clear:both;" />
Complete the setup by pressing “OK”.<br><br>

===Definition of the Event===
Select “Rules and Event”. Right-click “Generic Event” and select “New”.<br>
Enter the event name and the text string to search for in the data telegram from the Data Source “ICX-AlphaCom”.
<br>
[[File:MilestoneExternalGenericEvent_3.jpg|thumb|left|700px|Define the Event]]
<br style="clear:both;" />
<br>

===Definition of the Rule===
<br>
[[File:MilestoneExternalGenericEvent_4.jpg|thumb|left|700px|Add new Rule]]
<br style="clear:both;" />

<br>
[[File:MilestoneExternalGenericEvent_5.jpg|thumb|left|700px|Define Rule Type]]
<br style="clear:both;" />
Push '''event'''
<br>
[[File:MilestoneExternalGenericEvent_6.jpg|thumb|left|700px|Select Event]]
<br style="clear:both;" />
Push “OK” and “Next” on the shown window.

<br>
[[File:MilestoneExternalGenericEvent_7.jpg|thumb|left|700px|Selected Event]]
<br style="clear:both;" />
Select “Day of week is <day>” and push '''days'''
<br>

<br>
[[File:MilestoneExternalGenericEvent_8.jpg|thumb|left|700px|Select active time]]
<br style="clear:both;" />
Select all and press “OK” and “Next” on the next window.
<br>

<br>
[[File:MilestoneExternalGenericEvent_9.jpg|thumb|left|700px|Select Action to perform]]
<br style="clear:both;" />
Select “Start recording on <device>” and '''recording device'''
<br>
[[File:MilestoneExternalGenericEvent_10.jpg|thumb|left|700px|Select Device]]
<br style="clear:both;" />
Select “Select devices” and press “OK”.

<br>
[[File:MilestoneExternalGenericEvent_11.jpg|thumb|left|700px|Select Device from List]]
<br style="clear:both;" />
Select the devices and press “Add” for add to selected devices and press “OK”.

<br>
[[File:MilestoneExternalGenericEvent_12.jpg|thumb|left|700px|Defined Start Action]]
<br style="clear:both;" />
Press “Next”.

<br>
[[File:MilestoneExternalGenericEvent_13.jpg|thumb|left|700px|Define Stop Action]]
<br style="clear:both;" />
Select “Perform stop action after <time> and press '''time'''

<br>
[[File:MilestoneExternalGenericEvent_14.jpg|thumb|left|700px|Stop Action Criteria]]
<br style="clear:both;" />
Select 3 seconds (for test). Press Ok and Press “Next”.

<br>
[[File:MilestoneExternalGenericEvent_15.jpg|thumb|left|700px|Defined Rule]]
<br style="clear:both;" />
Press “Finish”.

<br>
[[File:MilestoneExternalGenericEvent_16.jpg|thumb|left|700px|Rule added to List]]
<br style="clear:both;" />

==ICX-AlphaCom Setup==

===Setup Client Connection===
<br>
Define a TCP/IP client connection, which can connect to the Milestone VMS.
[[File:MilestoneExternalGenericEvent_17.jpg|thumb|left|700px|Select Serial Ports]]
<br style="clear:both;" />

<br>
Assign an EDIO port (here EDIO 1) for the IP-Connection and press “Change”. 
[[File:MilestoneExternalGenericEvent_18.jpg|thumb|left|700px|Define Protocol Type]]
<br style="clear:both;" />

<br>
Insert IP-address of the Milestone VMS and the port number to be used.
[[File:MilestoneExternalGenericEvent_19.jpg|thumb|left|700px|Define Port Protocol Parameters]]
<br style="clear:both;" />
<br>
Press ”OK”.<br>
Press ”Send All” and afterwards “Reset” to activate the changes.
<br>

===Usage of the Client Connection ===
<br>
In the “Users” menu – select a station and press the “Event”-button.<br>
In this example the string “CallFromTurbine109” is send on activation of the call button (DAK 1). The parameters \r and \n is added after the string to match the separator bytes used by Milestone server.<br>
For debug reasons the LOG event is added to the system log in ICX-AlphaCom.<br>

[[File:MilestoneExternalGenericEvent20.jpg|thumb|left|700px|Define Station Event]]
<br style="clear:both;" />

==Firewall Setup==
The port number (1238) must be added to the firewall. It is assumed that the ICX-AlphaCom is able to access Milestone as this is required for the plugin to work.<br>
Start the Control Panel and select “Windows Defender Firewall”.
<br>

[[File:MilestoneExternalGenericEvent_21.jpg|thumb|left|700px|Select Firewall Setup]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_22.jpg|thumb|left|700px|Add new Rule]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_23.jpg|thumb|left|700px|Add new Inbound Rule]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_24.jpg|thumb|left|700px|Select Type of Rule]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_25.jpg|thumb|left|700px|Select Protocol and Port Number]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_26.jpg|thumb|left|700px|Select Connection Allowed]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_27.jpg|thumb|left|700px|Select Connection Type]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_28.jpg|thumb|left|700px|Name the Rule]]
<br style="clear:both;" />

[[File:MilestoneExternalGenericEvent_29.jpg|thumb|left|700px|New Rule added]]
<br style="clear:both;" />

==Testing==
<br>
Restart the XProtect Event Server.<br>
When pushing the call button on the Turbine the TCP telegram can be logged using WireShark: 

[[File:MilestoneExternalGenericEvent_30.jpg|thumb|left|700px|WireShark Logging]]
<br style="clear:both;" />
<br>

Also, viewing the MIP logs the event should be listen in the log. Right-click on the Event Server in the Task Bar.

[[File:MilestoneExternalGenericEvent_31.jpg|thumb|left|700px|MIP Logging]]
<br style="clear:both;" />



[[Category: Video]]