FieldServer FS-8700-72 Secutron Modul-R Instruction Manual

Driver Version:

1.01

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-72 Secutron Modul-R

Effective for all systems manufactured after August 2008

APPLICABILITY & EFFECTIVITY

Document Revision: 8

FS-8700-72 Secutron Manual Table of Contents

TABLE OF CONTENTS

1.

SECUTRON MODUL-R DRIVER DESCRIPTION ...........................................................3

2.

DRIVER SCOPE OF SUPPLY.........................................................................................3

2.1.

Supplied by FieldServer Technologies for this driver.................................................. 3

3.

HARDWARE CONNECTIONS ........................................................................................4

4.

CONFIGURING THE FIELDSERVER AS A SECUTRON MODUL-R DRIVER CLIENT ..5

4.1.

Data Arrays/Descriptors ............................................................................................. 5

4.2.

Client Side Connection Descriptors............................................................................ 6

4.3.

Client Side Node Descriptors ..................................................................................... 6

4.4.

Client Side Map Descriptors....................................................................................... 7

4.4.1. FieldServer Specific Map Descriptor Parameters.................................................... 7

4.4.2. Driver Specific Map Descriptor Parameters ............................................................ 7

4.4.3. Timing Parameters.................................................................................................. 7

4.4.4. Map Descriptor Example......................................................................................... 8

5.

CONFIGURING THE FIELDSERVER AS A SECUTRON MODUL-R DRIVER SERVER 9

5.1.

Data Arrays................................................................................................................ 9

5.2.

Server Side Connection Descriptors ........................................................................ 10

5.3.

Server Side Node Descriptors.................................................................................. 10

5.4.

Server Side Map Descriptors ................................................................................... 11

5.4.1. FieldServer Specific Map Descriptor Parameters.................................................. 11

5.4.2. Driver Specific Map Descriptor Parameters .......................................................... 11

5.4.3. Map Descriptor Example....................................................................................... 12

APPENDIX A. ADVANCED TOPICS......................................................................................12

Appendix A.1. Event Function or Condition Codes............................................................. 12

Appendix A.2. Panel Circuit or Zone numbers.................................................................... 13

Appendix A.3. Panel Power-up, Restarts and Resets ........................................................ 14

Appendix A.4. Driver Messages, Error Messages and Optional Map Descriptors............... 14

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

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

FS-8700-72 Secutron Manual Page 3 of 15

1. Secutron Modul-R driver Description

The Secutron Modul-R driver allows the FieldServer to transfer data to and from a Client and a Server
panel on a single point to point network over RS-232 using Secutron Modul-R protocol.

The protocol is strictly command/response with the Client polling a Server device. A Server device can
report the generation and clearing of alarms to the polling Client. One panel can be connected per
FieldServer port. The driver supports networked panels connected to a single port. The server driver
only supports 10 panels due to memory limitations. A Server panel can consist of up to 100 circuits.

Whan an alarm is generated, a bit is set and when the alarm is cleared, the bit is cleared. The panel
number is identified by the Node_ID in the configuration file.

2. Driver Scope of Supply

2.1. Supplied by FieldServer Technologies for this driver

FieldServer Technologies PART # Description

FS-8917-16 Pigtail cable for RJ45 Port
FS-8700-72 Driver Manual.

.

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

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

FS-8700-72 Secutron Manual Page 4 of 15

3. Hardware Connections

The FieldServer is connected to the panels as shown below.
Configure the panels according to manufacturer’s instructions.

Connector Pinouts

RJ-45 Pin From RJ-45 To Secutron

1 Brown Tx
8 White/Orange Rx
5 Blue/white GND

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

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

FS-8700-72 Secutron Manual Page 5 of 15

4. Configuring the FieldServer as a Secutron Modul-R driver Client

For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration
Manual. The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer (See “.csv” files on the provided with the FieldServer).

This section documents and describes the parameters necessary for configuring the FieldServer to
communicate with Secutron Modul-R panels.

The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order
to enable the FieldServer for Secutron Modul-R driver communications, the driver independent
FieldServer buffers need to be declared in the “Data Arrays” section, the destination device addresses
need to be declared in the “Client Side Nodes” section, and the data required from the Servers needs to
be mapped in the “Client Side Map Descriptors” section. Details on how to do this can be found below.

Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.

4.1. Data Arrays/Descriptors

Section Title

Data_Arrays

Column Title Function Legal Values

Up to 15

Data_Array_Name Provide name for Data Array

Data_Format

Data_Array_Length

Example

// Data Arrays

Data_Arrays
Data_Array_Name, Data_Array_Format, Data_Array_Length
p1c1_devices, Bit, 1
p1c1_function, Byte, 1000
p1c69_restart, Bit, 1000
p1c69_function, Byte, 100
p1c90_reset, Bit, 100
p1c90_function, Byte, 100

