FieldServer Carrier DataPort FS-8700-86 Release note

A Sierra Monitor Company
APPLICABILITY & EFFECTIVITY
Effective for all systems manufacture after August 2008
Driver Manual
(Supplement to the Fiel Server Instruction Manual)
FS-8700-86 Carrier DataPort
Driver Version:
1.03
Document Revision: 11

FS-8700-86 Carrier DataPort Table of Contents
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
TABLE OF CONTENTS
1. CARRIER DATAPORT DESCRIPTION ........................................................................................... 3
2. DRIVER SCOPE OF SUPPLY.......................................................................................................... 3
2.1. Supplied by FieldServer Te hnologies 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 Conne tions..............................................................................................................6
4.3. Client Side Node Des riptors...................................................................................................... 7
4.4. Client Side Map Des riptors ....................................................................................................... 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 Conne tions .......................................................................................................... 11
5.3. Server Side Node Des riptors .................................................................................................. 11
5.4. Server Side Map Des riptors .................................................................................................... 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 Des riptor Length Explained .............................................................................. 19
Appendix A.4. How the Client stores the states/values of the Table Variables................................. 19
Appendix A.4.1. Dis rete States........................................................................................................ 19
Appendix A.4.2. Time Values ............................................................................................................ 20
Appendix A.4.3. Numeri Values....................................................................................................... 21
Appendix A.4.4. O upan y Strings / Values....................................................................................21
APPENDIX B. TROUBLE SHOOTING/CONNECTIONS - TIPS AND HINTS ..................................... 22
Appendix B.1. Conne tion problems. ................................................................................................ 22
Appendix B.2. Timeouts..................................................................................................................... 22
Appendix B.3. Determining Storage Lo ations .................................................................................. 22
Appendix B.4. How to build a s ript file that tests a ustomer log..................................................... 23
APPENDIX C. DRIVER NOTES ...........................................................................................................26
Appendix C.1. Driver Limitations and Ex lusions .............................................................................. 26
APPENDIX D. DRIVER ERROR MESSAGES .....................................................................................27
Appendix D.1. Driver Stats ................................................................................................................ 31

FS-8700-86 Carrier DataPort Page 3 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
1. Carrier DataPort Description
The Carrier DataPort driver allows the FieldServer to transfer data to and from devi es over either RS-
232 or RS-485 using Carrier DataPort proto ol. The FieldServer an emulate either a Server or Client.
The DataPort devi e provides a gateway to CCN devi es. This driver polls the DataPort devi e whi h in
turn reads data from the CCN devi es. Up to 15 system elements may be onne ted to a DataPort
Devi e.
Carrier limits the number of CCN devi es that an polled from a DataPort Devi e and also limits the data
that an be transferred between some CCN devi es and the DataPort devi e. For information on these
limitations please onsult the Carrier Corporation.
The driver is an a tive Client driver. This means that it initiates read polls with the DataPort devi e whi h
is expe ted to provide responses. Server fun tionality is provided by the driver too.
The driver is onfigured to allow a single Data Table (usually the Display Table) to be read from the CCN
devi es via the DataPort devi e. As the table typi ally ontains more than one data element, the
retrieved data is stored in a number of onse utive Data Array lo ations in the FieldServer. The driver
an provide des riptions for ea h of the table values retrieved.
The driver has no advan ed knowledge of the CCN devi es and their Data Tables. This means that the
driver handles ea h table in a generi way, without regard for the parti ular variables that onstitute the
tables. The most important onsequen e of this is that the variable values are stored in the order in
whi h they appear in the response from the DataPort devi e. It is not possible to map parti ular variable
values to parti ular lo ations in the FieldServer Data Arrays.
2. Driver Scope of Supply
2.1. Supplie by Fiel Server Technologies for this river
Fiel Server Technologies PART # DESCRIPTION
FS-8917-02 RJ45 to DB9F onne tor adapter
FS-8917-17 RJ45 to DB25M onne tion adapter
SPA59132 RS-485 onne tion adapter
FS-8700-86 Driver Manual.

