A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8704-06 BACnet/IP
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after September 2008
Driver Version:
Document Revision:
1.16
0
FS-8704-06 BACnet IP Driver Manual
Page 3 of 24
1.
BACnet IP Description
The BACnet/IP driver allows the FieldServer to transfer data to and from devices over Ethernet using
BACnet/IP protocol. 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 #
FS-8915-10
Description
UTP cable (7 foot) for Ethernet connection1
2.2.
2.2.1.
Provided by the Supplier of 3rd Party Equipment
Hardware
Part #
Description
Ethernet 10/100 BaseT hub2
1
This cable is necessary for connection to the driver. It is shipped with the FieldServer and not
separately with the driver.
2 Not all FieldServer models support 100BaseT. Consult the appropriate instruction manual for details of
the Ethernet speed supported by specific hardware.
FS-8704-06 BACnet IP Driver Manual
Page 4 of 24
3.
Hardware Connections
It is possible to connect a BACnet/IP device using the N1 or the N23 network ports. These ports need to
be configured for BACnet/IP in the configuration file.
Configure the Controller according to manufacturer’s instructions
Controller
Ethernet Interface
SITE
FS-8915-10
ETHERNET
FS-8915-10
(408)-262-2299
FIELDSERVER
BACNET IP
CONNECTION DIAGRAM
BASE NAME:
FILE NAME:
DATE: 12/28/04
BY: MC
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-8704-06 BACnet IP Driver Manual
Page 5 of 24
4.
Configuring the FieldServer as a BACnet IP Client
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/IP 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/IP 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
Provide data format. Each Data Array
can only take on one format.
Data_Array_Format
Data_Array_Length
Number of Data Objects. Must be larger
than the data storage area required by the
Map Descriptors for data placed in this
array.
1-10,000
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Array_Format,
Data_Array_Length
Float,
Float,
Bit,
200
200
200
200
DA_DO_01,
Bit,
FS-8704-06 BACnet IP Driver Manual
Page 6 of 24
4.2.
Client Side Connection Descriptions
Section Title
Adapter
Column Title
Adapter
Function
Legal Values
N1, N24
Adapter Name
Protocol
Specify protocol used
BACnet_IP
Poll_Delay*
Time between internal polls
Specify the UDP port that will be used to
communicate with other BACnet Client devices.
0-32000s; 0.25s
Any legal IP port value
(1 - 65535); 47808
IP_Port*
Example
// Client Side Connections
Connections
Adapter,
N1,
Protocol,
Bacnet_IP,
Poll_Delay
0.500s
4.3.
Client Side Node Descriptors
Section Title
Nodes
Column Title
Function
Provide name for Node
Legal Values
Up to 32 alphanumeric
characters
Node_Name
Node_ID
BACnet station address of physical Server
node
1 - 4194303
Protocol
Adapter
Specify protocol used
Specify port Adapter used
BACnet_IP
N1, N24
Example
// Client Side Nodes
Nodes
Node_Name,
BCU_01,
Node_ID,
1,
Protocol,
Bacnet_IP,
Adapter
N1
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.
FS-8704-06 BACnet IP Driver Manual
Page 7 of 24
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Legal Values
Up to 32 alphanumeric
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 above
Data_Array_Name
Data_Array_Offset
Function
Starting location in Data Array
Function of Client Map
Descriptor
0 to (“Data_Array_Length” -1)
Rdbc, Wrbc, Wrbx, Ars
4.4.2.
Driver Related Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Legal Values
One of the Node_Names
specified in “Client Side Node
Descriptors” above
Node_Name
Data_Type
Name of remote Server Node.
AI, AO, AV, BI, BO, BV, MI,
Data type
MO, MV5
Object_ID
Property*
Address of the object
The BACnet property to be read
0, 1, 2, 3, …4194303
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
Allows the driver to specify the
write priority used to write an
output. See also Appendix B.2
This over-writes the Data_Type
with a numerical value for the
Data_Type. e.g. Analog Value =
2
-32767 to 32767, 0
-32767 to 32767, 100
Write_Priority*
Custom Type
Custom_Prop
1..16, 16
1..1023
This over-writes the Property with
a numerical value for the
1..4194303
property. e.g. Present Value = 85
4.4.3.
Timing Parameters
Section Title
Map Descriptors
Column Title
Scan_Interval*
Function
Rate at which data is polled
Legal Values
0-32000s, 2s
5 Refer to Appendix A.1 for further information.
FS-8704-06 BACnet IP Driver Manual
Page 9 of 24
5.
Configuring the FieldServer as a BACnet IP 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” files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to
communicate with a BACnet/IP Client.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to
enable the FieldServer for BACnet/IP 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
5.2.
Server Side Connection Descriptors
Section Title
Connections
Column Title
Adapter
Function
Legal Values
Adapter Name
N1, N26
Protocol
Specify protocol used
BACnet_IP
Specify if this Connection should act as a BBMD
Server on the network. Refer to Appendix B.5 for BBMD
Connection_Type*7
more information.
Specify the UDP port that will be used to
communicate with other BACnet Client devices.
Any legal IP port value
(1 - 65535); 47808
IP_Port*
Example
// Server Side Connections
Connections
Adapter,
N1,
Protocol,
Bacnet_IP,
Connection_Type
BBMD
6 Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
7 BBMD only runs on N1 on an X30.
FS-8704-06 BACnet IP Driver Manual
Page 10 of 24
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
BACnet station address of physical
Server node
Specify protocol used
Node_ID
Protocol
1 - 4194303
BACnet_IP
Example
// Server Side Nodes
Nodes
Node_Name,
Virtual_BCU_11,
8
Node_ID,
11,
Protocol
Bacnet_IP
5.4.
5.4.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Legal Values
Up to 32 alphanumeric
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 Arrays” section
above
Data_Array_Name
Data_Array_Offset
Function
Starting location in Data Array
Function of Server Map
Descriptor
0 to (“Data_Array_Length” -1)
Server
8 Note that adapter is not declared under Server Side Nodes.
FS-8704-06 BACnet IP Driver Manual
Page 11 of 24
5.4.2.
Driver Specific Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Legal Values
One of the Node Names
specified in “Server Side
Node Descriptors” above
AI, AO, AV, BI, BO, BV, MI,
MO, MV9
Node_Name
Name of Node to fetch data from
Data_Type
Data type in Controller
Object_ID
Property
Address of the object
0, 1, 2, 3, …4194303
Present_Value
The object property to read
Refer to Appendix D,
No-Units
Units*
The object units
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
-32767 to 32767, 0
Node_Low_Scale*
Node_High_Scale*
Active_Text10
Scaling zero in Connected Node
Scaling max in Connected Node
-32767 to 32767, 100
Specify the Active Text property of
the Object
Any legal BACnet Ascii
string
Specify the Inactive Text property of Any legal BACnet Ascii
Inactive_Text10
the Object
string
Specify the startup
Relinquish_Default Property value
for this Object
Relinquish_Default10
Any Float value
This over-writes the Data_Type with
a numerical value for the
Data_Type. e.g. Analog Value = 2
This over-writes the Property with a
numerical value for the property.
e.g. Present Value = 85
Custom_Type
Custom_Prop
1..1023
1..4194303
9 Refer to Appendix A.1 for further information.
10 See the BACnet DFS to determine if a particular object supports this property
FS-8704-06 BACnet IP Driver Manual
Appendix A. Driver Notes
Page 13 of 24
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-8704-06 BACnet IP Driver Manual
Appendix B. Advanced Topics
Page 14 of 24
Appendix B.1.
BACnet object names
When an external BACnet Client builds a list of Object Names, the BACnet Server Map Descriptor
names determine the BACnet Object Name. If the Map Descriptor length is greater than 1, 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 stores it 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
alphanumeric
characters
DA_Pri_Array
DA_Pri_Array_Offset*
DA_Pri_In_Use
Starting location in Data Array.
1-65535 ,0
Name of Data Array that indicates if a particular
Priority Value is in use. Location 0 indicates whether
the Relinquish Default has been set and locations 1
to 16 indicate whether the index is in use (1), or
Relinquished (0).
Up to 16
alphanumeric
characters
DA_Pri_In_Use_Offset* Starting location in Data Array.
1-65535, 0
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)
FS-8704-06 BACnet IP Driver Manual
Page 15 of 24
•
The Map Descriptor property must be Present_Value.
Appendix B.4.
IP Address Issues related to BACnet IP
It is not necessary to configure the IP address of the Server node in the Client Side Node Descriptor
in the configuration file since the BACnet Client will automatically discover the IP address based on
the Node_ID supplied. It is still necessary for the FieldServer itself to have a valid IP address,
however. Please refer to the FieldServer Utilities Manual for instructions on changing the FieldServer
IP address.
Appendix B.5.
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
Appendix B.6.
Using BBMD
BACnet/IP requires that a BBMD be defined on every subnet for cross-router communications. The
FieldServer can act as a BBMD for the subnet that it resides on. Setting the Connection_Type to
BBMD will enable this functionality on the FieldServer. Note that BBMD operation is not required if
there is already another BBMD on the network.
Setting up a Broadcast Distribution Table (BDT)
The FieldServer supports two methods of updating its internal broadcast distribution table.
•
Trane’s Tracer Summit IP Validation utility can be used directly to upload and download a
Broadcast Distribution Table.
•
The Broadcast Distribution Table can be configured using the bdt.ini file. The following file must
be created and downloaded to the FieldServer using the Ruinet “Download Configuration”
command.
//
BBMD IP_Address,
24.90.48.179,
64.80.115.156,
BBMD port,
47808,
47808,
BBMD subnet Mask
255.255.255.255
255.255.255.255
FS-8704-06 BACnet IP Driver Manual
BBMD Configuration Example
Page 16 of 24
Using the following configuration, a PC using BACnet explorer is able to browse and display the
contents of two FieldServers. The following image shows the BACnet explorer screen.
The following diagram shows the layout of the connections between the FieldServers and the PC via
a router.
FS-8704-06 BACnet IP Driver Manual
Page 17 of 24
BBMD Block Diagram
FS1
192.168.0.49 IP
255.255.255.0 Mask
192.168.0.50 GW
Node=11275
Router
192.168.0.50 IP
255.255.255.0 Mask
0.0.0.0
GW
255.255.255.0 Mask
192.68.1.1
IP
PC
192.168.1.111 IP
255.255.255.0 Mask
192.168.1.1
GW
FS2
192.168.1.84 IP
255.255.255.0 Mask
192.168.1.1
GW
Node=11276
bdt.ini
BBMD IP_Address,
192.168.1.84,
192.168.0.49,
BBMD port,
47808,
47808,
BBMD subnet Mask
255.255.255.255
255.255.255.255
Configuration of the FieldServers is shown in the following examples.
FS-8704-06 BACnet IP Driver Manual
Appendix C. Troubleshooting Tips
Page 21 of 24
Appendix C.1.
Debugging a BACnet connection
•
•
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.
•
•
Polling BACnet addresses that are not configured for Liebert systems may cause the connection
to fail in older versions of Liebert. Please contact your Liebert supplier for more information.
Some of the BACnet IP features result in the creation of files (priarray.ini; desc.ini; alarms.ini) on
the FieldServer. Sometimes updates of firmware can result in these files becoming outdated.
Deleting these files will restore configuration defaults and may assist with configuration errors.
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
messages. If the number is higher than the
transmit/receive messages, however, there
may be a problem with lost
A “who-is” link control message
was send or received.
Link Control
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
Segmentation
Not Supported
maximum size of the APDU and
could not be sent using an un-
segmented message.
use a different method to read data from
the FieldServer.
Invoke ID of a reply did not match
the Invoke ID of the poll.
You should not see this message. It
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.
Sequence Error
Write Access
Denied
A write to an object was 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-8704-06 BACnet IP Driver Manual
Appendix D. Units
Page 22 of 24
Variation 3
Unit
Variation 1
Variation 2
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-8704-06 BACnet IP Driver Manual
Page 23 of 24
Variation 3
Unit
Variation 1
Variation 2
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-8704-06 BACnet IP Driver Manual
Page 24 of 24
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
|