View source for Prison Applications using VS-Operator

{{AI}}
<table style="float:right; max-width:80%; border-style: double; border-color: #c7c7c7;">
<tr style="rowspan:2;">
<td style="display: block; vertical-align: bottom;">[[Image:Prison Main.png|700px]]</td>
</tr>
<tr>
<td style="background-color:#efefef;">The above image shows a typical layout for a prison.</td>
</tr>
</table>

This is an article showing a few suggestions for using VS Operator in a prison environment. From the layout an operator will be able to handle:

*Call Requests
*Tamper Alarm
*Video control
*Visitor Intercom
*Recording

In the example used, all cell stations call the guard using Ringing Group 1.


==Layout==
The layout is divided into 5 parts:

#Established Call
#Call Request List
#Tile view (video)
#Map view
#Journal

[[File:Prison Layout.png|left|750px]]
<br style="clear:both;" />

==Cell Script==
===Call Request Buttons===
For each station in the Call Request list we can define two buttons that allows us to answer the incoming call, or dismiss it. <br>
Create a new station script. In this example it is named CellScript. Add the following scripts for Call request buttons:

*Click the ''Call request buttons'' and then click '''Add'''
*Name the first button '''Accept''' and the second button '''Cancel'''

[[File:CellScript CR Buttons.png|left|700px]]
<br style="clear:both;" />

For button '''Accept''' enter in the field to the right the following script: <br>
{{Code|App.STE ("@U%NNOP $CALL L%DIROP L%DIRA");}}

For button '''Cancel''' enter in the field to the right the following script: <br>
{{Code|App.STE ("@U%NNOP $C L%DIRA");}}

In case the Call Request code 62x is used instead of ringing group the script must be:
{{Code|App.STE ("@U%NNOP $MAILQ_NAVIG L%DIROP U0");}}


[[File:CellScript CR Buttons2.png|left|700px]]
<br style="clear:both;" />

===Established call button===
When the operator station is in a conversation with a cell, we can define two buttons. One for starting to record the conversation, and one for ending the conversation. <br>
Edit the script CellScript. Add the following scripts for Call established buttons:

*Click the ''Established call buttons'' and then click '''Add'''
*Name the first button '''Record''' and the second button '''Cancel'''

For button '''Record''' enter in the field to the right the following script: <br>
{{Code|App.STE ("@U%NNOP $REC L%DIRA");}}

For button '''Cancel''' enter in the field to the right the following script: <br>
{{Code|App.STE ("@U%NNOP $C L%DIRA");}}

[[File:CellScript EC Buttons.png|left|700px]]
<br style="clear:both;" />

[[File:CellScript EC Buttons2.png|left|700px]]
<br style="clear:both;" />

===Icon commands===
VS Operator can present different options by right clicking a Cell Icon in different Station States. <br>
A station icon can have 8 states, ranging from 0 to 7. It is possible to present a different set of choices for each state when right clicking the icon:

*During Idle State

[[File:Cell Idle.png]]

*During Conversation State

[[File:Cell conversation.png]]

*During Call Request State

[[File:Cell CR.png]]

*During Tamper Alarm State

[[File:Cell Tamper.png]]

The command with cog wheel in front is the default command, i.e. the command that will be executed by simply clicking the icon directly.

===Assign Script===
The script needs to be assigned to all Cell Stations that should have this behavior. This is done by simply rightclicking the Cell Station in the Operator device list, and selecting the script there. It is also possible to multiselect stations and assigning the same script to all.
[[File:Cell script assign.png|left|500px]]
<br style="clear:both;" />
[[File:Cell script assign2.png|left|500px]]
<br style="clear:both;" />

Script assignment can also be done from the Selected Object menu:
[[File:Cell script assign3.png|left|500px]]
<br style="clear:both;" />

==Video Script==
In the example there is one Video Tile added to the layout. This tile is defined as 1 in the layout configurator:
[[File:TileID1.png|left|500px]]
<br style="clear:both;" />

