A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-72 Secutron Modul-R
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after August 2008
Driver Version:
Document Revision:
1.01
8
Download from Www.Somanuals.com. All Manuals Search And Download.
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 #
FS-8917-16
FS-8700-72
Description
Pigtail cable for RJ45 Port
Driver Manual.
.
Download from Www.Somanuals.com. All Manuals Search And Download.
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
8
5
Brown
White/Orange Rx
Blue/white GND
Tx
Download from Www.Somanuals.com. All Manuals Search And Download.
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
alphanumeric
characters
Provide data format. Each Data Array can only take Bit, Byte, Packed_Bit,
Data_Format
on one format.
Uint16
Number of Data Objects. Must be larger than the data
Data_Array_Length storage area required for the data being placed in this 1-10,000
array.
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
p1c1_devices,
p1c1_function,
p1c69_restart,
p1c69_function,
p1c90_reset,
Data_Array_Format,
Bit,
Byte,
Bit,
Byte,
Bit,
Data_Array_Length
1
1000
1000
100
100
100
p1c90_function,
Byte,
The Poller Data Array will contain non-zero data when communications with the panel is OK.
Download from Www.Somanuals.com. All Manuals Search And Download.
FS-8700-72 Secutron Manual
Page 6 of 15
4.2.
Client Side Connection Descriptors
Section Title
Connections
Column Title
Function
Legal Values
Specify through which port the device is
connected to the FieldServer
Port
P1-P81
150, 300, 1200, 2400, 4800, 9600
(Vendor limitation)
Baud*
Specify baud rate
Parity*
Specify parity
None (Vendor limitation)
Data_Bits*
Specify data bits
8 (Vendor limitation)
1 (Vendor limitation)
Stop_Bits*
Protocol
Specify stop bits
Specify protocol used
Secutron
None
Handshaking* Specify hardware handshaking
Example
// Client Side Connections
Connections
Port,
P1,
Protocol,
Secutron,
Baud,
9600,
Parity,
None,
Handshaking
None
4.3.
Client Side Node Descriptors
Section Title
Nodes
Column
Title
Function
Legal Values
Up to 32 alphanumeric
characters
Node_Name Provide name for Node
Generic Node ID unique to port. Also used as panel
number.
Specify protocol used
Specify which port the device is connected to the
FieldServer
Node_ID
Protocol
Port
0-999
Secutron
P1-P81
Example
// Client Side Nodes
Nodes
Node_Name,
Node_1,
Node_ID,
1,
Protocol,
Secutron,
Connection
P1
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.
Download from Www.Somanuals.com. All Manuals Search And Download.
FS-8700-72 Secutron Manual
Page 7 of 15
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Map_Descriptor_Name Name of this Map Descriptor
Function
Legal Values
Up to 32 alphanumeric characters
Name of Data Array where data One of the Data Array names
is to be stored in the FieldServer from “Data Array” section above
Data_Array_Name
Data_Array_Offset
Function
0 to (Data_Array_Length-1) as
specified in “Data_Array” section
Starting location in Data Array
Function
Descriptor
of
Client
Map
Rdbc, Passive_Client
One of the node names specified
in “Client Node Descriptor” above
Node_Name
Name of Node to fetch data from
The number of devices on the
Length
circuit the Map Descriptor must 0-999
detect
Used to enable packed bit when
using a Packed_Bit Data Array Flag, -
on the Map Descriptor
Block_Type*
4.4.2.
Driver Specific Map Descriptor Parameters
Column Title
Secutron_Type
Secutron_Circuit Identifies the circuit or panel zone
Function
Legal Values
Identifies the type of data the Map Descriptor Poller, Device,
points to
Function
0-99
4.4.3.
Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
>= 0s
Download from Www.Somanuals.com. All Manuals Search And Download.
Download from Www.Somanuals.com. All Manuals Search And Download.
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
Up to 15 alphanumeric
characters
Data_Array_Name
Data_Format
Provide name for Data Array
Provide data format. Each Data Array Bit,
can only take on one format.
Packed_Bit,
Byte,
Uint16
Number of Data Objects. Must be larger
Data_Array_Length
than the data storage area required for 1-10,000
the data being placed in this array.
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
p1c1_devices,
p1c1_function,
p1c69_restart,
p1c69_function,
p1c90_reset,
Data_Array_Format,
Bit,
Byte,
Bit,
Byte,
Bit,
Data_Array_Length
1
1000
1000
100
100
100
p1c90_function,
Byte,
Download from Www.Somanuals.com. All Manuals Search And Download.
FS-8700-72 Secutron Manual
Page 10 of 15
5.2.
Server Side Connection Descriptors
Section Title
Connections
Column Title
Function
Legal Values
Specify which port the device is connected
to the FieldServer
Port
P1-P82
150, 300, 1200, 2400, 4800, 9600
(Vendor limitation)
Baud*
Specify baud rate
Parity*
Specify parity
None (Vendor limitation)
Data_Bits*
Specify data bits
8 (Vendor limitation)
1 (Vendor limitation)
Stop_Bits*
Protocol
Specify stop bits
Specify protocol used
Secutron
None
Handshaking* Specify hardware handshaking
Example
// Server Side Connections
Connections
Port,
P1,
Protocol,
Secutron,
Baud,
9600,
Parity,
None,
Handshaking
None
5.3.
Server Side Node Descriptors
Section Title
Nodes
Column
Title
Function
Legal Values
Up to 32 alphanumeric
characters
Node_Name Provide name for Node
Generic Node ID unique to port. Also used as panel
number.
Node_ID
0-9
Protocol
Port
Specify protocol used
Port to which node belongs
Secutron
P1-P8
Example
// Server Side Nodes
Nodes
Node_Name,
Node_1,
Node_ID,
1,
Protocol,
Secutron,
Connection
P1
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.
Download from Www.Somanuals.com. All Manuals Search And Download.
FS-8700-72 Secutron Manual
Page 11 of 15
5.4.
5.4.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Legal Values
Map_Descriptor_Name Name of this Map Descriptor
Name of the Data Array where
Up to 32 alphanumeric characters
One of the Data Array names from
“Data Array” section above
Data_Array_Name
data is to be stored in the
FieldServer
0 to (Data_Array_Length-1) as
specified in “Data_Array” section
Data_Array_Offset
Function
Starting location in Data Array
Function
of
Client
Map
Server
Descriptor
The name of the Node the Map One of the Node Names specified
Node_Name
Descriptor is attached to
in “Server Node Descriptor” above
The number of devices on the
Length
circuit the Map Descriptor must 0-999
represent
Used to enable packed bit when
using a Packed_Bit Data Array Flag, -
on the Map Descriptor
Block_Type*
5.4.2.
Driver Specific Map Descriptor Parameters
Column Title
Secutron_Type
Secutron_Circuit Identifies the circuit or panel zone
Function
Legal Values
Identifies the type of data the Map Descriptor points to Device, Function
0-99
Download from Www.Somanuals.com. All Manuals Search And Download.
Download from Www.Somanuals.com. All Manuals Search And Download.
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
65
Alarm
A
B
C
D
E
G
H
I
66
67
68
69
71
72
73
74
77
78
80
81
82
83
84
85
87
Bypass
Comlink
Duplicate Addressable Device
Maintenance Alert
Ground Fault
Hot Key Pressed
Illegal Addressable Device
Switch
Missing Addressable Device
Non-Fire/Non-Reporting
Pull Station Alarm
Releaser Abort
Releaser Halt
Supervisory
Trouble or Parameter Change
Wrong Device Type
Waterflow Alarm
J
M
N
P
Q
R
S
T
U
W
Download from Www.Somanuals.com. All Manuals Search And Download.
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.
Download from Www.Somanuals.com. All Manuals Search And Download.
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
003 – Illegal Instruction
000 – Power On/Hard reboot
001 - Watchdog
002 – Clock Monitor
001 – Fire Drill
002 - Lamp Test
003 – Releaser Disconnect
004 – Relay disconnect
005 – Test mode
006 – Signal Disconnect
007 - Acknowledge
008 – Signal Silence
009 - Reset
010 – Common Disconnect
011 – General Alarm
012 - Halt
Program Restart
(Circuit 69)
004 – Unused Interrupt
005 – Orphan Interrupt
026– Switch 11 On
027 – Switch 12 On
028 – Switch 13 On
029 – Switch 14 On
030 – Switch 15 On
031 – Switch16 On
032 – Switch 1 Off
033 – Switch 2 Off
034 – Switch 3 Off
035 – Switch 4 Off
036 – Switch 5 Off
037 – Switch 6 Off
038– Switch 7 Off
039– Switch 8 Off
040– Switch 9 Off
041– Switch 10 Off
042– Switch 11 Off
043 – Switch 12 Off
044 – Switch 13 Off
045 – Switch 14 Off
046 – Switch 15 Off
047 – Switch16 Off
051 – Manual Restart
Hot Key Activation
(Circuit 90)
013 - Abort
Function number of the Hot Key
pressed.
013 – 2nd Stage Inhibit
016 – Switch 1 On
017 – Switch 2 On
018 – Switch 3 On
019 – Switch 4 On
020 – Switch 5 On
021 – Switch 6 On
022– Switch 7 On
023– Switch 8 On
024– Switch 9 On
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.
Download from Www.Somanuals.com. All Manuals Search And Download.
|