FieldServer Carrier DataPort FS-8700-86 Driver Manual

Driver Version:

1.03

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-86 Carrier DataPort

Effective for all systems manufactured after August 2008

APPLICABILITY & EFFECTIVITY

Document Revision: 11

FS-8700-86 Carrier DataPort Table of Contents

TABLE OF CONTENTS

1. CARRIER DATAPORT DESCRIPTION ...........................................................................................3

2. DRIVER SCOPE OF SUPPLY.......................................................................................................... 3

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

3. HARDWARE CONNECTIONS .........................................................................................................4

4. CONFIGURING THE FIELDSERVER AS A CARRIER DATAPORT CLIENT................................ 5

4.1. Data Arrays ................................................................................................................................. 5

4.2. Client Side Connections.............................................................................................................. 6

4.3. Client Side Node Descriptors......................................................................................................7

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

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

4.4.2. Driver Related Map Descriptor Parameters ............................................................................8

4.4.3. Timing Parameters .................................................................................................................. 8

4.4.4. Map Descriptor Example 1 – Read .........................................................................................9

5. CONFIGURING THE FIELDSERVER AS A CARRIER DATAPORT SERVER ............................10

5.1. Data Arrays ............................................................................................................................... 10

5.2. Server Side Connections ..........................................................................................................11

5.3. Server Side Node Descriptors ..................................................................................................11

5.4. Server Side Map Descriptors .................................................................................................... 12

5.4.1. FieldServer Specific Map Descriptor Parameters .................................................................12

5.4.2. Driver Specific Map Descriptor Parameters ..........................................................................12

5.4.3. Timing Parameters ................................................................................................................ 13

5.4.4. Map Descriptor Example. ...................................................................................................... 14

APPENDIX A. ADVANCED TOPICS....................................................................................................15

Appendix A.1. Field Status & Field Engineering Units....................................................................... 15

Appendix A.2. Field / Variable Names ...............................................................................................16

Appendix A.3. Map Descriptor Length Explained .............................................................................. 19

Appendix A.4. How the Client stores the states/values of the Table Variables................................. 19

Appendix A.4.1. Discrete States........................................................................................................ 19

Appendix A.4.2. Time Values ............................................................................................................ 20

Appendix A.4.3. Numeric Values....................................................................................................... 21

Appendix A.4.4. Occupancy Strings / Values .................................................................................... 21

APPENDIX B. TROUBLE SHOOTING/CONNECTIONS - TIPS AND HINTS .....................................22

Appendix B.1. Connection problems. ................................................................................................22

Appendix B.2. Timeouts..................................................................................................................... 22

Appendix B.3. Determining Storage Locations ..................................................................................22

Appendix B.4. How to build a script file that tests a customer log. ....................................................23

APPENDIX C. DRIVER NOTES ...........................................................................................................26

Appendix C.1. Driver Limitations and Exclusions ..............................................................................26

APPENDIX D. DRIVER ERROR MESSAGES ..................................................................................... 27

Appendix D.1. Driver Stats ................................................................................................................31

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-86 Carrier DataPort Page 3 of 32

1. Carrier DataPort Description

The Carrier DataPort driver allows the FieldServer to transfer data to and from devices over either RS­232 or RS-485 using Carrier DataPort protocol. The FieldServer can emulate either a Server or Client.

The DataPort device provides a gateway to CCN devices. This driver polls the DataPort device which in
turn reads data from the CCN devices. Up to 15 system elements may be connected to a DataPort
Device.

Carrier limits the number of CCN devices that can polled from a DataPort Device and also limits the data
that can be transferred between some CCN devices and the DataPort device. For information on these
limitations please consult the Carrier Corporation.

The driver is an active Client driver. This means that it initiates read polls with the DataPort device which
is expected to provide responses. Server functionality is provided by the driver too.

The driver is configured to allow a single Data Table (usually the Display Table) to be read from the CCN
devices via the DataPort device. As the table typically contains more than one data element, the
retrieved data is stored in a number of consecutive Data Array locations in the FieldServer. The driver
can provide descriptions for each of the table values retrieved.

The driver has no advanced knowledge of the CCN devices and their Data Tables. This means that the
driver handles each table in a generic way, without regard for the particular variables that constitute the
tables. The most important consequence of this is that the variable values are stored in the order in
which they appear in the response from the DataPort device. It is not possible to map particular variable
values to particular locations in the FieldServer Data Arrays.

2. Driver Scope of Supply

2.1. Supplied by FieldServer Technologies for this driver

FieldServer Technologies PART # DESCRIPTION

FS-8917-02 RJ45 to DB9F connector adapter
FS-8917-17 RJ45 to DB25M connection adapter
SPA59132 RS-485 connection adapter
FS-8700-86 Driver Manual.

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-86 Carrier DataPort Page 4 of 32

3. Hardware Connections

The FieldServer is connected to the Carrier DataPort device as shown below.

Configure the DataPort Device according to manufacturer’s instructions. This driver requires that the
DataPort device’s DTPCONFIG table has been configured prior to connection with a FieldServer. In
addition, consult the manufacturer’s information on connecting Carrier Device’s to CCN network.

Note: Typical connections are 9600,N,8,1.

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-86 Carrier DataPort Page 5 of 32

4. Configuring the FieldServer as a Carrier DataPort Client

It is not possible to complete a configuration for communication with a DataPort device until you are
familiar with the data available from the devices connected to the DataPort. The DataPort device does not
provide a method for discovering the data tables and variables that are available in all the Carrier devices.

Configuring the DataPort driver as a Client is easy; however, you will not be able to complete the server
side configuration until you have a list of the variables and the order in which the DataPort device will
report them. The driver is capable of helping you determine this information but cannot auto-complete the
configuration. This method is discussed in Appendix A.

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 Carrier DataPort Server.

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

