CSID Zone Triggers

This Help File Page was issued on 09/30/2017

<< Click to Display Table of Contents >>

Navigation:  Central Station Monitoring > Edit View - Monitoring Tab - An Overview > Subscriber Panels - Panels Info Tab > CSID Zones >

CSID Zone Triggers

This Help File Page was issued on 09/30/2017

Under Development

 

 

SPA can be configured to send commands to peripheral equipment when a specific Alarm Signal (i.e., Signal ID and Physical Zone) is received from a predefined CSID.  

This peripheral equipment can include (but is not limited to) PTZ (i.e., Pan, Tilt, Zone) cameras, video switching gear, door locks, and other types of security related equipment.

Currently, only Serial Communication Ports are supported, but other connectivity may be implemented in the future.

 

This process is called Zone Triggering.

Configuration for Zone Triggers is accomplished in MKMS.

 

Zone Triggers - By default, the ZoneTriggers option is set to False ("F") in the Company Settings Form.

To activate this CSID Zone Triggers functionality, set the ZoneTriggers option to True ("T") and restart MKMS.  

 

HelpFilesCompanySettingsZoneTriggers

 

 

If your company settings are correct, you should see the TV Camera icon on the Stark Shortcuts|General tab

Click it to pop up the Zone Trigger Equipment Assignment form:

 

 

When the Zone Triggers ("ZoneTriggers") option is set to True ("T"), it will add a Zone Triggers Eqp Icon to the Shortcuts Tab, and a Zone Triggers sub-tab to the CSID Zones Form.

When a Zone Trigger is defined, it will use the identified CSID, Zone, and Alarm Condition Code combination to cause command strings to be transmitted to the Control Panel which can control various peripheral devices (e.g., cameras, recorders, doors).

 

HelpFilesZoneTriggerEqpIcon

 

You will use this form to assign subscribers to Zone Trigger (ZT) equipment that will activate when certain alarms are detected by SPA for that subscriber.

 

HelpFilesZoneTriggerEqpAssignment

 

You must assign all of the subscribers that will be using Zone Triggers before you can begin assigning Zones and Trigger commands.

There are 3 grids on the Zone Trigger Equipment form.  

The top grid shows a list of every subscriber in the database. This grid is not editable.

The middle grid shows a list of all available Zone Trigger Equipment and their communication settings.  You can add/delete/edit all items in this grid but please note that this updates all Zone Trigger equipment settings in real-time. Changes to a live system should be done with great care!

The bottom grid shows the Subscribers associated with the currently highlighted Zone Trigger Hardware item.  In the example above, the Pelco Snozbot 1100 is highlighted.  You can delete subscribers from this grid to disassociate them from the Zone Trigger (ZT) hardware.

 

You add subscribers by dragging subscriber records from the top grid and dropping them on the desired ZT Hardware grid record.

All of the grids support Printing and Export to Excel and PDF.  Right click on a grid cell (not a column header) to view a list of Print/Export options. Click one of the popup menu items to select that item.

 

Exploring the All Zone Trigger Hardware Grid

The Make, Model and SN columns should be self-explanatory.  

You must list every equipment item you wish to control with SPA.  

These columns are simply used to differentiate between similar types of equipment.

You can enter anything that helps you keep track of your devices.

 

All Zone Triggers Hardware columns:

a)IP/Port identifies the physical connection that SPA will use to communicate with this specific equipment item.  Currently only Serial Ports are implemented, so enter the COMM port number you are going to use.

b)Ping Interval sets the number of seconds between SPA sending supervision queries to the equipment item.

c)Ping String is the ASCII command string to send to the equipment item.  This string should cause the device to return a known reply.  You should not put any commands into this field that cause the device to change modes, move cameras, Etc.

d)Ping Response String is the expected response from the equipment item when it "hears" our Ping String. The response string is case-sensitive.

e)Max Ping Loss is the maximum number of missed-ping-responses before SPA raises an equipment malfunction alarm.

f)Baud is the data rate to use to communicate with the device.  It must match the current setting of the device.

