-
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-16 Bacnet PTP - Serial
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after September 2008
Driver Version:
Document Revision:
1.15
4
FS-8700-16 BACnet PTP Serial Driver Manual
Page 3 of 20
1.
BACnet Description
The BACnet PTP driver allows the FieldServer to transfer data to and from devices using the BACnet
protocol over a serial RS-232 physical layer. The FieldServer can emulate either a Server or Client.
The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer.
2.
Driver Scope of Supply
2.1. Supplied by FieldServer Technologies for this Driver
FieldServer Technologies
PART #
Description
FS-8917-02
FS-8917-03
FS-8700-16
RJ45 to DB9F Connector adapter
Connector adapter – DB9M to DCE, RTS/CTS, DSR/DTR
Driver Manual.
2.2.
Provided by supplier of 3rd party equipment
PART #
DESCRIPTION
Building control unit (BCU) 1
BACnet client such as a workstation2
1 If FieldServer used as BACnet Client.
2 If FieldServer used as BACnet Server
FS-8700-16 BACnet PTP Serial Driver Manual
Page 4 of 20
3.
Hardware Connections
It is possible to connect a BACnet device to any of the eight RS-2323 ports. These ports just need to be
configured for BACnet in the configuration file.
Configure the PLC (or BCU) according to manufacturer’s instructions
8917-03 WIRE LIST
FUNCTION FROM
TO
COLOUR
GREY
DB9M
RX
CTS
DSR
GND
GND
DTR
RTS
TX
RJ45-01 DB9M-02
RJ45-02 DB9M08 BROWN
RJ45-03 DB9M-06 YELLOW
RJ45-04 DB9M-05 GREEN
RJ45-05
RJ45-06 DB9M-04
RED
BLACK
RJ45-07 DB9M-07 ORANGE
RJ45-08 DB9M-03
BLUE
8917-02 WIRE LIST
DB9F
FUNCTION FROM
TO
COLOUR
WHITE
GREEN
BLUE
Rx
GND
Tx
RJ45-01 DB9F-03
RJ45-04 DB9F-05
RJ45-08 DB9F-02
RJ45 Connector
(408)-262-2299
FIELDSERVER
BACNET PTP
CONNECTION DIAGRAM
BASE NAME:
FILE NAME:
DATE: 7/30/06
BY: MC
Note that connection to a Trane BCU requires the 8917-02 option.
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-16 BACnet PTP Serial Driver Manual
Page 5 of 20
4.
Configuring the FieldServer as a BACnet Client
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 BACnet Server.
4.1.
Data Arrays/ Descriptors
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In
order to enable the FieldServer for BACnet 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.
Section Title
Data_Arrays
Column Title
Function
Legal Values
Up to 15 alphanumeric
characters
Data_Array_Name
Provide name for Data Array
Float, Bit, Uint16, Uint32,
Sint16, Sint32, Packed_Bit,
Byte, Packed_Byte,
Swapped_Byte
Data_Format
Provides data format
Data_Array_Length
Number of Data Objects
1-10,000
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Format,
Float,
Float,
Bit,
Bit,
Data_Array_Length
200
200
200
200
DA_DO_01,
4.2.
Setting the FieldServer Node_ID and Network Number
Section Title
FieldServer
Column Title
System_Node_ID
Network_Number
Function
Configure Node_ID of FieldServer
BACnet Network Number
Legal Values
1-255
1-65535, 5
FS-8700-16 BACnet PTP Serial Driver Manual
Page 6 of 20
Example
// FieldServer
FieldServer
Title,
BACnet_PTP,
System_Node_ID,
11,
Network_Number
2
4.3.
Client Side Connection Descriptions
Section Title
Connections
Column
Title
Function
Port Name
Legal Values
Port
P1-P84
110; 300; 600; 1200; 2400; 4800; 9600; 19200; 38400;
57600; 115000
Baud*
Specify baud rate
Parity*
Specify parity
Odd, Even, None
Data_Bits*
Stop_Bits*
Specify data bits
Specify stop bits
7, 8
1,2
Specify
Used
Protocol
Protocol
BACnet_PTP
Example
// Client Side Connections
Connections
Port,
P8,
Baud,
9600,
Parity,
Even,
Data_Bits,
7,
Stop_Bits,
1,
Protocol
BACnet_PTP
4.4.
Client Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Port
Function
Provide name for node
Node ID of physical server node (the BCU)
Specify protocol used
Legal Values
Up to 32 alphanumeric characters
1 - 4194303
BACnet_PTP
Specify port
P1-P85
Example
// Client Side Nodes
Nodes
Node_Name,
BCU_1,
Node_ID,
1,
Protocol,
BACnet_PTP,
Port
P8
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
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-16 BACnet PTP Serial Driver Manual
Page 7 of 20
4.5.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
4.5.1.
Column Title
Function
of this
Descriptor
Legal Values
to 32 alphanumeric
Name
Map Up
characters
Map_Descriptor_Name
Name of Data Array
where data is to be stored
in the FieldServer
One of the Data Array names
from “Data Array” section above
Data_Array_Name
Starting location in Data 0 to maximum specified in
Data_Array_Offset
Function
Array
“Data Array” section above
Function of Client Map
Descriptor
RDBC, WRBC, WRBX
4.5.2.
Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
Node_Name
Data_Type
Name of Node to fetch data from
AI, AO, AV, BI, BV, MI,
Data type in FieldServer
MO, MV6
Object_Instance
Property*
Address of object
The BACnet property to be read
0, 1, 2, 3, …
Present_Value
Data_Array_Low_Scale* Scaling zero in Data Array
Data_Array_High_Scale* Scaling max in Data Array
-32767 to 32767, 0
-32767 to 32767, 100
Node_Low_Scale*
Node_High_Scale*
Scaling zero in Connected Node
Scaling max in Connected Node
Number of objects that will be polled
-32767 to 32767, 0
-32767 to 32767, 100
Length*
using
the
READ_PROPERTY_ 2-29, 1
MULTIPLE service. See Appendix B.3
Allows the driver to specify the write
Write_Priority*
Custom_Type
Custom_Prop
priority used to write an output. See 1..16, 16
also Appendix B.2
This over-writes the Data_Type with a
numerical value for the Data_Type. 1..1023
e.g. Analog Value = 2
This over-writes the Property with a
numerical value for the property. e.g. 1..4194303
Present Value = 85
4.5.3.
Timing Parameters
Column Title
Scan_Interval*
Function
Seconds per scan
Legal Values
0-32000, 2
6 Refer to Appendix A.1 for further information.
FS-8700-16 BACnet PTP Serial Driver Manual
Page 9 of 20
5.
Configuring the FieldServer as a BACnet 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 BACnet Client.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to
enable the FieldServer for BACnet 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.
Driver Specific FieldServer Parameters
Section Title
Bridge
Column Title
Function
FieldServer name
Legal Values
Title
Text
Specify a unique network number
if there are multiple virtual Server
nodes.
1-65535
5
Network_number*
Example
// FieldServer Driver specific parameters
Bridge
Title,
Network_number
Bacnet Server,
6
FS-8700-16 BACnet PTP Serial Driver Manual
Page 10 of 20
5.2.
Server Side Connection Descriptions
Section Title
Connections
Column Title
Function
Legal Values
P1-P87
Port
Port name
110; 300; 600; 1200;
2400; 4800; 9600; 19200;
38400; 57600; 115000
Odd, Even, None
7, 8
Baud*
Parity*
Data_Bits*
Stop_Bits*
Protocol
Specify baud rate
Specify parity
Specify data bits
Specify stop bits
Specify Protocol Used
1,2
BACnet_PTP
Example
// Server Side Connections
Connections
Port,
P1,
Baud,
9600,
Parity,
Even,
Data_Bits,
7,
Stop_Bits,
1,
Protocol
BACnet_PTP
5.3.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name8 Provide name for node
Function
Legal Values
to 32 alphanumeric
characters
Up
BACnet station address of physical Server
node
Specify protocol used
Node_ID
Protocol
1 - 4194303
BACnet_PTP
Example
// Server Side Nodes
Nodes
Node_Name,
Virtual_BCU_11,
Node_ID,
11,
Protocol
BACnet_PTP
7
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
8 When using the Trane Tracer Summit Workstation System, this name will appear as the object name
FS-8700-16 BACnet PTP Serial Driver Manual
Page 11 of 20
5.4.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
5.4.1.
Column Title
Function
Legal Values
to 32 alphanumeric
Up
characters.
Map_Descriptor_Name
Name of this Map Descriptor
Name of Data Array where
data is to be stored in the
FieldServer
One of the Data Array names
from “Data Array” section
Data_Array_Name
0 to data_array_length-1 as
Data_Array_Offset
Function
Starting location in Data Array
specified
section
in
“Data_Array”
Function of Server Map
Descriptor
Server
5.4.2.
Driver Specific Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Server Node
Descriptor” above
Node_Name
Name of FieldServer Node
AI, AO, AV, BI, BV, MI, MO,
MV9
Data_Type
Data type in BCU
Object_Instance
Units
Data_Array_Low_Scale*
Data_Array_High_Scale*
Address of the object
The object units
Scaling zero in Data Array
Scaling max in Data Array
Scaling zero in Connected
Node
Scaling max in Connected
Node
Specify the Active Text
property of the Object
Specify the Inactive Text
property of the
0, 1, 2, 3, …
See Appendix D
-32767 to 32767, 0
-32767 to 32767, 100
Node_Low_Scale*
Node_High_Scale*
Active Text
-32767 to 32767, 0
-32767 to 32767, 100
Any legal BACnet ASCII string
Any legal BACnet ASCII string
Inactive Text
Specify
the
startup
Relinquish Default
Custom_Type
Relinquish_Default
value for this Object
Property Any legal BACnet ASCII string
This
over-writes the
Data_Type with a numerical
value for the Data_Type. e.g.
Analog Value = 2
1..1023
This over-writes the Property
with a numerical value for the
property. e.g. Present Value =
85
Custom_Prop
1..4194303
9 Refer to Appendix A.1 for further information.
FS-8700-16 BACnet PTP Serial Driver Manual
Appendix A. Driver Notes
Page 13 of 20
Appendix A.1.
Data_Type Legal Values – Abbreviation Descriptions
AI
ANALOG_INPUT
AO ANALOG_OUTPUT
AV ANALOG_VALUE
BI
BINARY_INPUT
BV BINARY_VALUE
MI MULTI_STATE_INPUT
MO MULTI_STATE_OUTPUT
MV MULTI_STATE_VALUE
FS-8700-16 BACnet PTP Serial Driver Manual
Appendix B. Advanced Topics
Page 14 of 20
Appendix B.1.
BACnet Object Names
When an external BACnet Client builds a list of Object Names, the BACnet Server Map Descriptor
name determines the BACnet Object Name. If the Map Descriptor length is greater than 1, then the
Object Name will be suffixed with the index into the Map Descriptor. For example, if the Map
Descriptor name is SMD_AI_01 and the length 3, then the Object Names will be SMD_AI_01[0],
SMD_AI_01[1] and SMD_AI_01[2].
Appendix B.2.
BACnet Priority Arrays
FieldServer implementation of BACnet priority Arrays
When BACnet Output objects are written to the Server side of the FieldServer, an associated write
priority is given to each write value. When the FieldServer receives the write value, it will be stored to
the Map Descriptor Priority Array Table at the specified priority. The Priority Array Table is then
scanned and the value with the highest priority is stored to the Data Array location specified by the
Map Descriptor.
When a Write “Relinquished” command is received, the value is removed from the Priority Array
Table and the next highest value from the Priority Array Table is stored to the Data Array.
If all values have been “Relinquished” from the Priority Array Table, then the Map Descriptors
“Relinquish Default” value will be stored to the Data Array.
Accessing Priority Array information
The Priority Array table and its “In_Use” (or Not Relinquished) state are stored internally to every Map
Descriptor, and cannot be accessed directly. If the following data arrays are specified, however, they
will maintain an exact copy of the Priority Array Table for the Map Descriptor. Thus the Priority Array
Table can be accessed.
Section Title
Map_Descriptors
Column Title
Function
Legal Values
Name of Data Array where the Priority Array Table will
be stored. Location 0 is the Relinquish Default value
and locations 1 to 16 the different entries of the
Priority Array Table.
Up
to
16
DA_Pri_Array
alphanumeric
characters
DA_Pri_Array_Offset
DA_Pri_In_Use
Starting location in Data Array.
Name of Data Array that indicates if a particular
1-65535 ,17
Priority Value is in use. Location 0 indicates whether Up
to
16
the Relinquish Default has been set and locations 1 to alphanumeric
16 indicate whether the index is in use (1), or characters
Relinquished (0).
DA_Pri_In_Use_Offset Starting location in Data Array.
1-65535, 17
Appendix B.3.
Limitations of the BACnet READ_PROPERTY_MULTIPLE service.
The BACnet PTP client driver can read multiple BACnet objects using the
READ_PROPERTY_MULTIPLE service under the following conditions:
•
•
•
•
The number of objects to be read must not exceed 29.
No gaps must exist in the range of object to be read.
The Map Descriptor function must be of the READ type. (e.g. RDBC)
The Map Descriptor property must be Present Value.
FS-8700-16 BACnet PTP Serial Driver Manual
Page 15 of 20
Appendix B.4.
Network number
The default Network number of a FieldServer is 5. In order to ensure communication between the
BACnet Client and all Servers on a BACnet network, however, it may be necessary to assign a
unique network number to each FieldServer.
A unique network number will need to be assigned if both of the following conditions are true:
•
•
The FieldServer has multiple BACnet Server nodes.
There is more than one FieldServer on a network which includes multiple BACnet nodes.
To override the FieldServer’s default network number 5, refer to Section 5.1
FS-8700-16 BACnet PTP Serial Driver Manual
Appendix C. Troubleshooting Tips
Page 17 of 20
Appendix C.1.
Debugging a BACnet connection – Hints and Tips
•
•
Disconnect the FieldServer from the BACnet network when transferring images to the BCU.
If duplicate object instances are accidentally configured in the FieldServer, the second call of
the instance will overwrite the first one. This may cause a BACnet Object to be “lost.”
If “Virtual_BCU_…” is not being indicated as the device description for the FieldServer on the
BACnet SCADA system, then the FieldServer is not communicating with the SCADA system.
If the present value’s name is being indicated, but the present value shows question marks,
then it is most likely that the Client side of the FieldServer is not communicating.
When new points are added to the FieldServer it is important to restart the Summit
Workstation or BCU, otherwise these new points may not be seen by the FieldServer.
Polling BACnet addresses that are not configured for Lieberts systems may cause the
connection to fail in older versions of Lieberts. Please contact your Lieberts supplier for
more information.
•
•
•
•
When a BACnet_PTP connection is established, and the connection is broken abruptly
(for instance a power down), the BCU might not know immediately that this happened. If
the FieldServer is the powered up again, it might take several seconds (up to 60
seconds) before polling will start again.
•
•
Extra memory is required to store Map Descriptors that have the active/inactive text
parameters specified. If the defaults are appropriate, do not specify these parameters.
This will save memory and allow more Map Descriptors to be created
McQuay Units are shipped with a default Device instance of the last 6 digits of the McQuay
Serial number.
Trane Specific Tips
•
•
When new points are added to the FieldServer it is important to restart Summit Workstation
or BCU, otherwise these new points may not be seen by the FieldServer.
Disconnect the FieldServer from the BACnet network when transferring images to the BCU
Appendix C.2.
BACnet Specific Statistics
Stat
Description
Resolution
It is normal to receive a few link control
A who-is link control message was messages. If the number is higher than
Link Control
send or received.
the transmit/receive messages, there may
be a problem with lost communications.
This is not an error. BACnet clients often
poll all properties of a particular object to
determine which properties are supported.
Unsupported
Properties
A request for an unsupported
property was received.
Data was requested but the
response would have exceeded the This is not an error - the BACnet client will
maximum size of the APDU and use a different method to read data from
could not be sent using an un- the FieldServer.
Segmentation
Not Supported
segmented message.
Invoke ID of a reply did not match You should not see this message. It
Sequence Error
the Invoke ID of the poll.
normally indicates a configuration error.
This typically happens when trying to write
to an Input Object that is not Out-Of-
Service. It is not possible to write to Input
Objects.
Write
Access
Writing to an object was denied.
Denied
This may be a problem on the Client
system. Consult the PIC statement to
determine what services are supported.
Exception
Errors
A
BACnet Service was denied
because it is not supported
FS-8700-16 BACnet PTP Serial Driver Manual
Appendix D. Units
Page 18 of 20
Unit
Variation 1
Variation 2
Variation 3
Amperes
Amps
A
Bars
BTUs
BTUs-per-hour
btus-per-pound
btus-per-pound-dry-air
centimeters
centimeters-of-mercury
centimeters-of-water
cubic-feet
cubic-feet-per-minute
cubic-feet-per-seconds
cubic-meters
cubic-meters-per-hour
cubic-meters-per-seconds
Currency1
Currency2
Currency3
Currency4
Currency5
Currency6
Currency7
Currency8
Currency9
Currency10
cycles-per-hour
cycles-per-minute
days
degrees-angular
Degrees-Celsius
degrees-celsius-per-hour
degrees-celsius-per-minute
Degrees-days-Celsius
Degrees-days-Fahrenheit
Degrees-Fahrenheit
degrees-fahrenheit-per-hour
degrees-fahrenheit-per-minute
Degrees-Kelvin
degrees-phase
delta-degrees-fahrenheit
delta-degrees-kelvin
feet
Deg-C
Deg_C
Deg-F
Deg-K
Deg_F
Deg_K
feet-per-minute
feet-per-second
foot-candles
grams-water-per-kg-dry-air
hectopascals
Hertz
Hz
Horsepower
HP
hours
FS-8700-16 BACnet PTP Serial Driver Manual
Page 19 of 20
Unit
Variation 1
Variation 2
Variation 3
imperial-gallons
imperial-gallons-per-min
inches
inches-of-mercury
inches-of-water
Joules
joules-per-degree-kelvin
joules-per-kilogram-degree-kelvin
joules-per-kilogram-dry-air
Kilograms
Kg
kilograms-per-hour
kilograms-per-minute
kilograms-per-second
Kilohertz
KHz
kilohms
Kilojoules
kilojoules-per-kilogram
kilometers-per-hour
Kilopascals
KPa
kilovolt-amperes
kilovolt-amperes-reactive
kilovolts
kilovolt-amps
KVAR
KVA
kilowatt-hour-per-square-foot
kilowatt-hour-per-square-meter
kilowatt-hours
kilowatts
KWh
KW
liters
liters-per-hour
liters-per-minute
liters-per-second
lumens
luxes
Megahertz
MHz
megajoules
megajoules-per-square-foot
megajoules-per-square-meter
megavolt-amperes
Megavolt-amperes-reactive
megavolts
megavolt-amps
MVAR
megawatts
MW
megohms
meters
meters-per-second
miles-per-hour
milliamperes
milliamps
millibars
millimeters
millimeters-of-mercury
Millivolts
Milliwatts
minutes
months
FS-8700-16 BACnet PTP Serial Driver Manual
Page 20 of 20
Unit
Variation 1
Variation 2
Variation 3
No-Units
No Units
No_Units
None
ohms
parts-per-billion
parts-per-million
Pascals
Percent
percent-obscuration-per-foot
percent-obscuration-per-meter
percent-per-second
percent-relative-humidity
Per-hour
per-minute
per-second
pounds-force-per-square-inch
Pounds-mass
% RH; %RH
PSI
Percent RH;
PercentRH
pounds-force-per-sq-inch
pounds-mass-per-hour
pounds-mass-per-minute
pounds-mass-per-second
Power-Factor
PF
psi-per-degrees-fahrenheit
radians
revolutions-per-minute
seconds
Secs
S
square-centimeters
square-feet
square-inches
square-meters
Therms
ton-hours
Tons
Tons-refrigeration
US-gallons
us-gallons-per-minute
Volt-Amperes
volt-amperes-reactive
Volts
watt-hours
Gallons
GPM
Volt-Amps
VAR
Voltage
Wh
VA
Watts
W
watts-per-square-foot
watts-per-square-meter
watts-per-square-meter-degrees-kelvin
weeks
years
|