The Poller Data Array will contain non-zero data when communications with the panel is OK.

Provide data format. Each Data Array can only take
on one format.
Number of Data Objects. Must be larger than the data
storage area required for the data being placed in this
array.

alphanumeric
characters
Bit, Byte, Packed_Bit,
Uint16

1-10,000

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

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

FS-8700-72 Secutron Manual Page 6 of 15

4.2. Client Side Connection Descriptors

Section Title

Connections

Column Title Function Legal Values

Port

Baud* Specify baud rate

Parity* Specify parity
Data_Bits*

Stop_Bits*

Protocol

Handshaking* Specify hardware handshaking None

Example

// Client Side Connections

Connections
Port, Protocol, Baud, Parity, Handshaking
P1, Secutron, 9600, None, None

Specify through which port the device is
connected to the FieldServer

P1-P81

150, 300, 1200, 2400, 4800, 9600
(Vendor limitation)
None (Vendor limitation)

Specify data bits

Specify stop bits

8 (Vendor limitation)

1 (Vendor limitation)

Specify protocol used Secutron

4.3. Client Side Node Descriptors

Section Title

Nodes

Column

Title

Node_Name Provide name for Node

Node_ID

Generic Node ID unique to port. Also used as panel
number.

Protocol Specify protocol used Secutron

Port

Specify which port the device is connected to the
FieldServer

Example

// Client Side Nodes

Nodes
Node_Name, Node_ID, Protocol, Connection
Node_1, 1, Secutron, P1

Function Legal Values

Up to 32 alphanumeric
characters

0-999

P1-P81

1

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction

manual for details of the ports available on specific hardware.

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

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

FS-8700-72 Secutron Manual Page 7 of 15

4.4. Client Side Map Descriptors

4.4.1. FieldServer Specific Map Descriptor Parameters

Column Title Function Legal Values

Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters

Data_Array_Name

Data_Array_Offset Starting location in Data Array

Function

Node_Name Name of Node to fetch data from

Length

Block_Type*

Name of Data Array where data
is to be stored in the FieldServer

Function of Client Map
Descriptor

The number of devices on the
circuit the Map Descriptor must
detect
Used to enable packed bit when
using a Packed_Bit Data Array
on the Map Descriptor

One of the Data Array names
from “Data Array” section above
0 to (Data_Array_Length-1) as
specified in “Data_Array” section

Rdbc, Passive_Client

One of the node names specified
in “Client Node Descriptor” above

0-999

Flag, -

4.4.2. Driver Specific Map Descriptor Parameters

Column Title Function Legal Values

Secutron_Type

Secutron_Circuit Identifies the circuit or panel zone 0-99

Identifies the type of data the Map Descriptor
points to

Poller, Device,
Function

4.4.3. Timing Parameters

Column Title Function Legal Values

Scan_Interval Rate at which data is polled >= 0s

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

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

The number of

devices on the

circuit this Map

Descriptor can

detect for incoming

The circuit or

zone number

used to trap

incoming events

into the Map

Descriptor. See

Driver notes.

The type of data

the Map

Descriptor points

to. Device data

contains alarm

statuses. Function

data contains

condition codes.

Refer to Appendix

information.

A.1 for more

to the device

to which the

A name given

Function, Node_Name, Secutron_Type, Secutron_Circuit, Length

FieldServer is

events.

Function must be

read for pollers

and all others

Passive_Client.

must be one found

under Data_Arrays.

Data from a circuit

event will be stored

in the array at

A Data Array name

Data_Array_Offset.

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

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

4.4.4. Map Descriptor Example.

The rate at which

the driver polls the

name.

Name will

appear in

Bridge Map

Descriptor

status

information

Any unique

FS-8700-72 Secutron Manual Page 8 of 15

Map_Descriptor_Name, Scan_Interval, Data_Array_Name,

P1_poller, 0s, poller 0, Rdbc, Node_1, poller, -, 1

P1c1_devices, -, P1c1_devices 0, Passive_Client, Node_1, device, 1, 200

P1c1_function, -, P1c1_function 0, Passive_Client, Node_1, function, 1, 200

P1c69_restart, -, P1c69_restart, 0, Passive_Client, Node_1, device, 69, 100

P1c69_function, -, P1c69_function, 0, Passive_Client, Node_1, function, 69, 100

P1c90_reset, -, P1c90_reset, 0, Passive_Client, Node_1, device, 90, 100

P1c90_function, -, P1c90_function, 0, Passive_Client, Node_1, function, 90, 100

screens.

panel.

FS-8700-72 Secutron Manual Page 9 of 15

5. Configuring the FieldServer as a Secutron Modul-R driver Server

