-
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.01
4
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 or commands to the E3. Messages
received from the E3 are analyzed and are then either discarded or used to update the FieldServer’s
internal Data Arrays. The action depends on which types of events, the type of device generating the
event and device address the FieldServer has been configured to process. Once stored in the
FieldServer the data is available to be read or written using other protocols such as BACnet.
No automatic panel data synchronization technique exists. The data in the FieldServer and the panel
status have to be synchronized manually. This typically requires a panel reset.
Since the driver cannot send data or commands to the E3 it cannot be used to acknowledge, silence or
reset alarms and other events.
The driver can process messages from networked panels. The driver connects to the main panel.
Subsidiary panels are configured to send event data to the main panel which then sends messages to the
FieldServer. Node information is sent in the line preceding the event and the driver uses this to
determine the panel at which the event originated and to store data appropriately.
The driver provides both Client and Server emulation. 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.
Max Nodes Supported
FieldServer
Nodes Comments
Mode
1 Node per serial port. If there is more than one alarm panel they can be
Client
1
networked and configured to send event data to the primary panel. The driver
can process messages which identify the node of origin.
Server side is not supported. See description.
Server
N/A
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
PART #
Description
FS-8917-16
FS-8700-132
Pigtail cable for RJ45 Port for RS-232 use
Driver Manual.
2.2.
Provided by the Supplier of 3rd Party Equipment
Required 3rd Party Hardware
2.2.1.
ILI-MB-E3 Board
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
1
8
P1
FieldServer
Connector Pinouts
RJ-45
Pin Signal Signal
FCI-E3
Wire Color
Pin
2
1
Brown
White/Orange
Blue/white
1
8
5
Rx
Tx
GND
+ve
-ve
Signal Common Reference
4
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 parameters necessary for configuring the FieldServer to
communicate with a FCI Series E3.
4.1.
Data Arrays/Descriptors
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In
order to enable the FieldServer for Gamewell FCI-E3 Series 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.
Section Title
Data_Arrays
Column Title
Function
Legal Values
Up to 15 alphanumeric
characters
Data_Array_Name
Provide name for Data Array
Float, Bit, UInt16, SInt16,
Provide data format. Each Data Array Packed_Bit, Byte,
Data_Array_Format
Data_Array_Length
can only take on one format.
Packed_Byte,
Swapped_Byte
Number of Data Objects. Must be
larger than the data storage area
required by the Map Descriptors for the
data being placed in this array.
1-10,000
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Array_Format,
Data_Array_Length
UInt16,
UInt16,
Bit,
200
200
200
200
DA_DO_01,
Bit,
FS-8700-132 Gamewell FCI-E3 Driver Manual
Page 7 of 20
4.2.
Client Side Connection Descriptions
Section Title
Connections
Column Title
Port
Function
Specify which port the device is connected to the FieldServer
Specify protocol used
Legal Values
P1-P81
FCI_E3
Protocol
Specify baud rate
Vendor documentation indicated that the only supported Baud 9600, 57600
rate was 9600. During testing we learned this was not true. The (Vendor
driver was tested at 57600 and 9600 baud. Testing at 115200 Limitation)
Baud produced intermittent result and should not be used.
Baud*
Parity*
None
–
Specify parity
(Vendor
Limitation)
8
(Vendor
Data_Bits*
Stop_Bits*
Specify data bits
Specify stop bits
Limitation)
1
Limitation)
(Vendor
Handshaking* The E3 series panels do not support hand shaking.
Example
// Client Side Connections
Connections
Port,
P1,
Protocol,
FCI_E3,
Baud,
9600,
Parity
None
1
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
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
characters
Node_Name
Provide name for Node
Only
required
for
networked
configurations. Set the Node_ID of the
Node_ID
Protocol
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.
Specify protocol used
FCI_E3
Only required for networked
configurations:
When not specified or set to
‘Reset_by_any_Node ‘ then the driver
will reset the data array points
associated with the given node
irrespective of the reset message’s
origin.
Reset_by_any_Node,
Reset_by_this_Node_Only
FCI_Reset_Action_Option*
When set to ‘Reset_by_this_Node_Only’
then the driver only resets the data
associated with the given node if the
reset originated from the same node.
Specify which port the device is
connected to the FieldServer
Connection
P1-P82
Example
// Client Side Nodes
Nodes
Node_Name,
Panel-01,
Protocol,
FCI_E3,
Connection
P8
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Function
of this
Descriptor
Legal Values
to 32 alphanumeric
Name
Map Up
characters
Name of Data Array
where data is to be stored
in the FieldServer
One of the Data Array names
from “Data Array” section above
Data_Array_Name
Starting location in Data 0 to maximum specified in
Data_Array_Offset
Function
Array
“Data Array” section above
Function of Client Map
Descriptor.
Server, Passive_Client
2
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
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
Names specified in
Section 4.3
Node_Name
Event Type
Point Type
Name of Node to fetch data from
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,
‘Alarm’, ‘Fault’, ‘Trouble’ or ‘Other events. Alarm, Trouble
Alternatively, specify “Any”
A table of events vs. categories is provided in
Appendix A.1
This driver uses this parameter to determine the Zone, Relay, Loop,
suitability of a Map Descriptor when looking for a Sensor,
Module,
location to store data from an incoming message.
Ignored when the Point Type is ‘Panel’
Point Type = Relay 1..255
Panel
Relay/Loop/Zone
Number
Point Type = Zone 1..8
Point Type = Loop 1..2
Whole Numbers
1, 2 , etc
Point Type = Module 1..2
Point Type = Sensor 1..2
Each Map Descriptor defines storage locations for a
series of addresses. This parameter specifies the
length of the series.
This parameter is specific to Map Descriptors with
‘Event Type’ Module or Sensor. It specifies the
starting Module or Sensor number. The length 1..99
parameter then determines the range of the
Sensor/Module numbers
1,2,3 .etc
Whole numbers
Length*
Address
By default the driver stores using the ‘Index Value’
Method. If set to ‘Bit’ the driver will use the primary
Data Array to store using the ‘Bit Storage’ Method.
Store As*
Bit, Index_Value
These methods are described in Appendix A.3
If the default ‘Store As’ is specified or if the
parameter is omitted then a secondary array can be One of the Data
specified using this parameter - the driver will store Array names from
DA_Bit_Name
event data as ‘Bit Storage’ in the Secondary array “Data
(and as ‘Index Values’ in the Primary array.) These section above
methods are described in Appendix A.3
Array”
If this parameter is specified it will prevent the Driver
resetting the Data Array points associated with the Yes, No
Map Descriptor on reset.
Clear on Reset*
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.
FS-8700-132 Gamewell FCI-E3 Driver Manual
Appendix A. Advanced Topics
Page 13 of 20
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
2 = Fault
3 = Alarm
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
1
Category
FCI_EVENT_TYPE_FAULT
Event
"Fault"
2
3
4
5
6
7
8
9
FCI_EVENT_TYPE_OTHER "Short"
FCI_EVENT_TYPE_OTHER "Disconnect"3
FCI_EVENT_TYPE_OTHER "Comm Fault"
FCI_EVENT_TYPE_OTHER "Config Err"
FCI_EVENT_TYPE_OTHER "Eeprom Bad"
FCI_EVENT_TYPE_OTHER "Reset"
FCI_EVENT_TYPE_OTHER "Silence"
FCI_EVENT_TYPE_OTHER "Cross Zone"3
FCI_EVENT_TYPE_OTHER "Acknwldgd"
FCI_EVENT_TYPE_OTHER "Walk Test"
FCI_EVENT_TYPE_OTHER "Alarm Test"
FCI_EVENT_TYPE_OTHER "SPVSN Test"
FCI_EVENT_TYPE_OTHER "Fault Test"
FCI_EVENT_TYPE_OTHER "Fire Drill"
FCI_EVENT_TYPE_OTHER "Batt Test"
FCI_EVENT_TYPE_OTHER "PRGM Mode"
FCI_EVENT_TYPE_OTHER "Action"
FCI_EVENT_TYPE_OTHER "Loop Break"
FCI_EVENT_TYPE_ALARM "Alarm"
FCI_EVENT_TYPE_OTHER "P.A.S."
FCI_EVENT_TYPE_OTHER "Off-Normal"
FCI_EVENT_TYPE_OTHER "RZA Fault"3
FCI_EVENT_TYPE_OTHER "Verify"3
FCI_EVENT_TYPE_OTHER "CM Short"3
FCI_EVENT_TYPE_OTHER "Test Fail"
FCI_EVENT_TYPE_OTHER "Alert"
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
FCI_EVENT_TYPE_OTHER "Dirty"
FCI_EVENT_TYPE_OTHER "Very Dirty"
FCI_EVENT_TYPE_OTHER "Missing"
FCI_EVENT_TYPE_OTHER "Wrong Type"
FCI_EVENT_TYPE_OTHER "Extra Addr"
FCI_EVENT_TYPE_OTHER "Clock Err"3
FCI_EVENT_TYPE_TRBLE
"Trouble"3
FCI_EVENT_TYPE_OTHER "MLT Events"3
FCI_EVENT_TYPE_OTHER "Alrm Ackd"
FCI_EVENT_TYPE_OTHER "Outpt Fail"
FCI_EVENT_TYPE_OTHER "Tally Flt"
FCI_EVENT_TYPE_OTHER "AC Flt To"
FCI_EVENT_TYPE_OTHER "Trbl Ackd"
FCI_EVENT_TYPE_OTHER "Access"
FCI_EVENT_TYPE_OTHER "Netwrk Flt"
FCI_EVENT_TYPE_OTHER "NetGndFlt"
FCI_EVENT_TYPE_OTHER "Dact Fault"
FCI_EVENT_TYPE_OTHER "Node Msng"
FCI_EVENT_TYPE_OTHER "Node Xtra"
FCI_EVENT_TYPE_OTHER "Fans Off"
FCI_EVENT_TYPE_OTHER "Xzone Alrm"
3 Not defined in the spec
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 ,
TROUBLE, 100, 4,
Protocol
FCI_E3
Example 2: New Entry is added
Since it has been added as category=3, only Map Descriptors with 'Event Type' set to “Alarm” or
“Any” will capture messages with this event description
Driver_Table
Event_Type_Description,
DESTROYED,
Event_Type_Index_Value,
51,
Event_Type_Category,
3,
Protocol
FCI_E3
For categories use the following values
'Other' = 1
'Fault' = 2
'Alarm' = 3
'Trouble' = 4
Appendix A.3.
How Data is stored
All messages shorter than 102 characters are discarded unless they contain information identifying
the networked/local panel. All other messages are processed as follows:
•
•
•
•
The driver determines if the message is a Zone, Relay, Loop, Sensor, Module or Panel message.
The driver finds all Map Descriptors with matching ‘Point Type’ parameters.
The event category is determined.
Map Descriptor selection is refined based on whether the ‘Event Type’ matches or has been
defined as “Any”
•
The driver determines the Loop. Relay, Zone, Sensor and Module numbers from the message
and refines its selection of Map Descriptors by selecting those that match the values determined
from the message.
•
•
The selected Map Descriptors are now used to determine a Data Array and offset at which to
store the data.
Finally the driver checks the ‘Store As’ parameter. If it hasn’t been specified then ‘Index Value’
storage is assumed. If it has been specified as ‘Bits’ then the driver will perform ‘Bit Storage’. In
cases where the Map Descriptor has both a primary and secondary Data Array, the driver will use
‘Index Value’ storage using the primary data array and ‘Bit Storage’ using the secondary array.
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.
What happens when the panel sends a Reset Message
When a panel sends a reset message the driver processes every single Map Descriptor, looking at
the ‘Clear on Reset’ parameter (See section 4.4.2). If the parameter is set to yes, then the driver sets
all the Data Array elements referenced by the Map Descriptor to zero by looking up the Data Array
Name, the Data Array offset and the length. The driver also clears the relevant sections of a Data
Array specified with the DA_Bit_Name parameter.
The process can take some time. For this reason, it is suggested that you take care not to set the
Map Descriptor length to a value larger than necessary.
Appendix A.5.1.
Networked Panels.
The driver can processes messages and store data from multiple panels provided that:
•
The panels are connected in an FCI network and the panels are configured to report their
events to the main panel
•
The main panel is configured to send the Node of origin in a message preceding the event
message. Consult with FCI for information on how to achieve this.
Example of message sent by a panel that is networked. The driver is dependent on seeing the
node of event origin included in parenthesis before each event message.
Node02:
MISSING Acclimate L1S041 00:17:06
01/01/06
Node55: 1st Floor Lobby
DISCONNECT RSTRD Ion Detector L1S024 09:51:44
01/15/06
Local:
FIRST ALARM Photo Detector L1S001 09:24:52
12/01/06
The main panel is identified as ‘Local’. The driver interprets this as Node_ID=0.
To capture events from multiple networked panels a Node Descriptor is required for each panel
with the appropriate Node_ID. Each Node requires a set of Map Descriptors.
FS-8700-132 Gamewell FCI-E3 Driver Manual
Appendix B. Driver Error Messages.
Page 17 of 20
Message
Description
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
Refer to Appendix B.1
Printed for information only. No action
required if it confirms your expectations.
Categ=%d
new_event_desc_index_value , new_event_desc_categ ) ;
FCI_E3:#3 Err. No space. Reject Event Desc=<%s>
,
new_event_desc
,
Index=%d
new_event_desc_index_value ) ;
FCI_E3:#4 FYI. Duplicate Event Desc=<%s>.
new_event_desc ) ;
FCI_E3:#5 FYI. Duplicate Event Desc=<%s>.
new_event_desc ) ;
,
new_event_desc
,
,
,
There is only space for 60 event types.4
The Event type being added already
exists. If you are updating the category,
ignore the message. Otherwise correct the
configuration file.4
If the event index is greater than 64 then
the data cannot be stored as bits - only 64
bits are reserved for events.
FCI_E3:#6 Err. Event Index=%d. Too big to set bit.,
drv_bd->event_index )
FCI_E3:#7a Err. DA=%s too short. Rqd=%d, dt- The MD in question has a length and
>buffer_name , offset );
FCI_E3:#7b Err. DA=%s too short. Rqd=%d, possible_md-
>data->buffer_name , offset );
offset which makes it run past the end of
the Data Array. Message 7b is printed
when data is being stored as bits.4
FCI_E3:#8 FYI. Reset was rcvd and processed! Stamped Printed for information only. No action
%s %s , drv_bd->time , drv_bd->date )
required.
A reset was received but the driver could
FCI_E3:#9 Err. Reset was ignored.
not reset any data.
'Clear_on_Reset'
possibly set to 'no' on all Map Descriptors?
FCI_E3:#10 FYI. Reset of DA=%s Off=%d Len=%d,
Printed for information only. No action
required.
possible_md->data->buffer_name
,
possible_md-
>bxi_data_buffer_offset , possible_md->data_length );
FCI_E3:#11 Err. Cant reset DA=%s len=%d rqd=%d,
The Map Descriptor in question has a
length and offset which makes it run past
the end of the Data Array.4
possible_md->data->buffer_name
da_get_length_in_items ( (DAH_TYP) possible_md->data )
possible_md->data_length+possible_md-
,
,
>bxi_data_buffer_offset );
FCI_E3:#12a Err. No MD's to store message data.
The Driver could not find a place to store
data from a message received. If the data
is not required then the message may be
FCI_E3:#12b Err. No MD's to store message data."
ignored.
Otherwise
update
the
FCI_E3:#13 Err. Msg was ignored. MD Required for
Storage.
configuration file4.
FCI_E3:#13a Err. Diagnostic 1);
FCI_E3:#13b Err. Diagnostic 2);
FCI_E3:#13c Err. Diagnostic 3);
Take a log. Try and repeat the event that
caused the message to be printed. Then
contact tech support.
FCI_E3:#14
Err.
<%s>
file
not
found.,
md-
>mapdesc_name ) ;
FCI_E3:#15 Err. Event Type=<%s> Not recognized." ,
drv_bd->event_desc )
FCI_E3:#16 Err. Point Type='%c'(%#x) Not recognized. ,
drv_bd->point_identifier[0] , drv_bd->point_identifier[0] ) ;
If this error is repeated often it is possible
that a FCI firmware update has made the
driver unusable. Take a log and contact
tech support.
4 Correct the configuration file, download to the FieldServer and restart the FieldServer for the changes to
take effect.
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
you notice it more than once then take a
log and contact tech support.
FCI_E3:#17 Err. Loop=%d < 1. Rejected. , drv_bd->loop )
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] )
driver unusable. Take a log and contact
tech support.
This message should only be printed if a
byte in a message has been corrupted. If
you notice it more than once then take a
log and contact tech support.
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"
Valid Point Types are listed in section
4.4.25
FCI_E3:#23 Err. Event Type not recognized
FCI_E3:#24 Err. Undefined Event Type
Valid Event Types are listed in section
4.4.25
FCI_E3:#25a Err. Address+Length>99. Length Truncated
The maximum value for a sensor/module
is 99. The combination of address and
length specified produce a number > 995
FCI_E3:#25b Err. Address+Length>99. Length Truncated
FCI_E3:#26 Err. Invalid Module number. Expected 1..99
FCI_E3:#27a Err. Invalid Loop number. Expected 1..10
FCI_E3:#27b Err. Invalid Loop number. Expected 1..10
FCI_E3:#27c Err. Invalid Loop number. Expected 1..10
FCI_E3:#28 Err. Invalid Sensor number. Expected 1..99
FCI_E3:#29 Err. Invalid Zone number. Expected 1..255
FCI_E3:#30 Err. Invalid Relay number. Expected 1..255
Correct the configuration file5
Valid Point Types are listed in Section
4.4.25
FCI_E3:#31 Err. Point Type Invalid.
The length of each Map Descriptor should
be specified. Refer to Section 4.4.25
The driver can only listen passively for
message from the panel. Map Descriptors
may not be configured as active. 5
An event message is less than 80 bytes
long. If this error is repeated often it is
possible that a FCI firmware update has
made the driver unusable. Take a log and
contact tech support.
FCI_E3:#32 Err. No MD Length. Default to 1
FCI_E3:#33 Err. Driver can’t poll or write.
FCI_E3:#36 Err. Too Short. Bytes=%d , conn->ux_iptr"
5 Correct the configuration file, download to the FieldServer and restart the FieldServer for the changes to
take effect.
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,
fci-e3-stats,
Data_Format,
UINT32,
Data_Array_Length
200
The driver exposes stats based on a port handle. The offset specified in the table below must be
added to the handle number multiplied by 100. i.e. for port whose handle is 1 then the driver will store
the 1st stat at 1+100*1=101.
Stat
Offset Description
Increments each time point data is
#define FCI_E3_STAT_NO_PLACE_TO_STORE
1
2
3
4
received but there is no Map
Descriptor to store the data (any)
Increments each time point data is
received but there is no Map
Descriptor to store Zone data
Increments each time point data is
received but there is no Map
Descriptor to store Relay data
Increments each time point data is
received but there is no Map
Descriptor to store the Loop data
Increments each time point data is
received but there is no Map
Descriptor to store the Sensor
data
#define
FCI_E3_STAT_NO_PLACE_TO_STORE_ZONE
#define
FCI_E3_STAT_NO_PLACE_TO_STORE_RELAY
#define
FCI_E3_STAT_NO_PLACE_TO_STORE_LOOP
#define
5
FCI_E3_STAT_NO_PLACE_TO_STORE_SENSOR
Increments each time point data is
received but there is no Map
Descriptor to store the Module
data
Number of times that a message
line was zero bytes long
(excluding the terminator)
#define
6
7
FCI_E3_STAT_NO_PLACE_TO_STORE_MODULE
#define FCI_E3_STAT_EMPTY_MSG
Number of times that a message
line was too short probably a
system id tag line
Increments each time a reset was
rcvd but no Data Array was reset
Increments each time point data is
received but there is no Map
Descriptor to store data that
cannot be attributed to a zone,
relay, loop, sensor, module
#define FCI_E3_STAT_SHORT_MSG
#define FCI_E3_STAT_NO_RESET
8
9
#define
10
11
FCI_E3_STAT_NO_PLACE_TO_STORE_PANEL
Increments each time a message
is received
#define FCI_E3_STAT_RCVD_MSGS
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
message terminator is received.
Thus this count is equivalent to
#define FCI_E3_STAT_RCVD_BYTES
12
the
byte
count
in
all
FCI_E3_STAT_RCVD_MSGS
Increments each time a message
is parsed without errors. Excludes
Reset Messages
#define
13
FCI_E3_STAT_PARSED_NO_ERRS_EXCLD_RESET
Increments each time a reset
message is parsed without errors.
Increments each time a message
is parsed with no errors but the
nature of the message doesn’t
require data to be stored. (eg
empty message lines)
#define FCI_E3_STAT_PARSED_NO_ERRS_RESET 14
#define FCI_E3_STAT_PARSED_NO_ACTION
15
Increments each time a message
produces an error when parsed.
Set to 1 to inhibit resets altogether
Set to 1 to inhibit resets from
clearing arrays
#define FCI_E3_STAT_PARSED_WITH_ERRS
#define FCI_E3_STAT_INHIBIT_RESET
16
17
18
#define FCI_E3_STAT_INHIBIT_RESET_DA_PUT
Set to 1 to inhibit the reset
function from looping through Map
Descriptors
Increments each time a message
with Node information is received
Increments each time an event
#define FCI_E3_STAT_INHIBIT_RESET_WHILE
#define FCI_E3_STAT_NODE_INFO_MSG
19
20
#define
message
information relating to a Node that
cannot be found is discarded.
containing
Node
21
FCI_E3_STAT_NO_PLACE_TO_STORE_NODE
|