Actions

Difference between revisions of "Door Opening - Configuration example"

From Zenitel Wiki
 
(140 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{A}}
+
{{AI}}
−
This is an article explaining in detail how to configure Door Opening.
+
<table style="float:right; max-width:80%; border-style: double; border-color: #c7c7c7;">
 +
<tr style="rowspan:2;">
 +
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningExample.png|500px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Operator 120 in conversation with Door 106, pressing digit "6" to open the door</td>
 +
</tr>
 +
</table>
  
−
[[Door opening]] is a standard feature in the AlphaCom. The way it works is that when an operator is in a conversation with a door station, the operator kan dial digit 6 to activate an [[RCO]]. The RCO will in turn activate a relay which again releases the door lock. But, for all this to happen we need to assist the server with some details.
+
This article explains how to configure the Door Opening feature.
  
−
==Event Handler==
+
[[Door opening]] is a standard feature in the ICX-AlphaCom and AlphaCom XE. When an operator is in a conversation with a door station, the operator can press digit 6 to activate a relay. The relay will be pulsed for 3.5 seconds (configurable).
−
We need to define who this event is for, and which output to activate. This is done using the [[Event Handler]]. Go to Exhcange&System from the top menu in [[AlphaPro]]:
 
−
[[File:AlphaPro Exchange and System icon.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
From the Exchange&System window choose the Events button:
+
As an option, it is also possible to play a prerecorded message at the door, saying e.g. "''The door is open, please enter''".
−
[[File:Exchange System Events.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
In the '''Event Actions''' window click the ''Insert'' button and create an event like this:
 
−
[[File:EventHandler Event2.PNG|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
This event is triggered when the operator dials digit 6 while in covnersation with the door. Physical number 6 (the door station) is the owner of the event. This is where it happens. '''When Related To''' can be set to all, meaning whoever in conversation with the door is allowed to dial digit 6 to open the door. In this example we have chosen to limit this acces by selecting a single station; Directory number 120.
 
  
−
At the end of the event RCO 6 is chosen as the triggered action caused by the event.
 
  
−
==RCO==
 
−
The actual physical output that is activated is dependant on the station type.
 
  
−
===Analogue stations===
 
−
If the door station is analogue the RCO comes from the server its self. On an [XE7]] there are two connectors for RCO1-6 and 7-12 located on the back:
 
−
[[File:XE7 RCO Connectors.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
On XE20/XE26 there is an RCO output per ASLT connection. These can be fetched either from
 
−
* [[Subscriber Connection Board]]
 
−
[[File:Subscriber Connection Board RCO.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
* [[Filter and connection card ASLT and ATLB]]
 
−
[[File:RJ45 Connection RCO.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
The RCO, which is a logical signal must be connected to a relay. Use the Multi Relay Board for this. See <u>[[MRBD|MRBD article]]</u> for further details.
+
<div style="float:right;"> <youtube width="300" height="180">omKysK2PTDA=3s</youtube>  </div>
  
−
===IP Stations===
+
==Map the relay to a Logical RCO==
−
All IP Substations have an inbuilt relay which can be controlled by the RCO signal. Tod this the RCO must be remapped to go to the IP station in stead of the analogue output.
+
All Zenitel IP stations have an inbuilt relay. The relay must be mapped to a "Logical RCO" in the ICX-AlphaCom server. The mapping is done from AlphaPro, [[Exchange_%26_System_%28AlphaPro%29#RCO|Exchange & System > RCO]]. Here the logical RCO is assigned to a physical address.  The physical address is given as '''Station ID''' + '''Pin Number'''.
  
−
From Exchange&system choose the RCO button:
+
Open [[Exchange_%26_System_%28AlphaPro%29#RCO|Exchange & System > RCO]], and select a free RCO from the list to the left and click the '''Change''' button.
−
[[File:Exchange System RCO.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
Select the RCO from the list on the left and click the '''Change''' button:
+
Change the following parameters:
−
[[File:RCO Change.png|thumb|left|500px]]
+
* '''Description''': Any text
−
<br style="clear:both;" />
+
*'''RCO Type''' = Station
 +
* '''Station physical number''': The '''''physical''''' number of the door station (Not the directory number)
 +
* '''Pin number''': The output number related to the relay, normally "7" (see below)
  
−
Choose '''RCO Type''' = ''Station'', and enter the physical number of the door station (where the relay is physically located) in the '''Station''' field:
+
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
−
[[File:RCO Change2.PNG|thumb|left|500px]]
+
<tr style="rowspan:2;">
−
<br style="clear:both;" />
+
<td style="display: block; vertical-align: bottom;">[[Image:RCO mapping.PNG|700px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Mapping logical RCO 6 to the relay of station 11 (106 - Entrance)</td>
 +
</tr>
 +
</table>
  
−
The '''Pin Number''' is again dependant on the station type its self.  
+
What '''Pin Number''' to use depends on the station type:
 +
* [[:Category:Stations#Turbine_stations|Zenitel IP Stations (Turbine generation)]]: Pin Number = 7 refers to the relay. Pin 1-6 refers to the six I/Os of the Zenitel Device.
 +
* [[:Category:INCA Stations|INCA Stations (the previous generation Zenitel IP stations)]]: Use Pin Number = 1
  
−
For [[TCIS Connections|Turbine]] stations (all types) pin number 7 is chosen.
+
For an overview of which devices are supporting RCOs and what pin numbers they use, see [[RCO_-_Remote_Control_Output#Devices_supporting_RCOs|Devices_supporting_RCOs]]
 +
{{note|A '''Reset''' of the ICX-AlphaCom server is required for the RCO mapping configuration to take effect}}
  
−
For IP Substations
+
==Creating Event for Door Opening ==
−
* [[Weather and Vandal Resistant IP Substation - 1008041100]]
+
In AlphaPro, open [[Users & Stations (AlphaPro)|Users & Stations]], and select the door station from the list to the left. Then select the button '''Events'''. '''Insert''' a new event with the following properties:
−
* [[Weather and Vandal Resistant IP Substation for 3 gang Back Box - 1008051000]]
+
 
−
* And other stations based on this [[IP Substation Kit - 1008090200|circuit board]]
+
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
−
pin number must be set to '''1'''.
+
<tr style="rowspan:2;">
 +
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningEvent.png|700px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Door Opening event</td>
 +
</tr>
 +
</table>
 +
 
 +
 
 +
The '''When Related To''' field specifies who should be allowed to trigger the Door Opening feature. There are three options:
 +
* Any station: Set "When Related To" = '''All''' (default)
 +
* A specific station: Set "When Related To" = '''Directory Number''', and in the "Id" field enter the directory number of the station that should be allowed to open the door (station 120 in the screenshot above)
 +
* A group of stations: Set "When Related To" = '''Stations w. UDP''', and in the "Id" field enter the ID of the UDP group (1-8). See [[UDP group]] on how to include stations in a UDP group
 +
 
 +
In the example above RCO 6 will be pulsed for 3.5 sec when the Door Opening feature (digit 6) is pressed on station number 120. The '''RCO Pulse Time''' can be change in the [[Exchange_%26_System_(AlphaPro)#Timers|Exchange & System > System > Timers tab]].
 +
 
 +
 
 +
Upload the database using the '''Send All''' button.
 +
{{note|A '''Reset''' of the ICX-AlphaCom server is required for the RCO mapping configuration to take effect}}
 +
 
 +
<br>
 +
 
 +
== Optional configuration ==
 +
=== Automatic termination of the call after activation of door opening ===
 +
 
 +
The system can be configured to terminate the call automatically after the door opening feature has been activated, eliminating the need for the operator to press the C-key to end the call.
 +
Three lines must be added to the Action Command:
 +
 
 +
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
 +
<tr style="rowspan:2;">
 +
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningEvent3.png|700px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Event for auto-termination of call</td>
 +
</tr>
 +
</table>
 +
 
 +
The Action commands are (one can copy/paste from below):
 +
 
 +
{{code2|
 +
RCO 6
 +
IF %chg(0,1)
 +
$C L%1.dir
 +
ENDIF
 +
}}
 +
 
 +
<br>
 +
 
 +
=== Playing a prerecorded message at the door ===
 +
{{note|This feature requires an [[Licenses for ICX-500 and ICX-AlphaCom Core|Audio Messaging license]]}}
 +
<table style="float:right; max-width:80%; border-style: double; border-color: #c7c7c7;">
 +
<tr style="rowspan:2;">
 +
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningMessage.png|500px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Playing an audio message at the door</td>
 +
</tr>
 +
</table>
 +
A prerecorded audio message can be played at the door when the operator activates the door lock, saying e.g. "''The door is open, please enter''".
 +
 
 +
A wav file must be [[Audio_Messaging#Upload_customized_wav-files_from_AlphaWeb|uploaded to the ICX-AlphaCom server]]. Sample wav files can be found in the '''Audio files''' section on [[Downloads#Audio_files|download page]].
 +
 
 +
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
 +
<tr style="rowspan:2;">
 +
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningUploadMessage.png|700px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Uploading the wav file as Announcement Message (Message group 30) number 3 (Group index 3)</td>
 +
</tr>
 +
</table>
 +
 
 +
 
 +
The action commands in the Door Opening event created in the previous section needs to be modified. In the example below station group 890 is used for dispatching the message. If this group is already in use, the below event must be modified to use a different group.
 +
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
 +
<tr style="rowspan:2;">
 +
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningEvent2.png|700px]]</td>
 +
</tr>
 +
<tr>
 +
<td style='background-color:#efefef;'>Door Opening event playing message 3 (8193) to group 890 </td>
 +
</tr>
 +
</table>
 +
 
 +
{{code2|
 +
RCO 6
 +
$GRM L%1.dir L890 %chg(1,0)
 +
IF %chg(1,0)
 +
$GM L890 L8193 U1 U0 U0
 +
ENDIF
 +
}}
 +
 
 +
 
 +
Explanation:
 +
* When the Door Opening event goes ON:
 +
** Turn on RCO 6
 +
** Include ($GRM) the door station in station group 890
 +
** Play message 8193 to group 890
 +
* When the Door Opening event goes OFF 3.5 sec later:
 +
** Turn off RCO 6
 +
** Exclude ($GRM) the door station from station group 890
 +
 
 +
 
 +
If you want to combine Auto-termination of Call, and playback of audio message, insert the following Action Command:
 +
 
 +
{{code2|
 +
RCO 6
 +
$GRM L%1.dir L890 %chg(1,0)
 +
IF %chg(1,0)
 +
$GM L890 L8193 U1 U0 U0
 +
ENDIF
 +
IF %chg(0,1)
 +
$C L%1.dir
 +
ENDIF
 +
}}
  
−
==Finalization==
 
−
Close all windows in AlphaPro and upload the database using the '''Send All''' or '''Send Change''' button. Apply changes by restarting the server.
 
−
[[File:AlphaPro Communication icon.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
 
[[Category: How to]]
 
[[Category: How to]]
 +
[[Category:AlphaCom Applications]]
 +
[[Category:ICX-AlphaCom Applications]]
 +
[[Category:Applications using Event Handler]]

Latest revision as of 11:16, 24 October 2023

AI.png
DoorOpeningExample.png
Operator 120 in conversation with Door 106, pressing digit "6" to open the door

This article explains how to configure the Door Opening feature.

Door opening is a standard feature in the ICX-AlphaCom and AlphaCom XE. When an operator is in a conversation with a door station, the operator can press digit 6 to activate a relay. The relay will be pulsed for 3.5 seconds (configurable).

As an option, it is also possible to play a prerecorded message at the door, saying e.g. "The door is open, please enter".





Map the relay to a Logical RCO

All Zenitel IP stations have an inbuilt relay. The relay must be mapped to a "Logical RCO" in the ICX-AlphaCom server. The mapping is done from AlphaPro, Exchange & System > RCO. Here the logical RCO is assigned to a physical address. The physical address is given as Station ID + Pin Number.

Open Exchange & System > RCO, and select a free RCO from the list to the left and click the Change button.

Change the following parameters:

  • Description: Any text
  • RCO Type = Station
  • Station physical number: The physical number of the door station (Not the directory number)
  • Pin number: The output number related to the relay, normally "7" (see below)
RCO mapping.PNG
Mapping logical RCO 6 to the relay of station 11 (106 - Entrance)

What Pin Number to use depends on the station type:

For an overview of which devices are supporting RCOs and what pin numbers they use, see Devices_supporting_RCOs

Note icon A Reset of the ICX-AlphaCom server is required for the RCO mapping configuration to take effect


Creating Event for Door Opening

In AlphaPro, open Users & Stations, and select the door station from the list to the left. Then select the button Events. Insert a new event with the following properties:

DoorOpeningEvent.png
Door Opening event


The When Related To field specifies who should be allowed to trigger the Door Opening feature. There are three options:

  • Any station: Set "When Related To" = All (default)
  • A specific station: Set "When Related To" = Directory Number, and in the "Id" field enter the directory number of the station that should be allowed to open the door (station 120 in the screenshot above)
  • A group of stations: Set "When Related To" = Stations w. UDP, and in the "Id" field enter the ID of the UDP group (1-8). See UDP group on how to include stations in a UDP group

In the example above RCO 6 will be pulsed for 3.5 sec when the Door Opening feature (digit 6) is pressed on station number 120. The RCO Pulse Time can be change in the Exchange & System > System > Timers tab.


Upload the database using the Send All button.

Note icon A Reset of the ICX-AlphaCom server is required for the RCO mapping configuration to take effect



Optional configuration

Automatic termination of the call after activation of door opening

The system can be configured to terminate the call automatically after the door opening feature has been activated, eliminating the need for the operator to press the C-key to end the call. Three lines must be added to the Action Command:

DoorOpeningEvent3.png
Event for auto-termination of call

The Action commands are (one can copy/paste from below):

Action commands: 

RCO 6
IF %chg(0,1)
$C L%1.dir
ENDIF



Playing a prerecorded message at the door

Note icon This feature requires an Audio Messaging license


DoorOpeningMessage.png
Playing an audio message at the door

A prerecorded audio message can be played at the door when the operator activates the door lock, saying e.g. "The door is open, please enter".

A wav file must be uploaded to the ICX-AlphaCom server. Sample wav files can be found in the Audio files section on download page.

DoorOpeningUploadMessage.png
Uploading the wav file as Announcement Message (Message group 30) number 3 (Group index 3)


The action commands in the Door Opening event created in the previous section needs to be modified. In the example below station group 890 is used for dispatching the message. If this group is already in use, the below event must be modified to use a different group.

DoorOpeningEvent2.png
Door Opening event playing message 3 (8193) to group 890

Action commands: 

RCO 6
$GRM L%1.dir L890 %chg(1,0)
IF %chg(1,0)
$GM L890 L8193 U1 U0 U0
ENDIF



Explanation:

  • When the Door Opening event goes ON:
    • Turn on RCO 6
    • Include ($GRM) the door station in station group 890
    • Play message 8193 to group 890
  • When the Door Opening event goes OFF 3.5 sec later:
    • Turn off RCO 6
    • Exclude ($GRM) the door station from station group 890


If you want to combine Auto-termination of Call, and playback of audio message, insert the following Action Command:

Action commands: 

RCO 6
$GRM L%1.dir L890 %chg(1,0)
IF %chg(1,0)
$GM L890 L8193 U1 U0 U0
ENDIF
IF %chg(0,1)
$C L%1.dir
ENDIF


Retrieved from "https://wiki.zenitel.com/w/index.php?title=Door_Opening_-_Configuration_example&oldid=234467"