We can create a camera script and assign this to the cameras on our map:
[[File:CameraScript.png|left|500px]]
<br style="clear:both;" />

Add one script for each state, name these View and VideoOff:
{{Code|App.ViewCamera("%CAPTION", 1);}}

{{Code|App.ViewClose(1);}}

{{Note|the number 1 in the scripts relates to the tile ID}}

By rightclicking the camera icon on the map, the user can now chose to view the camera in the video tile, or close the view depending on the state it already has:
[[File:Video1.png|left]][[File:Video2.png]]
<br style="clear:both;" />

The cogwheel indicates the default command, and in this case we can simply toggle click the icon to switch video on off.

==Visitor Script==
In the example prison there is a visitor intercom solution.<br>
Two Intercoms, one in each room are paired together. They are both configured to call the other when the button is pressed. They can also be controlled from the VS Operator in the following way:<br>
First, they need to be configured to call each other in the ICX, triggered by DAK9. Both are set to the same UDP group, and both have the number of the other as their EXP:
[[File:Visitor1.png|left|500px]]
<br style="clear:both;" />

Second, we need an event that is triggered by DAK 9:
[[File:Visitor2.png|left|500px]]
<br style="clear:both;" />
{{Code2|
 $CALL L%1.dir L%1.exp
}}

In the VS Operator we create a script for the visitor intercoms. The script will simulate that DAK9 is pressed on either station:
[[File:Visitor3.png|left|]]
<br style="clear:both;" />

The script is executed when the operator selects the command Visitor Call by right clicking either Visitor icon:
[[File:Visitor4.png|left|]]
<br style="clear:both;" />

While the Visitor Intercoms are in conversation, the Operator can right click either icon and select to cancel the call, or to initiate recording if that option is used in the system:
[[File:Visitor5.png|left|]]
<br style="clear:both;" />

The above options are created in the Visitor script, under the ''Connected to other party'' state:
[[File:Visitor6.png|left|]]
<br style="clear:both;" />
{{Note|The Recording option requires that [[REC|Recording on demand]] is applied to the system}}

==Tamper Alarm==
Examples of tamper alarm from [[Tamper_switch|Vandal Station (TKIE) (I/O3)]] or [[Configuration of the VR3G-1 and VR3G-1P|VR3G (I/O4)]]. <br>
To make the tamper switch report an audiovisual alarm in the Operator we need an event in the ICX, which sends data to the VS Operator using the custom parameter.

This event is needed for [[Vandal Resistant intercom - VR3G-1|VR3G-1]] & [[Vandal Resistant intercom - VR3G-1P|VR3G-1P]] stations with the tamper switch connected to I/O4. The Vandal Resistant Substation ([[IPVRS-1]]) can also use tamper switch.
[[File:TamperEvent.png|left]]
<br style="clear:both;" />

{{Code2|
 @*D1 M7F01 L(1)%1.dir U0 W1 W0 W0 W7 W1
 @*D1 M7F01 L(1)101 U0 W9 W0 W0 W0 W0
}}

===Changing Icon===
The first line sends a custom parameter belonging to the cell station it is triggered on. It sets parameters 

*1=1
*4=7
*5=1

Parameter 4 and 5 will make the cell station enter Station State 7 (Active Custom 2). This makes the icon show the tamper alarm:

[[File:TamperState.png|left|]]
<br style="clear:both;" />

===Journal Entry===
To be able to write a custom text in the Operator Monitor Journal, we set a filter on the Cell stations. Since the event in the ICX is triggered by a cell station, it will carry the cell station directory number as a parameter, and we can filter on the cell station in VS Operator.<br>
Create a new station filter, name it Cells. Select '''Script''' for the ''On Custom Params'' option and enter this code:

{{Code|<nowiki>int ts = App.Params.Get("cp4",0);
int ts2 = App.Params.Get("cp5",0);

if ((ts == 7) && (ts2 == 1))
{
App.Log("<h4><font color='red'><b>-- TAMPERALARM --</b></font></h4>", LogLevel.Warning, true, true, true); 
App.Alert("-- TAMPERALARM --");
}</nowiki>}}

H4 = Level 4 Heading (text markup reference)

It should look like this:
[[File:TamperFilter.png|left]]
<br style="clear:both;" />

The result in the Journal when a tamper alarm is triggered will look like this:
[[File:TamperLog.png|left]]
<br style="clear:both;" />

===Play audio file===
To play an audiofile in the PC where the Operator Client is running, we use the second line in the event triggered by the tamper switch:

*@*D1 M7F01 L(1)'''101''' U0 W'''9''' W0 W0 W0 W0

This command is hardcoded with the operator directory number. In this example '''101'''.<br>
And the first parameter here is '''9'''.

Equally in the Operator we need a filter on the Operator Station (101) that catches the 9. So we create a station filter, add a script for ''On Custom Params'' and put in this code:
{{Code|<nowiki>int CP1=App.Params.Get("CP1", 0);
if(CP1 == 9)
{
App.PlaySoundLoop(@".\sounds\sirenwail.wav", false, 0);
App.Log("Audiofile played", true, true);
}
if(CP1 == 8)
{
App.StopSound();
}</nowiki>
}}

This is the result:
[[File:TamperAudio.png|left]]
<br style="clear:both;" />

===Acknowledge and Reset===
In this example we have chosen two actions to the Tamper Alarm:
[[File:TamperAlarm.png|left]]
<br style="clear:both;" />


Both of these are available when the Cell Station is in Tamper Alarm state. In the previously created CellScript we add two actions for State 7 ''Active Custom 2'':
[[File:TamperAck.png|left]]
<br style="clear:both;" />
Acknowledge (default action) will silence the audio file and write a text in the journal.

[[File:TamperReset.png|left]]
<br style="clear:both;" />
Reset will revert the station state back to normal by executing DAK99 for the Operator Station, and writes to the journal. 

DAK99 on the Operator Station will trigger an event in the ICX that sets the correct Icon Status in the Operator Client:
[[File:TamperEvent2.png|left|500px]]
<br style="clear:both;" />
{{Code2|
 @*D1 M7F01 L(1)%1.dir U0 W0 W0 W0 W7 W0
 @*D1 M7F01 L(1)%1.dir U0 W0 W0 W0 W1 W1
}}
The first line sets Station State 7 to off, and the second line sets Station State 1 to ON. Station State 1 is Active Custom 1 but it has the same look and behavior as Station State 0 which is the idle one.

== Silent Call ==
A silent call is a call made from the operator to a cell, where the conversation audio is in simplex and the direction is forced from the cell to the guard. There is also no connection tone or LED active in the cell.

To achieve this a couple of commands must be added to the Cell script:
[[File:SilentCallVSOP.png|left|500px]]
<br style="clear:both;" />
This is the command to use:
* App.STE("[[$CALL]] L%DIROP L%DIRA W256");

{{Note|The LED control from this command does not apply to [[VR3G-1]], [[VR3G-1P]] and [[IPVRS-1]]. <br> If this device is used a variable ([[WUDD]]) must be set to false when Silent Call is triggered.<br>This variable must then be checked in the Microphone Open event specific for that station type.<br> In addition the same variable must be set to true every time an [[Conversation Incoming (Event Type)|incoming call]] is ended for the cell station.<br> See the device specific configuration for [[Configuration_of_the_VR3G-1_and_VR3G-1P#Station_LED|VR3G-1]], [[Configuration_of_the_VR3G-1_and_VR3G-1P#Station_LED|VR3G-1P]] or [[Configuration_of_the_IP_Vandal_Resistant_Substation_TKIE#LED_Settings|IPVRS-1]].}}

[[Category: VS-Operator - Configuration examples]]