g)Bits is the number of data bits to use to communicate with the device.  It must match the current setting of the device.

h)Parity is the type of data communications error checking to use.  It must match the current setting of the device.

i)Stop Bits is the number of zero-bits to send after each Serial COMM character to indicate it has been fully sent.  It must match the current setting of the device.

j)Ping Loss Alarm Code is the code that SPA will push on to the Alarm Stack in the event of ping supervision failure.

k)Do Ping? is a Check box which activates/deactivates Zone Trigger device supervision.

l)Last Ping shows the time and date of the last ping for the device.

 

Adding Subscribers to a Zone Trigger Device

Use grid sorting and filtering to limit the list of Subscribers as required.

Sort by clicking on column headers.  

Hold down the Shift key if you wish to select multiple columns for sorting.

 

You can create simple filters by clicking the "funnel" on the column header.  

This will pop up a checklist box. Check or un-check one or more check boxes to limit the number of rows that the grid will show.

Click the funnel icon in the grid navigator to create more sophisticated filters. Using the funnel icon on the grid navigator allows you to create and save filters to your hard disk for future re-use.

 

Use the standard Windows Shift-Left-Click and Control-Left-Click to select multiple subscribers in the top grid.  

Once you have a group selected, you can drag and drop the mass-selection of Subscriber records on to the desired equipment record in the middle grid.

 

Use the minus (-) key to delete unwanted Subscribers in the bottom grid from a given piece of equipment.

If there is more than one ZT device, then you must select the device from which Subscribers are to be removed.

 

After assigning subscribers to ZT devices then you must configure zones to send commands to the ZT Device.

 

Configuring Zones and Triggers

Open the Subscriber Form and Retrieve a Subscriber to which you previously assigned to a ZT equipment item.

Click the Edit View button

Click the Monitoring tab

Select the appropriate CSID for this Subscriber in the Subscriber Panels section.

 

HelpFilesCSIDZoneTriggers-EditViewImage

CSID Zone Triggers - Edit View Image

 

Navigate to the CSID Zone tab and select an existing Zone record, or add a new one.  

You will need to edit or create a zone for each alarm-related command that you wish to send to the ZT equipment.

 

While a given Zone can be programmed to send multiple ZT commands, those commands will be sent as a block when a specific alarm signal comes in.

If you need more control than that, then you need to create more Zones – even if they are simply placeholders.

If for example you want to send a ZT command on Restoral, then you need to add a Zone for that.

 

The screen shot below shows how to set up a zone for the R140 Signal ID on CSID 8082.  

Observe that both the Alarm and OCTAR codes must be filled in.

 

HelpFilesCSIDZoneTriggers-CSIDZonesTab-ZonesSubTab

CSID Zone Triggers - Zone entry

 

a)Each Zone needs a Signal ID.  

This Signal ID will be used to look up the correct command to send.

b)Each Zone needs a Physical Zone.  

The PZ will be used to look up the correct command to send

c)Fill in the Alarm Code and OCTAR as required

d)Fill in the Description as desired.

You may want to add a note as to what this zone trigger will do, especially if this is a ZT "placeholder" zone.

 

Once you have configured all the zones for this CSID then navigate to the Zone Triggers tab.

Here is an example Alarm Signal and Restoral action commands to send on a single zone.

If an E140 signal comes in on CSID 8082, Zone 001, then send "I am being burgled![CR][LF]" to the Pelco Snozbot 1100, S/N 1234.

 

HelpFilesCSIDZoneTriggers-CSIDZonesTab-ZoneTriggersSubTab

CSID Zone Triggers - Zone Triggers Alarm entry

 

Here is the command we will send in the event of an R140 on CSID 8082, Zone 001 Restoral signal:

 

HelpFilesCSIDZoneTriggers-CSIDZonesTab-ZoneTriggersSubTab-Restoral

CSID Zone Triggers - Zone Triggers Restoral entry

 

Note : The Alarm Code must be manually filled in with a code that matches Alarm Code set on the Zones tab.  This may be changed in a future release.

 