FS-8700-86 Carrier DataPort Page 4 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
3. Har ware Connections
The FieldServer is onne ted to the Carrier DataPort devi e as shown below.
Configure the DataPort Devi e a ording to manufa turer’s instru tions. This driver requires that the
DataPort devi e’s DTPCONFIG table has been onfigured prior to onne tion with a FieldServer. In
addition, onsult the manufa turer’s information on onne ting Carrier Devi e’s to CCN network.
Note: Typi al onne tions are 9600,N,8,1.

FS-8700-86 Carrier DataPort Page 5 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
4. Configuring the Fiel Server as a Carrier DataPort Client
It is not possible to omplete a onfiguration for ommuni ation with a DataPort devi e until you are
familiar with the data available from the devi es onne ted to the DataPort. The DataPort devi e does not
provide a method for dis overing the data tables and variables that are available in all the Carrier devi es.
Configuring the DataPort driver as a Client is easy; however, you will not be able to omplete the server
side onfiguration until you have a list of the variables and the order in whi h the DataPort devi e will
report them. The driver is apable of helping you determine this information but annot auto- omplete the
onfiguration. This method is dis ussed in Appendix A.
For a detailed dis ussion on FieldServer onfiguration, please refer to the FieldServer Configuration
Manual. The information that follows des ribes how to expand upon the fa tory defaults provided in the
onfiguration files in luded with the FieldServer (See “. sv” sample files provided with the FieldServer).
This se tion do uments and des ribes the parameters ne essary for onfiguring the FieldServer to
ommuni ate with a Carrier DataPort Server.
The onfiguration file tells the FieldServer about its interfa es, and the routing of data required. In order to
enable the FieldServer for Carrier DataPort ommuni ations, the driver independent FieldServer buffers
need to be de lared in the “Data Arrays” se tion, the destination devi e addresses need to be de lared in
the “Client Side Nodes” se tion, and the data required from the servers needs to be mapped in the “Client
Side Map Des riptors” se tion. Details on how to do this an be found below.
Note that in the tables, * indi ates an optional parameter, with the bol 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 alphanumeri hara ters
Data_Format Provide data format. Ea h Data Array
an only take on one format.
FLOAT, BIT, UInt16, SInt16,
Pa ked_Bit, Byte, Pa ked_Byte,
Swapped_Byte
Data_Array_Length
Number of Data Obje ts. Must be larger
than the data storage area required for
the data being pla ed in this array.
1-10,000
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

FS-8700-86 Carrier DataPort Page 6 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
4.2. Client Si e Connections
Section Title
Conne tions
Column Title Function Legal Values
Port Spe ify whi h port the devi e is onne ted to the
FieldServer
P1-P8, ( R1, R2 with
onverter)
1
Baud* Spe ify baud rate. 600 , 1200, 2400, 9600
(Vendor limitation)
Parity* Spe ify parity None (Vendor limitation)
Data_Bits* Spe ify data bits 8 (Vendor limitation)
Stop_Bits* Spe ify stop bits. 1 (Vendor limitation)
Proto ol Spe ify proto ol used CarrierDP
Handshaking* Spe ify hardware handshaking None
Poll _Delay* Time between internal polls 0-32000 se onds, 1
secon
Timeout
2
Spe ifies the max amount of time the driver must
wait for a omplete response.
If the Data Port table is long then in rease the
timeout above the default until timeout errors
disappear.
2 se onds
Appli ation Refer to notes in Appendix B.3 Print_storage_lo ations
Start_Method*
If the parameter is not onfigured or set to 0
(default), the driver will identify the start of a
message as FORMFEED (0x0C) and the end as two
arriage returns (0x0D 0x0D)
When the parameter is set to 1, the first arriage
return (0x0D) will be onsidered the start of the
message (all hara ters before the first arriage
return will be ignored). and the end as two arriage
returns (0x0D 0x0D)
1,0
Example
// Client Side Conne tions
Conne tions
Port, Baud, Parity, Data_Bits, Stop_Bits, Proto ol , Handshaking, Poll_Delay
P8, 9600, None, 8 , 1 , CarrierDP, None , 0.100s
1
Not all ports shown are ne essarily supported by the hardware. Consult the appropriate Instru tion
manual for details of the ports available on spe ifi hardware.
2
See Appendix B.1 for additional information

