- 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: Document Revision: 1.
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 2.2. Provided by the Supplier of 3rd Party Equipment ................................
FS-8700-132 Gamewell FCI-E3 Driver Manual 1. Page 3 of 20 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 or commands to the E3.
FS-8700-132 Gamewell FCI-E3 Driver Manual 2. Page 4 of 20 Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # FS-8917-16 FS-8700-132 2.2. Description Pigtail cable for RJ45 Port for RS-232 use Driver Manual. Provided by the Supplier of 3rd Party Equipment 2.2.1. Required 3rd Party Hardware ILI-MB-E3 Board FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.
FS-8700-132 Gamewell FCI-E3 Driver Manual 3. Page 5 of 20 Hardware Connections The FieldServer is connected to the FCI-E3 panel as shown in the connection drawing.
FS-8700-132 Gamewell FCI-E3 Driver Manual 4. Page 6 of 20 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).
FS-8700-132 Gamewell FCI-E3 Driver Manual 4.2. Page 7 of 20 Client Side Connection Descriptions Section Title Connections Column Title Port Protocol Baud* Function Specify which port the device is connected to the FieldServer Specify protocol used Specify baud rate Vendor documentation indicated that the only supported Baud rate was 9600. During testing we learned this was not true. The driver was tested at 57600 and 9600 baud.
FS-8700-132 Gamewell FCI-E3 Driver Manual 4.3. Page 8 of 20 Client Side Node Descriptors Section Title Nodes Column Title Function Node_Name Legal Values Up to 32 alphanumeric characters Provide name for Node Node_ID Protocol FCI_Reset_Action_Option* Connection Only required for networked configurations. Set the Node_ID of the local panel to zero, and create one Node Descriptor for each panel setting the Node_ID to the panel number.
FS-8700-132 Gamewell FCI-E3 Driver Manual 4.4.2. Driver Related Map Descriptor Parameters Column Title Function Node_Name Name of Node to fetch data from Event Type Point Type Relay/Loop/Zone Number Length* Address Store As* DA_Bit_Name Clear on Reset* Page 9 of 20 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.
Map Descriptor Example 1 – Sensor / Module Events Page 10 of 20 Unique Map Descriptor Names are recommended. Event Type, Alarm, The name of the Node defined in the Node Descriptor Node_Name, Panel-01, Address, 1, Change this to ‘Sensor’ for sensors. Relay/Loop/Zone Number, 1, Only Alarm events will be stored. Point Type, Module, FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.
Map Descriptor Example 2 – Bit Storage Page 11 of 20 Client Side Map Descriptors DA_RELAY, RelayData, 0, Data_Array_Offset, Passive_Client, Function, Panel-01, Node_Name, Event Type, Any, Point Type, Relay, Remember that 2 elements per Relay, Module, Sensor, Loop are used. DA_Bit_Name is where secondary storage is defined. Events are stored by setting appropriate bits.
FS-8700-132 Gamewell FCI-E3 Driver Manual 5. Page 12 of 20 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.
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.
FS-8700-132 Gamewell FCI-E3 Driver Manual Appendix A.2. Page 14 of 20 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.
Page 15 of 20 Data_Array_Offset, 0, 0, 0, 0, 0, Event Type, ANY, ALARM, FAULT, TROUBLE, OTHER, Point Type, Module, Module, Module, Module, Module, Relay/Loop/Zone Number, 1, 1, 1, 1, 1, Address, 1, 1, 1, 1, 1, Length, 99, 99, 99, 99, 99, Clear_on_Reset, Yes, Yes, Yes, Yes, Yes, DA_Bit_Name DB_MODU DB_MODU_A DB_MODU_F DB_MODU_T DB_MODU_O FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.
FS-8700-132 Gamewell FCI-E3 Driver Manual Appendix A.4. Page 16 of 20 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.
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 17 of 20 Appendix B. Driver Error Messages. Message FCI_E3:#1 FYI. Use a DA called <%s> to expose diagnostic info., FCI_E3_STATS_DA ) FCI_E3:#2 FYI. Added Event Desc=<%s> Index=%d Categ=%d , new_event_desc , new_event_desc_index_value , new_event_desc_categ ) ; FCI_E3:#3 Err. No space. Reject Event Desc=<%s> Index=%d , new_event_desc , new_event_desc_index_value ) ; FCI_E3:#4 FYI. Duplicate Event Desc=<%s>. , new_event_desc ) ; FCI_E3:#5 FYI.
FS-8700-132 Gamewell FCI-E3 Driver Manual Message FCI_E3:#17 Err. Loop=%d < 1. Rejected. , drv_bd->loop ) FCI_E3:#18 Err. Loop Type='%c'(%#x) Not recognized. , drv_bd->point_identifier[2] , drv_bd->point_identifier[2] ) FCI_E3:#19 Err. Relay=%d < 1. Rejected. , drv_bd->relay FCI_E3:#20 Err. Zone=%d < 1. Rejected. , drv_bd->zone" FCI_E3:#21 Err. Point Type not recognized FCI_E3:#22 Err. Undefined Point Type" FCI_E3:#23 Err. Event Type not recognized FCI_E3:#24 Err. Undefined Event Type FCI_E3:#25a Err.
FS-8700-132 Gamewell FCI-E3 Driver Manual Appendix B.1. Page 19 of 20 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.
FS-8700-132 Gamewell FCI-E3 Driver Manual Page 20 of 20 Stat Offset #define FCI_E3_STAT_RCVD_BYTES 12 #define FCI_E3_STAT_PARSED_NO_ERRS_EXCLD_RESET 13 #define FCI_E3_STAT_PARSED_NO_ERRS_RESET 14 #define FCI_E3_STAT_PARSED_NO_ACTION 15 #define FCI_E3_STAT_PARSED_WITH_ERRS 16 #define FCI_E3_STAT_INHIBIT_RESET 17 #define FCI_E3_STAT_INHIBIT_RESET_DA_PUT 18 #define FCI_E3_STAT_INHIBIT_RESET_WHILE 19 #define FCI_E3_STAT_NODE_INFO_MSG 20 #define FCI_E3_STAT_NO_PLACE_TO_STORE_NODE 21 Descr
