Technical Document: Niagara Bacnet Guide
Technical Document: Niagara Bacnet Guide
Copyright Notice
The software described herein is furnished under a license agreement and may be used only in accordance with the terms of the agreement.
This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form without prior written
consent from Tridium, Inc.
The confidential information contained in this document is provided solely for use by Tridium employees, licensees, and system owners; and is not to be released to, or reproduced for,
anyone else; neither is it to be used for reproduction of this Control System or any of its components.
All rights to revise designs described herein are reserved. While every effort has been made to assure the accuracy of this document, Tridium shall not be held responsible for damages,
including consequential damages, arising from the application of the information contained herein. Information and specifications published here are current as of the date of this
publication and are subject to change without notice.
The release and technology contained herein may be protected by one or more U.S. patents, foreign patents, or pending applications.
Trademark Notices
BACnet and ASHRAE are registered trademarks of American Society of Heating, Refrigerating and Air-Conditioning Engineers. Microsoft and Windows are registered trademarks, and
Windows NT, Windows 2000, Windows XP Professional, and Internet Explorer are trademarks of Microsoft Corporation. Java and other Java-based names are trademarks of Sun Micro-
systems Inc. and refer to Sun's family of Java-branded technologies. Mozilla and Firefox are trademarks of the Mozilla Foundation. Echelon, LON, LonMark, LonTalk, and LonWorks are
registered trademarks of Echelon Corporation. Tridium, JACE, Niagara Framework, NiagaraAX and Vykon are registered trademarks, and Workbench, WorkPlaceAX, and AXSupervisor, are
trademarks of Tridium Inc. All other product names and services mentioned in this publication that is known to be trademarks, registered trademarks, or service marks are the property
of their respective owners.The software described herein is furnished under a license agreement and may be used only in accordance with the terms of the agreement.
CONTENTS
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Bacnet FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
BACnet terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Document Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
NiagaraAX-3.x
i
BACnet Guide
Contents
February 26, 2008
NiagaraAX-3.x
ii
BACnet Guide
Contents
February 26, 2008
NiagaraAX-3.x
iii
BACnet Guide
Contents
February 26, 2008
bacnet-BacnetAnalogValuePrioritizedDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryInputDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryOutputDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryValueDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBinaryValuePrioritizedDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBooleanCovTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–73
bacnet-BacnetBooleanIntervalTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetBooleanProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetBooleanScheduleDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetCalendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetCalendarDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetClientLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetConfigDeviceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetConfigFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetDeviceFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetDeviceObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–74
bacnet-BacnetEnumCovTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetEnumIntervalTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetEnumProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetEnumScheduleDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetEthernetLinkLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetEventHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetExportFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetExportTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetFileDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetHistoryDeviceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–75
bacnet-BacnetHistoryImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetIpLinkLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetListOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetLoopDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-MstpLinkLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetMultiPoll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetMultistateInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetMultiStateInputDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetMultistateOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetMultiStateOutputDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–76
bacnet-BacnetMultistateValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetMultiStateValueDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetMultiStateValuePrioritizedDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNetwork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNetworkLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNiagaraHistoryDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNotificationClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNotificationClassDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNumericCovTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNumericIntervalTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–77
bacnet-BacnetNumericScheduleDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetPoll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetPointDeviceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetPointFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetRouterTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetScheduleDeviceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetScheduleExport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–78
bacnet-BacnetScheduleImportExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetServerLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetStack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetStringCovTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetStringIntervalTrendLogExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetStringProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetStringScheduleDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
NiagaraAX-3.x
iv
BACnet Guide
Contents
February 26, 2008
bacnet-BacnetTransportLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetTrendLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetTrendLogDescriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–79
bacnet-BacnetTrendLogAlarmSourceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–80
bacnet-BacnetTuningPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–80
bacnet-BacnetTuningPolicyMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–80
bacnet-BacnetVirtualComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–80
bacnet-BacnetVirtualGateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–80
bacnet-BacnetVirtualObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–80
bacnet-BacnetVirtualProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
bacnet-BacnetWorker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
bacnet-BroadcastDistributionTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
bacnet-ForeignDeviceTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
bacnet-LocalBacnetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
bacnet-NetworkPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
Components in bacnetws module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–81
bacnetws-BacnetWsClientLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–82
bacnetws-BacnetWsDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–82
bacnetws-BacnetWsNetwork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–82
bacnetws-BacnetWsStack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–82
bacnetws-LocalBacnetWsDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–82
NiagaraAX-3.x
i-v
BACnet Guide
Contents
February 26, 2008
NiagaraAX-3.x
i-vi
BACnet Guide
PREFACE
Preface
• Bacnet FAQs
• BACnet terms
• Document Change Log
Bacnet FAQs
The following are frequently asked questions (FAQs) about the NiagaraAX Bacnet driver:
Q: Why are there two spelling variations used: BACnet and Bacnet?
A: The term Bacnet (vs. BACnet) is used throughout this document when referring to NiagaraAX compo-
nents and the Bacnet driver itself. This reflects the actual Niagara component and view names, such as
BacnetNetwork, BacnetDevice, Bacnet Device Manager, and so on. If the term BACnet is used, this refers
to BACnet in a context wider than the Niagara Framework, that is the protocol defined by ASHRAE
Standard 135.
Q: Why is it when I add proxy points for a device, that some proxy points are disabled by default?
A: By default, when you add a writable proxy point for a “commandable” type BACnet object (any object
with a priority_array property), the proxy point’s “Enabled” property is “false.” This is simply a “safety
technique,” to help prevent unintended BACnet writes from Niagara.
Keep in mind if you add a writable proxy point for the “present_value” property of such a (commandable)
BACnet object, that once enabled, that point’s 16 priority levels map directly to the BACnet priority levels
for that object. For example, if you invoke an “Emergency Override” action on the proxy point, it is
written to the BACnet object at priority level 1 (the highest). Or, if you link the “In4” slot of the writable
proxy to a Logic object, then slot 4 of the “priority_array”of the remote BACnet object will be controlled
by Niagara (by the output of the Logic object).
For these type point(s) to work at all—including reading the value from the device, or writing the value
to it from Niagara, you must manually set Enabled to “true.” You can do this either in the initial Add
dialog for these point(s), or in subsequent Edit dialogs (double-click on a point in Bacnet Point
Manager).
Also, note that if there is a BACnet object that you want to limit Niagara writes to one particular priority
level, instead of adding a writable proxy point for “present_value”, you could instead add one for a
particular “index” (level) under the object’s “priority_array” property.
Q: How do I make an object in the station appear as a BACnet object?
A: You “expose” objects in a station to BACnet, including chosen components, histories, and files, from one
central location: the Export Table under the Local Device in the BacnetNetwork. For more details,
see “Bacnet server configuration overview” on page 4-47.
Q: Why do some proxy points display differently after upgrading my system to AX-3.2?
A: By default, proxy points no longer poll “additional” BACnet properties of a target object like
“Status_Flags” and “Priority_Array”—however, you can configure proxy points for these (and other)
additional polled properties. For more details, see “About Bacnet Polling Changes (AX-3.2, AX-3.1)” on
page 3-15, and “Facets usage to poll additional properties” on page 3-29.
Q: Are there advantages to using “Bacnet virtual points” instead of proxy points?
A: For JACE platforms that have limited storage (Flash) capacity for their hosted station, use of Bacnet
virtual points (starting in AX-3.2) can offer advantages over proxy points, at least for simple Px view
monitoring. For more details, see “About Bacnet virtual points” on page 3-40.
NiagaraAX-3.x
vii
BACnet Guide
BACnet terms Preface
February 26, 2008
BACnet terms
The following list of terms and abbreviations is specific to BACnet usage in NiagaraAX, and covers
entries used in this document. For the definitive BACnet glossary of terms, refer to the ASHRAE publi-
cation: Standard 135-2004 – BACnet® – A Data Communication Protocol for Building Automation and
Control Networks. For general NiagaraAX terms, see the Glossary in the User Guide.
APDU Application (layer) protocol data unit. A unit of data specified within any of the BACnet link-
layer protocols, consisting of protocol control information and possibly application user data.
BACnet Building Automation and Control NETworking protocol (ANSI/ASHRAE Standard 135-
2004). An open communication protocol standard conceived by a consortium of manufacturers and sys-
tem users under the auspices of ASHRAE. Data is modeled as a common set of “objects” using a standard
set of “services.” See “Bacnet FAQs” about the spelling variation “Bacnet.”
BACnet client Operation mode for a BACnet system or device, where it makes use of a BACnet device
for some particular purpose via a service request instance.
BACnet server Operation mode for a BACnet system or device, where it provides a service to a re-
questing client.
BACnet/Ethernet Or B/ETH. BACnet over Ethernet, one of the original BACnet link-layer types.
Since the introduction of BACnet/IP, its usage has become less common.
BACnet/IP Or B/IP. BACnet over Ethernet IP. Introduced in “Annex J” of the BACnet standard, it has
become the most popular BACnet link-layer protocol (except in lowest-cost devices, where MS/TP is
used).
BACnet MS/TP Or MSTP. BACnet link-layer protocol used by lower-cost devices, using master slave
/ token passing over RS-485 multidrop networks. QNX-based JACEs support direct MS/TP (network)
trunks, one per RS-485 port (if licensed for MS/TP). See “Bacnet MS/TP licensing” on page 1-2.
BBMD BACnet/IP Broadcast Management Device. A device that receives and redistributes broadcast-
type BACnet messages (Who-Is, I-Am, etc.) to other B/IP devices on its own subnet, and sends broadcast-
type messages to BBMDs on other subnets. By having one BBMD on each subnet, a B/IP network can
span subnets (between IP routers, which otherwise typically block broadcast type messages). A Niagara
station supports operation as a BBMD.
Config object NiagaraAX can model BACnet objects in a client BACnet device as “Config” objects,
where you can see all properties of the object together. For details, see “About Bacnet Config objects” on
page 3-23.
COV Change-of-Value. BACnet provides services for COV reporting, on both the client and server
sides. NiagaraAX supports COV reporting services on both sides.
Device object Or device component. In general NiagaraAX terms, any component representing an ex-
ternal device. Specific to a BacnetNetwork, each BacnetDevice is a container that represents a particular
BACnet device. It has several device extensions, one being the Config Device Ext. By default, this Config
extension contains a (frozen) Device Object component, which represents the single BACnet Device Ob-
ject in that device. This component cannot be deleted, but other Config objects can be added if needed.
On the BACnet server side, a station’s Device Object is represented by the configuration of its single Local
Device component under its BacnetNetwork. See “Local Device notes” on page 4-62.
foreign device A BACnet/IP term for a BACnet device that exists on an IP subnet without a BBMD,
where the device can “register” with a BBMD on another (remote) subnet as a “foreign device” to explic-
itly receive BACnet broadcast messages. In no way does it imply any reduced functionality.
internetwork Two or more BACnet networks connected by a BACnet router. The single BacnetNet-
work in a station often represents an internetwork, for example if any external BACnet routers exist, or
if the BacnetNetwork has multiple ports under its BacnetComm, Network component. If the latter, the
station can act as a BACnet router between its local networks.
MS/TP Master Slave / Token Passing. See BACnet MS/TP.
object identifier Or object ID. A BACnet method to identify a particular object within a device, using
a combination of its object type and an instance number (unique for that type, within that device). In the
case of the single Device Object (type) per BACnet device, it must have a unique instance number across
the BACnet internetwork on which it is installed.
NiagaraAX-3.x
viii
BACnet Guide
Preface Document Change Log
February 26, 2008
NiagaraAX-3.x
ix
BACnet Guide
Document Change Log Preface
February 26, 2008
NiagaraAX-3.x
x
BACnet Guide
CHAPTER 1
Bacnet Driver Installation
To use the NiagaraAX Bacnet driver, you must have a target JACE host that is licensed for the feature
“bacnet,” or a PC host acting as a BACnet Supervisor (meaning it is also licensed for bacnet). See the
next section “Bacnet licensing considerations” for further details.
Note: Link layer types BACnet/IP and BACnet/Ethernet are supported by any NiagaraAX platform. However,
please note that BACnet MS/TP trunks are directly supported by QNX-based JACEs only, for example a
JACE-403 or JACE-2. Separate Bacnet MS/TP licensing is also required. Other platforms can indirectly
support MS/TP devices through BACnet routers.
The following sections provide details about Bacnet driver licensing and software installation:
• Bacnet licensing considerations
• Bacnet software installation
NiagaraAX-3.x
1–1
BACnet Guide
Bacnet software installation Chapter 1 – Bacnet Driver Installation
Bacnet MS/TP licensing February 26, 2008
Where port.limit defines the number of MS/TP trunks (JACE RS-485 ports) that can be used. This
ranges from 1 to 4, varying on the type of the host JACE controller, and the license purchased.
The “EIA-485 (or RS-485) load factor” of connected MS/TP devices determines how many devices are
physically supported, per trunk, due to electrical considerations. This ranges from 31 (“full load”) to up
to 127 (“quarter load”) devices. Note that any other device limits in the license’s bacnet feature, or
platform limits (e.g. JACE-403, 27 total devices) also apply.
NiagaraAX-3.x
1-2
BACnet Guide
CHAPTER 2
Bacnet Quick Start
This section provides a collection of procedures to use the NiagaraAX Bacnet driver’s client functions—
the most typical usage of the NiagaraAX Bacnet driver. Like other NiagaraAX drivers, you can do most
configuration from special “manager” views and property sheets using Workbench. These are the main
subsections:
• Configure the BacnetNetwork
• Create BacnetDevices
• Create Bacnet proxy points
Add a BacnetNetwork
To add a BacnetNetwork in the station
Use the following procedure to add a BacnetNetwork under the station’s Drivers container.
To add a BacnetNetwork in the station:
Step 1 Double-click the station’s Drivers container, to bring up the Driver Manager.
Step 2 Click the New button to bring up the New DeviceNetwork dialog. For more details, see “Driver Manager
New and Edit” in the Drivers Guide.
Step 3 Select “BacnetNetwork,” number to add: 1, and click OK.
This brings up a dialog to name the network.
Step 4 Click OK to add the BacnetNetwork to the station.
You should have a BacnetNetwork named “BacnetNetwork” (or whatever you named it), under your
Drivers folder.
NiagaraAX-3.x
2–3
BACnet Guide
Configure the BacnetNetwork Chapter 2 – Bacnet Quick Start
Configure the Network ports February 26, 2008
Above the Object Id, the Status should change from {fault} to {ok}, and the Fault Cause
should change from “Invalid Object ID” to blank.
Step 5 In the property sheet, click to collapse the Local Device.
See the next section: “Configure the Network ports”.
NiagaraAX-3.x
2-4
BACnet Guide
Chapter 2 – Bacnet Quick Start Create BacnetDevices
February 26, 2008 Configure the Network ports
Create BacnetDevices
After configuring the BacnetNetwork network port(s), you can use online discovery to find and create
BacnetDevice components under the BacnetNetwork. Or, you can add BacnetDevice components to the
station manually. You use the BacnetNetwork’s default Bacnet Device Manager view.
This section provides quick start procedures for both tasks, as follows:
• Using online Discover to add BacnetDevices
• Manually adding BacnetDevice components
Note: For general information, see the “About the Device Manager” section in the Drivers Guide.
NiagaraAX-3.x
2-5
BACnet Guide
Create BacnetDevices Chapter 2 – Bacnet Quick Start
Using online Discover to add BacnetDevices February 26, 2008
NiagaraAX-3.x
2-6
BACnet Guide
Chapter 2 – Bacnet Quick Start Create BacnetDevices
February 26, 2008 Manually adding BacnetDevice components
NiagaraAX-3.x
2-7
BACnet Guide
Create Bacnet proxy points Chapter 2 – Bacnet Quick Start
Using online Discover to add Bacnet proxy points February 26, 2008
NiagaraAX-3.x
2-8
BACnet Guide
Chapter 2 – Bacnet Quick Start Create Bacnet proxy points
February 26, 2008 Manually adding Bacnet proxy points
Note: Unlike other entries in the Add dialog, you cannot edit Type later.
• Enabled is whether the proxy point is enabled for polling, writing, etc.
Note: By default, any writable Type point (BooleanWritable, NumericWritable, etc) for a
“commandable” type object (any with a priority_array property, such as a Binary_Output,
Analog_Output, etc), will have Enabled initially set to false. To allow for point operation, you must
set this property to true. See “Bacnet FAQs” on page ii-vii for more details.
• Object ID, Property ID, and Index are how the point references its value in the remote BACnet de-
vice.
• Tuning Policy Name specifies the Bacnet tuning policy to use for the proxy point.
• Data Type specifies the ASN data type of the property in the BACnet object. Values are automat-
ically converted to the appropriate Niagara type for the point. For example, Analog Input
Present_Value is an ASN REAL, but can be interpreted by a StringPoint as a character string.
• Read and Write display the read and write status of the point.
• Device Facets represent the facets learned from the device.
• Facets represent the parent Niagara proxy point’s facets, for how the value should be displayed in
Niagara.
Step 4 When you have a Bacnet proxy point(s) configured properly for your usage, click OK.
The proxy points ares added to the station, and appear listed in the Database pane.
For more details, see “Bacnet Point Manager “Database” notes” on page 3-25.
NiagaraAX-3.x
2-9
BACnet Guide
Create Bacnet proxy points Chapter 2 – Bacnet Quick Start
Manually adding Bacnet proxy points February 26, 2008
NiagaraAX-3.x
2-10
BACnet Guide
CHAPTER 3
Niagara Bacnet Client Concepts
This section describes the “client side” operation of the NiagaraAX Bacnet driver, the most commonly
used NiagaraAX implementation with BACnet. These are the main subsections:
• About Bacnet Network Architecture
• About Bacnet Comm
• Bacnet Local Device
• About Bacnet Tuning Policies
• Bacnet Device Manager
• Bacnet Device components
• Bacnet Point Manager
• Bacnet proxy points
• About Bacnet Device’s Schedules
• About Bacnet Trend Logs (Histories)
NiagaraAX-3.x
3–11
BACnet Guide
About Bacnet Comm Chapter 3 – Niagara Bacnet Client Concepts
About Bacnet Comm: Network February 26, 2008
Even without showing the many other components under the Config and Server folders, this demon-
strates that Bacnet is one of the more comprehensive NiagaraAX field bus drivers. However (like most
NiagaraAX drivers), you seldom need to work from the palette. Instead, the various Bacnet manager
views simplify component creation, enforcing proper component hierarchy.
The few scenarios where you may need to work from the bacnet palette including the following:
• When adding another network port, found under folder NetworkPorts.
• When adding a specialized history extension (BacnetLogExtension) to any point in the station, in or-
der to make its Niagara history exportable as a BACnet-compliant Trend Log object. See “About
BacnetTrendLogExt extensions” on page 4-58 for more details.
• When adding a BacnetDestination to the station’s AlarmService, found under folder Alarming.
NiagaraAX-3.x
3-12
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Comm
February 26, 2008 About Bacnet Comm: Network: Router Table
Note: Whatever port type (default IP included), all ports require a unique Network Number across the entire
BACnet internetwork. The default Network Number value is -1 (inoperative). Ensure that each network
port has a unique, positive Network Number for proper operation. The valid Network Number range is
from 1 to 65534.
Existing BACnet network(s) note:
• If adding a station on an existing BACnet internetwork, specify the established BACnet/IP network
number and/or BACnet/Ethernet network number currently in use.
• If a JACE with one or more enabled MS/TP ports, specify a previously unused network number for
each MstpPort (RS-485) port.
NiagaraAX-3.x
3-13
BACnet Guide
About Bacnet Comm Chapter 3 – Niagara Bacnet Client Concepts
About Bacnet Comm: Network: Ethernet Port February 26, 2008
As with other Bacnet network ports, the Ip Port provides its own, independent Poll Scheduler (Poll
Service). See “About poll components” in the Drivers Guide for more details. Also see “About Bacnet
Polling Changes (AX-3.2, AX-3.1)” on page 3-15.
Link property IP Device Type allows for B/IP operation as a BBMD (BACnet Broadcast Management
Device) or BACnet Foreign Device, or a standard BACnet device (the default). Remaining properties
support further configuration as a BBMD or Foreign Device.
Figure 3-6 Property sheet view of Ethernet Port, Link container expanded
As with other Bacnet network ports, the Ethernet Port has its own, independent Poll Scheduler (Poll
Service). See “About poll components” in the Drivers Guide for more details. Also see “About Bacnet
Polling Changes (AX-3.2, AX-3.1)” on page 3-15.
NiagaraAX-3.x
3-14
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Comm
February 26, 2008 About Bacnet Comm: Client, Server, and Transport
Figure 3-7 Property sheet view of Mstp Port, Link container expanded
You must configure Link properties to specify the JACE serial port used, as well as other serial commu-
nications parameters. In addition, other MS/TP master parameters may require configuration.
Up to 4 Mstp Ports are supported, depending on host JACE platform, as well as licensing considerations.
As with other Bacnet network ports, each Mstp Port has its own, independent Poll Scheduler (Poll
Service). See “About poll components” in the Drivers Guide for more details. Also see “About Bacnet
Polling Changes (AX-3.2, AX-3.1)” on page 3-15.
NiagaraAX-3.x
3-15
BACnet Guide
About Bacnet Comm Chapter 3 – Niagara Bacnet Client Concepts
About Bacnet Polling Changes (AX-3.2, AX-3.1) February 26, 2008
Figure 3-8 Separate Poll Service for each port under BacnetComm, Network
Regardless of NiagaraAX release level, you can adjust the basic poll settings used for each port in its own
poll scheduler, as well as see individual statistics. The basic operation of each Poll Service, including the
four “buckets” (3 rate group + “dibs” stack) is explained in the Drivers Guide, in the section “About poll
components”. Note that a “multi-thread” capability exists in all Bacnet Poll Services, as this is sometimes
needed even in a (typically speedy) IpPort or EthernetPort link layer, where point polling might involve a
BACnet router (say, going between B/IP and slower MS/TP devices).
Also unique to Bacnet polling (in any release) is the interplay with BACnet COV services, where some
server devices may offer COV for point updates (as a typically desirable alternative to polling). This
affects Tuning Policy configurations, and how you should assign tuning policies for points. For related
details, see “Bacnet Tuning Policy notes” on page 3-18, “BacnetDevice properties” on page 3-22, and
“Bacnet ProxyExt properties” on page 3-27.
And now for the release-level differences in Bacnet point polling:
• Bacnet 3.1 polling changes
• Bacnet 3.2 polling changes
NiagaraAX-3.x
3-16
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts Bacnet Local Device
February 26, 2008 An essential Local Device property
NiagaraAX-3.x
3-17
BACnet Guide
About Bacnet Tuning Policies Chapter 3 – Niagara Bacnet Client Concepts
About Local Device slots February 26, 2008
Figure 3-9 Bacnet Local Device property Object Id is critical for driver operation
Most other properties are status (read-only) types reflective of the station’s BACnet device capabilities.
However, several are configuration properties to specify location, description, and various APDU param-
eters. External from Niagara (to other BACnet devices), these properties determine how the BACnet
Device object appears that represents the station. See “Local Device properties” on page 4-63 for more
details.
NiagaraAX-3.x
3-18
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Tuning Policies
February 26, 2008 Bacnet Tuning Policy notes
Figure 3-10 Example Tuning Policy used for points under a COV-capable device
Then, when adding/editing proxy points under such COV-capable devices, you can specify to use this
(COV-specific) tuning policy. See “About Tuning Policies” in the Drivers Guide for general information
about tuning policies.
Also see the two next sections:
• Bacnet-only Tuning Policy properties
• Special tuning notes about “stale”
Bacnet-only Tuning Policy properties
In addition to properties typical to most Tuning Policies, the Bacnet driver provides these properties:
• Use Cov
Default is False. If set to True, and assigned proxy points are under a BacnetDevice that supports the
Subscribe COV service, any necessary updates (Niagara proxy subscriptions) are attempted using
BACnet COV subscriptions to the device. If the subscription attempt succeeds, the “Read Status”
property of the point’s BacnetProxyExt displays “COV”. If the subscription attempt for a proxy point
fails, normal polling is used and the “Read Status” property shows “Polled”.
• Use Confirmed Cov
If Use Cov is enabled (True) and assigned proxy points are under a BacnetDevice that supports Con-
firmed COV notifications, any necessary updates (Niagara proxy subscriptions) are attempted using
BACnet Confirmed COV subscriptions to the device. If Use Cov is disabled (False), it makes no dif-
ference what this property value is. The default value is True.
• Cov Subscription Lifetime
The lifetime, in minutes, for which Niagara will subscribe for COV notifications, then (if necessary)
periodically re-subscribe. A value of zero means an indefinite lifetime, although this is not guaran-
teed to persist across resets of the server device. The default value is 15 minutes.
Special tuning notes about “stale”
In general, you should never set the “Stale Time” property in a Tuning Policy shorter than the poll cycle
time, or else points will go stale in the course of normal polling. Instead, set the stale timer to be longer
than the largest expected poll cycle time. This period can vary depending on how many Px graphics are
being viewed, and so on.
Also, note that for each point, the stale timer is measured from the last time the point was updated. This
means if you have a 10-minute stale timer, and an 8-minute poll cycle time, you will have some points with
values nearly 8 minutes old. If you stop polling, those points will begin going stale roughly 2 minutes after
polling has stopped, and not 10 minutes.
This has resulted in some confusion—where the expectation was that after viewing a graphic, any points
in it should stay up for the 10 full minutes (or the configured Stale Time) before going stale. However, the
actual time depends on how long ago they were last polled.
NiagaraAX-3.x
3-19
BACnet Guide
Bacnet Device Manager Chapter 3 – Niagara Bacnet Client Concepts
About Bacnet Device Find Parameters February 26, 2008
Depending on the size of the BACnet network you are learning, you may wish to configure settings from
defaults. By default, all known networks are selected to learn (each network number matches an entry in
the router table), “all networks” are not selected to learn, and the full range of device IDs (0 to 4194302)
is specified.
All fields in the Configure Device Discovery dialog are explained, as follows:
• Device Low Limit
Devices with an instance ID lower than this are not discovered. Default value is 0.
• Device High Limit
Devices with an instance ID higher than this are not discovered. Default value is 4194302 (the max-
imum valid BACnet instance number).
• Network
Allows selection of either:
• All Networks — Niagara will search on all possible BACnet networks segments, including all lo-
cally connected networks, as well as segments accessed over BACnet routers.
• <Known networks (by network number)> — Choices reflect the number of network ports avail-
able under Bacnet Comm, Network component, plus any additional remote networks dis-
covered by receiving “I-am-router” messages. Click to include/exclude as needed. By default, all
known networks are individually pre-selected.
NiagaraAX-3.x
3-20
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts Bacnet Device components
February 26, 2008 Bacnet Device Manager discover notes
As in the device discover dialog, you can set device low and high limits, as well as select which BACnet
networks (by number) receive the Who-Has broadcast (or all networks). When you click OK, a Bacnet
Who Has job is started, and when the job completes the results (including “I-Have” responses) appear in
another popup window, as shown in Figure 3-14.
NiagaraAX-3.x
3-21
BACnet Guide
Bacnet Device components Chapter 3 – Niagara Bacnet Client Concepts
BacnetDevice properties February 26, 2008
• BacnetDevice properties
• About the Config Device Ext container
BacnetDevice properties
When you add (or edit) a BacnetDevice from the Bacnet Device Manager, several key device properties
appear in that dialog, as shown in Figure 3-15.
NiagaraAX-3.x
3-22
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts Bacnet Device components
February 26, 2008 About the Config Device Ext container
The default view of the Bacnet Config Device Ext is the Bacnet Config Manager (Figure 3-16).
From this view, you can learn other config-type objects, each representing a BACnet object in that device.
You might do this to “evaluate” a BACnet device, rather than for permanent station engineering. In this
case, remember to delete the config-type objects afterwards, as they consume station resources. See
“About Bacnet Config objects” on page 3-23.
Note: In AX-3.2, an alternate method is available to evaluate the objects in a device, via its “Virtual Gateway.”
For more details, see “About Bacnet virtual points” on page 3-40.
About Bacnet Config objects
A config object provides a view of a BACnet object in its native format—where all properties of that
object are presented as a whole. Figure 3-17 shows the property sheet of a Binary Input config object.
Unlike Bacnet proxy points that you create using the Bacnet Point Manager, when subscribed, config
objects poll all properties—not as efficient as the selective proxy point model. In addition, slots of Bacnet
config objects use primitive or special data types, not compatible with normal linking logic.
NiagaraAX-3.x
3-23
BACnet Guide
Bacnet Point Manager Chapter 3 – Niagara Bacnet Client Concepts
Bacnet Point Manager “Discovered” notes February 26, 2008
Config objects are expected to be useful for one-time commissioning, or for proprietary objects for which
the proxy point interaction may be insufficient.
You can resort objects by clicking on any column header. Often, this is useful to sort by “Object ID”
(BACnet object type), to group like type objects together.
Also, you can click to expand any object (Figure 3-19). This lets you select other properties (apart from
Present_Value) as a candidate to proxy.
Figure 3-19 Click plus (+) icon beside any discovered object to see all properties
The following sections provide more details about the Discovered pane in the Bacnet Point Manager:
• Discovered object table columns
• Discovered object usage notes
NiagaraAX-3.x
3-24
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts Bacnet Point Manager
February 26, 2008 Bacnet Point Manager “Database” notes
NiagaraAX-3.x
3-25
BACnet Guide
Bacnet Point Manager Chapter 3 – Niagara Bacnet Client Concepts
Bacnet Point Manager “Database” notes February 26, 2008
You can resort points by clicking on any column header. Often, this is useful to sort by “Object ID”
(BACnet object type), or perhaps by name.
Also, if you created BacnetPointFolders under a device’s Points container, you can see all proxy points in
the device from the main (root) Points Manager using “All Descendants” tool. For details, see the section
“Points New Folder and New” in the Drivers Guide.
The following sections provide more details about the Database pane in the Bacnet Point Manager:
• Database proxy point table columns
• Modifying the Database table
Database proxy point table columns
By default, the following columns appear in the Database table, from left-to-right:
Name Out Object ID Property ID Index Read Write
Note: You can also modify columns shown, see “Modifying the Database table” on page 3-27.
Name The Niagara name for the Bacnet proxy point. If you added the point from a discover (selecting
the default “presentValue” property), and did not edit Object Name, this will be identical to the BACnet
object’s name. As needed, you can edit when adding, or at any later time.
Out The current out value, including any point facets. For (presentValue) proxy points before AX-3.2,
this includes both the BACnet “Present_Value” and the logical “OR” status merger of the BACnet object’s
“Status_Flags” (in_alarm, fault, overridden, out_of_service) along with Niagara point status.
Note: BACnet status flags “in_alarm” and “out_of_service” OR with Niagara status “alarm” and “disabled,”
respectively. Status flags “overridden” and “fault” map OR to identically named Niagara statuses. For more
details, see “Status merger for Bacnet proxy points” on page 3-28.
Also, (before AX-3.2) if a writable proxy point for a “priority type” BACnet object (Binary_Output,
Analog_Output, etc.), the out value facets always include the active BACnet priority array level (1—16),
as the object’s “Priority_Array” is also automatically polled. By default, this is formatted as “bac=n”. For
example, a (presentValue) BooleanWritable point for a Binary_Output object may have an out of:
On {ok} @ 16 bac=16
Where here, the active Niagara point priority level (@ 16) agrees with the current BACnet priority level.
Note: Starting in AX-3.2, out display of a proxy point defaults to only the single (configured) property value, along
with Niagara status for the proxy point. However, you can edit point facets to poll for additional properties,
such as the native “statusFlags” and/or “priorityArray” level. For details, see “Facets usage to poll
additional properties” on page 3-29.
Object ID Just as in the Discovered table, this is the “Object_Identifier” property of the proxied BACnet
object, which is a combination of BACnet object type and instance number (unique within that type). In
this column, these two field appear separated by a “:”, using Niagara descriptors for type. For example:
• analogInput:3
• multiStateValue:3
• binaryOutput:3
Property ID The BACnet property name proxied by the point. For example “Present Value” or “Event
State,” depending on selection.
Index Applies only if an “arrayed” property, like “Priority Array” (otherwise it is “-1” for no index).
Provides a numeric index into the property array.
Read The read-only “Read Status” of the ProxyExt, which is typically either “Polled,” “COV,” or “unsub-
scribed,” depending on a number of factors. If a read error occurs, other descriptive text may appear
instead.
Write The read-only “Write” status of the ProxyExt, which is typically “readonly” if the proxy point is
not writable, or if a writable point type, either “writable” or “ok” (last Niagara write occurred within
effective Tuning Policy period). Or, if a write operation fails, the write status provides some descriptive
text.
For example, if you create a writable point for a readonly object (say, a NumericWritable for presentValue
of an Analog_Input object), and attempt to write from Niagara, following this the write status may show:
“Property:Write Access Denied”. If the error is actually a BACnet Error, then this colon-separated
format will contain the Error Class and Error Code returned by the device.
NiagaraAX-3.x
3-26
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts Bacnet proxy points
February 26, 2008 Bacnet ProxyExt properties
Note: To deal with proprietary object types and properties, you can refer to the numerical codes supplied by the
device vendor. Then click to highlight the Object Id, or the Property Id, and type in the needed numeric code.
For example, a proprietary property 1000 may be included on some company’s analog input objects.
Or, if you have added the relevant enumeration value into the BacnetDevice’s Enumeration List property,
you should be able to select it by name (normally) from the drop-down list.
In addition to typical ProxyExt properties (refer to “ProxyExt properties” in the Drivers Guide), the proxy
extension in Bacnet proxy points include these additional properties:
• Object Id
Consists of two fields: BACnet object type, and object instance number. Within any one object type
in that device, instance numbers must be unique. See “Object ID” on page 3-26, also Note above.
NiagaraAX-3.x
3-27
BACnet Guide
Bacnet proxy points Chapter 3 – Niagara Bacnet Client Concepts
Bacnet ProxyExt actions February 26, 2008
• Property Id
BACnet property ID for the specific data item being proxied. Often, this is “Present Value.” See
“Property ID” on page 3-26. If a proprietary property, see the preceding Note.
• Property Array Index
Index to a particular element in an arrayed property, if applicable. For example, if the point proxies
priority level 7 of a priority array input of a Binary_Output point, this value is “7”. If not applicable
to the property being proxied, this value is “-1”.
• Data Type
(read only) ASN primitive application data type, for example, “REAL” or “ENUMERATED.”
• Read Status
(read only) Indicates whether “Polled,” “COV,” or “Unsubscribed.” See “Read” on page 3-26.
• Write Status
(read only) Indicates “readonly” or “writable,” or some other value following a Niagara write. See
“Write” on page 3-26 for more details.
NiagaraAX-3.x
3-28
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts Bacnet proxy points
February 26, 2008 Facets usage to poll additional properties
• If “statusFlags” is added to facets, a “status merger” with Niagara point status occurs—just as it
does “automatically” for pre-AX-3.2 Bacnet proxy points.
• If “statusFlags” is not added to facets, no status merger occurs—only Niagara status is shown
for the proxy point (e.g., if the BACnet object is “in_alarm”, it will likely show “ok” in Niagara).
Status merger operation
In the parent proxy point, any of the above “native” abnormal statuses are OR’ed with the equivalent
Niagara-originated statuses, and merged with Niagara-only status flags, such as “stale,” “unackedAlarm,”
etc. (see “About point status” and “How status flags are set” in the User Guide).
This is mentioned because it is possible to see a proxy point show a status (as one example) “disabled,”
and yet it is enabled in Niagara (the source BACnet object is set to “Out of Service”). Or, you may
encounter a variety of other combinations.
Note that the “Read Value” property of a point’s ProxyExt should only show the BACnet status, so it can
be used to distinguish between Niagara and BACnet contributions to the status bit string. Also, consider
the possibility of any independent alarm and fault parameters between the source BACnet object, and any
possible NiagaraAX alarm extension on the proxy point.
Add facet
Select Select
Boolean true
for Type for Value
To add to the point poll using this technique, add Boolean facet(s) with any of these (Key) names:
NiagaraAX-3.x
3-29
BACnet Guide
Bacnet proxy points Chapter 3 – Niagara Bacnet Client Concepts
Facets usage to poll additional properties February 26, 2008
Figure 3-24 Adding slot in proxy point for DOPR poll method
NiagaraAX-3.x
3-30
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Device’s Schedules
February 26, 2008 Facets usage to poll additional properties
After adding the slot, go to ProxyExt’s property sheet and edit the new slot’s properties to poll/display the
property needed. Figure 3-25 shows a DOPR example for property “highLimit” (Property Id 45) of Analog
Input 1 in the same device (device -1).
Figure 3-25 Configuring properties in DOPR slot in ProxyExt for DOPR poll method
Due to the complexity of this technique, it is expected to be infrequently used. However, in certain appli-
cations, such as with Event Enrollment objects (a BACnet object that monitors other objects for the
purpose of generating alarms based on its own algorithm), it may prove useful.
The resulting metadata is included with the name of the DOPR. If it is an Event Enrollment object, and
the DOPR property is Event_State (the alarm state of the EE object), the facet appears like:
<EEinstanceNumber>=<EE event state>
if another property, the facet is:
<EEinstanceNumber>_<EEpropId>=<prop value>
NiagaraAX-3.x
3-31
BACnet Guide
About Bacnet Device’s Schedules Chapter 3 – Niagara Bacnet Client Concepts
About the Bacnet Schedule Import Manager February 26, 2008
Imported schedules and calendars are Niagara schedule components with a BacnetScheduleImportExt.
Events in an imported schedule (or calendar) are obtained from that BACnet device, and are read-only.
By default, the Schedules device extension also contains a Retry Trigger, for automatic usage as needed.
For details see “About the Retry Trigger” in the Drivers Guide.
Note that the Schedules device extension can also contain BacnetScheduleExport components. These
correspond to Niagara schedules or calendars that are “pushed” to specific BACnet Schedule or Calendar
objects in the remote device. See “About the Bacnet Schedule Export Manager” on page 3-33 for related
details. Also, see the next section “Notes on Bacnet Schedule Imports”.
Notes on Bacnet Schedule Imports
The Add (and Edit) dialog for importing BACnet Schedules and Calendars is shown in Figure 3-27.
The default name is the BACnet object’s name, and you typically leave this and other properties at
defaults. Upon adding, the object’s configuration is uploaded to the read-only Niagara schedule
component. Note that the default import (read synchronization) from the device’s object is “Manual”,
meaning that you must use the Import button in the Bacnet Schedule Import Manager to refresh the
Niagara schedule. Alternatively, you can also set the trigger time of the BacnetScheduleImportExt to be
either Daily or Interval, if you anticipate ongoing changes in the BACnet object’s configuration.
Note: When the remote BACnet schedule is imported, if it contains a reference to a Calendar object in the device,
the Calendar object will also be brought in as a schedule import, in order to keep the schedule in Niagara
self-complete.
NiagaraAX-3.x
3-32
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Device’s Schedules
February 26, 2008 About the Bacnet Schedule Export Manager
Figure 3-28 shows the property sheet of a BacnetScheduleImportExt for an imported schedule.
Note that the BACnet property “Priority for Writing” is included—however, this means little in the
Niagara (station) usage of this imported schedule.
Exported schedules and calendars are schedule export components , each “pointing” to a Niagara
schedule component in the station. Events in an exported schedule (or calendar) are written by Niagara
to the identified object in that BACnet device.
Note: The BacnetNetwork’s Local Device also has a child Export Table, with a Bacnet Export Manager
view that permits “exposing” Niagara schedule components in the station as either BACnet Schedule
objects or Calendar objects. However, this is a “server type” export, where exported components are made
available to any networked BACnet device (and not written to specific objects in a BACnet device, to which
we act as a client). See “Niagara Bacnet Server Operation” on page 4-47 for more details.
The following sections provide more details about exporting to BACnet objects:
• Exporting to BACnet Schedule and Calendar objects
• BacnetScheduleExport properties (including Skip Writes)
NiagaraAX-3.x
3-33
BACnet Guide
About Bacnet Device’s Schedules Chapter 3 – Niagara Bacnet Client Concepts
About the Bacnet Schedule Export Manager February 26, 2008
• Device — Data in the schedule that exists in the BACnet device is initially used, overwriting (ini-
tializing) the Niagara schedule. Essentially, this starts the same as if the schedule was imported.
• Niagara — Data in the Niagara schedule overwrites data in the existing BACnet schedule when
exported (how it originally worked in AX-3.0).
It is expected that the “Device” option may often be useful. After choosing an option and clicking Add,
the dialog appears. The Add (and Edit) dialog for exporting to a BACnet object is shown in Figure 3-30.
The default name is the target BACnet object’s name, and you typically leave this at default. The most
critical property is the Supervisor Ord (null by default).
In the Supervisor Ord property, click the open folder for a Select Ord popup dialog, in which you
can navigate to find the source Niagara schedule or calendar in the station (Figure 3-31).
Figure 3-31 Select Ord popup for Supervisor Ord property in BacnetExport
Another property of interest (to BACnet) is the “Priority For Writing” property, which defaults to priority
16. Set this as needed by the application in the BACnet device.
Finally, the default “Execution Time” (write synchronization) to the device’s BACnet object is at a
continuous 5-minute “Interval”. If needed you can adjust this, or set to “Daily” or even “Manual” (whereby
an Export from the Bacnet Schedule Export Manager is required).
NiagaraAX-3.x
3-34
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Device’s Schedules
February 26, 2008 About the Bacnet Schedule Export Manager
When you click OK in the Add dialog to create the schedule export, the component is added to the
database, and an attempt is made to write the (source) Niagara configuration into the (target) BACnet
Schedule or Calendar object. If successful, the status of the BacnetScheduleExport component remains
“ok,” and its row in the Database table of the export manager remains uncolored (white).
However, if any portion of the BACnet write failed, the BacnetScheduleExport has a “fault” status, and its
row in the export manager’s Database table appears colored orange, as shown in Figure 3-32.
Figure 3-32 Fault status (orange) indicates write problem to target BACnet schedule
Status: ok
Status: fault
In the case of fault, access the BacnetScheduleExport properties and examine the Fault Cause, and if
necessary adjust the Skip Writes property.
BacnetScheduleExport properties
To access the property sheet of a BacnetScheduleExport component, right-click it from either the Nav
side bar, or within the Database table of the export manager (as shown in Figure 3-33).
Included is a “Fault Cause” property that provides a text string description if a write operation failed to
the target BACnet Schedule or Calendar object. For example:
“scheduleDefault::Property:Write Access Denied”.
In addition, a Skip Writes property lets you adjust which property types in a target BACnet Schedule
object are written to, upon an export from a Niagara weekly schedule component.
NiagaraAX-3.x
3-35
BACnet Guide
About Bacnet Trend Logs (Histories) Chapter 3 – Niagara Bacnet Client Concepts
About the Bacnet History Import Manager February 26, 2008
About schedule export Skip Writes Depending on the BACnet device’s implementation by vendor,
some properties of its Schedule objects may be read-only. For example, a BACnet Schedule object may
allow writes to its weekly schedule events, but not to its exception schedule (“Special Events” in Niagara),
if they are read-only (or perhaps do not even exist). Or, the object’s “Priority_For_Writing” property may
be read-only, or the object may not even have a weekly schedule or exception schedule (a Schedule must
only have one or the other, it may have both).
To allow for this, a BacnetScheduleExport component provides a “Skip Writes” property in which you
can specify the properties to be written upon an export from Niagara. From the property sheet, click the
far-right side control for a popup Facets Editor, as shown in Figure 3-34.
As shown above, the default is to not skip writing any properties upon export (false for all), meaning
that all property areas of the source Niagara schedule component are written to the target BACnet
Schedule object. As needed, set any of these in the Facets Editor to true, such that Niagara does
not attempt to write to them. This can allow an export without a fault (see Figure 3-32).
Note: Skip Writes does not apply if exporting to a BACnet Calendar (from a CalendarSchedule).
The Skip Write property areas (facets) are:
• scheduleDefault — Corresponds to “Default Output” of the source Niagara schedule.
• weeklySchedule — Corresponds to the regular day-of-week events of the source Niagara schedule,
as defined in its Weekly Scheduler view.
• exceptionSchedule — Corresponds to all “Special Events” of the source Niagara schedule.
• effectivePeriod — As defined by the “Effective Period” in the source Niagara schedule.
• priorityForWriting — As defined by the “Priority For Writing” property in the BacnetScheduleEx-
port component itself (instead of the source Niagara schedule).
NiagaraAX-3.x
3-36
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Trend Logs (Histories)
February 26, 2008 BACnet Trend Log import notes
Figure 3-35 Bacnet History Import Manager is default view of a device’s Trend Logs
You discover Trend Log objects in the BACnet device, and add them as history import components,
each of which displays as one row in this manager view. For each import component added, a corre-
sponding Niagara history is made in the station, and is populated with data from the BACnet Trend Log
object. By default, the Trend Logs container also has a Retry Trigger, for automatic usage as needed.
For details, refer to “About the Retry Trigger” in the Drivers Guide.
See “BACnet Trend Log import notes” for more details.
To import Trend Logs, you select them in the top Discovered pane, and then click Add, producing the
Add dialog (Figure 3-37). This dialog shows some of a BacnetHistoryImport component’s properties.
NiagaraAX-3.x
3-37
BACnet Guide
About Bacnet Trend Logs (Histories) Chapter 3 – Niagara Bacnet Client Concepts
BACnet Trend Log import notes February 26, 2008
Fields in the Add (and Edit) dialog in the Bacnet History Import Manager are as follows:
• Name
The BACnet Trend Log object’s name.
• Object Id
The BACnet object type (Trend Log) and instance number, unique within the device.
• Execution Time
The frequency at which data is imported from the remote Trend Log into the Niagara history. De-
fault is daily, at 2:00 AM.
• Enabled
Must be true (default) to import Trend Log data into the Niagara history.
• Capacity
Capacity of the imported Niagara history, defaulting to unlimited.
• Full Policy
Niagara policy when history reaches its capacity.
• Local History Name
Name of the Niagara history initially created and populated by the Trend Log data.
Note that after adding, you can access additional BacnetHistoryImport properties from the property
sheet of any BacnetHistoryImport. Also the following right-click actions are available:
• Execute
Like an Archive from the manager, this updates the Niagara history from the Trend Log data.
• Clear Records in Device
Produces a confirmation dialog. If answered “Yes,” the attempts to clear all records in the source
BACnet Trend Log object. However, note that records in the imported Niagara history remain.
Also see the next section, “About histories imported from Trend Logs”.
About histories imported from Trend Logs
Niagara histories imported from BACnet Trend Logs have additional fields in each record, namely
“Sequence Number” and “Log Event,” which reflect BACnet-required items. These fields do not affect
“History Chart” views of these histories, but do require slightly more storage space.
Note: The concept of sequence number was introduced with Addendum B to the 2001 edition of the specification.
Trend Logs that were implemented against earlier editions (which includes logs from R2 Niagara stations,
and Niagara AX histories that were collected with a non-BacnetTrendLogExt) will not have sequence
number in their log data, so Niagara has to access the records by time only.
Figure 3-38 shows a History Table view of an example history created by a BacnetHistoryImport.
NiagaraAX-3.x
3-38
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet Trend Logs (Histories)
February 26, 2008 BacnetHistoryImport properties
Figure 3-38 History Table for history imported from BACnet Trend Log
BacnetHistoryImport properties
To access the property sheet of a BacnetHistoryImport component, right-click it from either the Nav side
bar, or within the Database table of the Bacnet History Import Manager (as shown in Figure 3-39).
The “Config Overrides” properties (capacity, fullPolicy) work as they do in the “History Config”
properties of a normal history extension. See the “Configure history extensions” section in the User Guide
for more details.
The last four properties affect the special collection process from the imported Trend Log object, and are
described as follows:
• Reference Time
Provides a Date and Time for reference.
• Max Records By Request
Defines the maximum Trend Log records that can be archived (0 to max), with default of 0. Note that
with the 0 default, Niagara asks for 10 records per request.
• Always Request By Reference Time
Whether Trend Log records should always request against the reference time. Default is false.
• Last Sequence Number Processed
Shows the highest numerical BACnet sequence number processed. Note that sequence numbers are
included in the imported Niagara history. See “About histories imported from Trend Logs” on page
3-38, including the relevant Note.
NiagaraAX-3.x
3-39
BACnet Guide
About Bacnet virtual points Chapter 3 – Niagara Bacnet Client Concepts
Usage of Bacnet virtual points February 26, 2008
As shown above, virtual objects are listed by object ID, i.e. <objectType>_<instanceNumber>, for
example analogInput_2 or trendLog_1. You can expand any Bacnet virtual object to see that object’s
properties, where each property is a child virtual. See the next section “About BacnetVirtualProperties
(AX-3.3 and later)”.
Note: Note if an AX-3.2 station, this varies slightly—see “Bacnet AX-3.2 virtual notes” on page 3-42.
NiagaraAX-3.x
3-40
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet virtual points
February 26, 2008 Browsing Bacnet virtual points
Figure 3-41 Properties of a BacnetVirtualObject are BacnetVirtualProperty components (AX-3.3 and later)
Figure 3-42 Each BacnetVirtualProperty has two properties: Status and value
Note that status reflects Niagara poll status, but does not reflect any “intrinsic” BACnet status (such as
alarm). Intitially, status changes from “stale” to “ok” upon the first polled read, and typically remains “ok”.
Status could possibly change to either “stale” or “down” in certain scenarios.
Each BacnetVirtualProperty also has a “set” action for right-click access, as shown in Figure 3-42.
This allows you to easily do “one time” configuration tweaks from the Workbench property sheet of the
virtual property—providing that the remote BACnet device permits writes, of course. Note that this write
action exists for every property of the BACnet object, even read-only or status types. Furthermore, this
action is also available on a Px widget bound to any BacnetVirtualProperty. see “Px usage of Bacnet
virtuals (AX-3.3 and later)” on page 3-43 for related details.
Note: You can globally rename the set action (and resultant popup dialog) to something else by editing the bacnet
lexicon value for the key named BacnetVirtualProperty.set.
In addition, each BacnetVirtualProperty has a default “Bacnet Virtual Property View” that shows both
value and status, as shown in Figure 3-44.
NiagaraAX-3.x
3-41
BACnet Guide
About Bacnet virtual points Chapter 3 – Niagara Bacnet Client Concepts
Bacnet virtual points in Px views February 26, 2008
Figure 3-44 Default “Bacnet Virtual Property View” shows both value and poll status
Although it is not an exciting view, it is an option when creating Px bindings and selecting “Workbench
view,” and it also provides a quick preview outside of the Px editor.
Bacnet AX-3.2 virtual notes
In AX-3.2 only, Bacnet virtual points are at the “object level” ony, using a single BacnetVirtualComponent
to model each BACnet object under the device’s gateway. See Figure 3-45.
This “virtual view” property sheet reflects current property values. If needed, you can modify selectively
and click Save with new values entered. Unlike with the later AX-3.3 virtual point design, there is no
available action on BacnetVirtualComponents, nor is status (of polling) included with property values.
Note: If making wide use of Bacnet virtual points, it is recommended to use AX-3.3 or later. In addition to
providing more features, polling has proven to work better under certain scenarios.
NiagaraAX-3.x
3-42
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet virtual points
February 26, 2008 Bacnet virtual points in Px views
Figure 3-46 Dragging BacnetVirtualProperty into Px editor view, with resulting Make Widget popup
Often you may wish to include the “presentValue” property, as shown here. In the Make Widget dialog,
you can select either “Bound label” (as shown) or “Workbench view” for the “Bacnet Virtual Property
View.” If using a bound label, the accompanying display name label (if that option was selected) can be
edited to another text string, as shown in Figure 3-47.
At the time of this document, every BacnetVirtualProperty provides an action to write (“set” is default
name), which may be useful in some scenarios. Figure 3-48 shows an example action being invoked.
Figure 3-48 Default “set” action and resulting popup for write to a present_value property
NiagaraAX-3.x
3-43
BACnet Guide
About Bacnet virtual points Chapter 3 – Niagara Bacnet Client Concepts
Bacnet virtual points in Px views February 26, 2008
By default, in the case of a write to the “presentValue” property of a BACnet object with a priority_array
(such as an Analog Output or Binary Output), the Niagara write is issued at priority level 16. You can
specify another priority level by editing the ord used in the Px binding (to the Bacnet virtual component).
See “Bacnet virtual ord syntax” on page 3-45 for related details.
Note: Currently, the “set” dialog for a BacnetVirtualProperty for present_value provides two fields (Figure 3-49).
Figure 3-49 Set dialog type field (drop-down list), value field in example binding to present_value
Figure 3-50 Make Widget popup from dragging BacnetVirtualComponent (AX-3.2) into Px view
Often the “presentValue” property will be selected, as shown above. The accompanying display name
label (if that option was selected) can be edited to another text string, if desired, as shown in Figure 3-51.
Unlike with Bacnet virtual points in AX-3.3 and later, there is no included polling status nor any available
right-click actions, such as “set”.
NiagaraAX-3.x
3-44
BACnet Guide
Chapter 3 – Niagara Bacnet Client Concepts About Bacnet virtual points
February 26, 2008 Bacnet virtual ord syntax
NiagaraAX-3.x
3-45
BACnet Guide
About Bacnet virtual points Chapter 3 – Niagara Bacnet Client Concepts
Bacnet virtual ord syntax February 26, 2008
NiagaraAX-3.x
3-46
BACnet Guide
CHAPTER 4
Niagara Bacnet Server Operation
This section describes the “server side” operation of the NiagaraAX Bacnet driver. If the host platform is
licensed as a BACnet server, you can “export” any number of selected types of objects in the station
(regardless of location) to appear as BACnet objects. As such, these objects can service client requests
from any networked BACnet devices. Exporting of Niagara schedules and calendars is included. Histories
can be exported also, where they appear externally as BACnet Trend Log objects.
Note: For related licensing details, see “Bacnet server (export) ability” on page 1-1.
Server operation of the Bacnet driver is concurrent with client configuration and operation—often, you
may choose to do both. In special cases, you may configure for BACnet server operation only.
These are the main subsections:
• Bacnet server configuration overview
• Bacnet Export Manager
• Bacnet File Export Manager
• Bacnet Niagara Log Export Manager
• Local Device notes
View Selector
Export Table
Server Descriptors
NiagaraAX-3.x
4–47
BACnet Guide
Bacnet server configuration overview Chapter 4 – Niagara Bacnet Server Operation
About the Export Table February 26, 2008
NiagaraAX-3.x
4-48
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet server configuration overview
February 26, 2008 Types of objects for Bacnet export
Note: You do not see file descriptors in the other two export manager views (Bacnet Export Manager, Bacnet
Niagara Log Export Manager). Those views show other server descriptors.
There is only one type: BacnetFileDescriptor. For more details, see “About Discover in Bacnet File Export
Manager” on page 4-55 and “Properties of Bacnet file descriptors” on page 4-57.
About log descriptors
A Bacnet log descriptor exports a Niagara history as a BACnet Trend Log object. There are two different
types of log descriptors:
• BacnetNiagaraHistoryDescriptor — Created when you select and add a “standard” Niagara history
using the Bacnet Niagara Log Export Manager view of the Export Table. Note that the resulting ex-
ported Trend Log object is compliant only with the original “broken” specification for BACnet
Trend Logs, which was superceded and fixed in Addendum B to the 2001 version of the spec,
• BacnetTrendLogDescriptor — Automatically created when you add a specialized Bac-
netTrendLogExt extension to a point. The resulting exported Trend Log object is fully-BACnet
compliant with the 2004 version of the BACnet spec.
For more details, see “About Trend Log exports” on page 4-58.
Note: You do not see log descriptors in the other two export manager views (Bacnet Export Manager, Bacnet File
Export Manager). Those views show other server descriptors.
About export folders
Use Bacnet export folders to organize any collection of Bacnet server descriptors. Add export folders
using the New Folder button in any of the Export Table manager views.
Note: There is only one type of Bacnet export folder—you see export folders in all views (Bacnet Export Manager,
Bacnet File Export Manager, Bacnet Niagara Log Export Manager). Note that the default (double-click)
view for any export folder is the Bacnet Export Manager.
NiagaraAX-3.x
4-49
BACnet Guide
Bacnet server configuration overview Chapter 4 – Niagara Bacnet Server Operation
About BACnet server access February 26, 2008
Figure 4-2 BACnet station user automatically created, but without write permissions
NiagaraAX-3.x
4-50
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet Export Manager
February 26, 2008 About Discover in Bacnet Export Manager
This view shows only Bacnet export descriptors and any Bacnet export folders. The following sections
provide more details:
• About Discover in Bacnet Export Manager
• Add (and Edit) in Bacnet Export Manager
• Properties of Bacnet export descriptors
• Bacnet Export Manager application notes
See “About the Bql Query Builder” in the Drivers Guide for general information. Relative to usage in the
Bacnet Export Manager, this dialog lets you find and select components in the station to export
(expose) as BACnet objects.
You can export the following component types (Also see “Types of objects for Bacnet export” on page 4-
49):
• Any components sub-classed from BooleanPoint, EnumPoint or NumericPoint, (including Writ-
ables) meaning the following types:
• Any proxy point that is not a StringPoint or StringWritable, under any driver.
NiagaraAX-3.x
4-51
BACnet Guide
Bacnet Export Manager Chapter 4 – Niagara Bacnet Server Operation
Add (and Edit) in Bacnet Export Manager February 26, 2008
• Most kitControl components that have a null ProxyExt—this includes all Math and Logic com-
ponents, for example. Typically, you export these as a “value type” object (Analog Value, Binary
Value, Multistate Value). Note that you can export a LoopPoint as a BACnet Loop object.
Again, kitControl objects subclassed from StringPoint (string Output) cannot be exported.
• Any Niagara Schedule component except a TriggerSchedule (no BACnet object equivalent).
• Alarm Class components (under the station’s AlarmService), which export as BACnet Notification
Class objects.
Note: Therefore in the Bql Query Builder, type selections other than Control Point, Boolean Point, Enum
Point, Numeric Point, Schedule, and Alarm Class have no practical application.
As with other manager views featuring online discovery, “Learn Mode” in Bacnet Export Manager has
two panes:
• Top (discovered) Local Objects pane—listing components found from your last Bql query.
• Bottom (database) Export Objects pane—listing components currently exported to BACnet.
These are special “export descriptor” components—each essentially a pointer to the exposed Niaga-
ra component, with additional slots that determine how BACnet access/writes are handled. See the
next section, “Add (and Edit) in Bacnet Export Manager” for more details.
When exporting, the manager automatically performs “object ID maintenance” on exported compo-
nents, ensuring that no duplicate combinations of object type and instance number are created.
All fields in this dialog apply separately to each highlighted (for export) component, as follows:
Note: Select Type first, before editing other fields such as Object Name and Description. Otherwise, those entries
become cleared and you will need to re-enter.
In addition, Type is the only slot you cannot change after adding (say, in the Edit dialog).
• Name
Niagara read-only component name for the Bacnet export descriptor, which defaults to the combi-
nation of <object type>_<instance number>. Reflects the “Type” chosen (below it in dialog).
• Object Name
The “exposed to BACnet” name for this object. By default, the entire component path under the sta-
tion’s Config is included, using period (“.”) delimiters between parent.child levels. This enforces (ex-
ternally) the BACnet requirement for unique names for all objects in a device.
Note: You can shorten or edit object name, either now or later. However, please note that each Object
Name should be unique among all server descriptors under the Export Table.
The Batch Search and Replace feature is useful when adding/editing multiple exports.
• Type
Initially (in Add dialog) you can select the specific Bacnet export descriptor (object type)—in most
cases, from two or more choices. Click the drop down control (Figure 4-6) to select type.
NiagaraAX-3.x
4-52
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet Export Manager
February 26, 2008 Add (and Edit) in Bacnet Export Manager
Figure 4-6 Bacnet export descriptor (object) type choice is typically two or more
Writable Niagara components typically offer more type selections than read-only points, such as:
• Two read-only: “input” or “value” type, e.g. Binary Input or Binary Value object.
• Two writable: “output” or “prioritized value” type, e.g. Binary Output or Binary Value Priori-
tized object.
Figure 4-7 shows an example of type selections when exporting an NdioBooleanWritable point.
• Object Type
Reflects the “BACnet Object type” exposed, dependent on Type selection.
• Inst Num
The instance number portion of this object’s “Object ID,” which must be unique within the station
for this (exported) BACnet Object type. By default, the export manager enforces this.
Note: If you are exporting a group of points at once, you can select them all in the Add/Edit dialog,
and type the instance number for the first one, and each descriptor will be assigned successive instance
numbers as available.
• Export Ord
Station’s Ord location of the source component. By default, format used is the numeric “handle” in-
stead of slot (better if source object gets renamed). In an Edit (dialog) scenario, you can access a
more meaningful ord by clicking the right-side Folder control. This produces a popup Select Ord
dialog, showing the component’s location in the station’s component tree hierarchy.
• Description
Optional text string; this appears as the Description property value in the exposed BACnet object.
• BACnet Writable
(“Dimmed” if the export Type is read-only, for example Analog Input or Binary Value)
For writable types, an array of checkboxes lets you select the specific priority levels externally ex-
posed to BACnet to accept writes. Included are “all controls” to clear or select, see Figure 4-8. (For
“full BACnet compliance,” all levels must be selected—however, see the Note: below).
Figure 4-8 BACnet Writable settings for exposed writable point includes all priority levels
Note: Each priority level (1—16) that you enable for BACnet writes results in that “InN” input on
the source component to be linked to this “Bacnet export descriptor” component. These links appear
as “nubs” when viewing the source writable point in its wire sheet view.
Do not select any priority level already linked or in use by Niagara, otherwise control contention will
occur. Also see “Allowing write access from BACnet” on page 4-50.
Note: After creation (adding) Bacnet export descriptors, note that each descriptor also has additional properties
accessible in its property sheet, along with those seen in the Add and Edit dialog. See the next section,
“Properties of Bacnet export descriptors” for more details.
NiagaraAX-3.x
4-53
BACnet Guide
Bacnet Export Manager Chapter 4 – Niagara Bacnet Server Operation
Properties of Bacnet export descriptors February 26, 2008
Some of these properties are BACnet optional properties, such as “Notify_Type” and “Device Type.”
Others are required, such as “Out_Of_Service”. The following list describes additional properties in
Bacnet export descriptors, not seen in the Add or Edit dialog for the component:
• Fault Cause
Niagara-only, read-only property showing an explanatory text string if the export descriptor is in
fault. For example, if its Object Id is manually edited to be the same as another existing export de-
scriptor—a fault occurs and the Fault Cause would be “Duplicate Object ID.”
• Reliability
BACnet read-only property that reads “No Fault Detected” when things are OK, and typically
“Unreliable Other” if the exported BACnet object appears in fault. This might happen, for exam-
ple, if the source (exported) component is a proxy point under some other driver, and device com-
munications are down, or if the point has been disabled.
In this case, note that the Bacnet export descriptor retains a status of “ok.”
• Out Of Service
Writable BACnet property, which you can set to false if needed—this affects the BACnet exposure
and access of the source component only. In other words, if the source (exported) component is a
proxy point, the equivalent “Enabled” property in its ProxyExt is not affected.
• Notify Type
Writable BACnet property that can be set to either Alarm (default) or Event. Applies if the source
Niagara component has an alarm extension.
• Cov Increment
Writable BACnet property included only for analog object types (Analog Input, Analog Output, An-
alog Value, Analog Value Priority, Loop), specifying the minimum COV required before a COVNo-
tification is issued to subscriber BACnet COV-clients. Default value is typically 1.00.
• Device Type
Writable BACnet property included only for some object types (Analog Input, Analog Output, Bi-
nary Input, Binary Output, Multi-state Input, Multi-state Output), typically associated with the type
of physical input or output. Use is optional. In NiagaraAX, this might apply mostly to exported Ndio
points—where each point corresponds to a physical device.
NiagaraAX-3.x
4-54
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet File Export Manager
February 26, 2008 Bacnet Export Manager application notes
Files can be accessed as read-only or as writable, depending on the local file system. Currently, the
BACnet “File_Access_Method” is Stream Access only.
The following sections provide more details:
• About Discover in Bacnet File Export Manager
• Add (and Edit) in Bacnet File Export Manager
• Properties of Bacnet file descriptors
NiagaraAX-3.x
4-55
BACnet Guide
Bacnet File Export Manager Chapter 4 – Niagara Bacnet Server Operation
Add (and Edit) in Bacnet File Export Manager February 26, 2008
As with other manager views featuring online discovery, “Learn Mode” in Bacnet File Export Manager
has two panes:
• Top (discovered) Local Files pane—listing all files and subfolders under the station folder.
• Bottom (database) Exported Objects pane—listing files currently exported to BACnet. These
are special “file descriptor” components—each essentially a pointer to the exposed station file, with
additional slots that determine how BACnet access/writes are handled. See the next section, “Add
(and Edit) in Bacnet File Export Manager” for more details.
When exporting, the manager automatically performs “object ID maintenance” on exported files,
ensuring that no duplicate combinations of object type and instance number are created.
All fields in this dialog apply separately to each highlighted (for export) file, as follows:
• Name
Read-only Niagara component name for the Bacnet file descriptor, which defaults to the combina-
tion of: file_<instance number>.
• Object Name
The “exposed to BACnet” name for this file. By default, only the filename and extension are used.
• Object Type
Read-only reflection of the “BACnet Object type” exposed, in this case always: File.
• Inst Num
The instance number portion of this object’s “Object ID,” which must be unique within the station
for this (exported) BACnet File object type. By default, the export manager enforces this.
• Export Ord
Station’s Ord location of the source file, using standard file Ord notation.
NiagaraAX-3.x
4-56
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet Niagara Log Export Manager
February 26, 2008 Properties of Bacnet file descriptors
• Description
Optional text string; this appears as the Description property value in the exposed BACnet object.
Note: After creation (adding) Bacnet file descriptors, note that each descriptor also has additional properties
accessible in its property sheet, along with those seen in the Add and Edit dialog. See the next section,
“Properties of Bacnet file descriptors” for more details.
The following list describes additional properties in Bacnet file descriptors, not seen in the Add or Edit
dialog for the component:
• Status
Niagara-only, read-only status flag for the file descriptor component.
• Fault Cause
Niagara-only, read-only property showing an explanatory text string if the file descriptor is in fault.
For example, if its Object Id is manually edited to be the same as another existing file descriptor—a
fault occurs and the Fault Cause would be “Duplicate Object ID.”
• File Type
BACnet property, as a text string intended to identify the use of this file. Default value is blank, how-
ever, the actual exported BACnet File object contains some default value, such as “text/plain” or
“application/zip”.
• Archive Time
Timestamp compared against the actual file timestamp, in order to set the BACnet property “Ar-
chive” (True if Archive Time < file timestamp, or False if Archive Time > file timestamp).
• File Access Method
Read-only BACnet property that indicates the types of file access supported. Currently, this is
Stream Access only.
Note: Additional properties in the exported File object exist, even though not visible in the Bacnet File Descriptor
property sheet. These properties include:
• File Size (integer, in bytes)
• Modification Date (actual file timestamp)
• Archive (True or False, see Archive Time above)
• Read Only (True or False, as determined by the local Java file system)
NiagaraAX-3.x
4-57
BACnet Guide
Bacnet Niagara Log Export Manager Chapter 4 – Niagara Bacnet Server Operation
About Trend Log exports February 26, 2008
Note: If fully BACnet-compliant Trend Log objects are required, you must configure the source Niagara points
with one of the BacnetTrendLogExt extensions (from the bacnet palette). For details, see the next section
“About Trend Log exports”.
The following sections provide more details:
• About Trend Log exports
• About Discover in Bacnet Niagara Log Export Manager
• Add (and Edit) in Bacnet Niagara Log Export Manager
• Properties of Bacnet trend log descriptors
NiagaraAX-3.x
4-58
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet Niagara Log Export Manager
February 26, 2008 About Trend Log exports
You can use one of these instead of a “standard history extension,” pasting it in any point in which you
need to export its history as a fully BACnet-compliant Trend Log object. For example, if you have a Lon
proxy point of type NumericPoint, for “nvoSpaceTemp” representing room temperature, you could copy
a BacnetNumericIntervalTrendLogExt into that NumericPoint. Its resulting history (created only after
you enable it, as with any history extension) will now be fully BACnet-compliant.
By default, when you add one of the BacnetTrendLogExt extension types to a component, note that a
corresponding Bacnet log descriptor of type BacnetTrendLogDescriptor is automatically created in the
root of the Export Table. You still define the normal collection parameters in the BacnetTrendLogExt
history extension (of the source component), however, there are additional properties in its associated
Bacnet Trend Log descriptor.
BacnetTrendLogExt extension types As found in the bacnet palette under the Trending, Bacnet-
LogExtensions folder (Figure 4-15), the different types of BacnetTrendLogExt include:
• BacnetBooleanCovTrendLogExt
• BacnetBooeanIntervalTrendLogExt
• BacnetEnumCovTrendLogExt
• BacnetEnumIntervalTrendLogExt
• BacnetNumericCovTrendLogExt
• BacnetNumericIntervalTrendLogExt
• BacnetStringCovTrendLogExt
• BacnetStringIntervalTrendLogExt
In addition, there is a BacnetTrendLogAlarmSourceExt that you can paste under any of the extensions
above. This provides intrinsic BACnet alarming/notification for buffer near-full events.
Differences in BACnet-exposed histories
A Niagara history created by a BacnetTrendLogExt has extra fields for sequence numbers, and also “Log
Events,” as shown in Figure 4-16.
NiagaraAX-3.x
4-59
BACnet Guide
Bacnet Niagara Log Export Manager Chapter 4 – Niagara Bacnet Server Operation
About Discover in Bacnet Niagara Log Export Manager February 26, 2008
As with other manager views featuring online discovery, “Learn Mode” in Bacnet Niagara Log Export
Manager has two panes:
• Top (discovered) Local Histories pane—listing all histories in the local station.
• Bottom (database) Exported Objects pane—listing histories currently exported to BACnet.
These include both types of log descriptor components—each essentially a pointer to the exposed
history, with additional slots that determine how BACnet access/writes are handled. See the next
section, “Add (and Edit) in Bacnet Niagara Log Export Manager” for more details.
When exporting, the manager automatically performs “object ID maintenance” on exported files,
ensuring that no duplicate combinations of object type and instance number are created.
NiagaraAX-3.x
4-60
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Bacnet Niagara Log Export Manager
February 26, 2008 Add (and Edit) in Bacnet Niagara Log Export Manager
All fields in this dialog apply separately to each highlighted (for export) history, as follows:
• Name
Read-only Niagara component name for the Bacnet log descriptor, which defaults to the combina-
tion of: trendLog_<instance number>.
• Object Name
The “exposed to BACnet” name for this history. By default, the entire component path under the sta-
tion’s History is included, using period (“/”) delimiters between parent.child levels. This enforces
(externally) the BACnet requirement for unique names for all objects in a device.
Note: You can shorten or edit object name, either now or later. However, please note that each Object
Name should be unique among all server descriptors under the Export Table.
• Type
Type of descriptor, in the Add dialog it is: Bacnet Niagara History Descriptor.
In any subsequent Edit dialog, this cannot be changed.
• Object Type
Read-only reflection of the “BACnet Object type” exposed, in this case always: Trend Log.
• Inst Num
The instance number portion of this object’s “Object ID,” which must be unique within the station
for this (exported) BACnet Trend Log object type. By default, the export manager enforces this.
• Export Ord
Station’s Ord location of the source history, using standard history Ord notation.
• Description
Optional text string; this appears as the Description property value in the exposed BACnet object.
Note: After creation (adding) Bacnet log descriptors, note that each descriptor also has additional properties
accessible in its property sheet, along with those seen in the Add and Edit dialog. See the next section,
“Properties of Bacnet file descriptors” for more details.
NiagaraAX-3.x
4-61
BACnet Guide
Local Device notes Chapter 4 – Niagara Bacnet Server Operation
Properties of Bacnet trend log descriptors February 26, 2008
The following list describes additional properties in Bacnet log descriptors, not seen in the Add or Edit
dialog for the component:
• Status
Niagara-only, read-only status flag for the file descriptor component.
• Fault Cause
Niagara-only, read-only property showing an explanatory text string if the log descriptor is in fault.
For example, if its Object Id is manually edited to be the same as another existing log descriptor—a
fault occurs and the Fault Cause would be “Duplicate Object ID.”
• Id
Appears only if a BacnetNiagaraHistoryDescriptor (as shown Figure 4-20), and reflects the same
Niagara history “Export Ord” in the station.
• Log Ord
Appears only if a BacnetTrendLogDescriptor (as shown Figure 4-21), and reflects the handle of the
the specific BacnetTrendLogExt responsible for creating the exported history.
NiagaraAX-3.x
4-62
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Local Device notes
February 26, 2008 Local Device properties
Figure 4-22 Some properties of Bacnet Local Device affect server operation
NiagaraAX-3.x
4-63
BACnet Guide
Local Device notes Chapter 4 – Niagara Bacnet Server Operation
Local Device backup and restore properties February 26, 2008
Figure 4-23 Container slots near bottom of Local Device property sheet
Apart from the Export Table (see “About the Export Table” on page 4-48), these container slots are as
follows (note some may be hidden by default, by design):
• Device Address Binding — (may be hidden) has entries reflecting client-side operation, essentially a
list of Device objects (by object ID) and BACnet device address. These identify actual device param-
eters used when making client BACnet service requests to these devices. For informational use only.
• Active Cov Subscriptions — (may be hidden) applies to server operation. See About Active Cov Sub-
scriptions.
• Enumeration List — a list of the manufacturer-specific extensions to extensible BACnet enumera-
tions that are defined and applicable for this specific device. In the case of the Local Device, there is
no need for editing. In client BacnetDevice components, however, editing items in the Enumeration
List may provide utility for proprietary items, perhaps property IDs.
About Active Cov Subscriptions
The NiagaraAX Bacnet driver provides “server-side Subscribe_COV” to remote BACnet devices (on
station objects exposed as BACnet objects). The Active Cov Subscriptions slot in the Local Device
contains a dynamic list of current Subscribe_COV subscriptions. Each appears as an Ord to the export
descriptor. Figure 4-24 shows an example with 3 active COV subscriptions.
Depending on the actual implementation, there may be many active COV subscriptions.
NiagaraAX-3.x
4-64
BACnet Guide
Chapter 4 – Niagara Bacnet Server Operation Local Device notes
February 26, 2008 Local Device backup and restore properties
Figure 4-25 Backup and restore related properties in AX-3.2 or later LocalBacnetDevice
NiagaraAX-3.x
4-65
BACnet Guide
Local Device notes Chapter 4 – Niagara Bacnet Server Operation
Local Device backup and restore properties February 26, 2008
NiagaraAX-3.x
4-66
BACnet Guide
CHAPTER 5
Bacnet Plugin Guides
Plugins provide views of components, and can be accessed many ways—for example, double-click a
component in the tree for its default view. In addition, you can right-click a component, and select from
its Views menu. For summary documentation on any view, select Help > On View (F1) from the
Workbench menu, or press F1 while the view is open.
Summary information is provided here about the different:
• Views in module bacnet
• Views in module bacnetws
NiagaraAX-3.x
5–67
BACnet Guide
Views in bacnet module Chapter 5 – Bacnet Plugin Guides
bacnet-BacnetFileExportManager February 26, 2008
bacnet-BacnetFileExportManager
The BacnetFileExportManager is one view of the BacnetExportTable under the LocalBacnetDevice.
You use it to export files as Bacnet Files. To view, under the LocalBacnetDevice, right-click BacnetExport-
Table (Export Table) and select Views > Bacnet File Export Manager. For more details,
see “Bacnet File Export Manager” on page 4-55.
bacnet-BacnetHistoryImportManager
Use the BacnetHistoryImportManager to import Bacnet Trend Logs under a BacnetDevice as Niagara
histories. The BacnetHistoryImportManager is the default view for the BacnetHistoryDeviceExt (Trend
Logs container) under a BacnetDevice. To view, under a BacnetDevice right-click BacnetHistoryDevi-
ceExt and select Views > Bacnet History Import Manager. For more details, see “About the
Bacnet History Import Manager” on page 3-36.
bacnet-BacnetNiagaraLogExportManager
The BacnetNiagaraLogExportManager is one view of the BacnetExportTable under the LocalBacnet-
Device. You use it to export Niagara histories as Bacnet Trend Logs. To view, under the LocalBacnet-
Device, right-click BacnetExportTable (Export Table) and select Views > Bacnet Niagara Log
Export Manager. For more details, see “Bacnet Niagara Log Export Manager” on page 4-57.
bacnet-BacnetPointManager
Use the Bacnet Point Manager to query a BACnet device for its objects. In this view, you can create,
edit, access, and delete Bacnet proxy points. The BacnetPointManager is the default view for the Bacnet-
PointDeviceExt (Points container) under a BacnetDevice. The BacnetPointManager is also the default
view for any BacnetPointFolders under the Points container. To view, right-click BacnetPointDeviceExt
or BacnetPointFolder and select Views > Bacnet Point Manager. For more details, see “Bacnet
Point Manager” on page 3-24.
bacnet-BacnetScheduleExportManager
Use the BacnetScheduleExportManager to export Niagara schedules in the station as Bacnet
schedules to the target BacnetDevice. The BacnetScheduleExportManager is a view on the BacnetSched-
uleDeviceExt (Schedules container) under a BacnetDevice. To view, right-click BacnetScheduleDevi-
ceExt and select Views > Bacnet Schedule Export Manager. For more details, see “About the
Bacnet Schedule Export Manager” on page 3-33.
bacnet-BacnetScheduleImportManager
The BacnetScheduleImportManager is the default view on the BacnetScheduleDeviceExt
(Schedules container) under a BacnetDevice. Use the BacnetScheduleImportManager to import
Bacnet schedules residing in the target BacnetDevice (as Niagara schedules in the station). To view, right-
click BacnetScheduleDeviceExt and select Views > Bacnet Schedule Import Manager. For
more details, see “About the Bacnet Schedule Import Manager” on page 3-32.
bacnet-BacnetVirtualPropertyView
This is the default view on a BacnetVirtualProperty under a BacnetVirtualObject (AX-3.3 and later
only). It simply shows the combined value and poll status of the virtual property component. For more
details, see “About BacnetVirtualProperties (AX-3.3 and later)” on page 3-41.
bacnet-BdtManager
The BdtManager (Broadcast Distribution Table, or BDT) is the default view of the BroadcastDistribu-
tionTable under the Link container of an IpPort (BacnetIpLinkLayer). When the station is operating as a
BBMD, Niagara maintains this table listing all other participating BBMDs, including their IP address and
broadcast distribution masks. If necessary, this view allows you to manually edit the BDT.
bacnet-FdtManager
The FdtManager (Foreign Device Table, or FDT) is the default view of the ForeignDeviceTable under
the Link container of an IpPort (BacnetIpLinkLayer). When the station is operating as a (BACnet)
“foreign device,” this table lists all other BACnet foreign devices that have registered with Niagara,
including their IP address, time to live, and purge time. This view allows you to manually edit the FDT, if
necessary, to support devices that cannot register themselves.
NiagaraAX-3.x
5-68
BACnet Guide
Chapter 5 – Bacnet Plugin Guides Views in bacnetws module
February 26, 2008 bacnet-BacnetWsDeviceManager
NiagaraAX-3.x
5-69
BACnet Guide
Views in bacnetws module Chapter 5 – Bacnet Plugin Guides
bacnet-BacnetWsDeviceManager February 26, 2008
NiagaraAX-3.x
5-70
BACnet Guide
CHAPTER 6
Bacnet Component Guides
These Component Guides provide summary information about:
• bacnet module components
• bacnetws module components
NiagaraAX-3.x
6–71
BACnet Guide
Components in bacnet module Chapter 6 – Bacnet Component Guides
bacnet-BacnetAnalogInput February 26, 2008
• BacnetListOf
• BacnetIpLinkLayer
• BacnetLoopDescriptor
• BacnetMstpLinkLayer
• BacnetMultiPoll
• BacnetMultistateInput
• BacnetMultiStateInputDescriptor
• BacnetMultistateOutput
• BacnetMultiStateOutputDescriptor
• BacnetMultistateValue
• BacnetMultiStateValueDescriptor
• BacnetMultiStateValuePrioritizedDescriptor
• BacnetNetwork
• BacnetNetworkLayer
• BacnetNiagaraHistoryDescriptor
• BacnetNotificationClass
• BacnetNotificationClassDescriptor
• BacnetNumericCovTrendLogExt
• BacnetNumericIntervalTrendLogExt
• BacnetNumericScheduleDescriptor
• BacnetPoll
• BacnetPointDeviceExt
• BacnetPointFolder
• BacnetRouterTable
• BacnetSchedule
• BacnetScheduleDeviceExt
• BacnetScheduleExport
• BacnetScheduleImportExt
• BacnetStack
• BacnetStringCovTrendLogExt
• BacnetStringIntervalTrendLogExt
• BacnetStringProxyExt
• BacnetStringScheduleDescriptor
• BacnetTransportLayer
• BacnetTrendLog
• BacnetTrendLogDescriptor
• BacnetTrendLogAlarmSourceExt
• BacnetTuningPolicy
• BacnetTuningPolicyMap
• BacnetVirtualComponent
• BacnetVirtualGateway
• BacnetVirtualObject
• BacnetVirtualProperty
• BacnetWorker
• BroadcastDistributionTable
• ForeignDeviceTable
• LocalBacnetDevice
• NetworkPort
bacnet-BacnetAnalogInput
A Config object that represents a BACnet Analog Input object in its entirety. For more details, see
“About Bacnet Config objects” on page 3-23.
bacnet-BacnetAnalogInputDescriptor
BacnetAnalogInputDescriptor exposes a numeric-type component as a BACnet Analog Input
object. You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and
access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetAnalogOutput
A Config object that represents a BACnet Analog Output object in its entirety. For more details, see
“About Bacnet Config objects” on page 3-23.
NiagaraAX-3.x
6-72
BACnet Guide
Chapter 6 – Bacnet Component Guides Components in bacnet module
February 26, 2008 bacnet-BacnetAnalogOutputDescriptor
bacnet-BacnetAnalogOutputDescriptor
BacnetAnalogOutputDescriptor exposes a NumericWritable as a BACnet Analog Output object.
You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and access
exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetAnalogValue
A Config object that represents a BACnet Analog Value object in its entirety. For more details, see
“About Bacnet Config objects” on page 3-23.
bacnet-BacnetAnalogValueDescriptor
BacnetAnalogValueDescriptor exposes a numeric-type component as a BACnet Analog Value
object (non-commandable). You use the Bacnet Export Manager view of the BacnetExportTable to
add, edit, delete, and access exported components. For more details, see “About export descriptors” on
page 4-48.
bacnet-BacnetAnalogValuePrioritizedDescriptor
BacnetAnalogValuePrioritizedDescriptor exposes a NumericWritable as a writable (commandable)
Bacnet Analog Value object. You use the Bacnet Export Manager view of the BacnetExportTable to
add, edit, delete, and access exported components. For more details, see “About export descriptors” on
page 4-48.
bacnet-BacnetArray
BacnetArray represents a Bacnet Array, which contains an indexed sequence of objects of a
particular Bacnet data type. The BacnetArray is available in the bacnet module.
bacnet-BacnetBinaryInput
A Config object that represents a BACnet Binary Input object in its entirety. For more details, see
“About Bacnet Config objects” on page 3-23.
bacnet-BacnetBinaryInputDescriptor
BacnetBinaryInputDescriptor exposes a boolean-type component as a BACnet Binary Input object.
You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and access
exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetBinaryOutput
A Config object that represents a BACnet Binary Output object in its entirety. For more details, see
“About Bacnet Config objects” on page 3-23.
bacnet-BacnetBinaryOutputDescriptor
BacnetBinaryOutputDescriptor exposes a BooleanWritable as a BACnet Binary Output object. You
use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and access
exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetBinaryValue
A Config object that represents a BACnet Binary Value object in its entirety. For more details, see
“About Bacnet Config objects” on page 3-23.
bacnet-BacnetBinaryValueDescriptor
BacnetBinaryValueDescriptor exposes boolean-type component as a BACnet Binary Value object
(non-commandable). You use the Bacnet Export Manager view of the BacnetExportTable to add,
edit, delete, and access exported components. For more details, see “About export descriptors” on page
4-48.
bacnet-BacnetBinaryValuePrioritizedDescriptor
BacnetBinaryValuePrioritizedDescriptor exposes a BooleanWritable as a writable (commandable)
BACnet Binary Value object. You use the Bacnet Export Manager view of the BacnetExportTable to
add, edit, delete, and access exported components. For more details, see “About export descriptors” on
page 4-48.
bacnet-BacnetBooleanCovTrendLogExt
An extension for collecting a Niagara history for the StatusBoolean out value of a component, using
COV. Unlike when using the equivalent “standard” history extension (BooleanCOVHistoryExt), the
history created by this extension can be exported as a fully-compliant BACnet Trend Log object. For
more details, see “About BacnetTrendLogExt extensions” on page 4-58.
NiagaraAX-3.x
6-73
BACnet Guide
Components in bacnet module Chapter 6 – Bacnet Component Guides
bacnet-BacnetBooleanIntervalTrendLogExt February 26, 2008
bacnet-BacnetBooleanIntervalTrendLogExt
An extension for collecting a Niagara history for the StatusBoolean out value of a component, using
a defined interval. Unlike when using the equivalent “standard” history extension (BooleanInterval-
HistoryExt), the history created by this extension can be exported as a fully-compliant BACnet Trend Log
object. For more details, see “About BacnetTrendLogExt extensions” on page 4-58.
bacnet-BacnetBooleanProxyExt
This BacnetProxyExt maps a BACnet boolean value to a BooleanPoint or BooleanWritable.
bacnet-BacnetBooleanScheduleDescriptor
BacnetBooleanScheduleDescriptor exposes a Niagara BooleanSchedule as a BACnet Schedule
object. You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and
access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetCalendar
Tridium Client Application Layer Implementation. BacnetCalendar represents the client side of the
application layer of the Bacnet communications stack. The BacnetCalendar is available in the bacnet
module.
bacnet-BacnetCalendarDescriptor
BacnetCalendarDescriptor exposes a Niagara CalendarSchedule to BACnet as a Calendar
object.You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and
access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetClientLayer
BacnetClientLayer (Client) represents the client side of the application layer of the Bacnet commu-
nications stack. Client resides under the BacnetStack (Bacnet Comm) of a BacnetNetwork, and has
no available properties.
bacnet-BacnetConfigDeviceExt
BacnetConfigDeviceExt (Config device extension) is a frozen device extension under every Bacnet-
Device. It functions as the container for any config-type objects, which represent individual BACnet
objects in the device. By default, it contains a BacnetDeviceObject for the device’s sole BACnet Device
object.
For more details, see “About the Config Device Ext container” on page 3-22.
bacnet-BacnetConfigFolder
BacnetConfigFolder is the implementation of a folder under a BacnetConfigDeviceExt (Config).
Typically, you add such folders using the New Folder button in the BacnetConfigManager view of
the Config container. Each BacnetConfigFolder has its own BacnetConfigManager view.
bacnet-BacnetDestination
BacnetDestination represents a BACnet device that is to receive alarms from Niagara, as a type of
alarm recipient. It resides with standard alarm recipients and alarm classes under the station’s
AlarmService. The BacnetDestination is available in the bacnet module Alarming folder.
bacnet-BacnetDevice
BacnetDevice is a Niagara representation of a remote BACnet device. Each BacnetDevice resides
under the station’s BacnetNetwork. Each BacnetDevice contains a full complement of device exten-
sions (containers), including Points, Schedules, and Trend Logs (Histories), for modeling data (from that
device) in the station. For more details, see “Bacnet Device components” on page 3-21, “About Bacnet
Device’s Schedules” on page 3-31, and “About Bacnet Trend Logs (Histories)” on page 3-36.
bacnet-BacnetDeviceFolder
BacnetDeviceFolder is the Bacnet implementation of a folder under a BacnetNetwork. Typically, you
add such folders using the New Folder button in the BacnetDeviceManager view of the Bacnet-
Network. Each BacnetDeviceFolder has its own BacnetPointManager view. The BacnetDeviceFolder is
also available in the bacnet palette.
bacnet-BacnetDeviceObject
BacnetDeviceObject is a config object that contains all the properties of a BACnet Device object as
defined by the BACnet specification. Properties such as the device address, which are not BACnet
Device properties, but which are associated with this device, are contained directly in this object. By
default, the BacnetDeviceObject is available in the BacnetConfigDeviceExt.
See “About the Config Device Ext container” on page 3-22 for related details.
NiagaraAX-3.x
6-74
BACnet Guide
Chapter 6 – Bacnet Component Guides Components in bacnet module
February 26, 2008 bacnet-BacnetEnumCovTrendLogExt
bacnet-BacnetEnumCovTrendLogExt
An extension for collecting a Niagara history for the StatusEnum out value of a component, using
COV. Unlike when using the equivalent “standard” history extension (EnumCovHistoryExt), the
history created by this extension can be exported as a fully-compliant BACnet Trend Log object. For
more details, see “About BacnetTrendLogExt extensions” on page 4-58.
bacnet-BacnetEnumIntervalTrendLogExt
An extension for collecting a Niagara history for the StatusEnum out value of a component, using a
defined interval. Unlike when using the equivalent “standard” history extension (EnumIntervalHis-
toryExt), the history created by this extension can be exported as a fully-compliant BACnet Trend Log
object. For more details, see “About BacnetTrendLogExt extensions” on page 4-58.
bacnet-BacnetEnumProxyExt
This BacnetProxyExt handles multistate values in a BACnet device, and maps enumerated values in
the device to the parent EnumPoint or EnumWritable.
bacnet-BacnetEnumScheduleDescriptor
BacnetEnumScheduleDescriptor exposes a Niagara EnumSchedule to BACnet as a Schedule object.
You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and access
exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetEthernetLinkLayer
Tridium Bacnet Ethernet virtual link layer implementation. The BacnetEthernetLinkLayer is
available under the BACnetComm, NetworkPorts folder of the bacnet palette.
bacnet-BacnetEventHandler
BacnetEventHandler processes event notification messages, and the acknowledgement of those
messages, including ConfirmedEventNotification, UnconfirmedEventNotification, and Acknowl-
edgeAlarm. It is a frozen container slot of the BacnetServerLayer (Server under Bacnet Comm).
bacnet-BacnetExportFolder
BacnetExportFolder is the implementation of a folder to use under the LocalBacnetDevice’s Bacne-
tExportTable to organize Bacnet server descriptors. Typically, you add such folders using the New
Folder button in the different manager views of the BacnetExportTable, namely the BacnetExport-
Manager, BacnetFileExportManager, and BacnetNiagaraLogExportManager.
Each BacnetExportFolder provides the same set of export manager views. The BacnetExportFolder is also
available in the bacnet palette.
bacnet-BacnetExportTable
The Export Table is a frozen slot under the LocalBacnetDevice, and contains all the server (export)
descriptors that expose station objects as BACnet objects. You use the different export manager
views of the Export Table to export station objects. For more details, see “Bacnet server configuration
overview” on page 4-47.
bacnet-BacnetFile
A Config object that represents a BACnet File object. For more details, see “About Bacnet Config
objects” on page 3-23.
bacnet-BacnetFileDescriptor
BacnetFileDescriptor exposes a file under the station’s folder as a BACnet File object. You use the
Bacnet File Export Manager view of the BacnetExportTable to add, edit, delete, and access exported
files. For more details, see “About file descriptors” on page 4-48.
All files in Niagara are accessed using the STREAM_ACCESS method.
bacnet-BacnetHistoryDeviceExt
BacnetHistoryDeviceExt (Trend Logs) is a frozen device extension under every BacnetDevice,
and the container for BacnetHistoryImport components. The default view is the Bacnet History
Import Manager, used to import data from Trend Log objects in the device, into the station as Niagara
histories. For more details, see “About Bacnet Trend Logs (Histories)” on page 3-36.
NiagaraAX-3.x
6-75
BACnet Guide
Components in bacnet module Chapter 6 – Bacnet Component Guides
bacnet-BacnetHistoryImport February 26, 2008
bacnet-BacnetHistoryImport
BacnetHistoryImport defines the archive action to retrieve data from a BACnet Trend Log object
into a Niagara history created by the addition of this component. You add BacnetHistoryImports
(import Trend Logs) using the Bacnet History Import Manager view of the parent BacnetHistoryDevi-
ceExt. For more details, see “BACnet Trend Log import notes” on page 3-37 and “BacnetHistoryImport
properties” on page 3-39.
bacnet-BacnetIpLinkLayer
The Bacnet IP virtual link layer implementation,it appears as the Link node under an IpPort
NetworkPort child of the BacnetComm, BacnetNetworkLayer. This Link container contains
properties specifying a number of items, including Ethernet adapter, IP address, UDP port, IP device
type, BBMD address, and registration lifetime.
This Link node is also the parent container for the BroadcastDistributionTable and ForeignDeviceTable.
For more details, see “About Bacnet Comm: Network: Ip Port” on page 3-13.
bacnet-BacnetListOf
BacnetListOf represents a Bacnet ListOf sequence, which contains a non-indexed sequence of
objects of a particular Bacnet data type. The BacnetListOf is available in the bacnet module.
bacnet-BacnetLoopDescriptor
BacnetLoopDescriptor exposes a kitControl LoopPoint to BACnet as a Loop object. You use the
Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and access exported
components. For more details, see “About export descriptors” on page 4-48.
bacnet-MstpLinkLayer
Tridium Bacnet MS/TP virtual link layer implementation. The BacnetMstpLinkLayer is available
under the BACnetComm, NetworkPorts folder of the bacnet palette.
bacnet-BacnetMultiPoll
BacnetMultiPoll is used to configure and manage a group of Bacnet proxy points to be polled. The
BacnetMultiPoll provides a flexible polling algorthim based on four “buckets.”
Each pollable proxy point assigned to a BacnetMultiPoll is configured in one of three buckets: fast,
normal, or slow. In addition there is a fourth bucket called the “dibs stack.” Whenever a point is
subscribed it immediately gets “first dibs” and goes on the top of the dibs stack. The poll scheduler always
polls the dibs before doing anything else. The dibs stack is polled last-in, first-out (LIFO). As long as
entries are in the dibs stack they are polled as fast as possible with no artificial delays.
When the dibs stack is empty the scheduler attempts to poll the components in each bucket using an
algorthim designed to create uniform network traffic. For example if the fast rate is configured to 5000ms
and there are 5 components currently subscribed in the fast bucket, then the scheduler will attempt to
poll each component with a second to delay.
Every ten seconds the poll scheduler rechecks the buckets for configuration changes. So if a point’s
configuration is changed from slow to fast, it takes at most ten seconds for the change to take effect.
Statistics are also updated every ten seconds. Statistics may be manually reset using the resetStatistics
action.
For additional details, see “About poll components” in the Drivers Guide.
bacnet-BacnetMultistateInput
A Config object that represents a BACnet Multi-state Input object. For more details, see “About
Bacnet Config objects” on page 3-23.
bacnet-BacnetMultiStateInputDescriptor
BacnetMultistateInputDescriptor exposes an EnumPoint as a BACnet Multi-state Input object. You
use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and access
exported components. For more details, see “About export descriptors” on page 4-48
bacnet-BacnetMultistateOutput
A Config object that represents a BACnet Multi-state Output object. For more details, see “About
Bacnet Config objects” on page 3-23.
bacnet-BacnetMultiStateOutputDescriptor
BacnetMultiStateOutputDescriptor exposes an EnumWritable as BACnet Multi-state Output
object. You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and
access exported components. For more details, see “About export descriptors” on page 4-48
NiagaraAX-3.x
6-76
BACnet Guide
Chapter 6 – Bacnet Component Guides Components in bacnet module
February 26, 2008 bacnet-BacnetMultistateValue
bacnet-BacnetMultistateValue
A Config object that represents a BACnet Multi-state Value object. For more details, see “About
Bacnet Config objects” on page 3-23.
bacnet-BacnetMultiStateValueDescriptor
BacnetMultiStateValueDescriptor exposes an EnumPoint as BACnet Multi-state Value object (non-
commandable). You use the Bacnet Export Manager view of the BacnetExportTable to add, edit,
delete, and access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetMultiStateValuePrioritizedDescriptor
BacnetMultiStateValuePrioritizedDescriptor exposes an EnumWritable as a writable
(commandable) BACnet Multi-state Value object. You use the Bacnet Export Manager view of the
BacnetExportTable to add, edit, delete, and access exported components. For more details, see “About
export descriptors” on page 4-48.
bacnet-BacnetNetwork
BacnetNetwork is the base container for all Bacnet components in the station. In addition to being
the network container for BacnetDevices and their child data objects (Bacnet proxy points), it
contains the station’s BACnet communications protocol stack (Bacnet Comm), plus a Local Bacnet
Device, which configures the station’s representation as a BACnet device.
Note: Only one BacnetNetwork component is supported in any station, regardless of how many different BACnet
link-layer protocols are being used.
As with other NiagaraAX driver networks, the BacnetNetwork should reside under the station’s Drivers
container. For general information, see “Niagara Bacnet Client Concepts” on page 3-11.
The default view of the BacnetNetwork is the Bacnet Device Manager.
bacnet-BacnetNetworkLayer
BacnetNetworkLayer represents the generic superclass for all network layer implementations. In
practical terms, it is the container for all network ports, plus the BacnetRouterTable. The BacnetNet-
workLayer resides under the BacnetStack (Bacnet Comm) of a BacnetNetwork or BacnetWsNetwork.
bacnet-BacnetNiagaraHistoryDescriptor
BacnetNiagaraHistoryDescriptor is the server log descriptor that exposes a standard Niagara
history to BACnet as a Trend Log object, supporting only “by time” or “by index” requests for the
trend log data. You use the Bacnet Niagara Log Export Manager view of the BacnetExportTable to add,
edit, delete, and access these descriptors.
Alternatively, you can add one of several BacnetTrendLogExt (specialized history extension) to a point—
this creates another type of log descriptor. For more details, see “About log descriptors” on page 4-49.
bacnet-BacnetNotificationClass
A Config object that represents a BACnet Notification Class object. For more details, see “About
Bacnet Config objects” on page 3-23.
bacnet-BacnetNotificationClassDescriptor
This export descriptor allows a station’s AlarmClass to be exposed to BACnet as a Notification Class
object. You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and
access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetNumericCovTrendLogExt
An extension for collecting a Niagara history for the StatusNumeric out value of a component, using
COV. Unlike when using the equivalent “standard” history extension (NumericCovHistoryExt), the
history created by this extension can be exported as a fully-compliant BACnet Trend Log object. For
more details, see “About BacnetTrendLogExt extensions” on page 4-58.
bacnet-BacnetNumericIntervalTrendLogExt
An extension for collecting a Niagara history for the StatusNumeric out value of a component, using
a defined interval. Unlike when using the equivalent “standard” history extension (NumericInterval-
HistoryExt), the history created by this extension can be exported as a fully-compliant BACnet Trend Log
object. For more details, see “About BacnetTrendLogExt extensions” on page 4-58.
NiagaraAX-3.x
6-77
BACnet Guide
Components in bacnet module Chapter 6 – Bacnet Component Guides
bacnet-BacnetNumericScheduleDescriptor February 26, 2008
bacnet-BacnetNumericScheduleDescriptor
BacnetNumericScheduleDescriptor exposes a Niagara NumericSchedule to BACnet as a Schedule
object. In the bacnet palette, it appears under the Server folder as ServerNumSchedDesc.
However, you typically use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete,
and access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetPoll
BacnetPoll is used to configure and manage a group of Bacnet proxy points to be polled. The
BacnetPoll provides a flexible polling algorthim based on four “buckets.”
Each pollable proxy point assigned to a BacnetPoll is configured in one of three buckets: fast, normal, or
slow. In addition there is a fourth bucket called the “dibs stack.” Whenever a point is subscribed it
immediately gets “first dibs” and goes on the top of the dibs stack. The poll scheduler always polls the dibs
before doing anything else. The dibs stack is polled last-in, first-out (LIFO). As long as entries are in the
dibs stack they are polled as fast as possible with no artificial delays.
When the dibs stack is empty the scheduler attempts to poll the components in each bucket using an
algorthim designed to create uniform network traffic. For example if the fast rate is configured to 5000ms
and there are 5 components currently subscribed in the fast bucket, then the scheduler will attempt to
poll each component with a second to delay.
Every ten seconds the poll scheduler rechecks the buckets for configuration changes. So if a point’s
configuration is changed from slow to fast, it takes at most ten seconds for the change to take effect.
Statistics are also updated every ten seconds. Statistics may be manually reset using the resetStatistics
action.
For additional details, see “About poll components” in the Drivers Guide.
bacnet-BacnetPointDeviceExt
BacnetPointDeviceExt (Points) is the Bacnet implementation of PointDeviceExt, a frozen device
extension under every BacnetDevice. Its primary view is the BacnetPointManager. For more details,
see “Bacnet Point Manager” on page 3-24.
bacnet-BacnetPointFolder
BacnetPointFolder is the Bacnet implementation of a folder under a BacnetDevice’s Points
container (BacnetPointDeviceExt). You add such folders using the New Folder button in the
BacnetPointManager view of the Points component. Each BacnetPointFolder has its own BacnetPoint-
Manager view. The BacnetPointFolder is also available in the bacnet palette.
bacnet-BacnetRouterTable
BacnetRouterTable stores the table of known routers to BACnet networks. In the station, the Bacne-
tRouterTable is under the BacnetNetwork’s Bacnet Comm, Network component. For more details,
see “About Bacnet Comm: Network: Router Table” on page 3-13.
bacnet-BacnetSchedule
A Config object that represents a BACnet Schedule object. For more details, see “About Bacnet
Config objects” on page 3-23.
bacnet-BacnetScheduleDeviceExt
BacnetScheduleDeviceExt (Schedules) is the container for BACnet schedules under a Bacnet-
Device. Its default view is the BacnetScheduleImportManager. Another view is the BacnetSchedule-
ExportManager, to allow writing Niagara schedule configuration into a device’s BACnet schedule. For
details, see “About Bacnet Device’s Schedules” on page 3-31.
bacnet-BacnetScheduleExport
BacnetScheduleExport is used to export the configuration of a Niagara schedule or calendar into a
specific Schedule or Calendar object in a BACnet device. The schedule in the remote BACnet device
is the “subordinate,” and Niagara will periodically synchronize the values by writing its local values to the
remote device using WriteProperty service requests. You add BacnetScheduleExports using the Bacnet
Schedule Export Manager view. For details, see “About the Bacnet Schedule Export Manager” on page 3-
33.
NiagaraAX-3.x
6-78
BACnet Guide
Chapter 6 – Bacnet Component Guides Components in bacnet module
February 26, 2008 bacnet-BacnetScheduleImportExt
bacnet-BacnetScheduleImportExt
BacnetScheduleImportExt is a child extension of a schedule that is being imported from a BACnet
device. The schedule in the remote BACnet device is the “master,” and Niagara will periodically
synchronize its local copy by reading the appropriate values. You add BacnetScheduleImportExts using
the Bacnet Schedule Import Manager view. For details, see “About the Bacnet Schedule Import Manager”
on page 3-32.
bacnet-BacnetServerLayer
BacnetServerLayer (Server) represents the server side of the application layer of the BACnet
communications stack. It is the container for the BacnetWorker and BacnetEventHandler. Bacnet-
ServerLayer resides under the BacnetStack (Bacnet Comm) of a BacnetNetwork or BacnetWsNetwork.
See “About Bacnet Comm: Client, Server, and Transport” on page 3-15 for related details.
bacnet-BacnetStack
BacnetStack (Bacnet Comm) provides the protocol stack for BACnet communications for a
BacnetNetwork, and is a frozen child container slot of the network. In turn, it has child frozen
container slots BacnetClientLayer, BacnetServerLayer, BacnetTransportLayer, and BacnetNet-
workLayer. For more details, see “About Bacnet Comm” on page 3-12.
bacnet-BacnetStringCovTrendLogExt
An extension for collecting a Niagara history for the StatusString out value of a component, using
COV. Unlike when using the equivalent “standard” history extension (StringIntervalHistoryExt), the
history created by this extension can be exported as a fully-compliant BACnet Trend Log object. For
more details, see “About BacnetTrendLogExt extensions” on page 4-58.
bacnet-BacnetStringIntervalTrendLogExt
An extension for collecting a Niagara history for the StatusString out value of a component, using a
defined interval. Unlike when using the equivalent “standard” history extension (StringIntervalHis-
toryExt), the history created by this extension can be exported as a fully-compliant BACnet Trend Log
object. For more details, see “About BacnetTrendLogExt extensions” on page 4-58.
bacnet-BacnetStringProxyExt
The BacnetProxyExt that handles the point configuration of a point of generic type in a BACnet
device. It is the default for types NULL, OCTET_STRING, CHARACTER_STRING, BIT_STRING,
DATE, TIME, and OBJECT_IDENTIFIER.
bacnet-BacnetStringScheduleDescriptor
BacnetStringScheduleDescriptor exposes a Niagara StringSchedule to BACnet as a Schedule
object. You use the Bacnet Export Manager view of the BacnetExportTable to add, edit, delete, and
access exported components. For more details, see “About export descriptors” on page 4-48.
bacnet-BacnetTransportLayer
BacnetTransportLayer (Transport) is the Tridium Transport Layer implementation. Transport
resides under the BacnetStack (Bacnet Comm) of a BacnetNetwork or BacnetWsNetwork, and
contains properties that typically do not require adjustment.
bacnet-BacnetTrendLog
BacnetTrendLog is a Config object that provides the configuration of a Trend Log object in a
BACnet device (to access its log data, you must import that Trend Log under the Trend Logs
extension of that BacnetDevice). For more details, see “About Bacnet Config objects” on page 3-23.
bacnet-BacnetTrendLogDescriptor
BacnetTrendLogDescriptor is the server descriptor that exposes a Niagara history created with a
BacnetTrendLogExt as a BACnet Trend Log object. These descriptors are automatically created in
the root of the BacnetExportTable when you copy one of the various BacnetTrendLogExt extensions into
a component. For related details, see “About BacnetTrendLogExt extensions” on page 4-58.
Note: Unlike a history exported with a BacnetNiagaraHistoryDescriptor (created by a “standard” Niagara
history extension), a history exported by a BacnetTrendLogDescriptor appears as a fully BACnet-
compliant Trend Log object. This means that it supports “by sequence number” requests in addition to “by
time” requests from external BACnet devices.
NiagaraAX-3.x
6-79
BACnet Guide
Components in bacnet module Chapter 6 – Bacnet Component Guides
bacnet-BacnetTrendLogAlarmSourceExt February 26, 2008
bacnet-BacnetTrendLogAlarmSourceExt
BacnetTrendLogAlarmSourceExt defines the intrinsic alarming/notification for a server-side Trend
Log object exposed to BACnet. If needed, you paste it as a child of any of the BacnetTrendLogExt
type extensions under the source Niagara component. It is found in the bacnet palette, under the
Trending, BACnetLogExtensions folder.
bacnet-BacnetTuningPolicy
A tuning policy for the BacnetNetwork, with both standard NiagaraAX tuning policy properties, and
additional properties related to client-side usage of the BACnet Subscribe_COV service.
For an explanation of driver tuning policies, refer to “About Tuning Policies” in the Drivers Guide. For
details specific to Bacnet, see “Bacnet Tuning Policy notes” on page 3-18.
bacnet-BacnetTuningPolicyMap
A container for one or more BacnetTuningPolicy(ies). Typically, you create multiple tuning policies
and assign Bacnet proxy points as needed, based upon the different BacnetComm, Network, port used
(Ip Port, Ethernet Port, Mstp Port).
Note: Each Bacnet network port has its own PollService, including 3 different poll rates (Fast, Normal, Slow).
This varies from other driver networks, where a single PollService is used.
For an explanation of driver tuning policies, refer to “About Tuning Policies” in the Drivers Guide. For
details specific to Bacnet, see “Bacnet Tuning Policy notes” on page 3-18.
bacnet-BacnetVirtualComponent
A BacnetVirtualComponent is the AX-3.2 BACnet driver implementation of a Baja “virtual point”,
where each BacnetVirtualComponent represents a BACnet object. You find these by expanding the
property sheet of the BacnetVirtualGateway under each BacnetDevice and BacnetWsDevice. The
property sheet of each BacnetVirtualComponent provides dynamic property values of that object.
Virtual components reside in the station’s “virtual component space,” and are not persisted in the
station’s database in its component space (Config), like regular components. For a general explanation
about Baja virtual components, refer to “About virtual component spaces” in the Drivers Guide.
Note: AX-3.2 or higher is required for virtual components. Starting in AX-3.3, the BACnet design for virtual
points changed such that BacnetVirtualComponents are replaced by BacnetVirtualObject components,
each with BacnetVirtualProperty components.
BacnetVirtualComponents can provide basic monitor access in Px views, or be used for one-off” read/
write access to configuration properties. For details, see “About Bacnet virtual points” on page 3-40.
bacnet-BacnetVirtualGateway
(AX-3.2 or later) The BacnetVirtualGateway is the Bacnet driver implementation of the Baja Virtual
Gateway. A virtual gateway is a component that resides under the station’s component space (Config),
and acts as a gateway to the station’s “virtual component space.” Note other object spaces are Files and
History. For a general explanation about Baja virtual components, refer to “About virtual component
spaces” in the Drivers Guide.
Starting in AX-3.2, each BacnetDevice and BacnetWsDevice has its own BacnetVirtualGateway, at the
same level as its device extensions (Points, Schedules, and so on). Accessing components under the
gateway dynamically adds them as “virtual points” while they are subscribed, but they exist only in
memory (are not persisted in the station database like proxy points). When virtual points become unsub-
scribed, they are automatically cleaned up from the station database.
The “virtual point” level under a BacnetVirtualGateway varies as follows:
• In AX-3.3 and later, expanding a BacnetVirtualGateway results in that device’s BACnet objects to be
listed underneath. Each is a BacnetVirtualObject that contains a number of BacnetVirtualProperty
components to represent its properties. Thus, virtual points are at the “object, property level.”
• In AX-3.2 (only), expanding a BacnetVirtualGateway results in that device’s BACnet objects to be
listed underneath as BacnetVirtualComponent components, where each has a property sheet that
shows all the values for the BACnet object’s properties. Thus, virtual points are at the “object level.”
For more details, see “About Bacnet virtual points” on page 3-40.
bacnet-BacnetVirtualObject
A BacnetVirtualObject is the AX-3.3 and later Bacnet driver implementation of the container for
Baja “virtual points”, where each BacnetVirtualObject represents a BACnet object. Find them by
expanding the BacnetVirtualGateway under each BacnetDevice and BacnetWsDevice. Each BacnetVir-
NiagaraAX-3.x
6-80
BACnet Guide
Chapter 6 – Bacnet Component Guides Components in bacnetws module
February 26, 2008 bacnet-BacnetVirtualProperty
NiagaraAX-3.x
6-81
BACnet Guide
Components in bacnetws module Chapter 6 – Bacnet Component Guides
bacnetws-BacnetWsClientLayer February 26, 2008
bacnetws-BacnetWsClientLayer
BacnetWsClientLayer (Client) represents the client side of the application layer of the Bacnet
communications stack. Client resides under the BacnetWsStack (Bacnet Comm) of a BacnetWs-
Network, and has no available properties.
bacnetws-BacnetWsDevice
BacnetWsDevice is a Niagara representation of a remote BACnet device in the BacnetWsNetwork
of a BACnet Supervisor station. Each BacnetWsDevice includes all the same properties and device
extensions (containers) of Points, Schedules, and Trend Logs (Histories) as does a regular BacnetDevice
component, for modeling data (from that device) in the station.
For more details, see “Bacnet Device components” on page 3-21, “About Bacnet Device’s Schedules” on
page 3-31, and “About Bacnet Trend Logs (Histories)” on page 3-36. Note that a BacnetWsDevice also
provides additional actions not available on a regular BacnetDevice, providing supervisory control
functions. These actions are: Comm Control, Reinitialize Device, Get Enrollment Summary, Get Event
Information. See “BacnetWsDevice additions” on page A-9 for related details.
bacnetws-BacnetWsNetwork
BacnetWsNetwork is the base container for all Bacnet components in a BACnet Supervisor station
(used instead of a BacnetNetwork). In addition to being the network container for BacnetWsDevices
and/or BacnetDevices and their child data objects (Bacnet proxy points), it contains the station’s BACnet
communications protocol stack (Bacnet Comm), plus a LocalBacnetWsDevice, which configures the
station’s representation as a BACnet device.
Note: Only one BacnetWsNetwork/BacnetNetwork component is supported in any station, regardless of how
many different BACnet link-layer protocols are being used.
As with other NiagaraAX driver networks, the BacnetWsNetwork should reside under the station’s
Drivers container. For general information, see “Niagara Bacnet Client Concepts” on page 3-11.
The default view of the BacnetNetwork is the Bacnet Ws Device Manager. For more details, see
“BACnet Supervisor” on page A-1.
bacnetws-BacnetWsStack
BacnetWsStack (Bacnet Comm) provides the protocol stack for BACnet communications for a
BACnet Supervisor station, and is a frozen child container slot of its BacnetWsNetwork. In turn, it
has child frozen container slots BacnetClientLayer, BacnetServerLayer, BacnetTransportLayer, and
BacnetNetworkLayer. For more details, see “About Bacnet Comm” on page 3-12.
bacnetws-LocalBacnetWsDevice
LocalBacnetWsDevice (Local Device) is the representation of Niagara as a BACnet device on
the BACnet internetwork for a BACnet Supervisor, and is a frozen container of a BacnetWsNetwork.
The LocalBacnetWsDevice has all the same proprerties and components of a regular LocalBacnetDevice,
including a child BacnetExportTable container that provides server-side functions to export station
objects as BACnet objects and service BACnet client requests.
For related details, see “Bacnet Local Device” on page 3-17 and “Bacnet server configuration overview”
on page 4-47.
The LocalBacnetWsDevice also provides additional properties not available on a LocalBacnetDevice,
used in operation as a BACnet time-synch master. See “LocalBacnetWsDevice additions” on page A-9.
NiagaraAX-3.x
6-82
BACnet Guide
APPENDIX A
BACnet Supervisor
Available starting with AX-3.1, the BACnet Supervisor is a specially-licensed AxSupervisor that lets you
interact with BACnet devices from a supervisory standpoint, as described in the BACnet Specification
B-OWS device profile. The BACnet Supervisor includes all the same functionality as the regular
NiagaraAX BACnet driver, as described in other sections of this document.
This appendix describes the additional features and functionality specific to the BACnet Supervisor, and
has the following main sections:
• BACnet Supervisor overview
• Bacnet Ws Device Manager
• LocalBacnetWsDevice additions
• BacnetWsDevice additions
NiagaraAX-3.x
A–1
BACnet Guide
Bacnet Ws Device Manager Appendix A – BACnet Supervisor
Event Information February 26, 2008
You discover BACnet devices in this view the same as in the Bacnet Device Manager view. For
details, see “About Bacnet Device Find Parameters” on page 3-20.
When doing this, the Add dialog provides the same parameters for adding BacnetWsDevices as for
BacnetDevices. See “BacnetDevice properties” on page 3-22.
This device manager view of this BACnet Supervisor network provides several additional buttons in the
button bar. These correspond to additional functions that can be performed on BacnetWsDevices.
These additional buttons available in the Bacnet Ws Device Manager are:
• Events — See “Event Information” on page A-2.
• ESumm — See “Enrollment Summary” on page A-3.
• Comm Ctl — See “Communication Control” on page A-4.
• Reinit — See “Reinitialize Device” on page A-5.
• — See “Time Synchronization” on page A-5.
• Backup — (AX-3.2 only) See “Backup Device” on page A-6.
• Restore — (AX-3.2 only) See “Restore Device” on page A-7.
Event Information
This button in the Bacnet Ws Device Manager retrieves event information from the selected
device, requesting all outstanding events from the BACnet device. The purpose of this feature is that if
Niagara somehow missed receiving an event, you can still retrieve and acknowledge this event using the
Event Information service. For example, the Niagara station may not have been running at the time the
original event occurred.
If the GetEventInformation service is supported, this will be used to retrieve events. The events retrieved
in this manner contain enough information to generate a valid acknowledgment to the remote device.
These event summaries will be propagated to the Niagara Alarm Service through the alarm class assigned
in the eventSummaryAlarmClass property of the Event Handler.
Event Handler configuration is contained within the Server layer configuration, as shown in Figure A-2.
NiagaraAX-3.x
A-2
BACnet Guide
Appendix A – BACnet Supervisor Bacnet Ws Device Manager
February 26, 2008 Enrollment Summary
If the GetEventInformation service is not supported, but the GetAlarmSummary service is supported,
the events will be retrieved using GetAlarmSummary.
The GetAlarmSummary service retrieves only events with a Notify_Type of “alarm”, so events with a
Notify_Type of “event” are not retrieved.
Event summaries retrieved using GetAlarmSummary do not have enough information to generate a valid
acknowledgment, so they are not propagated to the Niagara Alarm Service. In this case, a dialog box is
presented to the user, such as shown in Figure A-3.
Enrollment Summary
This button in the Bacnet Ws Device Manager retreives a summary of all objects within the
device that match a set of filter criteria that you define. When you click the Enrollment Summary button,
a filter configuration dialog box is displayed, as shown in Figure A-4.
NiagaraAX-3.x
A-3
BACnet Guide
Bacnet Ws Device Manager Appendix A – BACnet Supervisor
Communication Control February 26, 2008
Here you configure the various options to define the specific types of objects you wish to locate, and then
click OK. The device is queried for a list of objects that meet the specified filter criteria, and the result is
displayed in a dialog box, as shown in Figure A-5.
Filter options include the following:
• Acknowledgement
Filter on points that are acknowledged, or unacknowledged, or leave the filter open to all points.
• Enrollment
Filter on only event mechanisms that have a specific recipient, definable either by device id or by de-
vice address.
• Event State
Specify a particular event state, to restrict the request to include only points that are currently in a
specific event state.
• Event Type
Restrict the filter to objects that use a particular event type algorithm.
• Priority
Choose to only include objects where the priority of the last transition is within certain bounds.
• Notification Class
Include only objects and event mechanisms where the notification class used to route the event no-
tifications is equal to a specific number.
Communication Control
This button in the Bacnet Ws Device Manager allows you to control a device’s ability to
generate traffic on the network. This could be useful in a diagnostic situation, where you want to tempo-
rarily eliminate all traffic except from a single device. Or you may have a faulty device that is sending
extraneous data, and you wish to "silence it" until you can identify the cause of the problem. When you
click this button, a dialog box appears which allows you to configure the request, as shown in Figure A-6.
NiagaraAX-3.x
A-4
BACnet Guide
Appendix A – BACnet Supervisor Bacnet Ws Device Manager
February 26, 2008 Reinitialize Device
Reinitialize Device
This button in the Bacnet Ws Device Manager allows you to restart a device. In the popup
dialog (Figure A-7), you may choose either “Cold Start” or “Warm Start.”
Note: The specific meaning of terms Cold Start and Warm Start is left up to the device’s manufacturer to define,
so make sure you understand exactly what each procedure entails for the device in question.
As shown above, this dialog has two fields:
• Reinitialize Command
Select either Warm Start (default) or Cold Start (see Note: above).
• Password
Enter the password required by the device to invoke this command. Some devices may not require
a password, so if you do not enter anything, no password is sent to the device.
When you click OK, the reinitialize request is sent to the device. The result is displayed in a dialog box,
as either a success or failure.
Time Synchronization
This button in the Bacnet Ws Device Manager is available only on the tool bar and the menu bar. It
allows you to send a one-time time synchronization message. When you click it, you are first asked to
confirm this action, as it will send the current station time to all controllers on the network. If you choose
Yes, you are presented with a dialog, shown in Figure A-8.
NiagaraAX-3.x
A-5
BACnet Guide
Bacnet Ws Device Manager Appendix A – BACnet Supervisor
Backup Device February 26, 2008
Backup Device
(AX-3.2 only) This button in the Bacnet Ws Device Manager allows you to backup the selected
device’s configuration, as one or more “restorable” files on the BACnet Supervisor PC. If needed, you can
use the Restore function later to reinstall this backup.
Note: The target device must support the BACnet DM-BR-B BIBB, as part of the B-BC device profile
conformance. In addition, the device may require a password before it initiates a backup or a restore.
Otherwise, a backup or restore job will immediately fail, showing the associated reason in the job log
details. For example, you may see “Unrecognized Service” or “Security: Password Failure”.
When you click Backup, the standard Directory Chooser appears, in which you specify the target
directory for the backup file(s). If needed, use the “new folder” control , as was done in the example
shown in Figure A-9 to make a “Bacnet” folder under the system “backups” folder.
After you choose the target directory, the Backup Device dialog appears, as shown in Figure A-10.
NiagaraAX-3.x
A-6
BACnet Guide
Appendix A – BACnet Supervisor Bacnet Ws Device Manager
February 26, 2008 Restore Device
When the job completes, it will post a success or failed status. A successful backup has the specified
device subdirectory under the target base directory, containing one or more backup files for the device.
Note: An invalid backup job typically fails immediately. However, a valid backup job may take several minutes
to complete, depending on the implementation in the target BACnet device. Typically, the device executes
some “preparation routine” first, before assembling and sending the backup files. In the case of AX-3.2 or
higher stations running the Bacnet driver, there is a set server routine as well as associated properties,
found in the LocalBacnetDevice of the BacnetNetwork. For more details, see “Local Device backup and
restore properties” on page 4-64.
Restore Device
(AX-3.2 only) This button in the Bacnet Ws Device Manager allows you to restore a previous
backup to the selected device, where a backup is one or more “restorable” files saved on the BACnet
Supervisor PC. See “Backup Device” on page A-6.
Note: The target device must support the BACnet DM-BR-B BIBB, as part of the B-BC device profile
conformance. In addition, you may require a device password to have it initiate a backup or a restore.
Otherwise, a backup or restore job will immediately fail, showing the associated reason in the job log
details. For example, you may see “Unrecognized Service” or “Security: Password Failure”.
When you click Restore, the standard Directory Chooser appears, in which you navigate to the
directory that contains the backup file(s), as shown in Figure A-12.
NiagaraAX-3.x
A-7
BACnet Guide
Bacnet Ws Device Manager Appendix A – BACnet Supervisor
Restore Device February 26, 2008
Figure A-12 Directory Chooser dialog to specify directory with backup file(s)
After you choose the source directory, the Restore Device dialog appears, as shown in Figure A-10.
When the job completes, it will post a success or failed status. Successful restores will install the backup
file(s) found in the source directory, and typically re-initialize (reboot) the device.
Note: An invalid restore job typically fails immediately. However, a valid restore job may take several minutes to
complete, depending on the implementation in the target BACnet device. Typically, the device executes
some “preparation routine” first, before accepting the backup files. In the case of AX-3.2 or higher stations
running the Bacnet driver, there is a set routine as well as associated properties, found in the LocalBacnet-
Device of the BacnetNetwork. For more details, see.
NiagaraAX-3.x
A-8
BACnet Guide
Appendix A – BACnet Supervisor LocalBacnetWsDevice additions
February 26, 2008 Restore Device
LocalBacnetWsDevice additions
The LocalBacnetWsDevice (Local Device) component represents the configuration of the
NiagaraAX station as it appears as a BACnet device on the BACnet network. It includes all the same child
slots, properties, and actions as the LocalBacnetDevice component in the Bacnet driver. For details, see
related sections in “Niagara Bacnet Server Operation” on page 4-47.
Each LocalBacnetWsDevice also has the following available additional properties, relating to operation
as the time-synch master:
• Time Syncronization Recipients
Contains the list of recipients for periodic Time Synchronization messages. You can add and remove
entries to this list using the addElement and removeElement actions. The entries in this list are
BacnetRecipients. They can be either a Device Object Identifier, or a BACnet Address.
• Time Synchronization Interval
Configures how frequently Niagara will send the time synchronization messages. The default value
is 24 hours.
• Align Interval
Specifies if the periodic time synchronization messages should be aligned to the beginning of the
next interval. For example, if Time Synchronization Interval is exactly 24 hours and Align Interval is
true, then the time synchronization messages will be sent out exactly at the beginning of the day, at
12:00 midnight.
• Interval Offset
Specifies an offset from the beginning of the interval at which to send the periodic time synchroni-
zation messages. If Align Interval is false, this property is ignored.
• Utc Time Syncronization Recipients
Contains the list of recipients for periodic UTC Time Synchronization messages. Works the same as
the Time Syncronization Recipients property, where you can add and remove entries to this list us-
ing the addElement and removeElement actions. The entries in this list are BacnetRecipients. They
can be either a Device Object Identifier, or a BACnet Address.
BacnetWsDevice additions
Each BacnetWsDevice component added using the Bacnet Ws Device Manager contains the same set of
child slots, properties, and actions as a BacnetDevice component. For details, see related sections in
“Niagara Bacnet Client Concepts” on page 3-11.
Each BacnetWsDevice also has the following available additional actions:
• Comm Control
Also available from the Bacnet Ws Device Manager. See “Communication Control” on page A-4.
• Reinitialize Device
Also available from the Bacnet Ws Device Manager. See “Reinitialize Device” on page A-5.
• Get Enrollment Summary
Also available from the Bacnet Ws Device Manager. See “Enrollment Summary” on page A-3.
• Get Event Information
Also available from the Bacnet Ws Device Manager. See “Event Information” on page A-2.
NiagaraAX-3.x
A-9
BACnet Guide
BacnetWsDevice additions Appendix A – BACnet Supervisor
Restore Device February 26, 2008
NiagaraAX-3.x
A-10
BACnet Guide