FS-8700-86 Carrier DataPort Page 7 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
4.3. Client Si e No e Descriptors
Section
Title
Nodes
Column
Title Function Legal Values
Node_Name Provide name for node
Up to 32
alphanumeri
hara ters
Node_ID
These orrespond to the ‘devi es’ onfigured in the
DTPConfig. Thus the Node_ID is not the address of the final
CCN devi e.
The DataPort DTPConfig table maps a devi e number
(1...15) to a bus number (0-239). Use the Node_ID to tell the
driver whi h devi e to use.
1-15
Proto ol Spe ify proto ol used CarrierDP
Port Spe ify whi h port the devi e is onne ted to the FieldServer P1-P8, R1-R2
3
Example
// Client Side Nodes
Nodes
Node_Name, Node_ID, Proto ol , Port
FAN1 , 1 , CarrierDP, P8
3
Not all ports shown are ne essarily supported by the hardware. Consult the appropriate Instru tion
manual for details of the ports available on spe ifi hardware.

FS-8700-86 Carrier DataPort Page 8 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
4.4. Client Si e Map Descriptors
4.4.1. Fiel Server Relate Map Descriptor Parameters
Column Title Function Legal Values
Map_Des riptor_Name Name of this Map Des riptor Up to 32 alphanumeri hara ters
Data_Array_Name Name of Data Array where data is
to be stored in the FieldServer
One of the Data Array names from
“Data Array” se tion above
Data_Array_Lo ation Starting lo ation in Data Array 0 to maximum spe ified in “Data
Array” se tion above
Fun tion Fun tion of Client Map Des riptor Rdb , Wrb , Wrbx
4.4.2. Driver Relate Map Descriptor Parameters
Column Title Function Legal Values
Node_Name Name of Node to fet h data from
One of the node names
spe ified in “Client Node
Des riptor” above
Data_Type This ommonly used parameter is not
required for this driver.
Length
Length of Map Des riptor. When reading a
ompete 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.
1 – 1000
Address This ommonly used parameter is not required for this driver.
Store_As*
Use the ASCII or As iiLog format when
you are dis overing the variables
ontained in a table by reading a table.
Refer to Appendix A for more information.
ASCII, As iiLog, Values
DA_Byte_Name* If defined, the driver stores the ‘field status’
value in this array.
The name of a Data Array
defined in the Data_Array
se tion of the onfiguration file.
DA_Float_Name*
If defined, the driver stores the ‘field units’
value in this array.
The name of a Data Array
defined in the Data_Array
se tion of the onfiguration file.
4.4.3. Timing Parameters
Column Title Function Legal Values
S an_Interval Rate at whi h data is polled >0.1s

FS-8700-86 Carrier DataPort Page 9 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
4.4.4. Map Descriptor Example 1 – Rea
This example illustrates how to read data from the DataPort. Some basi s first: The Map Des riptor is onne ted to a node by means of the node name and a node definition provides a onne tion to a port. Thus this Map Des riptor is onne ted to a port via its node. The FieldServer will use that port to send this poll. The poll will be generated every 5 se onds in this example. The values extra ted from the response will be stored in the array alled DA_DISPLAY. Ensure that it is suitable format for storing number – FLOAT is suggested. The driver stores the value of the 1
st
element at offset 1, the 2
nd
element at offset 2 ….and the driver stores the number of
table elements whose values have been su essfully stored at offset zero.
// Client Side Map Des riptors Map Des riptors Map_Des riptor_Name, Data_Array_Name, Data_Array_Offset, Fun tion, Node_Name, Length, S an_Interval Read_Table_Md , Da_Display , 0 , Rdb , FAN01 , 100 , 5.0s
Responses get 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 value were stored.
The driver generates a read poll ontinuously.
The Node_Name onne ts the Map Des riptor to a Node definition.
The length is set to a number big enough to ontain all the table’s variables.

