User Guide

ManualsBrandsFieldServer ManualsOtherFS-8700-83

A Sierra Monitor Company

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after May 1, 2001

Driver Manual

(Supplement to the FieldServer Instruction

Manual)

FS-8700-83 Gamewell Serial Driver

Summary of content (24 pages)

PAGE 1
A Sierra Monitor Company Driver Manual (Supplement to the FieldServer Instruction Manual) FS-8700-83 Gamewell Serial Driver APPLICABILITY & EFFECTIVITY Effective for all systems manufactured after May 1, 2001
PAGE 2
FS-8700-83 Gamewell Index TABLE OF CONTENTS 1. GAMEWELL SERIAL DRIVER DESCRIPTION ................................................................................... 1 2. DRIVER SCOPE OF SUPPLY .............................................................................................................. 1 2.1 2.2 SUPPLIED BY FIELDSERVER TECHNOLOGIES FOR THIS DRIVER ............................................................ 1 PROVIDED BY USER ..........................................................
PAGE 3
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.
PAGE 4
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 SIM 232 BOARD FS-Rx RJ45-01 BROWN XMT FS-Tx FS-COM FS-8915-10 COM RCV COM2 GND RJ45-04 BLUE/WHITE RJ45-08 ORANGE/WHITE (408)-262-2299 GAMEWELL CONNECTION DIAGRAM BASE NAME: FILE NAME: T28700-83 .
PAGE 5
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).
PAGE 6
FS-8700-83 Gamewell Page 4 of 24 4.2 Client Side Connections Section Title Connections Column Title Port Baud Function Specify which port the device is connected to the Bridge Specify baud rate Parity* The driver supports all standard baud rates 110 – 115200. Gamewell panels only support a baud rate of 2400. Specify parity Legal Values P1-P8, R1-R2 2400 None The driver supports the following options.
PAGE 7
FS-8700-83 Gamewell Page 5 of 24 4.3 Client Side Nodes Section Title Nodes Column Title Node_Name Function Provide name for node Node_ID Gamewell panel node address. Legal Values Up to 32 alphanumeric characters 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.
PAGE 8
FS-8700-83 Gamewell Page 6 of 24 4.4 Client Side Map Descriptors FieldServer Related Map Descriptor Parameters Column Title Map_Descriptor_Name Function Name of this Map Descriptor Data_Array_Name Name of Data Array where data is to be stored in the Bridge Starting location in Data Array Data_Array_Location Function Function of Client Map Descriptor.
PAGE 9
FS-8700-83 Gamewell Length Address Ckt Page 7 of 24 Length of Map Descriptor Controls how many elements of the data array are controlled by the map descriptor. This commonly used parameter has no meaning for this driver. If specified it is best set to zero. Specify the circuit number whose message will get stored using this map descriptor. 1 – 1000 0 Panel , 1 ,2 , 3 …. 131 Use the keyword ‘Panel’ if the you wish to store data from a panel.
PAGE 10
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.
PAGE 11
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 1st element (because doesn’t change, then the driver will send the command to the panel.
PAGE 12
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 & 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.
PAGE 13
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.
PAGE 14
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.
PAGE 15
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.
PAGE 16
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.
PAGE 17
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. Driver_Table Gamewell_Action_String, Gamewell_Action_Value, Protocol FRED , 100 , Gamewell GINGER , 101 , Gamewell The driver can store a maximum of 100 action types. The maximum length of the string is 49 characters.
PAGE 18
FS-8700-83 Gamewell Page 16 of 24 6.6 Advanced Map Descriptor Examples Example 1 : Filtering Data You can direct the driver to filter the incoming messages so that data arrays are only updated for particular states. For 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.
PAGE 19
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.
PAGE 20
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.
PAGE 21
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_IGNORED 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’.
PAGE 22
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, Baud, Parity, Data_Bits, Stop_Bits, IC_Timeout P1, 2400, None , 8 , 1 , 0 7.
PAGE 23
FS-8700-83 Gamewell Page 21 of 24 The driver stores the following data.
PAGE 24
FS-8700-83 Gamewell Page 22 of 24 8. Revision History 29May2002 Driver Version 1.00 Document Revision 0 13Jun2002 19July2002 18Sep2002 1.00 1.00 1.01 1 2 0 Date 25Nov02 1.02 0 20Aug03 1.02 1 Resp Comment Initial Release. Issued for review, formatting. Connection diagrams required. No Changes Releasing Added Status:SUPV support. Message that begin this way are stored as Supervisories (see section 6.3). JD Changes to 6.2 Reference to Supervisory Data Type Changes to 6.