SMC Networks FieldServer FS-8700-16 BACnet PTP Driver Manual
Driver Revision: 2.01
Document Revision: 1.B
FieldServer
FS-8700-16 BACnet PTP – Serial
Driver Manual
(Supplement to the FieldServer Instruction Manual)
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 2019.
BACnet PTP Serial Driver Manual
Contact Information
Technical Support
Please call us for any technical support needs related to the FieldServer product.
Sierra Monitor Corporation
1991 Tarob Court
Milpitas, CA 95035
Website: www.sierramonitor.com
U.S. Support Information:
+1 408 964-4443
+1 800 727-4377
Email: support@sierramonitor.com
EMEA Support Information:
+31 33 808 0590
Email: support.emea@sierramonitor.com
BACnet PTP Serial Driver Manual
Table of Contents
TABLE OF CONTENTS
1 BACnet PTP Description ..................................................................................................................... 5
2 Driver Scope of Supply ....................................................................................................................... 5
2.1 Supplied by Sierra Monitor Corporation ......................................................................................... 5
2.2 Provided by supplier of 3rd party equipment ................................................................................... 5
3 Hardware Connections ........................................................................................................................ 6
4 Data Array Parameters ........................................................................................................................ 7
5 Configuring the FieldServer as a BACnet Client .............................................................................. 8
5.1 Setting the FieldServer Node_ID .................................................................................................... 8
5.2 Client Side Connection Parameters ............................................................................................... 8
5.3 Client Side Node Parameters ......................................................................................................... 9
5.4 Map Descriptor Parameters ............................................................................................................ 9
5.4.1 Client Side Connection Parameters ...................................................................................... 10
5.4.2 Timing Parameters ................................................................................................................ 10
5.4.3 Map Descriptor Example ....................................................................................................... 11
6 Configuring the FieldServer as a BACnet Server ........................................................................... 12
6.1 Driver Specific FieldServer Parameters ....................................................................................... 12
6.2 Server Side Connection Parameters ............................................................................................ 12
6.3 Server Side Node Parameters ...................................................................................................... 13
6.4 Server Side Map Descriptor Parameters ...................................................................................... 13
6.4.1 FieldServer Specific Map Descriptor Parameters ................................................................. 13
6.4.2 Driver Specific Map Descriptor Parameters .......................................................................... 14
6.4.3 Map Descriptor Example ....................................................................................................... 15
Appendix A. Useful Features ................................................................................................................... 16
Appendix A.1. BACnet Object Names ..................................................................................................... 16
Appendix A.2. Network Number .............................................................................................................. 16
Appendix A.3. Accessing Data from BACnet Properties Comprising Arrays of Values .......................... 17
Appendix A.4. FieldServer Implementation of BACnet Priority Arrays .................................................... 17
Appendix A.4.1. Accessing Priority Array Information ......................................................................... 17
Appendix A.5. BACnet State Text Preload .............................................................................................. 18
Appendix A.5.1. Method 1 – Using an Offset/User Table .................................................................... 18
Appendix A.5.2. Method 2 – Using a Single Data Array ...................................................................... 18
Appendix A.5.3. Using Intrinsic Reporting for a Multistate Value ........................................................ 19
Appendix A.6. COV and Intrinsic Reporting ............................................................................................ 20
Appendix A.6.1. Notes on COV Configuration ..................................................................................... 20
Appendix A.6.2. Notes on Intrinsic Reporting Configuration: .............................................................. 20
Appendix A.7. Map Descriptor Examples ................................................................................................ 21
Appendix A.7.1. COV ........................................................................................................................... 21
Appendix A.7.2. Intrinsic Reporting ..................................................................................................... 21
Appendix A.7.3. Enable or Disable COV ............................................................................................. 21
Appendix A.8. Reliability_Option ............................................................................................................. 22
Appendix A.9. Specifying ReadPropertyMultiple and WritePropertyMultiple Transactions Using Linked
Map Descriptors ...................................................................................................................................... 23
Appendix B. Troubleshooting .................................................................................................................. 25
Appendix B.1. Debugging a BACnet Connection .................................................................................... 25
Appendix B.2. BACnet Error Response Decoding .................................................................................. 25
Appendix B.2.1. BACnet Error CLASS ................................................................................................ 25
Appendix B.2.2. BACnet Error CODES for Error Class OBJECT ....................................................... 26
BACnet PTP Serial Driver Manual
Table of Contents
Appendix C. Vendor Information ............................................................................................................. 27
Appendix C.1. McQuay............................................................................................................................ 27
Appendix C.2. Trane ................................................................................................................................ 27
Appendix C.3. Liebert .............................................................................................................................. 27
Appendix C.4. Automated Logic Corporation .......................................................................................... 27
Appendix C.5. Honeywell EBI ................................................................................................................. 27
Appendix D. Reference ............................................................................................................................. 28
Appendix D.1. Object_Type Legal Values – Abbreviation Descriptions ................................................. 28
Appendix D.2. Property Legal Values ..................................................................................................... 28
Appendix D.3. BACnet Vendor ID ........................................................................................................... 30
Appendix D.4. Units ................................................................................................................................. 30
Appendix D.5. BACnet Specific Statistics ............................................................................................... 34
BACnet PTP Serial Driver Manual
Page 5 of 34
1 BACNET PTP 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.
All information in a BACnet system is represented in terms of objects. The Object_Identifier is a 32-bit
code that identifies the type of Object (also identified by the Object_Type Property) and its "Instance"
number, which together uniquely identify the Object within its BACnet device. Theoretically, a BACnet
device could have over four million Objects of a particular type. The Object_Name is a text string, which
has a unique capability. BACnet devices may broadcast queries for devices that contain Objects with a
specific Object_Name. This can greatly simplify project setup.
BACnet requires one Device Object to be present in every BACnet device. The Device Object makes
information about the device and its capabilities available to other devices on the networks. Before one
BACnet device starts control-related communications with another, it needs to obtain some of the
information presented by the other device's Device Object. Unlike other Objects, the Device Object's
Instance number must be unique across the entire BACnet internetwork because it is used to uniquely
identify the BACnet devices. It may be used to conveniently identify the BACnet device from other
devices during installation.
Standard object types are used to hold real time data and other information. Each Object Type is
referenced by a number, for example 0 represents an Analog Input.
Each Object consists of a number of prescribed properties, the main property being the Present_Value.
Objects are monitored and controlled through their properties. The Analog Input Object is representative
of the Objects involved directly with control elements and many of its Properties reflect this.
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 Sierra Monitor Corporation
Part #
Description
FS-8917-03
Connector adapter – DB9M to DCE, RTS/CTS, DSR/DTR
2.2 Provided by supplier of 3rd party equipment
Part #
Description
BACnet Controller
BACnet PTP Serial Driver Manual
Page 6 of 34
3 HARDWARE CONNECTIONS
It is possible to connect a BACnet device to any of the eight RS-2321 ports. These ports just need to be
configured for BACnet in the configuration file.
Configure the device according to manufacturer’s instructions:
FUNCTION FROM TO COLOUR
RX RJ45-01 DB9M-02 GREY
CTS RJ45-02 DB9M08 BROWN
DSR RJ45-03 DB9M-06 YELLOW
GND RJ45-04 DB9M-05 GREEN
GND RJ45-05 RED
TX RJ45-08 DB9M-03 BLUE
RTS RJ45-07 DB9M-07 ORANGE
DTR RJ45-06 DB9M-04 BLACK
8917-03 WIRE LIST
8917-03
8917-03
FieldServer
FieldServer Part #
8917-16
Brown
Orange/White
8
TX
1
RX
4
COM
GND Tx Rx
Blue/White
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.
BACnet PTP Serial Driver Manual
Page 7 of 34
4 DATA ARRAY PARAMETERS
Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is
necessary to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant
data.
Section Title
Data_Arrays
Column Title
Function
Legal Values
Data_Array_Name
Provide name for Data Array.
Up to 15 alphanumeric
characters
Data_Array_Format
Provide data format. Each Data Array can only
take on one format.
Float, Bit, Byte, Uint16, Uint32,
Sint16, Sint32
Data_Array_Length
Number of Data Objects. Must be larger than
the data storage area required by the Map
Descriptors for the data being placed in this
array.
1-10000
Example
// Data Arrays
Data_Arrays
Data_Array_Name
, Data_Array_Format
, Data_Array_Length
DA_AI_01
, Float
, 200
DA_AO_01
, Float
, 200
DA_DI_01
, Bit
, 200
DA_DO_01
, Bit
, 200
BACnet PTP Serial Driver Manual
Page 8 of 34
5 CONFIGURING THE FIELDSERVER AS A BACNET CLIENT
For detailed information on FieldServer configuration, 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 PTP Server.
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: In the following tables, * indicates an optional parameter and bold legal values are default.
5.1 Setting the FieldServer Node_ID
Section Title
FieldServer
Column Title
Function
Legal Values
System_Node_ID
Configure Node_ID of FieldServer.
1-255
Example
// FieldServer
FieldServer
Title
, System_Node_ID
BACnet_PTP
, 11
5.2 Client Side Connection Parameters
Section Title
Connections
Column Title
Function
Legal Values
Port
Port Name.
P1-P22
Baud*
Specify baud rate.
110; 300; 600; 1200; 2400; 4800; 9600; 19200; 38400;
57600; 115000
Parity*
Specify parity.
Odd, Even, None
Data_Bits*
Specify data bits.
7, 8
Stop_Bits*
Specify stop bits.
1,2
Protocol
Specify Protocol Used.
BACnet_PTP
Example
// Client Side Connections
Connections
Port
, Baud
, Parity
, Data_Bits
, Stop_Bits
, Protocol
P2
, 9600
, Even
, 7
, 1
, BACnet_PTP
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.
BACnet PTP Serial Driver Manual
Page 9 of 34
5.3 Client Side Node Parameters
Section Title
Nodes
Column Title
Function
Legal Values
Node_Name
Provide name for Node.
Up to 32 alphanumeric characters
Node_ID
Specify the BACnet Device object instance.
1 - 16777215
Protocol
Specify protocol used.
BACnet_PTP
Port
Specify port.
P1-P2
Retries*
Number of timeouts before the Node goes offline.
0,1,2,3
Example
// Client Side Nodes
Nodes
Node_Name
, Node_ID
, Protocol
, Port
, Retries
DEV_1
, 1
, BACnet_PTP
, P1
, 2
5.4 Map Descriptor Parameters
Column Title
Function
Legal Values
Map_Descriptor_Name
Name of this Map Descriptor. This is used
for Object_Name Property. Refer to
Appendix A.1.
Up to 32 alphanumeric
characters
Data_Array_Name
Name of Data Array where data is to be
stored in the FieldServer.
One of the Data Array names
from Section 4
Data_Array_Offset
Starting location in Data Array.
0 to (Data_Array_Length-1) as
specified in Section 4
Function
Function of Client Map Descriptor.
Rdbc, Wrbc, Wrbx, Arcs
BACnet PTP Serial Driver Manual
Page 10 of 34
5.4.1 Client Side Connection Parameters
Column Title
Function
Legal Values
Node_Name
Name of Node to fetch data from.
One of the Node_Names
specified in Section 5.3
Object_Type
(Alias = Data_Type)
Type of object. Refer to Appendix D.1 for
more information.
AI, AO, AV, BI, BO, BV, MI,
MO, MV, NC
Object_Instance
(Alias = Address)
Instance of the object on the device.
0, 1, 2, 3, …4194303
Property
The BACnet property to be read.
Refer to Appendix D.2
Data_Array_Low_Scale*
Scaling zero in Data Array.
-32767 to 32767, 0
Data_Array_High_Scale*
Scaling max in Data Array.
-32767 to 32767, 100
Node_Low_Scale*
Scaling zero in Connected Node.
-32767 to 32767, 0
Node_High_Scale*
Scaling max in Connected Node.
-32767 to 32767, 100
Length*
Used to create an array of sequential
Object_Instances on an Object_Type.
1 to max point count of the
FieldServer, 1
Array_Index*
When referencing Multistate properties,
allows the user to specify the index of the
property to be read. If 1 is specified, the
first one will be read, if 2 is specified, the
second will be read, etc. If 0 is specified,
the driver will return the total number
(count) of array items linked to the
property. If the parameter is not specified,
a list of all items will be returned. Refer to
Appendix A.3.
0 to max number of array items
in the BACnet Property, -
Write_Priority*
Allows the driver to specify the write
priority used to write an output.
1..16, 16
Linked_Map_Descriptors*
This parameter allows the linking of Map
Descriptors to an active read or write Map
Descriptor in order to construct a
ReadPropertyMultiple or
WritePropertyMultiple transaction. Refer
to Appendix A.9.
The name of a previously
defined active Map Descriptor,
-
Length*
When the optional Length parameter is
set to a value N, the Map Descriptor will
include N consecutive instances of the
specified Object_Type. For example, if a
Map Descriptor specifies Object_Type,
Address 4 and Length 3, this means that
the AO instances 4, 5 and 6 will be
included in the read or write transaction.
The corresponding Data Array values are
in consecutive positions in the Data Array,
starting at the specified
Data_Array_Offset.
Any positive integer that falls
between the range of the
Data_Array_Offset and the
Data_Array_Length as
specified in Section 4, -
Refer also to Appendix A.9
5.4.2 Timing Parameters
Column Title
Function
Legal Values
Scan_Interval*
Rate at which data is polled
0-32000, 2s
BACnet PTP Serial Driver Manual
Page 11 of 34
5.4.3 Map Descriptor Example
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Data_Type
, Object_Instance
, Property
, Scan_Interval
CMD_AI_01
, DA_AI_01
, 0
, Rdbc
, DEV_1
, AI
, 1
, Present_Value
, 20.000s
CMD_AI_02
, DA_AI_01
, 1
, Rdbc
, DEV_1
, AI
, 2
, Present_Value
, 20.000s
CMD_AI_03
, DA_AI_01
, 2
, Rdbc
, DEV_1
, AI
, 3
, Present_Value
, 20.000s
CMD_AO_01
, DA_AO_01
, 0
, Rdbc
, DEV_1
, AO
, 1
, Present_Value
, 30.000s
CMD_AO_02
, DA_AO_01
, 1
, Rdbc
, DEV_1
, AO
, 2
, Present_Value
, 30.000s
CMD_AO_03
, DA_AO_01
, 2
, Rdbc
, DEV_1
, AO
, 3
, Present_Value
, 30.000s
Map_Descriptors
Map_Descriptor_Name
, Data_Array_Name
, Data_Array_Offset
, Function
, Node_Name
, Data_Type
, Object_Instance
, Property
, Scan_Interval
CMD_DI_01
, DA_DI_01
, 0
, Rdbc
, DEV_1
, BI
, 1
, Present_Value
, 15.000s
CMD_DI_02
, DA_DI_01
, 1
, Rdbc
, DEV_1
, BI
, 2
, Present_Value
, 15.000s
CMD_DI_03
, DA_DI_01
, 2
, Rdbc
, DEV_1
, BI
, 3
, Present_Value
, 15.000s
CMD_DO_01
, DA_DO_01
, 0
, Rdbc
, DEV_1
, BO
, 1
, Present_Value
, 30.000s
CMD_DO_02
, DA_DO_01
, 1
, Rdbc
, DEV_1
, BO
, 2
, Present_Value
, 30.000s
CMD_DO_03
, DA_DO_01
, 2
, Rdbc
, DEV_1
, BO
, 3
, Present_Value
, 30.000s
Loading...