FS-8700-86 Carrier DataPort Page 10 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
5. Configuring the Fiel Server as a Carrier DataPort Server
For a detailed dis ussion on FieldServer onfiguration, please refer to the FieldServer Configuration
Manual. The information that follows des ribes how to expand upon the fa tory defaults provided in the
onfiguration files in luded with the FieldServer (See “. sv” sample files provided with the FieldServer).
This se tion do uments and des ribes the parameters ne essary for onfiguring the FieldServer to
ommuni ate with a Carrier DataPort Client.
The FieldServer an be onfigured to emulate a Carrier DataPort Devi e. The user is able to define a
variable quantity of variables. The FieldServer may be polled and will respond like a DataPort devi e.
The onfiguration file tells the FieldServer about its interfa es, and the routing of data required. In order
to enable the FieldServer for Carrier DataPort ommuni ations, the driver independent FieldServer
buffers need to be de lared in the “Data Arrays” se tion, the FieldServer virtual node(s) needs to be
de lared in the “Server Side Nodes” se tion, and the data to be provided to the Clients needs to be
mapped in the “Server Side Map Des riptors” se tion. Details on how to do this an be found below.
Note that in the tables, * indi ates an optional parameter, with the bol 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 Up to 15 alphanumeri
hara ters
Data_Format Provide data format. Ea h Data Array an
only take on one format.
Float, Bit, Uint16, Sint16,
Pa ked_Bit, Byte, Pa ked_Byte,
Swapped_Byte
Data_Array_Length
Number of Data Obje ts. Must be larger
than the data storage area required for
the data being pla ed in this array.
1-10,000
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

FS-8700-86 Carrier DataPort Page 11 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
5.2. Server Si e Connections
Section Title
Conne tions
Column Title Function Legal Values
Port Spe ify whi h port the devi e is onne ted to
the FieldServer P1-P8, ( R1-R2 with onverter)
4
Baud* Spe ify baud rate 300, 600 , 1200, 2400, 9600
(Vendor limitation)
Parity* Spe ify parity None (Vendor limitation)
Data_Bits* Spe ify data bits 8 (Vendor limitation)
Stop_Bits* Spe ify stop bits 1 (Vendor limitation)
Proto ol Spe ify proto ol used CarrierDP
Handshaking* Spe ify hardware handshaking None
Example
// Server Side Conne tions
Conne tions
Port, Baud, Parity, Data_Bits, Stop_Bits, Proto ol , Handshaking, Poll_Delay
P8, 9600, None, 8 , 1 , CarrierDP, None , 0.100s
5.3. Server Si e No e Descriptors
Section Title
Nodes
Column Title Function Legal Values
Node_Name Provide name for Node Up to 32 alphanumeri
hara ters
Node_ID
DataPort station address of physi al Server Node.
These orrespond to the ‘devi es’ onfigured in the
DTPConfig. Thus the Node_ID is not the address of
the final CCN devi e.
The DataPort DTPConfig table maps a devi e
number (1...15) to a bus number (0-239). Use the
Node_ID to tell the driver whi h devi e to use.
1-15
Proto ol Spe ify proto ol used CarrierDP
Example
// Server Side Nodes
Nodes
Node_Name, Node_ID, Proto ol , Port
5
FAN1 , 1 , CarrierDP, P8
4
Not all ports shown are ne essarily supported by the hardware. Consult the appropriate Instru tion
manual for details of the ports available on spe ifi hardware.
5
It is ommon to leave server nodes un onne ted to a port. This means that the FieldServer an respond
with the Node’s data irrespe tive of whi h port the request is re eived on.

FS-8700-86 Carrier DataPort Page 12 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
5.4. Server Si e Map Descriptors
5.4.1. Fiel Server Specific Map Descriptor Parameters
Column Title Function Legal Values
Map_Des riptor_Name Name of this Map Des riptor Up to 32 alphanumeri hara ters
Data_Array_Name Name of Data Array where data is
to be stored in the FieldServer
One of the Data Array names from
“Data Array” se tion above
Data_Array_Lo ation Starting lo ation in Data Array 0 to maximum spe ified in “Data
Array” se tion above
Fun tion Fun tion of Client Map Des riptor passive
5.4.2. Driver Specific Map Descriptor Parameters
Column Title Function Legal Values
Node_Name Name of Node to fet h data from
One of the Node Names
spe ified in “Server
Node Des riptor” above
Length
6
Length of Map Des riptor. When reading a
ompete table, set to the maximum number of
data values to be stored.
1 – 1000
Table_Name*
The name of the table to be polled, e.g.
DISPLAY. This parameter is for display purposes
only. The driver does not use the value of this
parameter.
Some system elements have multiple instan es
of the same table name. For example, the
Terminal System Manager has 64 Temperature
Zone onfiguration tables. The individual tables
are named TZONE1 though TZONE64. These
tables are a essed by using both the primary &
se ondary table names.
E.g. ‘TZCONF TZONE1’
Only As ii hara ters are
permitted.
When using the table
name parameter to
spe ify a primary and
se ondary table, leave a
single spa e between
the two names.
Field_Name This is the field variable pneumoni .
An As ii string whi h
may not
ontain spa es.
Max length 8 hara ters.
Field_Des ription Returned when a Client does a read.
An As ii string whi h
may ontain spa es.
Max length 24
hara ters.
Field_Units Returned when a Client does a read. If units
have no meaning for the variable set to zero.
A whole number. See
Appendix A.1
Field Status*
This parameter is used to set data quality
information that is returned when the Client polls
for data. If omitted and DA_Byte_Name has not
been spe ified the driver returns zero as the
status value.
A whole number. See
Appendix A.1 for more
information.
6
Additional information on the length parameter is provided in Appendix A.

