Carrier 17/19EX Instruction manual

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
Driver Version:
1.03
Document Revision: 5
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Table of Contents
TABLE OF CONTENTS
1.
Carrier DataLink Description..........................................................................................3
2.
2.1.
2.2.
Driver Scope of Supply...................................................................................................4
Supplied by FieldServer Technologies for this driver ..................................................4
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: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
1.
Page 3 of 31
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: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
2.
Page 4 of 31
Driver Scope of Supply
2.1.
Supplied by FieldServer Technologies for this driver
FieldServer Technologies PART #
FS-8915-10
FS-8917-17
FS-8700-82
2.2.
PART #
DESCRIPTION
UTP cable (7 foot) for RS-232 use
RJ45 to DB25M connection adapter
Driver Manual.
Provided by Suppler of 3rd Party Equipment
DESCRIPTION
Carrier DataLink Card
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
3.
Page 5 of 31
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: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
4.
Page 6 of 31
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
Data_Array_Name
Provide name for Data Array
Data_Format
Provide data format. Each data
array can only take on one format.
Legal Values
Up to 15 alphanumeric
characters
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte, Swapped_Byte
Number of Data Objects. Must be
larger than the data storage area
Data_Array_Length
1-10,000
required for the data being placed in
this array.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 7 of 31
Example
//
Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
DA_DO_01,
4.2.
Data_Format,
UInt16,
UInt16,
Bit,
Bit,
Data_Array_Length
200
200
200
200
Client Side Connection Descriptions
Section Title
Connections
Column Title
Port
Function
Specify which port the device is connected to the
FieldServer
Baud*
Specify baud rate
Parity*
Specify parity.
Data_Bits*
Stop_Bits*
Protocol
Handshaking*
Specify data bits
Specify stop bits
Specify protocol used
Specify hardware handshaking
Poll _Delay*
Time between internal polls
Timeout*
IC_Timeout*
Legal Values
P1-P8, R1-R21
300, 600 , 1200,
2400, 9600 (Vendor
limitation)
None (Vendor
Limitation)
8 (Vendor Limitation)
1 (Vendor limitation)
CarrrierDL
None
0-32000 seconds, 1
second
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
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
0.1 to 60.0 seconds,
2.0seconds
Example
//
Client Side Connections
Connections
Port, Baud,
P8,
9600,
Parity,
None,
Data_bits,
8 ,
Stop_Bits,
1
,
Protocol,
CarrierDL,
Handshaking,
None
,
Poll_Delay
0.100s
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: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
4.3.
Page 8 of 31
Client Side Node Descriptors
Section
Title
Nodes
Column
Title
Node_Name
Function
Legal Values
Up to 32
alphanumeric
characters
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
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.
Specify protocol used
Specify which port the device is connected to the
FieldServer
Node_ID
Protocol
Port
1-15
CarrierDL
P1-P8, R1-R22
Example
//
Client Side Nodes
Nodes
Node_Name,
FAN1 ,
4.4.
Node_ID,
1
,
Protocol ,
CarrierDL,
Port
P8
Client Side Map Descriptors
4.4.1.
FieldServer Related Map Descriptor Parameters
Column Title
Function
Map_Descriptor_Name Name of this Map Descriptor
Data_Array_Name
Data_Array_Location
Function
Name of Data Array where
data is to be stored in the
FieldServer
Starting location in Data
Array
Function of Client Map
Descriptor
Legal Values
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
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: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
4.4.2.
Driver Related Map Descriptor Parameters
Column
Title
Node_Name
Page 9 of 31
Function
Name of Node to fetch data from
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
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
a write Map Descriptor checks the data
Occupancy_Time
type it uses the information to convert the Occupancy_DOW
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
Length
1 – 1000
want stored. Additional information on the
length parameter is provided in Appendix
A.5.
Address
This commonly used parameter is not required for this driver.
The name of the table to be polled, e.g.
Only ASCII characters are
DISPLAY. Some system elements have
permitted.
multiple instances of the same table
name. For example, the Terminal System
Manager has 64 Temperature Zone
When using the table
Table_Name
name parameter to specify
configuration tables named TZONE1
a primary and secondary
though TZONE64. These tables are
accessed by using both the primary &
table, leave a single space
between the two names.
secondary table names, e.g. ‘TZCONF
TZONE1’
Only ASCII characters are
permitted.
Field names
If you wish to read the whole table, leave
Field_Name* the field name blank or specify
never contain spaces.
‘EVERYTHING’.
They may not be longer
than 10 characters long.
Use the Ascii or AsciiLog format when you
Store_As*
are discovering the variables contained in Ascii, AsciiLog, Values
a table by reading a table. Refer to 1.1
4.4.3.
Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
>0.1s
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
4.4.4.
Page 10 of 31
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 1st element at offset 1; the 2nd element at offset 2… The number of
table elements whose values have been successfully stored at is stored at offset zero.
//
Client Side Map Descriptors
Map Descriptors
Map_Descriptor_Name,
Read_Table_Md
,
Data_Array_Name,
DA_DISPLAY ,
Responses are stored in
this data array. Table
element x gets stored at
offset x, where x is a nonzero integer.
Offset zero is used by the
driver to report how many
values were stored.
Data_Array_Offset,
0
,
Function,
rdbc
,
Node_Name,
FAN01 ,
Scan_Interval,
5.0s
,
Table_Name,
DISPLAY ,
The name of the
table to be read.
The driver
generates a read
poll continuously.
The node name
connects the Map
Descriptor to a
node definition.
Length,
100 ,
The length is set
to a number big
enough to contain
all the table’s
variables.
By using the keyword
‘EVERYTHING’ you are
telling the driver to read
the whole table.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
Field_Name
EVERYTHING
Map Descriptor Example 2 – Read a Variable
Page 11 of 31
Data_Array_Name,
DA_TEMPS ,
DA_TEMPS ,
Data_Array_Offset,
0
,
1
,
Node_Name,
FAN01 ,
FAN01 ,
Length,
1
,
1
,
Table_Name,
DISPLAY ,
DISPLAY ,
Field_Name
RAT
SAT
Map Descriptor Example 3 – Write A Variable
The variable names are supplied by the Carrier Corporation. Refer to
Appendix A.2 for assistance in determining version names.
RAT
SAT
Scan_Interval,
5.0s
,
5.0s
,
The pneumonic variable name.
Space Temperature
-40.0 dF
Supply Air Temperature
-40.0 dF
Function,
rdbc
,
rdbc
,
Data_Array_Offset,
0
,
Function,
wrbc ,
Length,
1
,
Take care to
specify variables
that can be forced.
Node_Name,
FAN01 ,
Scan_Interval,
5.0s
,
Table_Name,
DISPLAY ,
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
This function ensures that the driver
writes the Setpoint to the device
continuously (every 5 seconds in this
example.) Use WRBX to generate a
write message each time the value in
the array is updated.
Data_Array_Name,
DA_DISPLAY ,
If the first element of
this array is set to 1,
the fan will be set ON;
if set to zero the fan
will be set OFF.
Map_Descriptor_Name,
Write_Md1
,
Field_Name
FAN
This example illustrates how to force a variable. Always set the length to 1 for a write. If the variable cannot be written then an error
will be reported. In this example the variable being written is called ‘FAN’. It can be set on/off because is a discrete point.
4.4.6.
The ‘RAT’ temperature will be stored at index 0 (first
element), the SAT temperature will be stored at index 1
nd
(2 element of array).
As we are using the same data array for both variables,
we change the offset.
Map_Descriptor_Name,
Read_Temps_Md1 ,
Read_Temps_Md2 ,
This example illustrates how to read single variables from a Carrier Device. A Map Descriptor needs to be defined for each variable.
Reading variables is effective for reading a limited set of variables from a table(s). Scaling can be applied when the driver stores the
value by using the additional parameters: Data_Array_Low_Scale, Data_Array_High_Scale, Device_Low_Scale, Device_High_Scale
4.4.5.
FS-8700-82 Carrier DataLink
Map Descriptor Example 4 – Write Day of Week (DOW) or Time
Page 12 of 31
Map_Descriptors
Map_Descriptor_Name,
MapDesc13
,
MapDesc14
,
Data_Array_Name,
TABLE_OCCPC64S,
TABLE_OCCPC64S,
Data_Array_Offset,
100
,
101
,
Function,
wrbx ,
wrbx ,
Node_Name,
Node_A
,
Node_A
,
Table_Name,
OCCDEFCS OCCPC64S,
OCCDEFCS OCCPC64S,
Length,
1
,
1
,
Data_Type
Occupancy_DOW
Occupancy_Time
The Data type tells the driver how
to format the value for the write.
Field_Name ,
DOW3
,
UNOCC3 ,
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
Scan_interval,
1.0s
,
1.0s
,
When a time write occurs the driver extracts the value from the Data Array and coverts the value to a time string. The value extracted
from the DA is considered to be the number of minutes from midnight, e.g. DA value = 1 - Time = 00:01; DA value = 959 Time=15:59
Occupancy’s are set using a BCD value. Write the value decimal equivalent of 01111100 (62 decimal) to signify an occupancy of
Monday to Friday. The bit string starts on Sunday, runs through Monday to Saturday and the final bit is for holidays.
When the DOW write occurs, the driver extracts the value from the Data Array and converts it to a binary string whose bit value is the
binary representation of the Data Array value, e.g. DA value = 131 DOW string = 10000011 e.g. DA value = 1 DOW string =
00000001
This example illustrates how to write values to an occupancy table. Occupancy tables contain amongst other variables, Day of Week
(DOW) settings and time settings. The driver needs to be configured so that it formats these values correctly.
4.4.7.
FS-8700-82 Carrier DataLink
FS-8700-82 Carrier DataLink
5.
Page 13 of 31
Configuring the FieldServer as a Carrier DataLink Server
For a detailed discussion on FieldServer configuration, please refer to the FieldServer
Instruction 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 Client.
The FieldServer can be configured to emulate a Carrier DataLink Device. The use is able to
define a variable number of data tables, allocating a table name a variable number of variables.
The FieldServer may be polled and will respond like a DataLink device. Remote clients can
force variable states by ending write variable commands.
The FieldServer does not emulate any of the alarm buffer/history features of the DataLink
Device.
All variables may be read or written without restriction.
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 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
Baud*
Specify baud rate
Parity*
Data_Bits*
Stop_Bits*
Protocol
Handshaking*
Specify parity
Specify data bits
Specify stop bits
Specify protocol used
Specify hardware handshaking
Legal Values
P1-P8, R1-R23
300, 600 , 1200, 2400, 9600
(Vendor limitation)
None (Vendor limitation)
8 (Vendor limitation)
1 (Vendor limitation)
CarrrierDL
None
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: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 14 of 31
Example
//
Server Side Connections
Connections
Port, Baud, Parity, Data_bits, Stop_Bits,
P8, 9600, None , 8
,
1
,
5.2.
Protocol ,
CarrierDL,
Handshaking,
None
,
Poll_Delay
0.100s
Server Side Nodes
Section
Title
Nodes
Column
Title
Node_Name
Node_ID
Protocol
Function
Legal Values
Up to 32
alphanumeric
characters
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
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.
Specify protocol used
1-15
CarrierDL
Example
//
Server Side Nodes
Nodes
Node_Name,
FAN1 ,
Node_ID,
1
,
Protocol ,
CarrierDL,
Port
It is common to leave Server nodes
unconnected to a port. This means that the
FieldServer can respond with the node’s
data irrespective of which port the request
is received on.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
5.3.
Page 15 of 31
Server Side Map Descriptors
5.3.1.
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Map_Descriptor_Name Name of this Map Descriptor
Data_Array_Name
Name of Data Array where
data is to be stored in the
FieldServer
Data_Array_Location
Starting location in Data Array
Function
Map Descriptor function
5.3.2.
Legal Values
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
Passive
Driver Specific Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node
names specified in
Node_Name
Name of Node to fetch data from
“Server Node
Descriptor” above
Data_Type
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
Length
1 – 1000
number of data values to be stored. Refer to
1.1.
Address
This commonly used parameter is not required for this driver.
The name of the table to be polled, e.g.
ASCII characters
DISPLAY. Some system elements have
only. When using
multiple instances of the same table name,
this parameter to
e.g. the Terminal System Manager has 64
specify a primary
Table_Name
Temperature Zone configuration tables
and secondary table,
named TZONE1 though TZONE64. These
leave a single space
tables are accessed by using both the
between the two
primary & secondary table names, e.g.
names.
‘TZCONF TZONE1’
ASCII characters
only. No spaces,
Field_Name
This is the field/table variable pneumonic.
maximum length 10
characters.
Returned
when
a
client
does
a
table
read.
If
Field_Description
ASCII string which
units have no meaning for the variable then
may contain spaces.
Field_Units
leave this field blank or use a single dash.
If the variable has a discrete state, use this
NUMERIC
parameter to define the word that describes
TIME
the state when the variable’s value is 1.
STRING
On_String
OR
DOW
Use one of the keywords to tell the driver to
Or any other ASCII
send the value of the associated array
string which may not
elements as a number (keyword=NUMERIC), contain spaces.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Column Title
Function
as a time value formatted as hh:mm
(keyword=TIME) or as a string of bytes
(keyword=STRING) or as an occupancy
string (keyword=DOW).
When using the string keyword the driver
reads x consecutive array elements and
treats them like ASCII character values in
forming the response. X is defined by the
length parameter.
If the variable has a discrete state, use this
parameter to define the word that describes
the state when the variable’s value is zero. If
you have used one of the above keywords,
simply put a dash in this field.
Always set the length to 1 unless you use the
key word ‘STRING’ as the On_String
parameter.
Off_String
Length
5.3.3.
Page 16 of 31
Legal Values
An ASCII string
which may not
contain spaces.
1
Timing Parameters
Column Title
Function
Specifies time server side waits before responding
Scada_Hold_Timeout to client that node is offline on FieldServer client
side.
Legal
Values
>1.0s
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
Map Descriptor Example.
Page 17 of 31
passive,
passive,
passive,
passive,
passive,
passive,
passive,
passive,
passive,
Display_MD02,
Display_MD03,
Display_MD04,
Display_MD05,
Display_MD06,
Display_MD07,
Display_MD08,
Display_MD09,
Display_MD10,
Node_1,
Node_1,
Node_1,
Node_1,
Node_1,
Node_1,
Node_1,
Node_1,
Node_1,
Node_Name,
Node_1,
CSPT
,
SPT
,
RAT
,
SAT
,
FANSTAT,
CCAP
,
HCAP
,
FLTSTAT,
ALARM
,
Field_Name,
MODE,
Field_Description,
Desired Mode,
Equipment
Status,
Controlling Setp,
Controlling Temp,
Space Temp,
Supply Air Temp,
Fan Mode,
Cooling Capacity,
Heating Capacity,
Filter Status ,
If the value of the array named
TABLE_DISPLAY, offset 10 is 1
then the FieldServer will report he
FLTSTAT variable as DIRTY. If it
is zero then the variable’s state
will be reported as clean.
DISPLAY,
DISPLAY,
DISPLAY,
DISPLAY,
DISPLAY,
DISPLAY,
DISPLAY,
DISPLAY,
DISPLAY,
Table_Name,
DISPLAY,
dF,
dF,
dF,
dF,
,
% ,
% ,
,
,
Field_Units,
,
,
NUMERIC,
NUMERIC,
NUMERIC,
NUMERIC,
ON
,
NUMERIC,
NUMERIC,
DIRTY ,
ALARM
On_String,
ON
,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
TABLE DISPLAY,
Data_Array_Name,
TABLE DISPLAY,
03,
04,
05,
06,
07,
08,
09,
10,
02,
Data_Array_Offset,
01,
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.
-,
-,
-,
-,
OFF,
-,
,
CLEAN,
NORMAL,
Off_String,
OFF
,
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
All the server Map
Descriptors are
passive.
Function,
passive,
Map_Descriptor_Name,
Display_MD01,
1
1
1
1
1
1
1
1
Length,
1
1
This example shows a number of server Map Descriptors used to define a table called ‘DISPLAY’. If a client sends a read table
request the driver responds by sending all the appropriate data for every Map Descriptor with the same table name (provided that the
node’s match).
5.3.4.
FS-8700-82 Carrier DataLink
FS-8700-82 Carrier DataLink
5.4.
Page 18 of 31
Driver Limitations and Exclusions
As a client:
• The Carrier DataLink driver is not capable of polling for alarm data. (The RA and AV
functions are not implemented).
• The Carrier DataLink driver dos not validate table or variable names.
• The Carrier DataLink driver does not support the Read Table command with the /C or /N
options.
• The Carrier DataLink driver records a timeout if the DataLink device does not provide the
‘?’ prompt within the user-configurable timeout period.
• Write-thru’s are not supported. The reason for this is that the driver read a composite
data set and the client side Map Descriptors do not contain enough information to format
a write.
As a server:
• The Carrier DataLink driver is not capable of serving alarm data. (RA and AV polls
produce an error response)
• The driver cannot set a discrete variable’s state unless it is set a value of one or zero.
• The driver server does not understand write table or write variable requests where the
requested state is a word like ON or OFF.
• The Carrier DataLink driver does not validate values or states, it simply stores the
values.
• All variables are may be read and written without limitation. The driver has not
implemented the Courier notion of Force Levels.
• There is no command buffer. One command can be processed at a time.
• The driver responds to all Read Table commands as if the /Y option was used. The
driver does not support the /C or /N options.
• The Carrier DataLink driver does not support the control character commands CTRLC/S/Q
General
• The Carrier DataLink driver is not capable of configuring the DataLink device. Software
provided by the Carrier Corporation is required to do this. The DataLink device requires
configuration, so that connects to the appropriate CCN devices on the CCN
communications network.
• The driver cannot be configured to act as what the Carrier Corporation identify as an
‘Alarm Acknowledger’.
• If the total length of the response from a read table query is more than 3000 bytes long,
the driver will produce an error.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 19 of 31
Appendix A. Advanced Topics
Appendix A.1. Table Names
The following list of table names is provided as a reference. Carrier may add tables and
new devices may become available.
Equipment Type
17/19EX CHILLER:
23XL CHILLER:
30GTNHW CHILLER:
30RA AQUASNAP
CHILLER:
39N AIR HANDLER:
Table Name
STATUS01
STATUS02
STATUS03
STATUS04
SETPOINT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
OCCDEFCS
OCCPC03S
COMPRESS
CVC_PSWD
HEAT_EX
ISM_STAT
MAINSTAT
POWER
STARTUP
SETPOINT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
OCCDEFCS
OCCPC03S
A_UNIT
CIRCADIO
CIRCA_AN
OPTIONS
SETPOINT
OccDefcS
OCCPC01S
A_UNIT
CIRCADIO
CIRCA_AN
CIRCBDIO
(some units)
CIRCB_AN
(some units)
OPTIONS
SETPOINT
BASEUNIT
DXCOOL
ELECHEAT
Equipment Type
48/50HG CENTURION
ROOFTOP:
AIR MANAGER AHU
CONTROLLER:
CHILLERVISOR:
COMFORTID VAV
TERMINAL CONTROL:
COMFORTID FAN
COIL CONTROLLER:
FLOTRONIC SYSTEM
MANAGER:
50 VPAC:
Table Name
OPTIONS
SETPOINT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
ECONOMZR
GENERAL
TSTAT
SETPOINT
OccDefcS
OCCPC01S
DISPLAY
SETPOINT
BASESYS
BYPASS
POINTS1
POINTS2
SETPOINT
OCCDEFCS
OCCPC01S
POINTS
SETPOINT
OCCDEFCS
OCCPC64S
DISPLAY
SETPOINT
OCCDEFCS
OCCPC64S
FSMSTAT1
FSMSTAT2
FSMSTPT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
HWP01-32
HWP33-64
SWP65-96
SETPOINT
SETPT01
SETPOINT
SETPT02
SETPOINT
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Equipment Type
19XR PIC II CHILLER:
30GTN CHILLER:
30GXNHXA CHILLER:
33CS VVT MONITOR:
40UV UNIT
VENTILATOR
48/50F SERIES
ROOFTOP:
Table Name
SETPT03
SETPOINT
SETPT04
SETPOINT
SETPT05
SETPOINT
SETPT06
SETPOINT
SETPT07
SETPOINT
SETPT08
OCCPCxxC
OCCPC01
COMPRESS
CVC_PSWD
HEAT_EX
ISM_STAT
MAINSTAT
POWER
STARTUP
SETPOINT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
OCCDEFCS
OCCPC03S
A_UNIT
CIRCADIO
CIRCA_AN
CIRCBDIO
CIRCB_AN
OPTIONS
SETPOINT
OccDefcS
OCCPC01S
A_UNIT
CIRCADIO
CIRCA_AN
CIRCBDIO
CIRCB_AN
OPTIONS
SETPOINT
OccDefcS
OCCPC01S
ZONESTAT
SETPOINT
OccDefcS
OCCPC01S
DISPLAY
SETPOINT
STATUS01
STATUS02
Page 20 of 31
Equipment Type
48/50M SERIES
ROOFTOP:
COMFORTID FAN
TERMINAL CONTROL:
CONQUEST
ROOFTOP:
PREMIERLINK
ROOFTOP
CONTROLLER:
VVT BYPASS
CONTROLLER:
VVT SLAVE STAT:
COMFORT
CONTROLLER
6400/1600:
Table Name
STATUS03
STATUS04
STATUS05
STATUS06
SETPOINT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
STATUS01
STATUS02
STATUS03
STATUS04
STATUS05
STATUS06
SETPOINT
OCCDEFCS
OCCPC01S
OCCDEFCS
OCCPC02S
POINTS
SETPOINT
OCCDEFCS
OCCPC64S
CV_TSTAT
DXCOOL
STATUS01
STATUS02
SETPOINT
OccDefcS
OCCPC01S
CV_TSTAT
STATUS01
SETPOINT
OCCDEFCS
OCCPC64S
BYPSSTAT
SETPOINT
ZONESTAT
SETPOINT
OccDefcS
OCCPC01S
HWP01-32
HWP33-64
SWP65-96
SETPOINT
SETPT01
OCCPCxxC
OCCPC01
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
Page 21 of 31
Function,
rdbc
,
Node_Name,
FAN01 ,
Scan_Interval,
5.0s,
Table_Name
DISPLAY ,
Field_Name,
EVERYTHING,
This is what tells the driver to dump the
table, its variables names and variable
descriptions in ASCII format.
Length,
1000 ,
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
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 can read it.
Data_Array_Offset,
0
,
Data_Array_Length
2000
Data_Array_Name,
DA_DUMP
,
Data_Format,
BYTE
,
Map Descriptors
Map_Descriptor_Name,
Md1
,
Data_Arrays
Data_Array_Name,
DA_DUMP
,
Storet_As
Ascii
The following example illustrates a Map Descriptor which reads a table and dumps the response in ASCII format to a Data Array
which can be browsed using RUINET (Refer to RuiNet Manual)
The Carrier Datalink driver can be used to obtain a list of variable names for a given table using the following Map Descriptors. It
is recommended that these Map Descriptors are removed from the configuration after the variable names have been obtained as
they will consume resource and processing time.
Appendix A.2. Using the Carrier Datalink Driver to Obtain Field Names
FS-8700-82 Carrier DataLink
Page 22 of 31
Function,
rdbc
,
Node_Name,
FAN01 ,
Length,
1000 ,
Scan_Interval,
5.0s
,
Table_Name,
DISPLAY ,
These are variable names.
Use these names in your
Map Descriptors.
Field_Name ,
EVERYTHING,
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
Variable descriptions.
Ascii Dump Requested for MD=<Md1> Table=<DISPLAY>
DEV 02 DISPLAY
Desired Mode
Off
MODE
Equipment Status
NORMAL
ALARM
Controlling Setpoint
75.0 dF
CSPT
Controlling Temperature
-40.0 dF
SPT
Space Temperature
-40.0 dF
RAT
Supply Air Temperature
-40.0 dF
SAT
Fan Mode
Off
FANSTAT
Cooling Capacity
0.0 %
CCAP
Heating Capacity
0.0 %
HCAP
The following fragment from the error log is typical of the response to a Map Descriptor like the one above.
Data_Array_Offset,
0
,
Data_Array_Length
2000
Data_Array_Name,
DA_DUMP
,
Data_Format,
BYTE
,
Map_Descriptor_Name,
Md1
,
Data_Arrays
Data_Array_Name,
DA_DUMP
,
Store_As
AsciiLog
This example illustrates a Map Descriptor which reads a table and dumps the response in ASCII format to the error log. The error
log can be dumped to a file on your computer using RUIDEBUG (Refer to FieldServer Utilities Manual)
FS-8700-82 Carrier DataLink
FS-8700-82 Carrier DataLink
Page 23 of 31
Appendix A.3. Map Descriptor Length Explained
The Length parameter is specified as part of the Map Descriptor.
Appendix A.3.1.
Client Reads a Table:
The length determines the number of table variables whose values are to be stored
when the response is received. If you do not know the length of the table in advance,
set the length to a large number (e.g. 100). If the table contains more elements than the
number defined in the length parameter, the additional data will be discarded.
Appendix A.3.2.
Client reads a variable:
Response to a variable read takes many forms. The ‘value’ returned can be a number, a
state (like ON), a time or some other string. To store a number or the time set the length
to 1. When a state or string is returned, the driver looks it up in a table of state words. If
it makes a match then it returns the value that has been associated with the state word,
(e.g. ON = 1, OFF = 0). If it cannot make a match, it stores the string byte for byte in the
data array. The number of bytes stored is determined by the length parameter. Thus, if
the length is 1 and the string is ‘INTERRUPTED’ then the driver will store the ‘I’ in the
data array. If the length was two, then the driver would use two consecutive locations
and store ‘I’ and ‘N’.
Appendix A.3.3.
Client writes a variable:
Always set the length to 1
Appendix A.3.4.
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 characters to extract from consecutive array
location to form the response string. When the server returns a value that is a number,
state or time the length should always be 1.
Appendix A.4. How the Client stores the states/values of the Table Variables.
Appendix A.4.1.
Discrete States
When a Carrier DataLink device reports the state of a table variable which has a discrete
state, it reports the state as a keyword like on/off. This driver has to convert the
keywords to numbers as most other remote devices are interested in the state as a
numeric value of 1 or 0.
The driver is programmed to recognize certain keywords. A list is provided below. The
driver is also capable of allowing the user to add to the table of predefined keywords by
specifying additional information in the configuration file.
State Word
Value
State Word
Value
CLEAN
DIRTY
HEAT
COOL
ON
1
0
1
0
1
ALERT
EMSTOP
ENABLE
Service
OFF-local
2
0
1
0
1
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 24 of 31
State Word
Value
State Word
Value
OFF
OPEN
CLOSE
CLOSED
ABNORMAL
NORMAL
ALARM
STOP
START
YES
NO
0
1
0
0
1
0
1
0
1
1
0
OFF-CCN
OFF-time
Emergency
ON-local
ON-CCN
ON-time
Redline
Shed
DSABLE
LOCAL
REMOTE
2
3
4
5
6
7
1
2
0
0
1
If the driver doesn’t recognize the state word it stores the characters of the state word as
decimal values based on their ASCII value. The number of characters 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 descriptor is 1 then the driver stores a value of
73 (An uppercase ‘I’ is the seventy third character in the ASCII alphabet.). If the length
was 2 then the driver would also store the value 78 in the next array. The driver will store
a maximum of 100 characters. The driver recognizes discrete state words by checking
the 1st character of the value field. If it is a non-digit then it is regarded as a state word.
Appendix A.4.2.
Extending the List of Discrete State Words
You can extend the list of state words the driver recognizes by modifying the
configuration file.
The following example adds three state words. If a device 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.
Keyword
starts a new
section of
the CSV file.
State Words. The
name will be
stripped of all
spaces between
the last character
and the comma.
Driver_Table
Carrier_Attr_State_Name,
LIGHT
,
DARK
,
Normally the values
will be 1 or zero for
the on/off states but
the driver does not
restrict the value.
Carrier_Attr_State_Value,
1
,
0
,
Protocol must be
defined on every
line.
Protocol
CarrierDL
CarrierDL
You can use this method to change the values of any of the driver’s default state words
by duplicating the word and specifying a new value in the configuration file.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Appendix A.4.3.
Page 25 of 31
Time Values
If the driver receives 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
recognizes a time value by checking the 3rd character for a colon and checking that the
1st character is a digit.
Value_Stored = hh * 60 + mm
Eg. 5:30pm is reported as 17:20 and is stored as 17*60 + 20 = 1040.
Appendix A.4.4.
Numeric Values
The driver recognizes numeric values by checking the first character of the value field. If
it is a digit then the field is treated as a number.
Appendix A.4.5.
Occupancy Strings / Values
If the value returned for a variable is 8 characters long and each of the characters is a
one or a zero then the driver regards this as an occupancy string and converts it to a
binary coded decimal value and stores this value.
Eg: 00101010 = 42 decimal
Appendix A.5. Timing Considerations
Reading a whole table can take several seconds depending on the table length. In addition
the response from the Carrier device can have small pauses after each line of response.
Thus, if you use the default timeout and IC_Timeout settings the communications may fail
when either one of the pauses exceeds the IC_Timeout setting or when the whole response
hasn’t been received by the time the timeout setting has elapsed.
For this reason it is recommended that the timeout be set to a value between 15 and 30
seconds and the IC_Timeout be set to a value between 7 and 15 seconds. Before setting
either of these to the maximum consider that the in the event of a real communications
failure, this set amount of time must elapse before the driver recognizes the timeout and
reports the node offline. Thus, it is best to start with a smaller value and increase it until
reliable communications have been achieved with the timeout settings.
The timeout can be set for the Map Descriptor, the node or the connection. This is more
fully explained in the FieldServer Configuration Manual. In summary, if you wish to apply a
single timeout to all messages to a device then set the timeout for the connection. If you
wish to override the connection timeout settings for a particular node the set the timeout for
that node too and if you wish to override the settings for a particular Map Descriptor then set
the timeout for that Map Descriptor.
The example below illustrates how to set the timeout parameters at the connection level.
//
Client Side Connections
Connections
Port, Baud,
P8,
9600,
Parity,
None,
Data_bits,
8
,
Stop_Bits,
1
,
Protocol ,
CarrierDL,
Handshaking,
None
,
Poll_Delay,
0.100s ,
Timeou,t,
30.0s ,
IC_Timeout
15.0s
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 26 of 31
Appendix B. Carrier DataLink Device Error Response
The following notes are provided from the protocol specification.
Message
Explanation
Action
Check the spelling of the
#1 Invalid
The last command sent to the DataLink
command and verify that it
contains the required
Command
device is not recognized.
parameters.
Check the spelling of the table
name(s). If using a WV or RV
#2 Invalid or NonThe specified table does not exist in the
command; verify that the table
Existent Table
specified element.
contains the specified
variables.
A Communication error has occurred
#3 Level II
due to other activity on the CCN
Verify the COMM2 connector
Communications
communication bus, a system element
is not disconnected and retype
failure,
or
an
incorrect
address.
The
Error
the command.
command will not be executed.
Verify that the correct bus and
The specified system element’s bus and element number have been
#6 Device Not
entered in the DTP-CONFG
the element number were not found in
Configured
the DTP-CONFG table.
table corresponding to the
device number.
Check the spelling of the
variable name and verify that
#7 Variable Does
The variable does not exist in the
Not Exist
specified table.
the CCN variable exists in the
specified system element.
#8 Invalid Data
The data was in an incorrect format.
Verify the format of the data.
An attempt was made to read or write to
#9 Access
Check variable.
a table or variable type that is not
Restricted
supported by the DataLink device.
#10 Limits
The value that was typed is outside the
Verify the limits and adjust the
Exceeded
specified variable’s upper or lower limits force value.
Reissue the command at later
#11 Alarms Not
There are no alarms currently in the
time or adjust the alarm
Available
alarm buffer.
priority level.
The CCN system element does not
#12 Cannot Force
Choose different variable.
allow write access to the specified
Variable
variable.
Check the spelling of the point
The 8-character point (variable) name
#13 Parameter Not
(variable) name and verify that
used in the RT or WT command does
Found
the point name exists in the
not exist.
specified system element.
The command was accepted but not
Retype the command after
understood by the specified system
checking the force priority and
#14 Level II
element, an attempt was made to write
after verifying that the correct
Communications
to or read a variable with a higher force
bus and element number is
NACK
level, or an attempt was made to write or entered in the DTP-CONFG
read from a UT203 controller.
table.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 27 of 31
Appendix C. Driver Notes
Appendix C.1. Driver Stats
The driver reports statistics according to the FieldServer standards. The following notes
describe some aspects of standard statistic reporting which are peculiar to this driver.
All errors responses from the Carrier DataLink device are recorded as a PROCOL ERROR,
In addition to the standard FieldServer communication statistics described above and in the
FieldServer User’s Manual, this driver can also expose some driver statistics by writing data
to a data array. A special Map Descriptor is required. The driver recognizes the Map
Descriptor by its name which must be "Carrier-stats”.
The following example shows how this special Map Descriptor can be configured. You can
copy this section of text directly into your CSV file.
Nodes
Node_Name ,
Carr_stats ,
Station ,
1
,
Protocol
CarrierDL
Data_Arrays
Data_Array_Name ,
DA_CARRIER_STATS ,
Data_Format,
UINT32 ,
Data_Array_Length
2000
Map_Descriptors
Map_Descriptor_Name,
Carrier-Stats,
Data_Array_Name ,
DA_CARRIER_STATS
Data_Array_Offset
0,
Function
passive,
Node_Name ,
Carr_stats,
Length
500
When the driver sees this Map Descriptor it uses the data array DA_CARRIER_STATS (in this
example) to store driver specific statistics. Only one of these Map Descriptors may be
specified per FieldServer.
The driver stores the following data. The location in the data array is obtained by
multiplying the port number by 50 and then using the location offset indicated in the table
below.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
OFFSET
0
1
2
3
4
5
6
Page 28 of 31
9
8
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
DESCRIPTION
Number of Read Table messages sent
Number of Read Variable messages sent
Number of Write Table messages sent
Number of Write Var Messages sent
Number of bytes sent by client driver
Number of messages sent by client
Number of response messages received by client
Number of times client tries write with alternate format because original
method failed
Most recent response error
Number of times client receives an error response
Carrier Error: #1 Invalid Command"
Carrier Error: #2 Invalid or Non-Existent Table"
Carrier Error: #3 Level II communications Error"
Carrier Error: #4 Error not defined"
Carrier Error: #5 Error not defined"
Carrier Error: #6 Device Not Configured"
Carrier Error: #7 Variable Does not Exist"
Carrier Error: #8 Invalid Data"
Carrier Error: #9 Access Restricted"
Carrier Error: #10 Limits Exceeded"
Carrier Error: #11 Alarms not Available"
Carrier Error: #12 Cannot Force Variable"
Carrier Error: #13 Parameter Not Found"
Carrier Error: #14 Level II Communications NACK"
Some other error
Number of response bytes received by client
26
Number of times client has timeout out waiting for (response) prompt
27
When set then the server sends response whose var names have leading
spaces. This is used for QAA testing and diagnostic purposes only.
Customers should never set this value.
28
Number of times client cannot parse / recognize the value sting in a response
29
Number of times the server had to store a time greater than 24:00
30
Number of times the client sent a message with a time greater than 24:00
31
Number of times the client sent a message to a probable occupancy table
without the correct data types
7
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 29 of 31
Appendix D. Driver Error Messages
The driver reports information and errors in the form of messages printed to the error log. Those
messages marked with a * are only printed once even if they occur repeatedly.
Error Message
Carrier:#1 FYI. The
MapDesc called <%s> is too
short
Carrier:#2 FYI. You could
have used a MapDesc called
<%s> to expose diagnostic
info.
Carrier:#3 Err. Illegal
Node_ID=%d Valid=1..15
Carrier:#4 FYI. Address has
no meaning. Best set to 1
MapDesc=<%s>
Carrier:#5 Err. For write, set
length to 1. MapDesc=<%s>
Carrier:#6 FYI. Field Name
Blank. Assumed
'EVERYTHING'.
MapDesc=<%s>
Carrier:#7 Err. Table name
required. MapDesc=<%s>
Carrier:#8 Err. Length
required. MapDesc=<%s>
Carr:#9 FYI. Duplicate
state=<%s>. Value has been
updated from=%d to=%d
Carr:#10 Err. No space.
Driver rejects value
state=<%s> value=%d
Carr:#11 FYI. User added
value state=<%s> value=%d
Carr:#12 Err. Length too
short to store all. MD=<%s>
Carrier:#13 FYI. Diagnostic
send error #1 response.
Carrier:#14 FYI. Diagnostic
cancelled slave response
Explanation
The length of the Map Descriptor used to expose driver
statistics is too short. Set to at least 1000. This message may
be ignored§.
This message is a prompt and may be ignored. Read
Appendix C.1 for more information.
Valid node numbers are in the range 1 to 15 inclusive. Read
sections 4.3 or 5.3 for more information. §
You can ignore this message. The address parameter has no
meaning in the configuration of this driver. Remove the
parameter from the configuration or set its value to 1§
If the Field_Name parameter is left unspecified then the driver
assumes you intend reading the whole table by filling in the
Field_Name with the keyword EVERYTHING. Suppress this
message by specifying the Field_Name .§
Every Map Descriptor for this driver requires that you specify a
table name. Section 4.4.2 and Appendix A.1 provide additional
information. §
The length parameter must be set in the configuration file to a
value greater than zero. Refer to Appendix A.3.§
You have specified a discrete state word in the configuration
file which is a duplicate of one already in the list. The driver
uses the new value, thus changing the values for the driver’s
default discrete state words. You can ignore this message.
The driver has limited space to store discrete state keywords
added in the configuration file. The maximum is 150 words
including the driver’s defaults. Remove some of the keywords
you have added to the configuration file. §
You can ignore this message; it is for information only. Each
time a new discrete state word is added to the driver from the
configuration file, the driver reports the new word and its value.
The read table command resulted in more variables being
returned than you have reserved space for (with the length
parameter). Increase the length parameter§.
These messages are for FieldServer engineers. If printed in
the error log please call FieldServer support and report the
message.
§
Correct the error by editing the configuration CSV file, downloading the corrected file to the FieldServer
and then resetting the FieldServer.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Error Message
Carrier:#15 Err. Alarm
commands not supported.
Carrier:#16 Err. Alarm
commands not supported.
Carr:#17 Err. MD=<%s>
discrete state word not
recognized.
CarrDL:#18 FYI. Timeout
probably too short. Read
Manual.
CarrDL:#19 Err. Diagnostic.
Call Support.
CarrDL:#20* FYI. Invalid
Time(%02d:%02d) being
written. MD=%s
CarrDL:#21* FYI. Invalid
Time(%02d:%02d) being
stored. MD=%s
CarrDL:#23* Err. CarrDL
device reported errors.
Check exposed stats 8-23.
CarrDL:#22* FYI. Read
notes for #22 in Manual.
MD=%s
Page 30 of 31
Explanation
The server does not support alarm functions. Polls beginning
AV or RA produce these errors. Re-configure your client not to
request this information. §
On the line immediately following this error the driver reports
the response that generated the error. The driver will store a
value that is the ASCII code for the first character of the
unrecognized word. Add a new discrete state word to the .CSV
file as described in Appendix A.4. §
This message may be ignored if your communications are
operating reliably. Read Appendix A.5 for additional information
on timing considerations. The message is printed when the
driver detects that the configuration requires that a whole table
be read and the timeout value is set below the recommended
minimum of 15s for this operation.
This error message should only be produced by FST’s QA
testing procedure. If you see this error, call Tech Support after
taking a log. Instructions for taking a log may be found in the
Trouble Shooting Guide.
The message is printed once and suppressed for subsequent
occurrences. The message is printed when writing a time to a
Carrier Device which is invalid as it is greater than 23:59.
Check the value in the Data Array being used for the write. It’s
possible an upstream device sent an invalid value. The driver
sends the message with the invalid time and it’s up to the
Carrier device to reject the setting.
The message is printed once and suppressed for subsequent
occurrences. The message is printed when the Server is
required to store an invalid time (>23.59). Check the value in
the Data Array being used for the write. The data is stored
despite the warning.
These errors occur when communications are operating
correctly but the CarrDL device cannot respond to the poll.
The reason error is reported in the driver stats (See Appendix
C.1) Stat #9, reports the error number of the most recent error
reported. The message is printed once and then suppressed.
These errors are most commonly produced when a table
name/ variable name does not exist or is mis-spelled
DOW and times require that the Data_Type be specified when
writing to enable the Driver to convert the value extracted from
the Data Array for formatting in the write message. This error
is printed if the table name or the field name contain the substring “OCC”, the function is a write, and a Data_Type has not
been specified. In most cases the write will be rejected by the
Carrier device or the value may not be what you expect. Refer
to Section 4.4.7 for more information.
§
Correct the error by editing the configuration CSV file, downloading the corrected file to the FieldServer
and then resetting the FieldServer.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com
FS-8700-82 Carrier DataLink
Page 31 of 31
THIS PAGE INTENTIONALLY LEFT BLANK
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.com