FieldServer FS-8700-19 User Manual

Driver Version:

1.02

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-19 Metasys N2

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after May 1, 2001

Document Revision: 22

FS-8700-19_Metasys_N2 Driver Manual Table of Contents

TABLE OF CONTENTS

1.

Metasys N2 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

2.2.1. Hardware................................................................................................................ 4

2.2.2. Required 3rd Party Software.................................................................................... 4

2.2.3. Required 3rd Party Configuration............................................................................. 4

3.

Hardware Connections .................................................................................................. 5

3.1.

Hardware Connection Tips / Hints.............................................................................. 5

4.

Configuring the FieldServer as a Metasys N2 Client ................................................... 6

4.1.

Data Arrays/Descriptors............................................................................................. 6

4.2.

Client Side Connection Descriptions .......................................................................... 7

4.3.

Client Side Node Descriptors ..................................................................................... 8

4.4.

Client Side Map Descriptors....................................................................................... 8

4.4.1. FieldServer Related Map Descriptor Parameters.................................................... 8

4.4.2. Driver Related Map Descriptor Parameters............................................................. 9

4.4.3. Timing Parameters ................................................................................................13

4.4.4. Map Descriptor Example 1 – N2Open....................................................................14

4.4.5. Map Descriptor Example 2 - VMA..........................................................................14

4.4.6. Map Descriptor Example 3 - DX9100.....................................................................15

5.

Configuring the FieldServer as a Metasys N2 Server .................................................16

5.1.

Server Side Connection Descriptors .........................................................................16

5.2.

Server Side Node Descriptors...................................................................................17

5.3.

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

5.3.1. FieldServer Specific Map Descriptor Parameters...................................................18

5.3.2. Driver Specific Map Descriptor Parameters ...........................................................18

5.3.3. Map Descriptor Example........................................................................................19

Appendix A. Advanced Topics...........................................................................................20

Appendix A.1. Writing to DX9100 Binary Outputs................................................................20

Appendix A.2. Managing Analog Inputs and Outputs for DX9100. ......................................21

Appendix B. Troubleshooting tips.....................................................................................22

Appendix B.1. Connection Tips & Hints...............................................................................22

Appendix B.2. Offline Behavior ...........................................................................................22

Appendix B.3. Tip on Overrides ..........................................................................................22

Appendix C. Setting up FS-B20 for RS-485.......................................................................23

Appendix C.1. Jumper Settings:..........................................................................................23

Appendix C.2. Hardware connections .................................................................................25

Appendix C.3. Configuration Settings..................................................................................25

Appendix D. Memory Maps ................................................................................................26

Appendix D.1. Metasys DX9100 Memory Map....................................................................26

Appendix D.2. Metasys DC9100 Memory Map....................................................................33

Appendix D.3. Metasys TC9100 Memory Map ....................................................................40

Appendix E. Error Messages .............................................................................................50

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 3 of 51

1. Metasys N2 Description

The Metasys N2 network supports communications with a diverse range of devices. Many N2
compatible devices use their own version of the protocol and care must be taken to ensure that
the device of interest is covered by the FieldServer implementation.

At present the FieldServer N2 driver will support communications with the following devices or
device classes when acting as a Client:

1. N2Open-compliant devices. N2Open is a published N2-compatible protocol enabling 3rd
party device vendors to integrate with N2.

2. VMA 1400 series (with restrictions, as described in this document)

3. DX9100 and XT9100

When acting as a Server, the FieldServer N2 driver can emulate an N2Open device only.

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 4 of 51

2. Driver Scope of Supply

2.1. Supplied by FieldServer Technologies for this driver

FieldServer Technologies

PART #

FS-8915-10 UTP cable (7 foot) for Ethernet connection
FS-8915-10 UTP cable (7 foot) for RS-232 use
FS-8917-02 RJ45 to DB9F connector adapter
FS-8917-01 RJ45 to DB25M connection adapter
SPA59132 RS-485 connection adapter
FS-8700-19 Driver Manual.

