FieldServer FS-8700-41 User Manual

Driver Version:

1.09

Document Revision:

4

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after August 2012

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-41 Simplex Time Recorder Company - 4100

Computer Port Protocol

A Sierra Monitor Company

FS-8700-41 Simplex Driver Manual Table of Contents

TABLE OF CONTENTS

1 Simplex Time Recorder Company - 4100 Computer Port Protocol .................................................................. 4

1.1 Supported Panel Types .................................................................................................................................. 4

1.2 Simplex Panel Firmware Revision vs. Supported Functionality ..................................................................... 4

2 Driver Scope of Supply ................................................................................................................................... 5

2.1 Supplied by FieldServer Technologies for this driver ..................................................................................... 5

2.2 Provided by Supplier of 3rd Party Equipment................................................................................................. 5

3 Hardware Connections ................................................................................................................................... 6

3.1 Sim4100 Panel ............................................................................................................................................... 6

3.2 Sim4100U Panel ............................................................................................................................................. 6

3.3 Connection to a Simplex 4020/4100 Panel .................................................................................................... 7

3.3.1 Communication Board ........................................................................................................................... 7

3.3.2 Serial Connection ................................................................................................................................... 7

3.4 Connection 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.1 Client Side Connection Parameters ............................................................................................................. 10

5.2 Client Side Node Parameters ....................................................................................................................... 11

5.3 Client 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.3 Card-Point-Sub Addressing Map Descriptor Parameters ..................................................................... 12

5.3.4 Timing Parameters ............................................................................................................................... 13

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.3.1. ShowResponse Attributes Driver Table .................................................................................. 20

Appendix A.3.2. Show Response Attribute States Driver Table ........................................................................ 20

Appendix A.4. Map Descriptor Examples ................................................................................................................ 21

Appendix A.4.1. ClearAll ................................................................................................................................... 21

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

Appendix A.4.6. Silence / Reset ........................................................................................................................ 24

Appendix A.4.7. Earths ..................................................................................................................................... 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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.5. Networked Panels ............................................................................................................................ 28

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.1. Address Errors .................................................................................................................................. 30

Appendix B.2. Driver Limitations ............................................................................................................................. 30

Appendix B.3. Resolving Network Addresses above 255......................................................................................... 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

Appendix C.2. Error Messages ................................................................................................................................. 35

Appendix C.3. Driver Stats ....................................................................................................................................... 38

Appendix C.3.1. How the Driver counts bytes and messages received and transmitted. ................................. 38

Appendix C.3.2. Driver Exposed Stats ............................................................................................................... 39

Appendix C.4. Pseudo Points ................................................................................................................................... 40

Appendix C.4.1. Digital Pseudo’s: ..................................................................................................................... 40

Appendix C.4.2. Analog Psuedos ...................................................................................................................... 45

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 6 of 48

Setting

Default

Options

Baud Rate

9600

75, 110, 134.5, 300, 600, 1200, 1800, 2000, 2400, 4800, 9600, 19200

Parity

EVEN1

ODD, EVEN, MARK, SPACE, NONE

Data Bits

8

7 or 8

Stop Bits

1

1 or 2

Setting

Default

Options

Baud Rate

9600

75, 110, 134.5, 300, 600, 1200, 1800, 2000, 2400, 4800, 9600, 19200

Parity

NONE1

ODD, EVEN, MARK, SPACE, NONE

Data Bits

8

7 or 8

Stop Bits

1

1 or 2

4100 Host

Cable

Computer

4100

Signal

Signal

DB25Pin

DB9Pin
Port ATB1

Port BTB2

DB25 Pin

8 1 2

TXD → RXD 2 2 6 3 3 RXD ← TXD 3 3 7 2 4 RTS 2

RTS 4 7

5 4 5

CTS CTS 5 8

4 5 7

GND

──

GND

7

5

1

2

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.

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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 7 of 48

1

4

8

FS-8917-16

FieldServer

P1

18

FS-X40
Function

From

Simplex
Panel

Terminal
Block #

Rx

RJ45-01

XMIT

6

Tx

RJ45-08

RCV 8 GND

RT45-04

GND

10

Card 4020/RS-232/2120
modem ready assembly.

Terminal Block
Port A =1-5, Port B=6-10.

3.3 Connection to a Simplex 4020/4100 Panel

3.3.1 Communication Board

3.3.2 Seria l C o nnection

Pinouts

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 8 of 48

FS-8717-07

Port B

RS-232 Card

Sim4100U Panel

FieldServer

P1

18

8917-07

FieldServer Part #

8915-10

UTP cable

Port B

Port A

Front of 4100U Panel
Pin 2 - White

Pin 3 - Blue

Pin 7 - Green

3.4 Connection to a Simplex 4100U /4100 ES Panel

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 9 of 48

Section Title

Data_Arrays

Column Title

Function

Legal Values

Data_Array_Name

Provide name for Data Array

Up to 15 alphanumeric characters

Data_Array_Format

Provide data format. Each Data Array can only take
on one format.

FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte, Packed_Byte,
Swapped_Byte

Data_Array_Length

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
// Data Arrays

Data_Arrays

Data_Array_Name

, Data_Array_Format

, Data_Array_Length

DA_AI_01

, UInt16,

, 200

DA_AO_01

, UInt16

, 200

DA_DI_01

, Bit

, 200

DA_DO_01

, Bit

, 200

4 DATA ARRAY PARAMETER S

Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary

to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data.

Example

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 11 of 48

Section Title

Nodes

Column Title

Function

Legal Values

Node_Name

Provide name for Node

Up to 32 alphanumeric characters

Node_ID

n/a

This parameter is IGNORED. Keywords used to define the
card-sub-point (c-p-s) are described in Appendix A.1

Protocol

Specify protocol used

Sim4100

Port

Specify which port the device is
connected to the FieldServer

P1-P8, R1-R2

PLC_Type*

4020/4100 - panels with firmware
version 9x or earlier.
4100U – panels with firmware
version 10x or later.

4100, 4020, 4100U
Node_Option*

Specify the point status data
format. Refer to Appendix A.1.1

State_Store, Bit_Store
// Client Side Nodes

Nodes

Node_Name

, PLC_Type

, Protocol

, Connection

Device1

, 4100U

, Sim4100

, P1

5.2 Clie n t S ide Node Parameters

Example

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Ackall, Setd, Disable, Restart, Clistall,
Clist, Time, Ctime, Ack, Xpoint, Seta,
Super, Show, Earths, Value, ClearAll

Column Title

Function

Legal Values

sim4100_Card

Simplex Address
<Card>

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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 13 of 48

Column Title

Function

Legal Values

Scan_Interval

Rate at which data is polled

>0.1s

5.3.4 Timing P arameters

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-41 Simplex 4100 Driver Manual Page 15 of 48

6 CONFIGURING 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

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]