FS-8700-86 Carrier DataPort Page 13 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
Column Title Function Legal Values
DA_Byte_Name*
If this parameter is defined then its value must be
the name of a Data Array. Instead of the driver
returning a stati Field Status, it will extra t the
value lo ated at the given offset and use this
value as the Field Status.
The name of Data Array
defined in the Data
Arrays se tion.
On_String
If the variable has a dis rete state, use this
parameter to define the word that des ribes the
state when the variable’s value is 1.
OR
Use one of the keywords to tell the driver to send
the value of the asso iated array elements:
NUMERIC – a number
TIME - a time value formatted as hh:mm
STRING - a string of bytes
DOW – o upan y string
When using the string keyword the driver reads x
onse utive array elements and treats them as
ASCII hara ter values in forming the response.
X is defined by the length parameter.
NUMERIC
TIME
STRING
DOW
Or any other As ii string
whi h may not ontain
spa es.
Off_String
If the variable has a dis rete state, use this
parameter to define the word that des ribes the
state when the variable’s value is zero. If you
have used a keywords des ribed above then
simply put a dash in this field.
An ASCII string whi h
may not ontain spa es.
Length Always set the length to 1 unless you use the key
word ‘STRING’ as the On_String parameter. 1
5.4.3. Timing Parameters
Column Title Function Legal
Values
S ada_Hold_Timeout
Spe ifies time Server side waits before responding to Client
that node is offline on FieldServer Client side. >1.0s

FS-8700-86 Carrier DataPort Page 14 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
5.4.4. Map Descriptor Example.
This example shows a number of server Map Des riptors used to define a table alled ‘DISPLAY’. If a Client sends a read table request the driver responds by sending all the appropriate data for every Map Des riptor with the same table name (provided that the node’s mat h too. ). The fields are returned in the order in whi h you define them in the onfiguration file. // Server Side Map Des riptors Map Des riptors Map_Des riptor_Name, Fun tion, Node_Name, Table_Name, Field_Name, Field_Des ription, Field_Units, On_String, Off_String, Data_Array_Name, Data_Array_Offset,
Length,
Display_MD01, passive, Node_1, DISPLAY, MODE , Desired Mode , , ON , OFF , TABLE_DISPLAY, 01 , 1, Display_MD02 , passive, Node_1, DISPLAY, ALARM , Equipment Status, , ALARM , NORMAL, TABLE_DISPLAY, 02 , 1, Display_MD03 , passive, Node_1, DISPLAY, CSPT , Controlling Setp., dF , NUMERIC , -, TABLE_DISPLAY, 03 , 1, Display_MD04 , passive, Node_1, DISPLAY, SPT , Controlling Temp, dF , NUMERIC, -, TABLE_DISPLAY, 04, 1, Display_MD05 , passive, Node_1, DISPLAY, RAT , Spa e Temp, dF , NUMERIC , -, TABLE_DISPLAY, 05, 1, Display_MD06 , passive, Node_1, DISPLAY, SAT , Supply Air Temp., dF , NUMERIC, -, TABLE_DISPLAY, 06, 1, Display_MD07 , passive, Node_1, DISPLAY, FANSTAT, Fan Mode, , ON, OFF , TABLE_DISPLAY, 07, 1, Display_MD08 , passive, Node_1, DISPLAY, CCAP , Cooling Capa ity, % , NUMERIC, - , TABLE_DISPLAY, 08, 1, Display_MD09 , passive, Node_1, DISPLAY, HCAP , Heating Capa ity, % , NUMERIC, - , TABLE_DISPLAY, 09, 1, Display_MD10 , passive, Node_1, DISPLAY, FLTSTAT, Filter Status, , DIRTY, CLEAN , TABLE_DISPLAY, 10, 1,
All the Server Map
Des riptors are passive.
If the value of the array named TABLE_DISPLAY, offset 10 is a 1 then the FieldServer will report he FLTSTAT variable as DIRTY. If it is zero then the variable’s state will be reported as lean.
By using the NUMERIC keyword, the driver is told to report the value of the variable HCAP as a number. Thus the driver sends the value of the array named TABLE_DISPLAY offset 9 to the Client.

