A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-86 Carrier DataPort
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after August 2008
Driver Version:
1.03
Document Revision: 11
FS-8700-86 Carrier DataPort
Page 3 of 32
1.
Carrier DataPort Description
The Carrier DataPort driver allows the FieldServer to transfer data to and from devices over either RS-
232 or RS-485 using Carrier DataPort protocol. The FieldServer can emulate either a Server or Client.
The DataPort device provides a gateway to CCN devices. This driver polls the DataPort device which in
turn reads data from the CCN devices. Up to 15 system elements may be connected to a DataPort
Device.
Carrier limits the number of CCN devices that can polled from a DataPort Device and also limits the data
that can be transferred between some CCN devices and the DataPort device. For information on these
limitations please consult the Carrier Corporation.
The driver is an active Client driver. This means that it initiates read polls with the DataPort device which
is expected to provide responses. Server functionality is provided by the driver too.
The driver is configured to allow a single Data Table (usually the Display Table) to be read from the CCN
devices via the DataPort device. As the table typically contains more than one data element, the
retrieved data is stored in a number of consecutive Data Array locations in the FieldServer. The driver
can provide descriptions for each of the table values retrieved.
The driver has no advanced knowledge of the CCN devices and their Data Tables. This means that the
driver handles each table in a generic way, without regard for the particular variables that constitute the
tables. The most important consequence of this is that the variable values are stored in the order in
which they appear in the response from the DataPort device. It is not possible to map particular variable
values to particular locations in the FieldServer Data Arrays.
2.
Driver Scope of Supply
2.1. Supplied by FieldServer Technologies for this driver
FieldServer Technologies PART #
FS-8917-02
FS-8917-17
SPA59132
FS-8700-86
DESCRIPTION
RJ45 to DB9F connector adapter
RJ45 to DB25M connection adapter
RS-485 connection adapter
Driver Manual.
FS-8700-86 Carrier DataPort
Page 4 of 32
3.
Hardware Connections
The FieldServer is connected to the Carrier DataPort device as shown below.
Configure the DataPort Device according to manufacturer’s instructions. This driver requires that the
DataPort device’s DTPCONFIG table has been configured prior to connection with a FieldServer. In
addition, consult the manufacturer’s information on connecting Carrier Device’s to CCN network.
Note: Typical connections are 9600,N,8,1.
FS-8700-86 Carrier DataPort
Page 5 of 32
4.
Configuring the FieldServer as a Carrier DataPort Client
It is not possible to complete a configuration for communication with a DataPort device until you are
familiar with the data available from the devices connected to the DataPort. The DataPort device does not
provide a method for discovering the data tables and variables that are available in all the Carrier devices.
Configuring the DataPort driver as a Client is easy; however, you will not be able to complete the server
side configuration until you have a list of the variables and the order in which the DataPort device will
report them. The driver is capable of helping you determine this information but cannot auto-complete the
configuration. This method is discussed in Appendix A.
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration
Manual. The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to
communicate with a Carrier DataPort Server.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to
enable the FieldServer for Carrier DataPort communications, the driver independent FieldServer buffers
need to be declared in the “Data Arrays” section, the destination device addresses need to be declared in
the “Client Side Nodes” section, and the data required from the servers needs to be mapped in the “Client
Side Map Descriptors” section. Details on how to do this can be found below.
Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.
4.1.
Data Arrays
Section Title
Data_Arrays
Column Title
Function
Legal Values
Data_Array_Name Provide name for Data Array
Up to 15 alphanumeric characters
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte, Packed_Byte,
Swapped_Byte
Provide data format. Each Data Array
Data_Format
can only take on one format.
Number of Data Objects. Must be larger
Data_Array_Length than the data storage area required for 1-10,000
the data being placed in this array.
Example
// Data Arrays
//
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Format,
UInt16,
UInt16,
Bit,
Data_Array_Length
200
200
200
200
DA_DO_01,
Bit,
FS-8700-86 Carrier DataPort
Page 6 of 32
4.2.
Client Side Connections
Section Title
Connections
Column Title
Function
Legal Values
R1, R2 with
Specify which port the device is connected to the P1-P8,
(
Port
FieldServer
converter)1
600 , 1200, 2400, 9600
(Vendor limitation)
Baud*
Specify baud rate.
Parity*
Specify parity
None (Vendor limitation)
Data_Bits*
Specify data bits
8 (Vendor limitation)
Stop_Bits*
Protocol
Specify stop bits.
1 (Vendor limitation)
Specify protocol used
CarrierDP
Handshaking* Specify hardware handshaking
None
0-32000
second
seconds,
1
Poll _Delay*
Time between internal polls
Specifies the max amount of time the driver must
wait for a complete response.
Timeout2
2 seconds
If the Data Port table is long then increase the
timeout above the default until timeout errors
disappear.
Application
Refer to notes in Appendix B.3
Print_storage_locations
If the parameter is not configured or set to 0
(default), the driver will identify the start of a
message as FORMFEED (0x0C) and the end as two
carriage returns (0x0D 0x0D)
Start_Method*
1,0
When the parameter is set to 1, the first carriage
return (0x0D) will be considered the start of the
message (all characters before the first carriage
return will be ignored). and the end as two carriage
returns (0x0D 0x0D)
Example
// Client Side Connections
Connections
Port, Baud, Parity,
P8, 9600, None,
Data_Bits,
Stop_Bits,
Protocol ,
CarrierDP,
Handshaking,
None
Poll_Delay
0.100s
8
,
1
,
,
1
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
2 See Appendix B.1 for additional information
FS-8700-86 Carrier DataPort
Page 7 of 32
4.3.
Client Side Node Descriptors
Section
Title
Nodes
Column
Title
Function
Legal Values
Up to
32
Node_Name Provide name for node
These correspond to the ‘devices’ configured in the
alphanumeric
characters
DTPConfig. Thus the Node_ID is not the address of the final
CCN device.
Node_ID
1-15
The DataPort DTPConfig table maps a device number
(1...15) to a bus number (0-239). Use the Node_ID to tell the
driver which device to use.
Protocol
Port
Specify protocol used
CarrierDP
Specify which port the device is connected to the FieldServer P1-P8, R1-R23
Example
// Client Side Nodes
Nodes
Node_Name,
Node_ID,
Protocol ,
CarrierDP,
Port
P8
FAN1
,
1
,
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.
FS-8700-86 Carrier DataPort
Page 8 of 32
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Column Title
Function
Legal Values
Map_Descriptor_Name Name of this Map Descriptor
Up to 32 alphanumeric characters
Name of Data Array where data is One of the Data Array names from
Data_Array_Name
to be stored in the FieldServer
Starting location in Data Array
Function of Client Map Descriptor
“Data Array” section above
0 to maximum specified in “Data
Array” section above
Data_Array_Location
Function
Rdbc, Wrbc, Wrbx
4.4.2.
Driver Related Map Descriptor Parameters
Function
Column Title
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
Node_Name
Data_Type
Name of Node to fetch data from
This commonly used parameter is not
required for this driver.
Length of Map Descriptor. When reading a
compete table, set the length to the
maximum number of data values you want
stored.
Length
1 – 1000
Additional information on the length
parameter is provided in Appendix A.3.
Address
This commonly used parameter is not required for this driver.
Use the ASCII or AsciiLog format when
you are discovering the variables
Store_As*
contained in a table by reading a table.
Refer to Appendix A for more information.
ASCII, AsciiLog, Values
The name of a Data Array
defined in the Data_Array
section of the configuration file.
The name of a Data Array
defined in the Data_Array
section of the configuration file.
If defined, the driver stores the ‘field status’
value in this array.
DA_Byte_Name*
DA_Float_Name*
If defined, the driver stores the ‘field units’
value in this array.
4.4.3.
Timing Parameters
Column Title
Function
Legal Values
Scan_Interval
Rate at which data is polled
>0.1s
FS-8700-86 Carrier DataPort
Page 10 of 32
5.
Configuring the FieldServer as a Carrier DataPort Server
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration
Manual. The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to
communicate with a Carrier DataPort Client.
The FieldServer can be configured to emulate a Carrier DataPort Device. The user is able to define a
variable quantity of variables. The FieldServer may be polled and will respond like a DataPort device.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order
to enable the FieldServer for Carrier DataPort communications, the driver independent FieldServer
buffers need to be declared in the “Data Arrays” section, the FieldServer virtual node(s) needs to be
declared in the “Server Side Nodes” section, and the data to be provided to the Clients needs to be
mapped in the “Server Side Map Descriptors” section. Details on how to do this can be found below.
Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.
5.1.
Data Arrays
Section Title
Data_Arrays
Column Title
Function
Legal Values
to 15 alphanumeric
Up
characters
Float, Bit,
Data_Array_Name Provide name for Data Array
Uint16,
Sint16,
Provide data format. Each Data Array can
only take on one format.
Data_Format
Packed_Bit, Byte, Packed_Byte,
Swapped_Byte
Number of Data Objects. Must be larger
Data_Array_Length than the data storage area required for 1-10,000
the data being placed in this array.
Example
// Data Arrays
//
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Format,
Uint16,
Uint16,
Bit,
Data_Array_Length
200
200
200
200
DA_DO_01,
Bit,
FS-8700-86 Carrier DataPort
Page 11 of 32
5.2.
Server Side Connections
Section Title
Connections
Column Title
Function
Specify which port the device is connected to
the FieldServer
Legal Values
P1-P8, ( R1-R2 with converter)4
Port
300, 600 , 1200, 2400, 9600
(Vendor limitation)
Baud*
Specify baud rate
Parity*
Specify parity
None (Vendor limitation)
Data_Bits*
Specify data bits
8 (Vendor limitation)
Stop_Bits*
Protocol
Specify stop bits
1 (Vendor limitation)
Specify protocol used
CarrierDP
Handshaking* Specify hardware handshaking
None
Example
// Server Side Connections
Connections
Port,
P8,
Baud, Parity, Data_Bits, Stop_Bits, Protocol ,
Handshaking, Poll_Delay
0.100s
9600, None, CarrierDP, None
8
,
1
,
,
5.3.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Function
Provide name for Node
Legal Values
Up to 32 alphanumeric
characters
Node_Name
DataPort 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.
Node_ID
1-15
The DataPort DTPConfig table maps a device
number (1...15) to a bus number (0-239). Use the
Node_ID to tell the driver which device to use.
Specify protocol used
Protocol
CarrierDP
Example
// Server Side Nodes
Nodes
Node_Name,
FAN1
Node_ID,
Protocol ,
CarrierDP,
Port5
P8
,
1
,
4
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
5 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.
FS-8700-86 Carrier DataPort
Page 12 of 32
5.4.
5.4.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Legal Values
Map_Descriptor_Name Name of this Map Descriptor
Up to 32 alphanumeric characters
Name of Data Array where data is One of the Data Array names from
Data_Array_Name
to be stored in the FieldServer
Starting location in Data Array
Function of Client Map Descriptor
“Data Array” section above
0 to maximum specified in “Data
Array” section above
passive
Data_Array_Location
Function
5.4.2.
Driver Specific Map Descriptor Parameters
Function
Column Title
Legal Values
One of the Node Names
specified in “Server
Node Descriptor” above
Node_Name
Length6
Name of Node to fetch data from
Length of Map Descriptor. When reading a
compete table, set to the maximum number of 1 – 1000
data values to be stored.
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
Only Ascii characters are
permitted.
parameter.
Some system elements have multiple instances
of the same table name. For example, the
Terminal System Manager has 64 Temperature
Zone configuration tables. The individual tables
are named TZONE1 though TZONE64. These
tables are accessed by using both the primary &
secondary table names.
When using the table
name parameter to
specify a primary and
secondary table, leave a
single space between
the two names.
Table_Name*
E.g. ‘TZCONF TZONE1’
An Ascii string which
may not contain spaces.
Max length 8 characters.
An Ascii string which
may contain spaces.
Field_Name
This is the field variable pneumonic.
Field_Description Returned when a Client does a read.
Max
characters.
Returned when a Client does a read. If units A whole number. See
length
24
Field_Units
have no meaning for the variable set to zero.
Appendix A.1
This parameter is used to set data quality
information that is returned when the Client polls A whole number. See
for data. If omitted and DA_Byte_Name has not Appendix A.1 for more
been specified the driver returns zero as the information.
status value.
Field Status*
6 Additional information on the length parameter is provided in Appendix A.
FS-8700-86 Carrier DataPort
Column Title
Page 13 of 32
Legal Values
Function
If this parameter is defined then its value must be
the name of a Data Array. Instead of the driver The name of Data Array
DA_Byte_Name* returning a static Field Status, it will extract the defined in the Data
value located at the given offset and use this Arrays section.
value as the Field Status.
If the variable has a discrete state, use this
parameter to define the word that describes the
state when the variable’s value is 1.
OR
NUMERIC
Use one of the keywords to tell the driver to send
TIME
the value of the associated array elements:
STRING
NUMERIC – a number
On_String
DOW
TIME - a time value formatted as hh:mm
STRING - a string of bytes
DOW – occupancy string
When using the string keyword the driver reads x
consecutive array elements and treats them as
ASCII character values in forming the response.
X is defined by the length parameter.
Or any other Ascii string
which may not contain
spaces.
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 a keywords described above then
simply put a dash in this field.
An ASCII string which
may not contain spaces.
Off_String
Always set the length to 1 unless you use the key
word ‘STRING’ as the On_String parameter.
Length
1
5.4.3.
Timing Parameters
Function
Legal
Values
Column Title
Scada_Hold_Timeout
Specifies time Server side waits before responding to Client
that node is offline on FieldServer Client side.
>1.0s
FS-8700-86 Carrier DataPort
Page 15 of 32
Appendix A. Advanced Topics
Appendix A.1.
Field Status & Field Engineering Units
The following tables duplicate information available from Carrier Corporation. We provide it for
reference purposes. It is best to ask the vendor for current data.
Value Engineering Units
Value Engineering Units
Value Engineering Units
000
no units
051
feet per minute
thousands of cubic feet
per minute
260
Pascal
001
degrees F
052
262
delta degrees C
thousands of cubic feet
per hour
002
degrees F
053
263
degrees C
003
004
005
006
007
008
010
011
013
014
015
016
017
018
020
032
033
percent
inches of water
milliamps
delta degrees F
degrees F
delta degrees F
Volts
degrees F
percent
inches of water
milliamps
delta degrees F
degrees F
054
055
056
057
058
059
064
065
066
067
068
069
070
080
tons
264
267
270
272
273
274
276
288
289
290
291
292
293
295
296
297
298
delta degrees C
degrees C
Pascal
delta degrees C
degrees C
delta degrees C
kiloPascals
liters per minute
liter per hour
cubic meters per minute
cubic meters per hour
kiloPascals
kilograms per hour
kilowatt hours
kilowatts
millimeters of water
millimeters of mercury
tons per hour
revolutions per minute
percent open
hours
gallons
on/off input
off/on input
input pulses on
input pulses off
seconds
normal/alarm
Hz
minutes
hours
revolutions per minute
clock
delta degrees F
pounds per square inch 081
gallons per minute
gallons per hour
thousands of gallons per
minute
thousands of gallons per
hour
pounds per square inch,
gauge
pounds per hour
thousands of pounds per
hour
082
124
034
035
126
128
ASCII
299
300
301
kilowatt hours
kilowatts
no units
milliamp
036
037
038
133
137
138
degrees C
pounds per square inch 302
percent relative humidity
amps
volts
303
039
040
041
042
043
044
045
046
047
048
049
050
BTUs per hour
thousands of BTUs
inches of water
inches of mercury
kilowatt hours
kilowatts
degrees F
percent relative humidity 208
amps
144
145
146
192
193
194
195
kilowatts
kilowatt hours/pulse
pulses
on/off output
off/on output
pulsed on output
pulsed off output
steps
ASCII
no units
degrees C
degrees C
304
305
306
307
310
311
312
313
314
315
volts
cubic meters per minute
cubic meters per hour
meters per second
tons
tons per hour
revolutions per hour
percent open
hours
254
256
257
258
volts
liters
cubic feet per minute
cubic feet per hour
FS-8700-86 Carrier DataPort
Page 16 of 32
Error Conditions
Conditions
No Force
Fire
Force Conditions
A
0
16
B
1
17
C
2
18
D
3
19
E
4
20
36
F
5
21
37
Safety
32
33
34
35
Service Tool
Supervisor
Monitor
48
64
80
49
65
81
50
66
82
51
67
83
52
68
84
53
69
85
Minimum-off
Control
BEST
Temp Override
Loadshed
96
97
98
99
100
116
132
148
164
101
117
133
149
165
112
128
144
160
113
129
145
161
114
130
146
162
115
131
147
163
Error Conditions:
A
B
C
D
E
F
no error
hardware or communications error
software error
low alarm limit exceeded (analog point),or point in alarm (discrete point)
high alarm limit exceeded
unconfigured point (VVT Gateway only)
Force Conditions:
No Force
Fire
forced by fire alarm equipment
Safety
forced by internal safety override
forced by CCN Service Tool
Service Tool
Supervisor
Monitor
Minimum-off
Control
forced by local Building Supervisor
forced by remote Building Supervisor
forced by minimum off time requirement
forced by System Software Option
forced by BEST program
BEST
Temp Override
Loadshed
forced by temperature override
forced by Loadshed System Software Option
Appendix A.2.
Field / 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 can be configured in some devices using
software provided by the Carrier Corporation.
Consult the points list with the literature provided with each 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 Descriptors which may be included in the configuration to help obtain this
information. FieldServer recommends that if these Map Descriptors are used to obtain variable name
information, they should be removed from the final configuration as they will consume resource and
processing time.
FS-8700-86 Carrier DataPort
Page 19 of 32
Appendix A.3.
Map Descriptor Length Explained
The Length parameter is specified as part of the Map Descriptor.
Client Reads:
The length means: “The number of table variable’s 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 larger number
(e.g. 100). The driver will process the response; if the table contains more than 100 elements then
some data will be discarded.
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.
Discrete States
Appendix A.4.1.
When a Carrier DataPort 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 converts the keywords to facilitate reading
by other devices.
The driver is programmed to recognize the keywords listed below. The user can add keywords
by specifying additional information in the configuration file.
State Word
CLEAN
DIRTY
HEAT
COOL
ON
Value
State Word
ABNORMAL
NORMAL
LOCAL
REMOTE
LOCAL R
RUNNING
Value
State Word
OPEN
CLOSE
CLOSED
ALARM
Value
1
0
1
0
1
0
1
0
0
1
0
1
1
0
0
1
OFF
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 the first character of the
word incredible; by storing a value of 73 (An uppercase ‘I’ is the seventy third character in the
ASCII alphabet.).
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. The comparison against keywords in the list is done
without respect for the case of the letters.
Unrecognized Discrete State Words
If the driver does not recognize the discrete state word that has been used it will report the
following error - CarrDP:#24 Err. MD=<MapDesc1> discrete state word not recognized.
The unrecognized discrete word can be found by extracting 10 characters from the line starting at
the 10th character. Once the 10 characters have been extracted they are left and right trimmed
to remove leading and trailing spaces.
FS-8700-86 Carrier DataPort
Page 20 of 32
In the following two examples the keywords that are not recognized are 'Reset T' and 'Tripout'
respectively
CarrDP:#24 Err. MD=<MapDesc1> discrete state word not recognized.
T02>
>
<MODE
Reset T 000 000 Control Mode
T02> CarrDP:#24 Err. MD=<MapDesc1> discrete state word not recognized.
T02>
>
<STATUS Tripout 000 000 Run Status
In the following example the keyword '********' is not being recognized. If this message is printed
it is necessary to consult 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=<MapDesc1> discrete state word not recognized.
T02>
>
<CHWPD ********** 020 000 Chilled Water Delta P
T02>
Extending the List of Discrete State Words
You can extend the list of state words the driver recognizes by modifying the configuration CSV
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.
State Words
Normally the values
Keyword
starts a new
section
the CSV file.
will be 1/0 for the
on/off states but the
The name will be
stripped of all
spaces between the
last character and
the comma.
Protocol must
be defined on
every line.
of
driver
does
not
restrict the value.
Driver_Table
Carrier_Attr_State_Name,
Carrier_Attr_State_Value,
Protocol
LIGHT
DARK
,
,
1
0
,
,
CarrierDP
CarrierDP
This method may be used 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.
Appendix A.4.2.
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
E.g. 5:30pm is reported as 17:20 and is stored as 17*60 + 20 = 1040.
FS-8700-86 Carrier DataPort
Appendix A.4.3.
Page 21 of 32
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.4.
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 an converts it to a binary coded decimal
value and then stores this value.
E.g.: 00101010 = 42 decimal
FS-8700-86 Carrier DataPort
Page 22 of 32
Appendix B. Trouble Shooting/Connections - Tips and Hints
Appendix B.1.
Connection problems.
Confirm that the device you are trying to attach to the FieldServer is in fact a DataPort device and not
a DataLink device which looks very similar but connects differently.
A DataLink device will require the DataLink driver – FieldServer part # FS-8700-82. Please contact
FieldServer to request an exchange of driver.
Appendix B.2.
Timeouts
Some Data Port tables are long and result in messages of up to 6.5 kB being sent from the data port
to the FieldServer. The default timeout is insufficient in such cases.
In resolving one customer’s connection problems a timeout of 4 s on a table of 134 entries was found
to produce good results.
Please read the notes provided with Error message #25 in section Appendix D of this manual.
Appendix B.3.
Determining Storage Locations
Set the Application parameter to ‘Print_storage_locations’ on the connection to tell the driver to print
messages each time it stores data. The driver dumps messages in the error log reporting the Data
Array name, offset, value and the ‘line’ from which the data was extracted.
Remove the parameter to stop the messages being printed.
Example:
In the line below the driver reports that the line beginning ‘hd_pos_a…..’ was processed and that the
value 0.0 was stored in DA_D2_01 at offset 149.
T02> DPStore:DA=DA_D2_01 Off=49 Val=0.00 <hd_pos_a 0.0
T02> See above===>hd_pos_a 0.0
003 000 Head Press A
FS-8700-86 Carrier DataPort
Page 23 of 32
Appendix B.4.
How to build a script file that tests a customer log.
The following brief notes are intended for configuration engineers who are expected to be familiar
with the FieldServer.
•
Take the hex log file and convert to ASCII using special chars (this is an option of the log file
converter)
•
•
Choose a response line from near the end of the log (most recent). Check the line is complete.
Place the line inside an INI file. Make the following changes
•
•
•
Replace [NP] with [FF]
Replace [SP] with a space
Replace [NULL] with a space.
•
Use the following files as a guide.
Client.csv
Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length
DA_D1_01,
Float,
500
Connections
Port ,
Parity, Baud, Data_Bits, Stop_Bits, Handshaking, Protocol,
Timeout, Print_storage_locations
P1,
None,
9600, 8,
1,
None,
CarrierDP, 60s, Yes
Nodes
Node_Name, Node, Protocol,
Port
Node_A ,
1,
CarrierDP, P1
Map_Descriptors
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Length, Scan_Interval,
CMD_GP_01,
Server.csv
Data_Arrays
DA_D1_01,
0,
Rdbc,
Node_A,
202,
5.0s
Data_Array_Name, Data_Format, Data_Array_Length
TABLE_DISPLAY, Float,
500
Connections
Port ,
P1,
Parity, Baud, Data_Bits, Stop_Bits, Handshaking, Protocol,
None, 1200, 8, 1, None, CarrierDP,
Nodes
Node_Name, Node, Protocol,
Node_A , 1, CarrierDP,
FS-8700-86 Carrier DataPort
Appendix C. Driver Notes
Page 26 of 32
Appendix C.1.
Driver Limitations and Exclusions
The Carrier DataPort driver does not support the following functions. Send Data Periodically, Stop
Sending, Xoff, Xon, Omit 24 Character description, Include 24 Character description, Read
Configuration.
The Carrier DataPort driver is not capable of configuring the DataPort device. Software provided by
the Carrier Corporation is required to do this. The DataPort device requires configuration, so that it
connects to the appropriate CCN devices on the CCN communications network.
If the total length of the response from a read table query is more than 3000 bytes long, the driver will
produce an error.
FS-8700-86 Carrier DataPort
Page 27 of 32
Appendix D. Driver Error Messages
The driver reports information and errors to you 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
Explanation
The length of the Map Descriptor used to expose driver statistics is too
The short. Set the length to at least 1000 by editing the CSV file. Then reset
CarrierDP:1
FYI.
MapDesc called <%s> is too the FieldServer. You can ignore this message if you wish – the driver will
short
abandon statistics which require the length of the Map Descriptor to be
increased.
CarrierDP:2 FYI. You could
have used
a
MapDesc You can safely ignore this message. It is a prompt. Read Appendix D.1 of
called <%s> to expose this manual for more information.
diagnostic info.
CarrierDP:3
Node_ID=%d Valid=1..15
Err.
Illegal Valid node numbers are in the range 1 to 15 inclusive. Read section 4.3
for more information.*
You can safely ignore this message. The address parameter is
commonly used in FieldServer configurations but it has no meaning in
the configuration of this driver. It is best to remove the parameter from
the configuration or set its value to 0.*
CarrierDP:4 FYI. Address
has no meaning. Best set to
0 MapDesc=<%s>
CarrDP:#5 Err. DataPort is The Carrier DataPort device is read only. You cannot have a Map
read only. No wrbc/x. Descriptor which writes to the device. Delete the Map Descriptor or
MapDesc=<%s>
changing it to a read*
CarrDP:#6 Err. Fieldname
max
length
=8.
MapDesc=<%s>
You can use no more than 8 characters to define a field name and no
more than 24 to define the field description.*
CarrDP:#7 Err. Field Desc.
max length =%d.
MapDesc=<%s>
The length parameter must be set in the configuration file and it must be
set to a value greater than zero. Appendix A.3 provides additional
information.*
CarrierDP:8 Err. Length
required. MapDesc=<%s>
You have specified a discrete state word in the configuration file which
duplicates one already in the list. The driver uses the new value specified
in the CSV file to replace the previous value. Thus it is possible to
change the values for the driver’s default discrete state words. You can
safely ignore this message; it is for your information only.
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*
CarrierDP:9 FYI. Duplicate
state=<%s>. Value has
been updated from=%d
to=%d
CarrierDP:10 Err. No space.
Driver
rejects
value
state=<%s> value=%d
CarrierDP:11 FYI. User You can safely ignore this message; it is for your information only. Each
added value state=<%s> time a new discrete state word is added to the driver from the
value=%d
configuration file, the driver reports the new word and its value.
CarrierDP:12 Err. Length The driver reports that the read table command resulted in more
too short to store all. variables being returned than you have reserved space for (with the
MD=<%s>
length parameter). Increase the length parameter. *
* Correct the error by editing the configuration CSV file, downloading the corrected file to the FieldServer
and then resetting the FieldServer.
* Correct the error by editing the configuration CSV file, downloading the corrected file to the FieldServer
and then resetting the FieldServer.
FS-8700-86 Carrier DataPort
Page 28 of 32
Error Message
Explanation
CarrierDP:13
FYI.
Diagnostic send error #1
response.
These messages are for FieldServer engineers. If any either is ever
printed in the error log please call FieldServer support and report the
message.
CarrierDP:14
FYI.
Diagnostic cancelled slave
response
A server side Map Descriptor requires that the Engineering units are
defined. More information about this field is provided in section 0 and
Appendix A.1
CarrDP:#15 Err. Field Units
required. MapDesc=<%s>
This message may be safely ignored. It is provided for your information
only. It reminds you that you can use a secondary Data Array connected
to the server side Map Descriptor to store ‘status’ value which will be
returned when the server is polled. This is an alternate way of allowing
the driver to determine the ‘status’ values. More information on status
values is provided in Appendix A.1
CarrDP:#16
DA_Byte_Name for server
status values. MD=<%s>
FYI.
Use
This message may be safely ignored. It is provided for your information
only. It reminds you that you can use a secondary Data Array connected
to the Client side Map Descriptor to have the driver store ‘status’ value
when a poll response is obtained. If this secondary array is not defined
then the status values are ignored. More information on status values is
provided in Appendix A.1
CarrDP:#17
DA_Byte_Name for 'status'
value storage. MD=<%s>
FYI.
Use
This message may be safely ignored. It is provided for your information
only. It reminds you that you can use a secondary Data Array connected
to the Client side Map Descriptor to have the driver store ‘engineering
units’ values when a poll response is obtained. If this secondary array is
not defined then the ‘units’ values are ignored. More information on ‘units’
values is provided in Appendix A.1
CarrDP:#18
DA_Float_Name for 'units'
value storage. MD=<%s>
FYI.
Use
CarrDP:#19
'Table_Name'
Err.
no
has
meaning. MapDesc=<%s>
On the Client side the parameters ‘Table_Name’ and ‘Field_Name’ have
no meaning and must be removed from the Map Descriptor. *
CarrDP:#20
'Field_Name'
Err.
no
has
meaning. MapDesc=<%s>
CarrDP:#21 Err. 'On_String'
required. MapDesc=<%s>
CarrDP:#22
Err.
required.
On the server side, each Map Descriptor must have these parameters
defined. Read section 0 and review the example in section 1.1.1 for more
information. *
'Field_Name'
MapDesc=<%s>
CarrDP:#23
Err.
'Field_Desc'
required.
MapDesc=<%s>
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 discrete state reported.
Identification of the unrecognized discrete state word as well as
information on how to extend the list of recognized discrete state words is
provided in Appendix A.4.1. *
CarrDP:#24 Err. MD=<%s>
discrete state word not
recognized.
CarrDP:#25 Err. This driver The length of the response from each different Carrier device and for
* Correct the error by editing the configuration CSV file, downloading the corrected file to the FieldServer
and then resetting the FieldServer.
FS-8700-86 Carrier DataPort
Page 29 of 32
Error Message
Explanation
works
timeouts.
best with
long each table is different. The driver does not know the length of the
responses. The Carrier devices take some time between receiving a poll
and sending a response. The amount of time is proportional to the length
of the response (and hence, to the size of the table.) If the device takes
too long the driver may timeout as the default timeout is 2.0 seconds. It is
strongly recommended that you set the timeout to a large value (like 30
seconds) to start with. The effect of having a large timeout is to
1) allow the driver enough time to receive the response and
2) Increase the amount of time before the driver reports the timeout if
there is a genuine timeout event.
This message is printed when a response is received but the driver did
not find any information in the response that it could use to store. If the
problem occurs repeatedly then take a log and call tech Support after you
have tried the following diagnostic steps. 1) Check connection stats – If
bytes received per message is < 100 then it is likely that the device you
are polling is not responding properly or that a port setting is invalid.
Check the port settings.
CarrDP:#26 FYI. No data
was stored for MD=%s
CarrDP:#27 Err. Can’t open This message should only be printed in simulation mode (QA testing). If
slave.log
you see this message call Tech Support.
CarrDP:#28 FYI. Response
was sent from slave.log
(Hex file)
This message should only be printed in simulation mode (QA testing). If
you see this message call Tech Support.
This message could be produced when the characters which signal the
end of a response are missing and the next response is appended to the
1st in the input buffer. In such cases the buffer may overflow.
This message is printed once and then suppressed. However each time
the event occurs, the STREAMING stat is incremented by one.
CarrDP:#29 Err. The input If the stat is produced rarely then you could assume that that an
buffer has overflowed.
occasional corrupt/incomplete message has produced the error.
If it occurs all the time, then assume that the response is too large to fit in
the input buffer.
Most FST drivers have an input buffer of 3080 bytes This driver has a
buffer size of 16000 bytes. The buffer size is hard coded so you will need
to capture a log and send an error report to FST.
When parsing a response, the driver processes the response line by line.
A single response may consist of a number of lines. Each line is
terminated with a Carriage Return (CR). If a single CR is missing then
the driver sees two lines as a single line. In versions prior to 1.03eA the
driver used the line number as the offset, therefore values extracted from
subsequent lines were stored at the incorrect offset. Now the driver
ignores the corrupted line and advances the line counter by 2 continuing
CarrDP: #30
CarrDP:#31 Err. Line has the parsing and storing of extracted values. The values associated with
missing CR. Some data not the corrupted response line are not updated. This is reflected in the line
stored
count stored at offset zero. The driver detects lines with missing CR's by
checking the line length. If the driver senses that more than two or more
consecutive CR's are missing then the driver abandons the parse and
store and prints error #32. If different parts of the response have missing
CR's message #31 will be printed more than once per response. There
is no direct corrective action you can take. The errors arise from dropped
bytes in the response. If the error occurs frequently you will need to
check that the data transmission is not being adversely affected by noise.
CarrDP:#32
missing CR's. Abandon
store... MD=%s
Err.
Many
FS-8700-86 Carrier DataPort
Page 30 of 32
Error Message
Explanation
There DataPort device responded but the response reports an error. The
error number is printed in the message. The message also reports the
name of the node that was polled.
The following 6 errors are documented. For other errors contact the
Carrier Vendor.
#1 Invalid Command : The digit 1 returned as an error code means that
the last ASCII character sent to the DATAPORT by the off-network
device is not one that the DATAPORT recognizes as a command.
#2 No Display Table : The digit 2 returned as an error code means that
the off-network device has commanded the DATAPORT to transmit data
from a controller that is properly configured in the DATAPORT, but the
controller does not contain a point display table.
#3 CCN Bus Communication Error: The digit 3 returned as an error code
means that the DATAPORT cannot transmit data from the requested
controller because
DATAPORT was acquiring data from that controller.
a
communication error occurred while the
CarrDP:#33 Err. DataPort
responded with Err=%d.
Device=%s
#4 Database Full : The digit 4 returned as an error code means that the
off-network device has commanded the DATAPORT to transmit data
from a controller that is properly configured in the DATAPORT, but the
controller is beyond the 900 point limit. For example, if controllers 1
through 10 each contain 90 points, a command for the DATAPORT to
transmit data from controller 11, 12, 13, 14, or 15 will result in error code
4.
#5 DATAPORT Busy : The digit 5 returned as an error code means that
a static data update is in progress, preventing the DATAPORT from
responding successfully to a Send Controller Data Command or a Send
Data Periodically command.
#6 Controller Not Configured : The digit 6 returned as an error code
means that the off-network device has commanded the DATAPORT to
transmit data from a controller that is not configured in the DATAPORT.
For example, if only controllers 1 through 5 are configured in the
DATAPORT, a command of 0 (Send Controller Data for Controller 15)
will result in error code 6.
CarrDP:#99 Err. Cant open This message should only be printed in simulation mode (QA testing). If
INI file for response. you see this message call Tech Support.
FS-8700-86 Carrier DataPort
Page 31 of 32
Appendix D.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 error responses from the Carrier DataPort device are recorded as PROTOCOL ERRORS,
In addition to the standard FieldServer communication statistics described above and in the
FieldServer Instruction 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 "CarrierDP-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
,
Station,
Protocol
CarrDP_stats ,
1
,
CarrierDP
Data_Arrays
Data_Array_Name
DA_CARRIERDP_STATS ,
,
Data_Format,
UINT32
Data_Array_Length
2000
,
Map_Descriptors
Map_Descriptor_Name, Data_Array_Name
,
Data_Array_Offset, Function, Node_Name ,
Length,
CarrierDP-Stats DA_CARRIERDP_STATS,
,
0
,
passive ,
CarrDP_stats, 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.
FS-8700-86 Carrier DataPort
Page 32 of 32
Array Offset is based on Port Number
P1 P2 P3 P4 P5 P6 P7 P8
Description
0
1
2
3
50
51
52
53
100 150 200 250 300 350
101 151 201 251 301 351
102 152 202 252 302 352
103 153 203 253 303 353
Available for future use
Available for future use
Available for future use
Available for future use
4
5
54
55
104 154 204 254 304 354
105 155 205 255 305 355
Number of bytes sent by Client driver
Number of messages sent by Client
Number of response messages received by
Client
Available for future use
6
7
9
56
57
58
106 156 206 256 306 356
107 157 207 257 307 357
108 158 208 257 307 357
Most recent response error
Number of times Client receives an error
response
Error #1 Invalid Command
Error #2 No Display Table
8
10
11
59
60
61
109 159 210 260 310 360
110 160 210 260 310 360
111 161 211 261 311 361
12
13
14
15
16
17
18
19
20
21
22
23
24
62
63
64
65
66
67
68
69
70
71
72
73
74
112 162 212 262 312 362
113 163 213 263 313 363
114 164 214 264 314 364
115 165 215 265 315 365
116 166 216 266 316 366
117 167 217 267 317 367
118 168 218 268 318 368
119 169 219 269 319 369
120 170 220 270 320 370
121 171 221 271 321 371
122 172 222 272 322 372
123 173 223 273 323 373
124 174 224 274 324 374
Error #3 CCN Bus Communication Error
Error #4 Database Full
Error #5 DATAPORT Busy
Error #6 Device Not Configured
Error #7
Error #8
Error #9
Error #10
Error #11
Error #12
Error #13
Error #14
Some other error
25
26
27
75
76
77
125 175 225 275 325 375
126 176 226 276 326 376
127 177 227 277 327 377
Number of response bytes received by Client
Number of times Client has timeout out waiting
for (response)
Number of times Client prints a timeout SDO
message.
|