For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration
Manual. The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer (See “.csv” files provided with the FieldServer).

The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order
to enable the FieldServer for Secutron Modul-R driver communications, the driver independent
FieldServer buffers need to be declared in the “Data Arrays” section, the FieldServer virtual node(s) need
to be declared in the “Server Side Nodes” section, and the data to be provided to the Client needs to be
mapped in the “Server 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. Data Arrays

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Format

Data_Array_Length

Example

// Data Arrays

Data_Arrays
Data_Array_Name, Data_Array_Format, Data_Array_Length
p1c1_devices, Bit, 1
p1c1_function, Byte, 1000
p1c69_restart, Bit, 1000
p1c69_function, Byte, 100
p1c90_reset, Bit, 100
p1c90_function, Byte, 100

Provide data format. Each Data Array
can only take on one format.
Number of Data Objects. Must be larger
than the data storage area required for
the data being placed in this array.

Up to 15 alphanumeric
characters
Bit, Packed_Bit, Byte,
Uint16

1-10,000

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

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

FS-8700-72 Secutron Manual Page 10 of 15

5.2. Server Side Connection Descriptors

Section Title

Connections

Column Title Function Legal Values

Port

Baud* Specify baud rate

Parity* Specify parity
Data_Bits*

Stop_Bits*

Protocol

Handshaking* Specify hardware handshaking None

Example

// Server Side Connections

Connections
Port, Protocol, Baud, Parity, Handshaking
P1, Secutron, 9600, None, None

Specify which port the device is connected
to the FieldServer

P1-P82

150, 300, 1200, 2400, 4800, 9600
(Vendor limitation)
None (Vendor limitation)

Specify data bits

Specify stop bits

8 (Vendor limitation)

1 (Vendor limitation)

Specify protocol used Secutron

5.3. Server Side Node Descriptors

Section Title

Nodes

Column

Title

Node_Name Provide name for Node

Node_ID

Generic Node ID unique to port. Also used as panel

number.
Protocol Specify protocol used Secutron
Port Port to which node belongs P1-P8

Example

// Server Side Nodes

Nodes
Node_Name, Node_ID, Protocol, Connection
Node_1, 1, Secutron, P1

Function Legal Values

Up to 32 alphanumeric
characters

0-9

2

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction

manual for details of the ports available on specific hardware.

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

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

FS-8700-72 Secutron Manual Page 11 of 15

5.4. Server Side Map Descriptors

5.4.1. FieldServer Specific Map Descriptor Parameters

Column Title Function Legal Values

Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters

Name of the Data Array where

Data_Array_Name

Data_Array_Offset Starting location in Data Array

Function

Node_Name

Length

Block_Type*

data is to be stored in the
FieldServer

Function of Client Map
Descriptor
The name of the Node the Map
Descriptor is attached to
The number of devices on the
circuit the Map Descriptor must
represent
Used to enable packed bit when
using a Packed_Bit Data Array
on the Map Descriptor

One of the Data Array names from
“Data Array” section above

0 to (Data_Array_Length-1) as
specified in “Data_Array” section

Server

One of the Node Names specified
in “Server Node Descriptor” above

0-999

Flag, -

5.4.2. Driver Specific Map Descriptor Parameters

Column Title Function Legal Values

Secutron_Type Identifies the type of data the Map Descriptor points to Device, Function
Secutron_Circuit Identifies the circuit or panel zone 0-99

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

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

The number of

devices on the

circuit this Map

Descriptor can

detect for incoming

The circuit or

zone number

used to trap

incoming events

into the Map

Descriptor. See

Driver notes.

The type of data

the Map

Descriptor points

to. Device data

contains alarm

statuses. Function

data contains

condition codes.

Refer to Appendix

information.

A.1 for more

to the device

to which the

A name given

Function, Node_Name, Secutron_Type, Secutron_Circuit, Length

FieldServer is

events.

Function may not

be read or write

since it

implements a

Server. Function

may only be

Server.

must be one found

under Data_Arrays.

Data from a circuit

event will be stored

in the array at

A Data Array name

Data_Array_Offset.

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

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

5.4.3. Map Descriptor Example.

The rate at which

the driver polls the

name.

Name will

appear in

Bridge Map

Descriptor

status

information

Any unique

FS-8700-72 Secutron Manual Page 12 of 15

Map_Descriptor_Name, Scan_Interval, Data_Array_Name,

P1c1_devices, -, P1c1_devices 0, Server, Node_1, device, 1, 200

P1c1_function, -, P1c1_function 0, Server, Node_1, function, 1, 200

P1c69_restart, -, P1c69_restart, 0, Server, Node_1, device, 69, 100

