FieldServer FS-8700-82 User Manual

Driver Version:

1.03

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-82 Carrier DataLink

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after May 1, 2001

Document Revision: 5

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

-

82 Carrier DataLink

Table of Contents

TABLE OF CONTENTS

1.

Carrier DataLink Description..........................................................................................3

2.

Driver Scope of Supply...................................................................................................4

2.1.

Supplied by FieldServer Technologies for this driver ..................................................4

2.2.

Provided by Suppler of 3rd Party Equipment................................................................4

3.

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

4.

Configuring the FieldServer as a Carrier DataLink 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..................................................................................................9

4.4.4. Map Descriptor Example 1 – Read a Table ...........................................................10

4.4.5. Map Descriptor Example 2 – Read a Variable.......................................................11

4.4.6. Map Descriptor Example 3 – Write A Variable.......................................................11

4.4.7. Map Descriptor Example 4 – Write Day of Week (DOW) or Time..........................12

5.

Configuring the FieldServer as a Carrier DataLink Server.........................................13

5.1.

Server Side Connection Descriptors.........................................................................13

5.2.

Server Side Nodes....................................................................................................14

5.3.

Server Side Map Descriptors....................................................................................15

5.3.1. FieldServer Specific Map Descriptor Parameters...................................................15

5.3.2. Driver Specific Map Descriptor Parameters...........................................................15

5.3.3. Timing Parameters................................................................................................16

5.3.4. Map Descriptor Example.......................................................................................17

5.4.

Driver Limitations and Exclusions .............................................................................18

Appendix A. Advanced Topics ..........................................................................................19

Appendix A.1. Table Names...............................................................................................19

Appendix A.2. Using the Carrier Datalink Driver to Obtain Field Names.............................21

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

Appendix A.3.1. Client Reads a Table:............................................................................23

Appendix A.3.2. Client reads a variable:..........................................................................23

Appendix A.3.3. Client writes a variable:..........................................................................23

Appendix A.3.4. Server:...................................................................................................23

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

Appendix A.4.1. Discrete States......................................................................................23

Appendix A.4.2. Extending the List of Discrete State Words............................................24

Appendix A.4.3. Time Values ..........................................................................................25

Appendix A.4.4. Numeric Values.....................................................................................25

Appendix A.4.5. Occupancy Strings / Values...................................................................25

Appendix A.5. Timing Considerations.................................................................................25

Appendix B. Carrier DataLink Device Error Response ....................................................26

Appendix C. Driver Notes...................................................................................................27

Appendix C.1. Driver Stats..................................................................................................27

Appendix D. Driver Error Messages..................................................................................29

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

-

82 Carrier DataLink

Page

3

of 31

1. Carrier DataLink Description

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

The Carrier DataLink Serial Driver allows variables to be read and written in system elements
connected to a Carrier Comfort Network communication bus. Up to 15 system elements may be
connected to a DataLink Device. Display, Occupancy, Set Point Tables and Carrier Comfort
Network (CCN) variables may be read or written.

The DataLink device provides a gateway to CCN devices. This driver polls the DataLink device
which in turn reads/writes data to the CCN devices.

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

The driver is an active client driver. This means that it initiates read/write polls with the DataLink
device which is expected to provide responses. Server functionality is not intended to provide
full emulation of DataLink Devices but can be extended on request.

The driver is configured to allow data tables to be read from the CCN devices via the DataLink
device. As the tables typically contain more than one data element, the retrieved data is stored
in a number of consecutive FieldServer data array locations in the FieldServer. The individual
values cannot be scaled before they are stored. The driver can provide descriptions for each of
the table values retrieved. Descriptions are stored in ASCII in a separate data array.

The driver can be configured to read a specific variable from a CNN device and store its value
using optional scaling in a configurable location in a FieldServer data array.

The driver can be configured to write a value (using optional scaling) from a FieldServer data
array to a specific variable in a CNN device, provided that the variable allows its value to be
written.

The driver has no advanced knowledge of the CCN devices and their data tables. Therefore it
cannot validate table names or variable names specified in the configuration file. This means
that the driver handles each table in a generic way, without regard for the particular variables
that constitute the tables.

It is important that you understand the limitations and exclusions of this driver. Refer to Section

5.4 for more information.

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

-

82 Carrier DataLink

Page

4

of 31

2. Driver Scope of Supply

2.1. Supplied by FieldServer Technologies for this driver

FieldServer Technologies PART # DESCRIPTION

FS-8915-10 UTP cable (7 foot) for RS-232 use
FS-8917-17 RJ45 to DB25M connection adapter
FS-8700-82 Driver Manual.

2.2. Provided by Suppler of 3rd Party Equipment

PART # DESCRIPTION

Carrier DataLink Card

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

-

82 Carrier DataLink

Page

5

of 31

3. Hardware Connections

The FieldServer is connected to the Carrier DataLink device as shown below. Ensure that the
device to be connected to is in fact the DataLink device and not the DataPort device which is
similar looking.

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

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

-

82 Carrier DataLink

Page

6

of 31

4. Configuring the FieldServer as a Carrier DataLink Client

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