Description

2.2. Provided by the Supplier of 3rd Party Equipment

2.2.1. Hardware

PART # DESCRIPTION

Metasys NCU or other device

2.2.2. Required 3rd Party Software

Depending on application, JCI software may be necessary

2.2.3. Required 3rd Party Configuration

Depending on application, third party devices may need configuration

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 5 of 51

06

3. Hardware Connections

FieldServer as a Client

3rd Party

System

FieldServer

N2 bus

N2 devices

FieldServer as a Server

NCM, N30 or

other N2 client

N2 bus

N2 devices

FieldServer

3rd Party

System

3.1. Hardware Connection Tips / Hints

MetasysN2

CONNECTION DIAGRAM

BASE NAME:
FILE NAME: FS-8700-19

(408)-262-2299

DATE: 05/31/
BY: MC

When using the FS-X40 ensure that the FieldServer is connected to the network using one
or both of the RS-485 ports marked R1 and R2. If more ports are required, P1-P8 may be
used in conjunction with an RS-232-to-RS-485 converter.

When using the FS-X20, ensure that the serial port is configured as an RS-485 port. Refer
to Appendix B.3 for more information.

Only one N2 Client may be connected to a N2 network. If the FieldServer is to act as a
Client, ensure that no other Clients are connected to the same N2 network.

Note: Interceptor mode is no longer supported for this driver.

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 6 of 51

4. Configuring the FieldServer as a Metasys N2 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 Metasys N2 Server.

4.1. Data Arrays/Descriptors

The configuration file defines the FieldServer interfaces, and the data routing required. In
order to enable the FieldServer for Metasys N2 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.

Note that in the tables, * indicates an optional parameter, with the bold legal value being the
default value. Where only one legal value is given, no other values for that parameter are
allowed.

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Array_Format

Provide data format. Each Data Array
can only take on one format.

Number of Data Objects. Must be

Data_Array_Length

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

Example

// Data Arrays

Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length
DA_AI_01, UInt16, 200
DA_AO_01, UInt16, 200
DA_DI_01, Bit, 200
DA_DO_01, Bit, 200

Up to 15 alphanumeric
characters
Float, Bit, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte

1-10,000

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 7 of 51

4.2. Client Side Connection Descriptions

Section Title

Connections

Column Title Function Legal Values

Port

Protocol Specify protocol used Metasys_N2
Baud* Specify baud rate
Parity* Specify parity
Data_Bits* Specify data bits

Stop_Bits* Specify stop bits

Handshaking* Specify hardware handshaking
Poll _Delay* Time between internal polls

Line_Drive_On*

Line_Drive_Off*

Example

// Client Side Connections

Connections
Port, Protocol
R1, Metasys_N2

Specify which port the device is
connected to the FieldServer

Duration of RTS assert before
start of transmission
Duration of RTS assert after
end of transmission

P1-P8, R1-R21

9600
None
8

1
None
0

0.001s

0.000s

1

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

manual for details of the ports available on specific hardware.

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 8 of 51

4.3. Client Side Node Descriptors

Section

Title

Nodes

Column

Title

Node_Name Provide name for node

Node_ID Station address of physical Server node 1-255
Protocol Specify protocol used Metasys_N2

Connection

Specify which port the device is connected to the
FieldServer
Identify type of device

If this parameter is omitted the driver treats the
configuration as a N2Open configuration and marks
the Node_Type as N2OpenClient when using Ruinet

Node_Type

to check the Node parameters.

If the Node_Type is specified as N2Open then the
driver still acts as N2 Open configuration but some
legacy port expander functionality used in some
legacy advanced configuration is enabled.

Example

// Client Side Nodes

Nodes
Node_Name, Node_ID, Protocol, Connection, Node_Type
PLC 1, 1, Metasys_N2, P8, VMA

Function Legal Values

Up to 32
alphanumeric
characters

P1-P8, R1-R2

