Home

FS-8700-83 Gamewell Serial Driver

1. When the Gamewell Panel is reset then the driver is able to clear the arrays The way that the panel works is that when a reset is performed send the following message Status NORMAL 08 31 95 16 23 System Idle After this message the panel then sends messages for all points that are not in a normal state The driver uses the parameter Clear_On_Reset to determine what gets cleared If a map descriptor has this parameter set to Yes then the arrays elements controlled by the Data_Array_Offset and the Length are set to zero This provides a good technique of synchronizing the panel and the FieldServer When you restart the FieldServer you should push the reset button on the panel so that the panel sends messages for all points that are not in a normal state If you don t do this and some points are in a not normal state then the FieldServer will not know about them until their state changes This is potentially dangerous 6 5 Action Types Typically messages from the panel are contain not only the status of a point but also describe the action that caused the state to change FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 13 of 24 Based on the table below if a message contains the string Fire Alarm in then the action number will be stored as 11
2. Value Action 255 System Setup 1 Skip System I O Assignments 2 Begin System I O Assignments 3 Programming Mode Entered 4 Exit Program Mode Control 5 Commencing System Reset 6 System Idle 7 System Acknowledged 8 Signals Deactivated 9 Signals Activated 10 Signals Silenced Automatically Fire Alarm 11 Fire Alarm in Supervisory 12 Supv Event in Generic 13 Genr Event in Security Alarm 14 Security Alarm in Pre Alarm 15 Ver Seq in 16 Pos Al Seq in 17 Pre Alarm in Fault 18 Alarm Tested in 19 AtoD Malfunction 20 LCD Malfunction 22 System In Walk Test 23 System Out Of Walk Test 24 System l Os By Passed 25 All By Passed I Os Cleared 26 1 0 Bypassed Description Driver did not recognize action type System power up System programming itself Ignore any data from this point until Exit Program Mode is received See Programming Mode Entered System reset button has been depressed System reset completed system is normal System Acknowledge button depressed System Signal Silence button depressed Audibles Silencing System Signal Silence button depressed Audibles reactivating System automatically silenced the audible signals Verification sequence started Positive Alarm Sequence started Pre alarm present Message during walk test System Problem System Problem Start partial or Full system walk test mode Finished system walk test mode Bypass system circuits or devices System not bypassed Starts ID of Cir
3. Supv 512 Genr 1024 Thus if a map descriptor has its Data_Type Any and two messages are received one an alarm and one an event then the value of the array element will be set to 1 4 5 Thus the value is non zero to report the not normal state but inspection of the value allows you to determine the specific stat The value s can be changed by using the method below to add but when you add use the existing name and a new value FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 12 of 24 When comparing these keywords to the data in the Status field of the message the driver only compares the first three characters The comparison is case insensitive Adding a New Status Type The fragment of a CSV file displayed below illustrates how to change the value associated with BUS to 9 and adds two new Status types Fred and Ginger Driver Table Gamewell Status String Gamewell Status Value Protocol BUS 7 9 Gamewell FRED 7 LOO Gamewell GINGE z WOT Gamewell There is a limitation in the use of new status types They can only be stored using map descriptors with the Data_Type set to Any The driver can store a maximum of 100 status types The maximum length of the string is 9 characters 6 4 When do Data Arrays get cleared Reset
4. 95 16 28 gt lt System Idle gt lt gt lt gt FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 23 of 24 3 Create a server side configuration 4 Create a script to test the server side configuration FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 24 of 24 8 Revision History 29May2002 Driver Version Document Revision Comment Initial Release Issued for review formatting Connection diagrams required 13Jun2002 No Changes 19July2002 Releasing 18Sep2002 Added Status SUPV support Message that begin this way are stored as Supervisories see section 6 3 Changes to 6 2 Reference to Supervisory Data Type Changes to 6 3 Reference to the value of a SUPV message 25Nov02 20Aug03 Changes to 6 3 Refrence to value of A GENR message Changes to 6 4 Commencing System Reset clears arrays too Changes to 6 5 Variations for action types 13 16 Releasing 6Sep03 Added 7 3 Notes on simulating a Gamewell Panel FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 4
5. a circuit number then it is assumed to be from the panel itself If a message contain a CKT number and no DEV number then the driver assumes the device number is zero The storage location is based on the device number it is used as an offset into the array Map Descriptors Map Descriptor Name Data Array Name Data Array Offset Function Node Name ckt Dev Length Data_Type Clear On Reset Panel data DA_STATUS 000 passive panell Panel O 100 Any Yes Ckt1_data01 DA_STATUS 200 passive panell re od aO 100 Any Yes Ckt2_data0l DA_STATUS 400 passive panell pee 710 4100 Any Yes Ckt3_data01 DA STATUS 600 passive panell ps 0 100 Any Yes The length determines the number of devices that can be processed using the map In this example all the These map descriptors You need one map descriptor Because the Data Type data for all these are all passive We descriptor for each is Any the driver will circuits is stored in one cannot poll the panel circuit panel Say a message for set an array element array but we can wait Ckt 2 Dev 20 is i non zero if any passively for the panel received The driver messages indicate that The offset is used to to send us messages looks at the device the point in not in a control the location in number and the length normal condition to see if the range of devices covers the incoming message I this case the data would be st
6. descriptors Bus Comm The Data Type determines the Control type of data that gets stored when a message get received Ack The Data Type corresponds to Signal Silence the Status field in a Gamewell Troubles message OR ss ae Supervisories Additional information is provided in section 6 2 Action Numbers Action_Bits Dump FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 7 of 24 Length Length of Map Descriptor Controls how many elements of the data array are controlled by the map descriptor 1 1000 Address This commonly used parameter has no meaning for this driver If specified it is best set to zero Ckt Specify the circuit number whose message will get stored using this map descriptor Use the keyword Panel if the you wish to store data from a panel All messages which do not contain the keyword Ck in the action field are deemed to be panel messages Valid panel numbers are 1 131 Panel 1 2 3 131 Dev The starting device number for the map descriptor The length determines how many devices can have their data stored using this map descriptor Valid circuit numbers are 1 126 but this driver allows a device number of zero to allow for the storage of messages which don t specify
7. out waiting for a 22 52 82 112 262 response to a supervision query 23 53 83 113 263 Number of times that a reset command was received 24 54 84 114 264 Number of times that a Ack command was received 25 55 85 115 265 Number of times that a Silence command was received Number of times that the slave received na unregonized 26 56 86 116 266 command Number of times that the slave received a command 27 57 87 117 267 message 28 58 88 118 268 Number of times that the slave received a message FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 22 of 24 7 3 Simulating a Gamewell Panel The driver provides support for QA procedures One of the ways that the driver provides this support is by allowing a configuration to send a list of Gamewell messages to the driver This allows a configuration developer or QA agent to test the effect of the messages on the driver does the driver store the correct data in the correct locations etc 1 Configure a client side MD as follows Map_Descriptors Map _Descriptor_Name Scan_interval Data_Array_Name Data_Array_Offset Function Node_Name Gamewell_Func 919sim ini 1 0s DA_AI 0 wrbc Node_1 Simulator The name of the file which contains the Tells the driver to Gamewell use the message file messages 2 Create the
8. simulation file This manual does not provide a list of possible messages Customer logs or Gamewell manuals may be used The following is an example Each lines consists of 4 text segments encapsulated in angle braces lt gt Gamewell messages consist of up to 4 lines of text Put each line of the message into a lt gt segment If the line begins with a sign then it is ignored Each time the MD becomes active after its scan interval the next line is read and sent There is no method of recycling or repeating lines For more examples of messages see the Word document attached to SPR2748 lt Status ALARM Istofl 08 31 95 16 25 gt lt Fire Alarm in Ckt 2 gt lt Fire Alarm Heat Detector gt lt I st Floor Room Number I gt lt Status FAULT 08 31 95 16 27 gt lt Aux AC Bad For Ckt 2 Dev 1 gt lt gt lt gt lt Status EVENT 08 31 95 16 26 gt lt Supv Event in Ckt 2 Dev 2 gt lt Sprinkler Tamper Switch gt lt I st Floor Room Number I gt lt Status BUS 08 31 95 16 24 gt lt Supv Event in Ckt 2 Dev 3 gt lt Sprinkler Tamper Switch gt lt 1st Floor Room Number 1 gt lt Status COMM 08 31 95 16 25 gt lt I O Restored Ckt 2 Dev 4 gt lt gt lt gt lt Status CONTROL 08 31 95 16 25 gt lt I O Restored Ckt 2 Dev 5 gt lt gt lt gt lt Status ACK 08 31 95 16 25 gt lt I O Restored Ckt 2 Dev 6 gt lt gt lt gt lt Status SIG SIL 08 31 95 16 25 gt lt I O Restored Ckt 2 Dev 7 gt lt gt lt gt lt Status NORMAL 08 31
9. 08 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com
10. Array_Name Provide name for Data Array Up to 15 alphanumeric characters Data_Format Provide data format Each data array can FLOAT BIT Ulnt16 SInt16 only take on one format Packed_Bit Byte Packed_Byte Swapped_Byte Data_Array_Length Number of Data Objects Must be larger 1 10 000 than the data storage area required for the data being placed in this array Example El Data Arrays Data_Arrays Data Array Name Data Format Data_Array Length DA AI OL UInt16 200 DA AO 01 Ue 200 DA DI Ol Bit 200 DA_DO 01 Bit 200 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell 4 2 Client Side Connections Page 4 of 24 Section Title Connections Column Title Function Legal Values Port Specify which port the device is P1 P8 R1 R2 connected to the Bridge Baud Specify baud rate 2400 The driver supports all standard baud rates 110 115200 Gamewell panels only support a baud rate of 2400 Parity Specify parity None The driver supports the following options Even Odd None Mark Space The Gamewell panels only support the use of no parity Data_Bits Specify data bits 8 Stop_Bits Specify stop bits 1 Protocol Specify protocol used Gamewell Handshaking Specify hardware handshaking None Po
11. Available for future use 2 32 62 92 242 Available for future use 3 33 63 93 243 Available for future use 4 34 64 94 244 Number of bytes sent by client driver 5 35 65 95 245 Number of messages sent by client 6 36 66 96 246 Number of reponse messages received by client 7 37 67 97 247 Number of response bytes received by client Number of times client has timeout out waiting for response 8 38 68 98 248 prompt Number of times client has timeout out waiting for response 9 39 69 99 249 prompt 10 40 70 100 250 Number of Supervision Messages Sent 11 41 71 101 251 Number of Supervision Messages Received 12 42 72 102 252 Number of Supervision Messages Responses Sent 13 43 73 103 253 Number of Supervision Messages Responses Received Number of Supervision Messages Received with a protocol 14 44 74 104 254 error Number of times that message containing status information 15 45 75 105 255 was found Number of times that message parsing failed because an 16 46 76 106 256 unrecognized status type was found Number of time that a message containing node information 17 47 77 107 257 was found Number of times that oarsing failed because 2 CR s were not 18 48 78 108 258 found Number of times that message parsing failed because an 19 49 79 109 259 unrecognized status type was found 20 50 80 110 260 Number of times that parsing completed Number of times that the client timed out waiting for a 21 51 81 111 261 message to be sent Number of times that the client timed
12. Data Array Offset Function node name ckt Length Data_Type Clear on Reset Ckt1128 datal2 DA ACTION128 000 passive panell r 128 r Aza Action_Numbers yes Using this data_Type the driver stores a value corresponding to the contents of the action field portion of the message sent by the panel A table in section 6 5 provides a list of values vs action descriptions FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 18 of 24 Example 3 Action Bits Instead of having the driver store a value to indicate the action the driver can set a bit whose offset indicates the underlying action For example if the string Fire Alarm in is contained in the action field of the message the driver would set the array element at offset 11 use table 6 5 to get the value vs string to 1 Important to note is that the driver does not clear a previously set bit when a new action is reported Thus if two messages were received and the first reported Fire Alarm in and the second reported Supv Event in then first the array element at offset 11 would be set to 1 and then element at offset 12 would be set The element at offset 11 would remain set Both would then remain set until a system reset is performed the state of the point returns to normal statu
13. FieldServer Technologies A Sierra Monitor Company Driver Manual Supplement to the FieldServer Instruction Manual FS 8700 83 Gamewell Serial Driver APPLICABILITY amp EFFECTIVITY Effective for all systems manufactured after May 1 2001 FS 8700 83 Gamewell Index 1 2 3 4 5 6 8 TABLE OF CONTENTS GAMEWELL SERIAL DRIVER DESCRIPTION c ccccceceeseeseee cece eeeeeseeeeeeeeeeeeseensseaneeseeeeeseesecaneeeeeeens 1 DRIVER SCOPE OF SYP PLY icccceiecevesisedtccccceseseaisecedicetenetaasscncecesieededasslaceceedcedeauvecaceceedetdeavasdeecuaeserdtas 1 2 1 SUPPLIED BY FIELDSERVER TECHNOLOGIES FOR THIS DRIVER ecccceceeeeeeeeceeceeeeeeeseceenaeeeeeeeeesensnaeees 1 2 2 PROVIDED BYUSER lt uiictciciiona diiniita di 1 HARDWARE CONNECTIONS cuiccoccccocirocccie necia sica il ietevevereetenctietertveressevcueaterress 2 CONFIGURING THE FIELDSERVER AS A GAMEWELL SERIAL DRIVER CLIENT c00 3 4 1 IDATA ARRAY Si tle ate arte ete ciate Oe eke e Lint abel ae el a tad 3 4 2 gt CUIENT SIDE CONNECTIONS iii A olaa de da ed 4 4 32 CENT SIDE N ODE S ee aearde A ee teat ansehen be eaves de teed 5 4 4 CIENT SIDE MAA DE CR TORS tl id Aita 6 FieldServer Related Map Descriptor ParaMeterS ccccccccecceceeeeceeeeecnneaecetecesesecsaeaeeeeeeneeetecsenineneees 6 Driver Related Map Descriptor ParaMeterS ooooononicocccinnnicinnconcononncnnccnnnnnn non cn nn nana rr c nn nn mnnnnnnnns 6 liming F
14. RED stat You can have the driver dump these messages to the error log or store the message in a data array by using the DATA_Type Dump If the data is stored in a data array then use a data array with a Byte format and display the array using the ruinet utility and view the array in String format If youhave the ignored messages dumped to the error log then use the RuiDebug utility to capture the error log Map Descriptor Name Data_Array Name Data_Array Offset Function node name Length Data Type Clear on Reset Store As Store Ignored Msg DA DUMP_ IGNORED 000 passive panell 1000 Dump No Ascii Store_As can be set to Ascii or AsciiLog When set to Ascii the message is save to a data rray When set to AsciiLog the ignored message is dumped to the error log FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 20 of 24 7 Driver Notes 7 1 IC_Timeout The connection IC_Timeout must be set to zero This is done in the CSV file by setting IC_Timeout parameter The following fragment from a CSV file illustrates how this is done Connections Port UTE a Darca Bits STOO Bits IC Wiimeouc RI 2400 None 8 reel z 0 7 2 Driver Stats In addition to the standard FieldServer communication statistics d
15. a device number Ty Clear_On_ Reset Yes No Store_As Only relevant when the Data_Type Dump This tells the driver to store ignored messages in ASCII format or to dump them_in ASCII format in the error log AsciiLog ASCII Value Gamewell_Func Only relevant when the function is write This parameter tell the driver what type of command to send to the panel You should always Ack before you silence the panel Reset Ack Silence Timing Parameters Column Title Function Legal Values Scan_ Interval Rate at which data is polled gt 0 1s FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 8 of 24 Map Descriptor Example 1 Store data from incoming messages This example illustrates typical map descriptor uses to store data from panel generated messaged As all these map descriptors have their Clear_On_Reset field set to yes when a panel reset message is received all the data in the controlled arrays will be set to zero When a point reports its own state as normal the driver will set the appropriate element of the appropriate array to zero to indicate the normal state Data is stored first by finding a map descriptor with the correct circuit number If the message doesn t contain
16. aran rS a A A ee A 7 Map Descriptor Example 1 Store data from incoming MESSages ococococcccccncccocanonancnnnnnccannnnnnnccnnnnnnns 8 Map Descriptor Example 2 Send a Reset Ack Silence Command cooooccocccccnnccococcconccncccnnannanccnnnnnnns 9 CONFIGURING THE FIELDSERVER AS A GAMEWELL SERIAL DRIVER SERVER 2 0 0 10 ADVANCED TOPICS coi Ai 10 6 1 DRIVER LIMITATIONS amp EXCLUSIONS sirien ari aeaaee ea eaa a ier aa aa eaa ae aa aA a ATAR A 10 G2 DATA TVPES nad Ads al is erT a Ea AA eas 10 6 3 STATUSTYPES AND VALUES airera Danen oat at Wises ae Gate aaa Aimee ar ae 11 Adding a New Status Tye cvicrieoieiai insid tre e aAa AAA aa iaaa ALA aE A ia ii aA 12 6 4 WHEN DO DATA ARRAYS GET CLEARED RESET cccceeeeeeecececeeeeesecacaeeeeeeeeeesecenaaeceeeeeeeseesenaneeeess 12 60 9 ACTION TYPES wives viet a tE cae IAE gael Gee E eecrs cdo 12 Adding New Action TYPOS isis titi dd ia Aia AAA Ah be 15 6 6 ADVANCED MAP DESCRIPTOR EXAMPLES 2 ececceceeeeeeeeeeeaeceeeeeeeseceaeaaeeeeeeeeesecsanaeseeeeeeeseesananeeeess 16 Example T Fiktermng Datars codi dt A aA a ER AD rat 16 Example 2 Action NOM D O S aa a a aa a a A a a aae a aa a a aaa eadi 17 EXamplei3 lt ACHON BUS e toas Eras la fen te es age Sete ad cad Sn eo Tenia sg aa aa a es rodas 18 Example 4 Ignored Messages cid ii hcg Sea gb ogden ea snes a ee Ena EEE aN EEEa 19 DRIVER NOTES a r r r rar aa ciated sete deieatvesvevsosetdageneeteeuesdet Gtagectentendartdie
17. communications with Node X Break or short in the primary class A cable Break or short in the secondary class A cable Master printer error 54 Communication Failure 55 Communication Restored 54 Communications Failure 55 Communications Restored 56 Primary Bus Error 57 Secondary Bus Error 58 Printer fault 59 Batt Charging OK 60 Batt Charging FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 15 of 24 Adding new Action Types The following fragment from a CSV file shows how you can add two new action types If a message is received and its action field contains the text FRED then the action number will be stored as 100 Driyer aloe Gamewell Action String Gamewell Action Value Protocol FRED 7 LOO Gamewell GINGER AQ Gamewell The driver can store a maximum of 100 action types The maximum length of the string is 49 characters FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell 6 6 Advanced Map Descriptor Examples Example 1 Filtering Data Page 16 of 24 You can direct the driver to filter the incoming messages so that data arrays are only updated for particular states F
18. cuit or point bypassed 27 Remote Annunciators Not Responding System Problem 28 Remote Annunciators OK 29 Key Stuck in 30 Display Missing for 31 Bad Card 32 Card Missing System Problem Restored System Problem System Problem System Problem System Problem FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell 33 New Card Detected 34 Out of Memory Assigning 35 I O Restored 36 Trouble Tested in 37 Trouble in 38 Output Shorted in 39 Dup Dev in 40 Dev Missing in 41 Type Mismatch 42 Dev Dirty in 43 No Response from Analog CKT 44 Open Short in CKT 45 I O Not Detected 46 Password Accepted 47 5V OK On 48 5V Bad On 49 Aux Supply OK For 50 Aux AC Bad For 51 Aux Batt Bad For 52 Aux Bad For 53 Unknown Event System Problem System Problem Supervisory or trouble in circuit that automatically restore themselves System Problem System Problem System Problem System Problem System Problem System Problem System Problem System Problem System Problem System Problem System Valid password entered System Problem System Problem System Problem System Problem System Problem System Problem System Problem Master lost communications with Node Master restored communications with Node X Master lost communications with Node Master restored
19. d by the Gamewell panel This definition is not strictly true because the driver is capable of sending the panel three messages Ack Silence and Reset Design Basis Gamewell serial port protocol specification IF 600r7 Message Stream not dated and SmartNet Data stream information not dated The driver is capable of exposing communication statistics in a FieldServer Data Array so that a remote device can monitor them 2 Driver Scope of Supply 2 1 Supplied by FieldServer Technologies for this driver FieldServer DESCRIPTION Technologies PART FS 8917 16 RS 485 RS 232 Pigtail for RJ45 port Driver Manual 2 2 Provided by user PART DESCRIPTION Gamewell Panel with SIM232 interface FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 2 of 24 3 Hardware Connections The bridge is connected to the Gamewell panel as shown below Configure the Gamewell panel according to manufacturer s instructions FIELDSERVER RS232 PORT GAMEWELL RJ45 01_ SIM 232 J FS 8915 10 BROWN BLUE WHITE RJ45 08 ORANGE WHITE e OO 408 262 2299 Technologies GAMEWELL CONNECTION DIAGRAM FILE NAME T28700 83 VSD BASE NAME DATE 6 4 02 BY MN Fi
20. e Client Side Nodes Nodes Node_ Name Node _ID Protocol Port Panell 0 Gamewell P8 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell 4 4 Client Side Map Descriptors FieldServer Related Map Descriptor Parameters Page 6 of 24 Column Title Function Legal Values Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters Data_Array_Name Name of Data Array where data is to be stored in the Bridge One of the Data Array names from Data Array section above Data_Array_Location Starting location in Data Array 0 to maximum specified in Data Array section above Function Function of Client Map Descriptor Reads rdbc rdb are not allowed The use of WRBX is recommended for the ack silence reset functions A message will be generated each time the value in the associated array is updated even if the value stays the same Passive WRBC WRBX Driver Related Map Descriptor Parameters Column Title Function Legal Values Node Name Name of Node to fetch data One of the node names from specified in Client Node Descriptor above Data_Type Data type Any Alarms This parameter is only required Faults for passive server map Events
21. e or the action in Gamewell terminology of the message When you specify the Data_Type as Action Numbers then the driver will store a value which can be used to look up the action that produced the message The most recent action number is stored over any older value The driver does not provide an event log 4 Instead of storing a value to indicate the action the driver can set a bit whose offset indicates the action For example action 30 will cause the 30 bit to be set Action bits are stored retentively This means that when a new action is reported the previous bits are left set and a new bit is set too 5 What happens if a message arrives that reports an alarm and you don t have a map descriptor with a Data_Type capable of storing an alarm You can make a catch all map descriptor and use the Dump Data_Type to tell the driver to store the whole message in ASCII format in a data array so that you can inspect it You can also use this map descriptor to tell the driver to dump the ignored message to the error log 6 3 Status Types and Values Generally the driver stores non zero values to indicate the state of a device circuit panel based on the status field of the incoming message The specific non zero value can be found in the following table The value have been chosen so that they correspond to different bits Status Value Stored Alarm 1 Fault 2 Event 4 Bus 8 Comm 16 Control 32 Ack 64 Sig Sil 128
22. e certain data arrays For example if you are only interested in storing data from messages that report an alarm then set the Data_Tupe of that map descriptor to Alarms If you don t care about the particular state then use the Data_Type of Any The driver will set the values of the array elements non zero if any not normal states are reported Data_Type Status Note Any 1 Alarms Status ALARM 2 Faults Status FAULT 2 Events Status EVENT 2 Bus Status BUS 2 Comm Status COMM 2 Control Status CONTROL 2 Ack Status ACK 2 Signal Silence Status SIG SIL 2 Troubles Status FAULT 2 Supervisories Status EVENT and Action contains Supv Event in 2 Action_Numbers 3 Action_Bits 4 Dump 5 Notes FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 11 of 24 1 If the Data Type is Any then the map descriptor will be used to store data from message with any status 2 The state reported is filtered and must match the Data_Type for the associated array to be updated For example if the Data_Type of a MapDesc is Alarms and a message is received that reports a Fault then the map descriptor will not be used to store the data from the message 3 Normally user s are interested in the Status of a device circuit panel but they may also be interested in the caus
23. e the remote device send a value to the 1 element of the above data arrays FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 10 of 24 5 Configuring the FieldServer as a Gamewell Serial Driver Server The Gamewell Serial Driver provides limited server functionality This has been developed to allows for automated testing and Quality Assurance It is not supported or documented however at a client s request it can be extended amp documented typically at an additional cost 6 Advanced Topics 6 1 Driver Limitations Exclusions The driver does not support scaling when data is stored in a data array The keywords Data_Array_Low_Scale Data_Array_High_Scale Device_Low_Scale Device_High_Scale have no meaning for this driver The reason for this is that the values stored by the driver have specific meanings based on parsing the message Scaling is only applicable in drivers which read and write values from the remote device 6 2 Data Types Messages contain Status and Action information The status information indicated the state of a device circuit panel The action information describe the event that generated the message By specifying one of the following Data_Types you can filter the incoming messages so that on certain types of messages updat
24. eldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 3 of 24 4 Configuring the FieldServer as a Gamewell Serial Driver Client For a detailed discussion on FieldServer configuration please refer to the FieldServer Configuration Manual The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer See csv files on the driver diskette This section documents and describes the parameters necessary for configuring the FieldServer to communicate with a Gamewell Serial Driver Server The configuration file tells the FieldServer about its interfaces and the routing of data required In order to enable the FieldServer for Gamewell Serial Driver communications the driver independent FieldServer buffers need to be declared in the Data Arrays section the destination device addresses need to be declared in the Client Side Nodes section and the data required from the servers needs to be mapped in the Client Side Map Descriptors section Details on how to do this can be found below Note that in the tables indicates an optional parameter with the bold legal value being the default 4 1 Data Arrays Section Title Data_Arrays Column Title Function Legal Values Data_
25. escribed in the FieldServer User s Manual the Gamewell Serial Driver can also expose some driver statistics by writing data to a data array A special map descriptor is required The driver recognizes the map descriptor by its name which must be Gamewell stats The following example shows how this special map descriptor can be configured You can copy this section of text directly into your CSV file Nodes Node_name Node_ID Protocol dummy_node 0 Gamewell Data _ Arrays Data Array Name Data Format Data Array Length DA GAMEWELL STATS uint16 500 Map Descriptors Map Descriptor_Name Data Array Name Data Array Offset Function node_name Gamewell Stats DA GAMEWELL STATS 0 passive dummy_node When the driver sees this map descriptor it uses the data array DA_GAMEWELL_STATS in this example to store driver specific statistics Only one of these map descriptors may be specified per FieldServer The offset into the array is based on the port number 30 arrays locations are used per port The offset is obtained by multiplying the port number by 30 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 21 of 24 The driver stores the following data PORT Description 0 1 2 Ss 8 Array Offset 0 30 60 90 240 Available for future use 1 31 61 91 241
26. he driver will only update the associated data arrays when the messages report a state that matches the data type Data_Type Any Alarms Faults Events Bus Comm Control Ack Signal Silence Troubles Clear_on_Reset Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 17 of 24 Example 2 Action Numbers You can have the driver store a value corresponding to the contents of the action field reported in the incoming messages Actions are brief descriptions of the event that caused the message to be generated A table of values vs descriptions is provided in section 6 5 The driver stores the most recent action number overwriting the previously stored action numbers The driver does not keep an event log The action number s are set to zero if the clear_on_reset is set to yes and a system reset message is received For example if the string Fire Alarm in is contained in the action field of the message the driver would store an action value of 11 This map descriptor can be used as well as the any of the map descriptors shown in previous examples Thus you can have one or more map descrriptor storing the state and one storing the action number Map Descriptors Map Descriptor Name Data_Array Name
27. ll_Delay Time between internal polls 0 32000 seconds default 1 second IC_Timeout This driver does not use an inter 0 character timeout system Failing to set the IC_Timeout to zero will result in driver errors Example _ Client Side Connections Connections Port Baud Parity Protocol Handshaking Poll_Delay IC_Timeout P8 9600 None Gamewell None 0 100s 0 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 5 of 24 4 3 Client Side Nodes Section Title Nodes Column Title Function Legal Values Node_Name Provide name for node Up to 32 alphanumeric characters Node_ID Gamewell panel node address 0 256 The Node Id has no meaning when the FieldServer is connected directly to Gamewell panel When connecting to a Gamewell panel directly always set the Node_ID to zero When connecting to a Gamewell SmartNet terminal The Node_ID is important and should correspond to the Node_ID s of the panel s connected to the SmartNet terminal Protocol Specify protocol used Gamewell Port Specify which port the device is P1 P8 R1 R2 connected to the FieldServer The use of R1 and R2 is only appropriate when a 232 485 converter is used The Gamewell panels only have a 232 port available for connection Exampl
28. or example an incoming messge which reports a device in Ckt 1 to be in a FAULT state Status FAULT will use the map descriptor Ckt1_data03 to store the data and the array DA_FAULTS1 will be updated If however the message reported an ALARM state Status ALARM then the array DA_ALRMS1 would have been updated In fact because the examples below provide a map descriptor where the data type is Any each incoming message would update two data arrays The DA_Status1 array would be updated by every single message and the other arrays would be updated depending on the state being reported in the message Map Descriptors Map Descriptor Name Ckt kt kt kt kt kt kt kt kt kt aaaaaanaaaa a _a a _a ee _a Al a _a _a ata0l ata02 ata03 ata04 ata05 ata06 ata07 ata08 ata09 atal0 monitoring DA_STA DA AlA DA_FAU TUS RMS LTS DA_EVENTS DA BUS DA COM DA CON DA ACK DA SIG DA TRO 1 M1 TRO 1 SIL UBL Data_Array_Name L1 ES1 You would need another set of these map descriptors for any other circuit you are Data_Array Offset 000 000 000 000 000 000 000 000 000 000 passive passive passive passive passive passive passive passive passive passive Function r r r node_ name panel panel panel panel panel panel panel panel panel panel ckt sy using specific data types t
29. ored at offset 20 in the map descriptor the array FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 9 of 24 Map Descriptor Example 2 Send a Reset Ack Silence Command This example illustrates three map descriptors used to send commands to the panel These are the only active map descriptors that can be used with the Gamewell Serial Driver These map descriptors use the WRBX function When the 1 element because Data_Array_Offset O has its value updated even if the value doesn t change then the driver will send the command to the panel Note that you are required to send an Ack before you can send a silence command The driver does not clear the trigger by setting the array element back to zero The panel does not send a message acknowledging receipt of the command thus the driver cannot provide positive confirmation Map Descriptors Map Descriptor Name Data Array Name Data Array Offset Length Function Node Name Gamewell Func Ack_md DA_ACK O pol wrbx panell Ack Sil_md DA_SILENCE 7 10 quod wrbx panell Silence Res_ md DA_RESET 0 pod wrbx panell Reset Use one of these keywords By using a wrbx you can have the driver send the command when the array is updated Thus to trigger any of these commands hav
30. s NORMAL or you clear the bits by writing to the array from the remote device As the driver may use up to 100 consecutive array locations for each Ckt Device pair if you use this method of storing data you will need one map descriptor for each Ckt Device pair In this example the map descriptor will store data for Ckt 128 device 10 only This is indicated by the Ckt number being set to 128 the device number being set to 10 and the length being set to 1 If the driver doesn t recognize the action type then it will set the array element at offset zero Map_Descriptors Map Descriptor Name Data Array Name Data Array Offset Function Node Name Ckt Dev Length Data Type Clear On Reset Ckt1128 datal2 DA_ACTION BITS 000 passive panell r 128 10 k Action Bits yes Only one device per map descriptor Ensure that at 100 elements of data array are available for each map descriptor 100 is the maximum action number FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 19 of 24 Example 4 Ignored Messages When messages are received that the driver cannot find a map descriptor to use to store the data from the message say a message from a device on circuit 127 is received but there are no map descriptors for circuit 127 then the driver produces a MSG_IGNO
31. vertens 20 PW 2 SIGE TIME OWT 22 c24 sa tcctetaatecuaths E hg Ache E za coe haa T 20 7 2 DRIVER STATS 24200 RAR tii A dante Aaaa 20 REVISION HISTORY 2 cc c eceeceeeeeeeeeeeeeeeeeeeeeeseneeeeneeseeeeeeens ERROR BOOKMARK NOT DEFINED FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 83 Gamewell Page 1 of 24 1 Gamewell Serial Driver Description The Gamewell Serial Driver allows the FieldServer to accept messages generated by a Gamewell 600 Series Panel as well as Smartnet Data Stream messages generated by a Gamewell Smartnet terminal All Gamewell 600 Series Fire Alarm panels are equipped with a serial port which produces panel circuit or device status messages This driver is designed to process these messages and store this status information in numeric form The numeric value will indicate the type of event being reported and the storage location in the FieldServer s data arrays is configurable amp dependent on the origin of the message panel circuit device Additional information such as event date and time and descriptions are ignored The driver is capable of supporting a panel configured to supervise the port by responding to the panel s supervision queries This is a passive client driver The driver listens passively for unsolicited messages produce

FS-8700-83 Gamewell Serial Driver

Contents

Download Pdf Manuals

Related Search

Related Contents