FS-8700-86 Carrier DataPort Page 15 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
Appen ix A. A vance Topics
Appen ix A.1. Fiel Status & Fiel Engineering Units
The following tables dupli ate information available from Carrier Corporation. We provide it for
referen e purposes. It is best to ask the vendor for urrent data.
Value Engineering Units Value Engineering Units Value Engineering Units
000 no units 051 feet per minute 260 Pas al
001 degrees F 052
thousands of ubi feet
per minute 262 delta degrees C
002 degrees F 053
thousands of ubi feet
per hour 263 degrees C
003 per ent 054 tons 264 delta degrees C
004 in hes of water 055 tons per hour 267 degrees C
005 milliamps 056 revolutions per minute 270 Pas al
006 delta degrees F 057 per ent open 272 delta degrees C
007 degrees F 058 hours 273 degrees C
008 delta degrees F 059 gallons 274 delta degrees C
010 Volts 064 on/off input 276 kiloPas als
011 degrees F 065 off/on input 288 liters per minute
013 per ent 066 input pulses on 289 liter per hour
014 in hes of water 067 input pulses off 290 ubi meters per minute
015 milliamps 068 se onds 291 ubi meters per hour
016 delta degrees F 069 normal/alarm 292 kiloPas als
017 degrees F 070 Hz 293 kilograms per hour
018 delta degrees F 080 minutes 295 kilowatt hours
020 pounds per square in h 081 hours 296 kilowatts
032 gallons per minute 082 revolutions per minute 297 millimeters of water
033 gallons per hour 124 lo k 298 millimeters of mer ury
034
thousands of gallons per
minute 126 ASCII 299 kilowatt hours
035
thousands of gallons per
hour 128 no units 300 kilowatts
036
pounds per square in h,
gauge 133 milliamp 301 degrees C
037 pounds per hour 137 pounds per square in h 302 per ent relative humidity
038
thousands of pounds per
hour 138 volts 303 amps
039 BTUs per hour 144 kilowatts 304 volts
040 thousands of BTUs 145 kilowatt hours/pulse 305 ubi meters per minute
041 in hes of water 146 pulses 306 ubi meters per hour
042 in hes of mer ury 192 on/off output 307 meters per se ond
043 kilowatt hours 193 off/on output 310 tons
044 kilowatts 194 pulsed on output 311 tons per hour
045 degrees F 195 pulsed off output 312 revolutions per hour
046 per ent relative humidity 208 steps 313 per ent open
047 amps 254 ASCII 314 hours
048 volts 256 no units 315 liters
049 ubi feet per minute 257 degrees C
050 ubi feet per hour 258 degrees C