1

N2OpenClient,
DX9100, VMA,
N2Open

4.4. Client Side Map Descriptors

4.4.1. FieldServer Related Map Descriptor Parameters

Column Title Function Legal Values

Map_Descriptor_Name

Name of this Map
Descriptor
Name of Data Array

Data_Array_Name

where data is to be
stored in the FieldServer

Data_Array_Offset

Function

Starting location in Data
Array
Function of Client Map
Descriptor

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

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

Up to 32 alphanumeric
characters
One of the Data Array names
from “Data Array” section
above
0 to maximum specified in
“Data Array” section above

RDBC, WRBC, WRBX

FS-8700-19_Metasys_N2 Driver Manual Page 9 of 51

4.4.2. Driver Related Map Descriptor Parameters

4.4.2.1. N2Open Map Descriptor Parameters

Column Title Function Legal Values

One of the node names

Node_Name Name of Node to fetch data from

Data_Type Data type

Length Length of Map Descriptor 1
Address Starting address of read block 1-256

Used to specify an N2-specific

MN2_Function*

function, e.g. COS. See
description below.
Used to specify the attribute if an

MN2_Attribute*

attribute other than Current Value
is to be accessed. See attribute
table below

specified in “Client Node
Descriptor” above
If the vendor device lists a
point as BD then use
Data_Type=Byte.

If the vendor device lists a
point as ADI then use
Data_Type=Integer.

If the vendor device lists a
point as ADF then use
Data_Type=Float_Reg.

AI, AO, DI, DO,
Float_Reg, Integer, Byte

COS, Override, Release

See
N2Open Attribute Table

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 10 of 51

N2Open Attribute Table

Data Type Attribute No. Attribute

Analog Input

Binary Input

Analog Output

Binary Output

Internal Float

Internal Integer

Internal Byte

1
2

3

4
5
6
7
8
1
2
1
2
3
1
2
3
4
5
1
2
1
2
1
2

Object Configuration
Object Status

Analog Input Value

Low Alarm Limit
High Alarm Limit
Low Warn Limit
High Warn Limit
Differential
Object Configuration
Object Status
Object Configuration
Object Status
Current Value
Object Configuration
Object Status
Minimum On-Time
Minimum Off-Time
Maximum Cycles/Hour
Object Status
Current Value
Object Status
Current Value
Object Status
Current Value

Using Change of State (COS) – N2Open

If a large number of points are to be monitored, optimal efficiency is achieved by
using the COS mechanism instead of reading each individual point directly. A
N2Open device responds to a COS poll with a change record if a change has taken
place. On startup the device will report the state of all its points when it receives a
COS poll.

Two kinds of Map Descriptors are required for every node that is to be monitored
using COS:

A COS polling Map Descriptor with Function set to COS_Poll.

A COS_Read (i.e. Function set to COS_Read) Map Descriptor for every point
on that node that is to be monitored. Any COS records received will be stored to
the matching Map Descriptor data location.

Note that the COS_Read Map Descriptor has an optional scan_interval. If a value is
set the Map Descriptor will poll at that rate in addition to receiving COS data. This
can be used if the values are to be refreshed continually even if they don’t change. If
the scan_interval is not configured (through omitting the column, or by setting the
value to ‘-‘) the COS_Read Map Descriptor will not cause active polls once the value
has been initialized. See 4.4.4 for example.

Important Note on COS Operation in N2Open

Please be aware that N2Open devices will only report value changes under the
following conditions:

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 11 of 51

Point Type Conditions that will trigger a COS report

point status change (e.g. override)

AI

AO

BI, BO

ADI, ADF, BD

change in alarm or warning status

NB: no value changes within the normal band are reported by COS!

point status change (e.g. override)
NB: no value changes within the normal band are reported by COS!
point status change (e.g. override); includes current value (On/Off)
none; COS cannot be used with internal data types.

Using Override and Release – N2Open

