FS-8700-41 Simplex 4100 Driver Manual Page 4 of 58
1. Simplex Time Recorder Company - 4100 Computer Port Protocol
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 a 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. Supported Panel Types
The driver has been tested against 4020, 4100 and 4100U panels. There is no difference in
the protocol format between the various panels. What changes is the panel firmware version
and with the firmware changes the supported function set changes.
1.2. Simplex Panel Firmware Revision vs. Supported Functionality
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.
A grid of firmware revision number and supported functions is provided by Simplex. This
grid is available from Simplex. Request the ‘CPP Revision Compatibility’ Table.
All the functions described in this manual are supported for firmware revisions 10 or higher.
For revisions between 9.2 and 10, the ‘Earths’ and ‘Value’ functions described in this driver
are not supported by the Simplex Panels. For revisions lower than 9.2, then functions
supported need to be determined by trial and error. We are fairly confident that all the
functions supported by version 9x are also supported by versions 8x of the panel firmware.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Ethernet cable with 25 pin male connector. (4100u
Panels)
2.2. Provided by Supplier of 3rd Party Equipment
To enable the 4100 Protocol, the 4100 system, supplied by the user, must have a free RS232 port dedicated for use with the computer device. In most cases, this is not included in
the base configuration of the product provided by The 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 specific product specifications, or contact a Simplex sales representative.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 6 of 58
3. Hardware Connections
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.
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.
FS-8700-41 Simplex 4100 Driver Manual Page 12 of 58
4. Configuring the FieldServer as a Simplex Time Recorder Company - 4100
Computer Port Protocol Client
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.
4.1. Data Arrays
Section Title
Data_Arrays
Column Title Function Legal Values
Data_Array_Name Provide name for Data Array Up to 15 alphanumeric characters
Specify which port the device is connected
to the FieldServer
Specify data bits
Specify stop bits 1
Specify protocol used sim4100
Time between internal polls
P1-P8, R1-R23
110 – 115200, standard baud
rates only.
Even, Odd, None, Mark,
Space
7, 8
0-32000 seconds, 1 second
4.3. Client Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name Provide name for node Up to 32 alphanumeric characters
Node_ID Ad
Protocol Specify protocol used Sim4100
Port
Specify which port the device is
connected to the FieldServer
Required for Simplex4100 Panels.
If not specified then a Simplex
4100/4020 panel is assumed.
PLC_Type*
4020/4100 - panels with firmware
version 9x or earlier.
4100U – panels with firmware
version 10x or later.
3
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
Function Legal Values
This parameter is IGNORED. Special
keywords to define the card-sub-point
are described in section 4.4
P1-P8, R1-R2
3
4100, 4020, 4100U
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
A driver table is used to extend a table of values/attributes that have been hard coded into
the driver. It is possible to extend the tables using CSV file parameters.
Additional information on the use of these tables may be found in Appendix A.8
4.4.1. SHOW Response Attributes Driver Table
Column Title Function Legal Values
Protocol
sim4100_Attr_Name
sim4100_Attr_Offset
sim4100_Attr_Method
The protocol must be specified on each row
of a driver table.
The SHOW command response consists of
a number of attributes and their current
state/ values.
Use this parameter to add a new attribute to
the table.
If the response contains the attribute defined
above, its current state/value must be stored
at offset x in the associated Data Array.
Use this parameter to define x. Take care to
leave enough space for those attributes
which have multiple values.
This parameter tells the driver how to
convert the current state/value for storage in
the Data Array. For example, the driver
cannot store the state ‘Normal’ . By
specifying method 1, you tell the driver to
use the state descriptor ‘Normal’ in a lookup
table of attribute states to find the value
associated to Normal and to store that
value.
Sim4100
The exact
character
sequence that
must be
specified. May
include an equal
sign.
May not be zero.
1,2,3
May not be zero.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 15 of 58
4.4.2. SHOW Response Attribute States Driver Table
Column Title Function Legal Values
The protocol must be
Protocol
sim4100_Attr_State_Name
sim4100_Attr_State_Value
specified on each row of
a driver table.
Use this parameter to
extend this list of
predefined attribute
states.
This parameter is the
value to be associated
with the ‘name’
Sim4100
Define a state word such as
‘Normal’ and associate a
value using the ‘value’
parameter.
May not be zero.
4.5. Client Side Map Descriptors
4.5.1. FieldServer Specific Map Descriptor Parameters
Column Title Function Legal Values
Map_Descriptor_Name
Data_Array_Name
Data_Array_Location
Function
Name of this Map
Descriptor
Name of Data Array where
data is to be stored in the
FieldServer
Starting location in Data
Array
Function of Client Map
Descriptor
Up to 32 alphanumeric
characters
One of the Data Array
names from “Data Array”
section above
0 to maximum specified in
“Data Array” section above
RDBC, WRBC, WRBX
4.5.2. Driver Specific Map Descriptor Parameters
Column Title
Node_Name Name of Node to fetch data from
Length of Map Descriptor - must always be
specified.
If the length of the response (such as errors /
Length
Address
earths, show, revision) is not known in advance it
should be set to a value large enough to store to
allow some contingency. If data cannot be stored
because an array is too short the driver will
produce a message in the error log.
Not required. The address is specified by using the card-point-sub
specification described in section 4.4.2
Function Legal Values
4.5.3. Timing Parameters
Column Title Function Legal Values
Scan_Interval Rate at which data is polled >0.1s
One of the node
names specified in
“Client Node
Descriptor” above
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
FS-8700-41 Simplex 4100 Driver Manual Page 16 of 58
4.5.4. Protocol (Simplex Device) Specific Parameters
Column Title Function Legal Values
Further notes on
these keywords
are provided in
Appendix A
A keyword which controls the function being
sim4100_func
performed or the type of data being polled /
written.
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 keywords are used to address devices.
sim4100_Card Simplex Address <Card>
sim4100_Point Simplex Address <Point>
sim4100_Sub Simplex Address <Sub_Type>
Only appropriate when the
sim4100_func=clist.
Controls the write through behavior of the
clist function. See Appendix A.20 for
sim4100_WriteThru*
additional information.
When using the default value then the write
commands are done using the format SET
c-p-s ON/OFF. If the parameter is set to
value then writes are done using the format
SET c-p-s value.
Control the ability of ‘CLIST’ map descriptors
Store_Unsolicited*
to be used to store data from unsolicited
messages. Refer also to Appendix A.20