FS-8700-86 Carrier DataPort Page 16 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
Error Con itions Force Con itions
Conditions
A
B
C
D
E
F
No For e 0 1 2 3 4 5
Fire 16 17 18 19 20 21
Safety 32 33 34 35 36 37
Servi e Tool 48 49 50 51 52 53
Supervisor 64 65 66 67 68 69
Monitor 80 81 82 83 84 85
Minimum-off 96 97 98 99 100 101
Control 112 113 114 115 116 117
BEST 128 129 130 131 132 133
Temp Override 144 145 146 147 148 149
Loadshed 160 161 162 163 164 165
Error Con itions:
A no error
B hardware or ommuni ations error
C software error
D low alarm limit ex eeded (analog point),or point in alarm (dis rete point)
E high alarm limit ex eeded
F un onfigured point (VVT Gateway only)
Force Con itions:
No For e
Fire for ed by fire alarm equipment
Safety for ed by internal safety override
Servi e Tool for ed by CCN Servi e Tool
Supervisor for ed by lo al Building Supervisor
Monitor for ed by remote Building Supervisor
Minimum-off for ed by minimum off time requirement
Control for ed by System Software Option
BEST for ed by BEST program
Temp Override for ed by temperature override
Loadshed for ed by Loadshed System Software Option
Appen ix A.2. Fiel / Variable Names
A list of variable names vs. table names vs. equipment types is not provided in this manual. The
reasons for this are that they are not all available to us they an be onfigured in some devi es using
software provided by the Carrier Corporation.
Consult the points list with the literature provided with ea h type of equipment from Carrier to obtain
variable names. Alternately use the software provided by Carrier to browse the network and
determine the table and variable names.
This driver may also be used to obtain a list of variable names for a given table. On the following
pages are sample Map Des riptors whi h may be in luded in the onfiguration to help obtain this
information. FieldServer re ommends that if these Map Des riptors are used to obtain variable name
information, they should be removed from the final onfiguration as they will onsume resour e and
pro essing time.

FS-8700-86 Carrier DataPort Page 17 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
This example illustrates how to reate a Map Des riptor whi h reads a table and dumps the response in ASCII format to a Data Array so that RUINET( a utility provided with the FieldServer) an be used to browse and read the results.
Data_Arrays Data_Array_Name,
Data_Format, Data_Array_Length
DA_DUMP, BYTE, 2000 Map Des riptors Map_Des riptor_Name,
Data_Array_Name,
Data_Array_Offset, Fun tion, Node_Name, Length, S an_Interval, Storet_As
Md1 , DA_DUMP , 0 , rdb , FAN01 , 1000 , 5.0s , ASCII
This is what tells the driver to dump the table, its variables names and variable des riptions in ASCII format.
The s=Data Array DA_DUMP has been defined with format BYTE. When viewing this table with RUINET display the array in ‘STRING’ format so that you an read it.

FS-8700-86 Carrier DataPort Page 18 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
This example illustrates how to make a Map Des riptor whi h reads a table and dumps the response in ASCII format to the error log. The error log an be dumped to a file on your omputer using RUIDEBUG (a utility supplied with your FieldServer)
Data_Arrays Data_Array_Name,
Data_Format, Data_Array_Length
DA_DUMP, BYTE, 2000 Map Des riptors Map_Des riptor_Name,
Data_Array_Name,
Data_Array_Offset, Fun tion, Node_Name, Length, S an_Interval, Storet_As
Md1 , Da_Dump , 0 , rdb , FAN01 , 1000 , 5.0s , As iiLog The following fragment from the error log is typi al of the response to a Map Des riptor like the one above.
T01> ASCII Dump Requested for MD=<MapDes 1> T01> Field1 99.0 000 000 Des 1 1 1 T01> Field2 98.0 000 000 Des 2222222 T01> Field3 on 000 000 33333 33333 3 T01> Field4 Off 000 000 44444444444444 T01> Field5 Off 000 000 5555 55555555 T01> Field6 Off 000 000 6666666666666 T01> Field7 Off 000 000 7 T01> Field8 Off 000 000 888 888 88888 T01> Field9 Off 000 000 99999999999 3 T01> Fielda DIRTY 000 000 aaaaaaaaaaaaa T01> Fieldb 0.0 000 000 bbbb T01> Field Off 000 000 T01> Fieldd -1.0 000 000 ddddddddddddd