4.1. Data Arrays

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array Up to 15 alphanumeric characters

Data_Format

Data_Array_Length

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

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

Number of Data Objects. Must be larger
than the data storage area required for
the data being placed in this array.

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

FS-8700-86 Carrier DataPort Page 6 of 32

4.2. Client Side Connections

Section Title

Connections

Column Title Function Legal Values

Port

Specify which port the device is connected to the
FieldServer

Baud* Specify baud rate.

Parity* Specify parity
Data_Bits*

Stop_Bits*

Protocol

Specify data bits

Specify stop bits.

Specify protocol used CarrierDP

Handshaking* Specify hardware handshaking

Poll _Delay*

Time between internal polls

Specifies the max amount of time the driver must
wait for a complete response.

Timeout2

If the Data Port table is long then increase the
timeout above the default until timeout errors
disappear.

Application

Refer to notes in Appendix B.3 Print_storage_locations
If the parameter is not configured or set to 0

(default), the driver will identify the start of a
message as FORMFEED (0x0C) and the end as two
carriage returns (0x0D 0x0D)

Start_Method*

When the parameter is set to 1, the first carriage
return (0x0D) will be considered the start of the
message (all characters before the first carriage
return will be ignored). and the end as two carriage
returns (0x0D 0x0D)

Example

// Client Side Connections

Connections
Port, Baud, Parity, Data_Bits, Stop_Bits, Protocol , Handshaking, Poll_Delay
P8, 9600, None, 8 , 1 , CarrierDP, None , 0.100s

P1-P8, ( R1, R2 with
converter)1
600 , 1200, 2400, 9600
(Vendor limitation)

None (Vendor limitation)
8 (Vendor limitation)

1 (Vendor limitation)

None
0-32000 seconds, 1
second

2 seconds

1,0

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.

2

See Appendix B.1 for additional information

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-86 Carrier DataPort Page 7 of 32

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
These correspond to the ‘devices’ configured in the
DTPConfig. Thus the Node_ID is not the address of the final
CCN device.

Node_ID

1-15
The DataPort DTPConfig table maps a device number
(1...15) to a bus number (0-239). Use the Node_ID to tell the
driver which device to use.

Protocol Specify protocol used CarrierDP
Port Specify which port the device is connected to the FieldServer P1-P8, R1-R23

Example

// Client Side Nodes

Nodes
Node_Name, Node_ID, Protocol , Port
FAN1 , 1 , CarrierDP, P8

3

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

FS-8700-86 Carrier DataPort Page 8 of 32

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 Up to 32 alphanumeric characters

Data_Array_Name

Data_Array_Location Starting location in Data Array

Function Function of Client Map Descriptor Rdbc, Wrbc, Wrbx

Name of Data Array where data is
to be stored in the FieldServer

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

4.4.2. Driver Related Map Descriptor Parameters

Column Title Function Legal Values

One of the node names

Node_Name Name of Node to fetch data from

Data_Type

Length

Address This commonly used parameter is not required for this driver.

Store_As*

DA_Byte_Name*

DA_Float_Name*

This commonly used parameter is not
required for this driver.

Length of Map Descriptor. When reading a
compete table, set the length to the
maximum number of data values you want
stored.

Additional information on the length
parameter is provided in Appendix A.3.

Use the ASCII or AsciiLog format when
you are discovering the variables
contained in a table by reading a table.

Refer to Appendix A for more information.

If defined, the driver stores the ‘field status’
value in this array.

If defined, the driver stores the ‘field units’
value in this array.

specified in “Client Node
Descriptor” above

1 – 1000

ASCII, AsciiLog, Values

The name of a Data Array
defined in the Data_Array
section of the configuration file.
The name of a Data Array
defined in the Data_Array
section of the configuration file.

4.4.3. Timing Parameters

Column Title Function Legal Values

Scan_Interval Rate at which data is polled >0.1s

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

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

The length is set

to a number big

enough to contain

all the table’s

variables.

element at offset 2 ….and the driver stores the number of

nd

The Node_Name

connects the Map

Descriptor to a

element at offset 1, the 2

st

The driver

generates a read

poll continuously.

Node definition.

4.4.4. Map Descriptor Example 1 – Read

FS-8700-86 Carrier DataPort Page 9 of 32

This example illustrates how to read data from the DataPort.

Some basics first: The Map Descriptor is connected to a node by means of the node name and a node definition provides a connection to a port.

Thus this Map Descriptor is connected to a port via its node. The FieldServer will use that port to send this poll. The poll will be generated every 5

seconds in this example.

The values extracted from the response will be stored in the array called DA_DISPLAY. Ensure that it is suitable format for storing number –

FLOAT is suggested. The driver stores the value of the 1

table elements whose values have been successfully stored at offset zero.

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

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

Responses get

stored in this Data

element x gets

stored at offset x,

where x is a non-

zero integer.

Offset zero is used

by the driver to

report how many

Array. Table

// Client Side Map Descriptors

Map Descriptors

Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Length, Scan_Interval

Read_Table_Md , Da_Display , 0 , Rdbc , FAN01 , 100 , 5.0s

value were stored.

FS-8700-86 Carrier DataPort Page 10 of 32

5. Configuring the FieldServer as a Carrier DataPort 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” sample files provided with the FieldServer).

This section documents and describes the parameters necessary for configuring the FieldServer to
communicate with a Carrier DataPort Client.

The FieldServer can be configured to emulate a Carrier DataPort Device. The user is able to define a
variable quantity of variables. The FieldServer may be polled and will respond like a DataPort device.

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

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Format

Data_Array_Length

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

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

Number of Data Objects. Must be larger
than the data storage area required for
the data being placed in this array.

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