Adding and Modifying Zone Trigger Commands

You cannot add new zones to the top grid of the Zone Triggers sub-tab.  

However, you can edit the Description and select a different Zone Equip device.

The other fields are not editable.

 

To begin the editing process, click the Edit Icon p found at the bottom left side of the grid.  

When editing is complete, click the Post Icon ü found at the bottom left side of the grid.

Cancel un-posted edits using the Cancel Icon HelpFilesNavigatorMenu-StandardCancelfound at the bottom left side of the grid.

 

HelpFilesCSIDZoneTriggers-CSIDZonesTab-ZoneTriggersSubTab-CommandsGrid

 

You can add as many commands for a given [CSID + Signal Identifier + Physical Zone] combination as you like.  

Simply add new lines to the bottom grid (shown above).  

Use the bottom grid navigator to make changes to the grid contents.

 

a)Alarm Code - Use the Drop-Down Selection List provided to Choose the appropriate Alarm Condition Code.

b)Send Delay - The Send Delay value identifies the number of milliseconds SPA will wait between commands.

i.If for example, you need to pan a camera and then switch your monitor screen to a specific video channel, then you may wish to delay the execution of commands that come after the pan.

ii.The pan action may take a few seconds to move to the desired camera angle.  

iii.You can time the video to switch when the camera's position is stable.

c)Send Order - You can force the order of execution multiple commands by entering a Send Order number.

i.Low numbers are sent first.

ii.When this Zone Trigger fires, SPA will step through the list of commands in Send Order and transmit them to the device.

iii.Sort the bottom grid by Send Order to avoid confusion.

iv.If you enter the same Sort Order more than once, then the same-numbered commands will execute in random order, which is not a good thing

d)Command to Send - The Command to Send entry may also use the standard MKMS control character macros, such as [CR], [LF].  See the "Command Characters Appendix" list at the end of this chapter.

 

Configuring SPA

Make sure that SPA has the Trigger Zone Hdw field Checked.

HelpFilesSPA-Setup-ShowTriggerHdw

 

Insure the machine running SPA has actual COMM Port hardware, or has functional Device Master drivers installed and configured.

It is recommended that you use an RS-232 breakout box to snoop on command transmissions between SPA and the Zone Trigger Hardware during setup.  

After setup is complete you can remove the breakout box. Later the breakout box will be useful for troubleshooting.

Alternatively, you can connect PuTTY to the RS-232/RS-422 COMM port and monitor Zone Trigger command transmissions, but without a breakout box you won't be able to tell if the Zone Trigger Equipment is correctly receiving and interpreting the commands.

 

Logging - Here are some typical log entries when the correct alarm signal is detected in a Zone Trigger zone:

a)An E140 signal comes in from CSID 8082, Zone 001:

R 09/12/2017 09:39:42 IP.18:2025 [LF]11 8082 18 E140 00 C001 [CR]

T 09/12/2017 09:39:42 IP.18:2025 [ACK]

P 09/12/2017 09:39:42 EM(), PS(******************), AS(IS=[LF]11 8082 18 E140 00 C001 [CR], RN=1, LN=1, AN=8082, A=1, CSID=8082, SI=E140, PZ=001, HD=, OD=, CID=, UN=, DT=9/12/2017 9:39:42 AM, AC=B, OCTAR=A, ID=0, SN='1 ON 1 AUTOMOTIVE', SID=24576, OnTest=F, OffLine=F, VSignal=T, VSubs=T, OldSub=F, EvntId=0, EvntEx=, ForceVerify=F, CZS=1107292, CZP=Null, PZS=Null, PZP=Null, ActiveS=T, ActiveA=T, OCSup=F, VideoFile=, VPL={ACCOUNT}, NewArea=F, 2WayVoice=, HID.HIDSystemID=0, HID.HIDExtentionID=0, HID.DoorID=0, HID.CardID=0, HID.Data=, RedirectCount=0, SignalExempt=F, ZoneName=, GeoInfo=0,0,0, DataOnly=F,, AutomatedUsers='',, AlarmQueueID=0) - Completed. AlarmStackID = 20490989 (Per:62), Task Step - ******************