FS-8700-86 Carrier DataPort Page 19 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
Appen ix A.3. Map Descriptor Length Explaine
The Length parameter is spe ified as part of the Map Des riptor.
Client Rea s:
The length means: “The number of table variable’s whose values are to be stored when the response
is re eived.” If you do not know the length of the table in advan e, set the length to a larger number
(e.g. 100). The driver will pro ess the response; if the table ontains more than 100 elements then
some data will be dis arded.
Server:
The length parameter is used when the server returns a value that is a string. The length is used to
tell the driver how many hara ters to extra t from onse utive array lo ation to form the response
string. When the server returns a value that is a number, state or time the length should always be 1.
Appen ix A.4. How the Client stores the states/values of the Table Variables.
Appen ix A.4.1. Discrete States
When a Carrier DataPort devi e reports the state of a table variable whi h has a dis rete state, it
reports the state as a keyword like on/off. This driver onverts the keywords to fa ilitate reading
by other devi es.
The driver is programmed to re ognize the keywords listed below. The user an add keywords
by spe ifying additional information in the onfiguration file.
State Wor Value State Wor Value State Wor Value
CLEAN 1 ABNORMAL 1 OPEN 1
DIRTY 0 NORMAL 0 CLOSE 0
HEAT 1 LOCAL 0 CLOSED 0
COOL 0 REMOTE 1 ALARM 1
ON 1 LOCAL R 0
OFF 0 RUNNING 1
If the driver doesn’t re ognize the state word, it stores the hara ters of the state word as de imal
values based on their ASCII value. the number of hara ters stored is dependent on the length
parameter.
For example, say the driver responds, reporting a variable to be a state ‘INCREDIBLE’. If the
length parameter of the polling Map Des riptor is 1 then the driver stores the first hara ter of the
word in redible; by storing a value of 73 (An upper ase ‘I’ is the seventy third hara ter in the
ASCII alphabet.).
The driver re ognizes dis rete state words by he king the 1
st
hara ter of the value field. If it is a
non-digit then it is regarded as a state word. The omparison against keywords in the list is done
without respe t for the ase of the letters.
Unrecognize Discrete State Wor s
If the driver does not re ognize the dis rete state word that has been used it will report the
following error - CarrDP:#24 Err. MD=<MapDes 1> dis rete state word not re ognized.
The unre ognized dis rete word an be found by extra ting 10 hara ters from the line starting at
the 10th hara ter. On e the 10 hara ters have been extra ted they are left and right trimmed
to remove leading and trailing spa es.

FS-8700-86 Carrier DataPort Page 20 of 32
Fiel Server Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver. om
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fieldserver. om
In the following two examples the keywords that are not re ognized are 'Reset T' and 'Tripout'
respe tively
CarrDP:#24 Err. MD=<MapDes 1> dis rete state word not re ognized.
T02> <MODE Reset T 000 000 Control Mode
>
T02> CarrDP:#24 Err. MD=<MapDes 1> dis rete state word not re ognized.
T02> <STATUS Tripout 000 000 Run Status
>
In the following example the keyword '********' is not being re ognized. If this message is printed
it is ne essary to onsult Carrier Corp. to learn why a variables’ value is printed as '********'. It
may be that the value is over range or invalid.
T02> CarrDP:#24 Err. MD=<MapDes 1> dis rete state word not re ognized.
T02> <CHWPD ********** 020 000 Chilled Water Delta P
>
T02>
Exten ing the List of Discrete State Wor s
You an extend the list of state words the driver re ognizes by modifying the onfiguration CSV
file.
The following example adds three state words. If a devi e reports the state of the variable as
LIGHT then the driver will store the value of 1, if on the other hand the state is reported as DARK
then the driver will store the value zero.
Driver_Table
Carrier_Attr_State_Name, Carrier_Attr_State_Value, Proto ol
LIGHT , 1 , CarrierDP
DARK , 0 , CarrierDP
This method may be used to hange the values of any of the driver’s default state words by
dupli ating the word and spe ifying a new value in the onfiguration file.
Appen ix A.4.2. Time Values
If the driver re eives a variable value reported in the format hh:mm then the driver stores a
number obtained by multiplying the hours by 60 and adding the minutes. The driver re ognizes a
time value by he king the 3
rd
hara ter for a olon and he king that the 1
st
hara ter is a digit.
Value_Stored = hh * 60 + mm
E.g. 5:30pm is reported as 17:20 and is stored as 17*60 + 20 = 1040.
Proto ol must
be defined on
every line.
Keyword
starts a new
se tion of
the CSV file.
State Words
The name will be
stripped of all
spa es between the
last hara ter and
the omma.
Normally the values
will be 1/0 for the
on/off states but the
driver does not
restri t the value.