It is not normally necessary to use the Override command explicitly as the
FieldServer automatically uses this command when the Current Value attribute of a
point is written. For any other attribute it uses the Write command. It will sometimes
be necessary to send a Release command to an overridden point, however. To do
this, a Map Descriptor must be configured with Function set to wrbx and
MN2_Function set to Release. Then, when any value is stored to the Map
Descriptor data location, the Release command will be sent to the N2Open point
specified by the Map Descriptor.

4.4.2.2. VMA Map Descriptor Parameters

Column Title Function Legal Values

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

Node_Name

Name of Node to fetch
data from

AI, AO, DI, DO, Driver

Data_Type Data type

(used for ADF, ADI and
BD)

Length Length of Map Descriptor 1

Address

Starting address of read
block

1-256

Data type specifier to be

MN2_Type

set when Data_Type has

5-7

been set to Driver

ADI, ADF and BD types: using the “Driver” Data_Type and MN2_Type fields

The VMA protocol uses a byte value to specify the data types. The standard types

AI, AO, DI and DO correspond to a byte value of 1 through 4 respectively. The types
ADF, ADI and BD are believed to correspond to a byte value of 5 through 7

respectively. If the user wishes to use any other type value based on knowledge of a
particular VMA configuration, then that value may also be specified here. Refer to
Section 4.4.5 for a specific example.

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 12 of 51

Driver Data_Type
MN2_Type values
Point Type Known Value

2

Suggested Value

3

AI 1
AO 2
BI 3
BO 4
ADF 5
ADI 6
BD 7

If a large number of points are to be monitored, optimal efficiency is achieved by
using the COS mechanism instead of reading each individual point directly. An
N2Open device responds to a COS poll with a change record if a change has taken
place. On startup the device will report the state of all its points when it receives a
COS poll.

Three kinds of Map Descriptors are required for every node that is to be monitored
using COS:

• A COS initialization Map Descriptor with Function set to ARS and
MN2_Function set to COS_Enable. This Map Descriptor enables COS polling

of those points on the VMA for which Passive Map Descriptors exist.

• A COS polling Map Descriptor with Function set to rdbc and MN2_Function set
to COS.

• A Passive (i.e. Function set to Passive) Map Descriptor for every point on that
node that is to be monitored. Any COS records received will be stored to the
matching Map Descriptor data location.

See example in Section 4.4.5

Using Override and Release - VMA

It is normally not necessary to use the Override command explicitly as the
FieldServer automatically uses this command when the Current Value attribute of a
point is written. For any other attribute it uses the Write command. It will sometimes
be necessary to send a Release command to an overridden point, however. To do
this, a Map Descriptor must be configured with Function set to wrbx and
MN2_Function set to Release. Then, when any value is stored to the Map
Descriptor data location, the Release command will be sent to the VMA point
specified by the Map Descriptor.

Note: The VMA Release function only works for analog and binary inputs (AI and
BI). Outputs may be restored to their original value using an explicit write command.

2

For information only. Do not use Driver type for these, but specify AI, AO, BI or BO directly in the Data_Type field.

3

These values are believed to be correct for the corresponding point types, but no guarantee can be given at this time.

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

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

FS-8700-19_Metasys_N2 Driver Manual Page 13 of 51

4.4.2.3. DX9100 Map Descriptor Parameters

Column Title Function Legal Values

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

Node_Name

Name of Node to fetch
data from

Length Length of Map Descriptor 1

Address

Starting address of read
block

0 - 2397

For DX9100 addresses please refer to the DX9100 user documentation. This lists
the name, function (read/write) and data format of all available points. Alternatively,
obtain assistance from FieldServer Technical Support.

4.4.3. Timing Parameters

Column Title Function Legal Values

Scan_Interval Rate at which data is polled ≥0.001s

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

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

Release function used in conjunction with

wrbx. If the Data Array value specified in this

Map Descriptor is changed, then a Release

command is sent to the specified point.

Node_name Address Data_Type Scan_Interval

