Summary of the content on the page No. 1
-
A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-132 Gamewell FCI E3 Series Serial
Driver
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after September 2008
Driver Version: 1.01
Document Revision: 4
Summary of the content on the page No. 2
FS-8700-132 Gamewell FCI-E3 Driver Manual Table of Contents TABLE OF CONTENTS 1. Gamewell FCI-E3 Series Serial Driver Description...................................................... 3 2. Driver Scope of Supply ................................................................................................. 4 2.1. Supplied by FieldServer Technologies for this driver.................................................. 4 rd 2.2. Provided by the Supplier of 3 Party Equipment ...........
Summary of the content on the page No. 3
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 3 of 20 1. Gamewell FCI-E3 Series Serial Driver Description The Gamewell FCI-E3 Series System Control Units are manufactured by Fire Control Instruments. An E3 Panel with an enabled serial port can transmit data to a FieldServer which can, in turn, make the data available to other devices including those which communicate using different protocols (e.g. BACnet) This passive Client driver does not poll for data, nor does it send data
Summary of the content on the page No. 4
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 4 of 20 2. Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies Description PART # FS-8917-16 Pigtail cable for RJ45 Port for RS-232 use FS-8700-132 Driver Manual. rd 2.2. Provided by the Supplier of 3 Party Equipment rd 2.2.1. Required 3 Party Hardware ILI-MB-E3 Board FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (40
Summary of the content on the page No. 5
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 5 of 20 3. Hardware Connections The FieldServer is connected to the FCI-E3 panel as shown in the connection drawing. Part of FCI-E3 Panel ILI-MB-E3 Board 1 2 3 4 TB6 Blue/white Orange/White Brown FieldServer Part # FS-8917-16 Pigtail for RJ45 Port Connect to one of the RS-232 Ports on the FieldServer RJ45 8 1 P1 FieldServer Connector Pinouts RJ-45 FCI-E3 Wire Color Pin Signal Signal Pin Brown 1 Rx +ve 2 White/Orange 8 Tx -v
Summary of the content on the page No. 6
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 6 of 20 4. Configuring the FieldServer as a Gamewell FCI-E3 Series 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” sample files provided with the FieldServer). This section documents and describes the
Summary of the content on the page No. 7
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 7 of 20 4.2. Client Side Connection Descriptions Section Title Connections Column Title Function Legal Values 1 Port Specify which port the device is connected to the FieldServer P1-P8 Protocol Specify protocol used FCI_E3 Specify baud rate Vendor documentation indicated that the only supported Baud 9600, 57600 Baud* rate was 9600. During testing we learned this was not true. The (Vendor driver was tested at 57600 and 9600 baud. Tes
Summary of the content on the page No. 8
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 8 of 20 4.3. Client Side Node Descriptors Section Title Nodes Column Title Function Legal Values Up to 32 alphanumeric Node_Name Provide name for Node characters Only required for networked configurations. Set the Node_ID of the Node_ID local panel to zero, and create one Node Whole numbers 0,1,2,3 … Descriptor for each panel setting the Node_ID to the panel number. Protocol Specify protocol used FCI_E3 Only required for networ
Summary of the content on the page No. 9
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 9 of 20 4.4.2. Driver Related Map Descriptor Parameters Column Title Function Legal Values One of the Node Node_Name Name of Node to fetch data from Names specified in Section 4.3 This driver uses this parameter to determine the suitability of a Map Descriptor when looking for a location to store data from an incoming message. A Map Descriptor may be defined to store only Any, Other, Fault, Event Type ‘Alarm’, ‘Fault’, ‘Trouble’ or
Summary of the content on the page No. 10
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 10 of 20 4.5. Map Descriptor Example 1 – Sensor / Module Events If messages from Loop 1, Module 1 to 99 are received then the Map Descriptor in this example will be used for storage. If modules occur on more than one loop, one Map Descriptor is required per loop. In this example the event type is set to ‘Alarm’ so only “Alarm” events will be stored. The “Event_Type” can be changed to suit the required data. If all events are required,
Summary of the content on the page No. 11
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 11 of 20 4.6. Map Descriptor Example 2 – Bit Storage This example defines storage location for Relay Point events. The example would work for all other point types. In the example, both primary and secondary storage Data Arrays have been specified. The driver stores index values in the primary array. Each new event for a particular relay will overwrite the value stored previously. In the Bit Array, the driver sets the bit corresponding t
Summary of the content on the page No. 12
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 12 of 20 5. Configuring the FieldServer as a Gamewell FCI-E3 Series Serial Driver Server The server side of the driver is intended to support FieldServer’s Quality Assurance program and is not intended to provide complete emulation of an E3 and is thus not fully documented. Should you require the Server side functionality to be documented and enhanced, please contact FieldServer’s sales group. FieldServer Technologies 1991 Tarob Court M
Summary of the content on the page No. 13
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 13 of 20 Appendix A. Advanced Topics Appendix A.1. Events and Event Categories The driver reports the event cause using the matching index value. There are 4 event categories: 1 = Other 3 = Alarm 2 = Fault 4 = Trouble The message category must match the ‘Event Type’ parameter specified on a Map Descriptor before that Map Descriptor can be considered for storage of the message data. Index Category Event 1 FCI_EVENT_TYPE_FAULT "Fau
Summary of the content on the page No. 14
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 14 of 20 Appendix A.2. Extending the Event Table New event causes may be added to the Event Table and the index value or category of existing event causes modified by adding a section to the configuration CSV file. The examples below illustrate this: Example 1: Index value of 'Trouble' is updated to a new value of 100 Driver_Table Event_Type_Description, Event_Type_Index_Value, Event_Type_Category , Protocol TROUBLE, 100, 4,
Summary of the content on the page No. 15
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 15 of 20 Example: The following fragment is part of a Map Descriptor definition; some parameters have been omitted for the purposes of clarity. Map_Descriptors, Data_Array_Name, Data_Array_Offset, Event Type, Point Type, Relay/Loop/Zone Number, Address, Length, Clear_on_Reset, DA_Bit_Name DA_MODU , 0, ANY, Module, 1, 1, 99, Yes, DB_MODU DA_MODU_A, 0, ALARM, Module, 1, 1, 99, Yes, DB_MODU_A DA_MODU_F, 0, FAULT, Module, 1, 1, 99,
Summary of the content on the page No. 16
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 16 of 20 Appendix A.4. Panel Synchronization Manual synchronization is required. When the “Reset” button on the panel is pressed a message is transmitted to the FieldServer, which clears the data in the FieldServer. After a reset the panel sends messages to report all abnormal states. When all these messages have been processed the FieldServer and panel will be synchronized. This process can be repeated at any time. Appendix A.5.
Summary of the content on the page No. 17
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 17 of 20 Appendix B. Driver Error Messages. Message Description FCI_E3:#1 FYI. Use a DA called <%s> to expose Refer to Appendix B.1 diagnostic info., FCI_E3_STATS_DA ) FCI_E3:#2 FYI. Added Event Desc=<%s> Index=%d Printed for information only. No action Categ=%d , new_event_desc , required if it confirms your expectations. new_event_desc_index_value , new_event_desc_categ ) ; FCI_E3:#3 Err. No space. Reject Event Desc=<%s> 4 Inde
Summary of the content on the page No. 18
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 18 of 20 Message Description This message should only be printed if a byte in a message has been corrupted. If FCI_E3:#17 Err. Loop=%d < 1. Rejected. , drv_bd->loop ) you notice it more than once then take a log and contact tech support. If this error is repeated often it is possible FCI_E3:#18 Err. Loop Type='%c'(%#x) Not recognized. , that a FCI firmware update has made the drv_bd->point_identifier[2] , drv_bd->point_identifier[2]
Summary of the content on the page No. 19
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 19 of 20 Appendix B.1. Driver Stats Exposed. In addition to the standard FieldServer operating statistics the driver exposes certain key stats in a Data Array if required. An upstream device can then monitor these stats. Add the following to your configuration file to activate these stats. // Expose Driver Operating Stats. Data_Arrays Data_Array_Name, Data_Format, Data_Array_Length fci-e3-stats, UINT32, 200 The driver ex
Summary of the content on the page No. 20
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 20 of 20 Stat Offset Description Increments each time a character is received from the panel. The bytes are only added when a #define FCI_E3_STAT_RCVD_BYTES 12 message terminator is received. Thus this count is equivalent to the byte count in all FCI_E3_STAT_RCVD_MSGS Increments each time a message #define 13 is parsed without errors. Excludes FCI_E3_STAT_PARSED_NO_ERRS_EXCLD_RESET Reset Messages Increments each time a reset
