FieldServer FS-8700-40 User Manual

Driver Version:
1.12
Document Revision:
4
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after January 2012
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-40 SBT-FSI
(Siemens Building Technologies – Foreign Systems Interface)
FS-8700-40 SBT FSI Driver Manual Table of Contents
TABLE OF CONTENTS
1 SBT-FSI Description ........................................................................................................................................ 3
2 Driver Scope of Supply ................................................................................................................................... 4
2.1 Supplied by FieldServer Technologies for this driver ..................................................................................... 4
2.2 Provided by the Supplier of 3rd Party Equipment ......................................................................................... 4
Hardware ............................................................................................................................................................... 4
Required 3rd Party Configuration ........................................................................................................................... 4
3 Hardware Connections ................................................................................................................................... 5
1.1 Using the NIM-1R or NIM-1W for MXL .......................................................................................................... 5
1.2 RS-232 Connection to the XLS Panel .............................................................................................................. 6
1.3 FSI Connection Notes ..................................................................................................................................... 7
2 Data Array Parameters ................................................................................................................................... 8
4 Configuring the FieldServer as a SBT-FSI Client ............................................................................................... 9
4.1 Client Side Connection Parameterss ............................................................................................................ 11
4.2 Client Side Node Parameters ....................................................................................................................... 12
4.3 Client Side Map Descriptor Parameters ....................................................................................................... 12
FieldServer Related Map Descriptor Parameters ................................................................................................. 12
Driver Related Map Descriptor Parameters ......................................................................................................... 13
Timing Parameters .............................................................................................................................................. 13
Map Descriptor example 1 - Monitoring a MXL/XLS Device for Events ............................................................... 14
Map Descriptor example 2 – Monitoring Analog Loop Devices ........................................................................... 16
5 Configuring the FieldServer as a SBT-FSI Server ............................................................................................ 17
5.1 Server Side Connection Descriptors ............................................................................................................ 18
5.2 Server Side Node Descriptors ...................................................................................................................... 18
5.3 Server Side Map Descriptors........................................................................................................................ 19
FieldServer Specific Map Descriptor Parameters ................................................................................................. 19
Driver Specific Map Descriptor Parameters ......................................................................................................... 19
Map Descriptor example 1 - Emulating a MXL/XLS device with events ............................................................... 20
Map Descriptor example 2 - Emulating a MXL/XLS device with analogs............................................................. 21
Appendix A Useful Features ................................................................................................................................. 22
Appendix A.1. Specifying a Poller Map Descriptor length ....................................................................................... 22
Appendix A.2. Interpreting Panel Error Messages ................................................................................................... 23
Appendix A.3. Obtaining Point Addresses from the panel report ........................................................................... 23
Appendix A.4. Activating and De-activating Entities ............................................................................................... 24
Appendix A.5. Arming and De-Arming Entities ........................................................................................................ 25
Appendix A.6. Request ASD or Sensitivity ............................................................................................................... 27
Appendix A.7. Request % Compensation Used / % Dirty ........................................................................................ 28
Appendix A.8. Opcode 45 – Request List Map Descriptors that trigger at Startup or Node Offline and stop at
Node Online ............................................................................................................................................................. 28
Appendix A.9. Node Status Function ....................................................................................................................... 29
Appendix B Troubleshooting ................................................................................................................................ 30
Appendix A.10. Checksum Errors ............................................................................................................................ 30
Appendix A.11. Recording Active Events – XLS Panel .............................................................................................. 30
Appendix A.12. Using Trouble Codes ....................................................................................................................... 30
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 3 of 32
FieldServer Mode
Nodes
Comments
Client
1-10 (one Client per physical FieldServer serial port). Depends on FieldServer model and configuration.
Only 1 Client node allowed on multidrop systems Server
99
Panel numbers from 1 to 99 may be emulated
1
2
SBT-FSI DESCRI P T ION 1
The SBT-FSI (Siemens Building Technologies – Foreign Systems Interface) driver allows the FieldServer to transfer data to and from Siemens MXL/XLS devices (NIM-1R1 or NIM-1W or RPM2) over either RS-232 or RS-485 using MXL/XLS to foreign system protocol. The FieldServer can emulate either a Server or a Client. Note that the Driver does not support MXL and XLS panels networked together.
Max Nodes Supported
Note that NIM-1R is no longer supported by Siemens and is therefore considered to be legacy while NIM-1W is common. The ports on the RPM need to be configured by the XLS panel. Configuration can be set up for either RS-232 or RS-485, but not both together.
Connection to the RS-485 port of the RPM has not been tested and is not supported.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 4 of 32
FieldServer Technologies PART #
Description
FS-8917-03
RJ45 to DB9F connector adapter
FS-8917-16
Pigtail cable for RJ45 Port for RS-232 use
Part #
Description
Siemens MXL/XLS System
Siemens NIM-1R Network Interface Module ( for MXL usage )
Siemens RPM Network Interface Module ( for XLS usage )
500-699103
Siemens NIM-1W Network Interface Module ( for MXL usage )
Siemens Cable P/N 555-193085 (For RS-232 connection)
DRIVER SCOPE OF SU P PLY 2
2.1 Supplied by FieldSe r v e r Technologies f o r this driver
2.2 Provided by the Su p p l ier of 3rd P a r t y Equipment
2.2.1 Hardware
2.2.2 Required 3
The SBT-FSI System must be set up for remote monitoring with the MXL or XLS to foreign systems protocol.
The ports on the RPM must be configured by the XLS panel. The RPM can be configured for RS-232 or RS-485,
but not both together. Connection to the RS-485 port has not been tested and is not supported.
rd
Party Configurat io n
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 5 of 32
3
FieldServer
P1
18
2
3
4
1
6
7
8
5
10
11
12
9
14
15
16
13
TB4
Gnd
_
+
Gnd
FG
_
+
RS-485
Opto
Isolated
FS-8917-03 RJ45 to DB9M Connector
RJ45 CAT 5 Cable FS8915-10
Cerberus Cable P/N 555-193085
FS-8917-03
NIM-1R
Connection
3
HARDWARE CON N E CT IO N S 3
3.1 Using the NIM-1 R o r NIM-1W f o r MXL
Configure the NIM-1R
or NIM-1W for Foreign System Interface (FSI) by setting all of the switches in SW2
to open (or OFF). See connection diagram below:
Connect the NIM-1R to an RS-232 port on the Fieldserver as depicted in the fiagram below (brown circle) Connect the NIM-W to an RS-485 port on the FieldServer as depeicted in the diagram below.
Note that NIM-1R is no longer supported by Siemens and is therefore considered to be legacy while NIM-1W is common.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 6 of 32
FS Function
RJ45 Pin#
DB9F Pin#
Cerberus Cable Pin
Color
RX 1 2
14
Red
GND
4 5 16
Black
TX 8 3
13
Green
RTS 7
12
Brown
CTS 8
15
White
4
FieldServer
P1
18
2
3
4
1
6
7
8
5
10
9
RXD
TXD
RTS (Do not use)
CTS (Do not use)
GND
RXD
TXD
RTS (Do not use)
CTS (Do not use)
GND
Port 1
RS-232
Port 3
RS-232
2
3
4
1
6
7
5
Port 2
RS-485
RS-232 Port
FieldServer Part #
8917-16
Pigtail for RJ45
Port
Connect to one of the RS-232
Ports on the FieldServer
Brown
Blue/white
Orange/White
GND
TX
RX
Pins 6 and 7 must be jumpered to enable Port 3
4
Pinouts
3.2 RS-232 Connection to the X L S Panel
Configure the NIM-1R
or NIM-1W for Foreign System Interface (FSI) by setting all of the switches in SW2
to open (or OFF).
The ports on the RPM can be configured for either RS-232 or RS-485, but not both together. Connection
to the RS-485 port of the RPM has not been tested and is not supported.
The FieldServer can be connected to either Port 1 or Port 3 on the XLS Panel as described in the
connection drawing. Pins 6 and 7 on the Port 2 Connector must be jumpered to enable RS-232 Port 3.
Note that NIM-1R is no longer supported by Siemens and is therefore considered to be legacy while NIM-1W is common.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 7 of 32
Wire Color RJ-45
XLS Panel Port 1 (3)
Pin
Signal
Signal
Pin
Brown
1
Rx
TXD
2 (7)
White/Orange
8
Tx
RXD
1 (6)
Blue/white
4
GND
GND
3 (8)
Configuration 1 – One FSI Panel per FieldServer per port, one Panel per FSI
FSI
FSI
Panel Panel
Configuration 2 – One FSI Panel per FieldServer port, 3 panels connected in series to the FSI
FSI
Panel PanelPanel
FieldServer
P1
18
FieldServer
P1
18
18
P2
Connector Pinouts for RS-232 Ports
3.3 FSI Connection No t es
It is possible to connect a MXL/XLS device to any RS-232 or RS-485 port. These ports simply need to be
configured for MXL/XLS in the configuration file.
The driver does not support MXL and XLS panels networked together. One FSI panel may be connected per FieldServer port, but multiple panels may be connected per FSI. The
following diagram illustrates two possible connection configurations.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 8 of 32
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.5
Int16, Uint16, Bit
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_Array_Function
Special function for Data Array – Refer to Appendix A.9.
Node_Status
// Data Arrays
Data_Arrays
Data_Array_Name
, Data_Format
, Data_Array_Length
Event_Counts
, Uint16
, 19
Fire
, Bit
, 2048
Fire_UnAck
, Bit
, 2048
5
DATA ARRAY P A R AMETERS 4
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
Format must be Uint16 or Int16 to see trouble codes.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 9 of 32
Event
Counter Offset
Fire Alarm In
0
Fire Alarm Out
1
Fire Alarm Acknowledge
2
Trouble In
3
Trouble Out
4
Trouble Acknowledge
5
Supervisory In
6
Supervisory Out
7
Supervisory Acknowledge
8
Security Alarm In
9
Event
Counter Offset
Security Alarm Out
10
Security Alarm Acknowledge
11
Status In
12
Status Out
13
Test In
14
Test Out
15
Audible Silenced
16
Audible Unsilenced
17
System Reset
18
Array
Msg_Type
Fire Alarm
Fire
Fire Alarm Un-Acknowledged
Fire_Ack
Trouble Alarm
Trouble
Trouble Un-Acknowledged
Trouble_Ack
Supervisory Alarm
Super
Supervisory Un-Acknowledge
Super_Ack
Array
Msg_Type
Security Alarm
Secur
Security Alarm Un-Acknowledged
Secur_Ack
Status
Status
Test
Test
Audible (Un)Silenced
Audible
System Reset
Reset
CONFIGURI NG T HE FIELDSERVER A S A SB T-FSI C L IENT 5
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” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate with a SBT-FSI Server.
In FSI mode, the NIM-1R or NIM-1W or RPM allows the FieldServer to gather data from up to 63 MXL/XLS Panels connected via an MXL/XLS network. The default configuration shipped with the FieldServer will monitor two panels (1 and 2) with 8 modules (1 to 8) each.
When the FieldServer is configured as a Client, two sets of data are collected by a “poller” Map Descriptor.
The first is a collection of 19 counters per panel. Each 16-bit counter is incremented by the poller Map Descriptor whenever the corresponding event occurs. An external Client can read these counters to quickly determine whether a new event has been reported to the Server. The counters are mapped into the Data Array specified for the poller Map Descriptor. Counter offsets into the Data Array per event type are indicated below:
The second set of data is a collection of bit maps that can be queried to identify the device that has reported the event. When an alarm event arrives from a device, the corresponding bit is set in two separate arrays. The bit in one array indicates the alarm has occurred, and the bit in the other array indicates that the alarm has not yet been
acknowledged. When an “alarm clear” event arrives, the bit in the alarm array is cleared. If an “alarm acknowledge” event arrives, the bit in the un-acknowledged array is cleared. All event arrays in a Client driver
configuration are optional. To enable an event array, a Map Descriptor must be defined in the configuration using a Map Descriptor message type that corresponds to the array as shown in the following table:
Notes
1 Map Descriptors are used to determine which bit to set in the Data Array. When an event arrives from a
panel, the FieldServer will scan for a Map Descriptor with a Node_ID matching the panel number reported in the event. This Map Descriptor will point to the Data Array to be modified. The location can be further refined if a starting module within the panel is specified in the Block_Number field. Each module represents 256 bits that can be set or reset by an event. A Map Descriptor that is 512 bits long with a starting module (Block_Number) of 3 represents the events for Modules 3 and 4. A Map Descriptor that is 10 bits long will only map the first 10 devices for that module. The combination of Block_Number and Data_Array_Location
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 10 of 32
can be used to map multiple panels with various numbers of modules into a packed array to be read by the Server side of the FieldServer.
2 When the customer receives a Communication FieldServer with the default driver installed, the configuration
is set to poll 2 MXL/XLS devices once per second.
3 In addition to the two sets of event counters, alarm bit arrays are set up for 8 modules (1 to 8) per device. If
the required configuration falls within this size, only the Server side of the FieldServer needs to be configured. To connect to a device using Modbus RTU protocol, configure the interface as if the FieldServer were another Modbus PLC and create a Map Descriptor to assign a Modbus address (such as 40001) to the Counts Data Array so that it can be read by the Modbus bus master.
4 If the customer has different panel numbers, the Nodes section of the configuration file will need to be
changed. To add more panels, add Node entries and Map Descriptors by copying the original ones and modifying the Panel number entries and Data Array offsets. To access panels with more modules, first increase the Data Array lengths. If the extra modules are contiguous, the Map Descriptors for that panel can have their lengths increased also. If there are large gaps in the numbering of the module, it will be more efficient to add additional Map Descriptors by copying the ones that are given and modifying the Block_Number to start at the next existing module number.
5 While the creation of passive Client-side Map Descriptors is optional, error messages will appear when events
arrive for which Map Descriptors cannot be found. It is therefore recommended that Map Descriptors (especially ack mapdescs) be allocated even if only as dummies to prevent nuisance error messages.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable the FieldServer for SBT-FSI 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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 11 of 32
Section Title
Connections
Column Title
Function
Legal Values
Port
Specify which port the device is connected to the FieldServer
P1-P8, R1-R26
Protocol
Specify protocol used
Cerberus, SBT-FSI
Enhanced_Protocol
Enables legacy or enhanced protocol.. MXL panels do not currently support Enhanced_Protocol, so this parameter must be set to “No” for
MXL. The parameter is normally set to “Yes” for XLS, but may be set to “No” if problems are being experienced.
Yes (XLS) No (MXL) System_Type
Specifies Siemens Panel type
MXL, XLS
Block_Acks7
Specifies if the driver uses block or individual command acks
Yes, No
Fire_Alarms_Hold*
Specifies if the driver should hold fire alarms until the system reset, or clear on fire alarms going out
Yes, No
Baud*
Specify baud rate
19200 (Vendor limitation)
Parity*
Specify parity
Even (Vendor limitation)
Data_Bits*
Specify data bits
7 (Vendor limitation)
Stop_Bits*
Specify stop bits
1 (Vendor limitation)
Poll _Delay*
Time between internal polls
0-32000 seconds, 1 second
// Client Side Connections
Connections
Port
, Protocol
, Baud
, Parity
, Data_Bits
, Poll_Delay
P1
, SBT-FSI
, 19200
, Even
, 7
, 0.100s
6
7
5.1 Client Side Connect i o n P a r a m eters
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.
Refer to the Advanced Driver Manual for usage. This function not enabled on standard driver.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 12 of 32
Section Title
Nodes
Column Title
Function
Legal Values
Node_Name
Provide name for Node
Up to 32 alphanumeric characters
Node_ID
Panel number
1-999
Protocol
Specify protocol used
Cerberus, SBT-FSI
Port
Specify on which port the device is connected to the FieldServer
P1-P8, R1-R2
1
// Client Side Nodes
Nodes
Node_Name
, Node_ID
, Protocol
, Port
Panel1
, 1
, SBT-FSI
, P1
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 Section 4.
Function
Function of Client Map Descriptor
Rdbc for Msg_Type: Poller, Analog_Volts, Analog_Sense, Analog_Thres
Passive for Msg_Type: Fire_Alarm, Fire_Ack, Trouble, Trouble_Ack, Secur, Secur_Ack, Super, Super_Ack, Status, Test, Audible, Reset
Awt for Msg_Type: Entity_Arm_Disarm; Entity_Activate_Deact
5.2 Client Side Node Parameter s
Example
5.3 Client Side M a p D escriptor P a ra m eters
5.3.1 FieldServer Relate d Map Desc r i p t o r Parameters
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 13 of 32
Column Title
Function
Legal Values
Node_Name
Name of Node to fetch or store data from
One of the Node names specified in Section 5.2
Block_Number
Starting module number within panel. There are 256 points per module.
1 – 256 Sub_Module
Sub module number for XLS systems only
0 – 99
Component_Address
Component address for XLS systems only
0 – 99
Length
Length of Map Descriptor specifies number of points. There are 256 points per module.
1 – 10000
Msg_Type
Indicates a “poller” Map Descriptor or identifies the type of event message this Map Descriptor will handle. If this is configured, the driver will store a value that indicates the point type of the event if the Data Array used on the Map Descriptor is not of a bit type
Poller; Fire_Alarm; Fire_Ack; Trouble; Trouble_Ack; Super; Super_Ack; Secur; Secur_Ack; Status; Test; Audible; Reset; Analog_Volts; Analog_Sense; Analog_Thres; Entity_Arm_Disarm8; Entity_Activate_Deact9
Analog_Device
Indicates range of device data to be requested by analogs
0 : devices 1-60 1 : devices 61-121 2 : devices 122-182 3 : devices 183-243 4 : devices 244-252
Block_Offset
This field allows you to set the start address of a MXL or XLS point in a Map Descriptor.
0 - 255
Entity_Types
Used to indicate the type of Entity on the panel.. . Refer to Appendix A.5 for more information
Inputs, Outputs, (If all elements are Input or Output) OR specify each element of the entity individually e.g. IOIOIOO
Entity_Energizations
Used to control the entity on the panel. Refer to Appendix A.5 for more information.
De-energize, Energize, (If all elements are Energize or De-energize) OR specify each element of the entity individually, e.g. EDED---DED
Column Title
Function
Legal Values
Scan_Interval*
Rate at which data is polled
≥0.001s , 1.0s
8
9
5.3.2 Driver Related M ap Descriptor P arameters
5.3.3 Timing Parameters
Refer to Appendix A.5 Refer to Appendix A.4
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 14 of 32
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
CD_Poller1
, Event_Counts1
, 0
, RDBC
, Panel1
, 1
, 19
, Poller
Specifies lowest panel
for more
Specify length in
Specify poller
Specifies Data Array
Specifies offset
Choose a
5.3.4 Map Descriptor example 1 - Monitoring a MXL/ X L S Device for E ve nt s
To monitor a MXL/XLS device we need only one “poller” Map Descriptor as shown below. The function of this Map Descriptor’s is to continuously check the MXL device for events from panels. Only one poller Map Descriptor per FieldServer port is required when monitoring more than one MXL/XLS device. The Node_Name will indicate on which port this Map Descriptor resides.
that will hold event counters. Data Array length must be equal or greater than Data Array offset plus Map Descriptor length.
Node_Name from
the passive Map into event counters Data Array where event counts will be stored.
Descriptors in the
next section to
specify the port
on which this
poller will be
active.
number from which events will be received. Refer to Appendix A.2 information.
multiples of 19 events according to Block Number used.
Refer to Appendix A.2 for more information.
message type for this Map Descriptor.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 15 of 32
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
CD_Fire1
, Fire
, 0
, Passive
, Panel1
, 1
, 1024
, Fire
CD_Fire_Ack1
, Fire_Ack
, 0
, Passive
, Panel1
, 1
, 1024
, Fire_Ack
CD_Trouble1
, Trouble
, 0
, Passive
, Panel1
, 1
, 1024
, Trouble
CD_Trouble_Ack1
, Trouble_Ack
, 0
, Passive
, Panel1
, 1
, 1024
, Trouble_Ack
CD_Super1
, Super
, 0
, Passive
, Panel1
, 1
, 1024
, Super
CD_Super_Ack1
, Super_Ack
, 0
, Passive
, Panel1
, 1
, 1024
, Super_Ack
CD_Secur1
, Secur
, 0
, Passive
, Panel1
, 1
, 1024
, Secur
CD_Secur_Ack1
, Secur_Ack
, 0
, Passive
, Panel1
, 1
, 1024
, Secur_Ack
CD_Status1
, Status
, 0
, Passive
, Panel1
, 1
, 1024
, Status
CD_Test1
, Test
, 0
, Passive
, Panel1
, 1
, 1024
, Test
CD_Audible1
, Audible
, 0
, Passive
, Panel1
, -
, 1
, Audible
CD_Reset1
, Reset
, 0
, Passive
, Panel1
, -
, 1
, Reset
Length specifies the number of points. There
Block Number specifies the
Node Name specifies the panel number for which events will be stored.
Passive Map Descriptors must be added for each event per panel to be monitored:
CD – Client Descriptor
starting module number under
which points are mapped.
are 256 points per module. A length of 1024 holds points for 4 modules.
Notes:
1 All passive Map Descriptors are optional. Specific Map Descriptors may be defined for particular events to be monitored as per the Msg_Type. Should
events happen for which no Map Descriptors are defined, error messages will occur on the FieldServer. It may therefore be useful to add dummy Map Descriptors especially for ack responses to prevent nuisance error messages.
2 Passive Map Descriptors with Node_Name the same as the poller Map Descriptor will only be able to store events from a panel with the same Node_ID
e.g. Node_ID of 1 will only store events from panel 1. To store events from panel 2, it is necessary to add passive Map Descriptors with Node ID of 2 etc. Do not add poller Map Descriptors for other panels.
3 Important Note about first alarm point and Data Array Offsets
Most SBT-FSI panels have device point numbers starting at one instead of zero. The FieldServer MXL driver reserves Data Array offset zero for points with device numbers of zero although they are currently not used. Triggering the first alarm point on a MXL panel will thus result in a point status change at Data_Array_Offset of one instead of zero.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 16 of 32
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
, Analog_Device
, Scan_Interval
CD_Analog_Volts1
, Analog_Volts
, 0
, Rdbc
, Panel1
, 1
, 60
, Analog_Volts
, 0
, 300s
CD_Analog_Sens1
, Analog_Sense
, 0
, Rdbc
, Panel1
, 1
, 60
, Analog_Sense
, 0
, 300s
CD_Analog_Thres1
, Analog_Thres
, 0
, Rdbc
, Panel1
, 1
, 60
, Analog_Thres
, 0
, 300s
Scan Interval on analog
Use Float Data Arrays for
full analog value.
0 : devices 1-60
5.3.5 Map Descriptor example 2 – Monitoring Analog L o op Devices
Analog devices on a loop can be monitored for detector voltage, sensitivity voltage and threshold voltage using three analog Map Descriptors:
the analog Map Descriptors to get the
1 : devices 61-121 2 : devices 122-182 3 : devices 183-243 4 : devices 244-252
Note: If necessary, use more analog Map Descriptors with other Analog_Device numbers to poll other devices on the loop.
pollers may not be shorter than 300s to prevent flooding the Foreign Systems Interface.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 17 of 32
Device Type
Fire Alarm In
Fire Alarm Out
Fire Alarm Acknowledge
Trouble In
Trouble Out
Trouble Acknowledge
Supervisory In
Supervisory Out
Supervisory Acknowledge
Security Alarm In
Security Alarm Out
Security Alarm Acknowledge
Status Event
Test Event
Analog Voltage
Analog Sensitivity Voltage
Analog Threshold Voltage
CONFIGURI NG T HE FIELDSERVER A S A SB T-FSI S E R V E R 6
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).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate with a SBT-FSI Client.
The driver can be used to emulate a MXL/XLS Server device. Other protocol drivers could then poll other remote devices and access the local MXL/XLS Server data to set or clear events. In this configuration an existing SBT-FSI system could be replaced with an MXL/XLS emulation. Existing Clients could poll the emulation driver on the FieldServer to get the same data as from a conventional MXL/XLS Server.
Up to 99 panels can be emulated with the driver. A Map Descriptor has to be defined for each type of remote device that would normally exist in a MXL/XLS Server. The following types can be used:
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable the FieldServer for SBT-FSI communications, the driver independent FieldServer buffers need to be declared in the
“Data Arrays” section, the FieldServer virtual node(s) needs to be declared in the “Server Side Nodes” section , and the data to be provided to the Clients 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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 18 of 32
Section Title
Connections
Column Title
Function
Legal Values
Port
Specify which port the device is connected to the FieldServer
P1-P8, R1-R210
Protocol
Specify protocol used
Cerberus, SBT-FSI
Enhanced_Protocol
Enables legacy or enhanced protocol.. MXL panels do not currently support Enhanced_Protocol, so this parameter must be set to “No” for MXL. The parameter is normally set to “Yes” for XLS, but may be set to “No” if problems are being experienced.
Yes (XLS) No (MXL) System_Type
Specifies Siemens Panel type
MXL, XLS
Echo
Specifies if the server should echo the client’s polls
Yes, No
Baud*
Specify baud rate
110 – 115200, standard baud rates only, 19200
Parity*
Specify parity
Even, Odd, None, Mark, Space
Data_Bits*
Specify data bits
7, 8
Stop_Bits*
Specify stop bits
1 (Vendor limitation)
Server_Hold_Timeout
Specifies time FieldServer will reserve Server side connection while waiting for the Client side to update data in Data_Array (if necessary)
>1.0s // Server Side Connections
Connections
Port
, Protocol
, Baud
, Parity
, Data_Bits
P1
, SBT-FSI
, 19200
, Even
, 7
Section Title
Nodes
Column Title
Function
Legal Values
Node_Name
Provide name for node
Up to 32 alphanumeric characters
Node_ID
Panel number
1-99
Protocol
Specify protocol used
Cerberus, SBT-FSI
Server_Hold_Timeout
Specifies time FieldServer will reserve Server side connection while waiting for the Client side to update data in Data_Array (if necessary)
>1.0s
10
6.1 Server Side Conne c t i o n Descriptors
Example
6.2 Server Side Node D e scriptors
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: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 19 of 32
// Server Side Nodes
Nodes
Node_Name
, Node_ID
, Protocol
, 11
Panel1
, 1
, SBT-FSI
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 point data is to be fetched from
One of the Data Array names
from “Data Array” section
above
Data_Array_Offset
Starting location in Data Array
0 to maximum specified in “Data Array” section above
Function
Function of Server Map Descriptor
Server
Server_Hold_Timeout*
Specifies time FieldServer will reserve Server side connection while waiting for the Client side to update data in Data_Array (if necessary)
>1.0s Column Title
Function
Legal Values
Node_Name
Name of Node or panel for which this Map Descriptor holds points
One of the node names specified in Section 6.2.
Block_Number
Module number (Note that this only specifies one module number as opposed to a starting module number as in the Client Map Descriptor)
1 – 256 Sub_Module
Sub module in XLS system
0 – 99
Component_Address
Component address in XLS system
0 – 99
Length
Length of Map Descriptor Specifies number of points for the indicated module. Note that MXL systems typically has only 256 points per module.
1 – 256
Msg_Type*
If this is configured, the driver will store a value that indicates the point type of the event if the Data Array used on the Map Descriptor is not of a bit type Note that a poller message type may not be used in a Server Map Descriptor.
Fire_Alarm; Fire_Ack; Trouble; Trouble_Ack; Secur; Secur_Ack; Super; Super_Ack; Status; Test; Audible; Reset; Analog_Volts; Analog_Sense; Analog_Thres, -
11
Example
6.3 Server Side Map D e scriptors
6.3.1 FieldServer Speci f i c Map De s c r i p t or Paramete r s
6.3.2 Driver Specific M ap Descriptor Parameters
Note that no port information is necessary on Server side.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 20 of 32
// Server Side Map Descriptors
Map Descriptors
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
SD_Fire1
, Fire
, 0
, Server
, Panel1
, 1
, 256
, Fire
SD_Fire_Ack1
, Fire_Ack
, 0
, Server
, Panel1
, 1
, 256
, Fire_Ack
SD_Trouble1
, Trouble
, 0
, Server
, Panel1
, 1
, 256
, Trouble
SD_Trouble2
, Trouble
, 256
, Server
, Panel1
, 2
, 256
, Trouble
SD_Trouble_Ack1
, Trouble_Ack
, 0
, Server
, Panel1
, 1
, 256
, Trouble_Ack
SD_Super1
, Super
, 0
, Server
, Panel1
, 1
, 256
, Super
SD_Super_Ack1
, Super_Ack
, 0
, Server
, Panel1
, 1
, 256
, Super_Ack
SD_Secur1
, Secur
, 0
, Server
, Panel1
, 1
, 256
, Secur
SD_Secur_Ack1
, Secur_Ack
, 0
, Server
, Panel1
, 1
, 256
, Secur_Ack
SD_Status1
, Status
, 0
, Server
, Panel1
, 1
, 256
, Status
SD_Audible1
, Audible
, 0
, Server
, Panel1
, -
, 1
, Audible
SD_Reset1
, Reset
, 0
, Server
, Panel1
, -
, 1
, Reset
Specifies the panel number
Specifies the module
Specifies the number
Note that Trouble modules 1 and 2
separate Map Descriptors.
6.3.3 Map Descriptor example 1 - Emulating a MXL/XL S d e vice with events
The following list of Map Descriptors emulates a MXL Server,
SD – Server Descriptor
on Panel 1 are emulated with two
Notes:
1 MXL/XLS Server Map Descriptor fields differ in many respects from MXL/XLS Client Map Descriptors. Please follow the examples clearly and read all notes
to ensure a working configuration. No poller Map Descriptors may be defined in a configuration file that is used to configure a MXL/XLS Server.
2 Only one module specified by Block_Number can be emulated with a Server Map Descriptor whereas a Client Map Descriptor specifies a starting module
number with one module for every 256 counts of the Map Descriptor length. You have to use separate Map Descriptors for each module to emulate when doing a Server configuration.
3 More than one Msg_Type Map Descriptor may be used to represent other modules.
being emulated by this Server Map Descriptor.
number. A typical Cerberus Server has 256 points per module.
of points represented within the indicated module.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 21 of 32
// Server Side Map Descriptors
Map Descriptor
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
SD_Analog_Volts1
, Volts
, 0
, Passive
, Panel1
, 1
, 252
, Analog_Volts
SD_Analog_Sense1
, Sense
, 0
, Passive
, Panel1
, 1
, 252
, Analog_Sense
SD_Analog_Thres1
, Thres
, 0
, Passive
, Panel1
, 1
, 252
, Analog_Thres
Use Float Data Arrays for
6.3.4 Map Descriptor example 2 - Emulating a MXL/XL S d e vice with analogs
The following list of Map Descriptors emulate a MXL Server:
the analog Map Descriptors to get the full analog value.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 22 of 32
Appendix A. USEFUL FEATURES
Appendix A.1. Specifying a Poller Map Descriptor length
The poller Map Descriptor is responsible for checking a remote MXL/XLS device for events. When events are received the poller Map Descriptor increments counters at various offsets in the Data Array specified by the poller Map Descriptor. The offsets and their meanings are explained under the Client configuration section of this Driver Manual.
The poller Map Descriptor’s Data Array contains sets of 19 elements or counters. Each set of counters represents the events from a panel. The Block_Number is used to specify the lowest panel number from which events will be received. The highest Node_ID of any passive Map Descriptor on the same port as the poller Map Descriptor specifies the highest panel number from which events will be received. The poller Map Descriptor’s length has to be at least 19 and has to incremented by 19 for every extra panel above the Block_Number from which events will be received.
If a poller Map Descriptor length is set below 19 and for example, event “System Reset” is received which needs to be mapped at offset 18 in the Data Array, the following kernel message will be printed:
“Cannot store alarm event type counts!”, 11010” ‘offset=%u, da=%s”
Example 1: Only receive events from panel 7
Passive event Map Descriptor’s Node Id = 7 (X)
Poller Map Descriptor’s Block_Number = 7 (Y)
Poller Map Descriptor’s Length = (X – Y) * 19 + 19 = 19
Event counters for panel 7 will reside in the first 19 elements.
Example 2: Receive events from panel 7 and 6
Passive event Map Descriptor’s Node Id = 7 (X)
Poller Map Descriptor’s Block_Number = 6 (Y)
Poller Map Descriptor’s Length = (X – Y) * 19 + 19 = 38
Event counters for panel 6 will reside in the first 19 elements and those for panel 7 in the next 19 elements.
Warning: An error will be generated when an event arrives from a panel with a number lower than the Block_Number of the poller. The poller Map Descriptor’s Block_Number must equal the lowest panel number for which a passive Map Descriptor exists on the same port.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 23 of 32
Reason #
Error
Corrective Action
Reason 1
Checksum or Parity fail
Ensure connection baudrate, start, stopbits and parity match the panel's settings
Reason 2
Receive buffer full
Increase scan interval on the poller Map Descriptor.
Reason 3
Syntax Error
Check integrity of physical connection to panel, route cables away from electromagnetic sources that can generate noise.
Reason 4
Unrecognized message failure
Replace hardware?
Corresponds to Block Number 1
Corresponds to Block Array point 1
Appendix A.2. Interpreting Panel Error Messages
A NAK is sent by the panel when it is unable to respond to a message. The format will be as follows:
T02> DRV-> CER : Panel replied with NAK on last message! T02> DRV-> CER : Reason: 1
The following table lists the reason for the failure and the suggested corrective action. Note that the messages are generated by the panel, not the FieldServer.
Appendix A.3. Obtaining Point Addresses from the panel report
In order to configure the FieldServer to capture data from the Panel, the point addresses being used in the panel need to be identified. The Panel report that can be printed out from the panel can be used for this purpose, but matching the Report parameters with the FieldServer configuration parameters is not a trivial exercise. The following notes should assist in identifying the addresses needed for FieldServer configuration
The preamble to the report is not relevant to the FieldServer Driver.
The first Module can be identified by the title NET Address =1. This corresponds to FieldServer’s “Block 1”.
The Module Subaddress corresponds to individual points in the Block Array.
This information is depicted in the following file extract:
NET ADDR: 1 ==> ALD-2 2 Analog Loop Module Page: 5
===============================================================================
Module Subaddress ----------------> 1
DEVICE TYPE ----------------------> TRI-60/TRX-2/3 1 Switch Input
Usage --------------------------> TROUBLE
Message ------------------------> RCP-01 Trouble Input MM-1
Switch Contact Type -----------> N.O.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 24 of 32
// Client Side Connections
//
Connections
Port
, Baud
, Parity
, Data_Bits
, Line_drive_on
, Line_drive_off
, Enhanced_Protocol
, Protocol
, System_Type
P1
, 19200
, Even
, 7
, 0.001
, 0.001
, No
, Cerberus
, MXL
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Block_Offset
, Length
, Msg_Type
POLLER_1
, 2.0s
, Counts_1
, 0
, Rdbc
, Panel1
, 1
, 0
, 19
, Poller
// this is for activation and deactivation of pseudo points
PNL_1_Act_Entity
, 0s
, Act_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 10
, Entity_Activate_Deact
// Client Side Connections
//
Connections
Port
, Baud
, Parity
, Data_Bits
, Line_drive_on
, Line_drive_off
, Enhanced_Protocol
, Protocol
, System_Type
P1
, 19200
, Even
, 7
, 0.001
, 0.001
, Yes
, Cerberus
, XLS
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Sub_Module
, Block_Offset
, Length
, Msg_Type
POLLER_1
, 2.0s
, Counts_1
, 0
, Rdbc
, Panel1
, 1
, -
, 0
, 19
, Poller
// this is for activation and deactivation of pseudo points
PNL_1_Act_Entity
, 0s
, Act_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 1
, 10
, Entity_Activate_Deact
Appendix A.4. Activating and De-activating Entities
These examples demonstrate the methodology to activate or de-activate equipment on the MXL/XLS panel as per the SBT-FSI protocol specification. This relates to the opcode Activate/Deactivate Entity 0x7b/0x7c.
The configuration example in Section 4 can be modified as per the example below for Activating and De-activating Entities on the MXL Panel.
The configuration example in Section 4 can be modified as per the example below for Activating and De-activating Entities on the XLS panel.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 25 of 32
// Data Arrays
//
Data_Arrays
Data_Array_Name
, Data_Format
, Data_Array_Length
Counts_1
, Uint16
, 19
Arm_Disarm_Ent
, Bit
, 10 // Client Side Connections
//
Connections
Port
, Baud
, Parity
, Data_Bits
, Line_Drive_On
, Line_Drive_Off
, Enhanced_Protocol
, Protocol
, System_Type
P1
, 19200
, Even
, 7
, 0.001
, 0.001
, No
, Cerberus
, MXL
// Client Side Map Descriptors
//
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
POLLER_1
, 2.0s
, Counts_1
, 0
, Rdbc
, Panel1
, 1
, 19
, Poller
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
.Node_Name
, Block_Number
, Block_Offset
, Length
, Msg_Type
, Entity_Types
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 10
, Entity_Arm_Disarm
, Inputs
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Block_Offset
, Length
, Msg_Type
, Entity_Types
, Entity_Energizations
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 10
, Entity_Arm_Disarm
, Outputs
, De-energize
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Block_Offset
, Length
, Msg_Type
, Entity_Types
, Entity_Energizations
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 10
, Entity_Arm_Disarm
, Outputs
, Energize
// Data Arrays
//
Data_Arrays
Data_Array_Name
, Data_Format
, Data_Array_Length
Counts_1
, Uint16
, 19
Arm_Disarm_Ent
, Bit
, 10
Appendix A.5. Arming and De-Arming Entities
This example demonstrates the methodology to arm or disarm equipment on the MXL/XLS panel as per the SBT-FSI protocol specification. This relates to the opcodes Disarm/manuallycontrol entity – opcode 0x77; Arm entity – opcode 0x78,
The configuration example in Section 4 can be modified as per the example below for Arming and De-arming Entities on the MXL Panel.
The configuration example in Section 4 can be modified as per the example below for Arming and De-arming Entities on the XLS panel.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 26 of 32
// Client Side Connections
//
Connections
Port
, Baud
, Parity
, Data_Bits
, Line_Drive_On
, Line_Drive_Off
, Enhanced_Protocol
, Protocol
, System_Type
P1
, 19200
, Even
, 7
, 0.001
, 0.001
, Yes
, Cerberus
, XLS // Client Side Map Descriptors
//
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
POLLER_1
, 2.0s
, Counts_1
, 0
, Rdbc
, Panel1
, 1
, 19
, Poller
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Sub_Module
, Component_Address
, Block_Offset
, Length
, Msg_Type
, Entity_Types
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 1
, 1
, 10
, Entity_Arm_Disarm
, Inputs
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Sub_Module
, Component_Address
, Block_Offset
, Length
, Msg_Type
, Entity_Types
, Entity_Energizations
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 1
, 1
, 10
, Entity_Arm_Disarm
, Outputs
, De-energize
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Sub_Module
, Component_Address
, Block_Offset
, Length
, Msg_Type
, Entity_Types
, Entity_Energizations
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 1
, 1
, 10
, Entity_Arm_Disarm
, Outputs
, Energize
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Sub_Module
, Component_Address
, Block_Offset
, Length
, Msg_Type
, Entity_Types
, Entity_Energizations
PNL_1_Arm_Disarm
, 0s
, Arm_Disarm_Ent
, 0
, Awt
, Panel1
, 1
, 1
, 1
, 1
, 10
, Entity_Arm_Disarm
, IOIOIOIIOI
, EDED---DED
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 27 of 32
Data_Arrays
Data_Array_Name
, Data_Format
, Data_Array_Length
Current_ASD
, Uint16
, 60
Current_Sens
, Uint16
, 60
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
PNL_1_ASD
, 300s
, Current_ASD
, 0
, Rdbc
, Panel1
, 1
, 60
, Current_ASD
PNL_1_Sens
, 300s
, Current_Sens
, 0
, Rdbc
, Panel1
, 2
, 60
, Current_Sensitivity
Current_ASD
Current_Sensitivity
0
does not apply
does not apply
1
disabled
2.45%/foot
2
office
2.59%/foot
3
warehouse
2.72%/foot
4
lobby
2.86%/foot
5
computer room
3.00%/foot
6
dormitory
3.13%/foot
7
health care
3.27%/foot
8
garage
9 utility room
10
precious storage
11
hostile environment
Block_Number sets the module number for which this
Data values will be stored for device addresses from 0 to Length which can be from 1 to 253
Appendix A.6. Request ASD or Sensitivity
The values stored are as follows:
analog device data pertains
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 28 of 32
Data_Arrays
Data_Array_Name
, Data_Format
, Data_Array_Length
Comp_Used
, Uint16
, 253
Dirty
, Uint16
, 253
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
PNL_1_Comp_Used
, 300s
, Comp_Used
, 0
, Rdbc
, Panel1
, 1
, 253
, Compensation_Used
PNL_1_Dirty
, 300s
, Dirty
, 0
, Rdbc
, Panel1
, 2
, 253
, Dirty
Map_Descriptors
Map_Descriptor_Name
, Scan_Interval
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Block_Number
, Length
, Msg_Type
PNL_1_Req_List_ALR
, 2.0s
, -
, 0
, ARS
, Panel1
, -
, 1
, req_list_alarm
PNL_1_Req_List_TRB
, 2.0s
, -
, 0
, ARS
, Panel1
, -
, 1
, req_list_trouble
PNL_1_Req_List_SUP
, 2.0s
, -
, 0
, ARS
, Panel1
, -
, 1
, req_list_superv
PNL_1_Req_List_SEC
, 2.0s
, -
, 0
, ARS
, Panel1
, -
, 1
, req_list_secur
PNL_1_Req_List_STA
, 2.0s
, -
, 0
, ARS
, Panel1
, -
, 1
, req_list_status
// for networked panels
PNL_2_Req_List_ALR
, 2.0s
, -
, 0
, ARS
, Panel2
, -
, 1
, req_list_alarm
PNL_2_Req_List_TRB
, 2.0s
, -
, 0
, ARS
, Panel2
, -
, 1
, req_list_trouble
PNL_2_Req_List_SUP
, 2.0s
, -
, 0
, ARS
, Panel2
, -
, 1
, req_list_superv
PNL_2_Req_List_SEC
, 2.0s
, -
, 0
, ARS
, Panel2
, -
, 1
, req_list_secur
PNL_2_Req_List_STA
, 2.0s
, -
, 0
, ARS
, Panel2
, -
, 1
, req_list_status
Data values will be stored for
to 253
Block_Number sets the module number for which this analog device data pertains
The data values stored are %
e.g. 1, 10 etc
Appendix A.7. Request % Compensation Used / % Dirty
(must be DLC or ALD)
device addresses from 0 to Length which can be from 1
values per device address,
Appendix A.8. Opcode 45 – Request List Map Descriptors that trigger at Startup or Node Offline and stop at Node Online
Request List Map Descriptors can be added to ensure the current alarm, trouble, supervision, security or status events that have not been cleared or reset in the remote panel are recorded again after a power-cycle or a re-connection to the panel. Request List Map Descriptors are optional and may be defined per type as needed.
A Passive Map Descriptor of the indicated type needs to be defined and linked to the Request List Map Descriptors to allow storage of these events.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 29 of 32
Appendix A.9. Node Status Function
Refer to the FieldServer Configuration manual for information on how to configure Node status. The only status that can be monitored is the direct connection from the FieldServer to the main panel since there is no direct communication with the other networked panels.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 30 of 32
Trouble Type
Trouble Type Text
0 1
Multiple Response
2
Communication Error
3
Input Dev. Response too low
4
Device Receive Error
5
Dev Detected Waveform Error
6
Not Responding
7
Not Responding
8
Unspecified Dev. Responding
9
Incorrect ID
10
INPUT DE-ISOLATED
11
INPUT ISOLATED
12
Input Disarmed
13
Addressable Relay disarmed
14
Relay Disarmed
15
Signal Circuit Disarmed
Trouble Type
Trouble Type Text
16
Solid State Output Disarmed
17
Relay Supervision Failure
18
Signal Circuit Loop Open
19
Loop Disarmed
20
Class A Trouble
21
Relay Driver Inoperative
22
Signal Circuit Shorted
23
ALD Reception Error
24
Coil Open
25
Zone Power Off
26
Power Cycling
27
Short Circuit
28
Open Circuit
29
Voltage Low
30
Zone Power Loss
31
Loop Node
Appendix B. TROUBLESHOOTING
Appendix B.1. Checksum Errors
Messages using special characters with ASCII values higher than 127 (e.g. Portugese ç, á,ó, ã, etc), provide a bad
checksum at 7 data bits. This is resolved if 8 data bits are used.
Appendix B.2. Recording Active Events – XLS Panel
When there is an active event in the XLS panel, the FieldServer will report this event in the Driver log of RUInet (Remote User Interface) regardless of whether there is a Map Descriptor to store the event or not. The report may state the location of the event as follows:
1^10^0^26^1
This translates to the following: Panel Number ^ Block (Loop) ^ sub-Module ^ Address ^ Component Address
Alternatively the location of the event could be recorded as:
P:L-D
This translates to the following: Panel Number: Block (Loop) - Device
Appendix B.3. Using Trouble Codes
In order to see the trouble codes for incoming troubles it is necessary to use a Uint16 or Int16 data array for the trouble instead of the normal Bit. When the driver stores a trouble code of for example 15 into a Bit data array, it will be displayed as 1 since Bit only holds either a zero or a one value. Using a Uint16 or Int16 data array will ensure the value of 15 is displayed.
The following information is taken from Siemens Fire Safety documentation
MXL/XLS Trouble Codes
These codes are sent in Field 5 of the Trouble in, Trouble out and Trouble Acknowledge messages 24H, 25H and 26H. Each code is sent as up to 3 ASCII bytes. Leading zeros are not sent. The Request Trouble Type message (43H) can be used to obtain the text strings shown below for each of these codes. The trouble text string is returned in the Trouble Type message (53H).
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 31 of 32
Trouble Type
Trouble Type Text
32
Not defined
33
Multiple Response
34
MOI-1 Local Trouble
35
MOI-1 Zone Trouble
36
No database – default in use
37
Too Many ALD-2’s
38
PSR-1 Driver Disarmed
39
Output Disarmed
40
Not Responding
41
Unspecified Module Responding
42
Communication Failure
43
RAM Failure
44
ROM Failure
45
A/D Convert Fail
46
Single Module Zone Code
47
Command Not Valid
48
Network A Pair Fail
49 50
Loss of 24V Input Power
51
Act Power Voltage Low
52
Default Trouble Active
53
Network Disabled
54
Alarm from Isolated Device
55
Printer off-line
56
Warm Reset
57
Printer out of Power
58
Tamper Switch
59
Battery Backup Invalid
60
Positive Ground Fault
61
Negative Ground Fault
62
AC Fail/brownout
63
System Signal Power Failure
64
Battery Fuse/Wiring Open
65 66
24 Volt Supply Over/Under
67
High Battery Voltage
68
Battery Charger Off
69
24 Volts on Battery Backup
70
Low Battery voltage
71
Watchdog Triggered
72
Device LED Manually Activated
73
Alarm queue full
74
Supervisory queue full
75
Trouble queue full
76
Security queue full
77
Memory error in Ram text
78
Memory error in ROM text
79
Aux Pwr Class A Fail Pos
80
Aux Pwr Class A Fail Neg
81
Supervisory Point
82
Security Point
83
BELL 2 ISOLATED
Trouble Type
Trouble Type Text
84
BELL 2 DE-ISOLATED
85
Configuration Error
86
Addressable Relay Isolated
87
Relay Isolated
88
Single Circuit Isolated
89
Solid State Output Isolated
90
Class A Fault
91
Noise Fault
92
MOI-1 Local Fault
93
MOI-1 Zone Isolated
94
PSR-1 Driver Isolated
95
Fault queue full
96
Isolated Alarm queue full
97
Isolated Alarm point
98
Requires Service
99
MVP General Trouble
100
Valve Tamper queue full
101
Valve Tamper Point
102
WALKTEST Activated
103
Function Recursion Limit Exceeded
104
Trouble Causing Input
105
Carrier Loss
106 107
Missing Device ID Response
108
Annunciator Trouble
109
CMI-300 general trouble
110
ROM SW version error
111
Lamp Supervision Trouble
112
Keyswitch Activated
113
Ancillary Cntrl Funcs Isolated
114
Ancillary Cntrl Funcs De-Isolated
115
Pre-dirty Analog volt reached
116
IEC limit reached. Service Req
117
IEC memory error
118
NET-7 General Trouble
119
Network B Pair Failure
120
MOI-1 Voice System Trouble
121
Style 4 Network mode
122
Aux. RS232 Transmit Fail
123
Module Address Buffer Fail
124
Incorrect Enclosure
125
OCC-1 General Trouble
126
OCC-1 Degrade Mode
127
Backup Tone Card (BTC)
128
Daily detector test abnormal
129
Event log 80% full
130
Event log 90% full
131
Log FULL, events will be lost
132
Audio Riser 1 Trouble
133
Audio Riser 2 Trouble
134
Audio Riser 3 Trouble
135
Mic Key Trouble
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-40 SBT FSI Driver Manual Page 32 of 32
Trouble Type
Trouble Type Text
136
Mic Pre-amp Trouble
137
Tone Generator Trouble
138
Mic Input Trouble
139
Telephone Riser Trouble
140
Mic Key Trouble
141
Amplifier 1 Trouble
142
Amplifier 2 Trouble
143
Amplifier 3 Trouble
144
Amplifier 1 Backed Up
145
Amplifier 2 Backed Up
146
Amplifier 3 Backed Up
147
Multiple Response
148
Communication Error
149
Not Responding
150
Unspecified Sub-module Responding
151
Incorrect ID
152
Audio Riser 1 Class A Active
153
Audio Riser 2 Class A Active
154
Audio Riser 3 Class A Active
155
Backup Amplifier Trouble
156
Daily Detector Test Abnormal
157
Low IEC voltage. Service Req.
158
Audio Output Shorted
159
Audio Output Class A Active
160
Amplifier 1 Signal Loss
161
Amplifier 2 Signal Loss
162
Amplifier 3 Signal Loss
163
Generic Input Terminal
164
DMU 1 Failure
165
DMU 2 Failure
166
Out of RAM. Call factory
167
Incorrect Node Address
168
Not Responding
169
Unspecified Node Responding
170
Node Disconnected
171
Network CSGM Upload Needed
172
Style 7 Network Mode
173
Network input disarmed
174
Out of task – Call factory
175
Stack Fault – Call factory
176
Software Key Violation
177
Airflow too low
178
Airflow too high
179
Detector Trouble
180
AnaLASER General Trouble
181
Pre1 level
182
Pre2 level
183
Incorrect library version
184
Out of calibration
185
AnaLASER Power Trouble
186
Pre-alarm
Trouble Type
Trouble Type Text
187
+15volt fault
188
Strobe power fault
189
Audio fault iso-St 7Tx
190
Audio fault iso-St 7Rx
191
Audio fault iso-St 4Tx
192
Audio fault iso-St 4Rx
193
Multiple Response
194
Global audio riser-St 7
195
Global audio riser-St 4
196
Local audio riser
197
Database Out of Date
298
ASD disabled for test
199
Sys halt – too many ALD/ACM
200
DMC-1 in record mode
201
DMC-1 tone trouble
202
DMC-1 phrase trouble
203
Troubles summarized
204 205
Incorrect custom phrase control
206
Remote node disconnected
207
History manually turned off
208
History manually turned on
209
History manually erased
210
Memory upgrade required
211
Event queue corrupt
212
Current sensor failure
213
EEprom error
214
No application firmware
215
Component disarmed
216
Zone 1 open
217
Zone 2 open
218
Zone 1 short
219
Zone 2 short
220
Zone 1 Class A return fault
221
Zone 2 Class A return fault
222
Input source malfunction
223
Over current fault
224
Log failure, events lost
225
24V 4amp supply shutdown
226
24V 12amp supply shutdown
227
Backplane power shutdown
228
No battery detected
229
Thermistor Trouble
230
Configuration process failure
231
Device(s) with no address
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
Loading...