MN2_Function

,

COS_Read Map

Descriptor sets point type

the same as normal read

Map Descriptor. Optional

scan_interval.

COS_Poller Map

Descriptor. This only

specifies the

Function, Node and

Scan_Interval.

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

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

4.4.4. Map Descriptor Example 1 – N2Open

Normal read Map Descriptor.

Note RDBC function,

Data_Type and Address

specification.

FS-8700-19_Metasys_N2 Driver Manual Page 14 of 51

// Client Side Map Descriptors

Map_Descriptors

Map_Descriptor_Name, DA_Name, DA_Offset, Function,

COS_POLLER, DA_COS, 0, COS_Poller, -, Node_A, -, -, 30s

AI_READ, DA_AI3, 0, RDBC, -, Node_A, 1, Ana_Input 5s

BI_BY_COS, DA_BI, 3, COS_Read, -, Node_A, 2, Dig_Input, 10

AI_BY_COS, DA_AI3, 1, COS_Read, -, Node_A, 1, Ana_Input, -

AI_1_Release, DA_Release, 0, WRBX, Release, Node_A, 1, Ana_Input, -

Note:

To get change of state (COS) reports from an analog port, the warning/alarm levels need to be configured. If the alarm/warning

values are not known, then it would be better to configure an RDBC Map Descriptor which reads the analog input directly. Limits will

then not be required.

4.4.5. Map Descriptor Example 2 - VMA

// Client Side Map Descriptors

Map_Descriptors

Map_Descriptor_Name, DA_Name, DA_Offset, Function, MN2_Function, Node_name, Address, Data_Type, MN2_Type, Scan_Interval

AI_READ, DA_AI3, 0, RDBC, -, Node_VMA, 1, Ana_Input -, 5s

Special_type, DA_DRV, 10, RDBC, -, Node_VMA, 23, Driver, 5, 10s

AO_WRITE, DA_AO, 0, WRBX, -, Node_VMA, 3, Ana_Output, -, 30s

AO_Release, DA_AO, 0, WRBX, Release, Node_VMA, 3, Ana_Output, -, -

Override release function configured as wrbx. Driver type 5 (ADF) configured here.

The address alone is sufficient to specify DX9100

point. The Data Type is determined by the device.

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

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

4.4.6. Map Descriptor Example 3 - DX9100

FS-8700-19_Metasys_N2 Driver Manual Page 15 of 51

// Client side Map Descriptors

Map_Descriptors

Map_Descriptor_Name, DA_Name, DA_Offset, Function, Node_name, Address, Scan_Interval

D191_ZN1-T, DA_AI3, 0, RDBC, Node_DX, 1223, 5s

D191_ZN1-S, DA_AO3, 0, WRBX, Node_DX, 1225, -

FS-8700-19_Metasys_N2 Driver Manual Page 16 of 51

5. Configuring the FieldServer as a Metasys N2 Server

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

This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a Metasys N2Open Client. Note that only the N2Open variation of the
N2 protocol may be used when configuring the FieldServer as a Server.

The configuration file tells the FieldServer about its interfaces, and the routing of data required.
In order to enable the FieldServer for Metasys N2 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.

5.1. Server Side Connection Descriptors

Section Title

Connections

Column Title Function Legal Values

Port

Specify which port the device is
connected to the FieldServer

P1-P8, R1-R24

Protocol Specify protocol used Metasys_N2
Baud* Specify baud rate
Parity* Specify parity
Data_Bits* Specify data bits

Stop_Bits* Specify stop bits

Handshaking* Specify hardware handshaking
Poll _Delay* Time between internal polls

Line_Drive_On*

Line_Drive_Off*

Duration of RTS assert before
start of transmission
Duration of RTS assert after
end of transmission

9600
None
8

1
None
0

0.001s

0.000s

Example

// Server Side Connections

Connections
Port, Protocol
P8, Metasys_N2

4

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

manual for details of the ports available on specific hardware.

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

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