In order to configure the Client it is necessary to know the names of the data tables available in
the devices connected via the CCN network to the data link. A partial list of available tables is
provided in Appendix A.1. If you know the table names and the variable names that you wish to
poll then you have enough information to complete the configuration. If you have table names
but do not know variable names then we provide a method of discovering the variable names.
This method is discussed in chapter 6. If you do not have the table names then you will need to
consult with the Carrier Corporation before proceeding.

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

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

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Format

Data_Array_Length

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]

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

FS-8700

-

82 Carrier DataLink

Page

7

of 31

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

4.2. Client Side Connection Descriptions

Section Title

Connections

Column Title Function Legal Values

Port

Baud* Specify baud rate

Parity* Specify parity.
Data_Bits*

Stop_Bits*
Protocol
Handshaking* Specify hardware handshaking

Poll _Delay*

Timeout*

IC_Timeout*

Example

// Client Side Connections
Connections

Port, Baud, Parity, Data_bits, Stop_Bits, Protocol, Handshaking, Poll_Delay
P8, 9600, None, 8 , 1 , CarrierDL, None , 0.100s

Specify which port the device is connected to the
FieldServer

P1-P8, R1-R21
300, 600 , 1200,

2400, 9600 (Vendor
limitation)
None (Vendor
Limitation)

Specify data bits
Specify stop bits

8 (Vendor Limitation)
1 (Vendor limitation)

Specify protocol used CarrrierDL

None
Time between internal polls
When reading entire tables it is recommended that

the timeout be set to between 15 and 30 seconds.
Additional information is provided in Appendix A.5

0-32000 seconds, 1

second

0.1 to 60.0 seconds,

2.0seconds

When reading entire tables it is recommended that
the ic_timeout be set to approx 15.0 seconds.
Additional information is provided in Appendix A.5

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

-

82 Carrier DataLink

Page

8

of 31

4.3. Client Side Node Descriptors

Section

Title

Nodes

Column

Title

Node_Name Provide name for node

Modbus station address of physical server node.
These correspond to the ‘devices’ configured in the
DTPConfig. Thus the Node_ID is not the address of

Node_ID

the final CCN device.
The DataLink 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 CarrierDL
Port

Specify which port the device is connected to the
FieldServer

Example

// Client Side Nodes
Nodes

Node_Name, Node_ID, Protocol , Port
FAN1 , 1 , CarrierDL, P8

Function Legal Values

Up to 32
alphanumeric
characters

1-15

P1-P8, R1-R22

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 where

Data_Array_Name

data is to be stored in the
FieldServer

Data_Array_Location
Function

Starting location in Data
Array
Function of Client Map
Descriptor

2

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]

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

-

82 Carrier DataLink

Page

9

of 31

4.4.2. Driver Related Map Descriptor Parameters

Column

Title

Node_Name Name of Node to fetch data from

Data type. This parameter is not required
except when defining Map Descriptors
which write DOW (Day of Week) and
Time value to the Carrier devices. When

Data_Type

Length

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

Table_Name

Field_Name*

Store_As*

a write Map Descriptor checks the data
type it uses the information to convert the
value extracted from the FieldServer’s
Data Arrays into a suitable format for a
write. Refer to Section 4.4.7.

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

The name of the table to be polled, e.g.
DISPLAY. Some system elements have
multiple instances of the same table
name. For example, the Terminal System
Manager has 64 Temperature Zone
configuration tables named TZONE1
though TZONE64. These tables are
accessed by using both the primary &
secondary table names, e.g. ‘TZCONF
TZONE1’

If you wish to read the whole table, leave
the field name blank or specify
‘EVERYTHING’.

Use the Ascii or AsciiLog format when you
are discovering the variables contained in
a table by reading a table. Refer to 1.1

Function Legal Values

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

­Occupancy_Time
Occupancy_DOW

1 – 1000

Only ASCII characters are
permitted.

When using the table
name parameter to specify
a primary and secondary
table, leave a single space
between the two names.

Only ASCII characters are
permitted. Field names
never contain spaces.
They may not be longer
than 10 characters long.

Ascii, AsciiLog, Values

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]

4.4.3. Timing Parameters

Column Title Function Legal Values

Scan_Interval Rate at which data is polled >0.1s

FS-8700-82 Carrier DataLink Page 10 of 31

4.4.4. Map Descriptor Example 1 – Read a Table

This example illustrates how to read the entire contents of a table called ‘DISPLAY’. The Map Descriptor is connected to a node
using 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 which will be generated every 5 seconds.

The value extracted from the response will be stored in the array called DA_DISPLAY. Ensure that it is suitable format for storing a
number – FLOAT is suggested. The driver stores the value of the 1
table elements whose values have been successfully stored at is stored at offset zero.

// Client Side Map Descriptors
Map Descriptors

Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Length, Scan_Interval, Table_Name, Field_Name
Read_Table_Md , DA_DISPLAY , 0 , rdbc , FAN01 , 100 , 5.0s , DISPLAY , EVERYTHING

st

element at offset 1; the 2nd element at offset 2… The number of

Responses are stored in
this data array. Table
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
values were stored.

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]

The driver
generates a read
poll continuously.

The node name
connects the Map
Descriptor to a
node definition.

The length is set
to a number big
enough to contain
all the table’s
variables.

The name of the
table to be read.

By using the keyword
‘EVERYTHING’ you are
telling the driver to read
the whole table.