Actions

Difference between revisions of "PrisCom station - Configuration"

From Zenitel Wiki

(Starting point)
(Adding Guard Station in different node)
 
(429 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{stub}}
+
This article describes how to configure the Prison Stations model [[1007061000]] and [[1007063000]].
[[image:Tamper and Vandal Proof Station 100 7061 000.jpg|thumb|150px|Tamper and Vandal Proof Station - 1007061000]]
+
{| border="1" align="right"
[[Image:Tamper and Vandal Proof Station 100 7063 000.jpg|thumb|150px|100 7063 000 station]]
+
|+'''PrisCom Stations'''
This article describes the configuration of the PrisCom stations [[1007061000]] and [[1007063000]].
+
|-
 +
| valign="top"|
 +
[[File:1007061000.PNG|thumb|center|155px|Model 1007061000]]
 +
| valign="bottom"|
 +
[[File:1007063000.PNG|thumb|center|150px|Model 1007063000]]
 +
|-
 +
|}
 +
 
 +
 
 +
[[File:Prison Station.png|thumb|right|600px|The PrisCom station]]
 +
 
 +
 
  
 
==Software requirements==
 
==Software requirements==
Line 9: Line 20:
  
  
==Starting point==
+
"Scream alarm from idle" is available from station software 01.02.
The station properties are programmed from AlphaPro.
+
 
#'''Basic features''': Start with a new AlphaPro database and fill in all parameters from scratch.
+
==Decide the configuration starting point==
"Basic features" are:  
+
 
 +
When configuring a system with the 1007061000/1007063000 stations there are two options:
 +
 
 +
#Start with a new AlphaPro database and fill in the parameters from scratch ('''Basic features''')
 +
#Use a preprogrammed [[Downloads#AlphaPro|PrisCom database]]  from Zenitel ('''Advanced features''')
 +
 
 +
"'''Basic features'''" are:  
 
* Call Button
 
* Call Button
 
* Program Step button (without displaying selected channel)
 
* Program Step button (without displaying selected channel)
  
 
+
"'''Advanced features'''" means support for:  
#'''Advanced features''': When using the advanced features of the station, a preprogrammed AlphaPro database should be used as a starting point. The advanced features is depending on Event Handler programming.
 
 
 
"Advanced features" are:  
 
 
* Light button
 
* Light button
 
* External key switch
 
* External key switch
 
* Corridor lamp and/or group lamp
 
* Corridor lamp and/or group lamp
 
* Display for selected program channel
 
* Display for selected program channel
* Tamper alarm and Power failure
+
* Tamper alarm and Power failure alarm
 
* Scream alarm
 
* Scream alarm
* AlphaVision support
+
* AlphaVision
 +
 
 +
When using the advanced features of the station, it is highly recommended to use the preconfigured AlphaPro database as a starting point. The advanced features is depending a lot on Event Handler programming, and much work is saved by using an already preconfigured database.
  
 
==Basic feature programming==
 
==Basic feature programming==
Line 32: Line 48:
 
*In '''Users & Stations''' -> '''User Preferences''' set DAK signaling to "(3) Two tone signaling w/ack“
 
*In '''Users & Stations''' -> '''User Preferences''' set DAK signaling to "(3) Two tone signaling w/ack“
 
* In '''Users & Stations''' -> '''DAK''' assign numbers to the panel buttons: 
 
* In '''Users & Stations''' -> '''DAK''' assign numbers to the panel buttons: 
**DAK 2 = Call button
+
**DAK 2 = Call button, normally configured to "I 623 I xxx", where xxx is the number of the Guard Station
**DAK 3 = Program button (not available on the 100 7061 000)
+
**DAK 3 = Program Step button, normally configured to "I 790" (button not available on the 100 7061 000)
  
 
==Advanced feature programming==
 