SPA sees that this is a ZT zone so it loads the designated command

S 09/12/2017 09:39:42 Pelco Snozbot 1100 SN:1234 ZoneTrigger Cmd: I am being burgled! Help![CR][LF]

SPA sends the command to the Snozbot on COMM 13, 4800 Baud, 8 bits, no parity, 1 Stop bit

S 09/12/2017 09:39:42 ZoneTrigger Async: 13,4800,8,0,1,1

SPA took 63 milliseconds to send the command

S 09/12/2017 09:39:42 ZoneTrigger Time to send: 63

SPA closes the COMM port after the ZT command send

S 09/12/2017 09:39:42 ZoneTrigger closing comm port

b)An R140 Signal comes in from CSID 8082, Zone 001:

R 09/12/2017 09:39:49 IP.18:2025 [LF]11 8082 18 R140 00 C001 [CR]

T 09/12/2017 09:39:49 IP.18:2025 [ACK]

P 09/12/2017 09:39:49 EM(), PS(************), AS(IS=[LF]11 8082 18 R140 00 C001 [CR], RN=1, LN=1, AN=8082, A=1, CSID=8082, SI=R140, PZ=001, HD=, OD=, CID=, UN=, DT=9/12/2017 9:39:49 AM, AC=O, OCTAR=A, ID=0, SN='1 ON 1 AUTOMOTIVE', SID=24576, OnTest=F, OffLine=F, VSignal=T, VSubs=T, OldSub=F, EvntId=0, EvntEx=, ForceVerify=F, CZS=1107295, CZP=Null, PZS=Null, PZP=Null, ActiveS=F, ActiveA=F, OCSup=F, VideoFile=, VPL={ACCOUNT}, NewArea=F, 2WayVoice=, HID.HIDSystemID=0, HID.HIDExtentionID=0, HID.DoorID=0, HID.CardID=0, HID.Data=, RedirectCount=0, SignalExempt=F, ZoneName=, GeoInfo=0,0,0, DataOnly=F,, AutomatedUsers='',, AlarmQueueID=0) - Completed. AlarmStackID = 20490990 (Per:31), Task Step - ************

SPA sees that this is a ZT zone so it loads the designated command

S 09/12/2017 09:39:49 Pelco Snozbot 1100 SN:1234 ZoneTrigger Cmd: The dogs ate the burglars[CR][LF]

SPA sends the command to the Snozbot on COMM 13, 4800 Baud, 8 bits, no parity, 1 Stop bit

S 09/12/2017 09:39:49 ZoneTrigger Async: 13,4800,8,0,1,0

SPA took 62 milliseconds to send the command

S 09/12/2017 09:39:49 ZoneTrigger Time to send: 62

SPA closes the COMM port after the ZT command send

S 09/12/2017 09:39:49 ZoneTrigger closing comm port

Command Characters Appendix

Command Macros are used to send special characters to ZT devices.

Enter the "[xxx]" string into the command as needed.  

SPA will translate the macro in to the corresponding single byte character found in the Char column.

Characters in the chart below are shown in hexadecimal.

 

Command Macro

Hex Char

[0]

0x0

[SOH]

0x1

[STX]

0x2

[ETX]

0x3

[EOT]

0x4

[ENQ]

0x5

[ACK]

0x6

[BEL]

0x7

[BS]

0x8

[TAB]

0x9

[LF]

0xA

[VT]

0xB

[FF]

0xC

[CR]

0xD

[SO]

0xE

[SI]

0xF

[DLE]

0x10

[DC1]

0x11

[DC2]

0x12

[DC3]

0x13

[DC4]

0x14

[NAK]

0x15

[SYN]

0x16

[ETB]

0x17

[CAN]

0x18

[EM]

0x19

[SUB]

0x1A

[ESC]

0x1B

[FS]

0x1C

[GS]

0x1D

[RS]

0x1E

[US]

0x1F