FieldServer FS-8700-40 User Manual

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-40 SBT-FSI

(Siemens Building Technologies – Foreign Systems Interface)

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after September 2008

Driver Version: 1.08
Document Revision: 3

FS-8700-40 SBT FSI Driver Manual Table of Contents

TABLE OF CONTENTS

1 SBT-FSI Description ........................................................................................................................................ 3

2 Driver Scope of Supply ................................................................................................................................... 3

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

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

2.2.1 Hardware ............................................................................................................................................... 3

2.2.2 Required 3rd Party Configuration ........................................................................................................... 3

3 Hardware Connections ................................................................................................................................... 4

3.1 Using the NIM-1R or NIM-1W for MXL .......................................................................................................... 4

3.2 FSI Connection Notes ..................................................................................................................................... 5

4 Configuring the FieldServer as a SBT-FSI Client ............................................................................................... 6

4.1 Data Arrays .................................................................................................................................................... 8

4.2 Client Side Connection Descriptions .............................................................................................................. 9

4.3 Client Side Node Descriptors ....................................................................................................................... 10

4.4 Client Side Map Descriptors......................................................................................................................... 10

4.4.1 FieldServer Related Map Descriptor Parameters ................................................................................. 10

4.4.2 Driver Related Map Descriptor Parameters ......................................................................................... 11

4.4.3 Timing Parameters ............................................................................................................................... 11

4.4.4 Map Descriptor example 1 - Monitoring a MXL/XLS Device for Events ............................................... 12

4.4.5 Map Descriptor example 2 – Monitoring Analog Loop Devices ........................................................... 14

5 Advanced Client Configuration – Using Bidirectional capability ................................................................... 15

6 Configuring the FieldServer as a SBT-FSI Server ............................................................................................ 16

6.1 Server Side Connection Descriptors ............................................................................................................ 17

6.2 Server Side Node Descriptors ...................................................................................................................... 18

6.3 Server Side Map Descriptors........................................................................................................................ 18

6.3.1 FieldServer Specific Map Descriptor Parameters ................................................................................. 18

6.3.2 Driver Specific Map Descriptor Parameters ......................................................................................... 19

6.3.3 Map Descriptor example 1 - Emulating a MXL/XLS device with events ............................................... 20

6.3.4 Map Descriptor example 2 - Emulating a MXL/XLS device with analogs ............................................. 21

Appendix A. Advanced Topics .............................................................................................................................. 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. Using Trouble Codes ......................................................................................................................... 24

Appendix A.5. Activating and De-activating Entities ............................................................................................... 27

Appendix A.6. Arming and De-Arming Entities ........................................................................................................ 28

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

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

FS-8700-40 SBT FSI Driver Manual Page 3 of 29

FieldServer Mode

Nodes

Comments