==Advanced feature programming==
Copy the PrisCom database to the AlphaPro Database folder. Start AlphaPro and select the PrisCom database.
+
Download the [[Downloads#AlphaPro|PrisCom database]] from the download site. Copy the PrisCom database to the AlphaPro Database folder (E.g. C:\Program files\AlphaPro\Database).  
 +
 
 +
Start AlphaPro and select the PrisCom database. Verify that the PrisCom database is visible.
  
 
===Guard station configuration===
 
===Guard station configuration===
*In '''Users & Stations''' -> '''UDP''', include the station in UDP 1
+
 
*In '''Users & Stations''' -> '''Group''', include the station in a “Guard group”. This is required even with a single guard station
+
#In '''Users & Stations''' window, highlight the guard station in the list box, select the tab '''UDP''', and include the guard station in UDP 1
 +
[[File:GuardStationUDP.PNG|thumb|left|500px|Include Guard Station in UDP 1]]
 +
<br style="clear:both;" />
 +
#In '''Groups''' -> '''Local Groups''', select group 10 (or another free group) and include the guard station in this “Guard group”. This is required even with a single guard station.
 +
# Continue with step 1 and 2 for all guard stations.
 +
[[File:GuardStationGroup.PNG|thumb|left|500px|Include Guard Station in a "Guard group", here group 10]]
 +
<br style="clear:both;" />
  
 
===Prison station configuration===
 
===Prison station configuration===
* In '''Users & Stations''' -> '''UDP''', include the station in UDP 2
+
#In '''Users & Stations''' window, highlight the prison station in the list box, select the tab '''UDP''', and include the prison station in UDP 2
* In '''Users & Stations''' -> '''UDP''', enter the “Guard group” index number in the '''Used Defined Parameter''' field. This is the target for calls from this station.
+
#In '''Users & Stations''' window, highlight the prison station in the list box, select the tab '''UDP''', and enter the “Guard group” index number (e.g. 10) in the '''Used Defined Parameter''' field. This is the target for calls from this station. When the call button is presses on the prison station, a call request is sent to all stations in this group.
 +
# Continue with step 1 and 2 for all prison stations.
 +
[[File:PriscomStationUDP.PNG|thumb|left|500px|Prison station: Enable UDP 2, and enter the "Guard group" (here: 10) to receive the Call Request]]
 +
<br style="clear:both;" />
  
 
Notes on DAK programming:  
 
Notes on DAK programming:  
 
*No DAK programming is required
 
*No DAK programming is required
*The event handler programming in the PrisCom database will automatically set “Two tone DAK signaling”, and program the DAK’s to point to physical station 500 and 501
+
*The event handler programming in the PrisCom database will automatically set “Two tone DAK signaling”, and redirect the DAK keys to point to physical station 500 and 501
*Physical station 500 and 501 are preconfigured with PrisCom Station DAK keys
+
*Physical station 500 and 501 have preconfigured DAK keys according to the PrisCom Station features.
 +
 
 +
Note that only Prison Stations model 1007061000 or 1007063000 should be in UDP 2. If there are other types of prison stations in the system, they should not be in UDP 2.
 +
 
 +
=== Upload configuration to the AlphaCom ===
 +
* After the PrisCom stations are connected to the AlphaCom, upload the configuration to the AlphaCom by selecting “SendAll” from AlphaPro
 +
* When the upload is finished, reset the AlphaCom. When the exchange is up and running, reset once more
 +
* Now do a “GetAll” to update AlphaPro with the correct settings
 +
 
 +
Note that every time a new Prison Station is added to the system, the above procedure should be used (SendAll, 2 x reset, GetAll).
 +
 
 +
The dual reset procedure is only required after adding new PrisCom stations to the system. The first reset will trigger the "Faulty Line OFF" event. This event will automatically program the DAK keys and enable the "Two Tone DAK signalling", and it will send configuration data to the Prison Stations. The second reset is to make the changes take effect. At this stage the AlphaCom configuration is different from the AlphaPro. The GetAll is required for AlphaPro to reflect the actual configuration in the exchange.
 +
 
 +
== Description of the PrisCom database ==
 +
The Prison Stations 7061 and 7063 are mainly operating by sending a "Two tone" DAK digits to the exchange for input events, and receiving display data messages in response. The Prison Stations are the only station types which are using the "double-tone" DAK signalling. The event handler programming in the PrisCom database will automatically set the Prison stations to use “Two tone DAK signaling”.
 +
 
 +
Display messages are used to e.g. turn lamps on, set alarm preparation mode during guard presence, or control other features. These messages are mostly defined as commands in the AlphaCom event handler. To change functionality one will have to change these commands or add/remove/change events.
 +
 
 +
=== DAK Keys on physical numbers 500 and 501 ===
 +
The Priscom stations have common DAK key programming. The DAK configuration is programmed on physical number 500 and 501, and the event handler programming in the PrisCom database will upon reset cause the AlphaCom to automatically program the DAK’s of the Prison Stations to point to these physical numbers 500 and 501. The DAK table of the physical numbers 500 and 501 are preconfigured according to the table below. Most of the numbers are Event Triggers, starting from 9550 and upwards. Actions for these custom event triggers are defined in the event handler, using the event “15 Event Trigger Feature”.
 +
 
 +
DAK keys 1-10 is from physical number 500, and DAK key 11-20 is from physical number 501.
 +
[[File:Priscom connections.PNG|thumb|right|450px|PrisCom station connectors]]
 +
 
 +
{| border="1"
 +
| align="center" style="background:#ffdead;" width="60pt" |'''DAK key'''
 +
| align="center" style="background:#ffdead;" width="80pt" |'''DAK string'''
 +
| align="left" style="background:#ffdead;" width="450pt" |'''Description'''
 +
|-
 +
| 1||E 9558||Panelkey 1: Light button
 +
|-
 +
| 2||M I 9550||Panelkey 2: Call Request / "Answer" on incoming calls
 +
|-
 +
| 3||I 790||Panelkey 3: Program button
 +
|-
 +
| 4||E 9551||Panelkeys in alarm mode: Alarm call
 +
|-
 +
| 5||E 9552||Tamper switch
 +
|-
 +
| 6||E 9553||IN KEY1 (Guard Keyswitch 1)
 +
|-
 +
| 7||E 9554||IN KEY2 (Guard Keyswitch 2)
 +
|-
 +
| 8||E 9555||Guard Keyswitch Reset
 +
|-
 +
| 9||E 9556||Power fail (Voltage must be down in 7-8Vdc for 100ms before hardware notice to low voltage)
 +
|-
 +
| 10||E 9557||Power OK
 +
|-
 +
| 11||||IN1 ON (Input 1): (Set as default alarm input during guard presence by display command 0x63. See below)
 +
|-
 +
| 12||M I 9550||IN1 OFF (Input 1): External Call Request / "Answer" on incoming calls
 +
|-
 +
| 13||||IN2 ON (Input 2)
 +
|-
 +
| 14||||IN2 OFF (Input 2)
 +
|-
 +
| 15||||IN3 ON (Input 3)
 +
|-
 +
| 16||||IN3 OFF (Input 3)
 +
|-
 +
| 17||||IN4 ON (Input 4)
 +
|-
 +
| 18||||IN4 OFF (Input 4)
 +
|-
 +
| 19||E 9561||Scream detector
 +
|-
 +
| 20||||
 +
|}
 +
<br><br>
 +
 
 +
=== IND Commands used by Prison Stations ===
 +
 
 +
The outputs on the Prison Stations are controlled by [[IND - Indicator control for CRMIV LEDs, buzzer etc.|IND commands]] executed in the event handler. There are eight outputs:
 +
{| border="1"
 +
| align="center" style="background:#ffdead;" width="100pt" |'''IND output'''
 +
| align="center" style="background:#ffdead;" width="150pt" |'''Description'''
 +
| align="center" style="background:#ffdead;" width="600pt" |'''Comment'''
 +
|-
 +
| 1||L1 - Output 1 || Red lamp (Call)
 +
|-
 +
| 2||L2 - Output 2 || Green lamp (Present)
 +
|-
 +
| 3||L3 - Output 3 || Blue lamp (Tamper alarm)
 +
|-
 +
| 4||L4 - Output 4 || Group lamp
 +
|-
 +
| 5||L5 - Output 5 || Spare
 +
|-
 +
| 6||L6 - Output 6 || Spare
 +
|-
 +
| 7||Relay || Cell light
 +
|-
 +
| 8||Call LED, External LED||Also controlled by microphone active (polarity reversal of C/D-wire during conversation)
 +
|}
 +
 
 +
'''Syntax''':
 +
*IND <station phys.no> <output> <1> <Indtype> [state]
 +
'''Example''':
 +
*IND %1.phy 1 1 3 ON: Turn the red lamp ON, flashing
 +
<br><br>
 +
 
 +
=== Display data commands ===
 +
Some properties of the Prison Station are configured in the station it self. The configuration data is sent to the Prison Station as display data, using the Event Handler and the [[DISPLAY TEXT|$DSPL command]].
 +
 
 +
The format is as follows:
 +
$DSPL <station> <length> <data>
 +
*Station: The prison station
 +
*Length: The length of the data string.
 +
*Data: Display data command and parameters. For the Prison Station programming, sequential hex values are used to make the string.
 +
 
 +
 
 +
{| border="1"
 +
| align="center" style="background:#ffdead;" width="50pt" |'''Cmd'''
 +
| align="center" style="background:#ffdead;" width="250pt" |'''Parameters'''
 +
| align="center" style="background:#ffdead;" width="100pt" |'''Default'''
 +
| align="center" style="background:#ffdead;" width="900pt" |'''Description'''
 +
|-
 +
| 0x23||None||||Volume override ON.
 +
|-
 +
| 0x24||None||||Volume override OFF.
 +
|-
 +
| 0x45||None||||Disable call LED. ("Silent monitoring" mode).
 +
|-
 +
| 0x46||None||||Enable call LED. (End "Silent monitoring" mode).
 +
|-
 +
| 0x47||None||||Set flag for preventing call-request button from generating a callrequest in station's offline mode
 +
|-
 +
| 0x48||None||||Clear flag for preventing call-request button from generating a callrequest in station's offline mode
 +
|-
 +
| 0x60||00 = off, 01 = on||60 00||Set "alarm preparation mode" on/off. When ON, all panel buttons trigger DAK 4.
 +
|-
 +
| 0x61||00 = static relay, >00 = pulse length||61 00||Select light relay type: Static or pulserelay.
 +
|-
 +
| 0x62||00 = none, 01 = type1||62 01||Select offline mode operation type. Required for offline mode operation.
 +
|-
 +
| 0x63||  ||63 02 00 00 00||Configure general inputs. One byte for each input. Select inverted input (bit0) and alarm-trigger input (bit1)
 +
|-
 +
| 0x64||  ||64 A0 08 00 23||Configure Scream alarm detector. Volume level (00=set default), min scream-time (00=set default), max scream-time, min pause before re-enabling alarm. Times in 100ms resolution. (Note: Parameters are not saved to EEPROM, and lost when the station is moved).
 +
|-
 +
| 0x65||||65 0960||Set guard alarm timeout. Value is 16-bit, 100ms resolution. Max value = 0x199A (11 minutes).
 +
|-
 +
| 0x66||||66 00||Select front-panel key types: Capacitive sensor-key (0) or switch input (1). Each bit represents one key (bit0 = light-button, bit1 = callrequest, bit2 = program, bit3 = vol up, bit4 = vol dn).
 +
|-
 +
| 0x67|| ||67 00 0A||Configure keyswitch inputs: Static switches (00) or toggle-switches (01). Delay after activation in 100ms resolution.
 +
|-
 +
| 0x68||||68 06||Set default volume override level (selected by messages 0x23/0x24). Min=00 Max=06.
 +
|-
 +
| 0x70||None||70||Restore EEPROM defaults.
 +
|}
 +
 
 +
 +
 
 +
'''Examples:''' <br>
 +
''<nowiki>$DSPL L%1.dir U2 6100 ''</nowiki>''  : Set light relay to static mode  <br>
 +
''<nowiki>$DSPL L%1.dir U1 23 ''</nowiki>''    : Volume override ON
 +
 
 +
'''Note:'''<br>
 +
The parameters are followed by two single apostrophes '''(')'''. Closing single quotation marks '''(‘…’)''' are not valid. A text editor like Word (and others) tends to convert apostrophes to single quotation marks, which will not work.
 +
 
 +
=== Volume Override ===
 +
When using the PrisCom database and a conversation is established, the volume set by the user is overridden, and a preset volume is used. The preset volume is defined by the display data command 0x68. By default set to maximum ''($DSPL L%1.dir U2 6806<nowiki>''</nowiki>).''
 +
 
 +
The volume override ON is set by the display data command 0x23 when the conversation starts ''($DSPL L%1.dir U1 23<nowiki>''</nowiki>),'' and the volume override OFF is set by the command 0x24 when the conversation ends (''$DSPL L%1.dir U1 24<nowiki>''</nowiki> '').
 +
 
 +
If the preset override volume is too loud, the following event can be modified:
 +
 
 +
Owner:    Event:                  Change to:
 +
UDP 2    13-Faulty station line  OFF
 +
 
 +
In the "Action field" find the line:
 +
* ''$DSPL L%1.dir U2 6806<nowiki>''</nowiki>,'' and change 06 to a value 00-05. The value 00-06 sets what volume level to use when volume override is activated.
 +
 
 +
 
 +
If volume override is not wanted at all, one can delete the line $DSPL L%1.dir U1 23<nowiki>''</nowiki> from the "Conversation Incoming ON" event.
 +
 
 +
===Changing the privacy setting===
 +
By default the Prison Stations are set in privacy mode. This means that a guard can’t call directly into the cell, but the prisoner has to accept the call by pressing the call button.
 +
 
 +
To change the station to operate in Open mode, the following event must be modified:
 +
 
 +
Owner:    Event:                  Change to:
 +
UDP 2    13-Faulty station line  OFF
 +
 
 +
In the "Action field" find the line:
 +
* $SNV Q55 W5 W8 W%1.phy W17 (Prison stations in Private mode)
 +
Change into:
 +
* $SNV <u>Q39</u> W5 W8 W%1.phy W17 (Prison stations not in Private mode)
 +
 
 +
 
 +
===Changing Offline mode operation===
 +
The cell station operates in both "online" mode when connected to AlphaCom and [[PrisCom_station_-_Configuration#Offline_mode|"offline" mode]] when connection is lost and only 24V power is used. In this mode the external lamps are used for status signalling. This operation is mostly hardcoded in the station. In case the station is used in an installation where offline mode operation should be turned off or changed, the following event can be modified:
 +
 
 +
Owner:    Event:                    Change to:         
 +
UDP 2    13 Faulty station line    OFF
 +
 
 +
In the "Action field" find the line:
 +
* <nowiki>$DSPL L%1.dir U2 6201 ''</nowiki> ([[PrisCom_station_-_Configuration#Offline_mode|Offline operation mode type 01]])
 +
Change into:
 +
* <nowiki>$DSPL L%1.dir U2 6200 ''</nowiki> (Offline operation turned off)
 +
 
 +
Note: In current station software v1.02 there is only one available offline operation mode: 01. Other modes may be added in the future.
 +
 
 +
===Changing Guard Presence timeout-alarm===
 +
When a guard marks his presence in a cell by turning the keyswitch to position 2, an alarm timeout is activated (no timeout for keyswitch position 1). The value of this timeout can be adjusted in the event handler.
 +
 
 +
The following event must be modified:
 +
 
 +
Owner:    Event:                  Change to:  Related to:   
 +
UDP 2    15-Event trigger        ON          9554
 +
 
 +
Modify this action command:
 +
* $ST L%1.dir W2400 L9554
 +
The value “W2400” is in 100ms resolution, which gives a 240 seconds (4 minutes) timeout. Change to desired value. Value is in decimal format.
 +
 
 +
 
 +
===Changing Sensor Key sensitivity ===
 +
By default the sensor buttons are set for high sensitivity, making it possible to operate the station with sanitary or latex gloves.
 +
 
 +
If the station is located in an area with high humidity, for instance just outside a shower area, there is a risk that the station could generate ghost calls. It is possible to change the sensor buttons to a lower sensitivity. The side effect is that gloves cannot be used to trigger calls.
 +
 
 +
The following event must be modified:
 +
 
 +
Owner:    Event:                  Change to:     
 +
UDP 2    13-Faulty station line  OFF
 +
 
 +
Modify this action command:
 +
* $DSPL L%1.dir U2 6600 <nowiki>''</nowiki> (High key sensitivity)
 +
into:
 +
* $DSPL L%1.dir U2 661f <nowiki>''</nowiki> (Low key sensitivity)
 +
 
 +
=== Pulse relay instead of static relay for Relay Control output===
 +
By default the Relay Control output (connector P1/5 and P1/6) is configured as a static relay changing on/off each time the “light” button on the prison station is pressed. This can be changed to a pulse relay operation if such a relay is used.
 +
 
 +
The following event must be modified:
 +
 
 +
Owner:    Event:                  Change to:     
 +
UDP 2    13-Faulty station line  OFF
 +
 
 +
Modify this action command:
 +
* $DSPL L%1.dir U3 6100 <nowiki>''</nowiki> (Static relay)
 +
into:
 +
* $DSPL L%1.dir U3 610A <nowiki>''</nowiki> (Pulserelay, 10*10ms pulsetime)
 +
 
 +
The parameter "0A" to the display data command 0x61 in the string above defines the pulsetime in 10ms resolution. Value is in hex format.
 +
 
 +
 
 +
If pulse relay is used, the state of the light (on or off) is unknown and some events should be modified accordingly. Some action lines should be deleted. They are highlighted by <span style="color: green">green color</span> in the following event handler description.
 +
 
 +
=== Scream Alarm ===
 +
 
 +
The display data command 0x64 is used to set the level and duration necessary to trigger the scream alarm.
 +
0x64 <volume level> <min-time> <max-time> <pause> [mode]
 +
 
 +
Default command is 64 A0 08 00 23, the values are in hexadecimal.
 +
* '''Volume level''' is the trigger level 00-FF, A0 is default. See table below.
 +
* '''Minimum scream time''' = 08 Default (800ms). Noise must be present this long to trigger an alarm
 +
* '''Maximum time''' = 00 default (optional). Noise longer than this do not trigger an alarm. Can be used to surpress alarms caused by sudden background noise which is present for a long time (longer than specified in this parameter).
 +
* '''Pause''' is minimum time for re-enabling alarm is default 23 (= 3500ms)
 +
* '''Mode''' is an optional parameter, available from station software 01.02. 00=Scream alarm only in "alarm preparation mode". 01=Scream alarm from idle.
 +
 +
The scream alarm is triggering DAK 19, and for testing the DAK key can be programmed to “I 101” or similar.
 +
 
 +
The default behavior of the Prison Station is that the scream alarm is active only when the station is in "alarm preparation mode" (controlled by display data command 0x60), i.e. when the guard is present by turning the key switch in position 1 or 2.
 +
 
 +
For special applications it is possible to enable scream alarm also from idle:
 +
 +
* ''$DSPL L%1.dir U6 64A008002301 <nowiki>''</nowiki> '': Enable scream alarm from idle
 +
* ''$DSPL L%1.dir U6 64A008002300 <nowiki>''</nowiki> '': Enable scream alarm only when in "alarm preparation mode" (Default)
 +
 +
 
 +
Relation between sound pressure and the programmed scream alarm volume:
 +
 
 +
{| border="1"
 +
| align="center" style="background:#ffdead;" width="80pt" |'''Volume<br>(00-FF)'''
 +
| align="center" style="background:#ffdead;" width="120pt" |'''Sound Pressure<br>(dBA, +/-3dB)'''
 +
|-
 +
| 40||74
 +
|-
 +
| 50||77
 +
|-
 +
| 60||80
 +
|-
 +
| 78||83
 +
|-
 +
| 90||86
 +
|-
 +
| A8||89
 +
|-
 +
| C0||92
 +
|-
 +
| D0||95
 +
|-
 +
| E0||98
 +
|-
 +
| F0||101
 +
|}
 +
 
 +
Example: ''$DSPL L%1.dir U5 64<u>78</u>080023 <nowiki>''</nowiki>'' will set the scream alarm level to 78 (83 dBA).
 +
<br><br>
 +
 
 +
=== Event Handler programming ===
 +
This paragraph describes the event handler programming used in the PrisCom database.
 +
==== The use of UDD variables ====
 +
 
 +
User Defined Data (UDD) are variables which can be used to store status information. In the PrisCom database the physical number of the station is used as index for the UDD. If there is a need to use additional UDD's in the database, one must avoid using index numbers in the same range as the physical numbers for the Prison Stations. In order to store several statuses in one UDD a bitmask is used  - one word per station:
 +
 
 +
 
 +
{| border="1"
 +
| align="center" style="background:#ffdead;" width="120pt" |'''Bit (value)'''
 +
| align="center" style="background:#ffdead;" width="270pt" |'''Description'''
 +
|-
 +
| 11 (2048)||(Not used)
 +
|-
 +
| 10 (1024)||Call request mode / tamper call
 +
|-
 +
| 9 (512)||Guard present
 +
|-
 +
| 8 (256)||Light status on
 +
|-
 +
| 7-0||(Not used)
 +
|-
 +
|}
 +
 
 +
Examples of using UDD's:
 +
*Read: '''%udd(%1.phy)''' will return the content of the UDD
 +
*Write: '''WUDD %1.phy 3''' will write the value 3 in the UDD
 +
 
 +
==== External light control ON ====
 +
Guard dials "9559 + 103 + C" to turn the cell-light relay on. Dirno 9559 is feature no 95/0.
 +
 
 +
'''Event Owner:''' UDP 1 (Guards)
 +
'''Event Type:'''  25 - Event Trigger w/Parameter
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:''' All
 +
'''Action:'''
 +
IND %2.phy 7 1 1 ON
 +
 
 +
==== External light control OFF ====
 +
Guard dials "9560 + 103 + C" to turn the cell-light relay off. Dirno 9560 is feature no 95/1.
 +
 
 +
'''Event Owner:''' UDP 1 (Guards)
 +
'''Event Type:'''  25 - Event Trigger w/Parameter
 +
'''Sub Event:'''  1
 +
'''When Change To:''' ON
 +
'''Related To:''' All
 +
'''Action:'''
 +
IND %2.phy 7 1 1 OFF
 +
 
 +
==== Conversation start ====
 +
 
 +
When conversation is established, "volume override" is activated and status lamps are switched off.
 +
 
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  07 - Conversation incoming
 +
'''When Change To:''' ON
 +
'''Related To:''' All
 +
'''Action:'''
 +
<nowiki>$DSPL L%1.dir U1 23 ''</nowiki>                    Volume override ON
 +
IF %op(%op(%udd(%1.phy),&,1024),==,1024)  If the station is in call request mode or tamper call (bit 10)
 +
WUDD %1.phy,%op(%udd(%1.phy),&,64511)      Reset Call Request mode / tamper call (bit 10)
 +
IND %1.phy 3 1 1 OFF                      Turn tamper-lamp off when communication is established
 +
IND %1.phy 1 1 1 OFF                      Turn call-lamp off when communication is established
 +
IND %1.phy 4 1 1 OFF                      Turn group-lamp off when communication is established
 +
ENDIF
 +
 
 +
==== Conversation end ====
 +
 
 +
When the conversation is ended, "volume override" is turned off.
 +
 
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  07 - Conversation incoming
 +
'''When Change To:''' OFF
 +
'''Related To:''' All
 +
'''Action:'''
 +
<nowiki>$DSPL L%1.dir U1 24 ''</nowiki>                    Volume override OFF
 +
 
 +
 
 +
==== Private Ringing start ====
 +
 
 +
When the Prison station starts to ring, and the station already has made a Call Request or the Guard is already present (Key Switch in pos.1 or 2), then autoanswer is triggered (simulating M-key press), and the converation is automatically established.
 +
If no autoanswer (still ringing), a flag is set to prevent the call button from triggering the call lamps when the button is pressed to answer the call. 
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  09 - Private Ringing mode
 +
'''When Change To:''' ON
 +
'''Related To:''' All
 +
'''Action:'''
 +
IF %op(%op(%op(%udd(%1.phy),&,512),==,512),||,%op(%op(%udd(%1.phy),&,1024),==,1024)) If Guard Present (bit 9) or Call Req mode (bit 10)
 +
$M L%1.dir                                                                          Simulate M-key push to connect the call without ringing
 +
$MREL L%1.dir
 +
STOP
 +
ENDIF
 +
<nowiki>$DSPL L%1.dir U1 47 ''</nowiki>                                                              Set flag for preventing call-request button
 +
                                                                                      from generating a callrequest in station's offline mode
 +
 
 +
==== Private Ringing end ====
 +
 
 +
When the ringing stops, clear the flag that prevents the call button from triggering the call lamps when the button is pressed to answer the call. 
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  09 - Private Ringing mode
 +
'''When Change To:''' OFF
 +
'''Related To:''' All
 +
'''Action:'''
 +
<nowiki>$DSPL L%1.dir U1 48 ''</nowiki>              Clear the flag that prevents the call button from generating a callrequest in station's offline mode
 +
 
 +
 
 +
==== Initialization of stations. DAK redirection ====
 +
 
 +
When the prison station is reported up (e.g. after a system restart), this event will send configuration data to the station using the $DSPL command. The event will also, with an IF statement, check if the station is already configured as a Prison station in the AMC by checking the [[Station_flags#Flags_.282.29|station flags2]] bits for Two-tone signaling and audio program display. If not already configured with these settings, they will be applied, and the DAK key 1 will be programmed to ">501" and DAK 2 to ">502".
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  13 - Faulty Station line
 +
'''When Change To:''' OFF
 +
'''Related To:''' All
 +
'''Action:'''
 +
LOG "St %1.phy, %1.dir %1.nam: Line fault reset" Send to System log that station is OK
 +
<nowiki>$DSPL L%1.dir U2 6100 ''</nowiki>                        Set light relay type to static
 +
<nowiki>$DSPL L%1.dir U2 6201 ''</nowiki>                        Offline mode: 01
 +
<nowiki>$DSPL L%1.dir U5 6302000000 ''</nowiki>                  Set input 1 (external call button) to alarm trigger input when station is in alarm mode.
 +
<nowiki>$DSPL L%1.dir U5 64A0080023 ''</nowiki>                  Configure scream alarm. Volume = A0, min. scream time = 08 (800ms), max. time = 00, pause = 23 (3500 ms)
 +
<nowiki>$DSPL L%1.dir U3 650960 ''</nowiki>                      Guard timeout: 0x0960 = 2400 ms = 4 min.
 +
<nowiki>$DSPL L%1.dir U2 6600 ''</nowiki>                        Key type: Capacitive sensor keys
 +
<nowiki>$DSPL L%1.dir U3 67000A ''</nowiki>                      Keyswitch: Static
 +
<nowiki>$DSPL L%1.dir U2 6806 ''</nowiki>                        Max. Volume override level = 06
 +
IF %OP(%op(%GNV(5,8,%1.phy,17),&,65519),==,39)  Is testing the bit pattern 1X0111 against [[Station_flags#Flags_.282.29|st_profile[n].flags2]] (but removes bit 5 first, counted from 1, this bit controls privacy.)
 +
STOP                                         Stop if the bit pattern already is 1X0111, as the station is already set as Prison Station.
 +
ENDIF
 +
$SNV Q55 W5 W8 W%1.phy W17                      Q55: Sets the bit pattern to 110111 (display, two-tone w/ack, privacy). Q39: Sets the bit pattern to 100111 (display, two-tone w/ack)
 +
$SNV Q16496 W5 W8 W%1.phy W16                 Sets bit 4, 5, 6 and 14 in [[Station_flags#Flags_.281.29|station_flags1]].
 +
$SNV Q62 W5 W8 W%1.phy W0 W0 W0                  Configure DAK 1 to ">500" and DAK 2 to ">501". Set first char in DAK 1 to ">"
 +
$SNV Q53 W5 W8 W%1.phy W0 W0 W1                  Set second char in DAK 1 to "5"
 +
$SNV Q48 W5 W8 W%1.phy W0 W0 W2                  Set third char in DAK 1 to "0"
 +
$SNV Q48 W5 W8 W%1.phy W0 W0 W3                  Set fourth char in DAK 1 to "0"
 +
$SNV Q62 W5 W8 W%1.phy W0 W1 W0                  Set first char in DAK 2 to ">"
 +
$SNV Q53 W5 W8 W%1.phy W0 W1 W1                  Set second char in DAK 2 to "5"
 +
$SNV Q48 W5 W8 W%1.phy W0 W1 W2                  Set third char in DAK 2 to "0"
 +
$SNV Q49 W5 W8 W%1.phy W0 W1 W3                  Set fourth char in DAK 2 to "1"
 +
 
 +
 
 +
==== LOG when a station is faulty ====
 +
 
 +
This event is triggered when a station is reported faulty, and an error message is sent to the [[System log]].
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  13 - Faulty Station line
 +
'''When Change To:''' ON
 +
'''Related To:''' All
 +
'''Action:'''
 +
LOG "St %1.phy, %1.dir %1.nam: Line fault"          Send to System log that station is FAULTY
 +
 
 +
 
 +
==== Call Request - Event Trigger 9550 ====
 +
 
 +
This event is triggered when the call button is pressed. A Call Request is sent to the Guard station(s), and the call- and group lamps are turned ON.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9550
 +
'''Action:'''
 +
$SM L%1.dir NG%1.exp U103 NM18 GV U3 'Call'          Send call request to the "Guard Group" (%1.exp) with priority 103
 +
LOG "St %1.phy, %1.dir %1.nam: Cell callrequest"    Send information to System log
 +
WUDD %1.phy,%op(%udd(%1.phy),|,1024)                Set Call Request mode / tamper call (bit 10)
 +
IND %1.phy 1 1 1 ON                                  Turn call-lamp on
 +
IND %1.phy 4 1 1 ON                                  Turn group-lamp on
 +
 
 +
==== Alarm Call Request - Event Trigger 9551 ====
 +
 
 +
This event is triggered when the status is "Guard Present" (i.e. the keyswitch is in position 1 or 2), and any button is pressed. An Alarm Call Request is sent to the Guard station(s), the lamps are turned ON, and a message is sent to [[AlphaVision]].
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9551
 +
'''Action:'''
 +
$STM L%1.dir NG%1.exp U143 '%1.dir Alarm!' U1        Send alarm request to the "Guard Group" (%1.exp) with priority 143
 +
LOG "St %1.phy, %1.dir %1.nam: Alarm call!"          Send information to System log
 +
IND %1.phy 1 1 3 ON                                  Turn call-lamp on, flashing
 +
IND %1.phy 4 1 3 ON                                  Turn group-lamp on, flashing
 +
IND %1.phy 2 1 1 ON                                  Turn guard present-lamp on
 +
@01FF M7C01 U01 W%1.phy U%3.CHG(3,0)                Send status message to AlphaVision
 +
 
 +
==== Tamper Alarm - Event Trigger 9552 ====
 +
 
 +
This event is triggered when the tamper alarm switch is activated. A message is sent to the Guard station(s), the tamper lamp is turned ON, and a message is sent to [[AlphaVision]].
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9552
 +
'''Action:'''
 +
$SM L%1.dir NG%1.exp U36 NM18 GV U2 'Tamper alarm!'  Send tamper alarm message to the "Guard Group" (%1.exp) with priority 36
 +
LOG "St %1.phy, %1.dir %1.nam: Tamper Alarm!"        Send information to System log
 +
WUDD %1.phy,%op(%udd(%1.phy),|,1024)                  Set Call Request mode / tamper call (bit 10)
 +
IND %1.phy 3 1 1 ON                                  Turn tamper-lamp on
 +
@01FF M7C01 U01 W%1.phy U%3.CHG(2,0)                  Send status message to AlphaVision
 +
 
 +
==== Guard Present 1 - Event Trigger 9553 ====
 +
 
 +
This event is triggered when the Guard Keyswitch is turned in position 1. Audio program is switched off, a "Guard Present" message is sent to the Guard station(s), the station is set in alarm mode (i.e. all buttons works as alarm buttons), the lamp status is updated, and a message is sent to [[AlphaVision]].
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9553
 +
'''Action:'''
 +
$TPROG L%1.dir U0                                      Switch off audio prog temporarily
 +
$CANM  L%1.dir  NG%1.exp                              Cancel all requests from this station
 +
$STM L%1.dir NG%1.exp U33 '%1.dir Grd present' U0      Send "Guard present" message
 +
LOG "St %1.phy, %1.dir %1.nam: Guard present"          Send information to System log
 +
<nowiki>$DSPL L%1.dir U2 6001 ''</nowiki>                              Cmd 60 01: Set Alarm preparation mode
 +
WUDD %1.phy,%op(%udd(%1.phy),|,512)                    Set Guard present (bit 9)
 +
IND %1.phy 1 1 1 OFF                                  Turn call-lamp off
 +
IND %1.phy 4 1 1 OFF                                  Turn group-lamp off
 +
IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
 +
<span style="color: green">IND %1.phy 7 1 1 ON                                    Switch on the cell light</span>
 +
@01FF M7C01 U01 W%1.phy U%3.CHG(3,0)                  Send status message to AlphaVision
 +
 
 +
If [[PrisCom_station_-_Configuration#Pulse_relay_instead_of_static_relay_for_Relay_Control_output|pulse relay]] is used, the state of the light (on or off) is unknown and the <span style="color: green">lines in green </span>should be removed.
 +
 
 +
==== Guard Present 2 - Event Trigger 9554 ====
 +
 
 +
This event is triggered when the Guard Keyswitch is turned in position 2. Audio program is switched off, a "Guard Present" message is sent to the Guard station(s), the station is set in alarm mode (i.e. all buttons works as alarm buttons), ''a 4 minute alarm timer is started'', the lamp status is updated, and a message is sent to [[AlphaVision]].
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9554
 +
'''Action:'''
 +
$TPROG L%1.dir U0                                      Switch off audio prog temporarily
 +
$CANM  L%1.dir  NG%1.exp                              Cancel all requests from this station
 +
$STM L%1.dir NG%1.exp U33 '%1.dir Grd present' U0      Send "Guard present" message
 +
LOG "St %1.phy, %1.dir %1.nam: Guard present"          Send information to System log
 +
<nowiki>$DSPL L%1.dir U2 6001 ''</nowiki>                              Cmd 60 01: Set Alarm preparation mode
 +
WUDD %1.phy,%op(%udd(%1.phy),|,512)                    Set Guard present (bit 9)
 +
$ST L%1.dir W2400 L9554                                Start a 240 second alarm-timer
 +
IND %1.phy 1 1 1 OFF                                  Turn call-lamp off
 +
IND %1.phy 4 1 1 OFF                                  Turn group-lamp off
 +
IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
 +
<span style="color: green">IND %1.phy 7 1 1 ON                                    Switch on the cell light</span>
 +
@01FF M7C01 U01 W%1.phy U%3.CHG(3,0)                  Send status message to AlphaVision
 +
 
 +
If [[PrisCom_station_-_Configuration#Pulse_relay_instead_of_static_relay_for_Relay_Control_output|pulse relay]] is used, the state of the light (on or off) is unknown and the <span style="color: green">lines in green </span>should be removed.
 +
 
 +
==== Guard Present timeout ====
 +
 
 +
This event is triggered when the timer that was started by turning the Guard Keyswitch in position 2, expires. An Alarm Call Request is sent to the Guard station(s) and the lamps are turned ON.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  21 - Event Timeout
 +
'''When Change To:''' ON
 +
'''Related To:'''  9554
 +
'''Action:'''
 +
$STM L%1.dir NG%1.exp U143 '%1.dir Alarm!' U1          Send "Alarm" message to Guard Group
 +
LOG "St %1.phy, %1.dir %1.nam: Alarm call! (timeout)"  Send information to System log
 +
IND %1.phy 1 1 3 ON                                    Turn call-lamp on, flashing
 +
IND %1.phy 4 1 3 ON                                    Turn group-lamp on, flashing
 +
IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
 +
 
 +
==== Guard reset - Event Trigger 9555 ====
 +
 
 +
This event is triggered when the Guard Keyswitch is turned back to idle position 0. Audio program is switched back on, all messages from this station is cleared, alarm mode and lamps are cleared, alarm timer is stopped, and a message is sent to [[AlphaVision]].
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9555
 +
'''Action:'''
 +
$TPROG L%1.dir U1                              Restore audio program
 +
$CANM  L%1.dir  NG%1.exp                        Cancel all requests from this station
 +
LOG "St %1.phy, %1.dir %1.nam: Guard reset"    Send information to System log
 +
<nowiki>$DSPL L%1.dir U2 6000 ''</nowiki>                        Cmd 60 00: Clear Alarm preparation mode
 +
WUDD %1.phy,%op(%udd(%1.phy),&,65023)          Reset Guard Present (bit 9)
 +
WUDD %1.phy,%op(%udd(%1.phy),&,64511)          Reset Call Request mode / tamper call (bit 10)
 +
$ST L%1.dir W0 L9554                            Stop the alarm-timer
 +
<span style="color: green">IF %op(%op(%udd(%1.phy),&,256),!=,256)          If the cell light was off before "Guard Present"...
 +
  IND %1.phy 7 1 1 OFF                          ...turn light off
 +
  @01FF M7C01 U01 W%1.phy U0                    ...Send message to AlphaVision
 +
ENDIF </span>
 +
IND %1.phy 0 0 0 OFF                            Switch off all lamps
 +
@01FF M7C01 U01 W%1.phy U0                      Send status message to AlphaVision
 +
 
 +
If [[PrisCom_station_-_Configuration#Pulse_relay_instead_of_static_relay_for_Relay_Control_output|pulse relay]] is used, the state of the light (on or off) is unknown and the <span style="color: green">lines in green </span>should be removed.
 +
 
 +
==== Power Fail ON - Event Trigger 9556 ====
 +
 
 +
This event is triggered when the local 24VDC power to the station drops out.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9556
 +
'''Action:'''
 +
$STM L%1.dir NG%1.exp U30 '%1.dir Power failure!' U0    Send "Power failure" message to guard group, priority 30
 +
LOG "St %1.phy, %1.dir %1.nam: Power failure"          Send information to System log
 +
 
 +
 
 +
==== Power Fail OFF - Event Trigger 9557 ====
 +
 
 +
This event is triggered when the station is connected to the local 24VDC power.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9557
 +
'''Action:'''
 +
$CANM L%1.dir NG%1.exp NM255 U30                        Remove "Power failure" message (i.e. all mails with priority 30)
 +
LOG "St %1.phy, %1.dir %1.nam: Power failure reset"    Send information to System log
 +
 
 +
 
 +
==== Light switch - Event Trigger 9558 ====
 +
 
 +
This event is triggered when the light button is pressed on the 1007063000 station. It is used to control the lighting in the cell.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9558
 +
'''Action:'''
 +
<span style="color: green">IF %op(%op(%udd(%1.phy),&,256),==,256)              If cell light is currently on...
 +
  WUDD %1.phy,%op(%udd(%1.phy),&,65279)            ..reset the light status (bit 8)
 +
  IND %1.phy 7 1 1 OFF                              ..switch light off
 +
  STOP
 +
ENDIF
 +
WUDD %1.phy,%op(%udd(%1.phy),|,256)                If cell light is currently off, set the light status (bit 8)...</span>
 +
IND %1.phy 7 1 1 ON                                ..and switch the light on. (If pulserelay, light will toggle on both ON and OFF message)
 +
 
 +
 
 +
If [[PrisCom_station_-_Configuration#Pulse_relay_instead_of_static_relay_for_Relay_Control_output|pulse relay]] is used, the state of the light (on or off) is unknown and the <span style="color: green">lines in green </span>should be removed.
 +
 
 +
==== Scream Alarm (VOX) - Event Trigger 9561 ====
 +
 
 +
This event is triggered when the keyswitch is in position 1 or 2, and audio above the [[PrisCom_station_-_Configuration#Scream_Alarm|specified level]] is detected.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  15 - Event Trigger Feature
 +
'''Sub Event:'''  0
 +
'''When Change To:''' ON
 +
'''Related To:'''  9561
 +
'''Action:'''
 +
IF %op(%op(%udd(%1.phy),&,512),==,512)                  If "Guard Present" status (bit 9)
 +
  $STM L%1.dir NG%1.exp U143 '%1.dir Scrm alarm!' U1    Send "Scream alarm" message
 +
  LOG "St %1.phy, %1.dir %1.nam: Scream alarm!"          Send information to System log
 +
  IND %1.phy 1 1 3 ON                                    Turn call-lamp on, flashing
 +
  IND %1.phy 4 1 3 ON                                    Turn group-lamp on, flashing
 +
  IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
 +
  @01FF M7C01 U01 W%1.phy U%3.CHG(4,0)                  Send message to AlphaVision
 +
  STOP
 +
ENDIF
 +
 
 +
 
 +
==== Silent call ====
 +
 
 +
The simplex conference feature can be used to silently monitor the prison station. When the prison station is included in a simplex conference this event is triggered, and a command is sent to the station not to switch on the "microphone alive" LED.
 +
 +
'''Event Owner:''' UDP 2 (Prison stations)
 +
'''Event Type:'''  17 - Simplex Conference Member
 +
'''When Change To:''' ON or OFF
 +
'''Related To:'''  All
 +
'''Action:'''
 +
<nowiki>$DSPL L%1.dir U1 %chg(45,46) ''</nowiki>                          Disable call LED while in Simplex Conference (monitoring mode).
 +
 
 +
 
 +
==== LOG Conversation start ====
 +
 
 +
All conversations will be logged in the [[System log]].
 +
 +
'''Event Owner:''' UDP 8 (all stations)
 +
'''Event Type:'''  7 - Conversation Incoming
 +
'''When Change To:''' ON
 +
'''Related To:'''  All
 +
'''Action:'''
 +
LOG "Conversation established: %2.dir -> %1.dir"          Send information to System log
 +
 
 +
 
 +
==== LOG Conversation end ====
 +
 
 +
All conversations will be logged in the [[System log]].
 +
 +
'''Event Owner:''' UDP 8 (all stations)
 +
'''Event Type:'''  7 - Conversation Incoming
 +
'''When Change To:''' OFF
 +
'''Related To:'''  All
 +
'''Action:'''
 +
LOG "Conversation reset      : %2.dir -> %1.dir"          Send information to System log
 +
 
 +
 
 +
==== LOG Private Ringing start ====
 +
 
 +
Calls in Private Ringing mode will be logged in the [[System log]].
 +
 +
'''Event Owner:''' UDP 8 (all stations)
 +
'''Event Type:'''  9 - Private Ringing mode
 +
'''When Change To:''' ON
 +
'''Related To:'''  All
 +
'''Action:'''
 +
LOG "Call in private        : %2.dir -> %1.dir"          Send information to System log
 +
 
 +
 
 +
==== Report faulty stations to AlphaVision ====
 +
 
 +
Station errors are reported to [[AlphaVision]] via this event. In AlphaVision the station error is displayed by a dedicated icon.
 +
 +
'''Event Owner:''' UDP 8 (all stations)
 +
'''Event Type:'''  13 - Faulty Station line
 +
'''When Change To:''' ON or OFF
 +
'''Related To:'''  All
 +
'''Action:'''
 +
@01FF M7C06 %1.REF U%3.CHG(1,0)                          Send status message to AlphaVision
 +
 
 +
 
 +
== Adding Guard Station in different node ==
 +
 
 +
It is possible to add one or more guard stations , analog or IP, in different nodes, but some changes must be done in the PrisCom node and the other nodes.
 +
 
 +
Changes in the other nodes:
 +
 
 +
*Add guard station as member in group 10, if this is the group used in Priscom node.
 +
*Set flag for "Show Mail in idle" in Users & Statons and Station Type tap.
 +
*Add events for answering call request with M-key or off-hook if wanted.
 +
*Change "Delete Mail Filter" in Exchange & System and Calls & Options from 0 to 3.
 +
[[File:Delete_Mail_Filter.png|thumb|left|500px|Change Delete Mail Filter]]
 +
<br style="clear:both;" />
 +
 
 +
Changes in PrisCom node:
 +
 
 +
* Change event 15 related to 9550. Add @FF in front of command $SM, and change parameter U3 to U11. Command should look like this: @FF $SM L%1.dir NG%1.exp U103 NM18 GV U11 'Call'
 +
[[File:Change_Call_Request_Event.PNG|thumb|left|500px|Change Call Request Event]]
 +
<br style="clear:both;" />
 +
 
 +
*Change command $SM and $STM to @FF $SM and @FF $STM in all events with UDP 2 as owner. This is 10 events in addition to the one in previous point:
 +
**Event 21 related to 9554
 +
**Event 15 related to 9554
 +
**Event 15 related to 9555
 +
**Event 15 related to 9556
 +
**Event 15 related to 9557
 +
**Event 15 related to 9561
 +
**Event 15 related to 9562
 +
**Event 15 related to 9551
 +
**Event 15 related to 9552
 +
**Event 15 related to 9553
 +
 
 +
== Offline mode ==
 +
When the station is set to offline mode, the inputs an outputs can be used even if the PrisCom station lose communication with the AlphaCom server for any reason. The input and output behavior described in the table below, is the same as the default online behavior.
 +
While in offline mode:
 +
{| border="1"
 +
| align="center" style="background:#ffdead;" width="100pt" |'''Activated Input'''
 +
| align="center" style="background:#ffdead;" width="350pt" |'''Action'''
 +
| align="center" style="background:#ffdead;" width="600pt" |'''Comment'''
 +
|-
 +
| Call key || Output 1 (L1) = ON <br> Output 4 (L4) = ON  <br>LED  driver flashing = ON || Red lamp (Call) <br> Red lamp (Group) <br/> External LED
 +
|-
 +
| IN Key1* ||Call/Alarm/Tamper OFF <br> Output 2 (L2) = ON <br> Relay = ON || If activated <br> Green lamp (Present) <br> Cell light
 +
|-
 +
| IN Key2* ||Call/Alarm/Tamper OFF <br> Output 2 (L2) = ON <br> Relay = ON || If activated <br> Green lamp (Present) <br> Cell light
 +
|-
 +
| Input 1 (Pulse)  ||Output 1 (L1) = ON <br> Output 4 (L4) = ON  <br>LED  driver flashing = ON || Red lamp (Call) <br> Red lamp (Group) <br/> External LED
 +
|-
 +
| Tamper Switch||Output 3 (L3) = ON || Blue lamp (Tamper)
 +
|-
 +
|}
 +
* All buttons works as alarm buttons. When IN Key 1 or 2 is deactivated, Output 2 (L2) and the relay is deactivated.
  
=== Upload to the AlphaCom ===
+
[[Category: Analogue Station - Configuration Guides]]
*First time after configuring the database it is required to use “SendAll” from AlphaPro
 
*Reset the AlphaCom, let it recognize all stations, and then reset once more
 
*The special dual reset is only required after adding new prison stations
 
*Do a “GetAll” to update AlphaPro with the correct settings
 
*Later changes of system settings only require “SendChanges”
 

Latest revision as of 10:02, 20 September 2022

This article describes how to configure the Prison Stations model 1007061000 and 1007063000.

PrisCom Stations
Model 1007061000
Model 1007063000


The PrisCom station


Contents

Software requirements

  • AMC software v.9.09 or later
  • AlphaPro 9.21 or later


"Scream alarm from idle" is available from station software 01.02.

Decide the configuration starting point

When configuring a system with the 1007061000/1007063000 stations there are two options:

  1. Start with a new AlphaPro database and fill in the parameters from scratch (Basic features)
  2. Use a preprogrammed PrisCom database from Zenitel (Advanced features)

"Basic features" are:

  • Call Button
  • Program Step button (without displaying selected channel)

"Advanced features" means support for:

  • Light button
  • External key switch
  • Corridor lamp and/or group lamp
  • Display for selected program channel
  • Tamper alarm and Power failure alarm
  • Scream alarm
  • AlphaVision

When using the advanced features of the station, it is highly recommended to use the preconfigured AlphaPro database as a starting point. The advanced features is depending a lot on Event Handler programming, and much work is saved by using an already preconfigured database.

Basic feature programming

The 7061 and 7063 uses “Two tone DAK signaling", not regular DAK signaling 

  • In Users & Stations -> User Preferences set DAK signaling to "(3) Two tone signaling w/ack“
  • In Users & Stations -> DAK assign numbers to the panel buttons: 
    • DAK 2 = Call button, normally configured to "I 623 I xxx", where xxx is the number of the Guard Station
    • DAK 3 = Program Step button, normally configured to "I 790" (button not available on the 100 7061 000)

Advanced feature programming

Download the PrisCom database from the download site. Copy the PrisCom database to the AlphaPro Database folder (E.g. C:\Program files\AlphaPro\Database).

Start AlphaPro and select the PrisCom database. Verify that the PrisCom database is visible.

Guard station configuration

  1. In Users & Stations window, highlight the guard station in the list box, select the tab UDP, and include the guard station in UDP 1
Include Guard Station in UDP 1


  1. In Groups -> Local Groups, select group 10 (or another free group) and include the guard station in this “Guard group”. This is required even with a single guard station.
  2. Continue with step 1 and 2 for all guard stations.
Include Guard Station in a "Guard group", here group 10


Prison station configuration

  1. In Users & Stations window, highlight the prison station in the list box, select the tab UDP, and include the prison station in UDP 2
  2. In Users & Stations window, highlight the prison station in the list box, select the tab UDP, and enter the “Guard group” index number (e.g. 10) in the Used Defined Parameter field. This is the target for calls from this station. When the call button is presses on the prison station, a call request is sent to all stations in this group.
  3. Continue with step 1 and 2 for all prison stations.
Prison station: Enable UDP 2, and enter the "Guard group" (here: 10) to receive the Call Request


Notes on DAK programming:

  • No DAK programming is required
  • The event handler programming in the PrisCom database will automatically set “Two tone DAK signaling”, and redirect the DAK keys to point to physical station 500 and 501
  • Physical station 500 and 501 have preconfigured DAK keys according to the PrisCom Station features.

Note that only Prison Stations model 1007061000 or 1007063000 should be in UDP 2. If there are other types of prison stations in the system, they should not be in UDP 2.

Upload configuration to the AlphaCom

  • After the PrisCom stations are connected to the AlphaCom, upload the configuration to the AlphaCom by selecting “SendAll” from AlphaPro
  • When the upload is finished, reset the AlphaCom. When the exchange is up and running, reset once more
  • Now do a “GetAll” to update AlphaPro with the correct settings

Note that every time a new Prison Station is added to the system, the above procedure should be used (SendAll, 2 x reset, GetAll).

The dual reset procedure is only required after adding new PrisCom stations to the system. The first reset will trigger the "Faulty Line OFF" event. This event will automatically program the DAK keys and enable the "Two Tone DAK signalling", and it will send configuration data to the Prison Stations. The second reset is to make the changes take effect. At this stage the AlphaCom configuration is different from the AlphaPro. The GetAll is required for AlphaPro to reflect the actual configuration in the exchange.

Description of the PrisCom database

The Prison Stations 7061 and 7063 are mainly operating by sending a "Two tone" DAK digits to the exchange for input events, and receiving display data messages in response. The Prison Stations are the only station types which are using the "double-tone" DAK signalling. The event handler programming in the PrisCom database will automatically set the Prison stations to use “Two tone DAK signaling”.

Display messages are used to e.g. turn lamps on, set alarm preparation mode during guard presence, or control other features. These messages are mostly defined as commands in the AlphaCom event handler. To change functionality one will have to change these commands or add/remove/change events.

DAK Keys on physical numbers 500 and 501

The Priscom stations have common DAK key programming. The DAK configuration is programmed on physical number 500 and 501, and the event handler programming in the PrisCom database will upon reset cause the AlphaCom to automatically program the DAK’s of the Prison Stations to point to these physical numbers 500 and 501. The DAK table of the physical numbers 500 and 501 are preconfigured according to the table below. Most of the numbers are Event Triggers, starting from 9550 and upwards. Actions for these custom event triggers are defined in the event handler, using the event “15 Event Trigger Feature”.

DAK keys 1-10 is from physical number 500, and DAK key 11-20 is from physical number 501.

PrisCom station connectors
DAK key DAK string Description
1 E 9558 Panelkey 1: Light button
2 M I 9550 Panelkey 2: Call Request / "Answer" on incoming calls
3 I 790 Panelkey 3: Program button
4 E 9551 Panelkeys in alarm mode: Alarm call
5 E 9552 Tamper switch
6 E 9553 IN KEY1 (Guard Keyswitch 1)
7 E 9554 IN KEY2 (Guard Keyswitch 2)
8 E 9555 Guard Keyswitch Reset
9 E 9556 Power fail (Voltage must be down in 7-8Vdc for 100ms before hardware notice to low voltage)
10 E 9557 Power OK
11 IN1 ON (Input 1): (Set as default alarm input during guard presence by display command 0x63. See below)
12 M I 9550 IN1 OFF (Input 1): External Call Request / "Answer" on incoming calls
13 IN2 ON (Input 2)
14 IN2 OFF (Input 2)
15 IN3 ON (Input 3)
16 IN3 OFF (Input 3)
17 IN4 ON (Input 4)
18 IN4 OFF (Input 4)
19 E 9561 Scream detector
20



IND Commands used by Prison Stations

The outputs on the Prison Stations are controlled by IND commands executed in the event handler. There are eight outputs:

IND output Description Comment
1 L1 - Output 1 Red lamp (Call)
2 L2 - Output 2 Green lamp (Present)
3 L3 - Output 3 Blue lamp (Tamper alarm)
4 L4 - Output 4 Group lamp
5 L5 - Output 5 Spare
6 L6 - Output 6 Spare
7 Relay Cell light
8 Call LED, External LED Also controlled by microphone active (polarity reversal of C/D-wire during conversation)

Syntax:

  • IND <station phys.no> <output> <1> <Indtype> [state]

Example:

  • IND %1.phy 1 1 3 ON: Turn the red lamp ON, flashing



Display data commands

Some properties of the Prison Station are configured in the station it self. The configuration data is sent to the Prison Station as display data, using the Event Handler and the $DSPL command.

The format is as follows:

$DSPL <station> <length> 
  • Station: The prison station
  • Length: The length of the data string.
  • Data: Display data command and parameters. For the Prison Station programming, sequential hex values are used to make the string.


Cmd Parameters Default Description
0x23 None Volume override ON.
0x24 None Volume override OFF.
0x45 None Disable call LED. ("Silent monitoring" mode).
0x46 None Enable call LED. (End "Silent monitoring" mode).
0x47 None Set flag for preventing call-request button from generating a callrequest in station's offline mode
0x48 None Clear flag for preventing call-request button from generating a callrequest in station's offline mode
0x60 00 = off, 01 = on 60 00 Set "alarm preparation mode" on/off. When ON, all panel buttons trigger DAK 4.
0x61 00 = static relay, >00 = pulse length 61 00 Select light relay type: Static or pulserelay.
0x62 00 = none, 01 = type1 62 01 Select offline mode operation type. Required for offline mode operation.
0x63 63 02 00 00 00 Configure general inputs. One byte for each input. Select inverted input (bit0) and alarm-trigger input (bit1)
0x64 64 A0 08 00 23 Configure Scream alarm detector. Volume level (00=set default), min scream-time (00=set default), max scream-time, min pause before re-enabling alarm. Times in 100ms resolution. (Note: Parameters are not saved to EEPROM, and lost when the station is moved).
0x65 65 0960 Set guard alarm timeout. Value is 16-bit, 100ms resolution. Max value = 0x199A (11 minutes).
0x66 66 00 Select front-panel key types: Capacitive sensor-key (0) or switch input (1). Each bit represents one key (bit0 = light-button, bit1 = callrequest, bit2 = program, bit3 = vol up, bit4 = vol dn).
0x67 67 00 0A Configure keyswitch inputs: Static switches (00) or toggle-switches (01). Delay after activation in 100ms resolution.
0x68 68 06 Set default volume override level (selected by messages 0x23/0x24). Min=00 Max=06.
0x70 None 70 Restore EEPROM defaults.


Examples:
$DSPL L%1.dir U2 6100 '' : Set light relay to static mode
$DSPL L%1.dir U1 23 '' : Volume override ON

Note:
The parameters are followed by two single apostrophes ('). Closing single quotation marks (‘…’) are not valid. A text editor like Word (and others) tends to convert apostrophes to single quotation marks, which will not work.

Volume Override

When using the PrisCom database and a conversation is established, the volume set by the user is overridden, and a preset volume is used. The preset volume is defined by the display data command 0x68. By default set to maximum ($DSPL L%1.dir U2 6806'').

The volume override ON is set by the display data command 0x23 when the conversation starts ($DSPL L%1.dir U1 23''), and the volume override OFF is set by the command 0x24 when the conversation ends ($DSPL L%1.dir U1 24'' ).

If the preset override volume is too loud, the following event can be modified:

Owner:    Event:                   Change to:
UDP 2     13-Faulty station line   OFF

In the "Action field" find the line:

  • $DSPL L%1.dir U2 6806'', and change 06 to a value 00-05. The value 00-06 sets what volume level to use when volume override is activated.


If volume override is not wanted at all, one can delete the line $DSPL L%1.dir U1 23'' from the "Conversation Incoming ON" event.

Changing the privacy setting

By default the Prison Stations are set in privacy mode. This means that a guard can’t call directly into the cell, but the prisoner has to accept the call by pressing the call button.

To change the station to operate in Open mode, the following event must be modified:

Owner:    Event:                   Change to:
UDP 2     13-Faulty station line   OFF

In the "Action field" find the line:

  • $SNV Q55 W5 W8 W%1.phy W17 (Prison stations in Private mode)

Change into:

  • $SNV Q39 W5 W8 W%1.phy W17 (Prison stations not in Private mode)


Changing Offline mode operation

The cell station operates in both "online" mode when connected to AlphaCom and "offline" mode when connection is lost and only 24V power is used. In this mode the external lamps are used for status signalling. This operation is mostly hardcoded in the station. In case the station is used in an installation where offline mode operation should be turned off or changed, the following event can be modified:

Owner:    Event:                    Change to:          
UDP 2     13 Faulty station line    OFF

In the "Action field" find the line:

Change into:

  • $DSPL L%1.dir U2 6200 '' (Offline operation turned off)

Note: In current station software v1.02 there is only one available offline operation mode: 01. Other modes may be added in the future.

Changing Guard Presence timeout-alarm

When a guard marks his presence in a cell by turning the keyswitch to position 2, an alarm timeout is activated (no timeout for keyswitch position 1). The value of this timeout can be adjusted in the event handler.

The following event must be modified:

Owner:    Event:                   Change to:  Related to:    
UDP 2     15-Event trigger         ON          9554

Modify this action command:

  • $ST L%1.dir W2400 L9554

The value “W2400” is in 100ms resolution, which gives a 240 seconds (4 minutes) timeout. Change to desired value. Value is in decimal format.


Changing Sensor Key sensitivity

By default the sensor buttons are set for high sensitivity, making it possible to operate the station with sanitary or latex gloves.

If the station is located in an area with high humidity, for instance just outside a shower area, there is a risk that the station could generate ghost calls. It is possible to change the sensor buttons to a lower sensitivity. The side effect is that gloves cannot be used to trigger calls.

The following event must be modified:

Owner:    Event:                   Change to:      
UDP 2     13-Faulty station line   OFF

Modify this action command:

  • $DSPL L%1.dir U2 6600 '' (High key sensitivity)

into:

  • $DSPL L%1.dir U2 661f '' (Low key sensitivity)

Pulse relay instead of static relay for Relay Control output

By default the Relay Control output (connector P1/5 and P1/6) is configured as a static relay changing on/off each time the “light” button on the prison station is pressed. This can be changed to a pulse relay operation if such a relay is used.

The following event must be modified:

Owner:    Event:                   Change to:      
UDP 2     13-Faulty station line   OFF

Modify this action command:

  • $DSPL L%1.dir U3 6100 '' (Static relay)

into:

  • $DSPL L%1.dir U3 610A '' (Pulserelay, 10*10ms pulsetime)

The parameter "0A" to the display data command 0x61 in the string above defines the pulsetime in 10ms resolution. Value is in hex format.


If pulse relay is used, the state of the light (on or off) is unknown and some events should be modified accordingly. Some action lines should be deleted. They are highlighted by green color in the following event handler description.

Scream Alarm

The display data command 0x64 is used to set the level and duration necessary to trigger the scream alarm.

0x64 <volume level> <min-time> <max-time> <pause> [mode]	

Default command is 64 A0 08 00 23, the values are in hexadecimal.

  • Volume level is the trigger level 00-FF, A0 is default. See table below.
  • Minimum scream time = 08 Default (800ms). Noise must be present this long to trigger an alarm
  • Maximum time = 00 default (optional). Noise longer than this do not trigger an alarm. Can be used to surpress alarms caused by sudden background noise which is present for a long time (longer than specified in this parameter).
  • Pause is minimum time for re-enabling alarm is default 23 (= 3500ms)
  • Mode is an optional parameter, available from station software 01.02. 00=Scream alarm only in "alarm preparation mode". 01=Scream alarm from idle.

The scream alarm is triggering DAK 19, and for testing the DAK key can be programmed to “I 101” or similar.

The default behavior of the Prison Station is that the scream alarm is active only when the station is in "alarm preparation mode" (controlled by display data command 0x60), i.e. when the guard is present by turning the key switch in position 1 or 2.

For special applications it is possible to enable scream alarm also from idle:

  • $DSPL L%1.dir U6 64A008002301 '' : Enable scream alarm from idle
  • $DSPL L%1.dir U6 64A008002300 '' : Enable scream alarm only when in "alarm preparation mode" (Default)


Relation between sound pressure and the programmed scream alarm volume:

Volume
(00-FF)
Sound Pressure
(dBA, +/-3dB)
40 74
50 77
60 80
78 83
90 86
A8 89
C0 92
D0 95
E0 98
F0 101

Example: $DSPL L%1.dir U5 6478080023 '' will set the scream alarm level to 78 (83 dBA).

Event Handler programming

This paragraph describes the event handler programming used in the PrisCom database.

The use of UDD variables

User Defined Data (UDD) are variables which can be used to store status information. In the PrisCom database the physical number of the station is used as index for the UDD. If there is a need to use additional UDD's in the database, one must avoid using index numbers in the same range as the physical numbers for the Prison Stations. In order to store several statuses in one UDD a bitmask is used - one word per station:


Bit (value) Description
11 (2048) (Not used)
10 (1024) Call request mode / tamper call
9 (512) Guard present
8 (256) Light status on
7-0 (Not used)

Examples of using UDD's:

  • Read: %udd(%1.phy) will return the content of the UDD
  • Write: WUDD %1.phy 3 will write the value 3 in the UDD

External light control ON

Guard dials "9559 + 103 + C" to turn the cell-light relay on. Dirno 9559 is feature no 95/0.

Event Owner: UDP 1 (Guards)
Event Type:  25 - Event Trigger w/Parameter
Sub Event:   0
When Change To: ON
Related To: All
Action: 
IND %2.phy 7 1 1 ON

External light control OFF

Guard dials "9560 + 103 + C" to turn the cell-light relay off. Dirno 9560 is feature no 95/1.

Event Owner: UDP 1 (Guards)
Event Type:  25 - Event Trigger w/Parameter
Sub Event:   1
When Change To: ON
Related To: All
Action: 
IND %2.phy 7 1 1 OFF

Conversation start

When conversation is established, "volume override" is activated and status lamps are switched off.

Event Owner: UDP 2 (Prison stations)
Event Type:  07 - Conversation incoming
When Change To: ON
Related To: All
Action: 
$DSPL L%1.dir U1 23 ''                     Volume override ON	
IF %op(%op(%udd(%1.phy),&,1024),==,1024)   If the station is in call request mode or tamper call (bit 10)	
WUDD %1.phy,%op(%udd(%1.phy),&,64511)      Reset Call Request mode / tamper call (bit 10)	
IND %1.phy 3 1 1 OFF                       Turn tamper-lamp off when communication is established
IND %1.phy 1 1 1 OFF                       Turn call-lamp off when communication is established	
IND %1.phy 4 1 1 OFF                       Turn group-lamp off when communication is established
ENDIF

Conversation end

When the conversation is ended, "volume override" is turned off.

Event Owner: UDP 2 (Prison stations)
Event Type:  07 - Conversation incoming
When Change To: OFF
Related To: All
Action: 
$DSPL L%1.dir U1 24 ''                     Volume override OFF


Private Ringing start

When the Prison station starts to ring, and the station already has made a Call Request or the Guard is already present (Key Switch in pos.1 or 2), then autoanswer is triggered (simulating M-key press), and the converation is automatically established. If no autoanswer (still ringing), a flag is set to prevent the call button from triggering the call lamps when the button is pressed to answer the call.

Event Owner: UDP 2 (Prison stations)
Event Type:  09 - Private Ringing mode
When Change To: ON
Related To: All
Action: 
IF %op(%op(%op(%udd(%1.phy),&,512),==,512),||,%op(%op(%udd(%1.phy),&,1024),==,1024)) If Guard Present (bit 9) or Call Req mode (bit 10)
$M L%1.dir                                                                           Simulate M-key push to connect the call without ringing	
$MREL L%1.dir		
STOP		
ENDIF		
$DSPL L%1.dir U1 47 ''                                                               Set flag for preventing call-request button
                                                                                     from generating a callrequest in station's offline mode

Private Ringing end

When the ringing stops, clear the flag that prevents the call button from triggering the call lamps when the button is pressed to answer the call.

Event Owner: UDP 2 (Prison stations)
Event Type:  09 - Private Ringing mode
When Change To: OFF
Related To: All
Action: 	
$DSPL L%1.dir U1 48 ''               Clear the flag that prevents the call button from generating a callrequest in station's offline mode


Initialization of stations. DAK redirection

When the prison station is reported up (e.g. after a system restart), this event will send configuration data to the station using the $DSPL command. The event will also, with an IF statement, check if the station is already configured as a Prison station in the AMC by checking the station flags2 bits for Two-tone signaling and audio program display. If not already configured with these settings, they will be applied, and the DAK key 1 will be programmed to ">501" and DAK 2 to ">502".

Event Owner: UDP 2 (Prison stations)
Event Type:  13 - Faulty Station line
When Change To: OFF
Related To: All
Action: 	
LOG "St %1.phy, %1.dir %1.nam: Line fault reset" Send to System log that station is OK
$DSPL L%1.dir U2 6100 ''                         Set light relay type to static
$DSPL L%1.dir U2 6201 ''                         Offline mode: 01
$DSPL L%1.dir U5 6302000000 ''                   Set input 1 (external call button) to alarm trigger input when station is in alarm mode.
$DSPL L%1.dir U5 64A0080023 ''                   Configure scream alarm. Volume = A0, min. scream time = 08 (800ms), max. time = 00, pause = 23 (3500 ms)
$DSPL L%1.dir U3 650960 ''                       Guard timeout: 0x0960 = 2400 ms = 4 min.
$DSPL L%1.dir U2 6600 ''                         Key type: Capacitive sensor keys
$DSPL L%1.dir U3 67000A ''                       Keyswitch: Static
$DSPL L%1.dir U2 6806 ''                         Max. Volume override level = 06
IF %OP(%op(%GNV(5,8,%1.phy,17),&,65519),==,39)   Is testing the bit pattern 1X0111 against st_profile[n].flags2 (but removes bit 5 first, counted from 1, this bit controls privacy.)
STOP	                                         Stop if the bit pattern already is 1X0111, as the station is already set as Prison Station.
ENDIF	
$SNV Q55 W5 W8 W%1.phy W17                       Q55: Sets the bit pattern to 110111 (display, two-tone w/ack, privacy). Q39: Sets the bit pattern to 100111 (display, two-tone w/ack)
$SNV Q16496 W5 W8 W%1.phy W16	                 Sets bit 4, 5, 6 and 14 in station_flags1.
$SNV Q62 W5 W8 W%1.phy W0 W0 W0                  Configure DAK 1 to ">500" and DAK 2 to ">501". Set first char in DAK 1 to ">"
$SNV Q53 W5 W8 W%1.phy W0 W0 W1                  Set second char in DAK 1 to "5"
$SNV Q48 W5 W8 W%1.phy W0 W0 W2                  Set third char in DAK 1 to "0"
$SNV Q48 W5 W8 W%1.phy W0 W0 W3                  Set fourth char in DAK 1 to "0"
$SNV Q62 W5 W8 W%1.phy W0 W1 W0                  Set first char in DAK 2 to ">"
$SNV Q53 W5 W8 W%1.phy W0 W1 W1                  Set second char in DAK 2 to "5"
$SNV Q48 W5 W8 W%1.phy W0 W1 W2                  Set third char in DAK 2 to "0"
$SNV Q49 W5 W8 W%1.phy W0 W1 W3                  Set fourth char in DAK 2 to "1"


LOG when a station is faulty

This event is triggered when a station is reported faulty, and an error message is sent to the System log.

Event Owner: UDP 2 (Prison stations)
Event Type:  13 - Faulty Station line
When Change To: ON
Related To: All
Action: 	
LOG "St %1.phy, %1.dir %1.nam: Line fault"           Send to System log that station is FAULTY


Call Request - Event Trigger 9550

This event is triggered when the call button is pressed. A Call Request is sent to the Guard station(s), and the call- and group lamps are turned ON.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9550
Action: 	
$SM L%1.dir NG%1.exp U103 NM18 GV U3 'Call'          Send call request to the "Guard Group" (%1.exp) with priority 103
LOG "St %1.phy, %1.dir %1.nam: Cell callrequest"     Send information to System log
WUDD %1.phy,%op(%udd(%1.phy),|,1024)                 Set Call Request mode / tamper call (bit 10)
IND %1.phy 1 1 1 ON                                  Turn call-lamp on
IND %1.phy 4 1 1 ON                                  Turn group-lamp on

Alarm Call Request - Event Trigger 9551

This event is triggered when the status is "Guard Present" (i.e. the keyswitch is in position 1 or 2), and any button is pressed. An Alarm Call Request is sent to the Guard station(s), the lamps are turned ON, and a message is sent to AlphaVision.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9551
Action: 	
$STM L%1.dir NG%1.exp U143 '%1.dir Alarm!' U1        Send alarm request to the "Guard Group" (%1.exp) with priority 143
LOG "St %1.phy, %1.dir %1.nam: Alarm call!"          Send information to System log
IND %1.phy 1 1 3 ON                                  Turn call-lamp on, flashing
IND %1.phy 4 1 3 ON                                  Turn group-lamp on, flashing
IND %1.phy 2 1 1 ON                                  Turn guard present-lamp on
@01FF M7C01 U01 W%1.phy U%3.CHG(3,0)                 Send status message to AlphaVision

Tamper Alarm - Event Trigger 9552

This event is triggered when the tamper alarm switch is activated. A message is sent to the Guard station(s), the tamper lamp is turned ON, and a message is sent to AlphaVision.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9552
Action: 	
$SM L%1.dir NG%1.exp U36 NM18 GV U2 'Tamper alarm!'   Send tamper alarm message to the "Guard Group" (%1.exp) with priority 36
LOG "St %1.phy, %1.dir %1.nam: Tamper Alarm!"         Send information to System log
WUDD %1.phy,%op(%udd(%1.phy),|,1024)                  Set Call Request mode / tamper call (bit 10)
IND %1.phy 3 1 1 ON                                   Turn tamper-lamp on
@01FF M7C01 U01 W%1.phy U%3.CHG(2,0)                  Send status message to AlphaVision

Guard Present 1 - Event Trigger 9553

This event is triggered when the Guard Keyswitch is turned in position 1. Audio program is switched off, a "Guard Present" message is sent to the Guard station(s), the station is set in alarm mode (i.e. all buttons works as alarm buttons), the lamp status is updated, and a message is sent to AlphaVision.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9553
Action: 	
$TPROG L%1.dir U0                                      Switch off audio prog temporarily
$CANM  L%1.dir  NG%1.exp                               Cancel all requests from this station
$STM L%1.dir NG%1.exp U33 '%1.dir Grd present' U0      Send "Guard present" message
LOG "St %1.phy, %1.dir %1.nam: Guard present"          Send information to System log
$DSPL L%1.dir U2 6001 ''                               Cmd 60 01: Set Alarm preparation mode
WUDD %1.phy,%op(%udd(%1.phy),|,512)                    Set Guard present (bit 9)
IND %1.phy 1 1 1 OFF                                   Turn call-lamp off
IND %1.phy 4 1 1 OFF                                   Turn group-lamp off
IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
IND %1.phy 7 1 1 ON                                    Switch on the cell light
@01FF M7C01 U01 W%1.phy U%3.CHG(3,0)                   Send status message to AlphaVision

If pulse relay is used, the state of the light (on or off) is unknown and the lines in green should be removed.

Guard Present 2 - Event Trigger 9554

This event is triggered when the Guard Keyswitch is turned in position 2. Audio program is switched off, a "Guard Present" message is sent to the Guard station(s), the station is set in alarm mode (i.e. all buttons works as alarm buttons), a 4 minute alarm timer is started, the lamp status is updated, and a message is sent to AlphaVision.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9554
Action: 	
$TPROG L%1.dir U0                                      Switch off audio prog temporarily
$CANM  L%1.dir  NG%1.exp                               Cancel all requests from this station
$STM L%1.dir NG%1.exp U33 '%1.dir Grd present' U0      Send "Guard present" message
LOG "St %1.phy, %1.dir %1.nam: Guard present"          Send information to System log
$DSPL L%1.dir U2 6001 ''                               Cmd 60 01: Set Alarm preparation mode
WUDD %1.phy,%op(%udd(%1.phy),|,512)                    Set Guard present (bit 9)
$ST L%1.dir W2400 L9554                                Start a 240 second alarm-timer
IND %1.phy 1 1 1 OFF                                   Turn call-lamp off
IND %1.phy 4 1 1 OFF                                   Turn group-lamp off
IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
IND %1.phy 7 1 1 ON                                    Switch on the cell light
@01FF M7C01 U01 W%1.phy U%3.CHG(3,0)                   Send status message to AlphaVision

If pulse relay is used, the state of the light (on or off) is unknown and the lines in green should be removed.

Guard Present timeout

This event is triggered when the timer that was started by turning the Guard Keyswitch in position 2, expires. An Alarm Call Request is sent to the Guard station(s) and the lamps are turned ON.

Event Owner: UDP 2 (Prison stations)
Event Type:  21 - Event Timeout
When Change To: ON
Related To:  9554
Action: 	
$STM L%1.dir NG%1.exp U143 '%1.dir Alarm!' U1           Send "Alarm" message to Guard Group
LOG "St %1.phy, %1.dir %1.nam: Alarm call! (timeout)"   Send information to System log
IND %1.phy 1 1 3 ON                                     Turn call-lamp on, flashing
IND %1.phy 4 1 3 ON                                     Turn group-lamp on, flashing
IND %1.phy 2 1 1 ON                                     Turn guard present-lamp on

Guard reset - Event Trigger 9555

This event is triggered when the Guard Keyswitch is turned back to idle position 0. Audio program is switched back on, all messages from this station is cleared, alarm mode and lamps are cleared, alarm timer is stopped, and a message is sent to AlphaVision.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9555
Action: 	
$TPROG L%1.dir U1                               Restore audio program
$CANM  L%1.dir  NG%1.exp                        Cancel all requests from this station
LOG "St %1.phy, %1.dir %1.nam: Guard reset"     Send information to System log
$DSPL L%1.dir U2 6000 ''                        Cmd 60 00: Clear Alarm preparation mode
WUDD %1.phy,%op(%udd(%1.phy),&,65023)           Reset Guard Present (bit 9)
WUDD %1.phy,%op(%udd(%1.phy),&,64511)           Reset Call Request mode / tamper call (bit 10)
$ST L%1.dir W0 L9554                            Stop the alarm-timer
IF %op(%op(%udd(%1.phy),&,256),!=,256)          If the cell light was off before "Guard Present"...
  IND %1.phy 7 1 1 OFF                          ...turn light off
  @01FF M7C01 U01 W%1.phy U0                    ...Send message to AlphaVision
ENDIF 
IND %1.phy 0 0 0 OFF                            Switch off all lamps
@01FF M7C01 U01 W%1.phy U0                      Send status message to AlphaVision

If pulse relay is used, the state of the light (on or off) is unknown and the lines in green should be removed.

Power Fail ON - Event Trigger 9556

This event is triggered when the local 24VDC power to the station drops out.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9556
Action: 	
$STM L%1.dir NG%1.exp U30 '%1.dir Power failure!' U0    Send "Power failure" message to guard group, priority 30
LOG "St %1.phy, %1.dir %1.nam: Power failure"           Send information to System log


Power Fail OFF - Event Trigger 9557

This event is triggered when the station is connected to the local 24VDC power.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9557
Action: 	
$CANM L%1.dir NG%1.exp NM255 U30                        Remove "Power failure" message (i.e. all mails with priority 30)
LOG "St %1.phy, %1.dir %1.nam: Power failure reset"     Send information to System log


Light switch - Event Trigger 9558

This event is triggered when the light button is pressed on the 1007063000 station. It is used to control the lighting in the cell.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9558
Action: 	
IF %op(%op(%udd(%1.phy),&,256),==,256)              If cell light is currently on...
  WUDD %1.phy,%op(%udd(%1.phy),&,65279)             ..reset the light status (bit 8)
  IND %1.phy 7 1 1 OFF                              ..switch light off
  STOP
ENDIF	
WUDD %1.phy,%op(%udd(%1.phy),|,256)                 If cell light is currently off, set the light status (bit 8)...
IND %1.phy 7 1 1 ON                                 ..and switch the light on. (If pulserelay, light will toggle on both ON and OFF message)


If pulse relay is used, the state of the light (on or off) is unknown and the lines in green should be removed.

Scream Alarm (VOX) - Event Trigger 9561

This event is triggered when the keyswitch is in position 1 or 2, and audio above the specified level is detected.

Event Owner: UDP 2 (Prison stations)
Event Type:  15 - Event Trigger Feature
Sub Event:   0
When Change To: ON
Related To:  9561
Action: 	
IF %op(%op(%udd(%1.phy),&,512),==,512)                   If "Guard Present" status (bit 9)
  $STM L%1.dir NG%1.exp U143 '%1.dir Scrm alarm!' U1     Send "Scream alarm" message
  LOG "St %1.phy, %1.dir %1.nam: Scream alarm!"          Send information to System log
  IND %1.phy 1 1 3 ON                                    Turn call-lamp on, flashing
  IND %1.phy 4 1 3 ON                                    Turn group-lamp on, flashing
  IND %1.phy 2 1 1 ON                                    Turn guard present-lamp on
  @01FF M7C01 U01 W%1.phy U%3.CHG(4,0)                   Send message to AlphaVision
  STOP	
ENDIF


Silent call

The simplex conference feature can be used to silently monitor the prison station. When the prison station is included in a simplex conference this event is triggered, and a command is sent to the station not to switch on the "microphone alive" LED.

Event Owner: UDP 2 (Prison stations)
Event Type:  17 - Simplex Conference Member
When Change To: ON or OFF
Related To:  All
Action: 	
$DSPL L%1.dir U1 %chg(45,46) ''                           Disable call LED while in Simplex Conference (monitoring mode).


LOG Conversation start

All conversations will be logged in the System log.

Event Owner: UDP 8 (all stations)
Event Type:  7 - Conversation Incoming
When Change To: ON
Related To:  All
Action: 	
LOG "Conversation established: %2.dir -> %1.dir"          Send information to System log


LOG Conversation end

All conversations will be logged in the System log.

Event Owner: UDP 8 (all stations)
Event Type:  7 - Conversation Incoming
When Change To: OFF
Related To:  All
Action: 	
LOG "Conversation reset      : %2.dir -> %1.dir"          Send information to System log


LOG Private Ringing start

Calls in Private Ringing mode will be logged in the System log.

Event Owner: UDP 8 (all stations)
Event Type:  9 - Private Ringing mode
When Change To: ON
Related To:  All
Action: 	
LOG "Call in private         : %2.dir -> %1.dir"          Send information to System log


Report faulty stations to AlphaVision

Station errors are reported to AlphaVision via this event. In AlphaVision the station error is displayed by a dedicated icon.

Event Owner: UDP 8 (all stations)
Event Type:  13 - Faulty Station line
When Change To: ON or OFF
Related To:  All
Action: 	
@01FF M7C06 %1.REF U%3.CHG(1,0)                           Send status message to AlphaVision


Adding Guard Station in different node

It is possible to add one or more guard stations , analog or IP, in different nodes, but some changes must be done in the PrisCom node and the other nodes.

Changes in the other nodes:

  • Add guard station as member in group 10, if this is the group used in Priscom node.
  • Set flag for "Show Mail in idle" in Users & Statons and Station Type tap.
  • Add events for answering call request with M-key or off-hook if wanted.
  • Change "Delete Mail Filter" in Exchange & System and Calls & Options from 0 to 3.
Change Delete Mail Filter


Changes in PrisCom node:

  • Change event 15 related to 9550. Add @FF in front of command $SM, and change parameter U3 to U11. Command should look like this: @FF $SM L%1.dir NG%1.exp U103 NM18 GV U11 'Call'
Change Call Request Event


  • Change command $SM and $STM to @FF $SM and @FF $STM in all events with UDP 2 as owner. This is 10 events in addition to the one in previous point:
    • Event 21 related to 9554
    • Event 15 related to 9554
    • Event 15 related to 9555
    • Event 15 related to 9556
    • Event 15 related to 9557
    • Event 15 related to 9561
    • Event 15 related to 9562
    • Event 15 related to 9551
    • Event 15 related to 9552
    • Event 15 related to 9553

Offline mode

When the station is set to offline mode, the inputs an outputs can be used even if the PrisCom station lose communication with the AlphaCom server for any reason. The input and output behavior described in the table below, is the same as the default online behavior. While in offline mode:

Activated Input Action Comment
Call key Output 1 (L1) = ON
Output 4 (L4) = ON
LED driver flashing = ON
Red lamp (Call)
Red lamp (Group)
External LED
IN Key1* Call/Alarm/Tamper OFF
Output 2 (L2) = ON
Relay = ON
If activated
Green lamp (Present)
Cell light
IN Key2* Call/Alarm/Tamper OFF
Output 2 (L2) = ON
Relay = ON
If activated
Green lamp (Present)
Cell light
Input 1 (Pulse) Output 1 (L1) = ON
Output 4 (L4) = ON
LED driver flashing = ON
Red lamp (Call)
Red lamp (Group)
External LED
Tamper Switch Output 3 (L3) = ON Blue lamp (Tamper)
* All buttons works as alarm buttons. When IN Key 1 or 2 is deactivated, Output 2 (L2) and the relay is deactivated.