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
Driver Version:
1.02
Document Revision: 22
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.
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 #
Description
FS-8915-10
FS-8915-10
FS-8917-02
FS-8917-01
UTP cable (7 foot) for Ethernet connection
UTP cable (7 foot) for RS-232 use
RJ45 to DB9F connector adapter
RJ45 to DB25M connection adapter
RS-485 connection adapter
SPA59132
FS-8700-19
Driver Manual.
2.2.
2.2.1.
Provided by the Supplier of 3rd Party Equipment
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
FS-8700-19_Metasys_N2 Driver Manual
Page 5 of 51
3.
Hardware Connections
FieldServer as a Client
N2 bus
3rd Party
System
FieldServer
N2 devices
FieldServer as a Server
N2 bus
NCM, N30 or
other N2 client
(408)-262-2299
MetasysN2
CONNECTION DIAGRAM
3rd Party
System
FieldServer
N2 devices
BASE NAME:
FILE NAME: FS-8700-19
DATE: 05/31/06
BY: MC
3.1.
Hardware Connection Tips / Hints
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.
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
Up to 15 alphanumeric
characters
Data_Array_Name
Provide name for Data Array
Float, Bit, UInt16, SInt16,
Provide data format. Each Data Array Packed_Bit, Byte,
Data_Array_Format
Data_Array_Length
can only take on one format.
Packed_Byte,
Swapped_Byte
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
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Format,
UInt16,
UInt16,
Bit,
Data_Array_Length
200
200
200
200
DA_DO_01,
Bit,
FS-8700-19_Metasys_N2 Driver Manual
Page 7 of 51
4.2.
Client Side Connection Descriptions
Section Title
Connections
Column Title
Function
Specify which port the device is
connected to the FieldServer
Specify protocol used
Specify baud rate
Legal Values
P1-P8, R1-R21
Port
Protocol
Baud*
Parity*
Metasys_N2
9600
None
8
Specify parity
Specify data bits
Data_Bits*
Stop_Bits*
Specify stop bits
1
Handshaking*
Poll _Delay*
Specify hardware handshaking
Time between internal polls
Duration of RTS assert before
start of transmission
None
0
Line_Drive_On*
0.001s
Duration of RTS assert after
end of transmission
Line_Drive_Off*
0.000s
Example
// Client Side Connections
Connections
Port,
R1,
Protocol
Metasys_N2
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.
FS-8700-19_Metasys_N2 Driver Manual
Page 8 of 51
4.3.
Client Side Node Descriptors
Section
Title
Nodes
Column
Title
Function
Legal Values
Up to 32
Node_Name Provide name for node
alphanumeric
characters
1-255
Node_ID
Protocol
Station address of physical Server node
Specify protocol used
Metasys_N2
Specify which port the device is connected to the
FieldServer
Connection
P1-P8, R1-R21
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 N2OpenClient,
Node_Type
to check the Node parameters.
DX9100, VMA,
N2Open
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,
PLC 1,
Node_ID,
1,
Protocol,
Metasys_N2,
Connection,
P8,
Node_Type
VMA
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Column Title
Function
Name of this Map
Descriptor
Legal Values
Up to 32 alphanumeric
characters
Map_Descriptor_Name
Name of Data Array
where data is to be
One of the Data Array names
from “Data Array” section
Data_Array_Name
stored in the FieldServer above
Starting location in Data 0 to maximum specified in
Data_Array_Offset
Function
Array
“Data Array” section above
Function of Client Map
Descriptor
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.
Column Title
N2Open Map Descriptor Parameters
Function
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
If the vendor device lists a
point as BD then use
Data_Type=Byte.
Node_Name
Data_Type
Name of Node to fetch data from
If the vendor device lists a
point as ADI then use
Data_Type=Integer.
Data type
If the vendor device lists a
point as ADF then use
Data_Type=Float_Reg.
AI, AO, DI, DO,
Float_Reg, Integer, Byte
Length
Address
Length of Map Descriptor
Starting address of read block
Used to specify an N2-specific
function, e.g. COS. See
1
1-256
MN2_Function*
MN2_Attribute*
COS, Override, Release
description below.
Used to specify the attribute if an
attribute other than Current Value
is to be accessed. See attribute
table below
See
N2Open Attribute Table
FS-8700-19_Metasys_N2 Driver Manual
Data Type
Page 10 of 51
N2Open Attribute Table
Attribute No.
Attribute
Object Configuration
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 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
Analog Input
Binary Input
Analog Output
Current Value
Object Configuration
Object Status
Minimum On-Time
Minimum Off-Time
Maximum Cycles/Hour
Object Status
Binary Output
Internal Float
Internal Integer
Internal Byte
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:
FS-8700-19_Metasys_N2 Driver Manual
Page 11 of 51
Point Type
AI
Conditions that will trigger a COS report
point status change (e.g. override)
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!
AO
BI, BO
point status change (e.g. override); includes current value (On/Off)
ADI, ADF, BD 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
AI, AO, DI, DO, Driver
(used for ADF, ADI and
BD)
Name of Node to fetch
data from
Node_Name
Data_Type
Data type
Length
Length of Map Descriptor
Starting address of read
block
1
Address
1-256
Data type specifier to be
set when Data_Type has
been set to Driver
MN2_Type
5-7
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.
FS-8700-19_Metasys_N2 Driver Manual
Page 12 of 51
Driver Data_Type
MN2_Type values
Point Type
Known Value2
Suggested Value3
AI
AO
BI
BO
ADF
ADI
BD
1
2
3
4
5
6
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
3
For information only. Do not use Driver type for these, but specify AI, AO, BI or BO directly in the Data_Type field.
These values are believed to be correct for the corresponding point types, but no guarantee can be given at this time.
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
1
Name of Node to fetch
data from
Node_Name
Length
Length of Map Descriptor
Starting address of read
block
Address
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.
Column Title
Scan_Interval
Timing Parameters
Function
Rate at which data is polled
Legal Values
≥0.001s
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
Port
Function
Specify which port the device is
connected to the FieldServer
Specify protocol used
Specify baud rate
Legal Values
P1-P8, R1-R24
Protocol
Baud*
Metasys_N2
9600
None
8
Parity*
Specify parity
Data_Bits*
Specify data bits
Stop_Bits*
Specify stop bits
1
Handshaking*
Poll _Delay*
Specify hardware handshaking None
Time between internal polls
Duration of RTS assert before
start of transmission
0
Line_Drive_On*
0.001s
Duration of RTS assert after
end of transmission
Line_Drive_Off*
0.000s
Example
// Server Side Connections
Connections
Port,
P8,
Protocol
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.
FS-8700-19_Metasys_N2 Driver Manual
Page 17 of 51
Legal Values
5.2.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Function
Up to 32
Node_Name
Provide name for node
alphanumeric
characters
MetasysN2 station address of physical
Server node
Specify protocol used
Node_ID
Protocol
1-255
Metasys_N2
Specifies time FieldServer will reserve
Server_Hold_Timeout* Server side connection while waiting for the < 0.175s5
Client side to update data in Data_Array
Identify type of device
This parameter need not be specified. The
N2OpenServer,
N2Open
Node_Type*
Server side of the driver can only operate
as an N2 Server and the option for setting it
to N2Open is purely for backward
compatibility.
Example
// Server Side Nodes
Nodes
Node_Name,
PLC 1,
Node_ID,
1,
Protocol
Metasys_N2
5 Can be set to >0.175s if the Client has bee set to timeout after >200ms. Refer to Appendix E for more
information.
FS-8700-19_Metasys_N2 Driver Manual
Page 18 of 51
5.3.
5.3.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Name of this Map
Descriptor
Legal Values
Up to 32 alphanumeric
characters
Map_Descriptor_Name
Name of Data Array where
data is to be stored in the
FieldServer
One of the Data Array
names from “Data Array”
section above
Data_Array_Name
Starting location in Data
Array
Function of Server Map
Descriptor
0 to maximum specified in
“Data Array” section above
Data_Array_Offset
Function
Server
5.3.2.
Column
Driver Specific Map Descriptor Parameters
Function
Legal Values
Title
Name of Node to
fetch data from
One of the node names specified in “Client
Node Descriptor” above
Node_Name
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.
Data_Type
Data type
If the vendor device lists a point as ADF then
use Data_Type=Float_Reg.
AI, AO, DI, DO, Float_Reg, Integer, Byte
Length of Map
Descriptor
Length
1 - 256
Starting address of
read block
Address
1 - 256
FS-8700-19_Metasys_N2 Driver Manual
Page 21 of 51
Appendix A.2. Managing Analog Inputs and Outputs for DX9100.
Relative offset for viewing an AI is 7
Relative offset for viewing and forcing an AO is 6
FS-8700-19_Metasys_N2 Driver Manual
Page 22 of 51
Appendix B. Troubleshooting tips
Appendix B.1. Connection Tips & Hints
When using the FieldServer as an N2 Client, make very sure that it is the only Client /
master on the N2 network. If there is another Client on the network there will be
communication conflicts. These will be reflected on the FieldServer as protocol errors.
Appendix B.2. Offline Behavior
When the Client node on the FieldServer goes offline, the corresponding data objects on the
FieldServer are also marked offline. If a client polls a virtual FieldServer node for this
particular data, therefore, an offline response will be returned by the FieldServer. A request
from an master device for a FieldServer to identify itself would be met by a valid response,
however. This could lead to confusion and status toggling. This can be addressed using
Responsible Map Descriptors and by configuring the virtual FieldServer using the
Offline_Method option. Please refer to the Configuration Manual for further information.
Appendix B.3. Tip on Overrides
It is important that there be only one device (including the slave device itself) updating a
point which is in overridden mode. The reason for this is that the value of the point could be
changed by an update from a non-Metasys Server before the override is released by the
Metasys Master. In this case, the FieldServer would respond to a poll from the Master with
this changed data.
|