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)

A Sierra Monitor Company

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

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

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

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

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

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

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

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

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