Actions

Difference between revisions of "Door Opening - Configuration example"

From Zenitel Wiki

(→‎Playing a prerecorded message at the door)
 
(43 intermediate revisions by one other user not shown)
Line 14: Line 14:
  
 
As an option, it is also possible to play a prerecorded message at the door, saying e.g. "''The door is open, please enter''".
 
As an option, it is also possible to play a prerecorded message at the door, saying e.g. "''The door is open, please enter''".
 +
 +
 +
 +
 +
 +
 +
 +
 +
<div style="float:right;"> <youtube width="300" height="180">omKysK2PTDA=3s</youtube>  </div>
  
 
==Map the relay to a Logical RCO==
 
==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_%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'''.
 
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'''.
  
−
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:
+
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.
−
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
 
−
<tr style="rowspan:2;">
 
−
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningRCO.png|700px]]</td>
 
−
</tr>
 
−
<tr>
 
−
<td style='background-color:#efefef;'>Default RCO configuration</td>
 
−
</tr>
 
−
</table>
 
−
 
 
  
 
Change the following parameters:
 
Change the following parameters:
Line 37: Line 37:
 
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
 
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
 
<tr style="rowspan:2;">
 
<tr style="rowspan:2;">
−
<td style="display: block; vertical-align: bottom;">[[Image:DoorOpeningRCO2.png|400px]]</td>
+
<td style="display: block; vertical-align: bottom;">[[Image:RCO mapping.PNG|700px]]</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td style='background-color:#efefef;'>Mapping logical RCO 6 to the relay of station 6 (106 - Entrance)</td>
+
<td style='background-color:#efefef;'>Mapping logical RCO 6 to the relay of station 11 (106 - Entrance)</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
 
What '''Pin Number''' to use depends on the station type:
 
What '''Pin Number''' to use depends on the station type:
−
* [[:Category:Stations#Turbine_stations|Zenitel IP Stations (Turbine generation)]]: Use Pin Number = 7
+
* [[: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:Stations#INCA_stations|INCA Stations (the old generation Zenitel IP stations)]]: Use Pin Number = 1
+
* [[:Category:INCA Stations|INCA Stations (the previous generation Zenitel IP stations)]]: Use Pin Number = 1
  
 
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]]
 
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]]
Line 63: Line 63:
 
</table>
 
</table>
  
−
This event is triggered when the operator dials digit 6 while in conversation with the door. Note that the Door Station is the owner of the event (here physical number 6). '''When Related To''' can be set to "All", meaning whoever in conversation with the door is allowed to dial digit 6 to trigger the door opening. In this example we have chosen to limit this access by selecting a single station; Operator with Directory number 120.
 
  
−
In the example above RCO 6 will be pulsed for 3.5 sec when the Door Opening feature (digit 6) is pressed. The '''RCO Pulse Time''' can be change in the [[Exchange_%26_System_(AlphaPro)#Timers|Exchange & System > System > Timers tab]].
+
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.
 
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}}  
 
{{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 ===
 
=== 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;">
 
<table style="float:right; max-width:80%; border-style: double; border-color: #c7c7c7;">
 
<tr style="rowspan:2;">
 
<tr style="rowspan:2;">
Line 81: Line 114:
 
</table>
 
</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 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''".
−
{{note|This feature requires an [[Licenses for ICX-500 and ICX-AlphaCom Core|Audio Messaging license]]}}
 
  
−
A wav file must be [[Audio_Messaging#Upload_customized_wav-files_from_AlphaWeb|uploaded to the ICX-AlphaCom server]].
+
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;">
 
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
Line 90: Line 122:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td style='background-color:#efefef;'>Uploading the wav file as Announcement Message (Message group 30) number 3 (Group index)</td>
+
<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>
 
</tr>
 
</table>
 
</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
 +
}}
  
  
 
[[Category: How to]]
 
[[Category: How to]]
 +
[[Category:AlphaCom Applications]]
 +
[[Category:ICX-AlphaCom Applications]]
 +
[[Category:Applications using Event Handler]]

Latest revision as of 10: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"