3.3Connection to a Simplex 4020/4100 Panel .................................................................................................... 7
3.3.1 Communication Board ........................................................................................................................... 7
3.3.2 Serial Connection ................................................................................................................................... 7
3.4Connection to a Simplex 4100U/4100ES Panel ............................................................................................. 8
4 Data Array Parameters ................................................................................................................................... 9
5 Configuring the FieldServer as a Simplex Time Recorder Company - 4100 Computer Port Protocol Client ... 10
5.1Client Side Connection Parameters ............................................................................................................. 10
5.2Client Side Node Parameters ....................................................................................................................... 11
5.3Client Side Map Descriptor Parameters ....................................................................................................... 12
5.3.1 FieldServer Specific Map Descriptor Parameters ................................................................................. 12
5.3.2 Driver Specific Map Descriptor Parameters ......................................................................................... 12
5.3.5 Map Descriptor Example 1. - Read Panel Time .................................................................................... 14
5.3.6 Map Descriptor Example 2 - Write Panel Time .................................................................................... 14
5.3.7 Map Descriptor Example 3 - Panel Revision Information ..................................................................... 14
6 Configuring the FieldServer as a Simplex Time Recorder Company - 4100 Computer Port Protocol Server .. 15
Appendix A. Useful Features ................................................................................................................................ 16
Appendix A.1. How to use Data Arrays to map to/from Card-Point-Sub addresses ............................................... 16
Appendix A.1.1. Simplex Point Status Data Format ......................................................................................... 17
Appendix A.2. SHOW Function Attributes and Attribute States .............................................................................. 17
Appendix A.2.1. Table of Attributes recognised by the Driver .......................................................................... 18
Appendix A.2.2. Attribute States recognised for Attribute Method 1 .............................................................. 19
Appendix A.3. Extending the List of Show Attributes .............................................................................................. 20
Appendix A.4.2. Read Point Status ................................................................................................................... 21
Appendix A.4.3. Using unsolicited messages from the Panel to determine point status ................................. 22
Appendix A.4.4. Acknowledge All Points .......................................................................................................... 23
Appendix A.4.5. Acknowledge a specific point ................................................................................................. 23
FS-8700-41 Simplex Driver Manual Table of Contents
Appendix A.4.8. Show ....................................................................................................................................... 25
Appendix A.4.9. Read Analog Psuedo Points .................................................................................................... 27
Appendix A.6. Synchronizing the FieldServer with the Panel .................................................................................. 28
Appendix A.6.1. Using the Xpoint Function ...................................................................................................... 28
Appendix A.6.2. Using Clist to Write-Through and Store point status from Unsolicited Messages ................. 29
Appendix B. Troubleshooting ............................................................................................................................... 30
Appendix B.4. Simulation of the Xpoint command ................................................................................................. 31
Appendix B.5. Simplex Port Vectoring ..................................................................................................................... 31
Appendix C. Reference ......................................................................................................................................... 32
Appendix C.1. Simplex Address Formatting – Specific Keywords ............................................................................ 32
FS-8700-41 Simplex 4100 Driver Manual Page 4 of 48
1 SIMPLEX TIME RECORDE R COMPANY - 4100 COMPUTER PORT P R OT O C O L
The Simplex Time Recorder Company - 4100 Computer Port Protocol driver allows the FieldServer to transfer data
to and from devices over either RS-232 or RS-485 using Simplex Time Recorder Company - 4100 Computer Port
Protocol.
This driver is designed to connect to a Simplex 4100 panel equipped to support the “4100 Computer Port Protocol”
as defined in Simplex’s document 950-004 Revision E dated 28 July 2000. The implementation provides a selected
subset of protocol functions and subset of functionality for each of these selected functions. It is important to
note the exclusions and limitations described in this document.
The driver is capable of parsing and storing information sent by a panel in the form of unsolicited messages which
are typically generated when there is a state change in the panel or one of the connected devices. The driver is
also capable of polling for point and panel status data and some additional data such as the panel’s time and
revision information. In addition the driver is capable of setting some control points in the panel – acknowledging
and resetting alarms and writing data (where permitted) to some analog and discrete points.
This is a client only driver and is not capable of emulating a Simplex Panel. Server emulation is provided for test
purposes only and is not supported or documented.
1.1 Sup ported Panel Types
The driver has been tested against 4020, 4100, 4100U panels, and is also compatible with the 4100ES and 4010ES
panels. There is no difference in the protocol format between the various panels. The supported function set
differs between panel firmware versions.
1.2 Sim ple x Panel Firmware Rev isio n v s . S up p o r t e d F u n c t i o n a l it y
This driver was primarily tested against a 4020 panel with firmware revision 9.2. Beta testing against a 4100 panel
with a firmware revision 10.x was also performed.
Please refer to the CPP Revision Compatibility Table (avalable from Simplex) to determine the functions supported
by different panel firmware revisions.
The functions described in this manual are supported for firmware revisions 10 or later. For revisions between 9.2
and 10, the ‘Earths’ and ‘Value’ functions described in this driver are not supported by the Simplex Panels.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 5 of 48
FieldServer Technologies Part #
Description
FS-8917-16
RJ45 to terminal connector cable. (4020 and 4100 Panels)
FS-8917-07
Ethernet cable with 25 pin male connector. (4100u Panels)
SPA59132
RS-485 connection adapter
2 DRIVER SCOPE OF SUPP LY
2.1 Sup plie d by FieldServer Technologies for this driver
2.2 Provided by Supplier of 3
To enable the 4100 Protocol, the 4100 system supplied by the user, must have a free RS-232 port dedicated for use
with the computer device. In most cases, this is not included in the base configuration of the product provided by
Simplex Time Recorder Company, and must be added as a sales option. All 4100 systems limit the number of
computer ports active at one time in a system. To determine the limit for the specific product configuration, refer
to the product specifications, or contact a Simplex sales representative.
rd
Party Equipment
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
The FieldServer is connected to the Simplex Device’s RS-232 port of device type "COMPUTER", the following port
attributes may be configured specifically for that particular port:
Ensure that these settings correspond to the settings described in section 4 of this document.
3.1 Sim 4100 Panel
3.2 Sim 4100U Panel
The following are the Simplex, recommended connections to be used in cabling between the 4100 and the
FieldServer device. For the computer device, the standard EIA signal description, and the 25 pin (DB25) and 9 pin
(DB9) connector assignments are shown.
Odd or Even parity is recommended (by Simplex) to provide additional error detection at the character level.
The driver does not support the Simplex RTS/CTS handshaking model. Therefore deselect the HSHAKE terminal flag or connect CTS to RTS
with a jumper on the 4100 side
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 10 of 48
Section Title
Connections
Column
Title
Function
Legal Values
Port
Specify which port the device is connected to
the FieldServer
P1-P8, R1-R23
Baud*
Specify baud rate
110 – 115200, standard baud rates only.
(Vendor limitation)
Parity*
Specify parity
Even, Odd, None, Mark, Space
Data_Bits*
Specify data bits
7, 8
Stop_Bits*
Specify stop bits
1
Protocol
Specify protocol used
sim4100
Poll Delay*
Time between internal polls
0-32000 seconds, 1 second
// Client Side Connections
Connections
Port
, Protocol
, Baud
, Parity
, Poll_Delay
P8
, Sim4100
, 9600
, Even
, 0.100s
3
5 CONFIGURING THE FIELD S E R V E R A S A S I M PLEX TIME RECORDER C OMPANY - 4100
COMPUT ER PORT PROTOCOL CLIEN T
For a detailed discussion on FieldServer configuration, please refer to the relevant instruction 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 provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate
with a Simplex Time Recorder Company - 4100 Computer Port Protocol Server.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable
the FieldServer for Simplex Time Recorder Company - 4100 Computer Port Protocol 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.
5.1 Clie n t S ide Connection Parameters
Example
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available
on specific hardware.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 12 of 48
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 FieldServer
One of the Data Array names from Section 4
Data_Array_Offset
Starting location in Data Array
0 to (Data_Array_Length-1) as specified in
“Data_Array” section
Function
Function of Client Map Descriptor
Rdbc, Wrbc, Wrbx
Column Title
Function
Legal Values
Node_Name
Name of Node to fetch data from
One of the Node names specified in
Section 5.2.
Length
Length of Map Descriptor. If data cannot be stored
because an array is too short the driver will produce a
message in the error log.
Any positive integer
Address
Not required. The address is specified by using the c-p-s specification described in section 0
sim4100_func
A keyword which controls the function being
performed or the type of data being polled / written.
Further notes on these keywords are provided in
Appendix C.1
The following ranges are valid for Simplex Devices:
Card address
Card type
0-119
Physical (Hardware) cards
128-143
Digital Pseudo cards
144-159
Analog Pseudo cards
160-175
List Pseudo cards
sim4100_Point
Simplex Address
<Point>
The range of point and sub-point fields for point addressing is very sparse
and depends on the type of card at that location. Contact Simplex Time
Company for details on point address ranges for specific cards.
The FieldServer will accept any positive integer number including zero;
however, not all the values are valid for Simplex devices – Refer to Appendix
A.1.1 for further information.
sim4100_Sub
Simplex Address
<Sub_Type>
5.3 Clie n t S ide Map Descriptor Parameters
5.3.1 Fie ld Server Specific Map Descriptor Parameters
5.3.2 Driver Specific Map Descriptor Parameters
5.3.3 Card-P oint-Sub Addressing Map Des c r i p t o r Parameters
The Simplex Time Recorder Company - 4100 Computer Port Protocol only uses the standard 4100 address format of
<Card>-<Point>-<Sub-point> (c-p-s). Symbolic addressing is not supported. The following keywords are used to
address devices. Refer to Appendix A.1 for further information and examples
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 14 of 48
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, Scan_Interval
, Length
Time_Mapdesc
, DA_TIME
, 0
, RDBC
, Node_A
, Time
, 30s
, 70
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, Scan_Interval
, Length
Time_Mapdesc
, DA_TIME
, 0
, Wrbc
, Node_A
, CTime
, 30s
, 7
Time_Mapdesc
, DA_TIME
, 0
, Wrbc
, Node_A
, Time
, 30s
, 7
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, Scan_Interval
, Length
Error_Mapdesc
, DA_REV_INFO
, 0
, Rdbc
, Node_A
, Revision
, 30s
, 200
Index 0: Hour (24 hour clock)
Index 1: Minute
Index 2: Second
Index 3: Day of week
Index 4: Day of month
Index 5: Month
Index 6: Year (since 2000)
Rdb may be sufficient as this data
does not change.
5.3.5 Map Descriptor Example 1. - R e a d P a n e l T i m e
5.3.6 Map Descriptor Example 2 - W r i t e P ane l Time
Use Ctime to set the panel time and date and use Time just to set the hour minute and seconds. If the hour is zero then the driver does not send a write
message to the panel.
5.3.7 Map Descriptor Example 3 - P ane l R e v ision Inf ormation
Define the DA_REV_INFO array as format BYTE and if using RUINET to monitor this Data Array change the display format to string to render the information
readable.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 15 of 48
6CONFIGURING THE FI E L DSERVE R AS A SI MPLEX TIME RECORDER C O MPA N Y - 4100 COMPUTER
PORT PROTOCOL SERVER
The driver contains some Server side functionality which has been developed to meet FieldServer’s continuous quality
assurance efforts. However, the Server side functions are not documented or supported for customer use. If you have a
strong requirement for this functionality then please contact the Sales and Marketing group of FieldServer.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 16 of 48
# Subpoints/point Calculated Offset
Sim4100_sub
0 1 2 3 4 5 6 ...
1 s per p
implies s=0 every time
c-0-0
c-1-0
c-2-0
c-3-0
c-4-0
c-5-0
c-6-0
...
2 s per p
implies s=0,1 for each p
c-0-0
c-0-1
c-1-0
c-1-1
c-2-0
c-2-1
c-3-0
...
5 s per p
implies s=0,1,2,3,4 for each p
c-0-0
c-0-1
c-0-2
c-0-3
c-0-4
c-0-5
c-1-0
...
x s per p
implies s=0,1,…(x-1)
c-0-0
c-0-1
c-0-2
c-0-3
c-0-4
c-0-5
c-0-6
...
...
, sim4100_func
, sim4100_card
, sim4100_point
, sim4100_sub
, data_array_offset
, Length
, Xpoint
, 10
,20
, 10
, 0
, 100
The length parameter reserves space in Data Array Items in
the Map Descriptor. If the calculated length exceeds the
length an error is printed and no data is stored (for Xpoint).
Appendix A. Useful Features
Appendix A.1. How to use Data Arrays to map to/from Card-Point-Sub addresses
Some commands derive a c-p-s address by inspecting a FieldServer Data Array. Others receive data from a device and modify
the data in an array based on the c-p-s address. This section explains how to make the connection between an index into a
Data Array and a c-p-s address.
To minimise the required Data Array size the FieldServer uses a mapping algorithm which can be optimized based on the
addresses of the Simplex devices. The map is manipulated by using the sim4100_card/point/sub parameter values.
If there are one sub-point (s) per point (p) then only one array location is required for each p. If there are two sub-point (s) per point (p) then two array locations are required for each p. If there are x sub-point (s) per point (p) then x array locations are required for each p.
This is more clearly explained in the table below:
Thus the offset into the Data Array is determined according to the following formula.
Data Array Offset = Offset specified on the Map Descriptor (Data_Array_Offset ) + Calculated Offset
Example:
Consider the following Map Descriptor fragment.
If data is received for point <c>-<p>-<s> = 9-0-0, this data will NOT be processed because the card number does not match
the value of the sim4100-card
If data is received for point <c>-<p>-<s> = 10-20-0, however, the data will be processed.
The array location is derived using the following formula (sim4100_sub is to be read as the “number of sub-points per point”; sim4100_card’s value will be ignored.)
FS-8700-41 Simplex 4100 Driver Manual Page 17 of 48
Bit
Identifier
State Store
Value
Bit Store
Value
Description
0 (First
Bit)
F 1 0
Fire Alarm
1 P 2 1 Priority 2
2 S 3 2 Supervisory
3 T 4 4 Trouble
4 U 5 8 Utility
5 C 6
16
Control
6 D 7
32
Disable
7 A 8
64
Primary state (based on point type - F if smoke detector, C if
signal circuit, etc.)
Appendix A.1.1. Simplex Point S t a t us Data For m a t
When a point status is obtained the FieldServer will, by default, write one byte of data to a Data Array. The byte will contain
the following information. Ensure that the funcion of the Data Array Type used is not Bit..
State or Bit Store options can be chosen using the Node_Option Parameter. The value provided depending on the option
chosen is shown in the appropriate column in the Data Array.
Appendix A.2. SHOW Function Attributes and Attribute States
The Show command provides an ASCII response formatted for printing. The driver parses these messages and converts the
data to numbers which can be sent to Client devices using another protocol.
The driver performs the following tasks in analyzing the response.
On a line by line basis from the left, it searches for an attribute against a table of attribute strings. If an attribute string is
found, processing continues. Otherwise the line is discarded.
The attribute number is used to determine the array location where the attribute state/value will be stored. The attribute also determines the state/value extraction method.
Method 1: The driver compares the remainder of the line against a table of attribute states. The value of the
attribute state is stored in the array location determined by the attribute,
Method 2: The driver looks for (up to three) analog values separated by forward slashes. Method 3: The driver looks for analog values preceded by an equal sign.
The driver stores in the first array location the number of response lines which resulted in attribute data being stored.
This information can be used for troubleshooting.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 18 of 48
Attribute
Array
Position
Method
Not Defined
0 1 PRIMARY STATUS
1 1 PHYSICAL STATE
2
1
RAW STATE
3
1
ACTIVE STATE
4 1 ARMED STATE
5 1 ENABLED STATE
6 1 UNVERIFIED
7
2
CURRENT DEVICE
8
1
DEVICE
9 1 TEST STATE
10 1 PRESENT SENSITIVITY SELECTED=
11
2
PRESENT SENSITIVITY SELECTED =
11 2 AVERAGE VALUE =
14
3
AVERAGE VALUE=
14 3 AVERAGE =
14 2 AVERAGE=
14
2
AVERAGE
14
2
VALUE =
17 2 VALUE=
17 2 PEAK=
20 2 PEAK =
20
2
TROUBLE THRESHOLD
23
1
OUTPUT STATE
24 1 OUTPUT STATUS
25 1 DETECTOR SOUNDER
26
1
Attribute
Array
Position
Method
ALARM TEMPERATURE SELECTED=
27 2 DETECTOR RELAY
30 1 TOTAL NUMBER OF TROUBLES
31
2
NODE MISSING
32
1
VERSION CONTROL
33 1 NODE INITIALIZATION IN PROGRESS
34 1 SIMPLEX SERVICE MODE
35 1 EARTH GROUND
36
1
AC POWER
37
1
BATTERY LOW/DISCHARGED
38 1 BATTERY CHARGE
39 1 SYSTEM PSEUDO STATUS
40
1
NETWORK CARD STATUS
41 1 CARD TROUBLE STATUS
42
1
MISCELLANEOUS STATUS
43 1 RELAY STATUS
44 1 PRIORITY
45
2
CONTROL STATUS
46
1
CURRENT (AMPS)
47 2 CARD MISSING/FAILED
48 1 CORRECT CARD
49 1 RS-232 Interface PORT A
40
1
RS-232 Interface PORT B
41
1
2120/RS-232 PORT Broadcast Fail
42 1 CARD MISSING/FAILED
43
1
Appendix A.2.1. Ta ble of Attr i b u t es recogn is e d b y t h e Driver
The following table reports the attributes recognized by the driver. This list may be extended by changing the configuration.
Refer to Appendix A.3 for more information. If, for example, the attribute ‘ENABLED STATE’ is recognized then the state of
this attribute will be stored at array location 6.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 19 of 48
Attribute State
Value
AUTOMATIC CONTROL
1
OUTPUT NORMAL
2
SELF TEST NORMAL
3
CORRECT DEVICE
4
PRIORITY 15
5
RANGE NORMAL
6
ALARM
7
SHORT
8
SHORT
9
ARMED
10
ENABLED
11
ON-LINE
12
ENABLED
13
NORMAL
14
TROUBLE
15
OFF
16
ON
17
0
Appendix A.2.2. Attribute Sta t e s recognised f o r A t tribute M et h o d 1
The table below reports the attribute states recognized for attribute method=1.
Examples:
PHYSICAL STATE SHORT
The Driver recognizes ‘Physical State’ as attribute 2 and uses method 1 to evaluate the rest of the line. The attribute state
SHORT has a value of 8. The number 8 is stored at location 2 in the Data Array.
VALUE=77 / 0% OF ALARM / 1.0% SMOKE
The Driver recognizes ‘VALUE=’ as attribute 17 and uses method 2 to evaluate the rest of the line. The Driver stores the
values; 77, 0 and 1.0 in three consecutive locations starting at location 17. Note that there is a gap between attribute 17 and
the next attribute in the table sufficient for storing up to 3 values. The three values are seperated by slashes.
AVERAGE VALUE=75 / ALARM LEVEL=145
The Driver recognizes ‘AVERAGE VALUE’ as attribute 14 and uses method 3 to evaluate the rest of the line. The Driver stores the values; 75 and 145 in two consecutive locations starting at location 14. An equal sign ‘=’ precedes each numeric value.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 20 of 48
Column Title
Function
Legal Values
Protocol
Specify protocol used
Sim4100
sim4100_Attr_Name
The SHOW command response consists of a number of
attributes and their current state/values. This parameter
is used to add a new attribute to the table.
The exact character
sequence must be
specified. May include an
= sign.
sim4100_Attr_Offset
This parameter defines the offset in the Data Array where
the current state/value of the attribute with the name
defined above must be stored. Ensure there is sufficient
space for attributes with multiple values.
May not be zero.
sim4100_Attr_Method
This parameter selects the method for converting the
current state/value for storage in the Data Array.
1,2,3
May not be zero.
Column Title
Function
Legal Values
Protocol
Specify protocol used
Sim4100
sim4100_Attr_State_Name
Use this parameter to extend this list of
predefined attribute states.
Define a state word such as ‘Normal’ and associate
a value using the ‘value’ parameter.
sim4100_Attr_State_Value
This parameter is the value to be
associated with the ‘name’
May not be zero.
Driver_Table
sim4100_Attr_Name
, sim4100_Attr_Offset
, sim4100_Attr_Method
, Protocol
BROKEN
, 30
, 1
, sim4100
FIXED
, 31
, 1
, sim4100
LIGHT STATE
, 32
, 1
, sim4100
Driver_Table
sim4100_Attr_State_Name
, sim4100_Attr_State_value
, Protocol
DIM
, 40
, sim4100
BRIGHT
, 41
, sim4100
Attribute States.
Use values that are not allocated to the predefined list of states.
Protocol must
be defined on
every line.
Protocol must
be defined on
every line.
Keyword starts a
new section of the
CSV file.
Attribute Definitions. The
name will be stripped of
all spaces between the
last character and the
comma.
Ensure that unique
offsets are
allocated.
Use a digit. The three
methods are
described above.
Appendix A.3. Extending the List of Show Attributes
The list of attributes and attribute states that the driver recognizes can be extended by modifying the configuration CSV file.
Appendix A.3.1. ShowRespon s e A t t ributes Dri v e r T a b le
Appendix A.3.2. Show Respon s e A t t ribute S tates Driv er T a b le
The following example adds three attributes and 4 attribute states. If a device reports an attribute of ‘LIGHT STATE’ as
‘BRIGHT’ then the driver will load array element 32 with the value 41.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 21 of 48
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, sim4100_card
, sim4100_point
, sim4100_Sub
, Length
Clear_Mapdesc1
, DA_AI
, 0
, Passive
, Node_A
, ClearAll
, 1
, 2
, 3
, 100
Clear_Mapdesc1
, DA_2
, 50
, Passive
, Node_A
, ClearAll
, 1
, 2
, 3
, 50
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Length
, Scan_Interval
, sim4100_func
, sim4100_card
, sim4100_point
, sim4100_sub
A1
, DA_AI3
, 0
, Rdbc
, Node_A
, 1
, 5
, Clist
, 1
, 2
, 3
Two different arrays, starting at two
different locations and with two
different lengths will get set to zero
when c-p-s=1-2-3 goes to state U1.
The sim400_func must be
ClearAll.
An Xpoint Map Descriptor must be
created for any clear all c-p-s. The clear
all logic never gets called until an Xpoint
store is done for the c-p-s configured to
do ClearAll.
The Data extracted
from the device is
placed in this driver
independent data
array.
This identifier must be
the same as the Node
Name used to identify
the port connected to
the Simplex device
being described in this
Map Descriptor.
Ignored for the Simplex
protocol unless the
sim4100_func=ackall,
clearall,
Simplex Device: Card
Perform the 'Computer List
Status' Function to (in this
case) read the current point
status of the point specified
by card-point-sub. This
function returns fire,
supervisory, trouble.... data.
The format of the returned
data is described in Appendix
A.1
The data is written
into the array
starting at this
position. A value of
zero is equivalent to
the first position.
Simplex Device: Point
Simplex Device: Sub-Point
Appendix A.4. Map Descriptor Examples
Appendix A.4.1. ClearAll
Since an Xpoint message only reports when a c-p-s goes into a non-normal state, this function is provided as a means of synchronising FieldServer to the panel
when everything is normal. The function is typically used in conjunction with pseudo-point(s) programmed into the panel. The underlying logic assumes that
the affected point(s) trigger the driver to clear sections of one or more Data Arrays when they report a state of U1
If an Xpoint message is received from the Panel for the specified c-p-s with the ClearAll function (or clist is used to poll for the state of the c-p-s) and the state
is U1, this triggers this ClearAll action. The driver sets all array points covered by all Map Descriptor’s with the clearal l function to zero, without consideration
of the c-p-s associated with the Map Descriptor.
Appendix A.4.2. Rea d Point St a t u s
This Map Descriptor can be used to poll for the status of a particular point. When the response is obtained the driver sets the value of one Data Array element
to a number indicating the point’s status. The values are described in . One Map Descriptor is required for every point polled.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 22 of 48
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, sim4100_card
, sim4100_point
, sim4100_sub
, Length
A1
, DA_AI3
, 0
, Passive
, Node_A
, xpoint
, 1
, 0
, 10
, 1000
The Data extracted
from the device is
stored in this driver
independent data
array.
Must be passive
Driver stores
data from
unsolicited
Xpoint
messages
Simplex Device: Card
All point-subpoint data
for this card are stored
using this Map
Descriptor.
Set this to zero for Xpoint
Map Descriptor.
When used with an Xpoint Map Descriptor this parameter
allocates the number of sub-points per point. In this case the
driver uses 10 array locations for each point.
Thus
Point 0: Array locations 0-9
Point 1: Array location 10-19
Point 2: Array locations 20-29 …
E.g. If the Xpoint message is for 1-1-0 then the state will be
stored at location 10.
If the Xpoint message is for 1-2-5 then the state will be
stored at location 25.
Appendix A.4.3. Using unsoli c i t e d messages f r o m t h e Panel to d e t e rmine point st a t u s
This Map Descriptor can be used to store point status data when the FieldServer receives an unsolicited message from the Panel containing point status
information (Xpoint messages). The panel sends an Xpoint message each time a point’s status changes to a non-normal state. Using these Map Descriptors
will ensure that the FieldServer is constantly updated with the latest panel status information. The Map Descriptor’s are pa ssive so they can be used in a joint
strategy with the clist function (Appendix A.3.1) to keep track of a point’s status.
One Xpoint Map Descriptor is required for storage of Xpoint messages from each card. For a given card, the driver uses a mapping function based on the pointsubpoint address to determine the array location to store the state for the c-p-s.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 23 of 48
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, Scan_Interval
, Length
AckAll_Mapdesc
, DA_ACKALL
, 0
, Wrbx
, Node_A
, AckAll
, 1.0s
, 6
2nd – ack
A
Primary Abnormal State
3rd – ack
F
Fire alarm
4th – ack
P
Priority 2
5th – ack
S
Supervisory
6th – ack
T
Trouble
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Length
, Scan_Interval
, sim4100_Func
, Sim4100_Card
, Sim4100_Point
, Sim4100_Sub
Ack_mapdesc1
, DA_ACK
, 0
, Wrbx
, Node_A
, 1
, 1.0s
, Ack
, 1
, 2
, 3
Ack_Mapdesc2
, DA_ACK
, 1
, Wrbx
, Node_A
, 1
, 1.0s
, Ack
, 1
, 2
, 4
Bit 0:
F
- Fire Alarm Panel
Bit 1:
P
- Priority 2 alarm state
Bit 2:
T
- Trouble State
Bit 3:
S
- Supervisory State
Bit 4:
U
- Utility Monitor
Bit 5:
C
- Control State
Bit 6:
D
- Disable Trouble State
Bit 7:
A
- Primary Point
The function is Wrbx, the message is only sent when
the value is updated.
Appendix A.4.4. Acknowledge A l l P o ints
The ackall function can be used to ack all points or all points that are in a particular state. Each time the driver uses th is Map Descriptor, it checks the data in the Data
Array. If a location is non-zero then the appropriate Ack message is sent to the panel.
The 1st element of the Data Array is used to trigger the ack all
Set the array element to 1 to initiate the command. The FieldServer clears the value on completion
Appendix A.4.5. Acknowledge a s p e cific point
One Map Descriptor is required for each c-p-s combination requiring specific acknowledgements. The driver checks the array location corresponding to the Map
Descriptor. If the value is non-zero then an ack message is sent. The value is used to determine what kind of ack is sent.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 24 of 48
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, Scan_Interval
, Length
Silence_Mapdesc
, DA_TRIGGERS
, 0
, Wrbx
, Node_A
, Silence
, 1.0s
, 6
Reset_Mapdesc
,DA_TRIGGERS
, 1
, Wrbx
, Node_A
, Reset
, 1.0s
, 6
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, sim4100_func
, sim4100_card
, sim4100_point
, sim4100_Sub
, Length
Clear_Mapdesc1
, DA_I
, 0
, passive
, Node_A
, Ack
, 1
, 2
, 3
, 100
Clear_Mapdesc1
, DA_2
, 0
, passive
, Node_A
, Ack
, 1
, 2
, 3
, 100
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Length
, Scan_Interval
, sim4100_Func
, Sim4100_Card
Earth_mapdesc1
, DA_EARTHS
, 0
, Rdbc
, Node_A
, 20
, 1.0s
, Earths
, 1
If location 0 goes non-zero then a silence message is sent. If location
1 goes non-zero then a reset message is set.
Driver’s set the trigger back to zero once the message has been set.
Two different arrays, starting at two
different locations and with two
different lengths will get set to zero
when c-p-s=1-2-3 goes to state U1.
If 1-2-3 or 1-2-4 go to state U1 then the
Data Array regions associated with both
Map Descriptors are set to zero.
The function is Wrbx, the message is only sent when
the value is updated.
Appendix A.4.6. Silence / Re s e t
Note: When configured as a Server, the driver increments the value in the associated DA element each time a silence/reset is received.
Appendix A.4.7. Earths
This function is only available for panel firmware versions 10.0 and later. This function reads earth / ground status information from the panel.
If, for example, card 3 reports information then the driver uses array elements 6 & 7 to store information for this card. Obtain the array location by multiplying the
card number by two.
If the card reports positive and negative earth data then the driver stores the positive earth data at location 6 and the negative earth data at location 7. If the card reports earth / ground state information without the keywords ‘Positive’ or ‘Negative’ the driver stores the data at location 6. The driver stores a value of 1 to report normal and a value of 2 to report abnormal.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 25 of 48
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Length
, Scan_Interval
, sim4100_Func
, Sim4100_Card
, Sim4100_Point
, Sim4100_Sub
Show_mapdesc1
, DA_SHOW
, 0
, Rdbc
, Node_A
, 100
, 1.0s
, Show
, 1
, 2
, 3
Appendix A.4.8. Show
One Map Descriptor is required for each point whose attributes you wish to ‘show’. The show function reads data that describe s the attributes and the state of each
attribute for a single device. Every type of device has a different set of attributes. When the response is received by the driver, it fills a number of Data Array locations
with numeric values that represent the attributes and their states. You should reserve at least 100 array locations for each Map Descriptor by setting the length to 100.
By way of example assume that point 1-2-3 is a Heat Detector and the response to the show query is as follows
40 Character Custom Label
Mx-y-2 HEAT DETECTOR
DEVICE ADDRESS: 7-10-2 TYPE: COMBO
IDNET INTERFACE CARD
LOCAL UNIT – MAIN PANEL
UNIT NUMBER: 0 RUI NUMBER: LOCAL
---------------------------------------PRIMARY STATUS NORMAL
CURRENT DEVICE CORRECT DEVICE
DEVICE ON_LINE
TEST STATE SELF TEST NORMAL
ALARM TEMPERATURE SELECTED= 135 DEG F
VALUE=0 / -41 DEG F
PEAK=0 / -41 DEG F
TROUBLE THRESHOLD RANGE NORMAL
ENABLED STATE ENABLED
UNVERIFIED 0
The driver will load the array DA_SHOW starting at offset zero for up to 100 elements. The following table can be used to determine the values to expect for this
response.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 26 of 48
Array
Posn
Attribute
Value
Filled
In4
Note
0
Not Defined
10
1
The value 10 represents the count of the number of attributes that were extracted from the response. It is not equal to the number of array
locations filled in because some attributes (e.g. Value) result in more than one array location being updated.
1
PRIMARY STATUS
14 (Normal)
1
#
2
PHYSICAL STATE
The un-filled-in locations are not updated by the driver when this response is analysed because the attributes corresponding to these
locations were not reported in the response to the query.
3
RAW STATE
4
ACTIVE STATE
5
ARMED STATE
6 ENABLED STATE
11 (Enabled)
1 7
UNVERIFIED
0 1
8
CURRENT DEVICE
4 (Correct
Device)
1
9
DEVICE
12 (On_Line)
1
10
TEST STATE
3 (Self test
normal)
1 11
PRESENT SENSITIVITY
SELECTED
14
AVERAGE
17
VALUE
0 1
18 -41 1
19 Room for up two three numbers for attributes like value, peak but in this case only two values are relevant for this device
20
PEAK 0 1
21 -41 1
22 Room for up two three numbers for attributes like value, peak but in this case only two values are relevant for this device
23
TROUBLE THRESHOLD
6 (Range
Normal)
1
24
OUTPUT STATE
25
OUTPUT STATUS
26
DETECTOR SOUNDER
27
ALARM TEMPERATURE
SELECTED=
135 1
30
DETECTOR RELAY
4
Locations marked with a 1 are updated when the driver analyses this response
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 28 of 48
Network Card #
5
Network Point #
Card #
Slot #
Point #
C-P-S Address
1 5 1 0 5-1-0
2 5 1 1 5-1-1
3 5 1 2 5-1-2
4 5 1 3 5-1-3
5 5 1 4 5-1-4
..
..
Appendix A.5. Networked Panels
If two or more Simplex panels are networked together, the FieldServer can poll the information from both. The
Simplex panels will need network cards installed and programmed by Simplex to pass the points to the panel
connected to the FieldServer. The points from the networked panel(s) will be in the same Card -Point-Subpoint
format (c-p-s) as the main panel. An algorithm is used to ensure that Point Sub point numbers stay the same and
only the network card number changes. A network card with point address of 61, sub point 98, card address 5 will
show up on the panel as as 5-61-98. Network points are numbered as follows: C-1-0 is network point 1, C-1-1 is
point 2, C-1-2 is point 3 and so on up to C-1-255 which is point 256. The sequence then starts again (C-2-0 through
C-2-255 points 257 to 512). Refer also to Appendix B.3.
The equation to calculate the network point # based off of the C-P-S is as follows:
Network Point # = ((<P> - 1) * 256) + <S> + 1
Example:
Appendix A.6. Synchronizing the FieldServer with the Panel
Appendix A.6.1. Using the Xpo i n t Function
When using the Xpoint function to store point states, each time the panel does a warm-start it sets all point states
to normal and then starts evaluating each one. Thus, the FieldServer will receive Xpoint messages from the panel
for every point not in a normal state. The limitation of this method is that the Simplex panels do not report when a
point’s state changes back to normal. Thus to maintain the synchronization the Client device must clear the point
to zero once it has read its abnormal state, i.e. The Client device should consider the data reported by the Xpoint
function as latched data.
This way the FieldServer states will always be updated. Polling is slow and in a system with many points it may
take several minutes to update status information for all points. Thus combining this method with the use of
Xpoint Map Descriptors gives the best of both worlds. When a point changes to ‘not’ normal, then the FieldServer
gets the state change from the Xpoint function immediately and at the same time synchronization is assured by
the continuous polling.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 29 of 48
Column Title
Function
Legal
Values
sim4100_WriteThru*
Only appropriate when the sim4100_func=clist.
Controls the write through behavior of the clist function.
Onoff,
value
Store_Unsolicited*
Control the ability of ‘CLIST’ map descriptors to be used to store data from unsolicited messages. Refer also to
Appendix A.6.2
Yes, No
Appendix A.6.2. Using Clist to W r ite-Thr o u gh and Stor e p o i n t status from Unsol i ci t e d M essages
This function is only available for panel version 1.05 and above.
The ‘Clist’ Map Descriptors can
Read a point’s status Write to a point when a Write-Through is activated Store the point status when an ‘Xpoint’ unsolicited message is received from the panel.
A Write-Through occurs when a Data Array value that is normally updated by a read (Rdbc) Map Descriptor is updated by some other driver or by using the
Ruinet application. The updated value is written through the Rdbc Map Descriptor to the panel. The value is written once only each time that the Data Array
element is updated except when the value is updated by the response to the read or if the point status is updated when an uns olicited message is received
from the panel.
Ensure that the point is not a read only point and the Panel’s access level has been set appropriately.
When an unsolicited message is received from the panel it would normally be stored using a Map Descriptor with the ‘Xpoint’ function. (See section Appendix A.4.3) However, if polling for the status of that point using a ‘Clist’ Map Descriptor with ‘Store_Unsolicited’ set to yes then omit the ‘Xpoint’ Map Descriptor as
the ‘Clist’ Map Descriptor can be used to store the point status when it is updated with an unsolicited message. If both Map Descriptor’s are defined then the
result will be unpredictable.
A write command can be sent to a Simplex panel in one of two formats:
SET c-p-s ON/OFF (default) SET c-p-s value
Use the sim4100_WriteThru parameter in the CSV to change to the 2nd format.
Even if writing to an analog pseudo point, format 1 is suitable because enabling the point forces it to take its intrinsic value. On setting the point off it’s value is
set to zero.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 30 of 48
Appendix B. Troubleshooting
Appendix B.1. Address Errors
If the driver produces BAD_ADDRESS stats then do the following
Refer to Appendix A.4.1. and create a Map Descriptor which will save the most recent error in the Data Array
DA_ERRORS.
Alternatively, take a log, open the ASCII version of the log and look for error messages. Error 2 is the response
sent by the panel when it is polled for a point that doesn’t exist. Find the Error #2's n the log. The line which
precedes the error identifies the point being polled. Now you know the c-p-s of the invalid point, edit the
configuration and remove the MD which polls for data at that point.
Appendix B.2. Driver Limitations
Other than being able to write through a Map Descriptor where the sim4100_func=’clist’ , write throughs are
The Standard format for addressing a simplex point is c-p-s (Card-Point-Subpoint). Each of these components in
the address supports a maximum value of 255. However, when using an NDU (Network Display Unit), addresses
may be supplied in a Card-Address format where the address value is larger than 255. In these applications it is
necessary to convert the Card-Address format into c-p-s format before configuring the points in the FieldServer.
The formula used to convert between the two formats is as follows:
Card is the same for both formats.
Network Address = ((Point-1)*256) + Sub-Point + 1
Example:
Card–Address point supplied = 5-2936 - From this we deduce the card number to be 5.
Convert the value to Hex: 2936 = 0xB78
Break out the last two hex numbers for sub-point portion, and use the rest for point address:
0xB = 11 = (Point-1): 0x78 = 120 = Sub-Point + 1
Solving this equation, we get:
Point = 12 Sub-Point = 119
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 31 of 48
Appendix B.4. Simulation of the Xpoint command
The following notes apply only to FieldServer Technologies engineers.
The sim4100_func=xpoint keyword is used to parse unsolicited point status change messages sent by Simplex
devices. For simulation purposes, a Wrbc version of this function has been implemented to test the response
parsing ability of the slave portion of the driver.
Appendix B.5. Simplex Port Vectoring
The 4100 panels do not automatically send event messages ( xpoint messages) to the serial port card. An explicit
procedure called 'Port Vectoring' maps the events to the port.
If a card is moved from one hardware location to another, it maybe necessary to revector the port.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 32 of 48
Keyword
Description
Function
Ackall
This command acknowledges all card-point-sub states based on
the values found in the associated arrays.
The FieldServer watches the Data Array to see if we need to
send an ack.
DA element
Accepted
1st – ack all
2nd - ack A
primary abnormal state
3rd – ack F
Fire alarm
4th – ack P
Priority 2
5th – ack S
Supervisory
6th – ack T
Trouble
7th – ack C
Control
Set the array element to 1 to initiate the command. The
FieldServer clears the value on completion.
WRBC
Do not specify c-p-s in the Map Descriptor.
Ack
This command allows the user to acknowledge a single point.
The specified Data Array is inspected and the value of the single
element is used to determine which device state's are ack'd.
Refer to Appendix A.4.5
WRBC
Specify c-p-s in the Map Descriptor.
Clist
This command returns the current point status for one point.
Refer to Appendix A.6.2
RDBC
Specify c-p-s in the Map Descriptor.
Earths5
This function obtains earth/ground status information from the
panel. Two Data Array elements are used to store the normal
(=1) or abnormal (=2) for each card. The first element is for the
positive ground and the second element is the negative ground.
Where cards do not report both, the first element of the pair is
used.
The array position is obtained by multiplying the card number by
two and adding the offset specified in the Map Descriptor. Set
the length of this Map Descriptor to twice the value of the
maximum card number.
RDBC
Do not specify c-p-s in the Map Descriptor.
Value
Stores analog value(s) read from a particular devicewithout
scaling or units. When more than one value is reported the
driver stores the values in consecutive array elements. Ensure
that the Map Descriptor’s usage of the Data Arrays is spaced
appropriately.
RDBC
Specify c-p-s in the Map Descriptor.
5
Appendix C. Reference
Appendix C.1. Simplex Address Formatting – Specific Keywords
The Simplex Time Recorder Company - 4100 Computer Port Protocol only uses the standard 4100 address format
of <Card>-<Point>-<Sub-point>. Symbolic addressing is not supported. The following table lists keywords which
control the behavior of the FieldServer with respect to connection to a Simplex device and the permissible values
determining the type of data being read/written.
This driver function used the Simplex ‘CSHOW c-p-s CVAL’ command. It is only supported by panels with firmware revision numbers greater
than 10
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 33 of 48
Keyword
Description
Function
Show
Each type of Simplex device reports a different set of attributes
and attribute states/values. Refer to Appendix A.2.1 for more
information. The driver analyses the response from the poll.
When an attribute is recognized, the attribute state is evaluated.
If this is recognized then the driver stores a value, corresponding
to the attribute state, at an array location corresponding to the
attribute. Appendix A.2 provides additional information. The
driver can only recognize attributes and attribute states that it is
programmed to recognize.
The length of the Map Descriptor must be set equal to the array
position of the highest attribute.
Ensure that Map Descriptors using this function do not use
overlapping areas of the Data Arrays. See example in Appendix
A.4.8.
RDBC
Specify c-p-s in the Map Descriptor.
Setd
This command allows the user to manipulate the status and/or
priority of a control point
The port access level must be set appropriately in the Simplex
device otherwise the device returns an error.
WRBC
Specify c-p-s in the Map Descriptor.
Seta
This command allows the user to:
Manipulate the status and/or priority of a control point
Modify the value of an analog pseudo point.
Set the sensitivity of a TrueAlarm sensor
Set the rate-of-rise threshold of a TrueAlarm heat sensor
Select the audio channel of a speaker circuit
WRBC
Specify c-p-s in the Map Descriptor.
Xpoint
This is an unsolicited message sent automatically by a Simplex
device to report a change in point status. The card-point-sub
address format is used to calculate an offset into the associated
Data Array as described in Appendix A.1. The state being
reported determines the value being written into the Data
Array. Refer to Appendix B.4 for more information..
Passive
Specify c-p-s in the Map Descriptor.
Disable
Not Implemented
Restart
Not Implemented
Time
This command sets and displays the time and date in "user"
format.
As a command it sets the hour minute second of the Simplex
device by getting the values from the Data Array associated with
the Map Descriptor. The first element contains the hour, the
second the minute and the third contains the second. A 24 hour
clock is assumed.
As a query, the data is unpacked into the Data Array in the
format described above.
RDBC (Query) or WRBC (Set)
Do not specify c-p-s in the Map Descriptor.
Ctime
As a command it sets the hour minute second of the Simplex
device by getting the values from the Data Array associated with
the Map Descriptor. The first element contains the hour, the
second the minute, the third element contains the second, the
4th contains the day of the week, the 5th contains the month,
the 6th contains the day of the month and the 7th element of
the array contains the year (value 01 indicates 2001). A 24 hour
clock is assumed.
RDBC (Query) or WRBC (Set)
Do not specify c-p-s in the Map Descriptor.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 34 of 48
Keyword
Description
Function
As a query, the data is unpacked into the Data Array in the
format described above.
Silence
Used to send a silence signal to the Simplex device. This is a
triggered command. When the element in the Data Array
associated with the Map Descriptor is set to 1 then the
command is sent to the Simplex device. The driver will set the
value to zero when the command has been acknowledged.
WRBC
Do not specify c-p-s in the Map Descriptor.
Reset
Used to send a reset signal to the Simplex device.
This is a triggered command. When the element in the Data
Array associated with the Map Descriptor is set to 1 then the
command is sent to the Simplex device. The driver will set the
value to zero when the command has been acknowledged.
WRBC
Do not specify c-p-s in the Map Descriptor.
Revision
Used to request revision information from the Simplex panel.
Use of this Map Descriptor is recommended as it allows the
driver to generate a warning if an unknown Simplex revision is
encountered.
Make sure that the length of the Map Descriptor is sufficient to
store all the revision information. A Length of 200 is
recommended.
RDBC
Do not specify c-p-s in the Map Descriptor.
Errors
Use this keyword to define a Map Descriptor which tells the
driver where to store error messages received from the Simplex
device. The most recent message is stored in the Data Array
specified. Make sure that the Data Array length is long enough
to store enough meaningful information. A length of 200 is
recommended.
Passive
Do not specify c-p-s in the Map Descriptor.
If using RUINET to monitor the FieldServer,
display the Data Array associated with this
Map Descriptor in ‘String’ format so that
you can read the error message easily. The
driver appends information about the Map
Descriptor which generated the error to
make the error more easily
understandable.
ClearAll
Map Descriptor’s which use this function do two things;
Firstly, they register a c-p-s with the driver.
Secondly they define a Data Array name and element range that
must be set to zero when the ClearAll function is activated.
Up to 4 c-p-s’s may be registered per FieldServer. These
registered points are monitored each time a Clist response is
obtained as well as each time the panel sends an unsolicited
Xpoint message with a state change. If one of these messages
reports a ‘U1’ state for a registered point then the driver
processes all ‘ClearAll’ Map Descriptor’s and sets all the
associated array values to zero.
An example of the use of ClearAll is provided in section 6.12
example 9.
Passive
Specify c-p-s in the Map Descriptor (but
read the notes on the left)
Warm_Start
Generates a warm restart message.
Used for simulation only.
Cold_Start
Generates a cold restart message.
Used for simulation only.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 35 of 48
Error Message
Description
Sim4100:#1 <card><point><sub> invalid for ack.
Read manual.
c-p-s is being used to derive an array offset. The calculation requires
division by the point & the sub and one or both of these values are zero.
Sim4100:#2 RTS has been asserted for too long.
Extend timer, check cable uses RTS/CTS or
reconfig 4100 device to suppress hardware
handshaking
If RTS-CTS handshaking has been used then this message is produced if
the driver finds that the RTS has been asserted by the slave device for too
long. The timeout is hard coded at 2.0s.
Sim4100:#3 sim4100_chan_init() Init with null
chan.
Requires support from FieldServer Technologies.
Sim4100:#4 Unknown sim4100_func in csv
<nnn>
The driver has found a value for a sim4100_func keyword that it does not
recognize. Check the CSV file and read Appendix C.1of this manual for a
list of legal keywords.
Sim4100:#5 Use Ackall function.
The sim4100_func keyword has been assigned the value 'ack' but a cardpoint-sub has not been specified. Use the ackall function.
Sim4100:#6 ack/ackall/seta/setd must be a
write.
You cannot use the rdbc function with these keywords. Use a wrbc
instead.
Sim4100:#7 disable/restart/list not implemented
Please contact FieldServer Technologies if you would like this feature
implemented.
Sim4100:#8 Func=Clistall/Clist, wrbc not allowed
These keywords must be used with a Rdbc
Sim4100:#9 Write ack was not expected.
Please report this error to FieldServer Technologies.
Sim4100:#10 Invalid point status
<s><v><a>=(Hex)<%x><%x><%x> <%c><%c><%c>
Please report his message to FieldServer Technologies noting the values
in braces.
Sim4100:#11. Error. Array too short. rqd= %d(
max= %d) act= %d. MapDesc= <%s> Data
Abandoned! Subsequent msgs suppressed!
Check the CSV file Data Array lengths.
Sim4100:#12 Error.
Incoming data is being abandoned.
Subsequent message supressed!
Check the CSV file; there was no matching Map Descriptor for a message.
Sim4100:#13 FYI. Login Function not
Implemented.
Please contact FieldServer Technologies if you would like this feature
implemented.
Sim4100:#14 MD=%s Addr=%d
A write thru is defined as follows. The FieldServer reads data from a
device and stores it in a Data Array. If a remote device changes the value
in that Data Array, the FieldServer will write the new value to the device
that is being read. This driver does not permit write thru's except when
the data is being updated using CLIST. Refer also to Appendix A.4.3 and
Appendix A.6.2. In versions of the driver up to and including 1.07a a
panic is produced when this message is printed. The message is printed
to a maximum of 10 times and then suppressed.
SIM4100:#15 FYI. Incoming abandoned. No Map
Desc.
Check the CSV file; there was no matching Map Descriptor for a message.
SIM4100:#16 FYI. No Map Desc. Respond with
Error.
If the server can’t find a matching MD (i.e. the point being polled for
doesn’t exist) then the driver responds with Simplex Error #2.
SIM4100:#17 FYI. Incoming Abandoned. No Data.
Check the driver manual and Simplex User Manuals. There is no driver
response to the message received.
SIM4100:#18 FYI. Incoming Abandoned. (%d)
Please report his message to FieldServer Technologies noting the values
in braces.
Sim4100:#19a FYI. Sim4100 Firmware found
(%.2f)
No corrective action is required on your part. The message is printed for
information only.
Message ‘a’ is printed when version 9 firmware is found in the panel.
Appendix C.2. Error Messages
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 36 of 48
Error Message
Description
Message ‘b’ is printed when version 10 firmware is found in the panel.
Message ‘b’ is printed when version 11 firmware is found in the panel.
Sim4100:#19d FYI. Panel Firmware Rev %.2f may
be incompatible.
The firmware version found is not one that the driver explicitly supports.
This does not mean the driver will not work but if a feature of the driver
isn’t working correctly knowing that the firmware version is not
supported may help diagnose the problem more easily.
No corrective action is required on your part. If however, some you
suspect that the driver is not operating correctly it is important that you
mention seeing this message in the Error Buffer when reporting the
problem.
Sim4100:#19e FYI. Panel Firmware may be
incompatible.
The format of the firmware version information could not be interpreted
correctly. This may mean that your panel has a firmware version that is
not one that the driver explicitly supports. This does not mean the driver
will not work but if a feature of the driver isn’t working correctly knowing
that the firmware version is not supported may help diagnose the
problem more easily.
No corrective action is required on your part. If however, some you
suspect that the driver is not operating correctly it is important that you
mention seeing this message in the Error Buffer when reporting the
problem.
Sim4100:#20 FYI. Data abandoned! Array too
short. MapDesc= <%s>
Check the CSV file Data Array lengths.
Sim4100:#21. Error. Data abandoned! Array too
short c-p-s= %d-%d-%d
Check the CSV file Data Array lengths.
Sim4100:#22. FYI. Polling Inhibited.
Polling is disabled until the port supervision message has been received.
This message can be safely ignored. When the panel sends unsolicited
messages to the FieldServer this message is printed. Polling remains
inhibited until the unsolicited message stream end.
Sim4100:#23. FYI. Polling Enabled
When a stream of unsolicited messages is received from the Simplex
panel then polling is inhibited until the stream ends. When the stream
ends this message is printed. It may be safely ignored.
Sim4100:#25. Error. Data abandoned! Array too
short c-p-s= %d-%d-%d
Check the CSV file Data Array lengths.
Sim4100:#26 FYI. Data abandoned! Array too
short.(%d) MapDesc=<%s>
Check the CSV file Data Array lengths.
Sim4100:#27. FYI. Sequence Number reset
requested & done.
Sim4100:#28. Error. Bad Sim4100_Func=%d in
MD=<%s>
Check the CSV file and driver manual for valid Simplex functions.
Sim4100:#29. FYI. Length changed to 1 in
MapDesc= <%s>
Check the CSV file for the correct Map Descriptor function type.
Sim4100:#30. FYI. Length changed to 1 in
MapDesc= <%s>
Check the CSV file for the correct Map Descriptor function type.
Sim4100:#31. FYI. Length changed to 1 in
MapDesc= <%s>
Check the CSV file for the correct Map Descriptor function type.
Sim4100:#32. FYI. Sequence number semi-reset.
Sim4100:#33. Error. Invalid Seq Number.
Message sequence numbers incorrect. Check Simplex User Manuals, and
driver manuals. Contact FieldServer Technologies for additional support.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 37 of 48
Error Message
Description
Sim4100:#34. Bad Seq. Sequence number reset.
Message sequence number incorrect. Check Simplex User Manuals, and
driver manuals. Contact FieldServer Technologies for additional support.
Sim4100:#36. FYI. Bad sim4100_func=%d in
MapDesc=<%s>
Check the CSV file for the correct Simplex function type.
Sim4100:#38. FYI. Bad sim4100_func=%d in
MapDesc=<%s>
Check the CSV file for the correct Simplex function type.
Sim4100:#39 FYI. Data abandoned! State not
recognized. Mapdesc=<%s>
Attribute was found, but State not found in driver table. Contact
FieldServer Technologies for additional support.
Sim4100:#40 FYI. Data abandoned! Array too
short.(%d) Mapdesc=<%s>
Check the CSV file Data Array lengths
Sim4100:#41 FYI. Data abandoned! Array too
short.(%d) Mapdesc=<%s>
Check the CSV file Data Array lengths
Sim4100:#43. Err. Can only monitor %d point(s)
for ClearAll
Contact FieldServer Technologies for additional support.
Sim4100:#44 FYI. ClearAll mapDesc's must be
passive
Map Descriptor function has been changed automatically
Sim4100:#45 FYI. User added SHOW
attribute=<%s> offset=%d method=%d
Sim4100:#46 Err. No space. Driver rejects SHOW
attribute=<%s> offset=%d method=%d
No space is available in internal driver table. Contact FieldServer
Technologies for additional support.
Sim4100:#47 Err. Duplicate. Driver rejects SHOW
attribute=<%s> offset=%d method=%d
Duplicate found in internal driver table. Contact FieldServer Technologies
for additional support.
Sim4100:#48 FYI. User added SHOW attr
state=<%s> value=%d
Sim4100:#49 Err. No space. Driver rejects SHOW
attr state=<%s> value=%d
No space is available in internal driver table. Contact FieldServer
Technologies for additional support.
Sim4100:#50 Err. Duplicate. Driver rejects SHOW
attr state=<%s> value=%d
Duplicate found in internal driver table. Contact FieldServer Technologies
for additional support.
sim4100:#51 Err. Length must be specified and >
0.
Check the CSV file for the length fields.
SIM4100:#52 FYI. Incoming Abandoned. Node
offline
Check the CSV file for node definitions, Simplex hardware, and
connections. A device node appears to be offline. Contact FieldServer
Technologies for additional support.
Sim4100:#53. Md=<%s> Abandoned. Polling was
inhibited.
Obsolete. Contact FieldServer Technologies for support.
Sim4100:#54. Err. SeqNumber check disabled.
Sequence number checking was disabled. Check your password. Contact
FieldServer Technologies for support.
Sim4100:#55. Error. Bad Sim4100_Func=%d in
MD=<%s>
Check the CSV file for the correct Simplex function type.
Sim4100:#56
The driver ignored Login messages. No corrective action is required. This
message is printed for your information only.
Sim4100:#58 FYI. You could have used an Array
called <%s> to expose diagnostic info.
This message is printed for your information only. It can safely be
ignored. For additional information read section “Appendix C.3.2 Driver
Exposed Stats”
Sim4100:#59 Err. Checkpoint. Report this to Tech
Support.
An internal driver diagnostic has been triggered. You must report this
error to FieldServer’s Technical Support.
Sim4100:#60 Err. MapDesc=%s. No Node.
Every Sim4100 Map Descriptor must be connected to a node. Ensure that
the parameter ‘Node_Name’ has been specified on the Map Descriptor.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 38 of 48
Error Message
Description
To correct this problem, edit the CSV, make the correction, download the
corrected CSV file and reset the FieldServer.
Sim4100:#61 Err. PLC_Type=4100u rqd for
'values'/'earths'
If you have a Map Descritor which has the sim4100_func parameter set to
‘earths’ or to ‘values’ then you must set the PLC_Type parameter on the
node to 4100U. (See section 0
Client Side Node ). It is only appropriate to do so if the firmware version
of your panel is 10.x or later. You can create a map descriptor to read the
version information if you are not sure. You can also use the menu
system on the Panel to read the version number.
To correct this problem, edit the CSV, make the correction, download the
corrected CSV file and reset the FieldServer.
Sim4100:#62 Err. Input Buffer Overflow.
This message is printed when the input buffer overflows. This usually
occurs when the panel sends lots of messages and they are not being
processed by the driver fast enough. A panic is printed immediate after
this message.
The driver will clear the buffer and start capturing new bytes as they
arrive. Messages may have been lost. We advise that you re-synch the
panel.
This error has only been seen once. It occurred when a panel was
connected to the driver with the wrong connection settings.
Appendix C.3. Driver Stats
Appendix C.3.1. H o w t h e Driver cou n t s b y tes and m e s s a g es received a n d t r a n smitted.
"Ack" messages sent/received by the driver in response to read/write messages are NOT counted as messages.
However, the single byte produced by these messages is included in the byte count.
The driver does not count DLL layer messages as messages.
The driver counts bytes at the DLL layer. The byte count includes the bytes that wrap application layer messages,
acks and the port supervision and responses messages.
The driver counts messages at the application layer.. This means that if you use RUINET to monitor the FieldServer
and you view the Map Descriptor’s the byte count stats will always be zero.
Some Map Descriptors require data in the Data Arrays to trigger a write command. An example is the "Ack"
command. The driver does not count one of these messages as being sent until the array actually triggers a poll to
be sent.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 39 of 48
Data_Arrays
Data_Array_Name
, Data_Format
, Data_Array_Length
sim4100-stats
, UINT16
, 1000
Stat #
Stats
Description
10
SIM4100_STAT_XPOINT_CARD
The Card in c-p-s from most recent xpoint store
11
SIM4100_STAT_XPOINT_POINT
The Point in c-p-s from most recent xpoint store
12
SIM4100_STAT_XPOINT_SUB
The SubPoint in c-p-s from most recent xpoint store
13
SIM4100_STAT_XPOINT_QUALIFIER
The Qualifier from most recent xpoint store
14
SIM4100_STAT_XPOINT_QUALIFIER_AS_ENUM
The Qualifier from most recent xpoint store, stored as an
enumeration – See Note1 for bit states
15
SIM4100_STAT_XPOINT_STATE
The reported state from most recent xpoint store. State
value: 0 FALSE/Normal 1 TRUE/Abnormal
16
SIM4100_STAT_XPOINT_ACK_STATE
The reported ack state from most recent xpoint store. Ack
state: *=needs ack, -=acked (always "-" for U or C states)
17
SIM4100_STAT_XPOINT_HOUR
The Time from most recent xpoint store
18
SIM4100_STAT_XPOINT_MIN
The Time from most recent xpoint store
19
SIM4100_STAT_XPOINT_SEC
The Time from most recent xpoint store
20
SIM4100_STAT_XPOINT_DOW
The Date from most recent xpoint store
21
SIM4100_STAT_XPOINT_DAY
The Date from most recent xpoint store
22
SIM4100_STAT_XPOINT_MONTH
The Date from most recent xpoint store
23
SIM4100_STAT_XPOINT_YEAR
The Date from most recent xpoint store
24
SIM4100_STAT_XPOINT_COMBO_STATE_OLD
A single point could potentially be active in more than one
state simultaneously. The driver tracks the combine state by
building a UINT whose bits indicate the state. This is the
combo state before the update. See Note 1 for bit states.
25
SIM4100_STAT_XPOINT_COMBO_STATE_NEW
A single point could potentially be active in more than one
state simultaneously. The driver tracks the combine state by
building a UINT whose bits indicate the state. This is the
combo state after the update. See Note 1 for bit states.
Appendix C.3.2. D r i v e r E xposed Stat s
The driver is capable of exposing statistics about its behavior in a Data Array. It is necessary to create a Data Array
with name sim4100-stats as per the example below and it will be updated by the driver. Note that the stat
number corresponds to the offset.
Take care not to poke any values into the 1st 10 elements of this Data Array (offsets 0 to 9). Doing so will trigger
internal diagnostics and may interfere with normal operation.
A different set of stats is maintained for each connection. Each connection uses 100 elements of the data array.
Ensure the array length is large enough if the port number is large.
At revision 1.07a of the driver and earlier, no stats had been exposed.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 40 of 48
Qualifier:
Enum=0 Qual=F Fire alarm state
Enum=1 Qual=P Priority 2 alarm state
Enum=2 Qual=T Trouble state
Enum=3 Qual=S Supervisory state
Enum=4 Qual=U Utility monitor, digital/analog pseudo state
Enum=5 Qual=C Control state (non pseudo)
Enum=6 Qual=D Disable Trouble state
Card address
Card type
0-119
Physical (Hardware) cards
128-143
Digital Pseudo cards
144-159
Analog Pseudo cards
160-175
List Pseudo cards
P0
SYSTEM RESET KEY
UTILITY
128-0-0
P1
ALARM SILENCE KEY
UTILITY
128-1-0
P2
FRONT PANEL LAMPTEST CONTROL (ANNUNC. 0)
UTILITY
128-2-0
P3
FIRE ALARM DETECT
UTILITY
128-3-0
P4
GLOBAL ACKNOWLEDGE ENABLE
UTILITY
128-4-0
P5
SET SERVICE PSEUDO VALUES
UTILITY
128-5-0
P6
ALARM SILENCE
UTILITY
128-6-0
P7
EXTRA CARD IN THE SYSTEM
TROUBLE
128-7-0
Note 1 – Bit States.
Appendix C.4. Pseudo Points
It is beyond the scope of the driver manual to describe the full functionality of the Simplex Panels. The following
information is not maintained and updated and therefore should be used for reference only.
Pseudo points are points that report states or attributes based on how the Simplex system has been installed,
configured and programmed. They are often programmed to groups, devices, zones or other logic groupings, e.g.
a pseudo point may be programmed to report only if more than one sensor in a particular area is reporting smoke.
Every Simplex system has a number of default pseudo points programmed into the firmware supplied with the
panel. These default points depend only on the firmware revision number and are generally unaffected by the
configuration programmed for a particular site.
Although the 4100 card number can range from 0-250 in theory, only the following ranges are presently used in
the system:
Appendix C.4.1. D i g i t a l Pseudo’s:
There are 250 fixed pseudo's in the 4020 panel and 511 in the 4100 and 4100U. The numbering sequence is
simple, 128 starts the first block of 256 (0 to 255), so the first point is 128-0-0, the second is 128-1-0, ... The next
block starts at 129 and follows the same sequence, then 130 and so on up to 143. In the 4100 the first user
definable pseudo is P-256, in the 4100U it is P-512.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com