10 (one Client per physical

500-699103

Siemens NIM-1W Network Interface Module ( for MXL usage )

1 SBT-FSI DESCRIPTION

The SBT-FSI (Siemens Building Technologies – Foreign Systems Interface) driver allows the FieldServer to transfer

1

data to and from Siemens MXL/XLS devices (NIM-1R

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.

Max Nodes Supported

1-

Client

FieldServer serial port). Depends on

Only 1 Client node allowed on multidrop systems

FieldServer model and configuration.

Server 99 Panel numbers from 1 to 99 may be emulated

2 DRIVER SCOPE OF SUPPLY

2.1 Supplied by FieldServer Technologies for this driver

FieldServer Technologies PART # Description

FS-8917-03 RJ45 to DB9F connector adapter

FS-8700-40 SBT FSI Driver Manual

2.2 Provided by the Supplier of 3rd Party Equipment

2.2.1 Hardware

Part # Description

Siemens MXL/XLS System

Siemens NIM-1R Network Interface Module ( for MXL usage )

Siemens RPM Network Interface Module ( for XLS usage )

Siemens Cable P/N 555-193085 (For RS-232 connection)

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 Configuration

1

Note that NIM-1R is no longer supported by Siemens and is therefore considered to be legacy while NIM-1W is common.

2

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: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-40 SBT FSI Driver Manual Page 4 of 29

2

3
4

1

6
7
8

5

10
11
12

9

14
15
16

13

2
3
4

1

6
7
8

5

10
11
12

9

14
15
16

13

2

1

TB2

TB7

TB4

P3

DB9

2 Rx
3 Tx
5 GND
7 RTS
8 CTS

P3

14
13
16
12
15

COLOR

RED
GREEN
BLACK
BROWN
WHITE

CERBERUS CABLE

P/N 555-193085

FieldServer

8917-03

8915-10

Cerberus Cable

555-193085

SPA59132

1

1

3 HARDWARE CONNECTIONS

Configure the MXL/XLS device according to manufacturer’s instructions.

It is possible to connect a MXL/XLS device to any RS-232 or RS-485 port. The appropriate ports must be configured
for MXL/XLS in the configuration file.

3.1 Using the NIM-1R or NIM-1W for MXL

• Configure the NIM-1R

3

or NIM-1W for Foreign System Interface (FSI) by setting all of the switches in SW2

to open (or OFF). See connection diagram below:

• 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.

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: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-40 SBT FSI Driver Manual Page 5 of 29

Configuration 1 – One FSI Panel per FieldServer per port, one Panel per FSI

Configuration 2 – One FSI Panel per FieldServer port, 3 panels connected in series to the FSI

FSI

FSI

FSI

Panel PanelPanel

Panel Panel

FieldServer

P1

18

FieldServer

P1

1818

P2

3.2 FSI Connection Notes

• 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: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-40 SBT FSI Driver Manual Page 6 of 29

Array

Msg_Type

Array

Msg_Type

4 CONFIGURING THE FIELDSERVER AS A SBT- FSI 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” 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:

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

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:

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

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

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

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

Security Alarm Secur

Security Alarm Un-Acknowledged Secur_Ack

Status Status

Test Test

Audible (Un)Silenced Audible

System Reset Reset

FS-8700-40 SBT FSI Driver Manual Page 7 of 29

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
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.

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

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

FS-8700-40 SBT FSI Driver Manual Page 8 of 29

Up to 15

ach Data Array can only take on one

// Data Arrays

4.1 Data Arrays

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.

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Array_Format

Provide data format. E
format.

4

Number of Data Objects. Must be larger than the data storage

Data_Array_Length

area required by the Map Descriptors for the data being placed in
this array.

Example

Data_Arrays
Data_Array_Name ,Data_Format ,Data_Array_Length
Event_Counts ,Uint16 ,19
Fire ,Bit ,2048
Fire_UnAck ,Bit ,2048

alphanumeric
characters

Int16, Uint16, Bit

1-10,000

4

Format must be Uint16 or Int16 to see trouble codes.

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

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

FS-8700-40 SBT FSI Driver Manual Page 9 of 29

.. MXL panels do not currently

6

7

Port

,Protocol

,Baud

,Parity

,Data_Bits

,Poll_Delay

4.2 Client Side Connection Descriptions

Section Title

Connections

Column Title Function Legal Values

Port Specify which port the device is connected to the FieldServer P1-P8, R1-R25

Protocol Specify protocol used

Enables legacy or enhanced protocol

Enhanced_Protocol

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.

System_Type Specifies Siemens Panel type MXL, XLS

Block_Acks

Fire_Alarms_Hold

Specifies if the driver uses block or individual command acks Yes, No

Specifies if the driver should hold fire alarms until the system reset, or
clear on fire alarms going out

Baud* Specify baud rate

Parity* Specify parity

Data_Bits* Specify data bits

Stop_Bits* Specify stop bits

Handshaking

Specify hardware handshaking * None

Poll _Delay* Time between internal polls

Example

Cerberus,
SBT-FSI

Yes (XLS)
No (MXL)

Yes, No

19200
(Vendor
limitation)

Even (Vendor
limitation)

7 (Vendor
limitation)

1 (Vendor
limitation)

0-32000
seconds, 1
second

// Client Side Connections
Connections

P1 ,SBT-FSI ,19200 ,Even ,7 ,0.100s

5

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available

on specific hardware.

6

Refer to the Advanced Driver Manual for usage. This function not enabled on standard driver.

7

Handshaking is not supported.

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

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