P1c69_function, -, P1c69_function, 0, Server, Node_1, function, 69, 100

P1c90_reset, -, P1c90_reset, 0, Server, Node_1, device, 90, 100

P1c90_function, -, P1c90_function, 0, Server, Node_1, function, 90, 100

screens.

panel.

FS-8700-72 Secutron Manual Page 12 of 15

Appendix A. Advanced Topics

Appendix A.1. Event Function or Condition Codes

When the Client driver receives an event from the panel, it stores the event’s function or condition
code in the Secutron_Type=function Map Descriptor’s Data Array at the device number’s offset,

Example:
Device=3 on Circuit=1 goes into alarm – the Panel reports an event with function code A (Decimal 65)
The Map Descriptor Secutron_Type=device, Secutron_Circuit=1 will set a bit and store the event
function code A (Decimal 65) at offset 3 in the Map Descriptors’ Data Array.

The Secutron_Type=device Map Descriptors will set a bit if any of the events listed below occur on
that circuit or zone. The bit will be cleared if the panel reports the event as cleared.

The full list of event function codes are:

ASCII value Decimal Meaning

A

B 66 Bypass
C 67 Comlink
D 68 Duplicate Addressable Device
E 69 Maintenance Alert
G 71 Ground Fault
H 72 Hot Key Pressed
I 73 Illegal Addressable Device
J 74 Switch
M 77 Missing Addressable Device
N 78 Non-Fire/Non-Reporting
P 80 Pull Station Alarm
Q 81 Releaser Abort
R 82 Releaser Halt
S 83 Supervisory
T 84 Trouble or Parameter Change
U 85 Wrong Device Type
W 87 Waterflow Alarm

65 Alarm

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

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

FS-8700-72 Secutron Manual Page 13 of 15

Appendix A.2. Panel Circuit or Zone numbers

The panel groups events under circuit or zone numbers. When setting up a Client configuration it is
necessary to create Map Descriptors to trap the events from the zones or circuits you want to see
data from.

If an event is received that has no corresponding Map Descriptor defined, this will be reported on the
RuiNet E screen. This is a useful configuration tool to ensure that all required data is stored.

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

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

FS-8700-72 Secutron Manual Page 14 of 15

Appendix A.3. Panel Power-up, Restarts and Resets

When the panel powers up or is restarted it will send an event on zone/circuit 69 device 0.
When the panel is reset from the Hot Keys on the front panel, it will send an event on zone/circuit 90,
device 9.

The Client driver will clear all the Secutron_Type=device and Secutron_Type=function Data Arrays
when it traps any of these 2 events, provided the circuit 69 and 90 Map Descriptors have been set up
as per the example Map Descriptors under the Client Side configuration instructions.

Other events for Circuits 69 and 90 are shown below for which a bit will be set in the
Secutron_Type=device Map Descriptor’s Data Array at the device offset values shown below:

Circuit Events

Program Restart
(Circuit 69)

Hot Key Activation
(Circuit 90)

Function number of the Hot Key
pressed.

000 – Power On/Hard reboot 003 – Illegal Instruction
001 - Watchdog 004 – Unused Interrupt
002 – Clock Monitor 005 – Orphan Interrupt

001 – Fire Drill 026– Switch 11 On
002 - Lamp Test 027 – Switch 12 On
003 – Releaser Disconnect 028 – Switch 13 On
004 – Relay disconnect 029 – Switch 14 On
005 – Test mode 030 – Switch 15 On
006 – Signal Disconnect 031 – Switch16 On
007 - Acknowledge 032 – Switch 1 Off
008 – Signal Silence 033 – Switch 2 Off
009 - Reset 034 – Switch 3 Off
010 – Common Disconnect 035 – Switch 4 Off
011 – General Alarm 036 – Switch 5 Off
012 - Halt 037 – Switch 6 Off
013 - Abort 038– Switch 7 Off
013 – 2nd Stage Inhibit 039– Switch 8 Off
016 – Switch 1 On 040– Switch 9 Off
017 – Switch 2 On 041– Switch 10 Off
018 – Switch 3 On 042– Switch 11 Off
019 – Switch 4 On 043 – Switch 12 Off
020 – Switch 5 On 044 – Switch 13 Off
021 – Switch 6 On 045 – Switch 14 Off
022– Switch 7 On 046 – Switch 15 Off
023– Switch 8 On 047 – Switch16 Off
024– Switch 9 On 051 – Manual Restart
025– Switch 10 On

Appendix A.4. Driver Messages, Error Messages and Optional Map Descriptors

The Client driver will report all events it receives from the panel on the RuiNet F screen.

If an event is received that has no corresponding Map Descriptor defined, this will be reported on the
RuiNet E screen. This is a useful configuration tool to ensure that all required data is stored.

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

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