ORCAview Technical Reference Manual 340
ORCAview Technical Reference Manual 340
ORCAview Technical Reference Manual 340
ORCAview
Version 3.40 Technical Reference Manual
Front Matter
First Released as ORCAview 3.20 PDF files May 1, 2000 (Rev. 1.0)
First Printed as 3-Ring paper manual June, 2000 (Rev. 1.01)
Released as revised ORCAview 3.21 PDF files April 3, 2001 (Rev. 1.10)
Released as revised ORCAview 3.22 PDF files September 28, 2001 (Rev. 1.20)
Released as revised ORCAview Beta 3.30 PDF files September 23, 2003 (Rev. 1.30)
Released as revised ORCAview 3.30 PDF files May 1, 2004 (Rev. 1.30)
Released as revised ORCAview 3.30 Release 2 PDF files April 30, 2005 (Ed. 1.40)
Released as revised ORCAview 3.30 Release 3 PDF files September 30, 2005 (Ed. 1.50)
Released as revised ORCAview 3.33 Release 1 PDF files May 3, 2006 (Ed. 1.60)
Released as revised ORCAview 3.33 Release 2 PDF files November 22, 2009 (Ed. 1.70)
Released as revised ORCAview 3.40 Release 1 PDF files December 9, 2011 (Ed. 1.80)
Information in this document is subject to change without notice and does not represent a
commitment to past versions of this document on the part of Delta Controls Inc. Delta
Controls Inc. may make improvements and/or changes to this manual/the associated
software/or associated hardware at any time.
BACspec, BACstat, the Delta logo, the ORCA logo, ORCApower, the ORCAview logo,
ORCAweb, enteliWEB, enteliBUS, enteliMESH, enteliTOUCH, enteliZONE, enteliSTAT,
enteliCON and enteliSYSTEM are trademarks of Delta Controls Inc.
BACstat®, ORCA®, ORCAview®, Virtual Stat® and Earthright® are registered trademark
of Delta Controls Inc.
Windows Vista and Windows XP and Windows 7 are registered trademarks of
Microsoft Corporation.
USRobotics is a trademark of 3Com Corporation.
Intel is a registered trademark of Intel Corporation.
ECHELON LONW ORKS are U.S. registered trademarks of Echelon Corporation.
All other trademarks are the property of their respective owners.
Document Control
Title: ORCAview Version 3.40 Release 1 Technical Reference Manual Edition 1.80
Product Number: None – PDF files included on Release CD
Rev Date Changes
1.0 April 30, Original manual for Version 3.20 ORCAview. Released as PDF files only.
2000
1.01 June 22, Revised document for release as paper-based manual DOC810-20. Added Data
2000 Exchange and ORCAview PIC Statements sections to Chapter 9 Controller Networks.
Fixed error in table for Event Object on page 44 of Chapter 11 General Control Language
(GCL+). Fixed minor format and copy editing issues in all chapters. Add text to copyright
allowing limited reproduction and distribution of the PDF electronic files in paper format.
1.10 April 3, Revised manual for Version 3.21 ORCAview. Released as PDF files only. Added new
2001 appendices for Derived Network Addressing (DNA) and Using ORCAview with Version 2
Sites. Added install information for Windows ME/2000 to Chapter1 Introduction. Added
objects to Chapter 10 Software Objects Reference. Included a section describing special
functions for use with Room Controllers, BACstats and LINKnet in Chapter 11 General
Control Language (GCL+). Revised Appendix D MicroNet. Chapter 4 Tutorial has been
excluded from this revision.
1.20 September Revised manual for Version 3.22 ORCAview. Released as PDF files only. The DAC
28, 2001 products can now do functions such as alarming, routing and data exchange formerly only
found on a DCU. Revised objects in Chapter 10 Software Objects Reference to include
additional BACnet features and also to update the additional objects (MI, MIC, TL, MT,
SCH) fully supported by DAC products. Added Appendix G for Working with MS/TP and
LINKnet and Appendix H Service Port Access. Included Adobe Catalog full-text index files
for use with Acrobat Reader 5.0 with Search and Accessibility or Reader 4.05 with
Search. Chapter 4 Tutorial has again been excluded from the revision.
1.30 May 1, Revised manual for ORCAview 330 Release 1. Released as PDF files only.
2004
1.40 April 30, Revised manual for release with ORCAview 330 Release 2. Includes improved printing of
2005 objects and alarms
1.50 September
30, 2005
1.6 May 3,
2006
1.7 November Supports Vista and Windows 7 plus multi-core processors. Support for DHMI, CON-
22, 2009 768BT Bluetooth converter and Embedded Web Server. New Navigator features include
Software Version Mismatch and Description Column. Extensive changes to LG and HS
objects. Includes MN and SD objects. Changes to DEV, SUA, and OS. Appendix F
Service Port Access includes CON-768BT.
1.80 December The headings of sections with significant changes have a green highlight. Document new
9, 2011 suite installer that handles installation, upgrades and maintenance for up to six Delta
software applications in a single install process. Dialogs, icons and overall look are
updated throughout the product. Ch. 3 Navigator has updates to Bluetooth,
Communication Control and Objects Security (Lock, Unlock and Temporary Logon).
Include new enteliBUS hardware. Include Start graphic from a command line in a running
graphic. Ch. 4 Tutorial is eliminated.
Add new objects to Ch. 10: SCH BACnet R4 supports 3 types of values plus partial day
scheduling, BDE, IPS, ORS, IOM, ZigBee® Wireless objects[x3] and SV. Add Intrinsic
Alarming for AI, AO, BI, BO and MI. Significant changes to BMD, DEV, EVC, EVL, EVR,
LG, LNK, Net, OS, PG, SSS plus Access Objects. Ch06 include support for multiple
Historians. Ch. 11 includes new constructs: IntDate/IntTime, Read/Write, SetTime and
ToSeconds. Update App. E and F plus increased PG size.
Chapter 1 – INTRODUCTION
Chapter 1 Contents
DESCRIPTION ....................................................................................................... 1–2
Matching Products for Release ............................................................. 1–2
SYSTEM REQUIREMENTS ...................................................................................... 1–3
SUITE INSTALLER FUNCTION ................................................................................ 1–4
Supported Scenarios ............................................................................. 1–4
Unsupported Scenarios ......................................................................... 1–6
OWS DEFAULT DIRECTORIES .............................................................................. 1–7
NEW INSTALLATION ............................................................................................. 1–7
Workstation Number ............................................................................. 1–8
Concise: Installation Procedure ........................................................... 1–9
To install Delta products from the ORCA Suite CD: .............. 1–9
To install Delta products from the desktop: .......................... 1–10
Detailed: Installation Procedure ........................................................ 1–11
To install ORCAview from the ORCAview CD: .................. 1–11
MS HTML Help ................................................................................... 1–18
UPGRADE INSTALLATION ................................................................................... 1–18
Upgrade Procedure............................................................................. 1–19
To upgrade ORCAview from the ORCAview 3.40 CD: ....... 1–19
COEXISTANCE INSTALLATION ............................................................................ 1–23
To coexist ORCAview from the ORCAview 3.40 CD: ........ 1–23
APPLICATION MAINTENANCE: ........................................................................... 1–27
Add/Remove Software ......................................................................... 1–27
Repair Software .................................................................................. 1–29
Uninstall Software............................................................................... 1–30
CONCISE INSTALLATION OF HISTORIAN ............................................................. 1–31
To install Historian from the ORCA Suite CD:..................... 1–32
To install Historian from the desktop: ................................... 1–32
Historian Install Microsoft SQL Server 2005 Setup ........................... 1–33
WINDOWS XP / WINDOWS 7 SENTINEL DRIVER UPDATE ................................... 1–39
To manually update the Sentinel driver from the
ORCAview 3.40 CD: ....................................................... 1–39
CUSTOMIZING THE DESKTOP SHORTCUT FOR AUTOMATIC LOGIN ..................... 1–41
To create a shortcut for automatic ORCAview login: ........... 1–42
SYSTEM ARCHITECTURE .................................................................................... 1–43
Networking Information in Other Chapters ........................................ 1–43
Architecture Design ............................................................................ 1–44
Ethernet – BACnet MS/TP .................................................................. 1–45
Operator Workstation Connections .................................................... 1–46
Thank you for buying the Delta Controls ORCAview® program. ORCAview
operates in a graphical Windows world and has powerful facilities management
tools. We trust that this product will satisfy your building control needs.
We are continuing our efforts to more fully express the vision Integrated Facilities
Management Solutions Simplified in the ORCAview product.
Description
The ORCAview software is a native Windows® application and has been written
to look and operate like most Windows applications.
The operator can view project data graphically or with the interactive Microsoft
Windows Explorer™ style Navigator. Both these interfaces to the DDC system
provide real-time data to the PC, with updates as quick as five second if needed.
Real-time data can be shown in a group of objects, single objects, multiple
objects, on-line graphics, or in any combination.
The user interface has an object-oriented design. This approach allows quick
access to menus by just clicking on an object using the right mouse button.
At the click of a button, the operator can change from viewing a graphic to editing
the graphic using the optional Illustrator tool created by Delta Controls. This
makes it easier to draw and test graphics.
For more detailed information on the drawing program Illustrator, see the
Illustrator Technical Reference Manual which is included on the release CD.
ORCAview currently has four methods to access a DDC system through Windows
networking. The LAN/WAN connections from the PC to the DDC system are:
• BACnet IP (UDP/IP)
• BACnet Ethernet (10 Mbits/s)
• BACnet MS/TP (Up to 76.8K Baud) PC to controller CON-768/ CON-768BT
• BACnet PTP RS-232 (Up to 38.4Kbytes/s) Local and Dial-in/Dial-out
• DSC/DAC – BN155693
• Tetra – EN155693
• DFM /DRP– FM155693
• V2 Micro – – RC114575
• DCU – 340.3073
System Requirements
To run the Delta Controls ORCAview® software, Delta Controls offers the
following minimum requirements:
Minimum Requirements
Operating Windows XP 32 Pro; Server 2003/Win2K3; Vista 32/64
System (Business, and Ultimate); 2008 Server; Windows 7 32/64 (Pro,
Business and Ultimate).
Processor Pentium or Athlon @ 1 GHz
ORCAview supports multi-core processors.
RAM at least 2 GB
Disk Drive CD-ROM if installing from a CD, otherwise an electronic form
can be used
Hard Disk Drive 2 GB of free space for ORCAview
Video Settings 1024 x 768 resolution with 16-bit color
Modem USRobotics modem if dialup needed
Serial ports COM Ports for PTP direct use and Service Port Access
USB Ports For Service Port Access over a wireless connection
Windows 95, Microsoft Windows 98, Windows NT and Windows Millennium
Edition (ME), are NOT supported.
Windows 2003 and 2008 Server are supported for installing and running the
ORCAweb product.
Although ORCAview will run on many less capable machines, performance may
be much slower in many cases (e.g., Multi-Trends), and you risk other
performance-related problems. If any performance problems are encountered on
PCs not meeting these specifications, the first recommendation will be to upgrade
to a more suitable machine.
To run the Delta Controls ORCAview™ software, Delta Controls offers the
following recommended requirements:
Recommended Specification
Operating Vista 32/64 (Business, and Ultimate); 2008 Server; Windows 7
System 32/64 (Pro, Business and Ultimate).
Processor Intel Core 2 Duo – 2.6 GHz
RAM 4 GB+
Disk Drive CD-ROM if installing from a CD, otherwise an electronic form
can be used
Supported Scenarios
All scenarios will be supported for both default and custom install locations. If
you change only the disk drive letter in a default path, ORCAview still treats the
path as the default directory. For example, you might just change the C: to D: and
leave the rest of the default path unchanged. A custom install is one that has the
names in the default path changed.
Note: All scenarios will be supported for both default and custom install
locations.
Supported Scenarios
Case See Action
Clean Install New Suite installation with no existing Delta
Installation product installed
section on
page 1–3
Suite Build-to- Upgrade Upgrade ALL installed product from older
Built upgrade Installation build to latest build of the current version.
section on
page 1–18 All site specific files are upgraded if
necessary.
E.g. 3.40.2159 suite ->
3.40.3073 suite
Upgrading from a beta build is NOT
recommended. Uninstall the Beta build and
then re-install a released version..
Suite Version Upgrade Upgrade ALL installed product from older
Upgrade Installation version to current version.
section on
page 1–18 All site specific files are upgraded.
E.g. 3.33.1917 suite ->
3.40.3073 suite
Suite Version Upgrade If Historian is installed, it will not be possible
Upgrade, keep Installation to keep old OWS on upgrade.
previous OWS section on
page 1–18 The old OWS is not upgraded. A new 3.40
OWS is installed alongside it. All other
components are upgraded.
E.g. 3.33.1917 suite ->
3.33.1917 OWS and 3.40.3073
suite
Coexistence Coexistance Install the current version of OWS and
of OWS only Installation on Loaders alongside the existing older version
(with 3.40 now page 1–23 suite (excluding Historian).
includes
Coexistence Or, install the current version suite
of Loaders) (excluding Historian) alongside the existing
older version OWS and Loaders.
No site specific files are upgraded. Both
installations are treated as separate.
E.g. 3.33.1917 suite ->
3.33.1917 suite and 3.40.3073
OWS/SystemLoader ***
*** Once in this
configuration, and you want
to upgrade your suite to
3.40, you must remove 3.40
OWS and Loaders and then
upgrade your 3.33 suite.
E.g. 3.33.1917
OWS/FlashLoader -> 3.33.1917
OWS/FlashLoader and 3.40.3073
Supported Scenarios
Case See Action
suite
Complete Uninstall Uninstall ALL installed product of current
Removal Software topic Version only.
in Application
Maintenance E.g. 3.40.3073 suite -> no
section on product
page 1–30
Modify Add/Remove Add and/or Remove individual suite
Components, Software topic components to current installation of Delta
Add or in Application product.
Remove Maintenance
section on E.g. 3.40.3073 OWS and
page 1–27 ORCAweb -> 3.40.3073 OWS and
Historian
Repair Repair If a malfunction occurs such as power failure
Software topic and a software application no longer runs, it
in Application is possible to repair the installation quickly.
Maintenance The core files are refreshed and it is not
section on necessary to do an uninstall / install of the
page 1–29 software product and this approach saves
time.
Unsupported Scenarios
If the Suite Installer does not offer a particular install option, then this scenario is
not allowed by the installer.
Unsupported Scenarios
Partial Build-to-Build upgrade resulting in mixed builds of the current version.
Version Upgrade of versions older than 3.33 R2.
Version Coexistence if Historian installed.
Add or Remove components during an Upgrade.
Upgrade of versions older than 3.33 R2. Those version would first need to be
upgraded to 3.33 R2.
Uninstall of older versions.
Install mixed versions of various non-OWS/Loader products in the suite (e.g., 3.33
Web and 3.40 ODBC Driver).
In some cases, you would uninstall the Suite and then re-install it.
C:\Users\Public\Delta Controls\3.40\
New Installation
With 3.40, ORCAview has a suite installer which provides a choice of six
applications to install. You may have a CD or downloaded folder with an
executable install file named ORCA Suite Setup.exe.
In the previous figure, the checkbox for Delta ODBC Driver is Red indicating that
the software key does not have this product enabled. You can still select this
product for installation or press the Cancel button to exit. If installation is
completed without the software key fully enabled, the disenabled products will not
run.
Before you begin your installation you will need to do the following:
• Choose a directory – You may let the install program place ORCAview in the
default directory or choose a different destination. See OWS Default
Directories on page 1–71–7
If the directory does not exist, then the install program will create it.
• Determine the name of the site. For example, you could enter International
Airport.
• Determine the name of the workstation on your local network. For example,
you could enter Main ORCAview PC.
• Determine the number of the workstation on the network. See the following
section titled Workstation Number.
Workstation Number
Every device on the same site must have a unique controller number. ORCAview
calls this the workstation number. The PC that will receive the new ORCAview
installation must have a unique workstation number.
Note: Choose the workstation number carefully, as you must re-install the
software to change it. To avoid conflicting workstation numbers, maintain a
list of device numbers for large sites.
The PC where the new ORCAview is being installed must have a unique
workstation number assigned to it. The workstation number must:
• be different than any other workstation number,
• be different than any other controller address,
• not be 0, 254, 65534 or 65535
• not be greater than 4194302 if only V3 hardware
• not be within any Micro Panel range.
1. If the autorun does not bring up the interface, use the My Computer icon or
the Explorer view to find the ORCA Suite Setup.exe file.
See the detailed Installation Procedure section starting on page 1–11 for more
information.
See the detailed Installation Procedure section following on this page for more
information.
Note: If you plan to use Ethernet, install an Ethernet card before installing
ORCAview.
See the tables in the Suite Installer Function section starting on page 1–4 for
supported and unsupported install scenarios.
b. Turn off the PC and attach a software key to your USB or Parallel port.
When the key is attached, turn on the PC.
• USB Port: This software key that attaches to your USB port.
Caution: Never remove or attach the software key to the PC while the
power is on. The key may be damaged if this caution is not heeded.
e. Use the My Computer icon or Explorer to view the contents of the CD.
• If the autorun brings up the interface: Select the installer and follow the
instructions to complete the installation process. Go to step 2 of this
procedure.
• If the autorun does NOT bring up the interface: Find and open the
ORCAview 3.40 in the Delta V3.40 Software Suite Installer software
folder. Double click ORCA Suite Setup.exe file to start the Suite
Installer.
f. The install screen displays and the ORCAview installation starts.
2. Welcome screen.
a. At the Welcome screen, click Next.
a. Click next.
4. Select Products
For this example, the ORCAview OWS, Delta Flash loader and Delta System
loader are selected in the following figure. The other product options must be
unchecked. A red checkbox (Delta ODBC Driver) indicates that a product is not
enabled on the hardware key.
a. The install program chooses default folders for you. Click Browse to
choose or create another folder.
Note: If you change only the disk drive letter in a default path, ORCAview
still treats the path as the default directory. For example, you might just
change the C: to D: and leave the rest of the default path unchanged.
6. Workstation Setup
a. Enter the Site Name information. You must enter the Site Name.
b. Enter a Workstation Name for ORCAview.
Note: The Site and Workstation Name fields do not allow invalid
characters ( \ /:*?"’< >| $ #) and accept a maximum of 79 characters
assuming an installation that uses the default path.
9. Setup Complete.
a. All necessary files have been loaded onto your hard drive.
b. Click finish to complete Setup.
The Installation Procedure is finished. You may need to read First Time Login
Problems section on page 2–6 in Chapter 2 – Getting Started of the ORCAview
Technical Reference Manual.
Note: The firewall included with Windows XP may block the Siserver,
when you first run ORCAview after installation. On the Windows Security
Alert dialog, click Unblock to allow the Siserver program to run. This
message will only appear when logging in via UDP/IP.
MS HTML Help
ORCAview now uses the MS HTML help format (.chm) and the viewer is
included with Windows. Previously, it was necessary to download the
non-distributable Winhelp viewer from a Microsoft site.
Upgrade Installation
Caution: Although the Upgrade procedure will save site graphics and databases,
we strongly recommend that you back up these items. Also back up any other files
or objects you have created for your system.
During an upgrade, the installation program searches your computer for previous
versions of the Delta Controls ORCAview. If the previous version is found to be
incompatible with version 3.40, the installation program offers to uninstall the
previous version. If you click Yes, the previous version is uninstalled.
See the New Installation starting on page 1–7.
If the previous version is found to be compatible with version 3.40, the installation
program continues.
See the tables in the Suite Installer Function section starting on page 1–4 for
supported and unsupported install scenarios.
The 3.40 Suite Installer can only upgrade from 3.33. If you have an earlier version
(3.20 to 3.30), you need to first upgrade to 3.33 using the 3.33 Installer. The 3.40
Suite Installer can handle the upgrade from 3.33 to 3.40.
Note: If the palette, database or graphics files are large or numerous, the
upgrade process could be lengthy. The upgrade process might take an
hour depending on the size of the site and the performance of the PC.
Upgrade Procedure
Note: If the user stops the Upgrade process by clicking Cancel, then all
files are automatically restored to the original version by the Upgrade
Installation program.
Note: If you plan to use Ethernet, install an Ethernet card before installing
ORCAview. No special driver is needed to get Ethernet working as it uses
the Windows drivers.
4. Welcome screen.
5. Setup
If ORCAview detects an incompatible previous installation:
• You may need to upgrade from versions before 3.33 using the 3.33R2
installer which is included with the ORCA 3.40 suite.
• You may also need to uninstall the current products and then re-install them.
–OR–
6. The Ready to Upgrade dialog box appears. Click Next to continue the
Upgrade procedure.
a. The install program now begins copying files to your PC. When all files
are copied over to your PC, the install program upgrades any existing
graphics, palettes, or panel database files. If the palette, database or
graphics files are large or numerous, the upgrade process could be
lengthy.
b. The installation program shows the status of the file conversions and
upgrades.
Note: The ORCAview Installation program will now remove SNS, UDP,
and Tunnelling adapters from OWS databases during an upgrade. The
OWS will re-create these adapters from the registry bindings
automatically. This applies to upgrade of older pre 3.33R2 installations.
Coexistance Installation
Coexistance allows ORCAview Version 3.20/ 3.21/ 3.22/ 3.30/ 3.33 and 3.40 to
be installed on the same computer. With Windows XP, 3.33 can co-exist only with
3.30 or 3.22a.
ORCAview 3.40 does not support version independence which means that you
cannot have more than one instance of ORCAview 3.40 running at the same time.
See the tables in the Suite Installer Function section starting on page 1–4 for
supported and unsupported install scenarios.
4. Welcome.
b. Click Next.
6. Select Products
a. Select the products for installation and uncheck the one that you do not
want installed.
b. Click Next.
7. Destination Folder
a. Select the Program and data folders. You can just accept the default
paths.
b. Click Next.
8. Workstation setup
b. Click Next.
9. Ready to Install
Application Maintenance:
The Suite Installer allows you to change your install by adding, removing,
repairing or uninstalling selected software.
See the tables in the Suite Installer Function section starting on page 1–4 for
supported and unsupported install scenarios.
Add/Remove Software
1. In the following figure, the Add/remove 3.40 ORCA Suite software option is
selected.
2. Click Next.
Note: You cannot use the Add/remove option to uninstall the whole ORCA
Software suite. At least one option must be selected. To uninstall the
whole suite, you use the Uninstall your 3.40 ORCA Suite software option.
The following figure shows that Flash Loader will be removed. The ORCAview
OWS (333.1917) and (3.40.3073) will remain.
4. Ready to Modify
Repair Software
The Repair option provides a way to put the core files of a selected product back
to their initial conditions. For example, if a product malfunction occurs after a
power failure, Repair would refresh the core files quickly. It avoids the need to
take the time to do a complete uninstall / re-install sequence.
1. Application Maintenance
b. Click Next.
2. Ready to Repair
Uninstall Software
Uninstall provides a way to remove selected software.
1. Application Maintenance
b. Click Next.
2. Ready to Uninstall
3. Setup Complete
a. Click Finish.
See the tables in the Suite Installer Function section starting on page 1–4 for
supported and unsupported install scenarios.
The releases build will be 3073 or later. This example uses Build 3.40.3051.
Note: With the ORCA 3.40 Suite Installer, you do NOT need to install
OWS first and then log in over the desired network connection before
beginning to install Historian. This approach was necessary with 3.33R2.
1. If the autorun does not bring up the interface, use the My Computer icon or
the Explorer view to find the ORCA Suite Setup.exe file.
2. Double-click ORCA Suite Setup.exe file to start the Suite Installer.
3. Follow the instructions from the Welcome screen to complete the installation
process.
With Microsoft SQL Server 2005 Express, you need to define a strong password
which means that the password contains a variety of character types. A strong
password contains a combination of lowercase, uppercase, numbers and special
characters such as $ or # etc.
a. Enter a password.
b. Click next.
2 License Agreement
b. Click Next.
3 Installing Prerequisites
5 Completing Setup
a. Inspect the summary logs to see if any failures occurred during setup.
6 Password
c. Click Next.
b. Click Next.
8 ORCA Suite
a. Click Finish.
The 3.40 CD includes the version 7.5.1 Sentinel System Driver Installer in \Delta
Software Suite - V3.40 Release 1.0\Delta V3.40 Software Suite Installer\Third
Party Software.
To manually update the Sentinel driver from the ORCAview 3.40 CD:
1 Close all programs.
2 Insert the CD into the CD-ROM drive.
3 Use the My Computer icon or Explorer to view the contents of the CD.
4 Open the Delta V3.40 Software Suite Installer\Third Party Software folder on
the release CD.
5 Find the Sentinel_System_Driver_Installer_7.5.1 file and double click it.
6 Sentinel System Driver – InstallShield Wizard
Caution: Do not use a shortcut providing automatic login unless you are
certain the site does not need username and password security, or, that
the username automatically logged in lacks permission to alter security
objects such as the SUA and UA objects or objects otherwise important to
site functions.
When you use the shortcut for automatic login, the following objects will exist on
your system:
• A System User Access (SUA) object in the ORCAview PC that uses the
automatic-login username and password. — If not, then you must create a
SUA object in the ORCAview PC containing the username and password.
(See the Creating a New User section in the System Security chapter.)
• A System User Access (SUA) object in the Network Security Panel that uses
the automatic-login username and password. — If not then you must create
such a SUA object. (See the Creating a New User section in the System
Security chapter.)
• A Site Settings (SS) object in the ORCAview PC that uses the site-name.
If not then you must create a SS object using the site name that you intend to
enter for automatic login. You cannot alter an existing SS object. (See the
Multiple Sites section in the Navigator chapter.)
2. In the Shortcut tab, there is a Target field that specifies the shortcut path. In
Windows 7- 32 bit:
"C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe"
In Windows XP:
“C:\Program Files\Delta Controls\3.40\System\ORCAview.exe”.
After the last quotation mark in the shortcut path, leave one space and then
type the following information:
user=username/password site=sitename.
You place your username/password and sitename after the shortcut path in the
target field. The modified target field will read:
Note: The username and password must not contain spaces. The
sitename may contain a space between the first and last letter of the
sitename but must be in quotations. Example: site= “site name”. The
following invalid characters cannot be used in the username, password, or
site name: ! \ / * ? : “ ‘ < > | $ #
System Architecture
System architecture is defined as the design of a communications system, which
includes the hardware, software, access methods, protocols, and method of
control.
The following figures explain the ORCA hardware architecture and illustrate the
use of Delta Control hardware in typical networks.
• Architecture Design
• Ethernet – BACnet MS/TP
• Operator Workstation Connections
See Appendix E — Working with MS/TP and LINKnet of this manual to configure
and program these products.
See Appendix F — Service Port Access of this manual for an explanation of how
to use ORCAview typically on a laptop to connect to a network using the Service
Jack on a DAC, DSC or BACstat controller. Use of the CON-768 and newer
CON-768BT converters is explained.
Architecture Design
The ORCA Hardware architecture is based on a hierarchical design. This allows
for simple and efficient communications in large Wide Area Networks and small
stand-alone systems. The ORCA® architecture is extremely flexible and can be
built up in a variety of configurations.
There are four levels to the ORCA hardware architecture: AREA level, SYSTEM
level, SUBNET level, and LINKnet level. AREA Level controllers are primarily
used to break-up large segments of a WAN. One controller per segment may be
configured as an AREA Level controller.
AREA Level
DSC-1212E, DSC-1616E,
DSC-1280E, DSM RTR
SYSTEM Level
SUBNET Level
LINKnet Level
Ethernet
System Level
DSC-1616E or
DSC-1212E or DSC DSC DSC
DSC-1280E or
DSC-1616EX
Subnet Level
DAC
DACs
DAC
communicating @ 76.8 Kbaud
LINKnet Newtork
LINKnet Level
DNS-24
DFM-202
There are also several standard connection points such as EIA-232 ports using
BACnet PTP, directly or through a modem.
There is a service port on most Delta ORCA hardware. This service port supplies
power to the EIA-232/485 converter (CON-768) or wireless Bluetooth to wired
RS-485 CON-768BT converter so that the operator does not have to provide a
separate power supply for powering the converter.
Ethernet
INTERNET
BACnet MSTP connection
through the Service Port
Modem using Delta's CON-768
BACnet MSTP Network
DSC-1616E, DSC-1212E,
DSC-1280E, DSC-1616EX, BACnet MSTP connection
DSM RTR through the Service Port
using Delta's CON-768
(EIA-232 / EIA-485 Converter)
Laptop computer
communicating @ 76.8 Kbaud
Workstation
LINKnet Newtork
DFM-202
Object created virtually
in Device 101
Chapter 2 Contents
OVERVIEW ........................................................................................................... 2–2
STARTING ORCAVIEW ........................................................................................ 2–2
Logon Dialog Box ................................................................................. 2–3
To log on to ORCAview: ........................................................ 2–4
Logon Dialog: Advanced Button Connections ...................................... 2–5
Multiple Connections .......................................................................... 2–12
OWS DIRECTORY CONVENTIONS ...................................................................... 2–13
CUSTOMIZING THE DESKTOP SHORTCUT FOR AUTOMATIC LOGIN ..................... 2–14
To create a shortcut for automatic ORCAview login: ........... 2–14
START GRAPHIC THROUGH A COMMAND LINE ................................................... 2–16
SOLVING FIRST TIME LOGON PROBLEMS ........................................................... 2–17
Windows XP Firewall Blocks Siserver ................................................ 2–17
Controller Turned Off ......................................................................... 2–17
To access your network: ........................................................ 2–18
ORCAview PC is Not Properly Connected to the Controller.............. 2–18
Incorrect Ethernet Card Selected........................................................ 2–18
Delta Version 2 Protocol is not Enabled ............................................ 2–18
To manually enable Version 2 Security and designate a
Security Panel: ................................................................. 2–19
IDENTIFYING MAIN COMPONENTS OF ORCAVIEW ............................................ 2–20
ORCAview Dashboard ........................................................................ 2–20
To set the ORCAview Preferences: ....................................... 2–21
Navigator ............................................................................................ 2–26
Delta Server ........................................................................................ 2–26
To see the Delta Server operation: ........................................ 2–27
General Control Language ................................................................. 2–27
Illustrator ............................................................................................ 2–27
GETTING HELP ................................................................................................... 2–28
MS HTML Help ................................................................................... 2–28
To read or print the help files: ............................................... 2–29
ADJUST TIME ..................................................................................................... 2–30
Set Time and Date in Windows for the PC .......................................... 2–30
To set the Windows Date and Time: ..................................... 2–30
Check Controller Time ........................................................................ 2–31
To check the time on a particular controller: ......................... 2–31
To send the current PC Time to all controllers:..................... 2–32
EXITING ORCAVIEW ......................................................................................... 2–32
To exit ORCAview: .............................................................. 2–33
To Log on ORCAview as another user or through another
network connection: ........................................................ 2–33
Overview
This chapter covers:
• Starting ORCAview on page 2–2
• Logon Dialog: Advanced Button Connections starting on page 2–5
• Multiple Connections starting on page 2–12
• Start Graphic through a Command Line on page 2–16
• Solving First Time Logon Problems on page 2–17
• Identifying Main Components of ORCAview on page 2–20
• Getting Help on page 2–28
• Exiting ORCAview on page 2–32
You need to connect power and communications to the controller before you start
ORCAview.
Chapter 8 – Modems and Printers provides wiring diagrams to ensure that the
controller is wired properly. The Chapter also describes how to make different
types of cables.
Starting ORCAview
This section discusses two methods of starting ORCAview. The ORCAview
Installation program creates the first method.
Note: The firewall included with Windows XP may block the Siserver, when you
first run ORCAview after installation. On the Windows Security Alert dialog, click
unblock to allow the Siserver program to run. This message will only appear when
logging in via UDP/IP.
First Method After installation, click the Start Button in the lower left corner
of the screen.
When you click the Start button, the Start Menu appears. Choose All Programs,
select Delta Controls, select 3.40, and then click ORCAview. The computer
displays a Windows 7 desktop similar to the following figure:
Click the ORCAview program. ORCAview then displays the Logon dialog box.
See Logon Dialog Box on page 2–3.
Second Method You can start ORCAview from the ORCAview icon on the
desktop. Double click on the icon to start ORCAview.
Password Enter the password for the SUA object entered in the Username
field.
Site A drop-down provides a list of the available choices. A Site Settings (SS)
object defines login parameters for each site.
To log on to ORCAview:
1. When the Logon Dialog box displays, type your Username and Password.
Your supervisor or the person who installed the ORCAview system assigns
your Username and Password.
2. Click OK on the Logon dialog box. ORCAview starts up as shown in the
following figures. If this is your first-time logging-on, and no connection is
made, see Solving First Time Logon Problems section on page 2–17 of this
chapter.
ORCAview
Dashboard
Navigator
Delta Server Icon The Delta Server Icon indicates that the Delta Server is
operating. The Delta Server processes information from BACnet or Version 2
networks.
In the previous figure, ORCAview uses the Ethernet card(s) already installed
through Windows.
If you click on the Add New Con768BT button, the Add Bluetooth Device Wizard
from Windows opens.
COM Port This field defines the COM port for communications. Only valid
virtual COM ports associated with the CON-768BT are listed in the Com Port
Drop down menu when Bluetooth: BACnet MS/TP is selected.
COM Port This field defines the COM port for communications. Only valid
detected COM ports are listed in the Com Port Drop down menu when Direct
Connection type or MS/TP is selected. These do not include virtual COM ports
associated with the CON-768BT.
Speed The choices for communication speed are 9600, 19200, 38400, and
76800. The default is 76800.
Connect Using With Serial, the options are either Serial BACnet MS/TP,
Serial BACnet PTP or Serial Version 2.
Connect Type For BACnet PTP The options are Direct, Modem Dial-out or
Modem Answer.
COM Port This field defines the COM port for communications. The options
are Com1-Com4.
Speed The choices for communication speed are 9600, 19200, 38400, 57600,
76800, 115200. The default is 9600.
The following figure shows the Connect Using field with Serial 2 (BACnet PTP)
and the Connect Type field with Direct selected.
The following figure shows the Connect Using field with Serial 2 (BACnet PTP)
and the Connect Type field with Modem Dial-out selected.
Phone Number The phone number for the device that is to be dialed. This
field accepts the Area Code and the Long distance prefix. Communications are
established with a device using a Modem Dial-out when the phone number is
dialed.
The following figure shows the Connect Using field with Serial 2 (BACnet PTP)
and the Connect Type field with Modem Answer selected.
The following figure shows the Connect Using field with Serial 3 (Version 2) and
the Connect Type field with Direct selected.
Connect Using With UDP/IP selected, the following fields are available. The
IP address is for the PC Ethernet card. This Ethernet address is stored in the
UDP/IP Settings (UNS) object but cannot be changed there.
Connect Type For BACnet PTP The options are Direct, Modem Dial-out or
Modem Answer.
UDP/IP Port The port defines which UDP port number that UDP/IP
communication will use. The available range is 0 to 65535 with 47808 being the
default. These port numbers are assigned by Internet standard with 47808 being
assigned for the use of BACnet networks. It is important that this port number is
not changed arbitrarily as many of the other port numbers have other purposes that
would conflict with BACnet. All devices on the same UDP/IP network must use
the same Port number.
Select Remote network in the Connect to field and enter a Remote Panel IP
Address
Multiple Connections
ORCAview can connect to different networks using separate connections. For
example, your PC might use two Ethernet cards at the same time. Multiple
connections are enabled in the Network Settings (NET1) Object for a DAC/DSC
controller or the Setup tab of the BACnet Protocol Settings (BCP) object for an
older DCU controller.
The following Warning Message will appear if you click on the advanced button
on the Logon dialog. This message explains that by clicking the advanced button,
all Network adapters except for one will be disabled. You will not be able to
enable more than one network adapter when using the Advanced button dialog. If
you wish to re-enable multiple network adapters, you can do so via the local BCP
object when the OWS is started.
C:\Users\Public\Delta Controls\3.40\
Caution: Do not use a shortcut providing automatic login unless you are
certain the site does not need username and password security, or, that
the username automatically logged in lacks permission to alter security
objects such as the SUA and UA objects or objects otherwise important to
site functions.
When you use the shortcut for automatic login, the following objects will exist on
your system:
• A System User Access (SUA) object in the ORCAview PC that uses the
automatic-login username and password. — If not, then you must create a
SUA object in the ORCAview PC containing the username and password.
(See the Creating a New User section in the System Security chapter.)
• A System User Access (SUA) object in the Network Security Panel that uses
the automatic-login username and password. — If not then you must create
such a SUA object. (See the Creating a New User section in the System
Security chapter.)
• A Site Settings (SS) object in the ORCAview PC that uses the site-name.
If not then you must create a SS object using the site name that you intend to
enter for automatic login. You cannot alter an existing SS object. (See the
Multiple Sites section in the Navigator chapter.)
2. In the Shortcut tab, there is a Target field that specifies the shortcut path. In
Windows 7- 32 bit:
"C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe"
In Windows XP:
“C:\Program Files\Delta Controls\3.40\System\ORCAview.exe”.
After the last quotation mark in the shortcut path, leave one space and then
type the following information:
user=username/password site=sitename.
You place your username/password and sitename after the shortcut path in the
target field. The modified target field will read:
For Windows 7 – 32 bit:
"C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe" user=username/password site=sitename.
Note: The username and password must not contain spaces. The sitename may
contain a space between the first and last letter of the sitename but must be in
quotations. Example: site= “site name”. The following invalid characters cannot
be used in the username, password, or site name: ! \ / * ? : “ ‘ < > | $ #
If you use spaces you must use double quotes to enclose the part with spaces.
For a programmer, this feature allows an outside script to determine what graphic
to load. You can use a macro to open a particular graphic based on conditions.
This behavior is not dependent on a predefined SUA.
If a starting graphic is also defined in the User Data tab of the SUA object for a
user, both graphics opens when OWS is started from a shortcut but the command
line graphic opens on top and has focus.
If you want access to a V2 controller on a network, you must manually enable the
Version 2 protocol and designate a V2 panel as the Security Panel.
3. Click the Application Protocol and enable the Delta Version 2 Protocol check
box.
4. Click OK.
5. Exit ORCAview. Wait five seconds for the Delta Server to unload. Restart
ORCAview. You can now access your network.
ORCAview Dashboard
From the ORCAview Dashboard, you can start all the components of ORCAview.
Whenever ORCAview runs, the Dashboard displays on your screen. The
Dashboard also displays the menus for other components.
ORCAview Dashboard
When the Dashboard first opens, it displays the standard dashboard and menu bar.
The Dashboard always displays the PC time in the lower right hand corner. To
change the time displayed, you must go through the Windows settings.
See the Adjust Time section starting on page 2–30 of this chapter for more details.
Docking You can place the Dashboard along the top or bottom side of the
monitor where it displays as a solid bar. The Dashboard is docked when it
displays as a solid bar along the top or bottom side of the monitor. You can
combine docking with other display options such as Always on Top or Autohide.
The ORCAview Preferences dialog box allows you to select these options.
The Dashboard Search Menu allows you to find text and objects.
The Dashboard Window menu selects which windows are currently active.
The Dashboard Help menu provides access to the Help File and contains
important version information about ORCAview.
See the Getting Help section of this chapter starting on page 2–28.
Menu Changes When components of the ORCAview program are open, the
Dashboard menu changes to match the currently selected component.
For example, when Navigator is open, the Dashboard menu provides access to the
Navigator functions. When Illustrator is open, the Dashboard menu includes a
Drawing Menu as well as changes to existing menu items.
ORCAview
Navigator
Navigator displays system information and provides operator interface to building
equipment. Navigator is a component of the ORCAview.
Filter Box
Delta Server
The Delta Server provides ORCAview with a link to the outside world. The DDE
(Direct Data Exchange) also use the Delta Server as a communication link. The
server routes information from the network to ORCAview. All requests for
information or commands affecting objects on the Delta Controls network pass
from ORCAview to the server and out into the network.
Whenever the Delta Server is running, an icon appears in the tray of the Windows
taskbar on the lower left.
The use of the GCL+ Editor is described in Chapter 11, General Control
Language (GCL+).
Illustrator
Use the Illustrator software module to create site graphics that display building
information. Illustrator graphics also include graphical controls for starting and
stopping equipment and adjusting heating and cooling.
Illustrator is an optional software module available from Delta Controls. A
separate Illustrator Technical Reference Manual explains the use of Illustrator.
Getting Help
In ORCAview, online help is always available. To get help for any part of the
program, press F1 on your keyboard. A help screen opens and provides help for
your current task.
Help is also available from the entry fields of most dialog boxes. To get help, you
place the cursor in the entry field and press the ? help button.
When using the GCL+ Editor, help is available for every GCL+ program element.
You place the cursor on the program element and press F1 on your keyboard.
MS HTML Help
ORCAview now uses the MS HTML help format (.chm) and the viewer is
included with Windows. Previously, it was necessary to download the
non-distributable Winhelp viewer from a Microsoft site.
Book
Topic
5. When you click Print…, the following submenu displays. Select one of the
two options to either print a single selected topic or to print all the topics in a
book.
Adjust Time
ORCAview uses the Date/Time that you set in Windows. The Set Panel Time
command on the Tools menu of the Dashboard sends the current Date/Time to all
the controllers on the Network.
• Right clicking on the time in the task bar and selecting Adjust Date/Time.
Send PC Time to All Controllers The Set Controller Time command on the
Tools menu of the Dashboard sends the current PC Date/Time to all the
controllers on the Network. Change the Windows Time and Date if the time in the
following Set Panel Time dialog is incorrect.
Exiting ORCAview
When you exit ORCAview, information about your building system, such as
preferences, is automatically saved onto the ORCAview PC or OWS. Setpoints
and other settings that you change are saved in the controller. It is not necessary to
save files before exiting.
Although it is not necessary to save the controller databases every time you exit,
you should back up controller databases periodically. Whenever you make
database changes, you should also make a backup
To exit ORCAview:
From the ORCAview Dashboard, choose File, and then click Exit.
–OR–
Click the X Close button in the top right hand corner of the ORCAview
Dashboard.
Logoff Selecting Logoff from the ORCAview File menu causes ORCAview to
exit. You can then do one of the following:
• Log on to ORCAview as another user;
–OR–
Overview
Navigator provides control and visualization of complex facility systems. Navigator is the
object management interface of the ORCAview Operator Work Station (OWS). Navigator
presents the building system components as a group (or groups) of objects. It has a similar
look and feel to the Windows Explorer application created by Microsoft.
This chapter explains how to use Navigator to view and change objects:
• Using Navigator Functions starting on page 3–6.
• The Navigator Window starting on page 3–7.
• How to use Left Pane Views starting on page 3–10.
• Viewing Controller Objects starting on page 3–25.
• Working with Controller Objects starting on page 3–34.
• Using Network View – Right Mouse Menu starting on page 3–43.
• Printing in Navigator starting on page 3–56.
• Multiples Sites starting on page 3–60.
• Creating Custom Views starting on page 3–65.
Description
Navigator provides you with tools for viewing, changing and controlling your system.
Navigator and the ORCAview Dashboard are shown on the Windows desktop in the
following figure:
If Navigator is not open, you can start Navigator by selecting Tools in the ORCAview
Dashboard and then clicking Navigator. You could also click the Navigator button on the
toolbar located on the ORCAview Dashboard. It is assumed that you have Navigator
permissions.
More than one Navigator window can be open at the same time.
Navigator Functions
Navigator provides you with many functions. The following text describes these functions
using four typical tasks:
• Viewing your System.
• Monitoring and Control of Equipment.
• Responding to Alarms.
• Managing Databases.
Responding to Alarms
• View alarms directly from Navigator or from the Active Alarms Folder.
• Sort alarms in Navigator windows or in the Active Alarm Folder.
• Acknowledge alarms.
• View past alarms from a Event Log.
Managing Databases
• Load and Back up databases.
• Back up all controllers at the site.
Navigator presents information about your system. Navigator is divided into 2 panes. The
left pane shows the network of controllers. The splitter bar separates the left and right
panes. If you position the mouse pointer over the splitter bar and left click and hold the
mouse down, you can adjust the position of the splitter bar. The right pane shows the
contents of the controller or folder selected in the left pane.
Left Pane
The Navigator left pane includes a network tree that shows the connected controllers and
ORCAview PCs. Typical network elements include the following:
• Delta Network.
• BACnet and Version 2 Protocol.
• ORCAview PCs.
• Controllers.
• Active Alarm folder.
• Graphics folder (usually).
• Reports Folder
• Access Folder (if RPL exists on the local OWS)
Active Alarms Folder The Active Alarms Folder generally contains all the active
alarms at the site. The Active Alarms folders can appear in two different ways.
When no active alarms are present, the active alarms folder appears as on the left.
When active alarms are present, the Active Alarms folder appears with a large red alarm
icon as on the left. Open the folder to view or acknowledge active alarms. When the Active
Alarm Folder is selected, its contents can be printed by choosing File and then clicking
Print from the ORCAview dashboard.
Graphics Folder The Graphics folder contains the site graphics. Although it appears by
default, it is an optional folder. To change the option, from the ORCAview Dashboard,
choose Tools, select Preference, and then select Navigator. Next disable or enable the Show
Graphics Folder checkbox.
Right Pane
The Navigator right pane shows the objects that exist in the controller that is currently
selected in the left hand pane. For example, some of the objects in a controller are inputs,
outputs, programs, variables and control loops. Each object type has its own symbol or icon
to distinguish it from other objects.
–OR–
From the ORCAview Dashboard click on View and select Network, Logical, or
Custom view.
Network
Network shows the connected controllers by protocols and is the default view setting for
Navigator. By default, Navigator will only display the highest level controllers of the
network hierarchy with the lower level controllers “Collapsed” in the Network Tree. This is
shown by a + or – sign next to the system or area controllers. Click on the + sign and the
network tree will expand, revealing the subnet controllers. For example, Subnet
Application controllers are collapsed under System controllers and System controllers are
collapsed under Area Controllers, etc.
The following figure shows Navigator with the Network Tree expanded.
Logical
Lists all the connected controllers in numerical order based on device addresses.
Custom
Displays the system by mechanical systems instead of controller.
See the Custom Views section starting on page 3–65 for information on how to create
and use Custom Views.
Options
The Options folder is another way to access the Preference menu.
You can also view the Preference menu from the ORCAview Dashboard by clicking Tools,
and selecting Preference.
Query Controller The yellow question mark appears when the Controller's information
that is cached by ORCAview is out of date or has not been loaded. If ORCAview is set to
not auto-load descriptors, the yellow question mark may stay on a controller until the
controller is selected.
Being Queried
Online Controller The ORCAview PC has loaded up the names at login and
established good communication with the controller.
All Controllers
have a good
connection
Device 30100
(30100) is
Misconfigured.
Non-existent Controller The red question mark appears when ORCAview attemps to
communicate with a controller that does not exist on the network. This can be caused by a
site graphic or GCL program that references a controller which does not exist, or an Active
Alarm List entry that references a controller that does not exist. This icon usually shows up
after re-initializing ORCAview descriptors. This problem be fixed by correcting the link
within the graphic or GCL program, or by deleting the errant Active Alarm List entry. If
the controller does actually exist on the network, then this is an indication that the
controller is not communicating with ORCAview.
<device 103>
(103) does not
exist
An indicator ( ) displays in the left pane Navigator tree on a device icon to immediately
indicate the mismatched-version devices.
The mismatched version mask (a little red octagon (eight sided figure) with a white
exclamation point) appears on the controller icons in the left pane of the Navigator tree to
immediately indicate when a device does not have the same version as the OWS. This mask
displays only when there is not another mask on the controller icon.
The following figure shows a portion of the left pane of the Navigator tree. OWS 27234
does not match the version of the Device 6300 and BBMD2 9600 controllers.
Controller Addressing
Controller addressing is very important since each controller must have a unique address
within the network.
In Navigator, the controller’s address is the number in brackets (100). The name of the
Controller has no impact on the address. In the following figure, Device200’s address is
(300).
Address of the
DCU in bracket
(100)
The mismatched version mask (a little red octagon (eight sided figure) with a white
exclamation point) appears on the controller icons in the left pane of navigator tree to
immediately indicate when a device does not have the same version as the OWS. This mask
displays only when there is not another mask on the controller icon. The following figure
shows the status icons that may appear on a controller icon in the left pane.
The following figure shows a portion of the left pane of the Navigator tree. OWS 27234
does not match the version of the Device 6300 and BBMD2 9600 controllers.
2. The Version Warning message displays when an object dialog is opened with a
mismatched version of ORCAview (or ORCAweb).
When a new object dialog or an existing object dialog is opened on a controller with a
different software version, a message displays informing the user that versions do not
match and that writing to the controller may adversely affect database integrity. The same
warning message is used in both ORCAview and ORCAweb.
3. The same Version Warning message displays for a hard-coded data link in a site graphic
to a device that does not match the ORCAview (ORCAweb) version. When a site graphic
with hard coded links to devices is opened, each link is checked. The warning message
displays after the revised graphic is saved and put into Run mode.
The version of the OWS or controller Firmware can be determined through the Device
(DEV) object | Product Tab | Firmware Version and Application SW Version fields. The
version mismatch features uses the datestamps on the DIC files as displayed in the
Dictionary Version datestamp field on the Database tab of the Database Information (DBI)
object.
First, we can examine the Device object for the ORCAview OWS. The following figure
shows that the OWS340 is from Delta Controls and has an Application SW Version of
3.40.
The following figure shows the Device object for the BBMD1 device which matches the
ORCAview OWS V3.40 version.
From the previous figure, the eBCON controller has application SW Version of V340. This
matches with the parameters for the ORCAview OWS 12345 which is V3.40 Application
Software Version.
The following figure shows the Device object for the BBMD2 device has a version (V3.33)
which does not match with the ORCAview OWS (V3.40).
The BBMD2 controller is a Delta Controls DSC_1616E (Delta System Controller) with
Application SW Version V3.33. The controller does not match with ORCAview OWS
3.40.
The following figure shows the current function of the Object Type column.
The following figure shows the Description columns heading at the extreme right column
of Navigator. The Description column contains sample text that was added to the
Description tab for each of the first three Analog Input Configuration (AIC) objects.
The
registry
key is:
You can adjust the size of the Navigator window and then grab (position cursor, left click
and hold, then move the column heading) the Description column and move it.
The Description column may have a very small width the first time that it appears. You
need to expand the Description column width. You can resize the column width by
positioning the mouse over the last column marker of the current Description column
heading and then left click and hold the mouse while you drag to resize the column.
Navigator remembers the settings when it is opened afterwards.
The following figure shows the column headings of Navigator arranged to allow a very
wide Description column.
The right hand Navigator pane has four possible views useful for viewing, changing and creating
controller objects. The views can be selected from the ORCAview Dashboard using the View toolbar,
or by right-clicking in the white space of the right hand Navigator pane.
Small Displays objects as small icons. The icon shows object type.
Icon
Show Real-time Data ON In the ON setting, data from the controller is periodically updated. The
Name, Object, Description, Value, Auto Manual, Commissioned, Objects, Units, and Alarm columns
display.
Show Real-time Data OFF If Show Real-time data is turned OFF, some of the columns in the
Navigator right hand pane are removed as the display is not updated. The Value, Auto Manual,
Commissioned, Objects, Units, and Alarm fields do not display any data. The Name, Object, and
Description columns display data. The update of the display stops and the Refresh icon in the bottom
lower right of the Navigator window disappears.
2. Click Show Real-time Data. Show Real-time Data is active when the check mark is beside the
menu item.
Note: Only the data visible on the display is refreshed. When you resize or scroll down the
Navigator window, Navigator will refresh the newly visible information
Right-click on the refresh icon in the lower right of the Navigator window. Select
the update rate from the pop-up menu. The default rate is 5 seconds.
–OR–
From the ORCAview Dashboard, choose Tools, select Preference, and click
Navigator.
Alarm
State Manual or
Automatic
Value Units
Commissioned or
Object not commissioned
Name Object Status
Reference
Type of Object
ORCAview has a feature that provides a means to display the contents of the Description
tab for objects in Navigator. The previous Description column is now more appropriately
named as Object Type and lists the type of the object for each Navigator entry. The
Description Column feature is not enabled by default and a customer would only enable it
if they had a specific need as it places higher data transfer demands on the network. Refer
to the optional Navigator Description Column Feature section starting on page 3–23.
Sort You can sort by clicking the top of any column name in the Navigator right hand
pane. ORCAview then does one more scan of all the objects, not just those visible on the
screen and sorts them.
When sorting by Value, Units, Alarms, Comissioned, Manual, or Status, the Refresh icon
in the bottom right corner may change from green to red to show that information must be
updated manually through the right mouse menu. A Hand also appears over the Refresh
icon (in the bottom right hand corner of Navigator) to indicate Manual Refresh.The Refresh
icon turns red only when all the objects are not visible in the right pane. The Refresh icon
stays green if all the objects are visible in the right pane during a sort.
Manual Refresh In the details view, if you sort on a dynamic field such as Value or
Status, the right hand side pane stops automatically refreshing.
The refresh changes from Auto Refresh to Manual Refresh as
indicated by the Manual Refresh icon in the lower right of the
Navigator window. To get back into Auto Refresh mode, you must
click on the heading at the top of any non-dynamic column such as
name or Object.
To sort by column:
Click on any column header.
To resize a column:
1. Place the mouse cursor over the lines that divide the column headers.
2. The cursor will become a double-headed arrow.
3. Click and drag the mouse cursor to resize the column.
To move columns:
1. Place the mouse cursor over a column. Click and drag the column to the left or right.
2. A grey shadow will show the column location while you move it. The column will be
inserted where you release the mouse button.
Note: If the columns are moved or resized, then the changes remain the next time anyone
logs in. The settings are saved for the PC and cannot be made specific to a particular user.
Filtering Basics
Filtering is used to sort and display specific types of objects.
Filter objects by typing the filter in the filter box and pressing Enter. The setting of the
Filter Icon in the lower left pane affects the objects that display for an entry in the filter
Box. The choices for the Filter Icon are Hide System Objects, Show Only System Objects,
and Show All.
Filter Box
Filter Icon
Wildcards can be used to filter by descriptor name. For instance, typing Hot* in the Filter
box and pressing ENTER will display all object names starting with Hot. Wildcards can
represent any letter or number.
It is also possible to filter for object type. Type the Object References such as ai bo (or
AI BO) with a space between them. You need to press ENTER for the matching objects to
appear. Multiple filters can be entered at one time as long as a space is present between
each filter entry.
Note: Filters for descriptor names such as AHU2 are not case sensitive. If you type either
ahu2 or AHU2 and then press ENTER, the same matching objects will display in the right
hand pane. Filters for object types such as BI or AO are also not case sensitive.
Filtering Advanced
The Filter Box has AND OR > < = properties. Generally the query is in a form of:
[Objects].[Property Conditions]
[Object] can be an object name pattern, an object type with individual instance, or an
instance range. [Object] defaults to * if it is not specified.
System Objects
System objects are needed for setup but are not normally needed for day-to-day operation
of the system. System objects can be hidden from view in the Navigator window.
By default, system objects are hidden. The Filter Icon in the lower right corner of the
Navigator window gives the user three options:
Hide System Objects
Show All
Select Active
Alarms here
When Navigator is in Active Alarms view, it gives the details about the active alarms on
the Controller. Navigator appears as shown in the following figure.
From this view the active alarms can be opened, acknowledged or deleted just as they can
when the viewing the active alarms folder.
Alarms can be opened, acknowledged or deleted from the Active Alarms folder. This can
be done by right-clicking on the alarm entry and choosing either Open, Acknowledge or
Delete.
For more information about alarming see Chapter 5: Event Management System.
Selected
Controller
Controller
Objects
Selecting an Object
A single click on any object will select the object. Objects may also be selected in groups.
Opening an Object
All objects can be opened by double-clicking the object, or by choosing open in the right-
click menu.
When an object is opened, it is displayed as a dialog box. A dialog box allows the display
and modification of the object’s settings using standard Windows methods.
OK, Cancel, and Apply Buttons All objects have OK, Cancel and Apply buttons as
shown in the following figure.
Help Button Help for an object is available by clicking on the ? button on the dialog
box or pressing F1.
Refresh Indicator A green dot appears next to the object icon and shows the refresh
rate of the data in the dialog. The dot changes state for each occurrence of a refresh. Each
time that the dot blinks, the user gets a visual cue that the information is refreshed.
Refresh
Indicator dot
(green)
The refresh rate is set in the System User Access (SUA) object. On the ORCAview
Dashboard, use Tools\Setup\CurrentUser. Select the User Data tab and set the Refresh Rate
for Objects. The Refresh Rate can vary between 5 seconds and 60 seconds.
Do not confuse the green dot refresh rate for the dialogs with the Refresh Rate for the
Navigator window data.
Command This opens a sub-menu. These options are available when certain objects are
selected in Navigator or when an object is selected with Illustrator in the RUN mode. The
sub-menu commands follow:
Note: The ORCAview Dashboard provides the same functions as this right-click menu.
Next Object Skips to the next object from the list in the
right hand Navigator pane.
Find Object Find Object allows you to search for objects throughout your system. Use
wildcards for a partial name search.
Rename Renames the currently selected object or group of selected objects. Renaming a
group of objects displays a pop-up that allows you to replace text in the names of the
selected objects. You can also append or prepend text to the names of the selected objects.
Save As Saves the currently selected object to the PC as a pob file. With DAC/DSC
controllers, the Save As and Save All commands cause the controller to first save the
database to flash memory and then to write a copy of the flash contents to the specified file.
The DCU controller does not first save to flash during a Save As or Save All operation.
(To reload the object from the PC to the controller, first select the controller. Then, right-
click and select the Load option).
Some objects, such as the Event Settings (EVS) object and Data Exchange Settings (DES),
are automatically created by the system and cannot be created or copied by the
programmer.
3. You can put in the entries for the dialog box in any order. As the dialog box will
suggest some of the information for you, start with what you know. For example, if
you know what type of object you wish to create but do not know the Object
Reference, put in the Type of Object Entry first. The dialog box automatically assigns
an Object Reference and an Object Number.
The entry fields are as follows:
Name: The name of the object. e.g.: AHU1 Supply Air Temperature. Underscores are not
needed between words when creating objects in BACnet controllers. Version 2 still requires
underscores in object names. Names that contain ‘ “ * & | / \ (backslash and forward
slash) should be avoided.
Object Reference: The object reference is made as follows: Protocol Type, Controller
Address. Object, and Number. The object reference does not need to be directly named as
the system automatically provides it for you.
BACnet Protocol
Controller Address
BAC.100.AI17
Type of Object: Object types are described in Chapter 10 – Objects of this manual. Your
choice of objects will vary depending upon the type of device selected in the left hand pane.
Object Number: The specific instance of this object type. For example, if a controller has
twenty Analog Inputs, they typically have object numbers from 1 to 20. For input and
output objects, the object number tells you which hardware input or output is being used.
Each object of the same type must have a different number.
Copy and Paste New objects can be created using the copy and paste functions of the
Navigator right-click menu. ORCAview will suggest a new object number and will prompt
for a new object name. The Navigator (Right Pane) Command >Copy section starting on page
3–39 explains the function including the Cancel All and OK to All buttons.
In a paste action, the OK To All and Cancel All buttons can now be used to avoid clicking
the OK or Cancel buttons many times to provide input for each individual object. With OK
to All and Cancel All, you do not have to inspect each individual object and this approach
can save time.
Button Explanation
OK Pressing this button pastes a single object with the current Object
Name and Object Number in the Copying Objects dialog.
OK to All Pressing this button pastes the remaining objects in the paste
collection with the default Object Name and Object Number. It
asks for confirmation only when an Object Name or Object
Number conflicts with an existing object on the controller. If there
are no conflicts, the remaining objects are pasted in a single
operation.
Cancel Pressing this button skips pasting the single object with the
current Object Name and Object Number in the Copying Objects
dialog. The next object in the paste collection with suggested
Object Name and Object Number then appears in the Copying
Objects dialog.
Cancel Pressing this button cancels the creation of any more objects in
All the paste collection. The remaining objects in the paste list are not
pasted and the copy and paste operation is immediately ended.
Help Pressing this button bring up the help topic for the Copying
Objects dialog.
When multiple objects are copied, you can select whether to paste each individual object or
not using the OK and Cancel buttons in the Copying dialog box. The OK to All button
pastes all the remaining objects only asking for confirmation when the Object Name or
Object Number conflict with an existing object on the controller. The Cancel All button
aborts the pasting of any remaining copied objects.
6. Decide if the suggested Object Number and Object Name are acceptable and then
press OK to accept.
OR:
• Press Cancel to skip pasting this individual object. The suggested Object Number
and Object Name for the next copied object to paste displays in the dialog.
7. Continue the process of inspecting the suggested Object Number and Object Name for
each individual copied object. (pressing OK or Cancel)
• If you want to not paste any of the remaining objects, press Cancel All. This
action ends the operation immediately and any remaining objects are not pasted.
OR:
• If you want to paste all the remaining objects, press OK to All. This action pastes
all the remaining objects with the default suggestions only asking for
confirmation when the suggested Object Name or Object Number conflicts with
an existing object on the controller.
Note: All Right-Click Menu options can also be accessed within the Logical view, except
for commands directly related to Protocol.
Controller Commands
These commands are available from the pop-up menu following a right-click on a controller.
A different menu is shown depending on whether the controller is currently on-line or off-line.
Controller Off-Line
A controller is off-line when a red X appears on top of the controller icon. Right-click on
the controller to access the following commands.
Delete Removes this controller from the Navigator left pane network. No further tries to
communicate with this controller will be made.
If a graphic is specified on the Device Graphic tab of the Navigator Settings (NVS) /
Device Graphic List (DGL) object, the designated site graphic opens instead of the Device
(DEV) object when you open a controller or device from the left pane of Navigator. The
assigned device graphic only displays from the left pane when you open the Device from
the File menu on the Dashboard or use the right mouse Open command.
If you double-click on a controller in the Right Pane of Navigator, then the Device (DEV)
object dialog opens as before.
Load From Flash Restores a saved to flash memory database to RAM in the controller.
This feature is not applicable to all controllers.
Note: The controller pauses operation (i.e. outputs remain at their last state, programs
pause execution) during a Load From Flash. Once the database is loaded into the
controller, it begins operation of the loaded database.
Save To Flash Saves the current RAM database to the controller’s flash memory. Once
saved to flash memory, the database is safe from loss due to power failures. This feature is
not applicable to all controllers.
Note: The controller pauses operation (i.e. outputs remain at their last state, programs
pause execution) during a Save To Flash. Once the database is saved to flash, the
controller continues operation.
Clear Database Clears the current database in RAM. Does not clear the flash memory.
To clear the flash memory, first use the clear database command. Then use the Save to
Flash command. The blank database will be saved to flash memory. This feature is not
applicable to all controllers
Caution: Use these Load From Flash, Save To Flash and Clear Database
commands with care. You may otherwise delete a database from a controller by
mistake.
Update Active Alarm List The active alarm list in a controller can be manually
updated. This may be necessary if the controller has logged into the network without auto
loading the Active Alarm Lists or if the situation arises where the Active Alarm List on the
controller becomes out of synch with the Active Alarm Lists on the other devices.
In the Duration field, a spin box accepts a number from 0 to 65535 and a
dropdown allows you to specify the time unit as either minutes or hours.
Remove Area This command can be used to remove unwanted Area number
inhertances from the BACnet address of system and subnet controllers.
Find Object Search for an object. Use wildcards for a partial name search.
System Objects Reloads system objects such as Zone Controller Formats (ZF)
from the selected controller to ORCAview. This is only needed if you are
communicating with Version 2 controllers.
Active Alarms Reloads the active alarm list from the selected controller device to
ORCAview.
If the selected controller does not support Object security, then the three options are grayed
out. If the selected controller does support Object Security, then the options are available in
the context menu.
When you click on one of the Object Security commands, the following ORS Login dialog
appears:
To request that the controller enter a specific state, the OWS transmits a BACnet
Confirmed Private Transfer containing the requested state, user ID, and password. The
controller response to the BACnet Confirmed Private Transfer is either a BACnet success
or a BACnet error.
Unlock In the Unlock state, the controller allows all requests. The
rules defined in any ORS objects are ignored.
To enter the Unlock state, the request’s User ID and
Password must match the Master SUA specified in
ORS1.
Lock In the Lock state, the controller restricts access to the
controller based on the rules specified in ORS1 (instance
1).
To enter this state: a) the controller is reset, and the
database contains ORS1, or b) the requestor’s User ID
and Password must match the Master SUA specified in
ORS1
Temporary Login In the Temporary Login state, the controller temporarily
enters the login state, where access is based on a
specified ORS other than ORS1. This state remains for
the amount of time specified in the request. If the user
selects Temporary Login, then the request is sent to the
device with a 20 minute timeout.
The ORS that is used is based on the User ID in the
request. The User ID should match one of the SUA’s in
the controller’s database. The ORS used for the rules is
the one specified in the SUA object.
Temporary Login In lockdown mode, the controller is reasonably secure because only
the exposed points are accessible. The service technician must take the device out of
lockdown mode to change the controller’s Object Security rules.
It is possible for a service technician to log in to a controller and make changes without
completely disabling Object Security (i.e. unlocking the controller). A controller-login
request saves the MAC address of the requestor (i.e. service tech) and their corresponding
Object Security level. During the login period, the controller will apply the rules of the
saved Object Security level to all requests from this MAC address while still enforcing the
Object Security rules of the default (ORS1) level for all other device/user requests.
This service technician feature allows tiered access to the controller’s objects,but it has
limitations since the packets are not encrypted and there is no protection from spoofing or
replay attacks. This feature supports up to five simultaneous logins. A user remains logged
in as long as the controller continues to receive requests from the requestor device. Users
are automatically logged out if they remain inactive for the SUA.Auto-Logoff period.
Paste Places copied object info into the selected controllers. The Navigator (Right Pane)
Command >Copy section starting on page 3–39 explains the function including the Cancel
All and OK to All buttons.
Load Loads a complete controller database or single object to the selected controller. For
a BACstat, only the values for the pre-defined objects are loaded.
Note: It is standard practice to load a database from the same controller type into a
controller. However in some situations, it is useful to load a database from a DCU/DSC
controller type into a DAC. DAC products have a smaller amount of database memory than
a DCU or DSC
If a database is too large for a DAC, you can remove some objects (such as unnecessary
Inputs, Outputs, or Trend Logs) or GCL programming from the database before you load
it. You can also delete or rename objects after a database is loaded.
If a database fails to load properly, a failed message appears and the controller will load
the database that was previously saved to flash (or will create the default database if there
is no database saved to flash).
Note: A password may restrict the use of the Save and Load commands. The Save and Load
Password is defined in the Reset field on the Configuration tab of the Device (DEV) object.
You need at least edit permission for the Device object to change this password.
Due to memory size limits, there are some objects that do not function in certain Toshiba
based controllers (DAC, DNT, and DLC products). If you load a database, that contains
any of these objects, into any of these controllers, these objects are loaded, but they are not
functional.
Note: If a database is loaded into a DSC controller that doesn't match the database's
original address, then UDP/IP is disabled and Ethernet is enabled. If UDP/IP is required
on the controller, then the settings in the NET object (i.e. new IP Address) must be set. If
the database is reloaded into the original controller, then UDP/IP is enabled with the
settings that are in the database. This approach avoids circular networks with multiple
controllers having the same IP settings and allows the same database to be loaded in
multiple Ethernet DSC's. A DCU behaves differently as it always disables UDP/IP
whenever a database is loaded.
Save As Saves the selected controller's database to a file for backup purposes. For a
BACstat, only the values for the pre-defined objects are saved.
With DAC/DSC controllers, the Save As and Save All commands cause the controller to
first save the database to flash memory and then to write a copy of the flash contents to the
specified file. The DCU controller does not first save to flash during a Save As or Save All
operation.
Print This option prints information for an object. The amount of detail depends on whether Short
Form or Long Form is selected. From the File menu, select Print Setup and then click either Short
Form or Long Form. See Printing in Navigator starting on page 3–56.
Find New Devices This command looks for new controllers on the network. It will
search for both BACnet and Version 2 controllers.
Find Device This command will search for a specific controller on the network by Panel
Number.
Load All Descriptors This command automatically loads the descriptors from each
controller on the network into ORCAview.
The Load all Descriptors feature is useful for large or slow networks where Auto Loading
descriptors is disabled. It allows ORCAview to load the descriptors from all known
devices for which it has not already loaded descriptors. The user will not have to manually
load the descriptors for every device on the network when Auto Loading desciptors is
disabled.
The Reconnect Bluetooth option is acccessed by right-clicking on the Network icon in the
top left-pane of Navigator. It may take up to 30 seconds to reconnect.
For this feature to be available, a CON-768BT device must be connected to the Service
Port of a hardware device such as a BACstat, DSC or DAC controller. The Bluetooth
connection can be lost due to moving out of range or by losing power when the CON-
768BT is physically moved from one controller’s Service Port to another. The CON-768BT
has a heartbeat feature that the OWS uses to detect loss of communication. The OWS then
displays a message and ask if want to try to reconnect the CON-768BT.
Note: The Navigator Reconnect feature will only function if ORCAview is the only client
connected to SIServer. If other clients are connected (i.e. System Loader, ORCAweb,
Historian etc.), they must be closed prior to using this function.
The laptop needs to have Bluetooth hardware such as a USB Dongle or an internal
Bluetooth device. It must be paired with the proper OUTGOING COM port to define a
serial MS/TP connection with passkey security and a subnet address that does not clash
with an existing address. The CON-768BT is designed to work best with the Windows
Generic Bluetooth stack and the drivers that are included in Windows XP SP2 or later,
Vista and Windows 7. Windows should automatically install the drivers when the USB
dongle is plugged in.
The range of the CON-768BT is limited to 10 meters (33 feet). Using a 100 meter USB
dongle will not improve this range. Sometimes, it may be necessary to move physically
closer to the CON-768BT that you wish to make a connection with especially for an
environment with lots of electromagnetic noise.
Many USB dongles with newer Widcomm or Toshiba (common with Dell laptops)
Bluestacks stacks work with the CON-768BT. The pairing procedures with the Widcomm
and Toshiba stacks are slightly different as described in the CON-768BT Dongle and
Bluetooth Stack Guide found on the Delta Support Site. Refer to the CON-768BT
Installation Guide for detailed information on specifications, installation and configuration
of the device.
8. When connected, the Blue Bluetooth LED is on, and flickering with Bluetooth
communication. Both the red RX and the green TX LEDs flicker with MS/TP
communication activity.
Save All Saves all controller databases on the network. When you click on Save All in
the menu, the following dialog box appears.
Base Name -The Base Name is used for all the output files. It serves as the root name for
all the different devices on the network and the name of the controller is appended to this
Base Name. A new Base Name such as Mar_2004 or Mar07_2004 should be used each
time a backup is done so that the previous files are not overwriten. Typically, a site might
require monthly backups of controller databases and you would keep more than one
complete set of databases for the site. This approach limits the possible effect of any
problematic database that is saved but will not reload if required.
Path - The Browse button allows you to define the Path to the storage location for the
database files.
With 3.33 DAC/DSC or later controllers, the Save As and Save All commands cause the
controller to first save the database to flash memory and then to write a copy of the flash
contents to the specified file. The DCU controller does not first save to flash during a Save
As or Save All operation.
The following procedure allows you to back up all databases on the network with a single
command.
Graphics Folder
These commands are available when the Graphics Folder is right-clicked in Navigator. If
the folder is not visible, do the following:
Right-click on the Graphics folder in Navigator to get access to the following commands:
New Creates either a new Folder for graphics or a new Site Graphic in the current folder.
Find Object Searches for specific object. Use wildcards for a partial name search.
Delete Deletes the currently selected folder and all its contents. A warning message asks
if you want to delete the folder and all its contents.
Properties Displays the ORCAview Settings dialog to edit the Site Graphic Path.
The Print command on the right-click menu is one method of printing an object. You can
also use Print from the file menu on the dashboard. However, the setting of the Print Setup
in ORCAview determines whether a Long or Short form is printed.
Short form Prints a one line summary of the selected object. Short form is the default
setting.
The header has the Username, the date and time that the printout was Generated On, and
the Site requesting the printout.
The Username of the operator initiating the print job is included on the top left hand side of
the Header in the format of Username: <Username>
The Date and Time that the print job executed is displayed on the top right hand side of the
Header in the format of Generated On:
The Site Name is included immediately below the Generated On field in the format of Site:
<Site Name>
The footer has the program (ORCAview) that the printout was Generated By and also a
current page number of the total page count. The system generating the print job is
displayed in the top left of the Footer in the form:
Pagination is displayed in the top right of the Footer: It is in the format of Page <Page#>
of <Total # of Pages?>
Printing Objects
In Long Form, objects now have more comprehensive information.
When you right-click on an object in Navigator and select print, the following symbols may
appear in the printout.
[ Symbol ] Meaning
! Alarm
# Overridden
X OutOfService
A Auto
M Manual
H HVAC,
Access, or
A
Lighting object
L
The following procedures describe how to print using the right mouse Print command. You
can use Print from the File menu on the Dashboard. The Print preview features is no longer
available for objects in ORCAview.
1. Click once on the first object of a list of objects in Navigator. The object should be
highlighted.
2. Press and hold the Shift key.
3. Click on the last object in the list. The entire list will be selected.
4. Right-click on the selected object list and select Print from the menu.
Searching
The Search Menu on the ORCAview Dashboard has a Find Object command that helps an
operator find objects easily even in complex systems. The Find Object command of the
Search Menu is also available from a right mouse click on a device.
Like other ORCAview menus, the Search changes depending on the context. For example,
when the GCL editor is open, the Search Menu includes text searching abilities within the
GCL program.
You can use wildcards in entries. For example, you could enter *AHU*
3. Use wild cards to find groups of objects. For example, if AH* is typed, all objects in
the system whose names start with AH are displayed.
Overview
During the installation of ORCAview, a single site is setup.
Multiple sites are needed in situations when ORCAview is running on a notebook that is
carried from site to site, or a PC that is used to establish remote connections to more than
one site. A new Site Settings object should be created for each different site that
ORCAview will log in to.
You may also transfer the site information from one workstation to another by using the
Auto Site Creation feature. A Site Folder (created when a Site Settings object is created)
may be copied from the Delta Controls Sites directory on one workstation and pasted into
another workstation. ORCAview will automatically create the site from the copied Site
folder the next time you login. Before copying a site in this manner, ensure that a site with
the same site number does not already exist on the target workstation.
ORCAview stores details about each site on the hard disk. This stored information allows
ORCAview to log into a site much faster after the first login.
The new Site Settings object contains details about the site such as whether Navigator was
in details view or list view when ORCAview was last exited. It also holds data about the
controllers on this site and descriptor names for the objects within each controller.
Each site also has a different set of graphics. Creating a new Site Settings object will also
create a new graphics folder within the new site folder. For most installations, the new site
and graphics folders are found in: C:\Users\Public\Delta Controls\3.40\Sites\
New Site Settings objects are only created on the workstation. Do not create or change the
Site Settings objects that exist in the controllers.
2. Type in the information for the General, Advanced, and Application Protocol tabs.
The following three sections describe the tabs of the Site Settings object.
3. Click on the OK or Apply button to save the Site Setting object information.
General
The general tab is used to hold information about the address of the site. The Site Name
must be entered but all other fields in this tab are optional. Names for this object cannot
contain the following characters: / \ “ ‘ * , $ # < >
Advanced
The advanced tab is used to specify the Master and Security Panels on the network. User
logging can be set up here as well.
V2 Master Panel
If the Master Panel is chosen, ORCAview will automatically reload the system objects such
as Units and Scale Ranges from that controller each time this site is logged into.
V2 Security Panel
The chosen Security Panel is the one that ORCAview will use to verify the username and
password typed at the logon screen. The Security Panel must contain a valid user access
object that matches an SUA object on the workstation.
User Logging
The User Logging is used to record activities from users who are logged into the system.
Application Protocol
The application protocol tab is used to specify the protocol that is used to communicate
with the network at this site. By default, BACnet protocol is enabled and Delta Version 2
protocol is disabled.
If the Delta Serial Adapter is selected as the default adapter, the possible options are:
• BACnet Protocol (default)
• BACnet protocol and Delta Version 2 protocol
• Delta MicroNet (Micro/Zone) Protocol
• Delta Version 2 Protocol
If the Ethernet Adapter is selected as the default adaptor, the Delta MicroNet Protocol is
excluded from the list of protocol options.
1. Open the site folder on Workstation 1 and ensure that it includes Lsetup.dbr,
Delta.dbr, setup.dbr, transactions.dbr, and sites.dbr.
2. Copy the individual site folder and paste it into on onto a Network Drive or Floppy
Disk that Workstation 2 has access to.
3. Copy the site folder from the Network drive (or Floppy Disk) and paste it into
C:\Users\Public\Delta Controls\3.40\Sites. Run ORCAview on Workstation 2.
4. You will be able to select the new site from the Sites drop down menu at the
ORCAview login screen.
After choosing to delete a Site Settings object, ORCAview will ask if you want to delete
the site folder as well. The site folder:
• Contains the details about how the Navigator was configured to display that site: and,
• Contains the site graphics folder.
• Contains any saved databases from that site.
Any graphics or databases will be deleted if the site folder is deleted.
If yes is chosen, the entire folder for that site will be deleted. For most installations the
folder in question is found in: C:\Users\Public\Delta Controls\3.40\Sites.
Custom Views
Custom views are used to organize your site by mechanical systems or other criteria. You
can sort by area, by system, by type, or by almost any other criteria you wish. A sample
custom view is already provided in Navigator.
Custom Views sort the controller objects from the project into a hierarchy of folders. The
folders appear in the left Navigator pane in a tree structure and replaces the normal network
view of the system.
Folders can contain sub-folders or objects. The contents of a folder are displayed in the
right Navigator pane, the same as network view.
In the sample view, the following folders are part of the folder Group By Name:
• Objects containing A (The filter is case sensitive.)
• Objects on controller 1 with A
• Objects start with A, B, C
Also in the sample view, the following folders are part of the folder Group By Object Type:
• All Inputs
• All Outputs
• Program and Variables
• Schedules
• Zones and Controllers
3. In the Description field, type the new subgroup name, and click OK. In this example the
new group name is Group by Name.
4. In this example, the new sub group has created the main Sample Custom View folder.
5.
4. Click OK. Navigator will display the newly created view. The new view automatically
contains the special folders Active Alarms and Graphics.
Note: In the filter description, names are case-sensitive. For example, ahu will not produce
the same results as AHU. Object references are not case-sensitive.
Filter Examples
To filter by descriptor name for all objects containing the letter A:
1. Right-click on the folder and select Properties. The ViewGroup dialog box opens.
2. Double-click on a row under the Descriptor column and type *A* . Click Apply to
accept changes and OK to exit. This folder will filter for all objects with an uppercase
A in their descriptor name.
3. In the left Navigator pane click on the folder, Objects containing A. All objects in the
network with an A in their descriptor names will be listed in the right Navigator pane.
The filter is case sensitive and would not pick an object that with a lower case a.
To filter by descriptor name for objects in controller 100 containing the letter A:
1. Right-click on the folder and select Properties. The ViewGroup dialog box opens.
2. Double-click the row under the Descriptor column and type 100.*A* . Click Apply
to accept changes and OK to exit.
3. In the left Navigator pane click on the folder Objects on Controller 100 with A. All the
objects in Controller 100 that have an uppercase A in their descriptor names are listed
in the right Navigator pane. The filter is case sensitive and would not pick an object
with a lowercase a.
2. Double-click on the 1st row under the Descriptor column and type A*
3. Double-click on the 2nd row under the Descriptor column and type B*
4. Double-click on the 3rd row under the Descriptor column and type C*
5. Click Apply to accept changes and OK to exit.
6. In the left Navigator pane click on the folder. All the objects in the system that have
descriptor names starting with an A or B or C, will be listed in the right Navigator
pane. The filter is case sensitive and would not pick an object that started with a lower
case letter.
2. Double-click on the 1st row under the Physical column to enable the checkbox.
3. Double-click on the 1st row under the Descriptor column and type *.AI*
4. Click Apply to accept changes and OK to exit.
5. In the left Navigator pane click on the folder. All the Analog Input objects in the
system will be listed in the right Navigator pane.
To filter by object type for all the Programs and Analog Variables:
1. Right-click on the folder and select Properties. The ViewGroup dialog box opens.
2. Double-click on the 1st row under the Physical column to enable the checkbox.
Double-click on the 1st row under the Descriptor column and type *.PG*
3. Double-click on the 2nd row under the Physical column to enable the checkbox.
Double-click on the 2nd row under the Descriptor column and type *.AV*
Using these commands, it is possible to Export a Custom View, save it to a disk and then
Import it into a different ORCAview workstation of the same version. This would work
with multiple ORCAview workstations.
When a Custom View folder is Exported, all the sub-folders below the top level are also
saved. To Export an entire Custom View, it is only necessary to save the top-most folder.
3. The selected folder and all its sub-folders will be saved to the selected directory.
2. From the ORCAview Dashboard, click File and then click Import…
3. In the Import Custom View dialog box, specify the file you wish to import.
4. To import as a new Custom View, select Import as Root. To import as a sub-folder,
select Import under the current folder. If no folder is selected in the current Custom
View, only the Import as Root option is available.
5. Click Open.
—U — —W —
Update Detail View · 3–25 workstation or controller
—V — right click menu · 3–44
version mismatch · 3–17 —Y —
yellow question mark · 3–13
yellow wrench · 3–15
Chapter 5 Contents
OVERVIEW ........................................................................................................... 5–5
EVENT (EV) ...................................................................................................... 5–9
EVENT HEADER ................................................................................................... 5–9
GENERAL ........................................................................................................... 5–11
SETUP................................................................................................................ 5–12
Name .................................................................................................. 5–12
Alarm Type ........................................................................................ 5–13
Alarm Input ........................................................................................ 5–13
Alarm Lockout (Optional) ................................................................ 5–13
Setup: Time Delay ............................................................................ 5–13
HVAC, Access, and Lighting Checkboxes .................................... 5–14
MESSAGES ........................................................................................................ 5–15
Auto Generated Alarm Messages (DSC/DAC Only) ................... 5–17
EVENT CLASS TAB ON EVENT OBJECT............................................................. 5–20
Event Class ....................................................................................... 5–21
Notification Method .......................................................................... 5–21
Transitions, Send at Priority and Operator Acknowledged ........ 5–21
Destination List Dataview ................................................................ 5–22
DESCRIPTION .................................................................................................... 5–24
ALARM TYPES FOR EVENT ................................................................................ 5–24
Out of Range ..................................................................................... 5–24
Change of State ................................................................................ 5–27
Floating Limit ..................................................................................... 5–30
Command Failure ............................................................................. 5–33
Change of Value ............................................................................... 5–35
Value Type: Bitstring ........................................................................ 5–37
Change of Bitstring ........................................................................... 5–40
EVENT CLASS (EVC) ................................................................................... 5–46
Status ................................................................................................. 5–46
DEFAULT DATABASE EVENT CLASSES ............................................................. 5–47
TABS ON EVENT CLASS OBJECT ...................................................................... 5–56
Setup .................................................................................................. 5–56
HVAC, Access, and Lighting Checkboxes .................................... 5–57
Destination List Tab ......................................................................... 5–58
Description......................................................................................... 5–62
EVENT FILTER (EVF) ................................................................................... 5–63
MAIN .................................................................................................................. 5–63
Name .................................................................................................. 5–64
Priority Override ................................................................................ 5–64
Reference an EVF in an SUA ......................................................... 5–65
HVAC, Access, and Lighting Checkboxes .................................... 5–66
EVENT ROUTER (EVR) ................................................................................ 5–66
Overview
The event management system provides the operator with a method of monitoring
a property of an object and sending alarm notifications to devices. The event
management system is made up of 6 main objects.
Event – EV on page 5–9
Event Class – EVC on page 5–46
Event Router – EVR on page 5–66
Event Filter – EVF on page 5–63
Event Log – EVL on page 5–81
Event Settings – EVS on page 5–94
If you have a site with Version 2 controllers, see Appendix D: – Using ORCAview
with Version 2 Sites.
BACnet Objects The Event (EV) and Event Class (EVC) objects are defined
by the BACnet protocol. In the BACnet specification, these objects are called
Event Enrollment and Notification Class but we call them Event and Event Class
in this document. The event management system is based on the classification of
Events and Alarms as explained in the Notification Method section starting on 5–
21. For example alarms that indicate equipment maintenance is required could all
be classified as Maintenance alarms. The actions that the Event Management
system takes when an alarm occurs are frequently based on the classification of
the alarm. In the example given, the Maintenance alarm could be printed in the
service person's office.
Event objects define the alarm condition to monitor for a specific object. The
Event object contains setup information such as the type of activity that warrants a
notification, the parameters required to set up each type of Event, the object and
property to be monitored and the classification of the Event.
Proprietary Objects The remaining 4 objects are the Event Router, Event
Log, Event Settings, and the Event Filter. These objects are all proprietary to
Delta Controls and cannot be seen by another vendor’s operator workstation.
Event Router (EVR) objects are used to print, page, email, or save alarm
notifications to text files. The Event Router contains setup information such as
destinations for different alarm types and the list of events and event classes that
are routed. It also contains parameters for the setup of email or pager routing.
Event Filter (EVF) objects are used to specify which Event Notifications are to be
ignored by ORCAview. The object also allows the supervisor to specify what
Events are not acknowledgeable or removable by a specific user.
The Event Log object specifies a list of Events or Event Classes. The
corresponding notifications are recorded in the log. The Event Log stores details
for each entry in the log.
The Event Settings (EVS) object is used to set up general device event processing
options. It specifies how large the active alarm list can be in the device, whether
there is a master alarm device on the network and whether to track local or remote
Events. It also holds statistical data about the event management system.
1
Event Transitions to
High Limit
2
Event Management
System checks the
Event Class
3
Alarm Notification is
loaded into Alarm
Notification buffer
4
A Alarm Notification is sent to C
Destination Devices
5 5 5
Local controller Remote DCU ORCAview PC
receives alarm receives alarm receives alarm
notification notification notification
Local controller
6 6 ORCAview tracks all 6
tracks its own active
Event Log Event Router active alarms in its Event Router
alarms in its Active
(EVL) (EVR) Active Alarm List (EVR)
Alarm List
7 7
Physical Printer Physical Printer
Note: The process that has been outlined above is only valid for devices that are
using the default event settings. The Event Management System can be customized
resulting in different alarm processing methods.
Note: In the DAC family of controllers, only DSC controllers can process and
redirect alarms. The other controllers cannot redirect alarms to printers. Remote
DAC’s cannot receive or process alarms.
EVENT (EV)
The Event object’s main purpose is to provide a method for identifying the
conditions that warrant an alarm notification. This is done by selecting an alarm
type and accompanying parameters. The type of Event is selected within the Event
object. The Event object monitors the named property of an object.
Note: An Event object does not function until the monitored Input or Output
object is commissioned. Each Input and Output has a Commissioned field. This
field must be checked. When an Input or Output object is Decommissioned, a Lock
symbol is shown beside it in Details view in Navigator. The Commissioned field
applies only to the products of Delta Controls.
Note: To disable alarm pop-ups dialogs open the user’s SUA object on the Local
OWS, click on the User Data tab and place a checkmark in the field labeled
Disable Alarm Pop-ups. For the changes to take effect the user must log out and
log back in.
Event Header
The header area of the Event object gives details about that particular Event and
its alarm input object.
The header displays the alarm type. The parameters for the particular alarm type
are displayed directly below it. Directly below the parameters the Alarm Input
object is displayed along with its present value.
The previous figure is an Out of Range alarm type. The Low Alarm and High
Alarm fields display before the Alarm Input field.
The header area also displays the Pending Alarm box. The Delay countdown is
also displayed to the immediate right of Pending Alarm. Pending Alarm prevents
the system from sending alarms unless an alarm condition persists for the Time
Delay defined on the Setup tab of the Event object.
The Last Alarm Input Value field displays in the header only for a Change of
Value alarm type when the Value Type field is set to Increment. This field shows
the last value that caused an alarm.
Object Mode:
The Event (EV) object has Auto and Manual modes. You toggle from one mode
to the other by clicking on the hand icon near the top of the dialog. In Auto mode,
the object will function normally and display the status of the monitored object. A
typical status is Normal
In Manual mode, the Event object ceases to monitor the Alarm Input defined in its
Setup tab. When in Manual mode, it is possible to set the status value using the
dropdown list that appears when the object is in manual.
Event Value:
The value of the Event object is dependent on the alarm type that is monitoring
the alarm input.
The Event can have the following values:
Normal The Monitored value is operating as expected for all alarm types.
High Alarm The Monitored value is greater than the High Limit for an Out of
Range or Floating Limit alarm type.
Low Alarm The Monitored value is less than the Low Limit for an Out of
Range or Floating Limit alarm type.
Fault The fault flag of the monitored object is set. This may indicate an I/O
problem such as a broken wire or a device that is off-line. For example, if an
Event object monitors an Analog Input (AI) and a DCU controller is not properly
connected to a Baseboard, then the AI goes into Fault. The Event issues a Fault
alarm.
Trouble This value is part of the BACnet standard but Delta Controls does not
use it.
Unknown This value is part of the BACnet standard but Delta Controls does
not use it.
Further descriptions for the Event values and transitions are given in the
description for each alarm type.
General
The General tab gives general information about the transitions of the Event
object. It displays the time and date when that transition last happened as well as a
transition count since it was last acknowledged. When a transition is
acknowledged the "Transitions since Ack" count is reset back to 0.
Setup
The monitored object the conditions that warrant an Event transition are specified
on the Setup tab. The Setup tab contains such items as the alarm type and
accompanying parameters for the selected alarm type.
Name
This is the name given to the Event object at creation. This is an editable field.
Alarm Type
This field specifies the type of algorithm that will be performed on the alarm input
object and property. When an alarm type is selected the parameters specific to the
type will appear for setup.
Note: With DAC/DSC, when you select an Alarm Type of Change Of Bitstring or
Change of Value, the Use Auto Generated Messages checkbox is automatically
disabled. These alarm types do not automatically generate a message.
Alarm Input
This field specifies the object and its property that is to be monitored by the Event.
The field will accept entries in the following form: *.obj*.property. By default the
property is "Value" but may be changed to any other valid property of the
referenced Alarm Input object.
The following list some examples of Alarm Input entries used to monitor the
following:
• value of analog input 1 on device #1, enter: 1.AI1.Value
• status flags of binary input 1 on device #2, enter: 2.BI1.statusFlags
• fault flags of binary input 1 on device #2, enter: 2.BI1.Flags
In DAC/DSC products, there is no time delay when returning to Normal. All other
transitions apply the time delay. The time delay is enforced as follows in
DAC/DSC products:
In the OWS/DCU, there is a time delay when transitioning to Alarm and when
returning to Normal. Fault transitions do not use the time delay. The time delay is
enforced as follows in the OWS/DCU:
Normal Fault No
Fault Normal No
Alarm Fault No
Fault Alarm No
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Messages
The Messages tab allows a message to be specified for the Alarm, Fault, and
Return to Normal transition messages.
Note: In ORCAview 3.30, the term off-normal was replaced with in-alarm.
The message text edit boxes accept event messages up to 255 characters long for
each transition. The messages are included when the alarm notification is
displayed on the workstation, printed to a printer, or logged to Event Log (EVL).
Note: f a large message is entered and you are using alphanumeric paging or
short text message format to send alarm notifications, then the notification is
truncated to 130 characters.
With a DCU controller, you need to manually enter messages so that the alarm
printouts or print to files are useful. Typically a message would include a concise
description of the problem with a typical response to the alarm. The message can
include the object references (e.g. 890000.AI8) for an object.
The following Alarm Notification shows the Alarm message that was entered in
Alarm field on the Messages tab of the Event (EV) object.
A print out or a print or file using EVR1 might look like the following.
If there is text in the event message fields, then this will be included first with a
space separating it from the auto generated alarm message that follows.
Note: There is a ‘Use Auto Generated Messages’ checkbox in the Messages tab of
the EV object. If it is checked, the Alarm Notification will contain the auto
generated alarm message and the text entered in the message text box. When you
select an Alarm Type of Change Of Bitstring or Change of Value, the Use Auto
Generated Messages checkbox is automatically disabled. These two alarm types
do not automatically generate a message. If the checkbox is unchecked, the Alarm
Notification will only display the text entered in the message text box.
The following figure shows a high limit alarm message for an Out of Range
Alarm Notification.
Event Class
The Event Class object contains user settings like priority levels and
acknowledgement settings. Once an Event Class is selected its settings are
displayed. This makes it easier for the operator to confirm their choice. The data
displayed is not editable from within the Event and must be adjusted through the
Event Class itself. For more details about the Event Class see the Event Class
section starting on page 5–46 of this chapter.
If the EVC field is blank or invalid then by default notifications are sent to EVC1
but Acknowledgement is not required.
Notification Method
Notifications can be specified as either Alarms or Events in the Event Class
(EVC) object. When Event is selected, transitions for this Event Class will not
cause the alarm bell to show up in the monitored object’s dialog header nor in
Navigator's alarm state column for the monitored object or the taskbar tray. When
the Notification Method is set to "Event", the external Alarm Flag is not set in the
status flags of the monitored object. Operation is normal if the Notification
Method is set to Alarm.
This column allows the user to enter either a logical address (e.g., 1.DEV1) or a
physical network address (e.g., NET1).
Note: The default setting of “Broadcast” will not establish dial up connections. In
order to establish a modem connection for an alarm transition, the specific
network number must be entered into the “Device Address” column.
If the device address does not have ‘BROADCAST’ and if ORCAview is NOT
named in the destination list:
1 The Operator Workstation will not display an alarm notification for Events of
that class.
2 The active alarm will not be loaded when commanding the Active Alarms
Folder to Update Alarms.
3 The active alarms of that class cannot be reloaded from a device.
For a logical address, just enter the <device>.<object><instance> or object name
of an object (e.g., 1.DEV3).
The physical network address needs a little more explanation. A physical address
is distinguished from a logical address in that it begins with NETn (where n is a
decimal number or *) or BROADCAST (which is equivalent to NET*). (This may
be entered in lower or mixed case.) A comma (,) is used to separate this from the
network address. 5 formats are supported for the network address.
They are listed below with an example of how you would enter them in the data
view. In each case, ddd is a decimal number in the range 0-255, and x is a
hexadecimal digit (0-F).
• MS/TP or PTP address (1 byte, formatted as ddd) (e.g., broadcast,42)
• 2-byte LonTalk address (formatted as ddd,ddd) (e.g., NET*,9,6)
• 7-byte LonTalk address (formatted as xxxxxxxxxxxxxx) (e.g.,
NET16,45C3B376A60DF8)
• IP address in 3.33: (6 bytes, formatted as xxxx:ddd.ddd.ddd.ddd) (e.g.,
NET46000,BAC0:192.168.8.60)
• where: NET46000 refers to the network that the destination device resides on
and BAC0 is the hexidecimal translation of port 47808 which is the IP Port #
that the destination device is using.
• IP address in 3.40: The format of the IP Address has changed in 3.40. The
Port # has been moved to the end as follows:
• IP address (6 bytes, formatted as ddd.ddd.ddd.ddd:xxxx) (e.g.,
NET46000,192.168.8.60:BAC0)
• where: NET46000 refers to the network that the destination device resides on
and BAC0 is the hexidecimal translation of port 47808 which is the IP Port #
that the destination device is using.
• Ethernet address (6 bytes, formatted as xxxxxxxxxxxx) (e.g.,
NET1,034CFFFF0005)
Input that does not fit any of the above formats is rejected.
Note: Since IP and Ethernet addresses are both 6-byte addresses, they will be
displayed in the IP address format once entered, since there is no way for the
OWS to distinguish between the two in their internal representation.
Retry
If the device fails to send the notification (either because the remote device did not
respond or because a connection could not be established - i.e. dialup failed) then
the notification will be placed onto the notification retry queue. The notification
will be re-sent at a later time.
Process ID
This is a number that a destination device uses to distinguish what "process"
within the device an event notification is meant for. Delta ignores this value when
it receives an event notification and instead looks to the Event Router to determine
what to do with the notification. It is provided in the dialog for setting up events
that are destined for other vendor's devices. For example a vendor may have
process ID #1as a printer and process ID #2 as a file, etc.
Description
The Description tab is provided for the user to give a description of the Event.
This is the standard BACnet description field and can be used for any comments
the user may have. The field can contain up to 2000 printable characters and has
no bearing on the execution of this object.
Out of Range
The Out of Range alarm type is used in situations where an analog property is
monitored and a notification will be generated if its value goes out of a specified
range.
Time Delay The amount of time between the alarm input satisfying the
conditions to alarm and the actual transition. If the alarm input returns to a normal
condition before the timer counts down, the Event will not transition. See the
Setup tab Time Delay field on page 5–13 for information on the handling of
transitions between Normal, Alarm and Fault in DAC/DSC and OWS/DCU
product.
Low Limit The low limit parameter specifies the minimum value the alarm input
can drop to before an Alarm (Low Limit) transition is generated.
High Limit The high limit parameter is used to specify the maximum value that
the alarm input property can rise to before an Alarm (High Limit) transition is
generated.
Change of State
The Change of State alarm type is used when a binary or multi-state object
property is to be monitored. Some examples are freeze status indicators, air
handler filters, smoke detectors, etc.
Time Delay The amount of time the Event will wait, after the alarm input has
changed to an alarm value, before it transitions. See the Setup tab Time Delay
field on page 5–13 for information on the handling of transitions between Normal,
Alarm and Fault in DAC/DSC and OWS/DCU product.
Alarm Values This is a list of values that are compared to the alarm input
property. If the alarm input object property matches one of these values an alarm
transition is generated.
Examples:
The change of state alarm type is also used to monitor multi-state objects. The
following example shows a change of state alarm that monitors the value of a
Device object.
Double clicking in
the “Alarming
Values” field will
produce a list of
possible states for
the Alarm Input
object.
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Floating Limit
The Floating Limit alarm type is used in situations where the high and low limits
must be based on a changing setpoint value. For example, an alarm makes a
transition if the temperature in a room is 3 degrees above or below the adjustable
setpoint for the room.
Time Delay The amount of time that the Event will wait, after the alarm input
object has changed to an alarm value, before it transitions. See the Setup tab Time
Delay field on page 5–13 for information on the handling of transitions between
Normal, Alarm and Fault in DAC/DSC and OWS/DCU product.
Setpoint Reference This field is for specifying the object and its property that
is to provide the setpoint reference. The field will accept entries in the following
form: *.obj*.property. By default, the property is "Value" but may be changed to
any other valid property of the object entered in Alarm Input field.
Low Differential Limit The Low Differential limit parameter specifies the
amount by which the alarm input value must drop below the setpoint reference to
generate a Low-Limit transition.
High Differential Limit The high differential limit parameter specifies the
amount by which the alarm input must rise above the setpoint reference to
generate a High-Limit transition.
Deadband The deadband parameter is set for return to normal calculations. The
role that the deadband plays in the alarm type is shown in the formulas below.
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Command Failure
The command failure alarm type is used in situations where it must be confirmed
that one object is controlling another. For example, you want to know if the fan
turned on based on the current relay feedback value. The command failure alarm
type cannot be used with analog references.
Time Delay The amount of time the Event will wait, after the alarm input has
changed to an alarm state, before it transitions. See the Setup tab Time Delay field
on page 5–13 for information on the handling of transitions between Normal,
Alarm and Fault in DAC/DSC and OWS/DCU product.
Note: For both external and intrinsic alarming, the Alarm Time Delay for
Command Failure alarm can be set for 0 - 65534 seconds. When using feedback
value of a physical output, the Time Delay must be greater than the time it takes to
toggle the output. Otherwise, a Command Failure alarm will be triggered every
time the alarm input value is commanded ON/OFF.
Feedback (Object Reference) This parameter identifies the object and its
property that provides the feedback to verify that the commanded property has
changed value. This parameter may reference only object properties that have
enumerated values or are of the type Boolean. For example: 1.BO1.FBackValue
The command failure alarm type works as follows:
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Change of Value
The change of value alarm type will never generate an off normal alarm
transition. It will only generate a Return to Normal transition for basic notification
purposes. The change of value alarm type can be used to monitor analog or
bitstring data.
Value Type The value type field is for selecting what type of property is going
to be monitored. The user can select bitstring or increment. Increment is the
default selection.
Value Type: Increment The incremental change of value alarm type is used
anytime it is necessary to monitor the incremental changes of a certain analog
value.
An alarm occurs when the absolute value of the difference between the new and
old alarm input values is greater than the Increment setting.
Bitmask The bitmask parameter is used to specify which bits in the string are to
be monitored. Before the Bitmask dataview will work, a valid alarm input and
bitstring property must be entered and the apply button clicked.
When this has been done, the user may double click on the dataview and the
following dialog will appear:
The dialog provides a list of flags in the bitlist. The bits that are to be monitored
can be checked here. The example shown above is set up to send a notification
every time the “Out of Service” bit for a binary input changes.
Double clicking on the BitMask field will produce the Edit Bitlist dialog.
Change of Bitstring
The change of bitstring alarm type is used when the object property that is to be
monitored is a bitstring type. The event generates an alarm transition when the
result of an AND function of the specified bitstring with the Bitmask matches any
of the bitstrings in the list of Alarm Bitstring Values.
If a new alarm condition occurs while the object is already in an alarm condition,
another transition will NOT be generated.
Alarm Input This field is for specifying the object and its property that is to be
monitored by the event. The field will accept entries in the following form:
*.obj*.property. By default the property is "Value" but may be changed to any
other valid property of the referenced Alarm Input object.
When you press Apply, the changed Alarm Input information is saved. However,
any existing Bitmask and Alarm Bitstring Values data is zeroed to avoid a
potential internal bitstring mismatch. You can now set the other fields such as
Bitmask and Alarm Bitstring Values in the normal way and press Apply / OK
when done.
Time Delay The amount of time the Event will wait, after the alarm input object
has changed to an alarm value, before it transitions. See the Setup tab Time Delay
field on page 5–13 for information on the handling of transitions between Normal,
Alarm and Fault in DAC/DSC and OWS/DCU product.
Bitmask The Bitmask field determines what bits in the monitored bitstring are
of interest to the algorithm.
Before you change either the Bitmask or Alarm Bitstring Values fields, you need
to press Apply immediately if the Alarm Input field is changed; this action zeroes
the existing Bitmask and Alarm Bitstring Values data to avoid a potential internal
bitstring mismatch. You can now set the other fields such as Bitmask and Alarm
Bitstring Values in the normal way and press Apply / OK when done.
Alarm Bitstring Values These are the list of bitstrings that are compared to the
result of the ANDed referenced property and the bitmask. If a match is established
the Event will generate an alarm transition.
The List of Alarm Bitstring Values can be made up of many different bit
combinations.
Note: Before you change either the Bitmask or Alarm Bitstring Values fields, you
need to press Apply immediately if the Alarm Input field is changed; this action
zeroes the existing Bitmask and Alarm Bitstring Values data to avoid a potential
internal bitstring mismatch. You can now set the other fields such as Bitmask and
Alarm Bitstring Values in the normal way and press Apply / OK when done.
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Before you change either the Bitmask or Alarm Bitstring Values fields, you need to press Apply
immediately if the Alarm Input field is changed; this action zeroes the existing Bitmask and Alarm
Bitstring Values data to avoid a potential internal bitstring mismatch. You can now set the other
fields such as Bitmask and Alarm Bitstring Values in the normal way and press Apply / OK when
done.
9. Click OK.
10. Now double click in the first row of the Alarm Bitstring Values dataview in the Event.
An Event that does not reference an Event Class will continue to transition
normally, and notifications are generated based on the EVC1 settings but no
acknowledgements are required.
Event Class objects are present in the default database. By default there are nine
Event Class objects in a device. They are named Maintenance, Network, Security,
Critical, Notification, Fire, Access Control Event, Access Control Alarm, and
Archival. The user may create more Event Class objects if needed.
The Event Class assigns each type of transition a priority value. The priority level
is used to determine the order in which notifications are sent out. The Event Class
also specifies what transitions need an operator acknowledgement. Finally the
EVC contains a list of devices to which the notifications are sent.
Note: Event Class objects must be configured in the same way on all devices for a
site. The Critical Event Class on device 1 must be configured the same as the
Critical Event Class on device 2.
The operator can adjust the value of the Event Class. If the value is set to Not
Sending, the notifications for that class of Events will not be sent to any devices.
Setting the value back to Sending results in the notifications being sent out.
Status
The operator can adjust the value of the Event Class. If the value is set to Not
Sending, the notifications for that class of Events will not be sent to any devices.
Setting the value back to Sending results in the notifications being sent out.
The following figure shows the Event Class tab of the AHU1 Filter Event.
A Binary Totalizer is often used to record the run time of equipment for
maintenance purposes. Typically, the total run time in hours and number of starts
are recorded for equipment such as a fan and pump. Most electric motors need
periodic maintenance such as lubrication, or changing of belts. A Binary Totalizer
may be linked to a Maintenance Event object to signal when maintenance is
needed.
An Out of Range Event monitors the Binary Totalizer object and transitions when
maintenance is needed. The following figure shows the Event Class tab of the
AHU1 Filter Event.
The following figure shows two DCU controllers (one an area and one a system
device) and a V3 Zone Device connected by Ethernet and BACnet MS/TP.
If communication fails between the System Device 1 and the Zone Device 2, an
alarm transition will occur.
The following figure shows the Event Class Tab of a Change of State Event that is
monitoring a motion detector.
A Change of State Event monitors the status of a fan motor. The operator is
notified when the return fan motor fails.
The following figure shows the Event Class tab of a Change of State Event object
that monitors a return fan.
An Out of Range event monitors the Supply Air Temperature. The following
figure shows the Event Class tab of the Out of Range Event.
An alarm transition will occur if the Supply Air Temperature is out of the set
range.
Fire Class A Fire Alarm reports conditions that show a fire or smoke alarm.
For example, a Fire alarm might be monitoring the input from a fire panel on site
or from a sensor connected directly to the DCU. The Change of State alarm
monitors the Return Air Smoke Detector Input that detects smoke inside the air
handler.
A Change of State Event monitors the status of a smoke detector in an air handler.
The operator is notified when smoke is detected inside the air handler.
Access Control Event Class This Event Class is specifically used for Access
Control events, and set up internally in the system. The user normally does not
have to set anything up, but can modify the object. See the Access Control
Documentation on Events and Alarms for more information.
Access Control Alarm Class This Event Class is specifically used for Access
Control alarms, and set up internally in the system. The user normally does not
have to set anything up, but can modify the object. See the Access Control
Documentation on Events and Alarms for more information.
Archival Event Class On sites with Historian, polling Trend Logs use this
event class to send notifications to Historian each time a set threshold of samples
are recorded. See the Chapter 6 - Trending, Archiving and Reporting of the
ORCAview Technical Reference manual for more information.
The user normally does not have to set anything up, but can modify the object.
See the Access Control Documentation on Events and Alarms for more
information.
Diagnostic This class is used to notify the user of a diagnostic event such as a
Device Reset. The Diagnostic Event Class (EVC10) is in the default database on a
controller that has a default Event object for Diagnostic events. Currently only an
entelliBUS controller has this EVC10.
Setup
The Setup tab contains settings for transition priorities and acknowledgement. In
most applications the default settings for the Setup tab will not need to be
adjusted.
Send at Priority The Send at Priority setting is used in cases where two Events
become active at the same time. The Event management system uses the priority
value to order event notifications in a notification queue. This includes both
notifications generated by the local device and notifications received from a
remote device. The queue is sorted from 0 (highest priority) to 255 (lowest
priority). Items are taken off of the queue and are routed to local peripherals and
distributed to remote devices.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Device Address The device address is the address of each BACnet device that
will be sent a notification from any Events that reference this class. By default the
column is set to BROADCAST and the notifications will be sent to every device
on the network.
This column allows the user to enter either a logical address (e.g., 100.DEV100)
or a physical network address (e.g., NET1).
Note: The default setting of “Broadcast” will not establish dial up connections.
To establish a modem connection for an alarm transition, a specific device
reference must be entered into the “Device Address” column.
If the device address does not have ‘BROADCAST’ and if ORCAview is NOT
named in the destination list:
1. The Operator Workstation will not display an alarm notification for Events of
that class.
2. The active alarm will not be loaded when commanding the Active Alarms
Folder to Update Alarms.
4. ORCAview will not automatically load the active alarms of that class at login.
The physical network address needs a little more explanation. A physical address
is distinguished from a logical address in that it begins with NETn (where n is a
decimal number or *) or BROADCAST (which is equivalent to NET*). (This may
be entered in lower or mixed case.) A comma (,) is used to separate this from the
network address. 5 formats are supported for the network address. They are listed
below with an example of how you would enter them in the data view. In each
case, ddd is a decimal number in the range 0-255, and x is a hexadecimal digit (0-
F).
Note: Since IP and Ethernet addresses are both 6-byte addresses, they will be
displayed in the IP address format once entered, since there is no way for the
OWS to distinguish between the two in their internal representation.
Always Send Always Send checkbox is enabled the Event Class will always
send alarm notifications. If the Always Send checkbox is disabled added setup
parameters will become available for configuring a specific window of time that
the class is to send alarm notifications to the set destinations.
Retry If the device fails to send the notification (either because the remote
device did not respond or because a connection could not be established - i.e.
dialup failed) then the notification will be placed onto the notification retry queue.
The notification will be re-sent at a later time.
This setting specifies the maximum size of the alarm notification buffer.
The default Max Notification Buffer size on a DCU is 10. The Setup tab of the
Events and Settings (EVS) object, has the Max. Notification Buffers field. Each
alarm transition uses one space in the notification buffer. This means that if an
alarm were to transition, then return back to normal and be acknowledged, the
notification buffer would have three spaces in use. If it is expected that a device
will sending out more than three or four alarms at any one time it may be
necessary to increase the Notification buffer size in the device’s Event Settings
object..
Alarm notifications that are relying on modems for transmission can take minutes
to be sent to their destinations. The DCU uses the Notification Buffer to hold
alarm notifications that have not yet been successfully sent to their destinations. If
a specified destination has gone offline, and there are many notifications that are
waiting to be sent, the notification buffer may become full and overflow. Any
alarms that become active, while the Notification Buffer is full, will not have the
notifications sent. If this situation arises it may be necessary to increase the
notification buffer size.
On a DAC, the maximum value depends on the image size of the controller. The
4Mbit DAC image allows for a maximum value of 100 and the 8Mbit DAC image
allows for a maximum value of 500. On a DSC, the value will be between 1 and
500 inclusive.
Transitions (new for 3.40) The Edit Values dialog provides a way to enable
or disable the To Alarm, To Fault and To Normal options. By default, all three
transition options are selected and notifications for these transitions are sent.
Valid Days Double clicking in the Valid Days column will produce an Edit
Bitlist dialog that allows the user to specify the days that the Event Class will send
the alarm notifications. The Edit Bitlist dialog contains a checkbox for each of the
days of the week. An enabled checkbox shows that the Event Class is to send
alarm notifications to that destination on that day.
From Time The From Time shows the time of day that the Event Class is to
begin sending alarm notifications. The time in this field applies to all enabled days
of the week. The time needs to be entered in the following format 12:00:00.
To Time The To Time shows the time of day that the Event Class is to stop
sending alarm notifications. This time applies to all the enabled days of the week.
The time needs to be entered in the following format 12:00:00.
Description
The Description tab is provided for the user to give a description of the Event
class. This is the standard BACnet description field and can be used for any
comments the user may have. The field can contain up to 2000 printable
characters and has no bearing on the execution of this object.
An Event Filter can be created in the ORCAview PC only. An Event Filter cannot
be created on DCU or DAC products.
Main
The Event Filter for each user is specified in the System User Access (SUA)
object. Each user can use a different Alarm Notification Filter.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Priority Override
The Priority Override will filter the Events or Event Classes specified in the
Disallowed Alarms Dataview based on their "Send at Priority" property.
Events received with a "Send at Priority" equal to or higher than the Priority
Override will not be filtered out by ORCAview. The Priority Override also
removes the user's ability to acknowledge alarm notifications.
The Priority Override option only applies to V3 alarms. V2 alarms ignore the
priority override value stored in the EVF object.
Disallowed Alarms All entries in this column are filtered out. This means that
the alarm notification dialog will not be displayed for the alarm and the active
alarms folder will not display the active alarm.
EVC1 All Event Class #1 notifications from all controllers are filtered
EV1 Event notification 1 is filtered.
*.EVC All event class notifications from all controllers are filtered.
*.EVC2 All Event Class #2 notifications from all controllers are
filtered.
<Controller All Events and Event Classes from a particular controller are
Address>.* filtered.
e.g. 400.*
<Controller All Event Classes notifications from a particular controller are
Address>.EVC* filtered.
<Controller All Event notifications from a particular controller are filtered.
Address>.EV*
<Controller All Event Class 2 notifications from a particular controller are
Address>.EVC2 filtered.
<Controller All Event 1 notifications from a particular controller are
Address>.EV1 filtered.
*.* All Event and event Classes notifications from all controllers
are filtered.
When the Event Filter has been selected, click the Apply button for the filter to
take effect.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7 - Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
The Event Router and the Event Class are used in conjunction with each other.
The Event Class specifies which BACnet devices are to receive a notification.
When the notification is received, the device uses the Event Router to determine
how to handle the notification.
Note: The Event Router is not used to send notifications to other BACnet devices.
The Event Class does this.
The Event Router has 2 states; Routing and Not Routing. These states indicate
whether or not the object is routing based on the Schedule reference. If the state is
Not Routing, the notifications are no longer sent to the specified destination. The
state can be manually changed when the object is in Manual mode.
Name
Name is a descriptive label given to an object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters for the
OWS and DCU, and 1 to 67 characters for DAC products. The name must be
unique among the objects located on the same controller.
Send Acknowledgements
Enabling this checkbox causes the acknowledgements for transitions to be routed
to the specified destination.
Schedule Reference
This field is optional and accepts a Schedule (SCH) or Binary Variable (BV)
object reference. The dropdown only lists the SCH objects but a BV object
reference can be manually typed into this field.
If the object referenced in the Schedule Reference field is inactive then the Event
Router will not route to the specified destination. If the object is active then the
Event Router will route to the specified destination.
The fields in the Class and /or Events to Route section provide the means to filter
the Alarm/Events that are routed by the EVR object.
The Classes and Events that are to be routed by this Event Router are entered in
this field. Alarm notifications from a specified event or an event that references a
specified event class are routed.
Class / Event
Local and remote CEL and EV objects can be referenced in addition to global
EVC objects. Since CEL can only send ACK-not-required events, the Ack Not
Req type has to be filtered in EVR, otherwise email for CEL events will not be
sent out. Ack Not Req is filtered by default, and it can be edited from the Ack
field. The choices in the drop-down include all the EVCs and EVs that are in the
controller.
• EVC* - All alarms of all Event Classes are routed on the current
controller
• *.EVC* - All alarms of all Event Classes are routed from all controllers
Since Event classes of the same instance in all devices must be the same
(100.EVC1 == 200.EVC1), if EVC1 is referenced in the Event Router, then all
Events of that class, regardless of which device they originate from, are routed.
Transition Bits
This field specifies which events to route based on transitions defined in the Setup
and Destination List tabs of EVC objects. If a Transition is selected in the EVR,
then it is routed by this EVR. In the Alarm Filtering tab of the EVR object, the
available options for the Transition Bits field are To Alarm, To Fault and To
Normal.
If you double click on an entry within a selected row, then an Edit Values dialog
appears. Modify the selected values and then click OK.
Min Priority
The Min and Max Priority fields work together to specify events to route.
The range of this field is from 0 to 255 with a default value of 0. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appear.
Modify the selected values by clicking on one of the arrows or by entering a value
into the field.
The Priority that the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Max Priority
The Min and Max Priority fields work together to specify events to route.
The range of this field is from 0 to 255 with a default value of 254. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected values by clicking on one of the arrows or by entering a value
into this field.
The Priority for the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Ack
The Ack field provides a way to filter what Events to route based on the setting of
the Operator Acknowledged checkboxes in the EVC object. If you double click on
an entry within a selected row, then an Edit Values dialog appears. Modify the
selected values and then click OK. All the available options are selected in the
previous figure.
Setup
The Setup tab is where the user can set up the type of event router. The Setup tab
is used to select the type of destination, along with destination specific settings,
that the Event Router is routing to.
Destination Type
The Destination Type drop down box is used to select what type of destination the
Event Router will send the notifications to.
The available options in this list depend on the type of device that you create the
EVR object in. Some Destination Types are only available in certain types of
devices. The available Destination Types for the different device types are listed
below:
The following table summarizes the available Destinations and Alarm Escalation
options on the Destinations / Alarm Escalation tab for a DSC controller:
Message Format
This drop down box is available for all the Destination Types. This field is used to
select the format of the notification message. The available options for this field
depend on the Destination Type that is selected.
Long Text has a message limit of about 350 characters and Short Text has a
message limit of about 130 characters. Short Text and Long Text formats apply to
both Email and Printer Destinations.
Short Text This format contains just the Event Class (EVC) that is associated with
the notification, and the message that was generated by the notification.
The layout of this format is:
<Event Class> - <Message>
When using the EVR object to send alarm notifications to an Alphanumeric pager,
messages sent to the pager are limited to 130 characters. If the message is larger
than 130 characters, three dots (...) are appended to the end of the message
indicating that there is more to the message. Since pagers are limited to about 140
characters themselves, a limit of 130 characters was chosen, to leave some
characters for the added timestamp. There is no point sending more characters as
the pager and/or pager system may simply truncate long messages or possibly
discard the entire message.
File Name
Only the Print to File Destination Type contains the File Name field. The default
file name is Print_Output.txt.
Printer Name
On an OWS, the Printer Name field appears only for an EVR object that was
created for a Windows Printer. This field is not applicable to the DSC.
Port Status
This read-only field is only visible for Printer (Local) and Pager/SMS Destination
Types. This field displays the status of the PTP port of the controller.
When the Destination Type is set to Local Printer, communications on the PTP
port is disabled since the port will only be used to send notifications to the printer
and the Port Status field will display “Driver Disabled”.
When the Destination Type is set to Pager/SMS, the EVR will only use the PTP
port when it needs to send a notification, and as soon as it is done, it will release
the port. When the EVR object is using the PTP port to send out a notification, the
Port Status field will display “Active”. When the EVR object is not using the PTP
port, the Port Status field will display “In Use By”, indicating that the NET object
is using the port for communications.
Baud Rate
This drop down box selects the speed between the PTP port on the controller and
the modem or printer. The following speeds are available: 9600, 19200, 38400;
with 9600 being the default. Both ends of a Point-to-Point connection must use the
same speed.
Dial Retries
This spin box is used to set the number of modem redial attempts. The field
accepts a value from 0-10. The default is 2 retries.
Init String
This field specifies the string that is used to initialize the modem. This string is
sent to the modem when the controller is reset and when the modem ends a call.
Refer to your modem manual for more details on the correct Initialization String.
Modem Type
The initialization string is defined for the modem based on the Modem Type
selection. Select your modem from the drop down list or chose Custom to enter a
user defined Modem initialization string. The choices from the drop-down are:
U.S. Robotics, USR (Quick Connect Disabled), Zoom, Boca, and Custom. Based
on the selection, the initialization string uses standard settings for a particular type
of modem.
Dial Prefix
This field specifies the string that is sent to the modem when starting a
connection. It tells the modem to get ready to dial.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
If the selected Destination Type does not require a destination (Local Printing,
HTTP, File, or Windows Printer), this tab will display “Destination(s) not needed
for the selected Destination Type”.
Email is selected as the Destination Type on the setup tab for the following screen
capture.
Current Selection
The number of the selected record in the dataview. For example if the Current
Selection is 7, that means that the seventh record in the dataview is selected.
Status
This field displays messages about whether the last notification was sent
successfully or if there was a problem. For example, a successful message could
be “Page sent Successfully”.
The following table lists some common error messages that could be displayed in
the Status field along with possible reasons for the error.
Paging error, Possible invalid Pager id Indicates a problem with the Pager Number field.
Make sure that the area code is not entered in the
Pager Number fields for alphanumeric paging. The
TAP gateway service rejects the area code.
Unexpected Disconnect… The TAP gateway is not responding or it rejected the
message (i.e. invalid or non-printable characters are
in the Message).
Alarm Escalation is only applicable for Email and Pager/SMS Destination Types.
If Alarm Escalation is not applicable for the selected Destination Type (HTTP,
Local Printing, File, or Windows Printer), this tab will display “Alarm Escalation
is not applicable for the selected Destination Type”.
Current Destination
This field displays the corresponding entry in the Destinations list that the EVR is
sending notifications to during the escalation cycle. Assuming Auto Escalation is
enabled, this value will begin incrementing at the First Destination to Try, jump
back to the beginning of the list once it reaches the end, and stop at the First
Destination to Try.
Auto Escalation
Auto Escalation means that the EVR object automatically escalates through all
destinations one at a time. When Auto Escalation is disabled, GCL is required to
control the Current Destination (EscalationIndex property of the EVR object).
Using GCL to control the Current Destination allows for implementing Alarm
Escalation capabilities that will suit a required purpose. Auto Escalation is enabled
by default.
Retry Interval
This spin box specifies the interval (in minutes) between sending notifications.
The minimum interval that you can specify in this field is 1 minute. The default is
5.
Debug Messages
This field displays the last message that was sent. It is used to ensure the proper
message was sent and ensure its format. It can also be used to compare the
message that the EVR sent with what the user actually received.
Description
The Description tab is provided for the user to give a description of what the
Event Router is doing. This is the standard BACnet description field and can be
used for any comments the user may have. The field can contain up to 2000
printable characters and has no bearing on the execution of this object.
Note: For users who have Historian installed with their ORCAview system
package: The first time Historian is started, three Event Logs and three Event
Routers are created by default in the Historian database. The three default logs
generated by Historian are the Alarm Log, the Access Control Log, and the
Access Control Alarm Log. There is an Event Log for all non-Access related
events (EVC 1-6), an Event Log for Access Events (EVC7) and an Event Log for
Access Alarms (EVC 8). These Event Logs theoretically have an unlimited
maximum number of storable entries. Historian EVLs cannot be deleted. Users
can create additional EVLs on the Historian which will have an unlimited
maximum number of storable entries.
Log Tab
The Log tab contains the entries of alarm notifications that were routed to the
Event Log.
Top Dataview:
The top dataview is the main Log. It displays alarms in chronological order. Each
transition is displayed in the top dataview. When an entry in the top dataview is
highlighted, the bottom area will give more details about the entry.
Alarm Input The alarm input for the Event that transitioned.
Time and Transition This column shows the time of the transition as well as the
specific transition that occurred.
The bottom area gives more details about the entry that is highlighted in the top
data view.
The following four fields are included in the Log Entry Details displayed at the
bottom of the EVL dialog.
Event Class This shows the class that the Event is a member of.
Event Class This shows the class that the Event is a member of.
Last Alarm Input Value This field shows the last value that caused an alarm.
This field displays in the header of the EV object only for a Change of Value
alarm type when the Value Type field is set to Increment.
Alarm Input Value Value of alarm input that caused the transition.
Exceeded Limit The high or low limit that was exceeded. The high limit
parameter is displayed for high limit entries; likewise the low limit parameter is
displayed for low limit entries.
Exceed High/Low Limits The high or low limit that was exceeded. The
calculated high limit is displayed for high limit entries; likewise the calculated low
limit is displayed for low limit entries.
COV Type Indicates if the change of value alarm is monitoring an analog value
or a bitstring.
Increment The final value of the alarm input object after the increment.
Bitmask Indicates the bits in the monitored bitstring that are set.
Note: The details given at the bottom of the Event Log are alarm type specific. In
other words, the details given about an Out of Range alarm are different from the
details given for a Change of State entry.
Exceeded Limit:
The high or low limit that
was exceeded. The high
limit parameter is displayed
for high limit entries,
likewise the low limit
parameter is displayed for
low limit entries.
Deadband:
Field no longer exists.
Event Status:
Indicates if that transition
required an
acknowledgement.
Exceeded High/Low
Limits:
The high or low limit that
was exceeded. The
calculated high limit is
displayed for high limit
entries, likewise the
calculated low limit is
displayed for low limit
entries.
Setpoint:
The value of the setpoint
object referenced in the
Event.
Feedback (Object
Reference):
Value of feedback object at
time of transition.
COV Type:
Indicates if the change of
value alarm is monitoring an
analog value or a bitstring.
Increment:
The final value of the alarm
input object after the
increment.
COV Type:
Indicates if the change of
value alarm is monitoring an
analog value or a bitstring.
Bitmask:
Indicates the bits in the
monitored bitstring that were
set.
Acknowledgement Entry
Describes the
user and the
device that
acknowledged
the alarm
notification.
Buffer Ready
Event Status:
Setup
The Setup tab contains settings.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Reliability
The Reliability field shows the state of the reliability flag for the Event Log
object. Under normal operating conditions it displays “No Fault Detected”
Historian Note: This field is not adjustable for EVLs created on the Historian
Device. EVLs on Historian can hold a theoretically unlimited number of events.
Caution: Adjusting the Maximum Log Entries value will result in the Event
Log being reinitialized and all entries being removed.
Event Class The Event Class drop-down box allows the notification’s event
class to be chosen. The choices available reflect the EVCs that are in the
controller. When the threshold is exceeded, a notification dialog displays if the
Event Class has Operator Acknowledged enabled for “Return to Normal”
transitions.
Threshold The Threshold field specifies the number of log entries recorded
before an event occurs. When the number of records is exceeded, the threshold
count is reset. Another event will occur if the number of records exceeds the
threshold value. This setting causes event to occur at multiples of one plus the
threshold value. For example, if the Threshold is set to 5, then an event occurs at
6, 12, 18, etc. record counts.
Records Since Last Notification The Records Since Last Notification field
shows the number of samples since a notification was issued.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Schedule Reference
If the SCH object referenced in the schedule reference is inactive then the Event
Router will not route to the named destination. This field is optional. The field
accepts only SCH object. If the schedule object is on then the notification will be
sent to the named destination. Schedule object must be on the same device as the
Event Router.
The fields in the Class and/ or Events to Log section provide a way to filter the
Alarms / Events that are logged by the EVL object.
The Classes/Events to log are entered in this field. Any specified alarms or
notifications from alarms which reference an Event Class found in this
Class/Event list are logged.
Class / Event The user selects or enters the class of alarm notifications that are
to be logged to the EVL.
The user may also enter the Remote Events. The choices in the dropdown include
all the EVCs and EVs that are in the controller.
• EVC* - All alarms of all Event Classes are routed on the current
controller
• *.EVC* - All alarms of all Event Classes are routed from all controllers
Since Event classes of the same instance in all devices must be the same
(100.EVC1 == 200.EVC1), if EVC1 is referenced in the Event Log as a class of
alarms to log, then all Events of that class, regardless of which device they
originate from, are logged.
This field specifies which events to log based on transitions defined in the Setup
and Destination List tabs of EVC objects. Event objects use EVC objects to
specify behavior based on the assigned Event Class.
Transition Bits
The available options for the Transition Bits field are To Alarm, To Fault and To
Normal. If you double click on an entry within a selected row, then an Edit Values
dialog appears. Modify the selected values and then click OK.
Highest Priority
The Highest and Lowest Priority fields work together to specify events to log.
The range of this field is from 0 to 255 with a default value of 0. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected value by clicking on one of the arrows or by entering a value
into the field.
The Priority for the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Lowest Priority
The Highest and Lowest Priority fields work together to specify events to log.
The range of this field is from 0 to 255 with a default value of 254. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected value by clicking on one of the arrows or by entering a value
into the field.
The Priority that the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Event Flag
The available options are Ack Req, Ack Not Req and Send Ack. If you double
click on an entry within a selected row, then an Edit Values dialog appears.
Modify the selected values and then click OK.
Description
The Description tab is provided for the user to give a description of what the
Event Router is doing. This is the standard BACnet description field and can be
used for any comments the user may have. The field can contain up to 2000
printable characters and has no bearing on the execution of this object.
The Event and Alarm Settings is present in the default database. Event and Alarm
Settings cannot be created or deleted.
The Event Setting object contains two tabs.
• Setup on this page
• Stats starting on page 5–96.
Setup
The Setup tab contains general event management settings for the device.
V3 Alarms to Track
The alarms to track menu allows the user to select which active alarms are to be
tracked by the device. The alarm to track menu has three possible selections.
• None– The device will not track any Events. If this is selected the Auto load
active event list and master alarm device properties are not available.
• Local– Tracks only the events on the local device.
• Local & Remote– Events from all devices will be tracked. This option is
only available on an OWS.
By default ORCAview tracks local and remote alarms and the DA/DSC/DCU will
only track its own local alarms.
The DAC/DSC does not support being an "Alarm Master", and can only track
local alarms and not remote alarms. The 'V3 Alarms to Track' droplist no longer
has the "Local & Remote" option so that it is clear that the DAC/DSC cannot be
an Alarm Master.
On an OWS/DCU, this value will auto increase to a maximum value of 500 with a
minimum value of 1.
On a DAC, the maximum value depends on the image size of the controller. The
4Mbit DAC image allows for a maximum value of 100 and the 8Mbit DAC image
allows for a maximum value of 500. On a DSC, the value will be between 1 and
500 inclusive.
The default Max Notification Buffer size on a DCU is 10. The Setup tab of the
Events and Settings (EVS) object has the Max Notification Buffers field. Each
alarm transition uses one space in the notification buffer. This means that if an
alarm were to transition, then return back to normal and be acknowledged, the
notification buffer would have three spaces in use. If it is expected that a device
will sending out more than three or four alarms at any one time it may be
necessary to increase the Notification buffer size in the device’s Event Settings
object.
Alarm notifications that are relying on modems for transmission can take minutes
to be sent to their destinations. The DCU uses the Notification Buffer to hold
alarm notifications that have not yet been successfully sent to their destinations. If
a specified destination has gone offline, and there are many notifications waiting
to be sent, then the notification buffer may become full and overflow. Any alarms
that become active, while the Notification Buffer is full, will not have the
notifications sent. If this situation arises it may be necessary to increase the
notification buffer size.
On an OWS/DCU, this value will auto increase to a maximum value of 500 with a
minimum value of 1.
On a DAC, the maximum value depends on the image size of the controller. The
4Mbit DAC image allows for a maximum value of 100 and the 8Mbit DAC image
allows for a maximum value of 500. On a DSC, the value will be between 1 and
500 inclusive.
Stats
The Stats tab gives details such as the number of times a certain processes have
taken place and the number of times that errors in the event management system
have occurred. The data in this tab is provided for troubleshooting the event
management system.
Active Events Shows the number of events that are currently active on the
device.
Events Generated This provides a count of how many transitions have occurred
on the device.
Activity List Overflows The number of times the device could not provide a
complete update of an event activity list. If this count is increasing the solution is
to increase the “Max. Event Activities in List” setting.
Activity Lists Missing The number of times an event activity list object for an
entry in the active list is not in the database.
Activity List Deletion Failed The number of times the system did not delete a
known existing event activity list. This may happen when the maximum number
of event activity objects is decreased in the event Settings object and the number
of activity lists fails to decrease to the new setting.
General Activity List Error The number of times errors occurred within the
activity list.
Failed to Initialize Destination List The number of times the system was
unable to initialize the destination list in an event notification. The list of
destinations in the notification is based on the one provided by the Event Class.
Event Class Missing The number of times there was no Event Class for the
Event.
Notifications Statistics
The notifications area of the Stats tab contains statistical data about the
notifications received by the device.
Retry Count The number of Event notifications requiring one or more retries to
send.
Notification Buffer Overflows The number of times that an Event Class could
not get a notification buffer.
Event Text Lost The number of times the system was unable to fit the event
text into the notification.
Event Info Lost The number of times the system was unable to fit the Event
information into a notification.
Acknowledge Text Lost Number of times the system was unable to fit the
acknowledgement text into the notification.
Notifications Missing The number of times the notification was in the buffer
but not in the database.
Notifications Missed The number of times a notification was received & not
processed for one reason or another.
Notification Deletion from Buffer Failed The number of times the notification
could not be deleted from the buffer. This may happen when the maximum
number of notification buffers is decreased but some of the entries weren’t
deleted.
Tracking no Alarms
The device may be configured such that it will track no alarms at all. This feature
may be used when only one device on the network is acting as the Master Alarm
List Device. The master alarm list device will be used to track all alarms on the
network. Here there will be no active alarm list on the device. It will not track the
alarms that are local or alarms that have been sent from any remote devices.
Note: If the DCU is to track local alarms it may be necessary to increase the
Maximum Event Activities in List setting in the device’s Event Settings object.
2. Adjust the V3
Alarms To Track
setting to “Local
and Remote".
Alarms can be opened, acknowledged or deleted from the Active Alarms folder.
This can be done by right clicking on the alarm entry and choosing either Open,
Acknowledge or Delete.
With 3.40, The AAL now updates every five minutes rather than every time that it
receives an alarm.
Active alarms
Folder
The above figure shows how two transitions of the alarm are displayed in the
active alarm folder.
To update active
alarms folder, right
click and select
“Update Alarms”
Select Active
Alarms here
Once Navigator is in “Show active alarms” view it will give the details about the
active alarms on the device. Navigator will appear as shown below.
From this view the active alarms can be opened, acknowledged or deleted just as
they can when the viewing the active alarms folder.
Note: Updating the active alarm list on the device is not the same as reloading
the active alarms from it. Updating the active alarm list commands the device to
update its own active alarm list and doesn’t load it into ORCAview.
The following figure is from ORCAview 3.40 running on Microsoft Windows 7.
Printing Alarms
ORCAview also makes it possible to send alarm notifications to a printer
connected to the PC or to a print-to-file. If there is a local or network printer
installed under Windows, alarms can be printed to a printer. The DCU is also
capable of printing alarm notifications to a parallel port. If the DCU has a
DXC053 PC/104 expansion card installed this feature is available to the user.
Event Class
Alarm Input
Event Class
(only shown if
acknowledgement was from
an ORCAview OWS)
DSC and DAC controllers support auto generated text alarm messages.
The printout has headers and footers. The header contains the username,
generation date and time, and the site name. The footer contains the name of the
application and the page count of the total pages in this printout. The contents of
the headers and footers are the same as the ones created when objects are printed.
Many sites use a dot matrix printer to log Alarm Notifications from an
ORCAview OWS. The print driver Generic / Text Only needs to be installed and
configured to print using a dot matrix printer.
To install the Generic / Text Only print driver for a dot matrix printer:
1. Double click on My Computer, double click on Control Panel and then
double click on Printers. The following window displays.
2. Double click on the Add Printer Icon to create the new Generic / Text Only
Printer. The Add Printer Wizard starts.
8. Click finish to complete the installation and to print a test page. After the
printer is installed, it must be properly configured.
9. Right click on the Generic / Text Only Icon in the printer window. Select
properties. The following window displays.
11. Select Std Fanfo as the paper size and Continuous – No Page Break as the
Paper Source. Click OK to finish the configuration of the printer.
Printing to File
Printing to a file is done in the same way as printing to a Windows printer.
Printing to a file is only possible in ORCAview. A DCU is not capable of printing
alarm notifications to a file. By default ORCAview creates one Event Router
object for printing to a file. There can be only one file created by ORCAview for
printing alarms. It is not possible to create more than one EVR object for printing
to files.
2. Select the Schedule object as the Schedule Reference. If the SCH object
referenced in the schedule reference is inactive then the Event Router will not
route to the named destination.
When using the EVR object to send alarm notifications to an Alphanumeric pager,
messages sent to the pager are limited to 130 characters. If the message is larger
than 130 characters, three dots (...) are appended to the end of the message
indicating that there is more to the message. Since pagers are limited to about 140
characters themselves, a limit of 130 characters was chosen, to leave some
characters for the added timestamp. There is no point sending more characters as
the pager and/or pager system may simply truncate long messages or possibly
discard the entire message.
DSC Pager/SMS The DSC can send messages to a pager or a device with
Short Message Service (SMS) capability such as a cellular phone. SMS is a
message service offered by the GSM digital cellular telephone system.
Sending a message to an SMS device works the same way as sending a message
to an alphanumeric pager by using the TAP protocol. A major benefit of using
Alphanumeric paging or SMS messaging is that it does not need any IT
infrastructure. Unlike Email, it only needs a phone line and modem connected to a
controller.
Many Telephone Companies provide modem access to their SMSC (SMS Central
Server) using TAP (Telocator Alphanumeric Protocol). In order to use SMS
messaging, arrange with your Telephone Company to receive access to this
service and to obtain the phone number and the modem communication
parameters (i.e. 2400 baud, 7 data bits, 1 stop bit, Even parity).
The TAP Gateway is a terminal that receives alphanumeric messages via a modem
connection and sends the messages to an alphanumeric pager or cellular phone
capable of handling text messages. The Telelocator Alphanumeric Protocol (TAP)
is an industry standard protocol for sending alphanumeric messages.
The TAP Gateway phone number can be provided by the pager service provider.
The following website contains phone numbers of various TAP Gateways
throughout the world:
http://notepager.net/tap-phone-numbers-a.htm
To configure the System User Access (SUA) object for alphanumeric paging
1 Create a new SUA object on the controller for every user that will receive an
alphanumeric page.
2 In the Phone Number field of the User Data tab of each SUA object, enter the
Telelocator Alphanumeric Protocol (TAP) number provided by the
Alphanumeric Pager Service Provider. In the Pager Number field, enter the
pager number.
The number in the Phone Number field is what the modem will dial when it picks
up the line. If it needs to dial 9 to get an outside line or to dial an area code such as
604, then it must be entered in this field.
The number in the Pager ID field is sent to the TAP Gateway so that it knows the
pager to which the message needs to be sent. Some TAP Gateways may require an
area code (e.g. 604) before the number, otherwise the message will not go
through.
When using the EVR object to send alarm notifications to a numeric pager,
messages sent to the pager are entered in the SUA object.
To configure the System User Access (SUA) object for numeric paging
1 Create a new SUA object on the controller for every user that will receive a
numeric page.
2 In the Phone/TAP Number field of the User Data tab of each SUA object,
enter the pager number directly followed by the numeric message to be sent.
Leave the Pager Number field blank.
For example: if the numeric pager number is 6043208244 and you want to send a
page with the numeric message "1234".
In the SUA object, enter the following in the Phone/TAP Number field:
6043208244,,,1234#
The commas provide delays. Each comma results in a two second delay. The #
symbol indicates the end of message.
The following is needed in order for the controller to send email notifications:
• DHCP Server or static IP address
• SMTP Server
• DNS Server for SMTP server lookup or static IP address of SMTP server
Note: Some SMTP Servers require that you use a valid E-Mail Account (in the
from field) when sending emails. Check with your network administrator to ensure
you are using a valid email account.
1 In the Time Info tab of the DEV object, check the UTC Enable checkbox and
set the UTC Offset. The EVR object puts the UTC Offset value in the email
header for the time/date that the email was sent.
The UTC Offset in the DEV object must be specified when sending emails with
the EVR object.
To configure the Panel for a static IP address (skip this section if you have a
DHCP server)
1. Uncheck DHCP. Enter the IP address, subnet mask, gateway address and
DNS Server.
To configure the System User Access (SUA) object for email notification
1. You will need to create a new SUA object on the controller for every user that
will receive an email notification.
2. In the Email Address field of the User Data tab enter the user’s email address.
Notification Buffers
In order to ensure all alarm notifications are delivered to the Email server, the
EVR object utilizes the notification buffers. As a result, the Max Notification
Buffers setting in the EVS object of the alarm routing controller may need to be
adjusted.
Note: The controller must be reset after adjusting values in the EVS object.
If the EVR object simultaneously receives multiple alarm notifications, the speed
at which it sends the notifications to the Email server primarily depends on how
fast the server can respond. The EVR may buffer some notifications and retry
them later if it cannot communicate with the server fast enough.
Note: Alarm notifications are not buffered; they are just retried. They are
discarded if undeliverable within 3 attempts (i.e. if the server is offline).
The Notification Buffer Overflows value in the Stats tab of the EVS object can be
observed to determine if there are enough notification buffers. If this value is
increasing, the Max Notification Buffers should be increased.
The Notification Retry Interval setting in the EVS object can also be adjusted.
This value specifies how long before the buffered notifications will be retried. By
default, this value is 60 seconds, and in most cases is sufficient.
Introduction
HTTP alarm notification is a sub-component of a Central Site Management
System (CSMS), and is used to implement enterprise-level centralized alarm
management. It consists of sending BACnet alarm notifications to a Web server
via HTTP (HyperText Transport Protocol), which can then be recorded in an
SQL-type database.
The Web server must be set-up to provide a URL that identifies a server
application (i.e. ASP or PHP web page) that will receive the alarms sent by the
alarm routing device. Typically, the Web server then logs the alarms in a database
that forms the basis of a centralized alarm management and dispatch system.
Features
HTTP alarm notification is capable of:
• Relaying alarm notifications received on the BACnet network across the
Internet to a Web server.
• Sending to multiple destinations (URL’s) with the ability to filter or
segregate alarms (since the URL is defined on a per EVR basis).
• Ensuring all alarm notifications are delivered to the Web server by
utilizing notification buffers.
Limitations
There are a few limitations of HTTP alarm notification:
• The Web server must be online at all times since alarm notifications are
NOT retained – they are only retried. If a notification is undeliverable
within 3 attempts, it is discarded.
• Web server authentication is NOT supported – the server must simply
accept the incoming POST requests.
• Alarms cannot be acknowledged via this feature – it is only for
notification purposes (like paging and email notifications).
Id=<value>&Time=<value>&Class=<value>&Type=<value>&Algo=<value>&Msg=<valu
e>&To=<value>&From=<value>&MValue=<value>&P1=<value>&P2=<value>
Event Object P1 P2
Algorithm
Change of Bitstring Not Used Not Used
Id=100.EV4&Time=11:23:16+11-Feb-2006&Class=Maintenance&Type=Alarm&Algo
=Floating+Limit&Msg=AHU1+Supply+Air+Temperature+is+out+of+range&To=High+L
imit&From=Normal&MValue=81.3000&P1=75.0000&P2=80.0000
Note: Make sure to specify IP settings (IP Address, Subnet Mask, Gateway, and
DNS Address) in the Device (DEV) object, under the Internet tab.
Notification Buffers
In order to ensure all alarm notifications are delivered to the Web server, the EVR
object utilizes the notification buffers. As a result, the Max Notification Buffers
setting in the EVS object of the alarm routing controller may need to be adjusted.
Note: The controller must be reset after adjusting values in the EVS object.
If the EVR object simultaneously receives multiple alarm notifications, the speed
at which it sends the notifications to the Web server primarily depends on how
fast the Web server can respond. The EVR may buffer some notifications and
retry them later if it cannot communicate with the Web server fast enough.
The Notification Buffer Overflows value in the Stats tab of the EVS object can be
observed to determine if there are enough notification buffers. If this value is
increasing, the Max Notification Buffers should be increased.
The Notification Retry Interval setting in the EVS object can also be adjusted.
This value specifies how long before the buffered notifications will be retried. By
default, this value is 60 seconds, and in most cases is sufficient.
Status Messages
The Status field in the EVR object displays the Web server responses. If an alarm
notification was sent successfully, it will display “HTTP/1.1 200 OK”. The
following table lists common error messages and possible causes. Refer to
documentation on the Web server for information about other error messages.
Once the Web server receives a notification, it can be manipulated (i.e. by using
ASP or PHP) and possibly sent to an SQL-type database.
If fso.FileExists("C:\\Inetpub\\wwwroot\\CSMS\\log.txt") Then
Set BrowserInfoFile = fso.OpenTextfile("C:\\Inetpub\\wwwroot\\CSMS\\log.txt", 8, true)
'append
Else
Set BrowserInfoFile = fso.OpenTextfile("C:\\Inetpub\\wwwroot\\CSMS\\log.txt", 8, true)
'append
End If
BrowserInfoFile.Close
%>
</HTML>
fwrite($handle, "\n");
DSC PRINTING
This section explains printing for:
• DSC Serial Printing starting on this page
In order to connect a parallel printer to the PTP port on a DSC, or to the serial
connection on a modem, a serial-to-parallel converter is required. When choosing
a serial-to-parallel converter, the following must be considered:
Although a non-buffered converter will work for local printing (as long as it
supports software flow control), it is not recommended.
For local printing, the converter must have an external power supply. It cannot be
powered off the DSC’s serial port.
The converter must be able to convert from serial to parallel. Converting from
parallel to serial is not required.
The fastest speed that is supported by the DSC is 38400, so a converter that works
faster than 38400 is not required. The speeds that the DSC supports are: 1200,
2400, 4800, 9600, 19200, and 38400.
The converter must support 8 data bits, no parity, and 1 stop bit.
ATEN SXP-320A
This converter does not work because it does not have an external power supply.
It needs to be powered off the serial (PTP) port, but the DSC does not support this.
ALARM NOTIFICATIONS
This section has covers two topics:
• Sending Alarm Notifications over Modem Connections starting on this page
• Sending Alarm Notifications to a Numeric Pager via Modem starting on page
5–118.
• A Modem (MDS) object (default settings usually fine for a USR modem) on
DCU only
To configure for modem dial out of alarms in a BACnet DCU or DAC controller:
1. Check that the DCU controller contains a Modem (MDS) object. Select the
USR Robotics modem type.
3. In the controller with the modem attached, create a Remote Panel Settings
object.
If other devices on the network need their alarm notifications sent out via the same
modem, these devices will need a duplicate Remote Panel Settings object to be
created in or copied to them as well. The configuration of the Remote Panel
Settings object differs on the device local to the modem and the remote devices.
To configure the Remote Panel Settings object for devices that use a modem
on another device:
1. Create a duplicate Remote Panel Settings object on the device with the alarms
on it.
2. Select the SUA to match that of the OWS that will be dialed.
6. Click OK.
The devices on the network are now configured so that they can connect to a
certain device. The next steps involve the configuration of the Event Class. The
alarms that are to have the notifications dialed out need to have the destination
ORCAview address in its destination list.
The next part of the setup involves configuring an Event Class such that the
remote ORCAview is in the destination list. By default the Event Class is set up to
“Broadcast” alarms to all devices on the network. However, this will not start a
modem connection to a remote device. Before the alarm will establish a modem
connection, the destination ORCAview must be entered into the destination list of
the Event Class. The following steps outline how to configure the Event Class.
5. Reconfigure all Event Class of the same instance and name on all devices so
that they are using the same settings.
After the above steps are finished any alarm that references the “Critical” Event
Class will be sent to device 27101 set is ORCAview in this example.
The situation may arise where one alarm notification has the modem connection
up and another alarm becomes active and needs to use the modem at the same
time. If the “Retry” property is not enabled the second notification will not reach
its destination. When the “Retry” property is enabled, the device will continue to
retry sending the notification until a modem connection is established and the
remote device confirms that the notification was received.
This setting specifies the maximum size of the alarm notification buffer.
The default Max Notification Buffer size on a DCU is 10. The Setup tab of the
Events and Settings (EVS) object, has the Max Notification Buffers field. Each
alarm transition uses one space in the notification buffer. This means that if an
alarm were to transition , then return back to normal and be acknowledged, the
notification buffer would have three spaces in use. If it is expected that a device
will sending out more than three or four alarms at any one time it may be
necessary to increase the Notification buffer size in the device’s Event Settings
object..
Alarm notifications that are relying on modems for transmission can take minutes
to be sent to their destinations. The DCU uses the Notification Buffer to hold
alarm notifications that have not yet been successfully sent to their destinations. If
a specified destination has gone offline, and there are many notifications that are
waiting to be sent, the notification buffer may become full and overflow. Any
alarms that become active, while the Notification Buffer is full, will not have the
notifications sent. If this situation arises it may be necessary to increase the
notification buffer size.
On an OWS/DCU, this value will auto increase to a maximum value of 1000 with
a minimum value of 1. On a DSC/DAC, the value will be between 1 and 500
inclusive.
2. Enter the
Username and
Password here.
6. Click OK.
Any active alarms that come in are displayed in an alarm notification dialog as
well as being loaded into the active alarm list. Alarms will appear just as they do
on a dedicated ORCAview PC.
While ORCAview is in the “Wait for Call” mode it is still possible to right click
on the RPS object and connect to the network. Although no devices are shown,
alarm notifications may be acknowledged this way.
2. Enter the
Username and
Password here.
4. Select “Modem
Dial-Out” here.
6. Enter the
telephone
number here.
7. Click OK.
8. ORCAview will now ask for the Remote Panel number. Enter the address of
the device that is being dialed and click OK.
9. ORCAview will begin to dial out to the device and fail the first time. Click
OK. This step needs to be done only once.
10. The logon screen will reappear. Enter the data as in steps 2 – 7 and click OK.
11. The second attempt to dial in will be successful and the network will appear
in Navigator.
12. Once the network is logged into the Remote Panel Settings (RPS) object can
be used to disconnect from the network. Right click on the RPS object and
select “Disconnect”
Note: The ORCAview PC that is to receive the alarm notification must establish a
connection to the network before any object names will be displayed, logged, or
printed properly in the future.
ALARM ESCALATION
Alarm Escalation works with pagers and email devices which receive
notifications.
Table of Contents
INTRODUCTION: ALARM ESCALATION ............................................................. 5–147
Definitions ........................................................................................ 5–147
Basic Operation ................................................................................ 5–148
Various Scenarios............................................................................. 5–149
Alarm Flood Suppression ................................................................. 5–150
Network Layout ................................................................................ 5–151
Determining a Policy........................................................................ 5–151
SETTING UP ALARM ESCALATION AND IMPLEMENTING THE POLICY ............... 5–153
System User Access (SUA) ............................................................... 5–153
Event Router (EVR) .......................................................................... 5–154
EXAMPLES ....................................................................................................... 5–158
EXAMPLE 1: TWO SEPARATE GROUPS (DAYTIME/EVENING) ........................... 5–158
Determining the Policy ..................................................................... 5–158
Implement the Policy ........................................................................ 5–159
Create and setup the SUA objects ....................................... 5–160
Create and setup the Schedule objects ................................ 5–160
Create and set up the EVR objects ...................................... 5–162
EXAMPLE 2: IT GROUP .................................................................................... 5–167
Determining the Policy ..................................................................... 5–167
Implement the Policy ........................................................................ 5–168
Create and setup the SUA objects ....................................... 5–168
Create and setup the Schedule objects ................................ 5–168
Create and setup the EVR objects ....................................... 5–170
EXAMPLE 3: MANUAL ESCALATION ................................................................ 5–174
IMPLEMENTATION GUIDELINES ....................................................................... 5–175
As a result, pagers (alphanumeric and numeric) and any email-capable device (i.e.
desktop computers, cell phones, wireless PDA’s) are now able to receive alarm
notifications, which results in fewer continuously monitored operator workstations
and the ability to notify people in remote locations.
When an alarm notification is sent (using alarm escalation), if the first user to
receive the notification does not acknowledge the alarm within a specified amount
of time, the alarm notification is “escalated” and the next user is notified. This
procedure continues notifying users one at a time until the alarm is acknowledged.
Note: Alarm escalation is only available in DSC/ASM type controllers and is only
applicable to alarm notifications directed to email destinations (including text
message capable cellular phones) and numeric or alphanumeric pagers. Alarm
notifications directed to a local or remote printer cannot be escalated.
Definitions
The following terms will be used throughout the Alarm Escalation section.
Destination List The list of users that will receive notifications. This
list is specified in the Event Router (EVR) object.
Basic Operation
The basic operation of alarm escalation is best described by a typical usage
example:
Suppose an alarm condition occurs and the notification is first sent out to a field
tech. If after a specified time period, the alarm has not been acknowledged, the
alarm is escalated and the notification is sent to his supervisor. The supervisor is
then expected to determine why the alarm has not been handled (including
possibly assigning another field tech to resolve the situation). If after the specified
time period, the alarm still has not been acknowledged, the alarm is again
escalated and the notification is sent directly to a secondary field tech. If after the
specified time period, the alarm still has not been acknowledged, the alarm is
again escalated and the notification is sent to the Manager.
EVR determines
whether or not to route Don't Route
the notification
Route
Is it at the end of
Yes
Yes the list?
Does it need to be
No
retried?
Yes End
Various Scenarios
This section goes beyond the basic operation and describes what occurs in various
different scenarios and how alarm escalation is handled. For example, what
happens when an alarm is acknowledged, or when another alarm occurs when a
previous alarm is being escalated.
Acknowledgement before reaching end of destination list
If the alarm-distributing controller receives an acknowledgement for any alarm
before it has finished escalating through the destination list, alarm escalation
stops.
When another alarm occurs, it will restart escalation at the last user it left off on
and continue escalating from there to the end of the list.
The EVR object sends only one notification whenever the ‘Retry Interval’ expires
(the ‘Retry Interval’ is 5 minutes by default with a minimum limit of 1 minute).
If the EVR object is in the process of escalating an alarm notification and receives
more notifications within the ‘Retry Interval’, the additional notifications are
“suppressed” and the ‘Pending Alarms Count’ is incremented for each additional
notification. Once the ‘Retry Interval’ expires, the message of only the last
notification is sent with the ‘Pending Alarms Count’ appended to the message.
Note: The ‘Pending Alarms Count’ is the total number of Alarms activated since
the last time an Alarm was acknowledged.
The ‘Pending Alarms Count’ is appended to the end of the message within square
brackets:
<Message> [<Pending Alarms Count>]
(i.e. “Fan Status (On) is in ALARM [1]”)
When the user receives a page or e-mail with a ‘Pending Alarms Count’ message
appended to the alarm message, he must realize that there is more than just one
alarm active in the system. The user must then log in to the system and review all
of the active alarms in order to know which alarms have been suppressed.
Once the EVR object receives an acknowledgement for any alarm, the ‘Pending
Alarms Count’ is reset back to 0.
Note: The acknowledgement of any alarm within the system by any user will reset
the ‘Pending Alarms Count’ as it is assumed that this user will review all alarms.
Network Layout
Typically, a System level controller is used as the alarm-distributing controller.
Area or Subnet level controllers can be setup as the alarm-distributing controller,
but these types of controllers are generally setup to do a specific important
purpose. Subnet controllers are generally setup to control specific applications and
Area controllers usually handle lots of network traffic. It is best not to overload
them with too much functionality.
The following diagram illustrates how the alarm-distributing controller fits into
typical network architecture.
Email
Pager
Modem
System System Alarm-distributing
Controller Controller (System)
Controller
Subnet
Subnet
Controllers
Controllers
Determining a Policy
Before setting up the controller to do Alarm Escalation, an escalation policy needs
to be determined. An escalation policy is a guideline on how to implement Alarm
Escalation (i.e. how, when and to whom to send the alarm notifications). In order
to determine a policy, the following need to be determined:
• The type of alarm notifications that will be sent to each user. For
example, notifications for a specific Event, Event Class, or all Events.
• The times/days that these notifications will be sent to each user. For
example, certain users will only be notified during the day, and others
only during the evening.
• Where to send the notifications. For example: pager, cell phone, or email
account.
When determining how to notify a user (i.e. email or pager), it is a good idea to
know the benefits and drawbacks of each notification type.
3. A numeric pager. This includes the cost of the pager plus the
service.
Note: The Event Router and System User Access objects only need to be created
in the alarm-distributing controller. The Event Router will receive the alarm
notifications that occur on remote controllers and forward them to their
destinations as long as the alarm notification matches an Event Class and/or
Event that needs to be routed.
Depending on the type of notification that will be sent to the user (i.e. email or
page), different information needs to be entered into the User Data tab of the SUA
object. The required information for the different notification types along with a
screenshot of the User Data tab is described below.
The Alarm Filtering tab of the EVR object is where you specify when to route
notifications to the users (‘Schedule Reference’ drop down), and the type of
Events and/or Event Classes to send notifications for (‘Class and/or Events to
Route’ list).
Select a Schedule object
from this drop down list if
you want to send
notifications only when
the Schedule is Active.
The Setup tab of the EVR object is used to select the type of destination, along
with destination specific settings, that the Event Router is routing to.
The EVR object uses a System User Access (SUA) object to determine where to
send the notifications. It references the SUA object in the Destinations / Alarm
Escalations tab as shown below.
The Destinations / Alarm Escalation tab of the EVR object is also where you
specify how many times to notify a user and how often.
The First Destination to Try field specifies the corresponding entry in the destination
list that the EVR object will start with when starting escalation and sending notifications.
The Auto Escalation checkbox is typically enabled except when GCL is used to
control escalation. Disable the Auto Escalation checkbox when using GCL to
control escalation.
The Number of Alarm Retries field Specify the number of times to retry sending
the notification to each destination.
The Retry Interval specifies the length of time to wait in between sending retried
notifications to each user
When using Auto Escalation, the EVR object starts sending notifications to the
entry in the destination list that corresponds to the 'Escalation Start Index' field
(i.e. 1, 2, 3, etc.). It then escalates from that destination to the end of the
destination list, then continues from the top of the destination list until it gets to
the starting destination and then stops (until the next event notification is
received). For example, in a 5 destination list, if the 'Escalation Start Index' field is
set to 4, then the EVR will send notifications in the following destination order: 4,
5, 1, 2, 3.
Note: If the 'Escalation Start Index' field is changed in the EVR object dialog
while the EVR is escalating, the current index that the EVR is sending the
notification to will be set to that value. In other words, if the EVR is currently
escalating and sending to destination 2, if you change the 'Escalation Start Index'
field to 4, the EVR will stop sending notifications to destination 2 and start
sending notifications to destination 4. It will then restart the escalation cycle from
destination 4 (without resetting the Current Retry Count).
You can also use GCL to control the 'Escalation Start Index'. The EVR property
'EnableEscalation' controls the 'Escalation Start Index' field. The following sample
GCL code changes the starting destination for Auto Escalation every Monday at
8AM.
If EVR1.AutoEscalation = TRUE Then
IfOnce Weekday = 1 and Time >= 800 Then
If EVR1.EnableEscalation < EVR1.SUACount Then
EVR1.EnableEscalation EVR1.EnableEscalation + 1
Else
EVR1.EnableEscalation = 1
End If
End If
End If
If desired, you can implement GCL code that will only change the
'EnableEscalation' property (Escalation Start Index) when the EVR is not
currently escalating. To do this, you can use the 'RetryTimer' property of the EVR
object in a conditional statement. When the EVR is not currently escalating, the
'RetryTimer' property has a value of -1. The following sample GCL code checks if
the EVR is currently escalating when it needs to change the 'EnableEscalation'
property (Escalation Start Index). If the EVR is escalating when it needs to change
the index, it will wait until the EVR stops escalating before incrementing the
index.
Variable NeedToIncrementIndexLater As Integer
If EVR1.AutoEscalation = TRUE Then
IfOnce Weekday = 1 And Time >= 800 Then
If EVR1.RetryTimer = - 1 Then
If EVR1.EnableEscalation < EVR1.SUACount Then
EVR1.EnableEscalation = EVR1.EnableEscalation +
1
Else
EVR1.EnableEscalation = 1
End If
Else
NeedToIncrementIndexLater = 1
End If
End If
If NeedToIncrementIndexLater = 1 And EVR1.RetryTimer
= - 1 Then
If EVR1.EnableEscalation < EVR1.SUACount Then
EVR1.EnableEscalation = EVR1.EnableEscalation + 1
Else
EVR1.EnableEscalation = 1
End If
NeedToIncrementIndexLater = 0
End If
End If
Examples
The following examples describe how to set up the required objects so that the
controller will send alarm notifications using Alarm Escalation. There are three
examples:
Example 2: IT Group
This example describes a setup where you have only one group of people that
receive alarm notifications, but depending on the time of day, they receive alarms
either via email or on their pagers. An example of this type of setup is an IT
group.
Note: These examples assume that the email specific settings are already set in
the E-Mail tab of the controller’s Device (DEV) object. Refer to the section
‘Routing Alarm Notifications via Email’ in Chapter 5 – Event Management
System for more information.
The phone number of the TAP Gateway depends on the pager service provider
and can be obtained from them. In addition, the following website contains phone
numbers of various TAP Gateways throughout the world:
http://www.notepager.net/tap-phone-numbers-a.htm
• Eight System User Access (SUA) objects – one for each user that will be
notified. Each SUA object contains the method to reach that particular
user (either email address or pager number).
• Two Schedule (SCH) objects – one active during daytime hours and the
other one active during evening/weekend hours.
• Two Event Router (EVR) objects – one sends alarm notifications via
email to the daytime people and the other one sends alarm notifications
via pagers to the evening/weekend people.
The following figure show the entered time blocks in the Daytime EVR Schedule object.
The following figure shows the Next / Last Transitions area from the Detail tab of the Daytime EVR
Schedule.
The following figure show the entered time blocks in the Evening/ Weekend EVR Schedule object.
The following figure shows the Next / Last Transitions area from the Detail tab of the Evening/ Weekend
EVR Schedule.
3. In the Daytime EVR object, leave the default “*.EVC*” in the Class and/or
Events to Route list.
In the Evening/Weekend EVR object, change the “*.EVC*” entry to the
“Critical” EVC. This will cause the Daytime EVR object to send alarm
notifications for any event that occurs, and the Evening/Weekend EVR object
will only send alarm notifications for alarms that occur with a Critical Event
Class.
4. Select the Destination Type in the Setup tab of both EVR objects. In the
Daytime EVR object, select Email as the Destination Type. In the
Evening/Weekend EVR object, select Pager as the Destination Type and
Alphanumeric (TAP) as the Message Format.
The following figure shows the Evening/Weekend EVR object with Pager
selected as the Destination Type and Alphanumeric (TAP) selected as the
Message Format.
5. In the Destinations / Alarm Escalation tab, enter the SUA objects that you
want to send the notifications to. To do this, double click on an available row
under the ‘Destination List’ column and select the SUA from the list that
appears. Enter Bill, Bob, Fred, and John into the list in the Daytime EVR
object. Enter Andrew, Dave, Joe, and Ryan into the list in the
Evening/Weekend EVR object.
Note: Alarm escalation starts by sending the notification to the first person in the
list. If the first person does not acknowledge the alarm within a specified period of
time, the notification is sent to the next person in the list, and so on. Therefore,
when entering the destinations into this list, make sure you enter them in the order
that you want them to receive notifications.
The following figure shows the Destination List in the Daytime EVR object.
Escalation Policies
6. Enter the Number of Alarm Retries and Retry Interval in the Alarm
Escalation tab of each EVR object.
For this example, in the Daytime EVR object, we will set the Number of
Alarm Retries to 0 and the Retry Interval to 10 minutes. This policy says: “A
user has 1 chance and 10 minutes to respond before the alarm is escalated to
the next user”. Since these people should be at their computer receiving
email, only 1 notification and 10 minutes should be sufficient to give them
enough time to acknowledge the alarm.
For this example, in the Evening/Weekend EVR object, we will set the
Number of Alarm Retries to 2 and the Retry Interval to 10 minutes. This will
send 3 notification messages to each user (original notification plus 2 retries)
with a 10 minute delay between sending each retry. Since these people may
not be near an OWS (to Acknowledge the alarm) when the initial notification
is sent, 2 more notification retries will be sent, giving each person 30 minutes
to acknowledge the alarm before escalating to the next person.
The following figure shows the Number of Retries and Retry Interval for the
Daytime EVR object.
The following figure shows the Number of Retries and Retry Interval for the
Evenings/Weekends EVR object.
The controller is now setup to send alarm notifications to one of two different
groups of people depending on whether it is daytime or an evening/weekend.
Example 2: IT Group
This example describes a setup where you have only one group of people that
receive alarm notifications, but depending on the time of day, they receive alarms
either via email or on their pagers. An example of this type of setup is an IT
group. During the day, all the members are at work and notifications can be sent
to their email account at work, but during the evenings and weekends, they are
off-site and notifications must be sent to their pagers. During the day, they will
receive notifications of all alarms that occur. During the evenings and weekends
they will only be notified of Critical alarms that require immediate attention.
Daytime Hours
Users: Bill
Bob
Fred
John
Alarms to route: All Alarms
Times: Daytime hours (8:00 to 17:00 Monday to
Friday)
Destination Type: Email
Destinations: Bill (bill@deltacontrols.com)
Bob (bob@deltacontrols.com)
Fred (fred@deltacontrols.com)
John (john@deltacontrols.com)
Number of Retries: 0
Retry Interval: 10
Evening/Weekend hours
Users: Bill
Bob
Fred
John
Alarms to route: Critical EVC
Times: Evening/Weekend hours (all remaining times)
Destination Type: Alphanumeric Pager
(TAP Gateway phone number: 604-555-1234)
Destinations: Bill (555-1111)
Bob (555-2222)
Fred (555-3333)
John (555-4444)
Number of Retries: 2
Retry Interval: 10
The phone number of the TAP Gateway depends on the pager service provider
and can be obtained from them. In addition, the following website contains phone
numbers of various TAP Gateways throughout the world:
http://www.notepager.net/tap-phone-numbers-a.htm
• Four System User Access (SUA) objects – one for each user that will be
notified. Each SUA object will contain the destinations of that particular
user (both email address and pager number).
• Two Schedule (SCH) objects – one active during daytime hours and the
other active during evening/weekend hours.
• Two Event Router (EVR) objects – one to send alarm notifications via
email during the daytime and the other one to send alarm notifications
via pagers during the evening and on weekends.
The following figure show the entered time blocks in the Daytime EVR
Schedule object.
The following figure show the entered time blocks in the Evenings/Weekends EVR Schedule object.
3. In the Daytime EVR object, leave the default “*.EVC*” in the Class and/or
Events to Route list.
In the Evening/Weekend EVR object, change the “*.EVC*” entry to the
“Critical” EVC. This will cause the Daytime EVR object to send alarm
notifications from any event that occurs, and the Evening/Weekend EVR
object will only send alarm notifications that occur with a Critical Event
Class.
4. Select the Destination Type in the Setup tab of both EVR objects. In the
Daytime EVR object, select Email as the Destination Type.
In the Evening/Weekend EVR object, select Pager as the Destination Type
and Alphanumeric (TAP) as the Message Format.
The following figure shows the Evening/Weekend EVR object with Pager
selected as the Destination Type and Alphanumeric (TAP) selected as the
Message Format.
5. In the Destinations/Alarm Escalation tab, enter the SUA objects that you want
to send the notifications to. To do this, double click on an available row under
the ‘Destination List’ column and select the SUA from the list that appears.
Enter Bill, Bob, Fred, and John into the list in both EVR objects.
Note: Alarm escalation starts by sending the notification to the first person in the
list. If the first person does not acknowledge the alarm within a specified period of
time, the notification is sent to the next person in the list, and so on. Therefore,
when entering the destinations into this list, make sure you enter them in the order
that you want them to receive notifications.
The following figure shows the Destination List in the Daytime EVR object.
Escalation Policies
6. Enter the Number of Alarm Retries and Retry Interval in the Alarm
Escalation tab of each EVR object.
For this example, in the Daytime EVR object, we will set the Number of
Alarm Retries to 0 and the Retry Interval to 10 minutes. This policy says: “A
user has 1 chance and 10 minutes to respond before the alarm is escalated to
the next user”. Since these people should be at their computer receiving
email, only 1 notification and 10 minutes should be sufficient to give them
enough time to acknowledge the alarm.
For this example, in the Evening/Weekend EVR object, we will set the
Number of Alarm Retries to 2 and the Retry Interval to 10 minutes. This will
send 3 notification messages to each user (original notification plus 2 retries)
with a 10 minute delay between sending each retry. Since these people may
not be near an OWS (to Acknowledge the alarm) when the initial notification
is sent, 2 more notification retries will be sent, giving each person 30 minutes
to acknowledge the alarm before escalating to the next person.
The following figure shows the Number of Retries and Retry Interval for the
Daytime EVR object.
The controller is now setup to send alarm notifications to one group of people but
to different destinations depending on the time of day.
The following properties of the EVR object can be controlled from a Program to
implement Manual Escalation:
Property Description
To illustrate how these properties work, the following is the default code within
the EVR object that is executed when Auto Escalation is enabled:
If EVR1.AutoEscalation = TRUE Then
If EVR1.EscalationStatus = 1 Then
If EVR1.EscalationIndex < EVR1.SUACount Then
EVR1.EscalationIndex = EVR1.EscalationIndex
+ 1
EVR1.RetryCount = EVR1.NumOfRetry + 1
Else
EVR1.EscalationIndex = 1
EVR1.RetryCount = 0
End If
EVR1.EscalationStatus = 0
End If
End If
The following sample GCL code changes the “Person-on-Call” every Monday at
8AM. In other words, each week someone different is notified and only that
person is notified, there is no escalation between users.
// Change the Person-on-Call every Monday 8AM
IfOnce WeekDay = 1 and Time >= 800 Then
‘Email Router.EscalationIndex’ = ‘Email
Router.EscalationIndex’ + 1
If ‘Email Router.EscalationIndex’ > ‘Email
Router.SUACount’ Then
‘Email Router.EscalationIndex’ = 1
End If
End If
Implementation Guidelines
When implementing alarm escalation, there are some very important points to
note:
• If using multiple EVR objects with the same Destination Type, ensure
only one EVR object is routing to that specific destination type at one
time. This can be accomplished by setting up Schedule objects and
referencing them from the EVR objects. If there are more than one EVR
active at the same time, you may run into problems like an EVR being
unable to send a Notification because another EVR object is using that
port. Creating multiple EVR’s using the same Destination Type is useful
when different people need to be notified using the same method during
different times.
• Although it is possible to have more than one EVR setup and Routing at
once to different Destination Types, do not setup more than one EVR
object with different Destination Types that use the serial port on the
DSC. Since Pager, Local Printer, and Remote Printer all use the serial
port on the DSC, make sure there is only one EVR accessing the serial
port at one time. You can have one EVR with a Destination Type of
Email and another EVR with a Destination Type of either Pager, Local
Printer or Remote Printer routing at the same time because the 2 EVR’s
are using different ports.
If a notification has been sent to a user and the retry interval is in effect, when
another alarm occurs, it will not trigger the EVR to send the notification right
away, it will wait until the retry interval has expired and continue on with alarm
escalation without interruption but it will send the notification of the last alarm
that it received.
INTRODUCTION
You can use Trend Logs, Multi-Trends and the Historian Device, to analyze,
view, record, investigate and maintain your ORCAview system data. There are
three main objects used to perform these functions: the Trend Log (TL), the Multi-
Trend (MT) and the Historian Settings (HS) object.
You can use the Reporting (RPT) object to generate commonly used technical
reports on your system. There are three types of reports generated by the RPT
object: Query reports, Tenant Billing reports and Access Configuration reports.
• Introduction to Historian what it is, why use it, and how to use it.
Starting 6–11.
• Installing Historian Starting 6–18
• Configuring HS Starting 6–24
• Basic Troubleshooting Starting 6–54
• Configuring TLs 6–42, Archived TLs and MTs 6–47.
• Maintaining Archived TLs. Starting 6–52.
• Improving Historian Performance Archived TLs. Starting 6–60.
• Troubleshooting Historian Archived TLs. Starting 6–62.
• Introduction to Reporting what it is, why use it, and how to use it.
Starting 6–80.
• Configuring Query, Tenant Billing and Access Configuration Reports.
Starting 6–82.
• Troubleshooting Reports. Starting.6–104.
Intended Audience
The intended audience for this section of the ORCAview Technical Reference
Manual is as follows:
• Facility Managers
• Application Engineers
• Service Personnel
• Supervisors
• Security Personnel
• Operations Staff
INTRODUCTION TO HISTORIAN
Historian is an archiving utility that stores data from Trend Logs (TL) for an
unrestricted period of time, and allows users to record a much larger set of data
than was previously possible. Historian provides an opportunity to analyze, view,
record, and investigate data in ways that are not possible using traditional TLs and
Multi-Trend Logs (MTs).
Archive TLs are presented as regular TLs to the other BACnet devices. As such,
they are accessible via any BACnet Operator Workstation (OWS) that supports
TLs as defined in the BACnet Standard (2001b or later). Historian will not work
with devices implementing trending as defined in versions of the standard prior to
2001b.
Features
• With Version 3.40, multiple Historians are supported.
• Historian allows multiple OWS systems, both local and remote, to view the
historical data.
• Historian supports Ethernet and BACnet/IP connections.
• Historian stores data in an Open DataBase Connectivity (ODBC) database.
• Historian’s data is available through a standard ODBC interface that permits
data to be imported into MS Excel, Crystal Reports, or other ODBC
compliant tools.
A detailed description of ODBC is included in the section entitled, What is
Historian’s ODBC database? starting on page 6–17.
System Requirements
To use Historian, ORCAview must be installed on the system. To run Historian
software, the minimum PC requirements are as follows:
The following table shows approximate database sizes based on different site
sizes. The values are approximate, and do not account for database transaction log
files which can be equivalent to, or larger than the database files. Microsoft SQL
Server 2000 and MSDE 2000 were used for these calculations.
The figures provided in the table are to be used only as an example and should be
treated as an approximation of space required.
Historian Trend Log Event Log Event Log DB Size DB Size DB Size
Level Objects
- HVAC / - Access Control (1 month) (6 months) (12
(1 data sample Lighting months)
per TL every 10 (entries per day (in MB) (in MB)
min. on avg.) (entries per day on avg.) (in MB)
on avg.)
TLs cannot be created directly on the Historian Device. In the right pane of
Navigator, right click on any source TL and click Add to Historian. Any polling or
buffer ready COV BACnet TL, on any controller (Protocol Version 1, Revision 3
or later), can be marked for archiving. .In V3.40, the Archived checkbox on the
Setup tab of a source TL is not editable due to the multiple Historian capability...
Previously in 3.33, it was possible to select the Archived checkbox to mark a TL
for archiving.
In V3.40, you must select a TL or group of TL's in the right pane of Navigator and
then right click. From the menu, select the Command option and click on Add to
Historian.
Note: V3.40 now supports multiple Historians on one site and as a result the
Archived checkbox on TL is not editable and is grayed out. To mark a trend or
groups of trends (regular TL's) for archiving in Version 3.40, you must select a TL
or group of TL's in the right pane of Navigator and then right click. From the
menu, select the Command option and click on Add to Historian.
4 If there are multiple Historians installed on the site, select the particular
Historian that you wish to archive the selected trend(s) to.
The previous dialog only appears if the site has more than one historian.
5 When the trend is marked as Archived, the Setup tab will show that it is being
archived.
In V3.40, the Archived checkbox cannot be edited from the Setup tab of the TL.
If this trend is being archived in multiple Historians, it will not list all Historical
trends here, only one. The V3.40 support for multiple historians is intended to
provide additional trending capacity on large sites. Although it is technically
possible to archive a trend to multiple historians in this configuration this is not
the intent, and is not supported in V3.40.
Additionally with multiple Historians, each historian must refer to its own SQL
database. You cannot have multiple historians that all reference the same SQL
database.
You can rename any source TL or Archived TL and Historian will continue to
function normally.
For Delta COV TL’s and third party COV TL’s that support Buffer Ready
Notifications, Historian will automatically configure TL’s to generate events when
they need to be archived. This approach allows for COV TL’s variable rates of
data collection. The intention is to avoid any loss of data.
Historian stores TL data and set up information in the ODBC database. Historian
is shipped with Microsoft SQL Server 2005 Express, and also supports MySQL.
INSTALLING HISTORIAN
Historian is included on the same CD-ROM as ORCAview. Version 3.40 supports
the installation of multiple Historians but each must have its own separate SQL
database.
If the default MS SQL Server Express is installed, the size of the database is
limited (Microsoft SQL Server 2005 Express, 4GB). For Large and Unlimited
Historian users, SQL Server 2005 Express may not be sufficient for large amounts
of trending and/or alarming. It may be better to immediately install My SQL or
purchase the full SQL Server. This avoids the inconvenience and effort required to
switch over to another SQL server product after starting with the default Microsoft
SQL Server 2005 Express, with its 4 GB database size limit.
For example, a site with 1000 trends with samples every 10 minutes, and 500
HVAC / lighting, and 1000 Access events a day - would use 5.3 GB per year. That
means the default of SQL Server 2005 would run out of database space in about 9
months. A site with 2500 trends would run out in more less than 4 months.
See the Historian Database Growth and Management section starting on page 6–
12 for a table that shows estimated hard drive usage.
Installation
With 3.40, ORCAview has a suite installer which provides a choice of six
applications to install. The Suite Installer handles multiple applications in one
installation process.
With the ORCA 3.40 Suite Installer, you do NOT need to install OWS first and
then log in over the desired network connection before beginning to install
Historian. This approach was necessary with 3.33R2.
Note: With the ORCA 3.40 Suite Installer, you do NOT need to install OWS first
and then log in over the desired network connection before beginning to install
Historian. This approach was necessary with 3.33R2.
1. If the autorun does not bring up the interface, use the My Computer icon or
the Explorer view to find the ORCA Suite Setup.exe file.
2. Double-click ORCA Suite Setup.exe file to start the Suite Installer.
3. Follow the instructions from the Welcome screen to complete the installation
process.
With Microsoft SQL Server 2005 Express, you need to define a strong password
which means that the password contains a variety of character types. A strong
password contains a combination of lowercase, uppercase, numbers and special
characters such as $ or # etc.
To stop or start the Historian service manually, you use the Services utility in the
Windows Administrative Tools. The Administrative Tools are accessible from the
Windows Settings | Control Panel | Administrative Tools | Services and provides a
way to Stop or Restart the Historian service.
4. From the Services dialog, scroll if necessary, and select Delta Historian in the
Name column.
5. If necessary, click the Extended tab in the lower left part of the dialog.
6. In the upper left area of the right pane, click Stop the service or Restart the
service.
3 Click OK.
Configuring Historian
To open the Historian Settings object:
• In the right-pane of the Navigator window, right-click the Historian Settings
icon, and then click Open.
For a detailed description of the HS object fields, please refer to Chapter 10:
Software Object Reference of the ORCAview Technical Reference manual.
The Current Time, Next Poll and Last Poll fields in the Header often helps in the
interpretation of the Stats and Troubleshooting tab information.
Current Time This field displays the current time of the Historian PC.
Next Poll This field indicates the next scheduled time at which the Historian
Device will archive samples from one or more TL’s. Historian may start to poll
before this time if a forced update is requested, or if a Buffer Ready Notification is
received from a TL.
Last Poll This field indicates the last time that any TLs were polled for new
samples.
Stats Tab
The Stats tab only shows statistics when viewed from the local Historian PC.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Data
Source must be set up in Windows.
Historian Uptime This field refers to the Delta server uptime and so starting
ORCAview first will increment this uptime count.
Historical Trend Log Count This field displays the number of trends in the
Historian DB.
Processing Time These are the percentage of time that historian runs in each
state. They start keeping track of statistics at the time of the first added TL.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
Refer to the Improving Historian Performance section starting on page 6–60. This
section discusses how to avoid missed samples and how to investigation
communication issues using the HistLog.txt file. The Troubleshooting Historian
Device section starting on page 6–62, contains examples of how to resolve issues
that arise when using the Historian device.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does NOT indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
High Usage Trend Logs This is a list of the ten fastest to fill trends (Poll or
COV). You may not need to do anything about these trends because this list
shows the TLs that use the most Historian resources.
Trend Logs with Insufficient Samples This is a list of the top ten trends
(Poll or COV) that Historian will miss data from with the current TL
configurations. If a Trend Log is on this list, it indicates a definite problem that
needs attention. These Trend Logs often do not have a large enough Max Samples
setting in the source Trend Log for Historian to be able to archive all new data at
the rate each Trend Log is storing data.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Setup Tab
The Setup tab contains the setup items for Historian’s auto logon, ODBC
connection, and TL polling. Users can configure Historian and change the default
settings by using the Setup tab in the HS object.
It is recommended to keep the Maximum Poll Interval at the default 24 hours. For
example, if this field was set to one hour, Historian would be extremely busy on a
large network with an increased risk of missing samples.
To specify the database name in the DSN for Microsoft SQL server:
1 Open Data Sources (ODBC)
For a 32 bit OS, open Control Panel | Administrator Tools.
For a 64 bit OS, you must use the 32 bit ODBC Data Source dialog (NOT 64
bit one). The Microsoft support site provides vital configuration information.
See http://support.microsoft.com/kb/942976
2 Select the System DSN tab. See HistorianDSN listed:
3 Click Configure.
4 Click Next.
5 Select the authenticity type to SQL Server Authentication. Be sure to use the
SQL Server authentication.
6 In Login field, type the UserID displayed on the HS object Setup tab. The
default UserID is sa.
7 In Password field, type password you entered during the SQL Server
installation.
8 Click Next.
9 Select the Change default database to checkbox.
10 Select HistorianDB from the Change default database to dropdown list.
If HistorianDB is not an option, leave the Default Database field blank and
finish this procedure. Start and stop Historian which causes the HistorianDB
to be created automatically. Use this procedure to define the Default Database
To ensure that the Stats and Troubleshooting tabs work on the HS, enter the
ODBC data source information on the Setup tab of HS.
11 Click Next.
12 Click Finish.
13 Click Test Data Source … See results similar to:
The configuration steps between the connector and the server are similar to the
previous Configuring DSN for Microsoft SQL Server section starting on page 6–
28. The HS dialog needs to reflect all the changes done with the ODBC data
source.
The following fields in the Historian Settings object Setup tab do not need to be
changed unless a different DBMS package is used, or user security needs to be
applied to the Historian database.
Installing MySQL
Before configuring MySQL server, you will need to download and then install the
MySQL Community Server and the MySQL Connector/ODBC Driver. These
download and installation instructions can be found on
http://dev.mysql.com/downloads.
In order for the Statistics and Troubleshooting information in to show in the HS object you
must specify the database name in the DSN.
Connection Polling
A connection pool is a shared set of established database connections that are
available for an ODBC application to reuse. Historian needs connection pooling
for it to work properly.
When using the connector/ODBC x.x with MySQL Database, you must have
Connection Pooling enabled.
2. Double-click to open the Historian Settings object, and then select the Setup
tab.
3. In the ODBC Info fields, enter the UserID ‘root’ and the Password assigned
to the root user. It is easy to use the root user as it is created by default and
avoids any complexity involved in creating new SQL users. To change the
root password, refer to the “Changing the Password for MySQL” section.
When you install MySQL, it will also automatically create a system administrator
account, with the username ‘root’ and it will prompt you for a password.
Remember to use a strong root password. A strong password contains a variety of
character types. A strong password contains a combination of lowercase,
uppercase, numbers and special characters such as $ or # etc.
These accounts are extremely powerful, and if left with a blank password, they are
completely unprotected. Passwords should be created or changed immediately
after installation.
Note: Do not forget the new password. If you cannot provide the correct
password, you must re-install either SQL Server or MySQL.
In MS SQL, you use the free Management Tool which includes a GUI interface to
edit users.
http://www.microsoft.com/downloadS/details.aspx?familyid=C243A5AE-4BD1-
4E3D-94B8-5A0F62BF7796&displaylang=en
In MySQL, you use the GUI tools free from their site to edit users.
http://dev.mysql.com/downloads/gui-tools/5.0.html
• On the Historian PC , right-click the Historian icon from the Windows system
tray,, and then click Status. The Historian Status dialog will show the
connection to the Delta Server, and the Historian Status.
Not Connected Historian has not logged onto the Delta Server yet, has failed
to log onto the server or has lost its connection due to an error. When Historian
loses its connection to the Delta Server, it periodically attempts to reconnect to
resume normal operations.
Archiving Historian is collecting data samples from one or more Trend Logs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Scheduling Historian is “calculating” which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database, the ODBC
database connection or else the Delta Server is offline. Historian will periodically
attempt to recover from the fault condition by reconnecting.
In Fault mode, Historian does not archive TLs or Alarm/ Event Notifications to its
ODBC database. However, Alarm/ Event Notifications are logged in a separate
MS Access database that is created when Historian is in fault due to database, or
database connectivity problems.
When Historian is in fault due to Delta Server being down, Historian does not log
to the Access database file as it no longer receives Alarm/ Event Notifications.
The backup Access file is called HistorianFaultDB.mdb and is located in the
Historian install folder.
EVC objects on controllers can be configured to use the Retry and Confirm
functions which will ensure Historian will receive Event Notifications during a
brief network interruption. The Setting Up Confirmed Event and Alarm
Transmissions To Historian section starting on page 6–24, contains detailed
information on how to set up confirmed alarm and event transmissions to
Historian.
This section emphasizes the setup of confirmed transmission for Access Control
events and alarms focusing specifically on EVC7 and EVC8. Access events are
valuable in comparison to other events and it is important not to lose any of these.
To configure other EVC’s, you would repeat the process shown here but for other
EVC’s,
It is recommended that Historian be online during the setup but it is not necessary.
When Historian is online, the Archive checkbox is available on the source TL in
the controllers.
2) Choose a controller
Select a controller in Navigator that you wish to confirm all events and alarms are
sent to the historian. In the event of a network miscommunication or fault, events
will be saved to send to the historian at a later time automatically.
These steps described in this Sequence of Operation section should be repeated for
all controllers that use confirmed transmission.
Under the Device Address, double click on BROADCAST and enter the following:
• DEV#The address of your historian#
For example, in this case it would be DEV999999
Under the Device Address, double click on BROADCAST and enter the following:
• DEV#The address of your historian#.
For example, in this case it would be DEV999999
Polled TLs collect new data samples based on a time interval, which can be set by
the user. This time interval is called the Log Interval. By default, a new TL will
have a Log Interval of one minute, which means that a new data sample will be
taken every minute.
TLs display the collected information in two ways: graphically, with a line graph
that has the last 200 values plotted against time, or as a text display of all the data
collected.
Additionally, TLs can be started or stopped at a time specified by the user.
The Archival Buffer Notification Setup enables a notification to occur each time a
set threshold of samples has been recorded. This functionality is used by Historian
for automated archival of trend data to prevent data loss.
Archive TLs are presented as regular TLs to other BACnet devices. As such, they
are accessible via any BACnet Operator Workstation (OWS) that supports TLs as
defined in BACnet 2001b. Once a TL has been selected for archiving, Historian
automatically creates an Archive TL that displays the data.
Archive TLs cannot be removed from the Historian Device without using database
management tools.
2. In the Create Object dialog, enter a name for the new TL.
3. From the Type Of Object drop-down menu, select Trend Log (TL), and then
click OK.
4. Click the Setup tab, and then do one of the following:
• Enter a descriptor name or object reference into the Monitored Object
box.
• Drag and drop the object that you want to monitor from Navigator into
the Monitored Object box.
5. Click Apply or OK.
Polling Records data at specified time intervals as defined in the Log Interval
field. A typical Log Interval value is 15 minutes.
COV Records data when the monitored value changes by a specified amount.
This type of TL uses the COV Minimum Increment value defined in the
monitored object and only retrieves a new sample when the monitored object
value changes by the Minimum Increment or more.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
With Historian, many solutions to problems involve increasing the size of the Max
Samples field on the source TL. Sometimes, this is not possible due to limitation
on the amount of memory available on a controller.
MULTI-TREND (MT)
The Multi-Trend (MT) object graphs the data samples from Trend Logs (TL). Up
to eight TLs can be graphed simultaneously in one MT object. The graph will plot
new samples as the TLs collect them.
The MT object allows users to drag-and-drop TLs onto the Multi-Trend dialog.
The MT object starts graphing the data when the TLs are added. This feature
makes it easy to graph a variety of Trend Logs quickly, in order to compare them.
For a detailed description of the Multi-Trend object, and all of its features, please
refer to Chapter 10, of this Technical Reference Manual. The following is a figure
of the Multi-Trend object dialog.
Note: By creating a Multi-Trend Log containing TLs and their associated Archive
TLs, users are able to view both controller data and historical data
simultaneously. An Archive TL can be added to the MT object using the same
drag-and-drop feature currently used for regular TLs.
When you open an MT on a Historian PC monitoring HTL’s, the latest data may
not display depending on when Historian last polled the controller’s TL data. An
MT with HTLs might display information that is a day old.
Configuring a Multi-Trend
The Multi-Trend object is a useful way to graph information simultaneously from
more than one TL.
Once the MT object is created, and the TLs are added, any information is
automatically graphed within the one MT object. To minimize network traffic, the
MT object will initially retrieve chunks of data from each TL, a small amount at a
time, until the entire databuffer of each TL is graphed. Following this, the MT will
receive new TL samples at a fixed rate, which defaults to once every 10 seconds.
2. In the Create Object dialog, click the Type of Object drop-down menu, and
then select Multiple Trend (MT).
3. In the Name field, enter a name for the new Multi-Trend, and then click OK.
4. Drag-and-drop one or more Trend Logs from Navigator into the open Multi-
Trend dialog window. The Multi-Trend will start graphing the Trend Logs
automatically.
Note: When Trend Logs are added to the MT in the Main window, using the drag
and drop function, the correct axes are automatically assigned. When using the
Line Properties dialog axes must be assigned manually by the user.
Viewing a Multi-Trend
A Multi-Trend defaults to Moving Frame (Range) mode with a time span of eight
hours, which means that the MT will display the last eight hours of TL data.
To change the interval at which new TL data samples are retrieved by an MT:
1. On the Multi-Trend toolbar, click the Settings button.
2. In the General Properties dialog, set the Polling Interval to the new value.
Set the new value from 10 to 60 seconds.
3. To save the changes, click Apply or OK.
When the Archive TL is enabled, the data from the source TL is archived
according to its polling schedule and buffer ready notifications.
When the Archive TL is disabled, the data from the source TL is not archived.
To update the data samples from the source TL in the Archive TL:
1. From the Navigator window, click to open the Archive TL for updating.
2. In the header of the Archive TL, click the Update button.
Refer to the Improving Historian Performance section starting on page 6–60. This
section discusses how to avoid missed samples and how to investigation
communication issues using the HistLog.txt file. The Troubleshooting Historian
Device section starting on page 6–62, contains examples of how to resolve issues
that arise when using the Historian device.
With a simple problem, it is easy to interpret appropriate data that helps to isolate
a reproducible cause and make suitable changes to prevent recurrence while not
introducing new problems.
With a complex problem, the nature of the problem itself is often unclear and may
also involve dynamic effects such as events that are not predictable. Some of the
most difficult troubleshooting issues arise from symptoms which are intermittent.
Your solution needs to prevent recurrence but also must not introduce further
problems within the overall system. After implementing a solution, you need to
observe and collect data to ensure its continued effectiveness.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does not indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Data
Source must be set up in Windows.
For example, the High Usage list may contain a Trend Log that collects large
amounts of data at frequent intervals. Everything may be fine as you need to
collect this data. Alternatively, the sample rate may be much too high for this
particular variable. It is also possible that the characteristics of the monitored
object value do not match expectations and indicate a possible problem within the
site. You may be using much more Historian resources than intended or needed
for a High Usage TL.
All Archive Trend Logs can be configured so that Historian can archive all Trends
without missing samples. To make sure this is the case on your site, use the
information in this High Usage table and in the Histlog.txt to verify the Trend
Logs in the High Usage list are configured correctly. The Histlog.txt can be
searched to make sure none of these Trend Logs have missed samples reported
and the information in the High Usage Trend Logs table should be reviewed.
Refer to the Improving Historian Performance section starting on page 6–60. This
section discusses how to avoid missed samples and how to investigation
communication issues using the HistLog.txt file. The Troubleshooting Historian
Device section starting on page 6–62, contains examples of how to resolve issues
that arise when using the Historian device.
The following table explains the information included with a High Usage Trend
Log list item. Each TL entry is followed by two numbers.
8000.TL1 - 3240, 1
Historian will be able to keep up with this trend.
(Samples per
minute)
The following table provides general guidelines for interpreting the information
included with a possible High Usage Trend Logs list item.
The following table provides some examples of possible High Usage Trend Logs
List Items with interpretation of the example.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Generally, you would increase the size of the buffer for the Trend Logs which
provide the most important data. A balance exists between the demands of data
collection, the memory available on a controller and the relative importance of the
data.
For example, a list item might be:
8000.TL1
8353.TL6
If 8000.TL1 is a Poll Trend Log with a Log Interval of one second and a Max
Samples (buffer size) of 100, then Historian cannot archive all the data. Historian
will miss many samples as Historian data collection is restricted to a maximum
interval of 120 seconds for a single Trend Log. This deliberate constraint prevents
a single poorly configured Trend Log from dominating Historian’s resources.
A solution might be to increase the Max Samples and/ or to increase the Poll
Interval. You could increase the Max Samples buffer size assuming that memory
is available on the controller. You could also reduce the data collection rate by
increasing the Poll Interval as it is probably not necessary to collect new data
every second.
If 8353.TL6 was a COV trend log, a typical solution would be to evaluate the
COV Increment of the Monitored Object to make sure that it is reasonable for the
point being measured and then change the COV increment and/or increase the
Max Samples for the TL as appropriate.
In the case of an intermittent problem, you can run a query on the ScheduleInfo
table looking at the MaxPeakRate. The MaxPeakRate provides the highest number
of samples per minute ever recorded in the past.
The following query will help identify trends that have problems due to
intermittent periods of high data samples:
When the trends with intermittent high data rates are identified, you can increase
their MaxSamples, decrease their COV rate number or decrease the samples rate.
The extra HistLog info also lists this information.
The following recommendations will decrease the time the Historian is using
network bandwidth for archiving, ease the workload on the CPU and hard drive,
and lengthen the time interval before database maintenance (purge or backup) is
required.
• Use COV where practical - Binary objects, and Setpoints, etc.
• Polling - Use reasonable polling intervals. 15 minute sample intervals for
example.
• Only archive those trends that require Historical data storage.
The following sequence of three HistLog .txt entries shows a situation where
Device 700 is offline resulting in 62 missed entries. Device 700 comes back
online and the trends are schedule normally.
09:23:00.19, 07-Jul-2009, Status = COMM TIMEOUT, Device 700 is offline. All trends will be scheduled out
09:25:58.02, 07-Jul-2009, Status = ERROR, 62 Missed Entries: HTL1
09:26:21.14, 07-Jul-2009, Status = RESUME, Device 700 is back online. All trends will be scheduled normally
Archiving Historian is collecting data samples from one or more Trend Logs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Scheduling Historian is calculating which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database or the ODBC
database connection when the Delta Server is offline. When in this mode,
Historian will not archive TLs, nor log Alarm/Event notifications.
Historian Connection
If the Historian Device is not visible in the ORCAview Navigator tree, or the
Archive checkbox of a Source TL is shaded out, you need to determine if
Historian is connected to the Delta Server.
• Not Connected: Historian has not logged onto the Delta Server yet, has
failed to log onto the server or has lost its connection due to an error.
The Historian Status dialog also contains information on the connection to the
Delta Server and Historian’s current mode of operation.
3. The Value column will display the status of the Archive TL.
• In the left pane of Navigator, right click on the controller and click Query
Panel. Query the controller with the source TL. If this does not remove the
Fault state, you can do a forced update to get the TL going. Sometimes, this
direct approach may correct the problem.
• Query the Historian database.
This query would return a list of the HTLs that are in fault and the reason. In
the Last Failure Reason column, review the error code.
The table below contains an explanation of error codes in the Last Failure Reason
column.
Basic
Error
Descriptio Detailed Description Suggestions
Code
n
Remote
The remote device is not Check to ensure the remote
-25 device
available on the network. device is functioning.
failure
The remote device did
Remote not respond in the
Check to ensure the remote
-27 device desired time – it may not
device is functioning.
timeout be available on the
network.
Investigate your networking
issues and look for something
Invalid This error might result
-84 that might be corrupting
packet from bad wiring.
packets like bad wiring or a
non functional Hub/Switch.
Look at the controller TL and
confirm it is present. If not,
recreate it and it will
automatically make a new
The source TL has been Archived TL and detach your
deleted on the controller old one. Make sure you are
Source TL
-127 and the Archive TL not losing data here.
deleted
cannot collect any more
data. If you make a new TL with the
same settings as before then
the HTL will relink with your
new source TL with the same
settings.
Timeout while waiting for
Database Ensure that Historian is
-165 a database read/write
timeout connected, and is not in fault.
lock.
Attempt to query your
Error Check with specific OS
-166 Historian and make sure it is
unknown for more information.
working. Call support.
Attempt to query your
Error Service/ function was
-190 Historian and make sure it is
aborted aborted.
working. Call support.
Create the source TL on a
The remote device does
Network device that supports the
not support the services
-380 service not BACnet Read-Range service
needed to perform the
supported (e.g., Delta Controls DCU, or
archiving of the TL.
DSC device).
When Historian is run, the TLs that have been created on "Historian's" PC are
erased. This ensures that the Historian Device is gathering archived data only.
Here are two main cases when this may occur:
• The first case may occur when an existing OWS has been running for a long
time. When the user installs and runs Historian, any TLs currently on that PC
are removed without warning.
• A second case may occur when Historian is stopped for some length of time
on the Historian PC. If that PC is then used as a work station, the user can
create TLs, but these TLs are deleted when Historian is re-started.
The following is a complete list of all Historian’s data tables with Column Name,
Data Type and additional information for each entry.
ACEvent
The ACEvent table stores information on all events generated with the Access
Control Event class.
DevOff
The DevOff table stores information on devices (controllers) that .are offline.
Enum_BAC_AC_Event
The Enum_BAC_AC_Event table contains the mappings for Access Control event
type (numbers to text values).
EVL
The EVL table stores information about the Event Log objects in Historian’s
database.
EVLData
The EVLData table the information on Events that Historian logs. Each table contains one row per Event.
EventRefInstance Number
EventRefProperty Number
EventRefArrayIndex Number
Category Number Event category of this entry
Notes Text Debug information.
MonitoredRefSiteNo Number Monitored object reference for this
event. The name of the monitored object
MonitoredRefDeviceNo Number is found in the RefNames table by
MonitoredRefObjectType Text matching the SiteNo, DeviceNo,
ObjectType and Instance.
MonitoredRefInstance Number
MonitoredRefProperty Number
MonitoredRefArrayIndex Number
Priority Number Priority of this Event entry
InfoType Number Information type for this event
0 = Event, 1 = Ack, 2 = Error
InfoEventTimestampType Number Event Timestamp type: 0 = Time, 1 =
Sequence Number, 2 = DateTime
InfoEventTimestampTime Datetime Event time – present if
InfoEventTimestampType = 0
InfoEventTimestampSequenceNumber Number Event sequence number - present if
InfoEventTimestampType = 1
InfoEventTimestampDateTime Datetime Event date/time - present if
InfoEventTimestampType = 2
InfoEventText Text Event text
InfoEventFromState Number Previous state of event: 0 = normal, 1 =
fault, 2 = off normal, 3 = high limit, 4 =
low limit, 5 = life safety, 6 = unknown, 7
= off alarm, 8 = on alarm, 9 = trouble, 10
= security, 11 = fire
InfoEventToState Number New state of event: 0 = normal, 1 = fault,
2 = off normal, 3 = high limit, 4 = low
limit, 5 = life safety, 6 = unknown, 7 = off
alarm, 8 = on alarm, 9 = trouble, 10 =
security, 11 = fire
InfoEventFlags Number Debug information.
EVLFilters Table
The EVLFilters table contains a list of filters used by EVL objects in Historian.
Historian
The Historian table lists information about the Historian Settings object.
HistorianDebug
The HistorianDebug table stores information on devices (controllers) that .are
offline.
ObjectMap
The ObjectMap table provides the mapping from the archived objects in Historian
to the source objects within the devices.
Ops
The Ops table stores information on how long Historian was in each of five states.
This information is used to calculate statistics.
Sleeping Number
Fault Number
Refnames
The Refnames tables contain the mappings from the object references to their
object names.
ScheduleInfo
The ScheduleInfo table provides scheduling information for TLs archived by
Historian. There is one row for each archived TL.
Stats
The Stats table provides the names and data values for fields on the Stats tab of
the HS dialog.
TL
The TL table lists information about the TL objects within Historian.
TLData
The TLData table contains all the Trend Log data gathered by Historian. There is
one row for each TL entry retrieved from the remote devices.
Error Basic
Detailed Description Suggestions
Code Description
Remote Check to ensure the
The remote device is not
-25 device remote device is
available on the network.
failure functioning.
The remote device did not
Remote Check to ensure the
respond in the desired time
-27 device remote device is
– it may not be available on
timeout functioning.
the network.
Invalid This error might result from
-84 Debug information.
packet bad wiring.
The source TL has been
Source TL deleted on the controller
-127 Debug information.
deleted and the Archive TL cannot
collect any more data.
Ensure that Historian
Database Timeout while waiting for a
-165 is connected, and is
timeout database read/write lock.
not in fault.
Error Check with specific OS for
-166 Debug information.
unknown more information.
Error Service/ function was
-190 Debug information.
aborted aborted.
Create the source TL
The remote device does not on a device that
Network
support the services needed supports the BACnet
-380 service not
to perform the archiving of Read-Range service
supported
the TL. (e.g., Delta Controls
DCU, or DSC device).
For a detailed description of the fields and tabs in the RPT object, refer to
Chapter 10: Software Objects.
Features
The Reports feature:
Query Generates a report listing the objects, based on user-defined criteria. For
example:
• Calendar Configuration
• Schedule Configuration
CAL and SCH objects are used with other objects besides Access Controls ones. It
helps the building owners to know Calendar and Schedule setups in other control
devices.
Controller Reports Generates reports for Input (IP) and Output (OP) objects
only.
GENERATING REPORTS
The following section covers how to create, configure and choose outputs and
formats. Report (RPT) objects are found in the Report folder that appears in the
left-pane of the Navigator window.
2. Click New, and the RPT object opens automatically to configure the report.
3. From the Report Type drop-down menu, select the desired report.
1. From the Report Type drop-down menu, select Query. The new report
displays as shown in the following figure.
Selecting Devices
The next step is to select which devices are included in the object filter criteria.
There are three options presented: All Devices, Area Devices (Area, System and
Subnet), or Specific devices.
Note: The area drop-down menu is disabled if there are no area devices on the
network.
Note: A single device address can also be combined with a range of addresses,
e.g., 10000, 20000 - 30000, 40000.
Objects can be filtered for in the following ways: by object name, object type,
object instance or by property values. The following table provides examples of
filtering criteria.
Note: By selecting the Group by Device checkbox, objects are sorted into groups
by device, with a device name heading on each group. The list of devices is sorted
in ascending order based on the device address. If the checkbox is cleared, then
all objects are displayed in one inclusive list.
AO Object BO Object
Name Name
Description Description
Value Value
StatusFlags StatusFlags
Units CommissionFlag
CommissionFlag Reliability
Reliability DeviceTypeRef
DeviceTypeRef DeviceType
DeviceType Polarity
CurrentPriority InactiveText
DefaultValue ActiveText
COVIncrement ChangeOfStateTime
Polarity ChangeOfStateCount
DAValue MinimumOffTime
OutputVolt MinimumOnTime
ModuleType CurrentPriority
HandsOffAuto DefaultValue
FBackValue DAValue
ManualOverride OutputVolt
HALFlags ModuleType
CriticalControl HandsOffAuto
StartDelayTime
FBackValue
ManualOverride
HALFlags
FlickWarnEnable
FlickWarnTime
FlickWarnTimer
FlickWarnActive
FlickWarnPAEnable
CriticalControl
AT Object BT Object
Name Name
Description Description
Value Value
Units StatusFlags
StatusFlags OutOfService
OutOfService StartTime
COVIncrement ActiveStateChanges
StartTime COVIncrement
ConversionUnits ManualOverride
ConversionRate HALFlags
ManualOverride InputRef
InputRef RunSeconds
TL Object EV Object
Name Name
Description Description
Value Value
StatusFlags StatusFlags
OutOfService OutOfService
StartTime Algorithm
StopTime InputRef
LogInterval EventEnable
LogEnable AckedTransitions
IsHistorical NotificationClass
ManualOverride EnableAutoText
HALFlags ManualOverride
InputRef HALFlags
BufferSize EnableRef
EventClassRef
Editing a Column
To edit a column:
1. Right-click the column header and click Edit Column.
2. In the Edit Column dialog, enter an object property, or select one from the
drop-down menu.
3. Enter a column name.
4. Click OK to save the changes.
2. Select an option (e.g., #.## displays 2 decimal places), and then click Apply
to save the changes.
2. Select the Text option, and then click Apply to save the changes.
The Invoice field is used to enter the invoice number that appears on the Tenant
Billing report. Each time a new report is automatically generated, the invoice
number is incremented by one.
Note: For automatic report generation users should select either Previous Month
or Current Month from the Period drop-down menu, otherwise the billing reports
will be generated for the same month over and over.
Note: Users can choose a new invoice number, and then the report numbers
increase automatically from that point forward.
3. In the Trend Logs field, select the TLs for the report. To select multiple TLs,
hold down the CTRL key.
4. In the Rate ($/hr) field enter the numerical value.
Note: This rate will be applied to all the selected TLs.
5. Click OK to save the changes.
Note: A V2 TL could contain up to four series of data. All the series will be used
in the report.
4. Click OK.
Note: The value entered is removed as soon as the RPT object is closed.
5. Print or export the report.
Click the Minimum charge field, and enter a custom value (e.g., 45 min.)
Click the Roundup to the nearest field, and enter a custom value (e.g., 35
min.)
The following procedures cover selecting and configuring, and then entering
object filter criteria for the report.
4. In the Devices field, select the appropriate device(s). This is done in the same
way as Query reports.
5. In the Object Filter field, enter the filtering criteria.
Note: If a wildcard is entered (*) all appropriate objects are shown in the report.
This is based on the report type selected and the filter criteria.
For example, if the Card User Configuration report is chosen, and A* is entered,
all card users with a first name beginning with A are shown.
Configuring Layout/Destination
This section covers procedures for customizing report titles, notes and footnotes,
assigning a Triggered By object, and how to configure the report destinations.
Customizing Reports
Information is added to a report by using the fields within the Layout/Destination
tab.
• Name.
• Object instance.
• Object instance with a specific property.
• Object instance with the device number.
• Object instance with the prefix V2, and the device number.
4. Click OK.
3. In the File name field, enter a file name for the report.
4. From the Save as type menu, select the file format, and then click Save.
5. In the Destinations dialog, click OK.
6. The Destinations field now displays the report location and format.
Note: For files generated automatically, a suffix needs to be added to the report
name to prevent any previous reports from being overwritten. When entering a file
name the following notations can be used. These notations add specific
information to each file name. Multiple notations can be added to file names (see
Add the Time), and they can be used in any order.
3. In the Destinations dialog, fill in the appropriate fields. Use a semi-colon (;)
to separate addresses if sending to multiple recipients.
4. From the Format drop-down menu, select the format, and then click OK.
Note: A SMTP server is required to send reports by email. The SMTP server
address should be specified in the email tab of the Device object dialog for the
local operator workstation. See the following figure.
TROUBLESHOOTING REPORTS
The following section provides some examples of issues that may arise when
using the RPT object, and how to deal with these issues to maintain your reports.
• Limit the criteria by name, or by object type. For example, replace "* > 23"
with "(ai, ao, av) > 23" or Temperature* > 23.
• Reduce the number of columns in the report.
• Reduce the number of devices involved. For example, specify a smaller
device range, or specify devices within a single System instead of in the
whole Area.
The Historian Settings object (HS) provides access to the setup options and status
information for the Historian device. The HS object is automatically created when
Historian is started and is accessible from any Operator Workstation (OWS) on
the network.
Header
Object Mode
The Historian’s current mode of operation is displayed at the top of the header.
Historian’s five modes of operation are as follows:
Initializing Historian is establishing connections to its ODBC database and to
Delta Server and is initializing its schedule.
Archiving Historian is collecting data samples from one or more source TLs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Sleeping Historian is “waiting” for one of three events to occur, it will then
transition into Scheduling mode. Historian enters scheduling mode when any of
the following three events occur:
When the next scheduled polling time is reached.
When a COV buffer ready notification from a TL is received.
When a Forced Update for a Historical TL is requested by the user.
Scheduling Historian is “calculating” which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database, the ODBC
database connection or else the Delta Server is offline. Historian will periodically
attempt to recover from the fault condition by reconnecting.
In Fault mode, Historian does not archive TLs or Alarm/ Event Notifications to its
ODBC database. However, Alarm/ Event Notifications are logged in a separate
MS Access database that is created when Historian is in fault due to database, or
database connectivity problems.
When Historian is in fault due to Delta Server being down, Historian does not log
to the Access database file as it no longer receives Alarm/ Event Notifications.
The backup Access file is called HistorianFaultDB.mdb and is located in the
Historian install folder.
Current Time This field displays the current time of the Historian PC.
Next Poll This field indicates the next scheduled time at which the Historian
Device will archive samples from one or more TL’s. Historian may start to poll
before this time if a forced update is requested, or if a Buffer Ready Notification is
received from a TL.
Last Poll This field indicates the last time that any TLs were polled for new
samples.
Stats
The Stats tab only shows statistics when viewed from the local Historian PC.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
Historian Uptime
Indicates how long the Delta Server has been running on the Historian PC. It
displays the length of time in Days/ Hours/ Minutes/ Second.
Processing Time
Provides a relative indication of the status of Historian over time. The fields
display the percentage of total time which is spent in Archiving, Sleeping,
Scheduling, Initializing and Fault states. It tracks the percentage of time that
Historian is in each state and begins when the first TL is added.
To specify the database name in the DSN for Microsoft SQL server:
1 Open Data Sources (ODBC)
For a 32 bit OS, open Control Panel | Administrator Tools.
For a 64 bit OS, you must still use the 32 bit ODBC Data Source dialog (NOT
64 bit one). The Microsoft support provides vital configuration information.
See http://support.microsoft.com/kb/942976
2 Select the System DSN tab. See HistorianDSN listed:
3 Click Configure.
4 Click Next.
5 Select the authenticity type to SQL Server Authentication. Be sure to use the
SQL Server authentication.
6 In Login field, type the UserID displayed on the HS object Setup tab. The
default UserID is sa.
7 In Password field, type password you entered during the SQL Server
installation.
8 Click Next.
9 Select the Change default database to checkbox.
The configuration steps between the connector and the server are similar to the
previous Configuring DSN for Microsoft SQL Server section of this chapter. The
HS dialog needs to reflect all the changes done with the ODBC data source.
Troubleshooting
Troubleshooting is often difficult and demands many higher-order skills combined
with experience to solve problems in an efficient and effective manner. The
solution to a simple problem can be direct but often with complex systems, it is
difficult to resolve a problem. In many cases, a problem may have multiple
causes. With many components such as systems, equipment, controllers, software,
sensors and transducers, a complex system has a greater possibility of problems
due to multiple causes.
With a simple problem, it is easy to interpret appropriate data that helps to isolate
a reproducible cause and make suitable changes to prevent recurrence while not
introducing new problems.
With a complex problem, the nature of the problem itself is often unclear and may
also involve dynamic effects such as events that are not predictable. Some of the
most difficult troubleshooting issues arise from symptoms which are intermittent.
Your solution needs to prevent recurrence but also must not introduce further
problems within the overall system. After implementing a solution, you need to
observe and collect data to ensure its continued effectiveness.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does NOT indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
High Usage Trend Logs This is a list of the ten fastest to fill trends (Poll or
COV). You may not need to do anything about these trends because this list
shows the TLs that use the most Historian resources.
For example, the High Usage list may contain a Trend Log that collects large
amounts of data at frequent intervals. Everything may be fine as you need to
collect this data. Alternatively, the sample rate may be much too high for this
particular variable. It is also possible that the characteristics of the monitored
object value do not match expectations and indicate a possible problem within the
site. You may be using much more Historian resources than intended or needed
for a High Usage TL.
All Archive Trend Logs can be configured so that Historian can archive all Trends
without missing samples. To make sure this is the case on your site, use the
information in this High Usage table and in the Histlog.txt to verify the Trend
Logs in the High Usage list are configured correctly. The Histlog.txt can be
searched to make sure none of these Trend Logs have missed samples reported
and the information in the High Usage Trend Logs table should be reviewed.
The following table explains the information included with a High Usage Trend
Log list item. Each TL entry is followed by two numbers.
8000.TL1 - 3240, 1
Historian will be able to keep up with this trend.
First #: The number of seconds Historian waits between
(PollInterval) successive Trend Log data collection operations. This
is the PollInterval from the ScheduleInfo table in the
3240 database.
(Seconds between TL Historian cannot archive a single Trend Log more
Archives) than once every 120 seconds. This deliberate
constraint prevents a single poorly configured Trend
Log from dominating Historian’s resources.
The following table provides general guidelines for interpreting the information
included with a possible High Usage Trend Logs list item.
Second #:
(PeakRate) Lower 0.125 < 0.4 <1 >6 60
(Number of
Samples per
minute)
The following table provides some examples of possible High Usage Trend Logs
List Items with interpretation of the example.
8000.TL1 - 8100, 0.4 Good: Historian can keep up with this trend.
8000.TL1 - 86400, 0.125 Better: Historian can definitely keep up with this
trend.
Trend Logs with Insufficient Samples This is a list of the top ten trends
(Poll or COV) that Historian will miss data from with the current TL
configurations. If a Trend Log is on this list, it indicates a definite problem that
needs attention. These Trend Logs often do not have a large enough Max Samples
setting in the source Trend Log for Historian to be able to archive all new data at
the rate each Trend Log is storing data.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Generally, you would increase the size of the buffer for the Trend Logs which
provide the most important data. There is a balance between the demands of data
collection, the memory available on a controller and the relative importance of the
data.
For example, a list item might be:
8000.TL1
8353.TL6
If 8000.TL1 is a Poll Trend Log with a Log Interval of one second and a Max
Samples (buffer size) of 100, then Historian cannot archive all the data. Historian
A solution might be to increase the Max Samples and/ or to increase the Poll
Interval. You could increase the Max Samples buffer size assuming that memory
is available on the controller. You could also reduce the data collection rate by
increasing the Poll Interval as it is probably not necessary to collect new data
every second.
If 8353.TL6 was a COV trend log, a typical solution would be to evaluate the
COV Increment of the Monitored Object to make sure that it is reasonable for the
point being measured and then change the COV increment and/or increase the
Max Samples for the TL as appropriate.
In the case of an intermittent problem, you can run a query on the ScheduleInfo
table looking at the MaxPeakRate. The MaxPeakRate provides the highest number
of samples per minute ever recorded in the past.
The following query will help identify trends that have problems due to
intermittent periods of high data samples:
Select * FROM ScheduleInfo ORDER BY MaxPeakRate DESC
When the trends with intermittent high data rates are identified, you can increase
their MaxSamples, decrease their COV rate number or decrease the samples rate.
The extra HistLog info also lists this information.
Setup
The Setup tab contains the setup items for Historian’s auto logon, ODBC
connection, TL polling and error logging.
Auto Logon
UserName This field specifies the name that the Historian Device uses when it
logs onto the Delta Server.
Password This field specifies the password that the Historian Device uses
when it logs onto the Delta Server.
The UserName and Password must match those of a System User Access (SUA)
object in the local database, or in the security panel. For information on changing
the password see Chapter 6: Trending, Archiving and Reporting.
ODBC Info
Historian is installed with a default Database Management System (DBMS), and
the settings are displayed in this section. Most users will not need to change the
following fields unless they choose a different DBMS package or if they need to
apply user security to the Historian database. Users who choose a different DBMS
will need to set these fields up appropriately. For more information on ODBC see
Chapter 6: Trending, Archiving and Reporting.
Driver The Driver field indicates the type of ODBC DBMS that Historian is
configured to use.
UserID The UserID field specifies the name that Historian uses to connect to
the database. The UserID and Password for the database are configured when the
DBMS package is installed. There is no relationship between this UserID and the
user name that the Historian will use to log onto the Delta Server.
DSN The Data Source Name (DSN) field specifies the ODBC DBMS source
that Historian is using. To use an alternate DBMS source, it must first be set up
through the appropriate ODBC Data Source Administrator dialog. Use the 32 or
64 bit version based on your OS..
Password The Password field specifies the password that Historian uses to
connect to the database. UserID’s and Passwords for this database are set up using
the installed DBMS package.
DB Name The DB Name field specifies the database that will store the
archived information. If a database name is not specified then Historian uses the
default database assigned to the selected DSN.
Archive TLs are presented as regular TLs to the other BACnet devices. As such,
they are accessible via any BACnet Operator Workstation (OWS) that supports
TLs as defined in the BACnet Standard (2001b or later). Historian will not work
with devices implementing trending as defined in versions of the standard prior to
2001b.
Once TLs are archived, the Archived TL’s cannot be removed without using a
database management tool.
Note: To mark a trend or groups of trends (regular TL's) for archiving in Version
3.40, follow the procedure in the Archived checkbox field of the TL Setup Tab:
Log Interval l section. V3.40 now supports multiple Historians on one site and as
a result the Archived checkbox on TL is not editable and is greyed out. In V 3.40,
you must select a TL or group of TL's in the right pane of Navigator and then
right click. From the menu, select the Command option and click on Add to
Historian.
Header
In the previous figure, the first section of the header shows the Historical TL’s
operating mode.
Samples
The Samples field displays the number of data samples that are currently stored in
the ODBC database for this TL.
Update Button
The Update button allows users to instruct the Historian Device to immediately
archive any new samples in the source TL.
Graph
The Graph tab contains a visual representation of the monitored object’s values
within a specific time frame.
The graph plots the object’s value on the Y-axis, against the time, which is on the
X-axis. These two axes are automatically scaled to best fit the available data.
Only the 200 most recent samples are graphed. To view the full set of TL data
graphically, create a Multi-Trend (MT).
Setup
All the fields within the Setup tab are read-only, with the exception of the Name
field.
Name
The Name field displays the name of the Archive TL. In the previous figure, the
Name text box shows the default naming convention for Archive TL’s. The Name
field can contain up to 255 characters. The Archive TL is named in this way: the
TL controller number, the TL name and then Archive. For example, an archived
TL for Temperature, on controller 100 would look like this: 100_Temperature
Archive.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security.
When a checkbox is selected, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Monitored Object
The read-only Monitored Object field displays the name of the source TL’s
monitored object. If the source TL’s monitored object is changed, the Historian
Device will detach from the TL and a new TL is created for the new monitored
object.
Log Type
The read-only Log Type field displays whether the source TL is in Polling mode,
or in Change of Value (COV) mode. Depending on the how the TL is configured,
Historian gathers the data in the following ways:
Log Interval
The read-only Log Interval field is only shown when the source TL has a Polling
Log type. The log interval is the amount of time between polled samples of the
source TL. The value in this field is taken from the Log Interval field of the source
TL.
When changes are applied to this field in the source TL, the field is also updated
in the corresponding Archive TL.
Max Samples
The read-only Max Samples field displays the maximum number of samples that
can be stored in the TL. In an Archive TL, this field is set to ‘unlimited’.
Total Samples
The read-only Total Samples field displays the total number of samples that the
archived TL has collected since it was created.
Start Trend At
This field shows the value of the Start Trend At field from the source TL. This
value does not affect the functioning of the archived TL.
Stop Trend At
This field shows the value of the Stop Trend At field from the source TL. This
value does not affect the functioning of the archived TL.
Data
The Data tab contains a text listing of all the data stored in the Archive TL. Each
entry shows the time and date at which the sample was collected, and is presented
with the newest data at the top of the list.
The Value column shows the value of the sample, which is displayed as 1 or 0 for
Binary values. An “Active” state is indicated by 1, and an “Inactive” state is
indicated by 0.
The Value column also displays error and status messages. This helps with
troubleshooting because these error and status messages do not show up in the
graph.
Some of the system messages that are shown in the Data tab include:
• Time Change: the time on the controller changed.
• Log Enabled: the source TL was enabled.
• Log Disabled: the source TL was disabled.
• Missed Sample: Historian missed a sample from the source TL.
• Buffer Purged: the source TL’s buffer was cleared.
• Archive Disabled: the archived TL has been disabled.
• Archive Enabled: the archived TL has been enabled.
If an archived TL is disabled, the log may have an Archive Disabled entry. If the
Archive TL is re-enabled and Historian finds that no samples have been missed,
the Archive Disabled entry in the Data tab is removed.
If, however, samples have been missed, Historian leaves the Archive Disabled
data entry in the Data tab and inserts an Archive Enable entry after the missed
sample entries.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
Description
The Description tab provides the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
The Trend Log (TL) object stores data for one monitored object. The TL can be
set to collect data in two ways:
• Change of Value
• Polled
Change of Value TLs use the monitored object’s Change of Value (COV)
minimum increment to determine when to take a new sample. When the
monitored object’s value changes by more than the COV minimum increment, a
new data sample will be collected in the TL. All objects default to a COV
minimum increment of 1.0, but this can be changed on an object-by-object basis.
Polled TLs collect new data samples based on a time interval, which can be set by
the user. This time interval is called the Log Interval. By default, a new TL will
have a Log Interval of one minute, which means that a new data sample will be
taken every minute.
The Archival Buffer Notification Setup enables a notification to occur once a set
threshold of samples has been recorded. This functionality can be used to perform
automated archival of trend data to prevent data loss.
Historian Note: V3.40 now supports multiple Historians on one site and as a
result this Archived checkbox is not editable and is grayed out. The Archived
checkbox was available in 3.33. In V 3.40, you must select a TL or group of TL’s
from a selected controller in the right pane of Navigator and then right click.
From the menu, select the Command option and click on Add to Historian.
Header
While a Trend Log is in “Enabled” mode, the object collects data samples and the
current date is between the Started Trend At date and the Stop Trend At date.
When a Trend Log is in “Disabled” mode, the object goes into auto shutdown.
This prevents existing data samples from being overwritten. When in Disabled
mode, the user must manually set the object to “Enabled” to start trending again.
Started Trend At
If the TL is set up to start archiving at some time in the future, this field is visible
and shows the scheduled start time.
Stop Trend At
If the TL is archiving and is set up to stop archiving at some time in the future,
this field is visible and shows the scheduled stop time.
Samples
This field displays the current number of data samples stored in Historian’s data
buffer.
Graph
The Graph tab contains a visual representation of the monitored object.
The graph plots the object’s value on the Y-axis, against time, which is on the X-
axis. The two axes are automatically scaled to best fit the available data. The
graph provides a fixed, 200 sample width. Only the most recent 200 samples are
graphed, regardless of how many samples the Trend Log is capable of storing. In
order to see the full set of data, use the Multi-Trend (MT) object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
operators for the HVAC and Access applications. It is possible for each operator
to only see the objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security.
When a checkbox is selected, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Monitored Object
The Monitored Object is the object that is being trended. Any analog or binary
value can be trended. By default, the value property of the monitored object is
trended. If a property name is specified, then that property is monitored. For
example, 9100.AI1 Commissioned, would trend the commissioned flag of this
analog input object.
Historian Note: Detached Trend Logs — If the source TL (of an Archive TL) is
deleted, or the monitored object is changed, or the archived checkbox is cleared,
the associated Archive TL becomes detached. Detached TL’s are set to
“Disabled” and do not collect new data, but they do keep all the data they have
accumulated.
Log Type
Change of Value Change of Value TLs use the monitored object’s Change of
Value (COV) minimum increment to determine when a new sample should be
taken. When the monitored object’s value changes by more than the COV
minimum increment, a new data sample will be collected in the TL. All objects
default to a COV minimum increment of 1.0, but this can be changed on an
object-by-object basis.
Polled Polled TLs collect new data samples based on a time interval, which can
be set by the user. This time interval is called the Log Interval. By default, a new
TL will have a Log Interval of one minute, which means that a new data sample
will be taken every minute.
Historian Note: Changing the Log Type field in a TL that is being archived may
cause Historian to change the manner in which it archives the TL’s data samples.
See the following table for details.
Log Interval
This is the amount of time between polled samples. The log interval can be set
from a minimum of one second, to a maximum of 23:59:59 hours.
If a TL is polling a remote object, then the time should not be set to less than 30
seconds as remote data exchange cannot achieve intervals faster than once every
30 seconds.
Historian Note: When the Log Interval is altered in a TL that is being archived,
the change affects how frequently Historian archives data samples from the
source TL.
Daily Checkbox
When the Daily checkbox is enabled, samples are taken once per day at a
specified time. The Daily sample time is determined by the Start Trend At
spinbox.
Max Samples
The Max Samples field is the maximum number of data samples that can be stored
in the TL’s data buffer. The range of this value is between one and 6000, with the
default being 100. The larger this number is, the more memory used by the
controller. As a rough guide, each sample takes about 10 bytes. Thus, a 100
sample TL would require 1000 bytes of memory. Obviously, not very many 6000
sample TLs (each occupying about 60,000 bytes) can be created in one controller.
Historian Note: Changing the Max Samples field affects the frequency at which
the Historian gathers samples if the TL is being archived. Increasing the Max
Samples value will improve Historian performance and help ensure the safety of
the data.
Total Samples
This number is the total number of samples that the TL has collected since it was
created. This field is read-only and cannot be reset.
Start Trend At
This field is used to specify the time and date at which the TL will start sampling.
When the checkbox is cleared, “No Start Date” will be displayed in the field and
the TL will start sampling immediately. When the checkbox is selected, enter the
desired start time into the field. The time format is HH:MM:SS.
When a new TL is created, the Start Trend At Date defaults to 00:00:00 Jan 2000
which is the base time. The Trend At date is enabled with no Stop Trend At Date.
When the start date is enabled, sample times are calculated using the Time Start
when Polling is used. The object calculates time interval on even periods if the
entered Start Trend At Time is divisible by 60 for minutes and seconds, or
divisible by 24 for hours. The Log Interval spin box allows a max of 23:59:59. If
you need to use a daily sample rate, you can enable the Daily checkbox beside the
Log Interval spin box.
The following examples show the behavior of the sampling for different entries:
• 00:00:00 15 min polling samples on hour, 15 minutes past, ½ past, and 45
minutes past hour.
• 00:00:10 15 min polling samples at 10 after hours, 25 minutes past, 40
minutes past, and 55 minutes past hour
• 00:00:00 1 Hour polling sample every hours on the hour
• 00:00:30 1 hours polling sample every hour at ½ past the hour
• 17:00:00 24 Hours polling sample every day at 17:00:00
• 00:00:00 2 hours polling sample at 0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22
• 01:00:00 2 hour polling sample at 1, 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23
If the sample time does not follow the rules of divisibility, then it is polled based
on the Trend Log start time or reset and simply counts the time period from this
start time. On Reset or DST/Time change, the new algorithm does not sample
immediately. It calculates the projected time for the next sample and then samples
at this time but cannot maintain the interval.
For example, a controller is reset at 12:30:30 and interval is 11 seconds. Then the
first sample will be at 12:30:41 the next and + 11 seconds so 12:30:52 instead of
being lined up on even intervals.
When the Start Trend At time is disabled, the Trend Log works in the standard
way. It begins taking samples on Reset/ Time Change/ creation of new TL and
then after the Polling Interval.
Stop Trend At
This field is used to specify the time and date at which the TL will stop sampling.
When the checkbox is cleared, “No End Date” will be displayed in the field and
the TL will never stop sampling. When the checkbox is selected, enter the desired
end time into the field. The time format is HH:MM:SS.
4 If there are multiple Historians installed on the site, select the particular
Historian that you wish to archive the selected trend(s) to.
The previous dialog only appears if the site has more than one historian.
5 When the trend is marked as Archived, the Setup tab will show that it is being
archived.
The Archived checkbox cannot be edited from the Setup tab of the TL.
The Reporting checkbox can now be disabled for DAC and DSC controllers.
Event Class The Event Class drop-down menu is used to select the
notification’s event class. The choices available will reflect the EVCs that are set
up in the controller.
Threshold The Threshold field is where the number of log entries recorded
before an event occurs is set. When the number of records has been exceeded, the
threshold count will be reset and an event will occur again once the number of
records exceeds the threshold value.
Records Since Last Notification The Records Since Last Notification field
displays the total of new records acquired by the TL since the last time an
Archival Buffer Notification was sent to Historian. This can be polling or COV
TLs.
Data
The Data tab is a text listing of the data in the TL’s buffer. Each entry shows the
time and date at which the sample was collected. The data is presented with the
newest data at the top of the list.
The Value column shows the value of the sample, which is displayed as a binary
value, 1 indicates On, and 0 indicates Off. Error and status messages are also
displayed in the dataview. These are to aid with troubleshooting and will not show
up in the graph.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
Note: A Trend Log object will trend a maximum period of around 490 days or the
date-time information for the old data is lost. Any trended data or error/event data
that is older than 490 days is automatically removed from the TL on a weekly
basis. This does not apply to Archive TL’s.
Description
The description tab contains the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
The Multi-Trend (MT) is an ORCAview application that graphs the data samples
in Trend Logs (TL). Up to eight TLs can be graphed simultaneously in one MT
Object. The graph will plot new samples as the TLs collect them.
One of the MT object’s most useful features is the ability to drag-and-drop a TL
onto the MT dialog and have the MT start graphing the TL automatically. This
feature makes it possible to graph different TLs at any time and instantly compare
them.
Multi-Trend Components
This section explains how the Multi-Trend object presents information. A Multi-
Trend object has these main components:
• Graph Area
• Dataview
• Slider Bar
• Axes
• Graph Legend (Colored Squares)
• Toolbar
Graph Area
The graph area is where Trend Log data is plotted and displayed. Analog data is
graphed along the top section, and the digital, or binary data, is graphed along the
bottom. The view can be scrolled from side to side to view all the data that the MT
has in its data buffer.
Dataview
The lower portion of the MT object contains the Dataview area. This area displays
information about each monitored object.
Dataview
Monitored Object This column lists each monitored object being plotted. To
the left of the monitored object name are two icons. The first is a checkbox that
shows or hides each line graph. The second icon shows the monitored object’s
corresponding line color on the graph.
Value This column shows either the last sample taken or the sample at the
intersection of the Slider Bar line and each graph.
Min / Last Off and Max / Last On These columns show the minimum and
maximum values for analog Trend Logs and the last on and last off times for
binary Trend Logs.
Average / On Time This column is the calculated average value for analog
Trend Logs, and the time spent in an ON state for binary Trend Logs.
Units This column shows the unit used for the data in each Trend Log.
Slider Bar
The slider bar at the top of the graph area is used to show the value of individual
samples for a specific time. When the slider bar is moved back and forth along the
length of the graph window, the slider caption will change to reflect the time that
the slider bar is positioned at, on the time axis. Where the slider line intercepts the
TL graphs, the value of the graph at that point will be shown at the bottom of the
MT window in the dataview section, under the Value column.
In order to move the slider bar back and forth, position the mouse cursor over the
slider caption area, press and hold the left mouse button, and then move the cursor
to the left or right.
Slider bar
Axes
Trended objects can be graphed against three axes: the Y1-axis (left-hand side),
and Y2-axis (right-hand side) are used to graph analog data. The X-Axis is used
for time and appears underneath the graph area.
Binary Trend Logs graphed in the Multi-Trend will have their own binary axis
created. The binary data appears at the bottom of the graph when needed.
There can be colored squares on both sides of the Multi-Trend graph area. The
color of the squares corresponds to the color of the graph lines. If the square is on
the left, then that graph is being plotted against the Y1-axis. If the square is on the
right, then the graph is being plotted against the Y2-axis.
Toolbar Components
The Toolbar is used to configure the Multi-Trend object.
The following section describes, from left to right, each of the toolbar buttons, and
the related functions.
TL Setup
This button opens the Line Properties dialog to set each TL up. There are eight
tabs, one for each TL, for a maximum of eight TLs that can be graphed at one
time.
Trend The Trend field is where the TL object name or object reference is
entered.
Axis Assignment These option buttons are where the axis for the Trend Log
is selected. Analog TL’s can be set to use either the Y1-axis or Y2-axis. Binary
TL’s should automatically be set to use the digital (binary) axis.
Graph Properties This drop-down menu is where the color of the Trend Log
graph is selected. For good printing results, select colors that are easy to
distinguish if using a black and white printer.
Remove Trend Button This button is used to remove the Trend Log from the
Multi-Trend. When the Remove Trend button is clicked, the user must click
Apply or OK to remove the TL.
Axis
The Axis button on the Multi-Trend toolbar opens the Axis Properties dialog that
sets the axis properties for Time (X-axis) and Value (Y1-axis, Y2-axis).
X-Axis Tab
These are the fields displayed in the X tab of the Axis Properties dialog.
Start Time This is the time at which the graph started plotting. This time is
displayed as the left-most value along the X-axis. If the Automatic checkbox is
selected, then the Start Time of the graph is automatically configured to show the
oldest Trend Log sample. If the Automatic checkbox is cleared, then time and date
fields are enabled. These fields are used to specify the time at which the graph will
start plotting.
Time Span This is the time span that the graph area will show. If the
Automatic checkbox is selected, then the graph will show all of the Trend Log
samples from the Start Time onwards. If the Automatic checkbox is cleared, then
the time span must be specified. The default value is eight hours.
Scale & Grid Interval This section sets the time interval for the X-axis and
grid lines (if displayed). If the Automatic checkbox is selected, then an interval
time will be calculated. If the Automatic checkbox is cleared, the time interval
may be set by the user.
Show Grid This checkbox enables and disables the X-axis grid lines.
The following fields are displayed in on the Y1, and the Y2 tabs of the Axis
Properties dialog. Both tabs contain the same fields.
Minimum Value This is the lowest value on the Y-axis scale. If the Automatic
checkbox is selected, the minimum value is determined based on the data to be
shown. If the Automatic checkbox is cleared, then the lower end of the Y-axis can
be set manually.
Maximum Value This is the highest value on the Y-axis scale. If the
Automatic checkbox is selected, the maximum value is determined based on the
data to be shown. If the Automatic checkbox is cleared, then the higher end of the
Y-axis can be set manually.
Scale & Grid Interval Selecting this checkbox sets the grid interval for the Y-
axis and grid lines (if displayed). If the Automatic checkbox is selected, then an
interval is calculated. If the Automatic checkbox is cleared, then the grid interval
may be set by the user.
Axis Precision Selecting this checkbox sets the number of decimal places that
are displayed on the Y-axis. If the Automatic checkbox is selected, then an
appropriate Axis Precision will be calculated. If the Automatic checkbox is
cleared, then the Axis Precision may be set by the user.
Axis Title This field displays the title that is shown on the graph.
Show Grid Selecting this checkbox enables Y-axis grid lines. When this
checkbox is cleared the grid lines are disabled.
Settings
The Settings button opens a dialog that sets some general MT properties.
Show Graph Values When this checkbox is selected, the MT displays the
actual Y-axis value for each data sample on the graph.
Note: The Show Graph Symbols must be selected first to enable the Show Graph
Values checkbox.
Polling Intervals This value is the amount of time the MT waits before
retrieving any new data samples that are stored in the TLs. The default MT polling
time is now 1 minute from the previous 10 seconds so as to improve the
performance of the Multi Trend and reduce the CPU usage.
Setting this value lower will speed up the responsiveness of the MT, but at a cost
in terms of network traffic. The minimum value for polling intervals is 10
seconds. If the MT seems sluggish, it is recommended that this value be increased
as necessary. MTs containing eight TLs, with a large number of samples (more
than 1000 each), should have this value increased to more than one minute.
Pause
This button prevents any automatic display updates. The MT keeps graphing and
only freezes the frame so the X axis (time scale) does not resize itself or pan when
the graph reaches the right. This is done so that when using the Back / Fwd and
Zoom In / Zoom Out functions, the display is not changed on the next polling
interval.
Print
This button prints the currently viewed MT. Note that if the connected printer is
capable of color, then the MT printout will be in color. It is also possible to select
the Print to File option on a Windows print driver and click OK. Then, you enter
the file path and name. A Postscript file is created and it is readable by a printer.
Save
This button saves the selected MT’s data, and writes it to a comma-delimited text
file with the default name MT.txt. The Username, Date/Time, and Workstation
name are included at the top of the file. This data can then be imported into a
spreadsheet or another application. All of the MT's data will only be written to the
file if the MT is in Auto mode showing the entire data. If the graph is only
showing a subset of the data, for example zoomed in with Setstart or Range mode,
only the viewable data points will be written to the file
Report Setup
The Report Setup tab is used to select and configure the Query, Tenant Billing,
Access Configuration, Access, Controller Configuration, and Controller reports.
When a new RPT is created the Setup tab defaults to Query report. The overall
layout of this tab changes based on which report type is selected.
Query Generates a report listing the objects, based on user-defined criteria. For
example:
• Calendar Configuration
• Schedule Configuration
CAL and SCH objects are used with other objects besides Access Controls ones. It
helps the building owners to know Calendar and Schedule setups in other control
devices.
Controller Reports Generates reports for Input and Output objects only.
The following sections describe the Setup tab for each report. This tab changes
based on the report type selected. The Destination/Layout tab and the Description
tab are the same for all six report types.
Query Setup
The following section describes all the fields and dialogs in the Setup tab when a
Query report is selected.
Devices
The Devices section of the Setup dialog contains three options for selecting object
filter criteria for individual devices or a range of devices.
All Devices Selecting All Devices filters for criteria related to all Version 2,
and all BACnet devices. If All Devices is selected, the query report displays
results from all devices that meet the object filter criteria.
Area Selecting this option enables the Area, System, and Subnet drop-down
menus, and allows the selection of devices based on the Area-System-Subnet
(DNA) architecture. Only BACnet devices are listed in these menus.
When an Area device is selected, the System drop-down menu shows all the
System devices under that area. Selecting All Devices from the System drop-down
menu generates reports on all devices in that Area.
If a specific System device is selected, the report is generated on all devices under
that system.
When a System device is selected, the Subnet drop-down menu contains all the
Subnet devices under that System. Users can generate a report on a single subnet
device by selecting a device in the subnet drop-down menu.
Note: If there are no applicable devices for the drop-down menu, that specific
drop-down menu is disabled.
Specific Selecting Specific filters for specific devices or device ranges. Some
examples of acceptable entries are:
• 23000
• 23000 - 40000
• 40000
• 23000, 30000 - 45000, 60000
Object Filter
The Object Filter box is used to enter specific search criteria in the same way
information is entered into the Navigator Filter Bar in ORCAview. The Object
Filter box limits which objects are displayed in the report. Objects can be filtered
in the following ways: by object name, object type, object instance, or by property
values. The following table provides examples of filtering criteria that can be
used.
Report Format
The Report Format section is used to configure how each column of the report
information is displayed.
Clicking the column headers sorts contents in ascending or descending order. The
columns and cells within each section can be modified in a variety of ways. The
right-click function is used to Add, Remove and Edit columns based on the report
information required.
Once modified, any report changes can be viewed by clicking the Preview button
on the lower left corner of the Setup dialog.
Property The Property cells define the object property shown in the report.
Using the cursor, click the cell, and select one of the predefined properties (as
shown in the following figure), or enter an object property that is relevant to a
specific object type.
Alignment The Alignment cells define the text alignment (left, center, right)
within that column. Click the cell to change the alignment.
Format The Format cells define how the properties are displayed, which can be
either text or decimal values. For example, if the object property is True/False and
"Text" is selected as the Format, then "True/False" is displayed in the column. If
the number signs (#.#####) are selected as the Format, then "1.00000/0.00000" is
displayed in the column.
Add, Edit & Remove The Add, Edit and Remove functionality becomes
available by right-clicking in the dataview area of the Report Format section.
Add Column This dialog contains two fields for adding new columns to a
report, the Property field and the Column Name field.
• The Property field defines the object property that is shown in the column. It
contains a drop-down menu of predefined properties or a desired property can
be entered.
• The Column Name field defaults to the predefined property chosen. This field
can be customized by typing in a chosen name. This name then appears as the
column header.
Edit Column This dialog is used to edit any columns by changing either the
Property field, or the Column Name field.
Remove Column This feature removes columns from the Report Format
dataview and from the report. Using the right-click function within a column,
click Remove Column to delete it.
Period
The Period drop-down menu is used to define the range of data used to calculate
the billing time period.
The options available are Previous Month, Current Month, or any of the 12
calendar months (January through December). When one of these calendar
months is selected, the Year box is enabled.
Invoice #
The Invoice field is used to enter the invoice number that appears on the Tenant
Billing report. Each time a new report is auto-generated, the invoice number is
incremented automatically. A new invoice number can be chosen, and then the
report numbers increase incrementally from that point forward.
Trend Logs
The Trend Logs dataview displays a list of the TLs used to calculate the tenant
billing amount. The Trend Logs dataview contains the following four columns:
Rate Displays the amount charged per hour for each TL entry.
+/- Displays any temporary adjustments made for that specific TL entry.
Because this value is temporary, the information is deleted when the RPT dialog is
closed.
Add Button
The Add button opens the Add Trend Log dialog, so that single or multiple TLs
can be added to the Trend Logs dataview.
Trend Logs The Trend Logs area displays a list of all TLs found in the
selected devices.
Rate The Rate field is for setting the hourly dollar rate that is used to calculate
the overall transaction cost for that specific TL. This field only accepts positive
numbers. By highlighting multiple TLs, the rate is applied to all of those selected.
Edit Button
The Edit button opens the Edit Trend Log dialog to modify the Description, Rate,
or the Temporary Adjustment value of a selected entry in the Trend Logs
dataview.
Trend Log Displays the TL name and the TL object reference (for example,
2000.TL2).
Rate ($/hr.) This field is used to set the hourly rate for the TL.
Remove Button
The Remove button deletes any highlighted entry from the Trend Log dataview.
Minimum Charge The Minimum Charge drop-down menu sets the minimum
time charge for transactions. This menu has the options 0, 5, 10, 15, 30, or 60
minutes, or enter a value of 0 - 6000. These amounts are displayed in the Tenant
Billing Report. For example:
Note: Access Configuration Report templates show how specific objects are
configured. Instead of going to a specific object or group of objects to see the
configuration, a report can be generated for that object or group of objects.
Devices
The Devices section contains three options for selecting object filter criteria for
individual devices or a range of devices. These fields are the same as the fields in
the Query report Setup tab.
All Devices Selecting All Devices filters for criteria related to all Version 2,
and all BACnet devices. If All Devices is selected, the query report displays
results from all devices that meet the object filter criteria.
Area Selecting this option enables the Area, System, and Subnet drop-down
menus, and allows the selection of devices based on the Area-System-Subnet
(DNA) architecture. Only BACnet devices are listed in these menus.
When an Area device is selected, the System drop-down menu shows all the
System devices under that area. Selecting All Devices from the System drop-down
menu generates reports on all devices in that Area.
If a specific System device is selected, the report is generated on all devices under
that system.
When a System device is selected, the Subnet drop-down menu contains all the
Subnet devices under that System. Users can generate a report on a single subnet
device by selecting a device in the subnet drop-down menu.
Note: If there are no applicable devices for the drop-down menu, that specific
drop-down menu is disabled.
Specific Selecting Specific filters for specific devices or device ranges. Some
examples of acceptable entries are:
• 23000
• 23000 - 40000
• 40000
• 23000, 30000 - 45000, 60000
Object Filter
The Access Configuration report template selected limits what information can be
entered into the Object Filter field. For Example, if the report style selected is
Schedule Configuration, then the object filter only applies to the SCH object (e.g.,
*=ON shows only the SCH objects that have an ON state).
Layout/Destination
The Layout/Destination Tab is used to customize report templates, configure
automated report generating schedules, and to choose report destinations.
Name
The Name field displays the name of the monitored object.
Title
The Title field is used to include descriptive information about the report. This
field only applies to Query Reports and Access Reports. When creating a new
RPT object, the RPT object name is filled into the Title field by default.
Notes
The Notes field is used to enter descriptive text into the heading area of a Query or
an Access Configuration report. For Tenant Billing reports, the text appears in the
Notes box. The maximum number of characters that can be entered is 254.
Footnote
The Footnote field is used to enter descriptive text at the end of a Query, Tenant
Billing, or Access Configuration Report. The maximum number of characters that
can be entered is 254.
Triggered By
The Triggered By field is used to enter an object reference, which can then
generate reports automatically. When the referenced object transitions from a
False state to a True state, a report is generated and sent to the chosen
destinations.
Destinations
The Destinations area is used to select where and how a report is sent. The Add
and Edit buttons are used to select and modify the destinations for the reports. The
Remove button is used to remove any of the report destinations no longer needed.
Add
The Add button is used to add a new destination. When selected, the destination is
displayed in the Destinations list area.
The Type drop-down menu contains three options: Printer, File, and Email.
Selecting these options determines which fields are available.
Printer When Printer is selected as the destination, the dialog shows all
available printers connected to the system.
File When File is selected as the destination, the dialog displays a Save As
button which is used to select the desired file format and storage location. The
default is “C:\Programs\Delta Controls\3.30\Sites\[Site Name]. When entering the
filename, the correct file extension must be used (pdf, rpt, csv, tsv, xls, htm, doc,
xml) or an error dialog appears.
Note: For files generated automatically, a suffix needs to be added to the report
name to prevent any previous reports from being overwritten. To create the suffix
a notation is used. These notations add specific information to each file name.
Multiple notations can be added to file names (see Add the Time), and these
notations can be used in any order. The Add an Invoice Number is used for Tenant
Billing only. When entering a file name the following notations are used.
Email When Email is selected as the destination, the dialog displays the address
fields and a Format field, as shown in the following figure. Format choices
include: Acrobat, Crystal Reports, Comma Separated Values, Tab Separated
Values, Excel, Word Document, HTML Document, or XML.
Edit
The Edit button is used to make changes to any selected destinations. Once a
destination is selected, click Edit to open the current destination settings and make
any required changes.
Remove
The Remove button is used to select, and then remove a report destination.
Description
The Description tab provides the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
Chapter 7 Contents
OVERVIEW ...................................................................................................... 7–4
SECURITY FOR BACNET NETWORK ..................................................................... 7–4
Version 2 Security ................................................................................. 7–5
LOGGING INTO A SITE WITH ORCAVIEW ............................................................. 7–5
Login Flow Chart .................................................................................. 7–6
Username and Password Characteristics ............................................. 7–7
BACNET OBJECT SECURITY................................................................................. 7–8
CREATING NEW USERS ............................................................................... 7–9
CREATING A NEW SECURITY USER GROUP (SUG) ............................................. 7–10
EVERY SUA REFERENCES A SUG ...................................................................... 7–11
SUG AND SUA CONCEPTS ................................................................................. 7–12
Using the Eight Default SUG Objects ................................................. 7–15
SETTING PERMISSIONS ............................................................................. 7–16
RESTRICTED DEVICES ........................................................................................ 7–17
Object Application Restrictions .......................................................... 7–17
Configuring Object Application Restrictions ...................................... 7–19
OBJECT ACCESS PERMISSIONS ........................................................................... 7–20
Entering Object Permissions............................................................... 7–20
Object Access Exceptions.................................................................... 7–22
Access Levels ...................................................................................... 7–23
OBJECT SECURITY IN NAVIGATOR USING ORS OBJECT ..................................... 7–25
Object Security (Lock, Unlock and Temporary Login Commands) .... 7–25
NETWORK SECURITY ......................................................................................... 7–27
PTP Remote Modem Connections with SUA Password ...................... 7–27
UDP/IP Remote Connections with SUA Password ............................. 7–30
SYSTEM USER ACCESS (SUA) [COPY] .................................................... 7–34
COMMON HEADER ............................................................................................. 7–35
Status ................................................................................................... 7–35
Last Logged In at ................................................................................ 7–36
Last Logged Off at............................................................................... 7–36
DESCRIPTION ..................................................................................................... 7–37
SETUP................................................................................................................. 7–38
Name ................................................................................................... 7–38
User Enabled ...................................................................................... 7–39
Security - Password ............................................................................ 7–39
Security - Password Auto Expire ........................................................ 7–39
Security - Password Start Date (Time also) ........................................ 7–40
Security - Password Expiry Date (Time also) ..................................... 7–40
Menu Reference (Not eTCH) ............................................................... 7–40
Object Security .................................................................................... 7–40
HVAC, Access, and Lighting Checkboxes ........................................... 7–40
USER DATA ........................................................................................................ 7–41
Alarm Filter ........................................................................................ 7–42
Disable Navigator ............................................................................... 7–42
OVERVIEW
ORCAview provides many new security features.
BACnet Object Security Object Security exists for all BACnet standards,
Delta Controls BACnet, and Version 2 objects. Version 3 object permissions for a
user or multiple users are defined in the Object Security tab of the System User
Group (SUG) object. Specific object exceptions for each individual user are
defined in the Object Overrides tab of the System User Access (SUA) object.
Version 2 Permissions are defined in UA object in the V2 Security Panel.
Third Party Security The security level set for BACnet standard objects in
ORCAview also apply to the BACnet objects in third party vendor’s equipment.
See Appendix D: Using ORCAview with Version 2 Sites for more details.
When a user wants to log in to the OWS, the username and password entered are
compared to the SUA objects, which exist in the OWS. If a match is found, the
user will be allowed access to the system, with permissions determined by the
SUA and SUG objects in the OWS. This method was allowed in order for
ORCAview to communicate to another BACnet vendor’s equipment, where a
Security Panel could not be specified in the Site Settings (SS) object.
Note: When a Security panel is specified, create all SUA and SUG objects on the
local OWS first and then the corresponding SUA objects are auto created on the
Security Panel. SUG objects associated with the SUA are not automatically
transferred. The permissions must be added or modified in the objects on the
Security panel.
Version 2 Security
For sites with Version 2 controllers installed, a specific Version 2 controller is
specified in the Site Settings (SS) object as the Security Panel. When someone
wants to log in to the OWS, the username and password entered in the login
screen is compared with the user access (UA) object in the specified Version 2
Security Panel. The UA object that exists in the Security Panel, not the OWS, will
determine the permissions for this user.
See Appendix D: Using ORCAview with Version 2 Sites for more details.
When the user clicks on the OK button, the system checks to ensure that this user
logon information is valid. It also determines the permission levels for the user
during logon. If the username and password match, then the SUA object in
ORCAview is set to the value Logged In.
A match occurs when the username and password typed by the user are identical
to the username and password specified in a particular SUA object. If the user
passes the check with the SUA objects which exist in ORCAview, then
ORCAview verifies that this user is valid according to the designated security
panel(s). This check is performed independently for Version 3 security and
Version 2 security.
No
When Version 2 security is checked, ORCAview verifies that the user who logged
in also has a valid UA object on the specified Version 2 Security Panel. The user
is granted access to the Version 2 network if the UA in the Security Panel has a
matching username and password, and the UA in the Security Panel is currently in
a Logged Off state. The user is now logged into the Version 2 network, and is
given permissions as determined by the UA object in the Version 2 Security
Panel.
Note: After a change is made to the security settings, the user must log out and
then log in again for the changes to take effect.
Object Security consists of the Security User Group (SUG) and the System User
Access (SUA) objects. Both objects are proprietary to Delta Controls Inc.
The SUG object sets and holds all permissions. The SUA object references the
SUG object and inherits its permissions. Specific object permissions can then be
set in the SUA.
The Security User group (SUG) object must be in the same controller (BACnet
Security Panel or OWS) as the SUA object, so that it can link and inherit the
group permissions for that user.
For example, if you have 10 SUA objects (10 users) on a BACnet Security Panel,
you will need to create or copy at least one SUG object into that controller. The
SUA objects can then be linked to the SUG object. Once linked, the SUAs will
inherit all permissions from the SUG object.
You need to have a matching user in ORCAview and the Security Panels or you
will be unable to log in to your system. If you create an SUA manually on the
OWS, the new SUA/ UA objects are automatically created in the Security Panels
For example if you create an SUA in your specified BACnet Security Panel but
not in the OWS, you will be unable to get into the OWS. Using the File->New-
>User… method from the ORCAview Dashboard eliminates these potential
problems for you.
This will create a Security User Group (SUG) on the local OWS and if a BACnet
Security Panel is specified then a corresponding SUG will also be auto created on
the BACnet Security Panel.
If an SUA is on the local OWS or on a BACnet Security Panel and it DOES NOT
have an SUG specified, then login will fail for that user and the following error
message displays.
When login fails, the previous message displays. When the OK button if clicked,
the login screen displays again. As a general rule, all SUA objects must reference
a local SUG to allow login.
By default the DELTA SUA object references the Administrator SUG for all
default databases and OWS.
The SUG object contains all the permissions within the object. This object has no
function unless an SUA is linked to it. Generally all permissions for a user or
group of users are set in the SUG object.
Here is an example setup of the SUA and SUG relationship based on 3 major
groupings of users (Administrators, Programmers, and Operators). Using the
default SUG objects located on the OWS.
Administrator
SUA SUG
This is the Administrator SUA that is This SUG object defines access rights to
linked to the SUG. the Administrator SUA.
Programmer / Operator
SUA SUG
These six SUAs are individually linked This SUG object defines access rights to
to the SUG. These could be groups of SUAs as a group.
Programmers or Operator SUAs.
The example picture below shows where in the SUA you can link to an SUG. In
this particular list this SUA object has 5 SUG selections to choose from,
Administrator, Operator, HVAC Operator, HVAC Programmer and Access
Operator.
To use these objects on a BACnet Security Panel, they must be copied from the
OWS to the Security Panel. If no BACnet Security Panel is specified, then the
objects do not need to be copied and can be access directly on the OWS.
The eight default SUGs fall into three pre-configured categories: Administrator,
Programmer and Operator. Programmer and Operator are then broken down into 3
sub categories; HVAC, Access and Lighting.
The Administrator SUG will have full access to all controllers and their associated
objects.
The Programmer SUG objects are configured so that the appropriate access is
given to the objects that a Programmer would use. Also, because there are three
different programmer SUG objects, the Administrator can assign the user the
HVAC, Access, or Lighting permissions depending on the area of the BACnet
Network the Programmer is working on. This same approach is applied to the
Operator SUG objects.
The eight default configurations are there to provide the Administrator a starting
point when setting up BACnet Object Security. These objects can be modified to
better suit the application or can be deleted if not needed.
SETTING PERMISSIONS
When setting the permissions in the SUA and/or SUG, be sure that you are setting
the permissions in the correct controller or OWS. If you are using a BACnet
Security Panel other than 0 (determined in ORCAview Site Settings object),
ensure that you are editing the SUA and SUG permissions in the BACnet Security
Panel you have specified or your changes will have no effect.
If you have entered 0 for your BACnet Security Panel, ensure that you are editing
the SUA and/or SUG permissions in WS as changes to an SUA and/or SUG in a
controller will have no effect. Permissions for Version 2 objects are set in the UA
object in the specified Version 2 Security Panel.
In the SUG object, the security restrictions are based on three major sections:
• Restricted Devices, starting on page7–17
• Object Application Restrictions, starting on page 7–17
• Object Access Permissions, starting on page 7–20
In the SUA object, additional specific object access exceptions can be specified.
Note: All permission changes for the specific SUA and/or SUG do not take place
until the ORCAview is logged out and logged back in again.
Restricted Devices
Device restrictions exclude a user from a controller or range of controllers. Any
controller can be restricted, including V2 and third party controllers. If device
restrictions are set for a user, ORCAview does not display the restricted
controllers or objects. Restricting a controller does not affect its operation.
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Object Application Restrictions allow users to identify the objects that they are
responsible for. By setting up Object Application Restrictions, the administrator
can remove access to all objects that are outside of the user’s application area.
Note: Setting an Access Level to “Nothing” in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of “Nothing”, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to “Nothing”, the user will
not have any access to custom views.
An absolute permission is an entry, such as 100.AV1, which has all its parameters
defined. If wildcard entries are used, then the permission is not absolute.
Wildcard entries can be substituted for any of the 3 values above. The table below
describes the different acceptable entries.
There are two abbreviated instances where the absence of the controller, object or
instance will mean that an assumed wildcard is used. The table below outlines the
two acceptable entries.
SUA exceptions take precedence over the settings in the SUG object that is
specified in the Security Group field on the Object Overrides tab of the SUA. In
the following figure, the HVAC Group SUG is specified in the Security Group
field.
Entering Object Access Exceptions in the SUA object follows the same format as
entering Object Access Permissions in the SUG object.
Access Levels
In the Access Levels scheme, the permission levels are as follows:
Nothing (lowest level)
Display/Open
Command
Edit/Modify
Create/Copy
Delete (highest level)
Each object is restricted to a single access level. Any access levels lower than the
assigned level is automatically enabled for that object. For example, if
Edit/Modify is selected for an object, the Command and Display/Open levels are
automatically enabled. Likewise, if Delete is selected for an object, all permission
levels for that object are enabled.
Nothing The Nothing permission level prevents the user from viewing that
object type. The object is effectively invisible to the user.
If the user has Nothing Access to an object that is being displayed through a
graphical link in a site graphic drawing, the value and/or the link does not update.
If the user tries to use the right click menu, the open command is disabled (grayed
out). If the user tries to open the object through a button or any other method, it
results in an error dialog and the operation is cancelled.
Note: Setting an Access Level to nothing in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of Nothing, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to Nothing, the user will not
have any access to custom views.
Display/Open The Display/Open permission level allows the user to view the
value of the object in the Navigator window and to open the object for display
purposes.
In a site graphic drawing, object links update normally and the user can right click
to open the object.
Command The Command permission level allows the user to command the
value property of the specified object type. In addition, the user has Display/Open
permissions for this particular object type.
Commands available are Manual On, Manual Off, Manual Value, Auto,
Acknowledge, and Reset. The type of object and its current status determines
which of these commands are available.
If the user does not have Command permission for an object type, then all
methods of commanding the object are unavailable to that user.
Any modifications to the object using the dialog are considered Edit/Modify
operations. A user with Command level access cannot perform these operations.
An error dialog is displayed if the user attempts to modify any object properties
through the open dialog.
If the user has Command access, they can right click and command an object or
issue a command from a button within a site graphic drawing. If a command is
issued to an object type to which the user does not have Command level
permission, then an error dialog is displayed and the operation will be cancelled.
Edit/ Modify The Edit/ Modify permission level allows the user to edit all
properties within an object type. This permission level allows the user to make
any changes to the object type. Everything from changing the Name,
Manual/Auto, Units, Scale Range, etc. is allowed.
In a site graphic drawing, the user can edit the objects properties.
Create/Copy The Create/Copy permission level allows the user to create, load,
copy or save the object type for which the Create/Copy permission level is
enabled.
Delete The Delete permission allows a user to do all available functions for an
object type, including deleting. The Delete permission level is the highest
permission level available.
If Delete permission is not enabled for a user, the delete function is disabled
(grayed out) in all menus or toolbars. An error displays if the user tries to delete
that object by other means (such as the Delete key), and the operation is cancelled.
Note: By default, if no object permission level is set for a specific object and / or
object type, the permission level will be delete.
When you click on one of the Object Security commands, the following ORS
Login dialog appears:
To request that the controller enter a specific state, the OWS transmits a BACnet
Confirmed Private Transfer containing the requested state, user ID, and password.
The controller response to the BACnet Confirmed Private Transfer is either a
BACnet success or a BACnet error.
Unlock In the Unlock state, the controller allows all requests. The
rules defined in any ORS objects are ignored.
To enter the Unlock state, the request’s User ID and
Password must match the Master SUA specified in
ORS1.
Lock In the Lock state, the controller restricts access to the
controller based on the rules specified in ORS1 (instance
1).
To enter this state: The LOCK/Unlock SUA in the ORS
Setup tab in the ORS1 must be set to the Master SUA.
Also the Object Security field on the Setup tab of the
Master SUA object must be set to ORS1
Temporary Login In the Temporary Login state, the controller temporarily
enters the login state, where access is based on a
specified ORS other than ORS1. To enter into the
Temporary Login state, the controller must be in the Lock
state. This state remains for the amount of time specified
in the request. If the user selects Temporary Login, then
the request is sent to the device with a 20 minute
timeout.
The ORS that is used is based on the User ID in the
request. The User ID should match one of the SUA’s in
the controller’s database. The ORS used for the rules is
the one specified in the SUA object.
Temporary Login In lockdown mode, the controller is reasonably secure because
only the exposed points are accessible. The service technician must take the
device out of lockdown mode to change the controller’s Object Security rules.
This service technician feature allows tiered access to the controller’s objects, but
it has limitations since the packets are not encrypted and there is no protection
from spoofing or replay attacks. This feature supports up to five simultaneous
logins. A user remains logged in as long as the controller continues to receive
requests from the requestor device. Users are automatically logged out if they
remain inactive for the SUA Auto-Logoff period.
Network Security
ORCAview has security features for networks of BACnet controllers that use
remote PTP or UDP/IP connections.
The SUA object also needs to be associated with a SUG in the Security Group
field on the Object Overrides tab.
In order to communicate to the DCU in the example, the network objects in the
DCU will also need to be correctly set. However, since the second serial port is
defaulted to support a modem, the default settings should be sufficient. These
settings involve the BCP, SNS and sometimes the V2P objects:
BACnet Protocol Settings in the DCU Notice that the Baud Rate selected
in this dialog must match the baud rate that was selected when logging in. In this
example, 9600 baud (the default) was the rate chosen for both the OWS and DCU.
Also notice that the Tunnel checkbox is checked for the Serial Port Settings 2 line.
This is necessary in order to see Version 2 controllers which are on the same
network as this DCU.
If the Site requires Network security for remote Operator Workstations attempting
to log in, select the Remote OWS Connections Require SUA Password Check
option. This option will allow the controller to verify the SUA object (username
and password) of the incoming OWS against its own SUA settings as it attempts a
dialup connection. If the SUA parameters match, the OWS will be allowed to
connect to the controller. If the SUA parameters do not match, the connection will
be dropped and the OWS will be unable to communicate with the network.
One controller per network is appointed as the BBMD device and it is responsible
for connecting other off-site controllers into this network.
The Tunnel checkbox for the UDP/IP interface should be checked, as it allows the
off-site OWS to see Version 2 controllers which are on the same network as a
DCU. The Ethernet interface should stay enabled if you need to communicate to
other DCUs in the site by Ethernet but with the Tunnel option unchecked..
If the Site requires Network security for remote Operator Workstations attempting
to log in, select the Remote OWS Connections Require SUA Password Check
option. This option will allow the BBMD controller to verify the SUA object
(username and password) of the incoming OWS against its own SUA settings as it
attempts to connect over UDP/IP. If the SUA parameters match, the OWS is
allowed to connect to the BBMD device. If the SUA parameters do not match, the
connection will be dropped and the OWS will be unable to communicate with the
network.
On the remote ORCAview OWS, enter your Username and Password in the
Logon. UDP/IP should be selected in the Connect using drop-down box and the
Connect to remote network checkbox should be checked. This will allow you to
enter the IP Address that you set in the UNS object in the controller in the
previous steps.
Following the Login process, the network objects in the remote OWS are
automatically re-configured to reflect the desired UDP/IP WAN connection. The
objects affected are the BACnet Protocol Settings (BCP) object and the Version 2
Protocol Settings (V2P) object. The new settings that will be applied when you
login are shown in the following dialogs:
The Device Type is now set to Foreign, which allows ORCAview to participate in
the controller network that is at the remote site. The IP Address that was entered
during login is now entered as the BBMD Address. This is the IP Address of the
DCU on-site which is appointed as the BBMD for that network.
The Dial-Out SUA is the object that contains the Username/Password parameters
that the OWS is using to connect with the Remote BBMD Device. If the BBMD
device requires a remote Password check, it will verify the Username/Password
parameters of the SUA object selected from this field against its own SUA object.
If the SUA parameters match, the OWS will be allowed to connect to the BBMD
device. If the SUA parameters do not match, the connection will be dropped and
the OWS will be unable to communicate with the network.
The SUA object is evaluated, during a security check when logging in, before
providing system access to an operator, and then determines Access Levels for
both BACnet and System Objects. Version 2 object permissions are set in a
separate User Access (UA) object.
The User (via the SUA object) resides in both the OWS and the Security Panel.
When creating the SUA object, it is created in both the OWS and the specified
BACnet and Version 2 Security Panel. When editing the SUA object, the changes
are only applied to the particular SUA object in the location that it was opened
from. For example, if you edit the SUA name in the OWS, then you must also edit
the SUA in the Controller to match.
The SUA object for the enteliTOUCH (eTCH) has only three tabs: Description,
Setup, and User Data. The User Data tab has a number of fields that are specific to
the eTCH
Common Header
The SUA in the controller and OWS will have a Status field.
Status
The status of the SUA is read-only and not editable by the user.
Logged Out The Logged Out SUA status indicates that nobody is logged into
the system using this particular SUA. If someone is to log into the system using
this SUA, then the SUA Status must be initially be Logged Out.
Disabled A user with sufficient permissions to the SUA can set the User
Enabled field on the setup tab of the SUA to disable the SUA. When the SUA
Status is Disabled, nobody can log into the system using this SUA until it is
returned to the Logged Out state. The Status must be returned to the Logged Out
state by setting the User Enabled field on the setup tab of the SUA.
Security Locked When the number of Login Failures on the Login tab of the
SUA reaches the Login Maximum Failure setting, the SUA is locked, thereby
preventing anyone from logging in with this SUA. The Login Lockout on the
Login tab of the SUA is checked (True) and the SUA is set to Security Locked and
remains locked until any one of three conditions occurs:
Inactive If the current date and time within the BACnet Security Panel and/or
OWS is not within the Password Start Date and Password Expiry date specified in
the SUA, the SUA Status will be set to Inactive. The Password Auto Expire
checkbox must be enabled for the Inactive state to be valid. When the Status is
Inactive, nobody can log into the system with this SUA.
If the SUAs’ Status changes to Disable, Security Locked, or Inactive while the
SUA is Logged In, the SUA Status does not change until the SUA is Logged Off.
For example, if SUA1 is logged in, and the time and date within the BACnet
Security Panel is outside of the Password Start Date and Expiry Date, then the
SUA Status does not change until the SUA is logged off.
Last Logged In at
This field shows the last time and date the SUA Status was Logged In. In the PC it
shows the last time someone logged into the workstation. The time is taken from
the PC clock.
The SUA Status in the controller shows the last time that the SUA Status in the
controller was in the Logged in state. In this case, the time is taken from the
controller.
The SUA Status in the controller shows the last time that the SUA Status in the
controller was in the Logged Off state. In this case, the time is taken from the
controller.
Description
This tab contains the description field.
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
Name
Name is a character string that represents the Name of the user. It is compared
against the username typed in for login purposes. Both the Name and the
Password in the SUA object have to match the username and password entered in
the login dialog to successfully log into the system.
User Enabled
When this field is toggled to Disabled it will set the SUA Value to Disabled and
prevent anyone from logging into the system with this SUA. Toggling this field to
Enable will enable the SUA again and set the Status of the SUA to Logged Off.
When a new SUA is created, the User Enabled field is set to Enabled by default.
Security - Password
Password holds the password for the SUA. It is the character string that is used to
compare against the password provided by the operator. The Password is not
shown visually when the SUA is displayed. It is shown as a series of ‘*’ each
representing a character in the password. As characters are added to the password
or edited they also appear as ‘*’.
• Maximum 14 characters
• Forced to be Uppercase
• Only Version 2 acceptable characters are accepted. Do not use characters
such as ( \ /:*?"< >| ).
• Minimum 4 characters
These restrictions are in place to keep the SUA compatible with the Version 2
User Access object (UA).
The Password Auto Expire occurs if the current date and time within the Security
Panel is not within the Password Start Date and Password Expiry date. The SUA
Status will be set to Inactive. When Inactive, no one will be able to log into the
system with the Inactive SUA.
To get it out of Inactive, a user with sufficient permissions to the SUA, must set
the Password Start Date and/or Password Expiry Date so that the current date is
within these two values or turn the Password Auto Expire off. Once the user has
done this and applied the changes the SUA Status will be set to Logged Off.
The default value for the Password Auto Expire is unchecked (Off).
The Menu (MN) object basically allows the organization and formatting of
functions to be interfaced and displayed on the LCD Keypad.
Object Security
Provides a way to select an optional Object Security Restrictions (ORS) object
from a list.
operators for the HVAC and Access applications. It is possible for each operator
to only see the objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
User Data
This tab contains information about the user and some of the settings for the user
when using ORCAview.
Alarm Filter
This field is used to specify an Event Filter (EVF) object for this SUA. By default,
the Alarm Filter field is blank and Alarms Notifications are not filtered out for this
user. The user will receive Alarm Notification for all Event Classes.
If an Alarm Filter field has an Event Filter (EVF) object specified, then Alarms
Notifications are filtered. The user will not receive Alarm Notification for the
Event Classes listed in the EVF object.
For details on the Event Filter object, see Chapter 5 Event (Alarms) Management
System of the Technical Reference manual.
Disable Navigator
This field is used to disable Navigator for a user. The user would typically use a
site graphic to access the system. The Disable Navigator checkbox is unchecked
by default when an SUA is created. The default allows Navigator to display for a
user.
When this field is checked, the user must log out of ORCAview and then log back
in again for the change to take effect. When the user logs in, only the ORCAview
Dashboard (main toolbar) is visible. The user cannot see Navigator or any
controllers through Navigator. The ability to create multiple instances of
Navigator is disabled in the Tools menu.
Disable Illustrator
This field is used to disable the Illustrator drawing tool for a user. The Disable
Illustrator checkbox is unchecked by default when an SUA is created. The default
allows Illustrator to operate in either the Run or Edit mode..
When this field is checked on the user's SUA in the OWS, it is necessary to log
out of ORCAview and then log back in again for the change to take effect. When
the user logs in, the ORCAview Dashboard and Navigator window is visible but
the Illustrator options are unavailable. A site graphic drawing may be opened but
the Illustrator is only available in the Run mode and not in Edit mode.
Once checked, if an alarm goes off, the user does not see a pop-up alarm
notification. Alarm notifications can still be monitored from the Active Alarms
Folder. To disable alarm pop-ups, a checkmark must be placed in this field for the
SUA object on the local OWS only.
Once checked, the user does not see a pop-up window when a server message is
received. Typically these messages relate to network issues. To disable server
messages, a checkmark must be placed in this field for the SUA object on the
local OWS only.
Process ID
The field displays the numerical ID for the user. This ID is used as the Process ID
in alarm acknowledgements to identify the user that acknowledged the alarm. The
information is provided for use with 3rd party products that only allow the
acknowledgement of alarms by Process IDs that the alarm has been directed to. In
these cases, this value should be used in the Recipient List of the Event Class
object in the 3rd party device.
If eTCH Login Required is checked (enabled), this field defines the first graphic
to display on the eTCH touch screen after a particular user logs in if a Starting
graphic is not assigned to that user. If eTCH Login Required is unchecked
(disabled), this field defines the default start graphic for all users after the device
starts up. All graphics that are stored in the eTCH are listed in the dropdown box.
The order of the list is based on FIL object instance. (Site graphics are saved as
FIL objects on the eTCH device).
If eTCH Login Required is enabled (enabled), this graphic displays before the
user logs in or after the user logs out. All graphics that are stored in the eTCH are
listed in the dropdown box. The order of the list is based on FIL object instance.
(Site graphics are saved as FIL objects on the eTCH device).
Note: The Refresh Rate for Objects field is not currently used by eTCH. It is
reserved for future features.
Language
This indicates what language OWS will operate in for this User. This tells the
OWS what language to use in when this User logs in to the system. This property
is a list of the supported languages.
Note: This field is not currently used by eTCH. It is reserved for future features.
Starting Screen
The Starting Screen is the name of the graphic that is opened each time this user
starts ORCAview. ORCAview will look in the Default graphic path for the logged
in site specified in ORCAview Settings. A path must be supplied along with the
graphic name if the graphics are located somewhere other than the default
graphics path.
Full Name
This field is used to keep track of the user’s actual name.
It is a character string that has the same restrictions as the Description field.
E-mail Address
This field is used to enter the user’s email account if he/she has one, and may also
be used for event paging by the Event Router.
It is a character string that has the same restrictions as the Description field.
Phone Number
This field is used to save the user’s phone number and may also be used for event
paging by the Event Router. The Phone Number can be used for the TAP Gateway
(in the EVR).
It is a character string that has the same restrictions as the Description field.
Fax Number
The user’s fax number will be saved in this field.
It is a character string that has the same restrictions as the Description field.
Pager Number
This field is used to save the user's pager number and may also be used for event
paging by the Event Route.
It is a character string that has the same restrictions as the Description field.
Cellular Number
The user’s mobile phone number.
It is a character string that has the same restrictions as the Description field.
Login
This tab contains information and setup for logins and logouts.
Device This field shows the name of the last device (OWS) that logged in using
this SUA. This field is read-only.
Network Inactivity Time If ORCAview stops running and the Delta Server
continues to run, then the system may not let the user log in again. The system
thinks that the user is already logged in.
This field counts up to 5 minutes for network inactivity, checks to see if the user is
still logged in, the system then waits another 2 minutes and logs the user out.
ORCAview automatically pings each security panel every 5 minutes to ensure that
a connection exists. After the Network Inactivity Time Setting (7 minutes), the
user can log in again.
Network Inactivity Time Setting This is the time that the device will wait
for a response from the workstation before setting the SUA to Logged Out. The
field defaults to 7 minutes and cannot be changed. There is a 2 minute delay in
addition to the Network Inactivity Time default count time of 5 minutes, to ensure
that there is sufficient time to complete any network activity.
Failures This is the field where the consecutive failed login attempts are
displayed. A failed attempt is defined as the username and password that was
specified in the login dialog does not match an SUA in the OWS and/or the
controller.
Once a successful login has been established this will reset the Failures to 0.
Once the Failures is equal to the Maximum Failures then the SUA Status will be
set to Security Lockout for the specified Login Lockout Period.
Maximum Failures This field is used to specify how many consecutive failed
login attempts will be allowed before the SUA Status is set to Security Lockout.
Login Lockout
Date This field displays the time and date that this SUA was locked out due to
Failures becoming equal or greater than the Maximum Failures.
Lockout This field is used to unlock an SUA that is in the Security Lockout. If
this field is unchecked (Unlocked) the SUA will return to the Logged Out state. It
can also be used by a user with edit access to the SUA object to lockout an SUA,
by checking (Locking) this field.
Period This field is used to specify the period for which the SUA State will be
set to Security Lockout. The Period is specified in minutes and must be a whole
number.
If the Period is set to 0 then the SUA State will be set to Security Lockout
permanently. The only way to get an SUA out of this state when Period is set to 0
is for an SUA with Edit access to SUA objects to uncheck the Lockout field.
Auto-Logoff
Period The Auto-Log off period is the amount of time that ORCAview will sit idle
before automatically logging off of the network. You can disable this feature by setting
the period to 0. In order for any changes in this field to take effect, you must log out then
log back in to ORCAview. The default Auto-Logoff period is 10 minutes.
Object Overrides
This tab is used to define the Object Access Exceptions for the user. User specific
exceptions are set to the Access Levels for BACnet Standard and System Objects.
The settings here override the SUG settings for that object.
Security Group
The Security Group drop down box allows the user to be linked to a Security User
Group (SUG) object. Once linked, that SUA object inherits all the SUG
permissions.
The Objects field allows input for any BACnet Standard and System Objects.
The Access Level field has a drop down box that appears when you click in it.
The drop down displays six different Access Levels which are in top down order
from most restrictive to least restrictive.
When entering object restrictions based on the same object type, the most
restrictive entry will take precedence. The order in which the entries are created
does not affect the restrictive precedence with one exception.
The exception to the ordering of restrictions occurs when there are duplicate
entries in the table. With duplicate entries, the first (top) entry takes precedence.
Least restrictive
Most restrictive
What will happen in the example picture above is the first entry *. AV* will set all
AV (Analog Variable) objects on every controller including the local OWS to the
Nothing access level. Because the second entry 300.AV* is a more specific or
higher restrictive entry it will take precedence. So on panel 300, Analog Variable
15 will have Command access and any other AV objects on controller 300 or any
other controller will have Nothing access.
Note: Setting an Access Level to nothing in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of Nothing, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to Nothing, the user will not
have any access to custom views.
The SUG (Security User Group) object provides a means to define a group of
SUA users and then assign access rights to these SUAs as a group. The SUG
object makes it easier to set the security permissions for Version 3 BACnet
objects. Version 2 object permissions are set in a separate User Access (UA)
object.
The SUG object has the ability to set restrictions for a group of users in three
different ways:
• Restricted Device
• Object Application Restriction
• Object Access Permissions
Description Tab
This tab contains the Description and Name fields
Description Field
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller. It is recommended that each name be
unique within a BACnet network.
The order of precedence for the fields on the Object Security tab from highest to
lowest are:
Example:
To restrict devices ranging from a software address of 100 to 600, double click on
the dataview row under Device Range and enter:
DEV100 - DEV600
Note: Exceptions cannot be made for a restricted device. For example, if you
make controller 100 restricted, then you cannot make an exception for a specific
object in the SUA on that controller as Device Restrictions have the highest level
of precedence.
Object Application Restrictions have the second highest precedence after Device
Restrictions. Applications Restrictions, like Device Restrictions, cannot be
overridden by Object Permissions Exceptions on a SUA object.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Object Access Permissions have the lowest level of precedence. They can be
overridden by Object Permission Exceptions entered in a SUA object.
In the previous graphic, the following restriction are set in this SUG object:.
• Under Object Application Restrictions, the users cannot view any Access and
Lighting objects.
• The 100.AI1 object has command access,
• 100.AO2 has Edit/Modify access and
• The user has no access to Device 900
The user has full access to all HVAC objects or objects that have no application
restriction except 100.AI1 and 100.BO2. The user will have command access to
100.AI1 and Edit / Modify access to 100.AI1.
Note: Setting an Access Level to nothing in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of Nothing, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to Nothing, the user will not
have any access to custom views.
If you upgrade from 321, 322 to 330, 333, the 8 default SUG objects are not
created.
To use these objects on a BACnet Security Controller, they must be copied from
the OWS to the Security Controller. If no BACnet Security Controller is specified,
then the objects do not need to be copied and can be access directly on the OWS.
The eight default SUG's fall into three pre-configured categories; Administrator,
Programmer and Operator. Programmer and Operator are then broken down into 3
sub categories; HVAC, Access and Lighting.
The Administrator SUG will have full access to all controllers and their associated
objects.
The Programmer SUG objects are configured so that the appropriate access is
given to the objects that a Programmer would use. Also, because there are three
different programmer SUG objects, the Administrator can assign the user the
HVAC, Access, or Lighting permissions depending on the area of the BACnet
Network the Programmer is working on. This same approach is applied to the
Operator SUG objects.
The eight default configurations are there to provide the Administrator a starting
point when setting up BACnet Object Security. These objects can be modified to
better suit the application or can be deleted if not needed.
This object security feature works with enteliBUS controllers and DAC/DSC
controllers that have a 16 Mb Toshiba DSC image, or an 8 Mb Toshiba DAC
image.
The status of the ORS object is either Unlocked, Locked, or Temporary Login.
Unlocked In the Unlock state, the controller allows all requests. The rules
defined in any ORS objects are ignored.
Locked In the Lock state, the controller restricts access to the controller
based on the rules specified in ORS1.
Temporary The controller temporarily enters the login state where access is
Login based on a specific ORS, instead of ORS1. This state will remain for
the amount of time specified in the request which is preset to 20
minutes.
Theory of Operation
Object security is not a complete solution for all security concerns. It provides the
first-level of defense after physical security of the device has been achieved.
Additional layers of network security build upon this feature to create a secure
site.
For each BACnet network request, the controller passes the request through
several phases.
3 The first phase checks if Object Security is enabled by checking for Locked
or Unlocked status.
5 Once the ORS object is determined, the controller applies the rules in the
ORS Device Exceptions list.
6 Finally, if the network request deals with objects, the controller applies the
rules in the ORS Object Exceptions list. A typical net request is a Read or
Write for an object property.
When you click on one of the Object Security commands, the following ORS
Login dialog appears:
To request that the controller enter a specific state, the OWS transmits a BACnet
Confirmed Private Transfer containing the requested state, user ID, and password.
The controller response to the BACnet Confirmed Private Transfer is either a
BACnet success or a BACnet error.
See the Object Security in Navigator Using ORS Object section starting on page
7–25 of this chapter.
Unlock In the Unlock state, the controller allows all requests. The
rules defined in any ORS objects are ignored.
To enter the Unlock state, the request’s User ID and
Password must match the Master SUA specified in
ORS1.
Lock In the Lock state, the controller restricts access to the
controller based on the rules specified in ORS1 (instance
1).
To enter this state: a) the controller is reset, and the
database contains ORS1, or b) the requestor’s User ID
and Password must match the Master SUA specified in
ORS1
Temporary Login In the Temporary Login state, the controller temporarily
enters the login state, where access is based on a
specified ORS other than ORS1. This state remains for
the amount of time specified in the request. If the user
selects Temporary Login, then the request is sent to the
device with a 20 minute timeout.
The ORS that is used is based on the User ID in the
request. The User ID should match one of the SUA’s in
the controller’s database. The ORS used for the rules is
the one specified in the SUA object.
Temporary Login
In lockdown mode, the controller is reasonably secure because only the exposed
points are accessible. The service technician must take the device out of lockdown
mode to change the controller’s Object Security rules.
This service technician feature allows tiered access to the controller’s objects, but
it has limitations since the packets are not encrypted and there is no protection
from spoofing or replay attacks. This feature supports up to five simultaneous
logins. A user remains logged in as long as the controller continues to receive
requests from the requestor device. Users are automatically logged out if they
remain inactive for the SUA Auto-Logoff period.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters long. The length of a name is from 1 to 255 characters on a DCU or an
OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Lock/Unlock SUA
Specifies the SUA object that a requestor’s User ID and Password must match.
This field is only shown in the ORS1 object.
If the instance of ORS is 1 then the master SUA is specified. This master SUA is
the one used to lock and unlock the controller
If ORS instance is other than 1, then the specified SUA is used to login to the
controller. The Lock/Unlock SUA field is included only in the ORS1 dialog. To
employ an ORS instance other than 1, the ORS object needs to be specified in the
SUA dialog as shown below.
The following figure shows the Object Security field on the Setup tab of the
DELTA SUA.
Object Exceptions
The Object Exceptions tab provides a way to define restrictions or rules for an
object property within a specific range of instances of an object.
The Objects Column accepts an entry that contains the StartID, EndID,
PropertyID, and ArrayIndex parts of the Object Security List.
The following table explains the access permissions options for the specified
object (property) entry. Each option can be turned on independent of the others.
For example, it is possible to have Read enabled but with Visible disabled. For
such an entry, remote devices will have to know the object exists, as reading the
Object List will not show the object.
Access Function
Level
Read Reading of the specified object/properties is allowed.
Write Writing of the specified Object/Properties is allowed.
Create Creating objects in the specified range between StartId and EndId is
allowed.
Delete Deleting objects in the specified range between StartId and EndId is
allowed.
Visible Objects in the specified range between Start and EndId are visible by
reading the ObjectList.
When you hover the cursor over a Device Exceptions Permissions entry, a tooltip
displays with a list of enabled permissions. In some situations with multiple
permissions enabled, the tooltip may not be able to display all the permissions.
You can double click on a selected entry and the Edit submenu displays with the
selected options shown.
The following example shows how to correctly enter rules to get the intended
function. If you wish to allow full Permissions for AO1, and for AV2-4194303
but otherwise want all other objects to have only Read and Visible permissions,
enter the following rules:
A very important part of the security system is ensuring that the Site Settings (SS)
object for the site is set correctly. Without the Site Settings security set correctly,
you may not see the BACnet or Version 2 controllers on their respective networks.
With 3.30, the Site Settings object is now only on the ORCAview PC and is no
longer found on the DCU.
Advanced
The advanced tab is used to specify the Master and Security Panels on the
network. User logging can be set up here as well.
After the BACnet network security has been verified, ORCAview uses the SUA in
the BACnet Security Panel to obtain the BACnet object Permission levels. If a 0
has been specified for the BACnet Security Panel, then the SUA in ORCAview is
used to determine the BACnet object Permission levels. If the BACnet network
security fails when the Security Panel has a non-zero setting, then the BACnet
Protocol Network appears with only ORCAview in it. Any BACnet controllers
that are present will not appear in Navigator or be accessible in any way.
V2 Master Panel
If the V2 Master Panel is specified, ORCAview will automatically reload the
system objects such as Units and Scale Ranges from that panel each time that site
is logged into. If this field is set to a number other than zero, the system object
used by OWS will be loaded from the specified panel.
V2 Security Panel
The V2 Security Panel is used to set which controller the PC uses to verify the V2
Network security. It must be set to a valid controller number that is present in the
V2 network or 0 for your PC. If you are using a serial connection (direct or
modem) and the V2 Security Panel is set to anything other than 0, this setting is
overridden for the V2 network security and the physically attached controller is
used to verify the V2 network security.
After the V2 network security has been verified then the OWS will look at the UA
in the V2 Security Panel to obtain the V2 Object Permission levels. This field
does not accept an entry of 0.
The BACnet Security Panel is used to set the controller that the PC will look at to
verify the BACnet network security. It must be set to a valid controller number
that is present in the BACnet network or 0 for your PC. If you are using a serial
(direct or modem) connection and the BACnet Security Panel is set to anything
other than 0 this setting is overridden for the BACnet network security and the
physically attached controller is used to verify the BACnet network Security.
User Logging
The User Logging is used to record activities from users who are logged into the
system. These activities are recorded to a text file, UserLog.txt stored in their site
name directory. Hence, each individual site could have its own UserLog.txt file in
their site name folder.
For example, if a site had only Delta Version 2 protocol enabled, then BACnet
controllers would not be visible after login, regardless of whether the BACnet
Security Panel was set up correctly.
The possible advantages of using an existing network are numerous and include:
• Reduced installed cost (due to utilizing the existing cabling and
workstations).
• Ability to communicate to all controllers in all buildings that the network
reaches from a single workstation.
• Ability to have all alarms from all sites forwarded to a central monitoring
office.
• Possibility of viewing the controllers off-site using the Internet.
Internet The Internet is a WAN, but it is a public WAN that anyone with a PC
can connect to through an Internet Service Provider (ISP). An Intranet is privately
controlled and accessed and thus has security which the Internet cannot match.
TCP/IP and UDP/IP protocols Both the Internet and Intranets make use of
the TCP/IP protocol for communications. The products of Delta Controls
communicate by UDP/IP exclusively on Ethernet, UDP/IP has the capability of
travelling over many other types of physical networks. The ORCAweb product
does use TCP/IP on the webserver side.
Incidentally, if the products of Delta Controls are used on a single LAN which
does not have any Gateways or Routers, than TCP/IP communication is not truly
required.
A Firewall has rules that restrict where different types of network traffic are
allowed. The Firewall allows users on the Intranet to view web pages on the
World-Wide-Web, but blocks outside people from gaining access to the Intranet.
http://www.bacnet.org
Off-Site Internet Access Owners who wish to access their control system
off-site by using the Internet, would require the Firewall to be programmed to
allow connections to a controller on UDP port number 47808. Again, the
limitations of BACnet communication would prevent this controller from
gathering information from on-site servers, workstations, etc.
Remember that the owner’s IT staff are very familiar with the concepts of TCP/IP
networks and are a very good resource for further information about the network
concepts discussed in this short document.
Note: The ORCAweb product is a special case that does have some extra security
considerations for IT staff. One side of the ORCAweb connection is a webserver
which is communicating TCP/IP using its services and not the BACnet protocol.
Chapter 8 Contents
OVERVIEW ........................................................................................................... 8–2
INTRODUCTION .................................................................................................... 8–2
Other Modem Information in Technical Reference Manual ................. 8–3
MODEM CONFIGURATION 8–4
MODEM WITH A V3 DSC CONTROLLER FOR DIAL-IN........................................... 8–4
MODEM WITH A V3 DCU CONTROLLER FOR DIAL-IN .......................................... 8–6
ORCAview Settings for V3 Remote Panel Dial-Up ............................... 8–9
DIAL OUT AN ALARM NOTIFICATION TO A PAGER ............................................. 8–10
DCU/DSC DIAL-OUT TO AN OWS .................................................................... 8–10
ADDITIONAL MODEM INFORMATION 8–12
USR MODEM CONFIGURATION REQUIREMENTS FOR DELTA V2 PANELS .......... 8–12
Description .......................................................................................... 8–12
Configuration ...................................................................................... 8–12
USR MODEM CONFIGURATION AT COMMAND REFERENCE .............................. 8–14
CABLING 8–17
HOW TO MAKE A SERIAL CABLE ....................................................................... 8–17
DIRECT SERIAL CABLE CONNECTIONS ............................................................... 8–17
Direct: Delta System Controllers and Intelli-Sys Products ................ 8–18
Direct: DCU-050, DSM-050, DSC-1616EX Products ........................ 8–19
Direct: Application Controllers (DAC25x, DSC-T305/ TO) ............... 8–21
MODEM CABLE CONNECTIONS .......................................................................... 8–22
Modems: Delta System Controllers and Intelli-Sys Products ............. 8–22
Modems: DCU-050, DSM-050, DSC-1616EX Products..................... 8–24
Modems: Application Controllers (DAC-25x, DSC-T305/ TO) .......... 8–26
INSTALLING AND CONFIGURING PRINTERS 8–28
INSTALLING A DOT MATRIX PRINTER DRIVER FOR ORCAVIEW ........................ 8–28
PRINTER CONFIGURATION FOR A V3 DCU ......................................................... 8–32
Overview
Point to point RS-232 communication is available for the DCU-050, DSM-050
and Delta Systems Controllers (DSC’s). The connection may be direct PC to
Panel or via Modem. The DCU, DSM, and DSC controllers support modems. In
ORCAview, the DSC-1616, DSC-1212, DSC-1280, DSC-T305 / T0, and ASM-24
now support serial communication.
This chapter contains configuration information for typical uses with modems and
printers.
• US Robotics (USR) Modems connected to a V3 DSC for Dial-In
• US Robotics (USR) Modems connected to a V3 DCU For Dial-In
• OWS settings for Dialing Up a V3 remote panel
• DCU/DSC Dial-out to an OWS
• USR Modems connected to a V2 controller
• Direct Serial Cable Connections
• Modem Cable Connections
• Installing a Dot Matrix Printer Driver for ORCAview
• Printer Configuration for a V3 DCU
• USR Modem Configuration for Delta Panels AT Command Reference
Introduction
With ORCAview 3.30 or later, the Windows modem that comes with your PC or
Laptop can be used for the PC/OWS modem. ORCAview 3.30 now supports many
more brands of modems in comparison to previous versions of ORCAview. You no
longer need to use a terminal program to set the modem string.
The US Robotics external 56 K modems and earlier models 14.4K, 28.8K, 33.6K
are the only ones supported by Delta Controls for use as a panel modem on a
controller. (Most Windows compatible modem can be used for the PC/OWS
modem.) The compatible US Robotics modem models have DIP switches and
operate under the AT compatible command set.
Other modems with the AT compatible command set could be used with a
controller. However, this is not recommended. Modems using the AT command set
may still differ from the US Robotics modem, and are therefore not supported by
Delta Controls.
Your USR modem will probably have a Read Me First document, and a printed
manual and extensive documentation (including troubleshooting) on the USR CD-
ROM. The USR website http://www.usr.com/support contains documents that
include troubleshooting information.
The serial cabling information that was formerly in Appendix C – Wiring is now
contained in this chapter.
The Delta Controls Wiring and Installation Guidelines, Rev. 1.0 contains wiring
practices and guidelines for Power, I/O, RS485, Ethernet and RS232 in one
document.
MODEM CONFIGURATION
The section includes information on the following:
• US Robotics (USR) Modems connected to a V3 DSC starting on this page.
• US Robotics (USR) Modems connected to a V3 DCU starting on page 8–6.
• USR Modems connected to V2 controllers starting on page 8–12.
2. If the USR modem has dip switches, then before the modem is turned on, set
the DIP Switches to match the following Table:
In most cases the direction of the DIP switches is down for ON and up for OFF.
Note: With the default USR settings, DIP 5 is DOWN but Delta Controls uses UP
for DIP 5.0
4. Reset the controller to program the modem for use with the controller.
In most cases the direction of the DIP switches is down for ON and up for OFF.
Note: With the default USR settings, DIP 5 is DOWN but Delta Controls uses UP
for DIP 5.0
1. Open the BACnet Protocol Settings object on the DCU with the modem
connected.
2. Ensure that the Serial Port Settings is enabled for the COM Port that you are
using on the DCU.
3. Select the Baud Rate by selecting the Serial Port Settings line, and editing the
Baud Rate in the information that appears below. The example shown below
is for a 9600 baud connection using COM2 on the DCU.
With a clear or default database in the DCU, this object only needs to be changed
if you require a higher baud rate. If the baud rate is changed then the controller
must be reset either through hardware or software.
1. In the MDS Object select your modem from the drop down list in the
Initialization field or chose Custom to enter a user defined Modem
initialization string. In most cases, you will be selecting US Robotics as the
modem type.
1. Open the Serial Port Settings (SNS) object for the COM Port you have the
modem attached to. SNS1 refers to COM1 and SNS2 refers to COM2 on the
DCU.
2. In the Modem Reference field, check that the MDS object is selected. By
default, the Modem Reference field references the MDS1 object. The system
automatically creates MDS1.
3. At this point the modem should be connected to the DCU, and the DCU reset,
so that all of the changes will take effect.
1. Start up ORCAview.
2. Enter the proper Username and Password.
3. Click on the Advanced option. If there is no Advanced button present, login
once and then logout again.
4. Select Serial (BACnet PTP) in the Connect using drop down box.
5. Select Modem Dial-Out in the Connect type drop down box.
6. Select the Modem you wish to use from the drop down box of available
modems.
7. Select the Speed, which is the BAUD Rate that you set the DCU/DSC to.
8. Type in the Phone Number in the field provided.
9. Click the OK button. You should connect to the remote site in a short time. It
is possible that a remote panel dialog will display and ask for a controller
number. The connection may fail the first time and work fine on the second
try.
When you are finished and wish to disconnect, just Log Off from ORCAview and
the modem will hang up.
In most situations you would dial into a DSC controller rather than have it
dial-out. See Modem with a DSC Controller for Dial-in on page 8–4.
For dial-out from a DSC controller, the NET1 and RPS objects must be
configured. Unlike the DCU controller, a DSC/ DAC controller does not have an
MDS object.
Configure RPS
1. On the Main tab, enter the phone number and select the SUA to match that of
the OWS that will be dialed.
2. On the Setup tab, set the Baud rate to match that of the OWS that will be
dialed. The default Baud Rate is 9600.
3. Enter the Panel Number and Network Number. The Network Number is on
the BCP object of the OWS that the Alarm Notification will be dialing into.
4. Reset the controller for the changes to take effect.
Description
This document will cover the setup of a US Robotics (USR) modem for use with a
Delta V2 Panel. The modems covered in this section will be: US Robotics
Sportster 14.4, 28.8, 33.6, and 56 Kbps modems. The user of this document
should read the US Robotics manual prior to installation.
The procedure will refer to NVRAM, this acronym stands for Non-Volatile
Random Access Memory.
Configuration
2. If the USR modem has dip switches, then before the modem is turned on, set
the DIP Switches to match the following Table:
Note: You may not see the command being typed on the screen depending on the
current modem settings. The E0 parameter turns the local echo off and any
keystrokes you enter do not display on the screen. To turn on the Echo, type ATE1
and press ENTER. You need to reset the panel or power it Off and then On for the
changes to take effect.
Note: The E0 parameter turns the local echo off and any keystrokes you enter do
not display on the screen. To turn on the Echo, type ATE1 and press ENTER.
Note: You may not see the command being typed on the screen depending on the
current modem settings. The E0 parameter turns the local echo off and any
keystrokes you enter do not display on the screen. To turn on the Echo, type ATE1
and press ENTER. You need to reset the controller or power it Off and then On
for the changes to take effect.
5. Enter the command ATI4 to display the current modem settings. Compare
these settings against the settings listed in Table 8-5 Modem Settings.
CABLING
You can make your own cable but many partners find it more economical to
purchase the required cables. The Delta Controls Wiring and Installation
Guidelines, Rev. 1.0 contains wiring practices and guidelines for Power, I/O,
RS485, Ethernet and RS232 in one document.
Requirements To make a serial cable for the DCU the following materials are
required:
• one 22 AWG shielded cable (Maximum of 50 ft or 15.2 m) with at least the
number of conductors required in the particular wiring diagram.
• one D connector, either a DB9 or DB25 (male or female) – Select your
RS-232 female D connector type based upon the pin-out of the PC Com port
used for the serial connection. If you are making a modem cable, you must
use the male DB25 connector.
The following figure shows a direct connection from a DSC controller to a female
DB9 connector from a solder side view.
24~
1
POWER
GND
2
-
1
NET2
+
2
(2)
6
TX
5
(5)
7
GND
4
3
8
(3)
RX
4
3
DTR
2
DCD
1
SERVICE PORT
GND
DCD
DTR
CTS
RTS
RX
TX
1 2 3 4 5 6 7
1
2
3
4
5
6
7
Pin Label on Description Direct DB9 PC
Controller to Panel
(1) DTR* Data terminal ready 4 Not Required
(N/R)
(2) CTS* Clear to Send. 8 N/R
(3) DCD* Carrier Detect 1 N/R
(4) RTS* Data terminal ready 7 N/R
(5) RX Receive 2
(6) GND Signal Ground 5
(7) TX Transmit 3
*
Only required for modem cables
The following figure shows a Direct connection from COM1 on a DCU controller
to a female DB9 connector.
USER
SCAN
(solder side view)
CPU
TX
1
6
2
7
3
8
4
POWER
5
COM1
(2)
7
(5)
6
(3)
5
4
3
2
1
Component COM2
Side of DCU
7
6
5
4
Only connect a modem to
3
COM2 of a DCU
2
1
RS485
- +
2
1
LONWORKS
B
2
A
GND
1
5
(2)
DCD 6
4
2
RX (3)
7 8
3
D 3
TXD
2
4 5
DTR (5)
9
1
The following figure shows a direct connection from a Room Controller (back
view) to a female DB9 connector from a solder side view.
Room Controller
(Back View)
(2)
1
6
(5)
2
7
3
8
(3)
4
9
5
DTR TXD RXD DCD GND GND IP1
This section describes the connections required for modem communications with
the products of Delta Controls.
TX
1 2 3 4 5
1
2
3
4
5
The following figure shows a modem connection to a female DB25 connector from a solder side view.
24~
1
POWER
GND
2
1
14 15 16 17 18 19 20 21 22 23 24 25
2
-
1
NET2
3
+
2
4
(2)
TX 5
5
(7)
6
GND
4
(3)
RX
3
DTR
(20)
9 10 11 12 13
2
DCD (8)
1
SERVICE PORT
GND
DCD
DTR
CTS
RTS
RX
TX
1 2 3 4 5 6 7
1
2
3
4
5
6
7
Pin Label on Description Direct DB25 PC
Controller to Panel
(1) DTR* Data terminal ready 20
(2) CTS* Clear to Send. 5
(3) DCD* Carrier Detect 8
(4) RTS* Ready to Send. 4
(5) RX Receive 3
(6) GND Signal Ground 7
(7) TX Transmit 2
*
Only required for modem cables
The following figure shows a DCU controller with a modem connection from
COM2 to a female DB25 connector..
24 VAC
USER
SCAN
CPU
TX
POWER
COM1
7
6
5
4
3
2
1
Component COM2
Side of DCU (2)
7
(7)
1
14 15 16 17 18 19 20 21 22 23 24 25
6
(3)
2
5
(4)
3
4
4
Only connect a modem to (8)
5
COM2 of a DCU (5)
6
(20)
1
7
8
RS485
9 10 11 12 13
- +
2
1
LONWORKS
The RS232 port of the Room Controller uses a MTA-156 5 Pin Connector.
5
4
3
2
1
The following figure shows a modem connection from a Room Controller (back
view) to a female DB25 connector from a solder side view.
Room Controller
(Back View)
(2)
1
14 15 16 17 18 19 20 21 22 23 24 25
(3)
2
3
4
5
(7)
6
7
DTR TXD RXD DCD GND GND IP1
8
9 10 11 12 13
(8)
(20)
OP5 COM IP4 GND IP3 GND IP2 GND
Many sites use a dot matrix printer to log Alarm Notifications from an
ORCAview OWS. A dot matrix printer is rugged, and also inexpensive to
purchase and operate. The print driver Generic / Text Only needs to be installed
and configured to print using a dot matrix printer.
8. Click finish to complete the installation and to print a test page. After the
printer is installed, it must be properly configured.
9. Right click on the Generic / Text Only Icon in the printer window. Select
properties. The following window displays.
11. Select Std Fanfo as the paper size and Continuous – No Page Break as the
Paper Source. Click OK to complete the configuration of the printer.
Dot matrix printer are the only printers supported for direct connection to a DCU.
The Raven PR-2417 and Panasonic KX-P1128 dot matrix printers have been
tested. Most other ASCII printers will print each alarm on a separate page.
See the Printing Alarm Notifications to a Printer on the DCU section of Chapter 5
Event Management System for more information.
For ink jet printers, only the Canon BJ80 was tested and found to be fully
compatible.
Note: Delta Controls does not support bubble jet printers for direct connection to
a DCU. Other bubble jet printers, such as the Canon BJ 210, do not work
properly.
Chapter 9 Contents
CONTROLLER NETWORKS IN ORCAVIEW ........................................... 9–4
CONTENTS - CONTROLLER NETWORKS IN ORCAVIEW ........................... 9–4
OVERVIEW ........................................................................................................... 9–4
INTRODUCTION AND DEFINITIONS ........................................................................ 9–5
ETHERNET AND TCP/IP ............................................................................... 9–9
CONTENTS - ETHERNET AND TCP/IP .......................................................... 9–9
ETHERNET OVERVIEW ....................................................................................... 9–10
DCU / DSC CONTROLLERS AND ETHERNET ...................................................... 9–11
ADVANCED BACNET/IP NETWORK CONFIGURATIONS (SECONDARY UDP/IP
ADAPTER) .......................................................................................................... 9–15
BBMD AND BBMD ........................................................................................... 9–15
BACNET/IP NETWORKS USING NAT ................................................................. 9–18
CONNECTING BACNET SYSTEMS .......................................................... 9–22
CONTENTS - CONNECTING BACNET SYSTEMS ................................................... 9–22
OVERVIEW ......................................................................................................... 9–22
INSTRUCTIONS THAT PERTAIN TO ALL BACNET NETWORK TYPES .................... 9–22
DATA EXCHANGE ....................................................................................... 9–26
CONTENTS - DATA EXCHANGE........................................................................... 9–26
DATA EXCHANGE OVERVIEW ............................................................................ 9–26
READING VALUES .............................................................................................. 9–27
WRITING VALUES .............................................................................................. 9–32
OTHER CONSIDERATIONS ................................................................................... 9–36
IP PACKET FILTERING .............................................................................. 9–39
TABLE OF CONTENTS ......................................................................................... 9–39
INTRODUCTION .................................................................................................. 9–40
ENABLING IP PACKET FILTERING ...................................................................... 9–41
BLOCK ETHERNET BROADCASTS FROM DELTA DEVICES ................................... 9–42
DISABLE ROUTING BETWEEN UDP/IP ADAPTERS ............................................. 9–43
DISABLE IP REGULAR SUPPORT ......................................................................... 9–44
DISABLE ROUTING GLOBAL BROADCASTS......................................................... 9–45
DISABLE FOREIGN TO FOREIGN COMMUNICATION ............................................. 9–46
DISABLE ROUTING BETWEEN ETHERNET AND UDP/IP ...................................... 9–46
DISABLE ROUTING DE BROADCASTS TO UDP/IP .............................................. 9–47
BLOCK ROUTED PACKETS FROM ETHERNET ...................................................... 9–48
IGNORE I-AM-ROUTER FROM ETHERNET ........................................................... 9–49
DISABLE ROUTING GLOBAL BROADCAST WHO-IS-ALL ..................................... 9–50
TYPICAL IP PACKET FILTERING SETTINGS ......................................................... 9–51
OBJECTS USED IN NETWORKING .......................................................... 9–54
CONTENTS - OBJECTS USED IN NETWORKING .................................................... 9–54
BACNET BROADCAST MANAGEMENT DEVICE LIST (BMD) .......... 9–59
ADDRESSING ...................................................................................................... 9–59
IP FILTER........................................................................................................... 9–60
DESCRIPTION ..................................................................................................... 9–64
BULK DATA EXCHANGE (BDE) [NEW 3.40] [COPY] ........................... 9–65
EXAMPLE: ACCESSING BDE DATA USING FORALL AND READ ..................... 9–66
DESCRIPTION ..................................................................................................... 9–67
SETUP ................................................................................................................ 9–68
TRANSMIT ENTRIES ........................................................................................... 9–70
RECEIVE ENTRIES .............................................................................................. 9–73
DESTINATIONS TAB ........................................................................................... 9–75
STATUS .............................................................................................................. 9–76
DATA EXCHANGE LOCAL (DEL) ............................................................ 9–78
HEADER (DEL) ................................................................................................. 9–78
FIELDS (DEL) .................................................................................................... 9–79
DATA EXCHANGE REMOTE (DER) ........................................................ 9–81
HEADER (DER) ................................................................................................. 9–81
FIELDS (DER).................................................................................................... 9–82
DATA EXCHANGE SETTINGS (DES) ....................................................... 9–85
SETUP ................................................................................................................ 9–86
BROADCASTING ................................................................................................. 9–87
POLL .................................................................................................................. 9–89
SUBSCRIPTION ................................................................................................... 9–90
DESCRIPTION ..................................................................................................... 9–91
BACNET PROTOCOL SETTINGS (BCP) [COPY]................................... 9–92
DESCRIPTION ..................................................................................................... 9–92
SETUP ................................................................................................................ 9–93
ADVANCED ........................................................................................................ 9–99
PROTOCOL ....................................................................................................... 9–100
STATS .............................................................................................................. 9–101
MS/TP SLAVES ............................................................................................... 9–102
NETWORK PROTOCOL SETTINGS (NET) [COPY] ............................ 9–105
HEADER ........................................................................................................... 9–105
DESCRIPTION ................................................................................................... 9–105
SETUP .............................................................................................................. 9–106
ADVANCED ...................................................................................................... 9–122
MS/TP SLAVES ............................................................................................... 9–124
INTERNET PROTOCOL SETTINGS (IPS) [NEW 3.40] [COPY] ......... 9–127
DESCRIPTION ................................................................................................... 9–128
IP..................................................................................................................... 9–129
EMAIL.............................................................................................................. 9–133
SNTP .............................................................................................................. 9–135
ROUTING TABLE AND DEVICE TABLE (DRT) .................................. 9–140
DEVICES .......................................................................................................... 9–140
ROUTING ......................................................................................................... 9–141
DESCRIPTION ................................................................................................... 9–142
VERSION 2 PROTOCOL SETTINGS (V2P)............................................ 9–143
SETUP .............................................................................................................. 9–143
You can access context sensitive help for each object dialog by pressing F1 with a
field selected or the ? Help button in the lower right corner of the dialog.
Overview
This overview section covers the following:
• Introduction and Definitions.
Describes new networking options, routing, protocol, tunneling, routing
capability, and default settings.
Networking Options
In Version 2, networking of controllers was relatively easy and straight-forward.
Turbos and DCUs were largely connected by IntelliNet, Delta's proprietary
network. The Plus panel, and more recently, the DCU controller have brought
Ethernet communications. The Version 3 Delta Controllers have many new
networking options.
Routing
Controllers can be equipped with more than one network interface. Routing is the
capability of receiving data from one controller on one interface, and re-
transmitting that data on a second interface. An example would be a DCU which
has MS/TP and an Ethernet PC/104 card (DXC052-4/5).
A V3 DCU controller that acts as a router must have an address lower than 32767
if there are V2 devices on the network.
Protocol
Protocols specify how the data that travels from one controller to another is
formatted. Protocols are largely independent of the actual network connection
type (Ethernet, IntelliNet, etc.).
From the tables, it can be seen that Serial and UDP/IP links are only capable of
supporting one protocol at a time. This is a problem because it means that an
OWS which is connected by a BACnet serial link would only be able to see
BACnet controllers in the network. Any Version 2 controllers on-site would be
effectively invisible. In order to deal with this drawback, a networking trick called
tunneling was implemented.
Tunneling
Tunneling is a procedure where a packet of one protocol is embedded inside a
packet of another protocol. In Delta's implementation of tunneling, a Version 2
packet can be embedded in a BACnet packet. Doing this allows a Version 2
transmission to travel along a link which only supports BACnet.
Routing Capability
The previous definitions for routing and protocol lead to the following table,
which describes what the Version 3 DCU or DAC controllers are capable of
routing.
Default Settings
The default settings are set to allow for the maximum number of installations to
work "out of the box". However, there will be instances where manual
configuration of a device is required in order to obtain the desired network
configuration.
The following table gives the defaults for each of the available controller network
interfaces, and what this will allow.
Caution
Information in this section is, by itself, insufficient to plan a network installation.
We highly recommend that installation personnel are trained and experienced in
network installations.
Ethernet Overview
This section covers the following information:
• Basics
Standards, Cabling and Communication Devices
• DCU and DSC Controllers and Ethernet
IP Addresses, Subnet Masks, IP Routers, and Nomenclature
Basics
Standards The IEEE (Institute of Electrical and Electronics Engineering) has a
standard for Ethernet LANs (Local Area Networks).
The Delta Controls V3 DCU and DSC controllers communicate on Ethernet IEEE
802.3 by either the IEEE 802.2 (Ethernet II) or DARPA UDP/IP protocols.
Cabling The two types of cabling supported by the DCU are Thin net
(10Base2) and UTP (10BaseT). DSC controllers only have 10BaseT. Each type of
cable has particular specifications that affect the installation of Ethernet.
IP Router A device that connects two or more networks which are using the same UDP/IP
protocol together. It takes data from one network and routes that data the
appropriate other network. Routing decisions are based upon the
destination packet address. These are mainly used on IP links.
A V3 DCU controller that acts as a router must have an address lower
than 32767 if there are V2 devices on the network.
Hub A device used in mainly UTP (10BaseT) networks that are arranged in a Delta 802.2 and
star-topology. It contains multiple ports to allow many cable runs from UDP/IP
each individual device to the hub. Networks using Thin net (10Base2) do
not require hubs.
Gateway A device which forms a logical connection between networks which are UDP/IP
using different protocols. Like a Bridge, Gateways are usually a rather
complex device.
Transceive A device used to translate one type of physical network to another. For Delta 802.2 and
r example, a transceiver can be used to connect a Thin net (BNC UDP/IP
connector) to a Fiber Optic (10BaseF) or UTP (10BaseT) medium.
Thin net (10 Base2) is used in conjunction with the following hardware:
• RG58U Coaxial cable
• BNC Tees
• BNC 50 ohm terminating resistors
Each DCU must have a Tee connected to the BNC port on the DCU. The Tee
provides two BNC ports which are then used to connect the cable from DCU to
DCU. Both ends of the network must be terminated with terminating resistors.
This is similar to the way IntelliNet has been wired.
IP Addresses
An IP address is a four-part address which is used to identify a particular
computer, DCU or other device in a network. Each part of an IP address can range
from 1 to 254. Although the actual range provided by a single byte is 0 to 255,
both 0 and 255 have special meanings, and therefore cannot be used. The address
format is usually written with the four numeric fields separated by dots, as
follows:
192.168.1.10
Three different address "classes" have been created, which are called Class A,
Class B and Class C. At this point, it is enough to know that addresses which
begin with a number in the range of 1 to 126 are considered Class A, with
numbers in the range of 128 to 191 being Class B and numbers in the range of 192
to 223 being Class C. Thus the complete address shown in the previous figure
would be considered Class C. Addresses which begin with 127 or 224 - 254 are
reserved for special purposes. It is important to note that these IP addresses cannot
simply be "made up". If connecting to an existing LAN or WAN, these IP
addresses will be provided by the site network administrator.
Subnet Masks
A subnet mask uses the same four-part format as an IP address and is written
using the same dot format. Subnet masks are used to separate the network that the
device is connected to from the device itself. Each device has a subnet mask
associated with it. This allows the device to know what other devices are its peers
(on the same network), and which devices are reachable only by IP Router.
Typically, a subnet mask has only one of two numbers in each of its four
positions. These are 0 and 255. This is why these two numbers cannot be used to
specify an actual IP address. A very common subnet mask is the following:
255.255.255.0
This particular subnet mask specifies that devices which have the identical first
three numbers in their IP address belong to the same network. For example:
This means that these two devices can communicate without the need for an IP
Router. However:
Therefore for these two devices to communicate, at least one IP Router will be
required.
From this, it is clear that if the subnet mask is 255.255.255.0, only 254 devices
can be connected on the same network. Remember, 0 and 255 cannot be used in
an IP address. For some networks this is insufficient, so three different classes of
IP address were created which each have their own subnet mask. These are
summarized in the following table:
From this we can see that the example subnet mask given in the previous figure is
the subnet mask of a Class C network. Notice how although only 254 devices are
possible on a single Class C network, over 16 million different networks are
possible. Each class of network trades one for the other. One way to identify the
class of address from its IP address is the value found in the first of the four fields.
Class A addresses are in the range of 1 to 126. Class B addresses are in the range
of 128 to 191. Class C addresses are in the range of 192 to 223. IP addresses
beginning with 127 or 224 through to 254 are reserved for special purposes.
For example, given a subnet mask of 255.255.0.0 (Class B), a device with the IP
address of 137.162.10.12 is on the same network as another device with the IP
address of 137.162.33.55.
When trying to communicate with a device that is outside the local subnet, an IP
Router must be used.
IP Routers
An IP router has the job of sending network traffic from one network (subnet 1) to
another network (subnet 2). A V3 DCU controller that acts as a router must have
an address lower than 32767 if there are V2 devices on the network. An IP Router
uses the subnet mask of a packet to determine if it should forward it to the remote
network or not. If the destination address of the packet is not in the local subnet,
then the IP Router will send the packet to the remote network.
However, for this to work, the local devices must be given the IP address of the IP
Router. This IP address in the device is typically labeled 'Router address' or
'Gateway address'.
The procedure for a packet to be sent from a local device to a remote device
through an IP Router is as follows:
1. The local device determines from the subnet mask that it cannot reach the
remote device directly.
3. The IP Router receives the packet and then re-sends it to the remote network.
IP Routers are commonly used in Wide Area Networks (WANs) to join the
individual networks (LANs) at each site to each other.
Terminology
Term Definition / Description
10Base2 Thin net Ethernet cabling at 10 Megabits per second.
10BaseT UTP category 5 cabling at 10 Megabits per second.
10BaseF Fiber Optic cabling at 10 Megabits per second.
BNC connector A connector with a half-twist locking shell typically used for thin coaxial
cable.
BNC Tees A "T" shaped connector used with BNC connector ends on coaxial cable.
Bridge A device for linking one network to another. Able to handle most protocol
types.
Communication Repeaters, bridges, routers, and gateways that assist communication on a
Devices network.
Ethernet A type of network defined by IEEE 802.3. Developed by Xerox.
Gateway A device for linking one network to another. Usually translates from one
protocol to another.
Hub A device used in 10BaseT networks for joining the cable segments from
each connected device.
IEEE 802.3 Standard of the Institute of Electronic and Electrical Engineers that defines
Ethernet networks.
IP Address A unique, four part address given to each device in a TCP/IP network.
LAN Local Area Network.
Router A device for linking one TCP/IP network to another TCP/IP network. A V3
DCU controller that acts as a router must have an address lower than
32767 if there are V2 devices on the network.
Subnet Mask A four part address used to distinguish the TCP/IP network from the actual
TCP/IP devices.
Terminator A BNC connected resistor used to properly end a thin net cable segment.
WAN Wide Area Network.
Combined Networks
A typical application for combining networks is if you have multiple IP segments
behind a NAT device, each with BACnet/IP devices. For more information, refer
to BACnet/IP Networks Using NAT (Multiple IP Segments Behind NAT).
Isolated Networks
A typical application for isolating networks is to communicate with other BBMD
devices and allow a service technician to log in but only be able to see devices on
the local site. This setup is similar to the above CSMS application, but uses a
BBMD connection rather than a foreign connection. This setup should only be
used if the site has a static IP address.
Note: This application is only for improving speed (by limiting the service
technician’s network traffic), and not for security reasons, since the service
technician could disable the IP filter.
Typical Applications
This section lists settings for typical BACnet/IP Router applications. It is only
intended as a guide, as specific applications vary.
Master BBMD
Description
The Master BBMD routes network traffic between remote BACnet/IP devices and the
local Ethernet network segment. The Master BBMD contains a list of the IP addresses
for each remote BACnet/IP device (in the BMD object).
A Master BBMD typically communicates on only one BACnet/IP network. Therefore, UDP/IP-1 is
enabled and UDP/IP-2 is disabled.
Settings
NET Object:
Ethernet: Enabled
UDP/IP-1: Enabled (Device Type = BBMD)
UDP/IP-2: Disabled
BMD Object (IP Filtering Options):
Block Ethernet broadcasts from Delta devices
Disable IP Regular support on UDP/IP-1
Disable Foreign-to-Foreign communication on UDP/IP-1
Remote BBMD
Description
The remote BBMD connects an entire BACnet site to the BACnet/IP network by
communicating directly with the Master BBMD. The remote BBMD contains only the
IP address of the Master BBMD (in the BMD object).
For this example, the remote BBMD communicates on two separate BACnet/IP networks; one that
communicates to the Master BBMD, and another that allows service technicians to log in. The remote
BBMD is setup to be a BBMD on both BACnet/IP networks.
Settings
NET Object:
Ethernet: Enabled
UDP/IP-1: Enabled (Device Type = BBMD; to connect to Master BBMD)
UDP/IP-2: Enabled (Device Type = BBMD; to allow service technicians to log in)
BMD Object (IP Filtering Options):
Disable communication between UDP/IP-1 and UDP/IP-2
Disable IP Regular support on UDP/IP-1
Disable IP Regular support on UDP/IP-2
Settings
NET Object:
Ethernet: Enabled
UDP/IP-1: Enabled (Device Type = Foreign; to connect to Master BBMD) UDP/IP-2: Enabled
(Device Type = BBMD; to allow service technicians to log in)
BMD Object (IP Filtering Options):
Disable communication between UDP/IP-1 and UDP/IP-2
Disable IP Regular support on UDP/IP-2
Note: The NAT device must be setup to forward data (on the port being used for
BACnet; default is 47808) to a BBMD device behind the NAT device. This can be
done by the network administrator.
This BBMD device will communicate to other BBMD devices external to the
NAT device using UDP/IP and route that network traffic to the Ethernet
controllers on the local network side of the NAT device and vice versa. This is
done by enabling both Ethernet and UDP/IP in the BBMD device.
The following diagram illustrates this setup. The “B/IP Device” represents a
Foreign or BBMD device (either OWS or controller) that is communicating to the
local network from a network that is external to the NAT device.
"external" network
Ethernet/IP "local" network
NAT
Note: For the network examples in this section, a DSM-RTR should be used as the
BBMD Device on the local network side of the NAT since it has two UDP/IP
ports.
Single IP Segment Behind NAT
This example illustrates a setup where there is a single network segment of
BACnet controllers on the local network side of the NAT device with a mix of
BACnet/IP and Ethernet only controllers.
The NAT device is setup to forward all incoming UDP packets with a port number
of 47808 to a BACnet/IP BBMD (DSM-RTR) on the local network. The DSM-
RTR then routes all the BACnet/IP data to UDP port 47809 and to Ethernet. All
the other BACnet/IP devices on the local network have a UDP port number of
47809. The DSM-RTR must have both UDP/IP adapters enabled with one setup
as a BBMD and the other as a Regular IP device.
The following diagram illustrates this setup. The “B/IP Device” represents a
Foreign or BBMD device (either OWS or controller) that is communicating to the
local network from a network that is external to the NAT device.
"external" network
Ethernet/IP "local" network
NAT
The NAT device is setup to forward all incoming UDP packets with a port number
of 47808 to a BACnet/IP BBMD (DSM-RTR) on the local network. The DSM-
RTR then routes all the BACnet/IP data to UDP port 47809 and to Ethernet, then
forwards it to BBMD devices on the other IP segments. All the other BACnet/IP
devices on the local network have a UDP port number of 47809. The DSM-RTR
must have both UDP/IP adapters enabled with both setup as a BBMD.
The following diagram illustrates this setup. The “B/IP Device” represents a
Foreign or BBMD device (either OWS or controller) that is communicating to the
local network from a network that is external to the NAT device.
"external" network "local" network
Ethernet/IP network
NAT IP Router
Routing Routing
UDP/IP UDP/IP Ethernet UDP/IP UDP/IP Ethernet
and only only and only only
Ethernet Ethernet
Ethernet/IP network
IP Router
Routing
UDP/IP UDP/IP Ethernet
and only only
Ethernet
For this setup, the List of BBMDs (BMD) objects need to be setup in the DSM-
RTR as well as BBMD Device 2, 3, and 4. The best way to do this is to setup the
DSM-RTR as a master where it knows of all the other BBMDs behind the routers
(BBMD Device 2, 3, and 4), and the BBMDs behind the routers only know about
the DSM-RTR:
Note: When an OWS is logged into a remote network, it will not be able to see any
other OWS’s on the local network in Navigator and vice versa.
Even though it is possible to have multiple OWS’s behind a NAT device connect
to the same remote DSC BBMD, it is not recommended. We recommend using
only one OWS behind a NAT device to log into a BBMD. If there are multiple
OWS’s behind a NAT device logging into the same remote network and there are
multiple BBMD’s on the network, we recommend logging each OWS into
different BBMD’s.
Note: If multiple OWS’s behind a NAT device try to connect to the same remote
DCU BBMD, only the first OWS that connected to the DCU will be able to see the
DCU and the rest of the network. Any other OWS’s that try to log into that same
DCU will not be able to connect and see any of the network.
Controller Setup
To enable BACnet/IP in a controller, there are different objects that need to be
setup depending on whether the controller is a DSC/DSM-RTR or DCU. The NET
object needs to be setup in a DSC/DSM-RTR and the BCP and UNS objects need
to be setup in a DCU. If the controller is a BBMD, the BMD object needs to be
setup regardless of whether it is a DSC/DSM-RTR or DCU. This section just
highlights a few key points that are important to note when setting up any of the
previous network examples.
• The UDP port number is specified in the NET or BCP object of the
controller.
Overview
This document explains how to connect different vendors' BACnet systems at the
network level in order to obtain interoperability.
The first and most critical consideration when connecting BACnet systems is
ensuring that all BACnet controllers in the newly connected BACnet network
have unique Device Numbers. BACnet allows the range of the Device Number to
span between 0 and 4,194,303 to ensure that all devices can have a unique
number.
The second consideration is to ensure that there is only one network path between
the connected BACnet controllers. Although some networks allow redundant
network paths for fail-safe considerations, BACnet has no mechanism to handle
multiple paths. In fact, multiple paths will have a severe impact on network
performance.
The fourth consideration is deciding how the actual physical connections are
going to be made. Clearly, networks of the same type (Ethernet, for example) can
be connected with little difficulty, but joining two networks that have different
types (Ethernet to ARCNET, for example) will require the use of a BACnet
router. A number of BACnet devices provide some type of BACnet routing right
on the device. However, there will be cases where a separate BACnet router
device is required to join the two networks.
Once the devices are properly cabled together with Ethernet, they will be able to
communicate.
However, BACnet also supports TCP/IP protocol over Ethernet networks. TCP/IP
does require considerable extra setup and is discussed in the section, BACnet
Devices with BACnet/IP starting on page 9–25.
The first consideration is the physical connection. Although there are "standard"
terminations (ends) for serial links, there are enough options that it often comes
down to making a custom cable to join the two devices. When this is done, usually
only three wires are required: Transmit, Receive, and Ground. The transmit and
receive wires on one device are connected to the receive and transmit wires on the
other device. Ground is connected straight through. A second problem is the
length of the cable. As the serial communication speed increases (baud rate), the
length of the cable has to decrease. At 9600 baud, the length of the cable joining
the two devices should not exceed 50 feet.
The Second consideration is the serial options that are possible. These must be the
same in both of the devices to be connected, and are summarized in the following
table:
Serial Explanation
Parameter
Baud Rate This is the speed that the serial link will communicate at. The most
common baud rate is 9600 baud, but many other speeds are
possible.
Data Bits This is the number of bits of data that are sent in each serial "frame".
The options are 7 or 8, with 8 being the most common. See the parity
entry in this table.
Stop Bits This is the number of stop bits that will be transmitted with each serial
"frame". The options are 1, 1.5, or 2. 1 is the most common.
Parity Parity is a marginally effective means of detecting errors on serial
links. The available options are None, Odd, Even, and Mark and
Space. Most devices default to None, because better error control is
provided by BACnet. Also, if the parity is set to anything besides
None, the Data Bits must be set to 7.
Like serial links, MS/TP also supports different baud rates (communication
speeds) which must be the same in all devices connected to the MS/TP network.
The default baud rate is 76800 baud; however rates of 19200 and 38400 are also
supported by BACnet. This is the default for the BCP, and both NET1 and NET2
objects.
However, the BACnet standard has defined two different, incompatible, methods
for implementing BACnet over TCP/IP networks. The first standard, which is
referred to as Annex H allows TCP/IP connections between two different BACnet
networks. Although functional, this standard places severe limitations on how the
network can be connected to. Annex H essentially makes it impossible for an off-
site OWS to look at a remote building's network, which is the reason for using
TCP/IP in the first place!
Property Explanation
IP Address A unique, four part address given to each device in a TCP/IP network.
Subnet Mask A four part address used to distinguish the TCP/IP network from the
actual TCP/IP devices.
Gateway A gateway is a device for linking one TCP/IP network to another TCP/IP
Address network. Gateway Address is the IP Address of the Gateway.
DATA EXCHANGE
Throughout this section, references will be made to the data exchange objects
(DEL, DER, DES). Full descriptions of the fields in these objects can be found in
the Objects Used in Networking section of this chapter.
Reading Values
Once applied, this program will create the data exchange from controller 4 to
controller 89. By default, the value of 'Local OAT value' (the local AV), will be
updated every 30 seconds. For most applications, this rate should be sufficient.
Another consequence of setting up this data exchange is that two new objects will
automatically be created.
In controller 89, a Data Exchange Remote (DER) object will be created. This
DER object knows from the program that you wish to receive the value of the
input on controller 4. The DER object is equivalent to the Highway Request (HR)
point in Version 2. One DER object will be created for each remote object value
that is requested.
In controller 400, a Data Exchange Local (DEL) object will be created. The DEL
object is responsible for sending out the value of the input on controller 4. This is
equivalent to the Highway Output (HO) point in Version 2. One DEL object will
be created for each local object value that is being requested by a remote
controller.
In the previous figure, the Exchange type field has a dropdown box in 3.22.
Unlike Version 2, BACnet supports many different types of data exchange. When
a data exchange is created, the default method of data exchange is Optimized
Broadcast. This is the method that was used in Version 2. The method that is used
for a specific data exchange (such as the previous one), can be changed in the
DER object.
Besides Optimized Broadcast, the other methods available for reading are
Broadcast, Change of Value and Poll. Descriptions of these other methods can be
found in the Objects section of the manual, in the DER object.
Note: This approach to reading values from a remote Version 2 controller only
works for a DCU controller and NOT for a DSC/DAC controller.
Once applied, this program will create the data exchange from controller 2 to
controller 89. By default, the value of 'Local OAT value', the local AV object, will
be updated every 60 seconds. For most applications, this rate should be sufficient.
Another consequence of setting up this data exchange is that two new objects will
automatically be created.
In controller 89, a Data Exchange Remote (DER) object will be created. This
DER object knows from the program that you wish to receive the value of the
input on controller 2. The DER object is equivalent to the Highway Request (HR)
point in Version 2. One DER object will be created for each remote object value
that is requested.
Notice that the Remote Object (2.IP1), is the input on controller 2 (P2_OAT) that
we wish to receive.
In controller 2, a new entry is made in the Highway Output (HO) point. If the HO
point had not previously existed, it would have been created. The HO point is
responsible for transmitting values from controller 2 to other controllers in the
network.
The first line in the HO point is an entry that refers to P2_OAT, which is the value
that controller 89 wishes to receive.
When exchanging values from a Version 2 controller to a BACnet DCU, only one
method (Optimized Broadcast) can be used.
Depending on the third party device, this may work immediately, or some
additional setup might be required. If it doesn't seem to work after a few minutes,
the problem likely is that the third party device does not support our default data
exchange method. Opening the DER object will report some additional
information. If the data exchange does not work with the default method, the DER
will automatically attempt to Poll the value.
Polling a value works much the same way that Navigator real-time data and
graphics retrieve their values. Polling does not require the remote device to initiate
anything, the value will just be retrieved. If polling seems to be working, the
Exchange Type can be set to Poll in the DER.
Note: If a third party device does not display properly in the Navigator, then data
exchange will not work. See the Contents - Connecting BACnet Systems in the first
part of this document for additional information.
Writing Values
Writing values to remote controllers is not normally required, because the remote
controller could instead read the value. Reading is the preferred method.
However, there are cases where reading is not possible, because the remote
controller cannot be programmed to do a read. A third party BACnet device is an
example, which is covered in the section 'Writing a Value to a Remote third Party
BACnet Object'.
Note: Enclose read or write code within a DoEvery EndDo loop. Otherwise the
program will read or write on every program scan. The database scan rate for the
controller will be greatly reduced.
Once applied, this program will cause the write data exchange to occur. The
output on controller 4 will be updated with the value of the controller in controller
89 every 30 seconds.
Another consequence of setting up this data exchange is that two new objects will
automatically be created. Like the read exchanges where one DER and one DEL
were created, writes create two DER objects on both DCU and DAC controllers.
These are shown in the following figures:
The first DER (89.DER3) references 'AHU 1 Mixed Air Dampers' as the Remote
Object. The Exchange Type is set to 'Write', which indicates that this is a write
data exchange. The second DER (89.DER5) also references 'AHU 1 Mixed Air
Dampers' as the Remote Object. However, the Exchange Type is 'Default'. This
second DER is used to retrieve necessary information from the remote object, in
order to write to it. A DEL object is not created in either controller when using
write. Writing is similar to Polling, in that the requesting end does all of the work.
This means that the V3 DCU controls the communication of writing values for
both directions i.e. Reading the values of the V2 controller and writing to the V2
controller. The following figure shows an example of reading from and writing to
a V2 controllers:
Note: This approach to writing values to a remote Version 2 controller only works
for a DCU controller and NOT for DSC/DAC controllers.
Writing to a third party's object values is very similar to writing to a remote Delta
controller. GCL program links are setup in the same fashion that was described
earlier. The controller will create local DER objects, which refer to the remote
object value, just as it did before. The DCU creates 2 DER objects and the DAC
creates 1 DER object.
Note: Enclose read or write code within a DoEvery EndDo loop. Otherwise the
program will read or write on every program scan. The database scan rate for the
controller will be greatly reduced.
The GCL statement which causes the data exchange to happen must be enclosed
in a 'DoEvery' loop. Without the 'DoEvery' loop, a write would take place on
every program scan. This would have a very large negative impact on the
database scan rate for the DCU. Also, it is entirely possible that the third party
device could not accept writes at this rate. If you are having trouble getting write
to work properly, try lengthening the time in the 'DoEvery' loop.
Note: If the third party device will not display properly in the Navigator, data
exchange will not work either. See the Connecting BACnet Systems starting on
page 9–22 in this manual for additional information.
Other Considerations
When doing data exchanging, there are some additional considerations.
OWS Capabilities
In ORCAview, the OWS behaves much the same as the controller, and can have
the same objects created. This includes GCL programs. This means that the OWS
can also do Data Exchanges between itself and other controllers.
It is not recommended that the OWS be used to handle any data that is used for
building control decisions. However, this functionality could prove useful for data
gathering, or long term averaging.
Poll Data Exchanges based on the Poll exchange type are adjusted by a setting
the Data Exchange Settings (DES) object. The trick is knowing which DES object
to adjust, because there is one in each controller. The easy way is to determine
which controller is making the request for remote data. For example, if controller
90 wishes to receive an object's value in controller 4, then the DES object to adjust
is the one in controller 90. The following is an example of the DES object:
The time between data exchanges is referred to as the Interval time. By default, it
is set to 30 seconds for the Poll exchange type. This time can be adjusted between
1 second and 600 seconds (10 minutes).
However, it is recommended that this time NOT be set to any less than the number
of controllers on the network. Faster exchange time (lower values) could lead to
excessive network traffic, which will impact on the responsiveness of Navigator.
The most common analog objects AV, AI, and AO each have a field referred to as
the 'COV Min. Increment'. This value defaults to 1, and it specifies how much the
value of this object must change, before the object's value will be sent to other
controllers in the system. In the previous example, the COV Min. Increment is set
to 1. This means that if the present value of 198.2% changes to either 199.2% or
197.2%, it will be transmitted to other controllers.
Write The final type of data exchange is 'Write'. Unlike the other 'reading'
methods, the transfer rate of Write exchanges is determined by a GCL program.
Please refer to the previous section named Writing Values to a Remote BACnet
Controller on page 9–32 for details.
IP PACKET FILTERING
This document provides a more detailed explanation of the checkbox fields on the
IP Filter tab of the BACnet Broadcast Management Device List (BMD) object.
This material is additional to the basic information provided with the BBMD
object. These filters work with the BACnet/IP Router (DSM-RTR) product of
Delta Controls. With an Ethernet DSC-based controller, only the 'Block Ethernet
broadcasts from Delta devices' and the 'Disable routing global broadcast Who-Is-
All' options are available.
This document details the IP packet filtering functionality, its use, and includes
settings for typical applications. Knowledge of Delta Controls products
(particularly the Operator Workstation software package) is required, in addition
to BACnet networking knowledge.
Table of Contents
INTRODUCTION .................................................................................................. 9–40
ENABLING IP PACKET FILTERING ...................................................................... 9–41
BLOCK ETHERNET BROADCASTS FROM DELTA DEVICES ................................... 9–42
DISABLE ROUTING BETWEEN UDP/IP ADAPTERS ............................................. 9–43
DISABLE IP REGULAR SUPPORT ......................................................................... 9–44
DISABLE ROUTING GLOBAL BROADCASTS......................................................... 9–45
DISABLE FOREIGN TO FOREIGN COMMUNICATION ............................................. 9–46
DISABLE ROUTING BETWEEN ETHERNET AND UDP/IP ...................................... 9–46
DISABLE ROUTING DE BROADCASTS TO UDP/IP .............................................. 9–47
BLOCK ROUTED PACKETS FROM ETHERNET ...................................................... 9–48
IGNORE I-AM-ROUTER FROM ETHERNET ........................................................... 9–49
DISABLE ROUTING GLOBAL BROADCAST WHO-IS-ALL ..................................... 9–50
TYPICAL IP PACKET FILTERING SETTINGS ......................................................... 9–51
Master BBMD ..................................................................................... 9–51
Remote BBMD .................................................................................... 9–51
Remote Foreign Device ....................................................................... 9–52
Introduction
In BACnet networks, every device is able to communicate with any other device.
If a device generates a global broadcast message, that broadcast will reach every
device on every network. This behavior can easily saturate the network with
excess traffic, affecting the throughput of the network. In some applications, not
all devices need to communicate with all other devices. In some cases,
communication from one device to another is even disallowed.
Note: With IP packet filtering enabled, the device will still process the packets
locally. IP packet filtering is only applicable for traffic destined to BACnet/IP
networks. There are no filtering options for traffic destined to Ethernet or MS/TP
networks.
The BBMD object contains a concise explanation of each of these filters. The
following sections of this document provide more detailed information for each of
these filtering options.
Before enabling IP packet filtering, you should have a good understanding of your
network and have determined what type of traffic you want to filter.
The purpose of this filter is to stop global broadcasts from flooding the IP
networks un-necessarily. This filter should be enabled if there is a lot of network
traffic on the local site that does not need to be routed over the IP network to other
remote sites.
The following diagram illustrates the behavior of this filter. The Ethernet and
BACnet/IP networks do not represent separate physical network connections to
the DSM-RTR, but rather separate BACnet networks. It is displayed this way for
easier illustration. The arrows represent global broadcast packets that originated
from the displayed device. If the displayed device routes network traffic (i.e. from
an MS/TP sub-network), all global broadcast packets that originate from the sub-
network will be blocked by the DSM-RTR, whether or not the sub-network device
or the Ethernet device is a Delta or Non-Delta device.
The purpose of this filter is to allow the DSM-RTR to be a part of two separate
isolated BACnet/IP networks. For example, if UDP/IP adapter 1 connects to a
Master BBMD and UDP/IP adapter 2 is used for service technicians to log in, this
filter could be used to limit the service technician's network traffic. With this filter
enabled, the service technician would only load descriptors from the local site,
which would be faster than loading descriptors from all remote sites.
Note: In this example, IP filtering is not intended for security reasons, as the
service technician could disable the filter.
The following diagram illustrates the behavior of this filter, and highlights the
devices in the above example (Master BBMD, Local Site, and Service Tech
OWS). The two BACnet/IP networks do not represent separate physical network
connections to the DSM-RTR, but rather separate BACnet/IP network adapters
(using different UDP port numbers). It is displayed this way for easier illustration.
The arrows represent packets that originated either from the displayed device, or
from a device whose network traffic is routed through it (i.e. from an Ethernet
network or MS/TP sub-network).
LOCAL SITE
BACnet/IP BACnet/IP
Network Network
DSM-RTR
BACnet/IP BACnet/IP
Disable Routing
Device Device
Between UDP/IP
Adapters
Filter Enabled
MASTER SERVICE TECH
BBMD OWS
This filter should only be used if there are no other BACnet/IP devices on the
local IP network segment (other than the BBMD). It is used to help eliminate
unnecessary IP network traffic.
This filter can be specifically enabled on either UDP/IP port (or both).
The following diagram illustrates the behavior of this filter. The three networks do
not represent separate physical network connections to the DSM-RTR, but rather
separate BACnet networks. It is displayed this way for easier illustration. The
arrows represent packets that originated either from the displayed device, or from
a device whose network traffic is routed through it (i.e. from an MS/TP sub-
network).
Remote
BACnet/IP Device
Internet
DSM-RTR
Disable IP
Regular Support
Ethernet Filter Enabled Local BACnet/IP
Device Device
The purpose of this filter is to stop global broadcasts from flooding the IP
networks un-necessarily. This filter should be enabled if there is a lot of network
traffic on the local site that does not need to be routed over the IP network to other
remote sites.
This filter is similar to the ‘Block Ethernet broadcasts from Delta devices’ filter,
except this filter is not restricted to just Delta devices or to just packets received
from the Ethernet network.
This filter can be specifically enabled on either UDP/IP port (or both).
The following diagram illustrates the behavior of this filter. The Ethernet and
BACnet/IP networks do not represent separate physical network connections to
the DSM-RTR, but rather separate BACnet networks. It is displayed this way for
easier illustration. The arrows represent global broadcast packets that originated
either from the displayed device, or from a device whose network traffic is routed
through it (i.e. from an MS/TP sub-network).
Disable Routing
Global
Broadcasts
Filter Enabled
LOCAL SITE
DSM-RTR BACnet/IP
Ethernet Network Network(s)
MS/TP
Devices
Ethernet BACnet/IP
Device Device
This filter can be used if you have foreign devices at separate sites logging into a
Master BBMD and there is no need for each site to communicate with each other.
This would eliminate unnecessary network traffic between the sites.
This filter can be specifically enabled on either UDP/IP port (or both).
The following diagram illustrates the behavior of this filter, and highlights the
devices in the above example (Master BBMD and foreign devices). In this case,
the three networks represent separate physical network connections all on the
same BACnet/IP network. The arrows represent packets that originated either
from the displayed device, or from a device whose network traffic is routed
through it (i.e. from an MS/TP sub-network).
This filter could be used to limit a service technician's network traffic. For
example, if a service technician logs into a site via Ethernet, the service technician
would only load descriptors from the local site, which would be faster than
loading descriptors from all remote sites.
Note: In this example, IP filtering is not intended for security reasons, as the
service technician could disable the filter.
This filter can be specifically enabled on either UDP/IP port (or both).
The following diagram illustrates the behavior of this filter, and highlights the
devices in the above example. The Ethernet and BACnet/IP networks do not
represent separate physical network connections to the DSM-RTR, but rather
separate BACnet networks. It is displayed this way for easier illustration. The
arrows represent packets that originated either from the displayed device, or from
a device whose network traffic is routed through it (i.e. from an MS/TP sub-
network).
LOCAL SITE
BACnet/IP
Ethernet Network Network
DSM-RTR
Disable Routing
Ethernet BACnet/IP
Device Between Device
Ethernet and
UDP/IP
SERVICE TECH Filter Enabled
OWS REMOTE SITE
1) The default broadcast destination in the DES object is NET0, which is only
the locally connected network to the corresponding device. However, there may
be cases to change NET0 to BROADCAST. To limit the impact of this change
this filter can be used at certain routers to choke the packet.
2) If there are traffic limits imposed by the Internet Service Provider (ISP) then
enabling this filter may lessen the amount of traffic being sent out onto the
UDP/IP network.
This filter only chokes broadcast Data Exchange packets. Unitcast (or directed)
packets are routed as normally would.
Note: The filter does NOT stop routing directed (unicast) DE (Data Exchange)
packets. This filter can be specifically enabled on either UDP/IP port (or both).
The primary application of this filter is when you have multiple Master BBMD's
on the same Ethernet segment. With this filter enabled, routed traffic from one
BBMD is not routed to the remote networks of the other BBMD. This prevents
remote devices of one Master BBMD from communicating with remote devices of
another Master BBMD. In other words, it eliminates unnecessary network traffic
between sites that belong to different Master BBMD’s.
With this filter enabled, all OWS's should be on the local Ethernet segment of the
Master BBMD's, otherwise the OWS would not be able to communicate with all
BACnet devices. Packets that originate from the local Ethernet segment will be
routed to the remote networks.
The following diagram illustrates the behavior of this filter, and highlights the
devices in the above example (multiple Master BBMD’s on the same Ethernet
segment). The Ethernet and BACnet/IP networks directly next to the DSM-RTR
do not represent separate physical network connections, but rather separate
BACnet networks. It is displayed this way for easier illustration. Although it is not
shown, the BACnet IP network(s) next to the DSM-RTR would be connected to
the Internet and communicate with remote BACnet/IP devices. The arrows
represent packets that originated either from the displayed device, or from a
device whose network traffic is routed through it (i.e. from an MS/TP sub-
network).
Master
BBMD
(DSM-RTR)
Block Routed
Remote Master BBMD Packets from
BACnet/IP Ethernet
Device MS/TP Filter Enabled
Devices LOCAL NETWORK
REMOTE
BBMD
The primary application of this filter is when you have multiple Master BBMD’s
on the same Ethernet segment. With this filter enabled in the Master BBMD, it
will not contain entries in its Routing Table to networks from the other Master
BBMD's, or to sub-networks from an Ethernet device on the same segment as the
Master BBMD's.
I-Am-Router packets are used to inform devices how to reach a remote network.
In cases where there are a large number of remote networks, a BBMD’s routing
table can become full quite easily. For example, with 25 Master BBMD's on the
same Ethernet segment, and each with 25 remote BACnet/IP devices, each Master
BBMD could be a router to about 75 networks (each remote BACnet/IP device
having approximately 3 networks). This would mean that there are 25 * 75 = 1875
individual networks. However, since the DSM-RTR's routing table can only store
250 entries, it would not have space to store all the routes. Once the routing table
becomes full, it has to generate extra traffic to find the routes to the networks that
are not currently in its routing table.
The purpose of this filter is to help prevent overflowing the BBMD's routing table
and to prevent it from sending extra traffic once its routing table becomes full.
With this filter enabled, all OWS's should be on the local Ethernet segment of the
Master BBMD's, otherwise the OWS would not be able to communicate with all
BACnet devices.
Note: Enabling this filter will not delete current routing table entries. Resetting
the device will clear the routing table. The routing table can be observed through
the DRT object.
The following diagram illustrates the above example application (multiple Master
BBMD’s on the same Ethernet segment).
The purpose of this filter is to drop global broadcast Who-Is-All messages; thus,
avoiding a large number of I-Am traffic. The side effect is that devices can no
longer issue global broadcast Who-Is-All messages to discover devices.
Delta Controls devices and software does not use this method of device discovery.
Enabling this filter may affect third party devices and/or software from
functioning.
Master BBMD
The Master BBMD routes network traffic between remote BACnet/IP devices and
the local Ethernet network segment. The Master BBMD contains a list of the IP
addresses for each remote BACnet/IP device (in the BMD object).
Remote BBMD
The remote BBMD connects an entire BACnet site to the BACnet/IP network by
communicating directly with the Master BBMD. The remote BBMD contains
only the IP address of the Master BBMD (in the BMD object).
For this example, the remote BBMD communicates on two separate BACnet/IP
networks; one that communicates to the Master BBMD, and another that allows
service technicians to log in. The remote BBMD is setup to be a BBMD on both
BACnet/IP networks.
The main difference between a remote foreign device and a remote BBMD is
remote BBMD’s require a static IP address, whereas remote foreign devices can
use a dynamic IP address (assigned via DHCP).
For this example, the remote foreign device communicates on two separate
BACnet/IP networks; one that communicates to the Master BBMD, and another
that allows service technicians to log in. The remote foreign device is setup to be a
foreign device on the BACnet/IP network that communicates with the Master
BBMD, and a BBMD on the BACnet/IP network that allows service technicians
to log in.
The following diagram illustrates a simplified network with each of these three
different device types (Master BBMD, Remote BBMD, Remote Foreign Device).
The Master BBMD would typically be located at a central site, and the remote
BBMD and foreign devices would be located at different sites connected via the
Internet.
CENTRAL SITE
Master BBMD
Ethernet/IP
You can access context sensitive help for each object dialog by pressing F1 or the
? Help button in the lower right corner of a dialog.
The DSM-RTR will automatically create a second BMD object. Other types of
Ethernet DSC-based devices do not create the second BMD object and also will
not use the second object if it is present. The names of the BMD object's are:
• BBMD List1 #
• BBMD List2 #
Where # is the Device Address
The first BMD object is used for the first UDP/IP adapter, and the second BMD
object is for the second UDP/IP adapter.
The OWS does not allow a BMD object to be deleted. If a DSM-RTR database is
loaded into a DSC, then the second BMD object will persist forever.
Addressing
Each line of the Remote BBMD Addresses can be used to hold one IP Address. An
example of a typical IP address is 192.168.10.1. Each of these IP addresses is used
to identify other BBMD devices on the network. The local device is not identified
in this table.
Thus in a network where four different IP segments are to be part of the same
BACnet network, each of these BBMD tables would have three addresses.
IP Filter
Ethernet DSC-based controllers are able to utilize only the 'Block Ethernet
broadcasts from Delta devices' and the 'Disable routing global broadcast Who-Is-
All' filters.
The IP Filter tab of the BMD object is used to eliminate unnecessary incoming
network traffic (packets) from being routed from one network to the IP
network(s). In other words, packet filtering restricts network traffic from entering
other sections of the network. It is intended for use in large Wide Area Network
(WAN) applications by the BACnet/IP Router (DSM-RTR) for improving
network speed by minimizing the amount of network traffic.
Note: Before enabling IP packet filtering, you should have a good understanding
of your network and have determined what type of traffic you want to filter.
These filtering options are only available on the DSM-RTR. However, Ethernet
DSC-based controllers are able to utilize the ‘Block Ethernet broadcasts from
Delta devices’ filter.
IP Filter Function:
Block Ethernet broadcasts from This filter blocks global broadcast packets,
Delta devices received on the Ethernet network that
originated from any Delta device (not
including the OWS), from being routed to
the IP network(s). This filter will not block
global broadcast packets that originated
from any non-Delta device, nor will it block
non-global broadcast packets from any
device.
Disable routing between UDP/IP-1 This filter blocks all packets from being
and UDP/IP-2 routed between one UDP/IP adapter to
the other.
Disable IP Regular support This filter restricts the device from re-
broadcasting packets over the local IP
segment(s). In addition, with this filter
enabled, the device will ignore BACnet/IP
packets from other devices on the local IP
segment. This filter can be specifically
enabled on either UDP/IP port (or both)
Disable routing global broadcasts This filter blocks global broadcast packets,
received on any network port (UDP/IP,
Ethernet, MS/TP), from being routed to
the IP network(s).This filter can be
specifically enabled on either UDP/IP port
(or both)
Disable Foreign to Foreign This filter restricts the device from sending
communication packets from one foreign device to
another foreign device. This filter can be
specifically enabled on either UDP/IP port
(or both).
Disable routing between Ethernet This filter blocks all packets from being
and UDP/IP routed between Ethernet and UDP/IP.
This filter can be specifically enabled on
either UDP/IP port (or both).
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
This object defines a group of data items that are exchanged. A user can configure
the settings of the object to suit the data exchange needs. This bulk exchange
eliminates the necessity of a large quantity of Data Exchange Local (DEL) / Data
Exchange Remote (DER) object pairs.
The concept of a bulk data object is not new. Delta Controls Version 2 product
provided a similar feature using its Highway Output (HO) object and IC Screens.
In the Transmit Entries, the BDE object can directly fetch values from local
objects while only GCL can read the received values from the BDE object in the
Receive Entries. The receiver’s BDE object cannot write directly to local objects.
In order for Bulk Data Exchange to occur between controllers, the BDE objects
must have the same object (Channel) name which makes the BDEs function
independent of instance numbers. Whenever a BDE exists on a device it does data
exchange with any other BDE on the network as long as they share the same
Name (Channel). A unique BDE name represents a unique channel for data
exchange between the controllers.
Supported controllers for the BDE object include eBUS and devices with DSC16
and DAC8 images.
Note: If receiving data from multiple controllers to one controller is desired, one
channel must be used for each transmitting controller. For example, if there are 3
transmitting controllers, each transmitting controller must have a BDE object
with a unique Name (Channel) and there must be 3 BDE objects in the receiving
controller corresponding to each transmitting BDE object.
total = 0
i = 0
ForAll Receiver In "BDE*:*"
value = Read ("BDE:" & Receiver.Name & ".IAT")
total = total + value
If i = 0 Then
minval = value
maxval = value
Else
If value < minval Then minval = value End If
If value > maxval Then maxval = value End If
End If
i = i + 1
End For
Average = total / i
Minimum = minval
Maximum = maxval
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
The Setup Tab contains the Name (Channel), Broadcast Interval and Exchange
Type fields.
Name (Channel)
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on other supported controllers such as a DAC.
The name must be unique among the objects located on the same controller.
The Name of a BDE object is not just a name. A unique name represents a unique
channel for data exchange between the controllers at a defined frequency. So
whenever a BDE exists on a device, it does data exchange with any other BDE
on the network as long as they share the same name. The function of BDE
objects is independent of instance numbers.
For more information, refer to the information at the start of this object.
Broadcast Interval
Specifies the interval in seconds at which the BDE transmits. Only the transmitter
uses this parameter. The range of the Broadcast Interval field is 10 to 100 seconds.
The Broadcast Interval field in the Bulk Data Exchange object has a default value
of 120 seconds.
Exchange Type
The Exchange Type dropdown field in the Bulk Data Exchange object contains
the following options: Broadcast and Broadcast & COV.
Transmit Entries
The Transmit Entries tab provides a list of Tag and Object entries that are
transmitted. One BDE object can transmit to multiple controllers at the same time.
Dataview
The Transmit Entries dataview contains the editable Tag and Object fields and
also the read only Last Value Sent field.
Next Broadcast in
Counts down the time in seconds to the next scheduled broadcast.
Receive Entries
When an entry is added to the transmitter list of a BDE object, the Tag and Last
Received Value dynamically update in the corresponding BDE objects on the
network.
The Receiver lists get dynamically updated when an entry is entered into a
transmitter on the same channel.
The device can read and assign values from the BDE object by using the
following Read command in GCL: AV1=Read("BDE:Channel_Name.Tag")
Last Received
Counts up the time in seconds since the last data exchange was received.
Receive Dataview
The dataview includes the names of entries transmitted from a BDE object on
another controller. The BDE controllers must have the same object name to form a
channel which shares entry name and data.
Destinations Tab
The Destinations tab contains a Broadcast Destinations edit box. The Broadcast
Destinations field accepts network numbers and device addresses.
If NET0 is entered into the Destinations list, the local broadcast does not get
forwarded to any other ports by the receiving controller. If NET65535 is entered
into the Destinations list, the global broadcast is forwarded onto each of the
receiving device's ports.
If a specific network number is entered into the Destination list, the receiving
device only forwards the BDE packets onto the correct port if that specific
network number exists. If a specific device address is entered into the Destination
list, the receiving device only forwards the BDE packets onto the correct port if
that specified target device exists.
Status
The Status Tab contains the Next Broadcast in, Time Since Last Update and
Received From dataview fields.
Next Broadcast in
The Next Broadcast in field displays the number of seconds before the controller's
BDE is required to transmit data again. This field is always decrementing as long
as the controller has data to send via BDE.
COVs Remaining
The COVs Remaining field displays the number of COV updates that the BDE
object can send until it has to wait another broadcast interval to send again. This
field only decrements if Broadcast and COV is the selected Exchange Type.
Heading Function
Device This column contains a list of entries for sending devices.
Time This column contains the time that a data transmission was
Received received from the particular device.
Multiple objects will be created in a single controller if more than one object value
is being transmitted to other controllers. These will be given the default names of
DEL1, DEL2, etc…
Header (DEL)
The DEL object has three fields in its header.
Exchange Value
This value is the last value that was transmitted to the receiving controller.
Exchange Flags
A number of different conditions can be displayed here.
Local Flags
Any flags on the controller that provided the value displays in this field. .A typical
flag might be Out of Service or Fault.
Fields (DEL)
The DEL object does not have any tabs.
Name
This is the descriptor name given to this object by the system. This would
typically be DEL1, DEL2 etc. and cannot be changed.
In DAC and DSC products, DER and DEL objects are named based on the object
they are transferring. This allows the DER and DEL objects to be easily sorted
and filtered in Navigator. DER/DEL names take the following form:
DER#__<RemoteDeviceID>_<ObjectType><Instance>_<PropertyID>
e.g. DER123__3600_AV1_85
DEL#__<ObjectType><Instance>_<PropertyID>
e.g. DEL38__AV12_85
Note: The Property ID identifies the property of the object being transferred. A
Property ID of 85 is the Value property.
Local Object
This value of this object in the controller is transmitted to the remote controller.
This is a read-only field.
Exchange Type
This field reflects the type of exchange set in the Data Exchange Remote (DER)
object. It indicates the type of exchange being used between controllers for this
object. See the DER object for a description of these types. This field is only
editable if the Manual Subscription checkbox is selected to in the dataview.
Manual Subscription
This box, when checked, forces this DEL object to broadcast the value to other
controllers. This would only be needed to send the value to non-Delta devices
which cannot properly request data exchange from Delta controllers. If no non-
Delta devices exist, then this checkbox can be left unchecked.
Dataview
This window at the bottom of the dialog box displays information about the
controllers that are requesting this object's value to be sent. Each controller that is
requesting this value is shown on its own line in the window.
Column Function
Subscribers The name of each controller who is requesting this value is shown in
this column.
'ID' This number is only used to uniquely identify a particular data
exchange.
Confirmed COV If the Exchange Type of this DEL is Change of Value, then this
column will be displayed in the dataview. It contains a checkbox
which, if checked, will cause this Change of Value data exchange to
be Confirmed. A Confirmed Change of Value data exchange will re-
send the data to the remote panel until it receives a successful
response from the remote panel. When the checkbox is unchecked,
the data exchange is Unconfirmed.
Flags Displays status flags similar to the Exchange Flags field of DEL. The
flags used are Subscribed, New Entry, and Error. Note that setting
this DEL to Manual Subscription is done by double clicking on the
Flags entry and clicking the Manual Subscription checkbox in the list
that appears. For a more explanation of Manual Subscription, see the
previous page.
Refresh Timer Displays the time at which this exchange will end if it is no longer
requested by the receiving controller. Essentially if this transfer is no
longer required, the row in the dataview will be deleted. If this is the
only row in the dataview, then the entire DEL object will be deleted,
since it is no longer required.
Multiple objects will be created in a single controller if more than one object value
is being requested from other controllers. These will be given the default names of
DER1, DER2, etc…
Header (DER)
The DER object has three fields in its header.
Exchange Value
This is the last value that was received from the transmitting controller.
Exchange Flags
A number of different conditions can be displayed here. The Exchange flags are:
• Have To Poll - Indicates that the object value will be polled. This is the case
if the Exchange Type is set to 'Poll' or if the value could not be subscribed to
successfully.
• ubscribed - Indicates that the remote value issuccessfully subscribed to.
• New Entry - Indicates that this is a new entry and needs to be subscribed to.
• Network Fault - Indicates that an error has occurred in receiving the remote
value, or if subscribing to the value failed.
• Manual Subscription - This indicates that this DER was created and setup
manually in order to receive data from another controller which is sending
data. This can occur between two controllers which are connected by
modems, or to receive a value from a third party (non-Delta) device. If either
of these is the case, see the Contents - Data Exchange section.
• Default - Indicates that the method of data exchange will be determined by
the setting of the Default Exchange Type in the receiving controller's DES
object.
• Dirty - For Write DER's, the dirty flag is set when the remote value is written
to. It does not matter if the value in the controller has changed or not since the
last time it was sent to the receiving controller.
Remote Flags
Any flags on the controller that provided the value displays in this field. .A typical
flag might be Out of Service or Fault.
Fields (DER)
The DER object does not have any tabs.
Name
This is the descriptor name given to this object by the system. The name would
typically be DER1, DER2 etc. and cannot be changed.
In DAC and DSC products, DER and DEL objects are named based on the object
they are transferring. This allows the DER and DEL objects to be easily sorted
and filtered in Navigator. DER/DEL names take the following form:
DER#__<RemoteDeviceID>_<ObjectType><Instance>_<PropertyID>_<R or W>
e.g. DER123__3600_AV1_85_R
Note: If a controller is reading a value from another controller, it has "_R" at the
end. If a controller is writing a value, then it has "_W" at the end. For example,
the following DER name indicates that the object is reading the value (Property
ID 85) of AV1 on controller 3600.
e.g. DER123__3600_AV1_85_R
On the older DCU controllers, the _R or _W are not appended at the end of the
name.
DEL#__<ObjectType><Instance>_<PropertyID>
e.g. DEL38__AV12_85
Note: The Property ID identifies the property of the object being transferred. A
Property ID of 85 is the Value property.
Remote Object
This is the object in the transmitting controller whose value is being received by
this controller. This is a read-only field.
Exchange Type
This field specifies how this value should be transmitted and received between
controllers. The types available are:
Poll - The receiving controller requests that the remote controller returns the
object's value immediately. The time between successive polls is set in the DES
object in the receiving controller, in the Poll tab. Note that when this type of
exchange is used, the corresponding DEL object is not created.
Number of Subscribers
This field reports the number of times that this value is being requested in the
receiving controller. For example, if two GCL programs in the same controller
both request the same value from another controller in the system, then the
number of subscribers would be 2. If this number drops to zero because this
remote value is no longer needed, the DER object will be automatically deleted.
Setup
The Setup tab has one field:
Broadcasting
Broadcast Interval
This is the time in seconds between successive broadcasts from this controller. It
functions equivalently to the 'Transmit Interval' in the Highway Output point of
Version 2 controllers. The default time is 30 seconds. The Interval should not be
set lower than the number of controllers on the network, or network performance
may suffer. If a value needs to be updated quickly, set the Exchange Type in the
DER object to Change of Value.
Next Broadcast In
This field displays the time at which the next broadcast will occur. It should
always be within 'Interval' seconds of the current time.
In this example, both Device 8900 (DEV8900) and Network 10200 (by default
could represent an Ethernet network) will receive Broadcast and Optimized
Broadcast Data Exchange. This capability can be used to limit the amount of
network traffic by only sending it to destinations that are required. For example, if
the controllers are all connected on an Ethernet segment (NET 10200) then setting
the destination to NET10200 will ensure that all broadcasts from this controller
are only sent out this Ethernet network. This could be beneficial if an OWS was
connected to this controller by Serial (RS-232), which is quite limited in
bandwidth.
Poll
Interval
This is the time in seconds between successive polls from this controller to other
controllers. The default is 30 seconds. DER objects in this controller which
receive values by an exchange type of Poll will be updated at this interval.
Next Poll In
This field displays the time at which the next poll will occur. It should always be
within Interval seconds until the next poll will take place.
Subscription
Interval
The Subscription Interval field determines how often the controller re-subscribes
to remote data. The field defaults to 1800 seconds and this setting should not need
to be adjusted.
Next Subscription in
This field displays the amount of time until the next Subscription Interval expiry
occurs.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
The DAC uses the NET object described on page 9–105 to set these configuration
options.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
ID Column The Dataview at the top of this tab lists all of the available Network
Interfaces in the ID column. Clicking on one of the Network Interfaces will
display additional configuration information (if available) in the area below the
Dataview.
Enabled Column The Enabled column contains one checkbox for each
Network Interface. When the checkbox is checked, this Network Interface will
support communication by the BACnet protocol.
Serial RS-232 networks are automatically given their own unique network number
which is 65535-(Controller Address MOD 5536).
The range of the NetworkNum is 0 to 65534. Note that the number cannot be
changed unless the controller is using software addressing mode.
Tunnel Column The Tunnel column contains one checkbox for each Network
Interface. When checked, all incoming Version 2 traffic will be directed as
Tunneled packets out this interface. Normally, only UDP/IP, Serial and MS/TP
interfaces should have this option checked. For a more through explanation of
Tunneling, see the Version 2 Protocol Settings (V2P) Object. The V2P object is
automatically created in the default database. It is used to configure network
options that pertain to the Delta proprietary Version 2 protocol. If only Version 3
panels are on site, then this option has no purpose. If only Version 3 controllers
are on site, then this option has no purpose. Never enable Tunneling for Ethernet
or IntelliNet.
Protocol This field reflects the PTP type of BACnet connection that is in use.
Parity Bits Parity is a simple method of error detection. The options are None
(default), Even, and Odd. It is provided mainly for compatibility with other
BACnet devices which may insist on a certain type of parity.
Stop Bits The available options are 1, 1.5 or 2 stop bits, with 1 being the
default. Like Baud Rate, all that matters is that both ends use the same setting.
Data Bits This is the number of actual data bits that will be sent in each frame
of RS-232 data. The available options are 8 bits (default) and 7 bits. 8 is almost
universally used, with 7 only being used when Parity is also used.
Idle Time This is the number of seconds that a serial PTP connection can be
idle before it is disconnected. The default is 600 seconds.
Dial Upon Login When this checkbox is checked, then the OWS dials out to a
controller upon login.
SUA for Direct Connect to 3rd Party Specifies the Password to check
when dialing into third party network.
Note: Changing the speed on any single device and pressing Apply or OK will
automatically cause a speed change on all Delta Controls devices on the same
MS/TP network. Speed change requests will be sent regardless of any baud rate
differences between the requesting device and other devices on the network.
Protocol The field displays the MSTP protocol used for communications.
Max Master The Max Master is the highest addressed controller that this
controller can communicate with over the MS/TP network. It is not recommended
to change it from the default of 127.
Address This is the physical MS/TP MAC address of the controller on the
MS/TP network. It is determined from the controller’s address but for a DCU
controller is always set to 0. Normally, this address is not changed.
Device Type This setting describes how this controller will participate in a
system where there are more than one IP network which are connected by routers.
This would typically be the case where a WAN is expected to carry controller to
controller communications.
• Regular Devices can communicate with other controllers in the same sub-
network, but cannot communicate with controllers in other sub-networks
without the assistance of a BACnet Broadcast Management Device (BBMD).
• Foreign Devices are controllers which are isolated by themselves on a sub-
network which has no BBMD. These controllers can communicate with the
larger network by registering with a remote BBMD device on another sub-
network. The following paragraph explains BBMD devices.
• BBMD Devices operate as regular controllers, but are also responsible for
sending information from the sub-network that the BBMD is connected on to
other BBMD devices on other sub-networks. The remote BBMD then sends
the received information to the controllers in that sub-network. It is important
BBMD Address This setting is only needed when the Device field is set to
Foreign Device. A foreign device needs to know the IP address of a remote
BBMD in order to participate with that remote network. Any of the controllers
which are set as a BBMD Device could be referenced here.
Registration Timeout This setting is only needed when the Device field is set
to Foreign Device. This field is a time in seconds and is passed along to the
remote BBMD Device. This controller must confirm its existence with the remote
BBMD at this interval or the remote BBMD will assume that this controller no
longer wants to participate in the network.
Dial-Out SUA This setting allows the user to select which SUA object that the
OWS will use to verify against the SUA object on the remote BBMD device. This
setting is only needed if the OWS is attempting to log into the network as a
foreign device, and the remote BBMD device requires an SUA Password Check.
Advanced
Protocol
Version
This is the major version number of the BACnet protocol that is implemented by
this controller. Currently, Version 1 is the only one available.
Revision
This is the minor version number of the BACnet protocol that is implemented by
this controller.
Retry Time
When a network transmission is made that requires an acknowledgement of
success, this field, which defaults to 7000 ms, specifies the time between
re-transmissions if the acknowledgement has not been received. If you are
experiencing problems with controllers dropping off-line, then increasing this
value may help.
Retries
This field specifies the number of times unsuccessful transmissions will be
repeated. If the receiving controller has not received the transmission successfully
after this many attempts, no further attempts will be made. The default is 3 on a
controller and 1 for the OWS.
Segment Timeouts
This field, which is very similar to the Retry Time, specifies the time between re-
transmissions of a single segment of a multi-segment message. When messages
between controllers are necessarily larger than the Max APDU Size (see above),
the message is broken down into multiple, smaller segments. Normally this field
does not need adjustment. The default is 5000 ms.
Stats
The Stats tab shows many statistics related to BACnet network communications.
MS/TP Slaves
This tab has a dataview which lists information about slave devices. See the Slave
Device List (SDL) object on page 9–158 of this chapter. The dataview has five
heading labels:
Device Number
Enter the device number of the slave device in this field.
Segmentation
Refer to the slave device’s documentation to determine what level of
segmentation the device supports, if any.
If the APDU portion of a message is larger than the maximum APDU value
supported by either of the devices participating in a conversation, the APDU
portion of message may be broken into multiple segments where each segment is
sent in a separate packet.
Vendor ID
This field indicates the manufacturer of the slave device. Refer to the slave
device’s documentation to determine the vendor ID to use. If the vendor ID is not
specified in the documentation, use 0.
MAC Address
This field contains the network number and MAC address of the slave device. The
MAC address is not the device number; it is the physical MS/TP address. Refer to
the slave device’s documentation to determine the MAC address for the device.
Caution: The MAC Address field uses a format that requires care and
attention when entering its value. First enter a valid network number
followed by a comma and then the MAC address for the particular device.
The format of the MAC address differs depending on the physical media
used by the device (Ethernet, MS/TP, ...).
Entering a MAC Address The value for this field begins with a network
number, followed by a comma and then the MAC address. For example, a MAC
address on network 2321 would start out with NET2321. The following examples
use network 50:
The DCU uses the BCP described on page 9–92 to set these configuration options.
Header
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
The Setup tab specifies which communication interfaces are active and sets their
parameters.
Port Column The Port column lists the physical ports on the controller.
Clicking on one of the Port numbers displays additional configuration information
(if available) in the area below the Dataview. Port 1 and 2 are EIA-485. Port 3 is
an EIA-232 serial, Port 5 is Ethernet, and Port 7 is UDP/IP. The port number is
internal and cannot be changed.
Type Column The Type column describes the interface for each port.
Enabled Column The Enabled column contains one checkbox for each
network interface. When the checkbox is checked, this Network Interface will
support communication by the BACnet protocol if the port is available.
Status Column The Status column displays the current state of each port.
Note: Changing the speed on any single device and pressing Apply or OK will
automatically cause a speed change on all Delta Controls devices on that MS/TP
subnet (DACs, DCUs and OWSs). Speed change requests will be sent regardless
of any baud rate differences between the requesting device and other devices on
the network.
Force Speed Change This checkbox is used to set the speed of all controllers
on the selected MS/TP network to the speed displayed in the Baud Rate field. This
checkbox is only available for MS/TP ports. This feature is used when you have a
current MS/TP network running at a certain speed, and you can add a controller
that is communicating at another speed. You would select this checkbox and press
Apply or OK and the Baud Rate of all controllers including the new controller is
changed to allow communication on the network.
Max Master This is the maximum number of MS/TP devices that can be in the
network segment. Any devices with a MAC address past this value will be ignored
and will not be visible on the OWS. This number must be the same on all devices
on the network segment.
Max Info Frames This value defines the maximum number of packets that the
MS/TP device can send out when it has the token, before it must pass the token to
the next device.
MAC Address This is the physical MS/TP address of the device. This number
comes from the DIP switch or LCD setup screen on the Room Controller.
Network The Network spin box field sets the BACnet network number for this
interface. Different physical (or logical) BACnet network segments must have
different BACnet network numbers or a value of 0. In order for the network
segment to work properly, all devices on that segment must contain the same
Network Number. Each interface in the Dataview is given a different network
number.
If DNA is disabled by removing the DNA jumper or by turning DNA off then
network numbers must be manually assigned and must match for each device on a
particular network segment. The Network spin box accepts a network number
range of 0 to 65534.
Note: The Network Number spin box field is grayed out if DNA is enabled. The
DNA scheme automatically calculates the proper network number. If DNA is
disabled, then the Network Number field is available, and needs to be set to the
proper value.
Setup Tab: Statistics MS/TP (same fields for PTP, Ethernet, and
UDP/IP)
This view shows some statistics related to BACnet network communications. The
fields for statistics are the same for all the different adapters. The values depend
on the interface selected in the Dataview.
Network Stats
Total Sent Counts the total number of packets sent including tokens for
MS/TP.
Total Received Counts the total number of packets received including tokens
for MS/TP.
Free Queue Counts the total number of packets available for network
communications. If this number stays below 10 for an extended period of time
(minutes), there may be a problem and you should consider resetting the panel.
Transmit Queue Counts the number of packets waiting to be sent out. This
number should normally be 0 or 1.
Application Stats
Total Sent Counts the total number of data packets sent from the BACnet
application code.
Total Received Counts the total number of data packets received from the
BACnet application code.
Invalid Received Counts the total number of errors in the BACnet protocol.
The fields for Setup below the Dataview change depending on the protocol on the
port that is selected in the dataview.
Parity is set to None. The Data Bits are set to 8 and the Stop Bits are set to 1. The
settings of these three parameters cannot be changed.
Current Connection This field displays the type of connection being used on
the PTP port, either Direct or Modem. The default connection is Direct, and the
controller automatically detects if there is a modem connected and will switch the
connection to Modem.
Modem Dial Retries This field defines the number of redial attempts. The
field accepts a value from 0-10. The default is 2 retries. This field is available only
if the current connection is Modem.
Modem Type The Modem Type drop-down contains a list of different types of
modems. The list includes: U.S. Robotics, Zoom, Boca, and Custom. Selecting a
Modem Type fills in the Modem Init String with the proper string. The
corresponding Modem Init Strings for the different Modem Types are:
Modem Init String The Modem Init String is sent to the modem whenever the
controller is reset and when the modem disconnects. The Modem Init String
initializes the modem to its proper settings. Therefore, it is important to use the
proper settings.
You can either select the type of modem from the Modem Type drop-down list or
manually enter the initialization string for your particular modem here. Refer to
your modem manual for more details. This field is available only if the current
connection is Modem.
Dial Prefix The Dial Prefix is sent to the modem whenever the controller is
attempting to make a modem connection. This field is available only if the current
connection is Modem. A The default Dial Prefix is:
ATDT
Note: The telephone number that the device will dial is specified in the RPS
object.
The telephone number that the device will dial is specified in the RPS object.
SUA for Direct Connect to 3rd Party Specifies the Password to check
when dialing into third party network.
This field specifies the local SUA object that is used to check the Password when
connecting directly to a third party device. This field is available only if the
current connection is Direct.
Note: The parameters available on this dialog will be fine in most situations. If
you have an unusual setup requirement, Customer Support can provide
instructions on how to change additional settings.
Network Stats
The fields for PTP Network Statistics are the same as those described for the
MS/TP in the Setup Tab: Statistics MS/TP section on page 9–110.
Application Stats
The fields for PTP Application Statistics are the same as those described for the
MS/TP in the Setup Tab: Statistics MS/TP section on page 9–111.
Network The Network spin box field sets the BACnet network number for this
interface. Different physical (or logical) BACnet network segments must have
different BACnet network numbers or a value of 0. In order for the network
segment to work properly, all devices on that segment must contain the same
Network Number. Each interface in the Dataview is given a different network
number.
If DNA is disabled by removing the DNA jumper or by turning DNA off then
network numbers must be manually assigned and must match for each device on a
particular network segment. The Network spin box accepts a network number
range of 0 to 65534.
Note: The Network Number spin box field is grayed out if DNA is enabled. The
DNA scheme automatically calculates the proper network number. If DNA is
disabled, then the Network Number field is available, and needs to be set to the
proper value.
Ethernet Address This field contains the physical Ethernet MAC address.
The MAC address is not the device number. It is the physical Ethernet address.
Network Stats
The fields for Ethernet Network Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 9–110.
Application Stats
The fields for Ethernet Application Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 9–111.
With the DSM-RTR only, a second UDP/IP adapter is available. UDP/IP-2 uses
the 30000 range for network numbers (3AASS). If there are any INet networks,
this may conflict with their network numbers. If this is the case, DNA should be
disabled and the network number for the UDP/IP-2 adapter should be manually
specified.
The following information is for when UDP/IP is selected in the dataview on the
Setup tab.
• Regular Devices can communicate with other controllers in the same sub-
network, but cannot communicate with controllers in other sub-networks
without the assistance of a BACnet Broadcast Management Device (BBMD).
• Foreign Devices are controllers which are isolated by themselves on a sub-
network which has no BBMD. These controllers can communicate with the
larger network by registering with a remote BBMD device on another sub-
network. The following paragraph explains BBMD devices.
• BBMD Devices operate as regular controllers, but are also responsible for
sending information from the sub-network that the BBMD is connected on to
other BBMD devices on other sub-networks. The remote BBMD then sends
the received information to the controllers in that sub-network. It is important
to note that only one controller on a sub-network can be designated as a
BBMD device. The other controllers must be set as Regular Devices.
UDP Port The port defines which UDP port number that UDP/IP
communication will use. The available range is 0 to 65535 with 47808 being the
default. These port numbers are assigned by Internet standard with 47808 being
assigned for the use of BACnet networks. It is important that this port number is
not changed arbitrarily as many of the other port numbers have other purposes that
would conflict with BACnet. All devices on the same UDP/IP network must use
the same Port number.
With a DSM-RTR, the second UDP/IP adapter will utilize a different UDP port
than the first, but it will still use the same IP address as the first; thus, the second
adapter can only be enabled if the first is enabled.
BBMD Address This setting is only needed when the Device Type field is set
to Foreign Device. A foreign device needs to know the IP address of a remote
BBMD in order to participate with that remote network. Any of the controllers
which are set as a BBMD Device could be referenced here.
Registration Timeout This setting is only needed when the Device Type field
is set to Foreign Device. This field is a time in seconds and is passed along to the
remote BBMD Device. This controller must confirm its existence with the remote
BBMD at this interval or the remote BBMD will assume that this controller no
longer wants to participate in the network.
A controller requests the use of an IP address from the DHCP server. The DHCP
server then allocates and assigns an IP address for the controller to use for a
particular amount of time. The period over which a network address is allocated to
a controller is referred to as a lease. The amount of time for the lease is
determined by the DHCP server.
The benefit of using DHCP is that it reduces the work necessary to administer a
large IP network. The alternative to using DHCP is manually entering the IP
Address, Subnet Mask, and Default Gateway information into the controller.
If the Use DHCP checkbox is checked, the IP Address, Subnet Mask, and
Gateway Address fields become unavailable since they are acquired using DHCP.
The Use DHCP checkbox is unavailable for BBMD controllers because they
require a static IP Address and cannot have a dynamic address.
IP Address Each device communicating by UDP/IP must have its own unique
IP (Internet Protocol) Address. The address is made up of four distinct numbers,
each of which have a range of 1 to 254. Normally, the site network administrator
provides the IP Address. It is important to note these addresses cannot simply be
‘made up’.
With a DSM-RTR, the IP address settings in the NET object are not displayed
under the second UDP/IP adapter (the DSM-RTR can only have a single IP
address).
Note: If a database is loaded into a DSC controller that doesn't match the
database's original address, then UDP/IP is disabled and Ethernet is enabled. If
UDP/IP is required on the controller, then the settings in the NET object (i.e. new
IP Address) must be set. If the database is reloaded into the original controller,
then UDP/IP is enabled with the settings that are in the database. This approach
avoids circular networks with multiple controllers having the same IP settings and
allows the same database to be loaded in multiple Ethernet DSC's. A DCU
behaves differently as it always disables UDP/IP whenever a database is loaded.
Subnet Mask Like the IP Address, this field also has four distinct numbers,
each of which have a range of 0 to 255. The subnet mask is used to determine
which other devices are on the same physical network segment, and which need to
be reached through an IP Router (Gateway). The most common subnets are
255.255.255.0 and 255.255.0.0. A subnet of 255.255.255.0 means that devices
whose IP address is different from this device in only the last of the four fields can
communicate directly to this device without the need of an IP Router.
For example, with the given subnet a device with an IP address of 192.168.1.1 can
communicate directly with another device which has an IP address of
192.168.1.20. Simplistically speaking, a 0 in the subnet means that devices with
IP addresses differing in this field can be reached directly. A 255 in the subnet
means that to contact a device with an IP address that is different in this field will
require the traffic to be first sent to an IP Router. Like the IP address, the Subnet
Mask would normally be supplied by the site network administrator.
Gateway Address This field also has four distinct numbers, and specifies
the IP address of the IP Router (Gateway) for this network. This field is only
required if two different networks need to communicate with each other. This
would be the case with a WAN. If required, this IP address is supplied by the site
network administrator.
Network The Network spin box field sets the BACnet network number for this
interface. Different physical (or logical) BACnet network segments must have
different BACnet network numbers or a value of 0. In order for the network
segment to work properly, all devices on that segment must contain the same
Network Number.
If DNA addressing is enabled, then the numbers are automatically computed and
this field is grayed out. The other option is to use jumpers or software settings to
enable the software addressing mode.
If DNA is disabled by removing the DNA jumper or by turning DNA off then
network numbers must be manually assigned and must match for each device on a
particular network segment. The Network spin box accepts a network number
range of 0 to 65534.
Note: The Network Number spin box field is grayed out if DNA is enabled. The
DNA scheme automatically calculates the proper network number. If DNA is
disabled, then the Network Number field is available, and needs to be set to the
proper value.
Outgoing Connection SUA This field allows the user to select the SUA
object that the device will use to verify against the SUA object on the remote
BBMD device. This setting is only needed if the device is attempting to log into
the network as a foreign device, and the remote BBMD device requires an SUA
Password Check.
Network Stats
The fields for UDP/IP Network Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 9–110.
Application Stats
The fields for UDP/IP Application Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 9–111.
Advanced
Maximums
BACnet Devices This value defaults to 100 and sets the maximum number of
other BACnet devices that the controller can communicate with. If you increase
the BACnet device’s value above 100, then more controller memory is used.
BACnet Routers This value, which defaults to 10, determines the maximum
number of BACnet routers that this controller can communicate with. A Delta
controller which is performing a routing function between two different network
interfaces would be included as one of these routers.
BACnet APDU
Max APDU Size This field, which defaults to 480 bytes, specifies the largest
size of an Application Protocol Data Unit that this controller can receive. If more
data needs to be transmitted to this controller at a single time than this value, then
the transmitting controller must break up the data into smaller pieces. This is
called 'segmentation'. The range of the value is 50 to 480 bytes. BACnet specifies
that all devices must support a minimum of 50 bytes.
Segment Timeout This field, which is very similar to the Retry Timeout,
specifies the time between re-transmissions of a single segment of a multi-
segment message. When messages between controllers are necessarily larger than
the Max APDU Size (see above), the message is broken down into multiple,
smaller segments. The default value is 5000 milliseconds.
BACnet Properties
Version This is the major version number of the BACnet protocol that is
implemented by this controller. Currently, Version 1 is the only one available.
Revision This is the minor version number of the BACnet protocol that is
implemented by this controller.
Local Network Number This value refers to the BACnet network that this
controller is locally connected to. The range of this number is 0 to 65534.
Essentially, all other devices which have the same Local Network Number can be
considered to be on the same 'logical' network. The only time this number would
have to be changed is if the network numbers for the individual interfaces are
changed.
MS/TP Slaves
This tab has a dataview which lists information about slave devices. See the Slave
Device List (SDL) object on page 9–158 of this chapter. The dataview has five
heading labels:
Device Number
Enter the device number of the slave device in this field.
Segmentation
Refer to the slave device’s documentation to determine what level of
segmentation the device supports, if any.
If the APDU portion of a message is larger than the maximum APDU value
supported by either of the devices participating in a conversation, the APDU
portion of the message may be broken into multiple segments where each segment
is sent in a separate packet.
Vendor ID
This field indicates the manufacturer of the slave device. Refer to the slave
device’s documentation to determine the vendor ID to use. If the vendor ID is not
specified in the documentation, use 0.
MAC Address
This field contains the network number and MAC address of the slave device. The
MAC address is not the device number; it is the physical MS/TP address. Refer to
the slave device’s documentation to determine the MAC address for the device.
Caution: The MAC Address field uses a format that requires care and
attention when entering its value. First enter a valid network number
followed by a comma and then the MAC address for the particular device.
The format of the MAC address differs depending on the physical media
used by the device (Ethernet, MS/TP, etc...).
Entering a MAC Address The value for this field begins with a network
number, followed by a comma and then the MAC address. For example, a MAC
address on network 2321 would start out with NET2321. The following examples
use network 50:
Supported devices include all Ethernet controllers except DCU, enteliTOUCH and
DAC-EC (Compact-Ethernet DAC) controllers.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
IP
The Dynamic Host Configuration Protocol (DHCP) is a network protocol for
automating the configuration of a controller that uses IP (Internet Protocol).
DHCP is used to assign temporary or permanent network (IP) addresses to
controllers and deliver configuration parameters such as the subnet mask and
gateway address. The controller automatically extracts its configuration from a
server called the DHCP server.
In a typical DHCP process, a controller requests the use of an IP address from the
DHCP server. The DHCP server then allocates and assigns an IP address for the
controller to use for a particular amount of time. The period over which a network
address is allocated to a controller is called a lease. The amount of time for the
lease is determined by the DHCP server.
The Use DHCP checkbox in the IP Tab of the IPS object is disabled (grayed out)
if the device is a BBMD and UDP/IP is enabled in the NET object. This is done so
that the availability of the DHCP checkbox in the IPS object matches the DHCP
checkbox in the NET object. DHCP cannot be used when the controller is a
BBMD device because they require a static IP Address and cannot have a
dynamic address.
When Use DHCP checkbox is unchecked or grayed out, IP address, Subnet Mask,
Gateway Address and User-denied DNS can be entered manually in the text boxes
by users.
IP Address
This field sets the IP address that the controller will use. Each device
communicating by UDP/IP must have its own unique IP Address.
192.168.1.10
Three different address classes have been created: Class A, Class B, and Class C.
Addresses which begin with a number in the range of 1 to 126 are considered
Class A, numbers in the range of 128 to 191 are Class B, and numbers in the range
of 192 to 223 are Class C. For example, 192.168.1.10 is considered Class C.
Addresses that begin with 127 or 224 - 254 are reserved for special purposes.
Currently, all supported controllers have only a single IP address even for the
device with 2 UDP/IP adaptors.
Subnet Mask
This field sets the subnet mask for the network to which the controller is
connected. A subnet mask uses the same four-part format as an IP address and is
written using the same dot format.
Subnet masks are used to separate the network that the device is connected to
from the device itself. Each device has a subnet mask associated with it. This
allows the device to know what other devices are its peers (on the same network),
and which devices are reachable only by a gateway or IP Router. Typically, a
subnet mask has only one of two numbers in each of its four positions: 0 and 255.
This is why these two numbers cannot be used to specify an actual IP address. A
very common subnet mask is the following:
255.255.255.0
This particular subnet mask specifies that devices which have the identical first
three numbers in their IP address belong to the same network. For example:
This means that these two devices can communicate without the need for a
gateway. However:
Therefore, for these two devices to communicate, at least one gateway will be
required.
If the subnet mask is 255.255.255.0, only 254 devices can be connected on the
same network. Remember, 0 and 255 cannot be used in an IP address. For some
networks this is insufficient, so three different classes of IP address (Classes A, B,
and C) were created, which each have their own subnet mask.
Gateway Address
This field sets the IP address of the site gateway or IP Router that is used to
connect with off-site devices. This field is only required if two different networks
need to communicate with each other. This would be the case with a Wide Area
Network (WAN). This IP address is supplied by the site network administrator.
Gateways are commonly used in WANs to join the individual Large Area
Networks (LANs) at each site to each other.
A gateway has the job of sending network traffic from one network (subnet 1) to
another network (subnet 2). A gateway uses the subnet mask of a packet to
determine if it should forward it to the remote network or not. If the destination
address of the packet is not in the local subnet, then the gateway or IP Router will
send the packet to the remote network.
However, for this to work, the local devices must be given the IP address of the
gateway. The device typically labels this IP address Gateway address or Router
address.
User-Defined DNS
This field defines the IP address of the Domain Name Server (DNS). The DNS
server looks up a name such as deltacontrols.com and associates an IP address
with it. The DNS server is required if you specify a name for the SMTP Server
such as mail.deltacontrols.net
DHCP: Section
A controller requests the use of an IP address from the DHCP server. The DHCP
server then allocates and assigns an IP address for the controller to use for a
particular amount of time called a lease.
DHCP:Server IP Address
This field shows the Server IP address that provides dynamic IP address to the
controller.
Email
The Email feature is used for event or alarm notifications which can be routed by
Event Router (EVR) object. The fields on this tab are hidden for Ethernet
controllers that do not support Email.
Note: Some SMTP Servers require that you use a valid email account in the From
field when sending emails. Check with your network administrator to ensure you
are using a valid email account.
SMTP Server
This field contains the address of the SMTP server. For example, an address might
be “mail.yourISP.com”. This field will also accept the IP address of the SMTP
Server (e.g. 192.168.1.200). Your network administrator can provide you with the
SMTP Server address. If you wish to enter the SMTP address in text format (e.g.
mail.yourISP.com), a User-Defined DNS must be specified.
You cannot use simple host names like “mail”. You must enter the Fully Qualified
Domain Name (FQDN) (e.g. "mail.deltacontrols.net") to your mailer, or email will
not work.
SMTP is short for Simple Mail Transfer Protocol which is a protocol for sending
email messages between servers. Most email Internet mail systems use SMTP to
send messages from one server to another. In addition, SMTP is generally used to
send messages from a mail client to a mail server.
However, you only need to specify the SMTP server in the controller and not the
POP or IMAP server since the controller is only able to send emails and not
receive them.
TCP Port
This field specifies the TCP/IP port number used by Simple Mail Transfer
Protocol (SMTP) server for the Email feature. By default it has a value of 25,
which is the standard port number for SMTP. It is recommended to check with
your server administrator before changing the port number.
Timeout
The Timeout defines how long the controller (email client) waits for the server to
respond. The default value is 10 seconds but it can be increased up to 600
seconds.
SNTP
This feature is supported only on certain types of controllers. The dialog fields on
the SNTP tab are hidden on Ethernet controllers that do not support STNP.
Server Address
This field provides the network address of a central NTP server. SNTP can
interpret NTP broadcast messages and synchronize time to a central server. The
internet has many public level-two time servers that can be specified for a server
located in your geographic area. The default SNTP URL is “pool.ntp.org” which
is a world-wide timeserver providing reliable NTP service.
Poll Interval
This field specifies the time interval between time synchronization of a client with
the central server. The Poll Interval has a range of 10 to 50000 minutes. The
default time interval is 781 minutes (13 hours + 1 minutes) which allows the
controllers to receive time on a different hour of the day each interval. Controllers
also have internal offset (device address MOD 31 minutes) on top of the time set
in the field.
In order to take DST in account when setting controller time, this setting must be
configured properly even though the checkbox is disabled by default.
• North American,
• European,
• Australian or
• Other DST time defaults.
This field defaults to North American. If the operator selects European then the
typical values for the European countries DST will appear in the DST fields. The
operator will still be able to modify the affected fields if there are slight
differences from the standard. If the operator does modify the standard, as soon as
APPLY is pressed the standard will change to OTHER. This will indicate to the
operator that the standard has been modified.
The purpose of DST is to conserve sunlight during the summer months. This is
accomplished by manipulating the clock time so that both sunrise and sunset will
take place at a later hour. This will have the effect of giving us one extra hour of
sunlight in the evening.
NORTH AMERICA:
Effective Hour - 2 AM
Offset - 60 Minutes
AUSTRALIA:
Effective Hour - 2 AM
Offset - 60 Minutes
EUROPE:
Offset - 60 Minutes
OTHER:
No set defaults. User can enter any option that they want.
For example if the DST start on the First Sunday in April (e.g. April 3) and the
"On and After" box is unchecked, DST will start on the 3rd of April. If however
"On and After" box is checked and the date selected in this field is 5, then DST
would not take effect until April 10. This type of DST algorithm is primarily used
in South American countries.
Devices
This tab has a dataview which lists devices that are currently communicating with
the controller.
In the first entry on the following screen capture, the network number is 20004
indicating communication with system controller 4 (400 DNA address) to the
Lighting Controller 9 (409 DNA address).
Device Number
Lists the device numbers of each device which is communicating with the
controller. BACnet allows the range of the Device Number to span between 0 and
4,194,302
MAC Address
This is the physical address of the device.
The format of the MAC address differs depending on the physical media used by
the device (Ethernet, MS/TP, etc...). The first digit which is enclosed in brackets
indicates the length of the MAC, in bytes.
Network Number
This value refers to the BACnet network that this controller is connected with
locally. The range of this number is 1 to 65534. Essentially, all other controllers
which have the same Local Network Number can be considered to be on the same
'logical' network.
Routing
This tab has a dataview which lists information about routing. The dataview has
three heading labels:
Network Number
Lists the device numbers of devices which are performing routing functions. The
range of the Network Number is 1 to 65534.
MAC Address
This is the physical address of the router which the controller uses to reach this
network.
Port
This value is the port from which the network is reachable. The values range from
1 to 8, and correspond to the Port numbers in the Net object.
Description
The Description tab is provided for the user to add descriptive comments. The
field can contain up to 2000 printable characters and has no bearing on the
execution of this object.
Setup
The Dataview at the top of this tab lists all of the available Network Interfaces in
the ID column. The Network Interfaces include Ethernet Network Settings,
IntelliNet Network Settings and Tunneling Network Settings.
For some fields, you need to do a logoff and logon sequence or to reset the
controller for changes to take effect.
Enabled The Enabled column contains one checkbox for each Network
Interface. When the checkbox is checked, this Network Interface will support
communication by the Version 2 protocol.
Route The Route column contains one checkbox for each Network Interface.
When checked, all incoming Version 2 traffic on this interface will be re-sent out
to any other interfaces which have their Route checkbox checked.
Stop HO’s (HO Block) The Stop HO’s (Highway Output) column contains
one checkbox for each Network Interface. When checked, all outgoing Version 2
traffic is blocked for this Network Interface. If a Stop HO checkbox is checked,
then HO data from the sub-networks is not allowed out onto the Network
Interface. If you use this feature, then in most cases, you would check all the
Network Interfaces to block all outgoing HO data.
This feature reduces network traffic when there are multiple V2 subnets joined by
V3 DCUs and data sharing is not needed between the V2 subnets.
If you change a Stop HO’s checkbox, after clicking Apply or OK, you must log
off/on again for the change to take effect.
Baud Rate
This is the communication speed between Point-to-Point (serial) devices.
Typically this would be the speed between the DCU and the operator workstation
or modem. The following speeds are available: 9600, 19200, 38400; with 9600
being the default. Both ends of a Point-to-Point connection must use the same
speed.
Parity Bit
Parity is a rarely used, marginally effective method of error detection. The options
are None (default), Even, Odd, Mark, and Stop. It is provided mainly for
compatibility with other BACnet devices which may insist on a certain type of
parity.
Stop Bit
The available options are 1, 1.5 or 2 stop bits, with 1 being the default. Like Baud
Rate, all that matters is that both ends use the same setting.
Data Bit
This is the number of actual data bits that will be sent in each frame of RS-232
data. The available options are 8 (default) and 7. 8 is almost universally used, with
7 only being used when Parity is also used.
Advanced
Maximum Panels
This value, which defaults to 100, is the maximum number of Version 2
controllers that this controller can connect to. This value is especially important
for the operator workstation, since having it set too low will hide some of the
Version 2 controllers from view. Setting this value too high will consume more
memory.
Stats
General
Registry Path
This is the description of the physical Ethernet interface in Windows' System
Registry. If two identical Ethernet interfaces are installed, this Registry Path is the
only way to distinguish one from the other.
Device Description
This gives a written description of the installed Ethernet interface. A DCU with a
DXC052-2 Ethernet expansion card will give a description of 'Delta PCNET
Adapter'. Ethernet cards installed in the operator workstation computer will report
their Windows name.
For settings on how this Ethernet interface can be used, see BACnet Protocol
Settings (BCP) starting on page 9–92 and Version 2 Protocol Settings (V2P)
starting on page 9–143.
Ethernet Address
This field displays the physical MAC address that the controller uses on the
Ethernet network.
In ORCAview 3.30, only DCU controllers can communicate with each other using
IntelliNet.
General
Registry Path
This is the description of the physical IntelliNet interface in the Windows System
Registry.
Device Description
This field gives a written description of the IntelliNet interface. A DCU with a
DXC052-1 IntelliNet expansion card will give a description of 'Delta IntelliNet
Adapter'.
For settings on how this IntelliNet interface can be used, see BACnet Protocol
Settings (BCP) starting on page 9–92 and Version 2 Protocol Settings (V2P)
starting on page 9–143.
General
Registry Path
This is the description of the Tunneling interface in the Windows System
Registry.
Device Description
This field gives a written description of the Tunneling interface.
UDP/IP, which stands for User Datagram Protocol / Internet Protocol, is part of
the Internet's TCP/IP protocol suite. It is a method by which controllers and
operator workstations at different physical locations that are connected by a Wide
Area Network (WAN), can communicate with each other. UDP/IP is conveyed by
Ethernet hardware. Only BACnet network traffic can be carried over a UDP/IP
connection. To send Version 2 traffic, Tunneling is required.
Note: In 3.22/ 3.30, Area controllers no longer pass DNA information over a
UDP/IP connection. Only the Network Number is passed. This approach
eliminates possible DNA addressing problems with DAC devices connected to the
Area Controllers.
General
Registry Path
This is the description of the UDP/IP interface in the Windows System Registry.
Device Description
This field gives a written description of the UDP/IP interface.
Setup
IP Address
Each device communicating by UDP/IP must have its own unique IP (Internet
Protocol) Address. The address is made up of four distinct numbers, each of
which have a range of 1 to 254. Normally, the site network administrator provides
the IP Address. It is important to note these addresses cannot simply be 'made up'.
Subnet Mask
Like the IP Address, this field also has four distinct numbers, each of which have
a range of 0 to 255. The subnet mask is used to determine which other devices are
on the same physical network segment, and which need to be reached through an
IP Router (Gateway). The most common subnets are 255.255.255.0 and
255.255.0.0. A subnet of 255.255.255.0 means that devices whose IP address is
different from this device in only the last of the four fields can communicate
directly to this device without the need of an IP Router. For example, with the
given subnet a device with an IP address of 192.168.1.1 can communicate directly
with another device which has an IP address of 192.168.1.20. Simplistically
speaking, a 0 in the subnet means that devices with IP addresses differing in this
field can be reached directly. A 255 in the subnet means that to contact a device
with an IP address that is different in this field will require the traffic to be first
sent to an IP Router. Like the IP address, the Subnet Mask would normally be
supplied by the site network administrator.
Gateway Address
This field also has four distinct numbers, and specifies the IP address of the IP
Router (Gateway) for this network. This field is only required if two different
networks need to communicate with each other. This would be the case with a
WAN. If required, this IP address is supplied by the site network administrator.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
General
Registry Path
This is the description of the Serial Port in the Windows System Registry.
Device Description
This field gives a written description of the Serial Port.
Setup
COM Port
This field sets which actual Communications (COM) port this serial interface will
use. The available settings are Com1 through to Com4. For an operator
workstation, this sets which of the available COM ports will be used for
communication with the system. This is typically either Com1 or Com2. For a
DCU, the available options are Com1 and Com2, which are the serial ports on the
DCU, and Com3 which is the RS-485 port used to communicate to Micros, Zone
Controllers, and other 485 devices.
Modem Reference
The field selects if a modem is connected to this Serial Port, and if so, which
Modem Setup (MDS) object to use. By default, SNS1 does not have a modem
reference, and therefore supports direct connections. SNS2 has a default modem
reference, and therefore support a modem connection.
Total Retries
This is the number of times the controller will attempt to connect to the remote
end before giving up.
Answer Timeout
The remote end is expected to answer within this time, or the modem will give up
and hang up. The default of 50 seconds should be sufficient under most
circumstances.
Redial Delay
This is the time, in seconds, to wait before attempting to redial after an
unsuccessful connection attempt.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
An MS/TP slave device cannot send network responses and as such cannot
respond to network requests. This means that a slave device cannot be
automatically found. Therefore any device that needs to communicate with a slave
device must be manually configured.
The Slave Device List tells other devices that there is a slave device at a particular
address.
The previous figure shows an MS/TP MAC address 34 on net 20031 that is
entered as:
Net20031,34
The MS/TP Slaves tab of the BCP or NET object on the local controller would
automatically include the Slave Device List entry shown in the previous figure.
MS/TP Slaves
This tab has a dataview which lists information about slave devices. The dataview
has five heading labels:
Device Number
Enter the device number of the slave device in this field.
Segmentation
Refer to the slave device’s documentation to determine what level of
segmentation the device supports, if any.
Vendor ID
This field indicates the manufacturer of the slave device. Refer to the slave
device’s documentation to determine the vendor ID to use. If the vendor ID is not
specified in the documentation, use 0.
MAC Address
This field contains the network number and MAC address of the slave device. The
MAC address is not the device number; it is the physical MS/TP address. Refer to
the slave device’s documentation to determine the MAC address for the device.
Caution: The MAC Address field uses a format that requires care and
attention when entering its value. First enter a valid network number
followed by a comma and then the MAC address for the particular device.
The format of the MAC address differs depending on the physical media
used by the device (Ethernet, MS/TP, etc...).
Entering a MAC Address The value for this field begins with a network
number, followed by a comma and then the MAC address. For example, a MAC
address on network 2321 would start out with NET2321. The following examples
use network 50:
INTRINSIC ALARMING (AI, AO, BI, BO, MI) [NEW 3.40] ............... 10–462
INTRINSIC ALARM TEXT TAB (AI, AO, BI, BO, MI) [NEW 3.40] .. 10–476
INTRINSIC ALARMING (AI, AO, BI, BO, MI) [NEW 3.40] ................ 10–462
INTRINSIC ALARM TEXT TAB (AI, AO, BI, BO, MI) [NEW 3.40]... 10–476
SETUP............................................................................................................. 10–728
USER DATA .................................................................................................... 10–731
LOGIN ............................................................................................................ 10–736
OBJECT OVERRIDES ....................................................................................... 10–738
SECURITY USER GROUP (SUG) ........................................................... 10–741
DESCRIPTION TAB .......................................................................................... 10–741
OBJECT SECURITY TAB .................................................................................. 10–742
USING DEFAULT SUG OBJECTS ..................................................................... 10–745
TREND LOG – BACNET (TL).................................................................. 10–746
HEADER ......................................................................................................... 10–747
GRAPH ........................................................................................................... 10–748
SETUP............................................................................................................. 10–749
DATA ............................................................................................................. 10–756
DESCRIPTION ................................................................................................. 10–757
VIEW GROUPS (VGS) .............................................................................. 10–758
MAIN ............................................................................................................. 10–758
CUSTOM VIEWS ............................................................................................. 10–761
ZIGBEE WIRELESS DEVICE (WSD) [NEW 3.40]................................ 10–774
You can access context sensitive help for each object dialog by pressing F1 or the
? (Help) button in the lower right corner of a dialog.
OVERVIEW
This chapter provides reference information about the Delta Controls objects.
DCU and DAC Features With the 3.30 ORCAview release, the capabilities
of the Delta Application controllers (DACs) have been expanded to include many
features previously found only on a DCU. The DAC controllers now fully support
objects such as MI, MIC, TL, MT, and SCH. The DAC controllers can now do
expanded alarming, routing and data exchanging. We now use the term controller
so that it includes both DCU and DAC controllers. Both DSC and DAC
controllers are part of the DAC product line. We emphasize the remaining
differences between DCU and DAC products in our documentation.
The word object is used to describe software features and functions which were
previously called points. By using the word objects instead of points, Delta
Controls provides a more exact terminology that is more in-line with modern
software systems.
In software, an object provides a limited and discrete function with defined inputs
and outputs. The graphical elements of Delta Controls software reflect this
definition in that they provide limited, discrete and precise control of specific
functions.
System Objects
System objects are not required by the operator on a regular basis. They are used
in areas of translation, presentation, storage of data and network and alarm
configuration. The following is a list of some common System Objects:
Overview
The Access Control Alarm Log (EVL) object provides a method of recording a
history of alarms. The EVL is a local object that is automatically created on the
Access System Manager (ASM). When using a DAC, DSC or DCU as your
System Controller, the EVL is automatically created when the Access Door
Module (ADM) is connected.
The EVL stores all alarms as specified in all Door Controller (DC) objects on the
ASM. For further information on the various alarms that can be generated, see the
information for the Alarms tab on the Door Controller (DC) object. The EVL
constantly monitors each Door Controller object for new alarms. All alarms from
the EVL are broadcast to the EVL on each ASM on your network. To avoid the
broadcasting of the alarms, set the EVC on each ASM to “not broadcast” the
alarms.
The EVL can automatically update to Historian if you have Historian set up on
your network, and you have configured it to do so. You must be broadcasting
events for historian to log them. This allows you to generate various types of
reports. For further information on using Historian and generating reports, see the
ORCAview Technical Reference Manual – Chapter 6 – Trending and Archiving
Data.
Event Log
The Log tab contains the entries of alarm notifications that were routed to the
Access Control Alarm Log from the Door Controller object. The EVL defaults to
store 25 alarms, and can hold as many as 100, depending on what you have
specified as the Maximum Log Entries in the Setup tab.
Top Dataview
The top Dataview is the main log. It displays alarms in chronological order. Each
transition is displayed in the top Dataview. Once an entry is highlighted the
bottom area will give more details about the entry.
Alarm Input The alarm input for the event that transitioned.
Time and Transition This column indicates the time of the transition as well
as the specific transition that occurred.
Alarm Type The monitoring algorithm used in the event to monitor the alarm
input object.
Alarm Input Value Value of alarm input that caused the transition.
Event Class This indicates the class that the alarm is a member of.
Setup
Name
Name is used to describe the Access Control Alarm Log, and what it is logging. It
is a descriptive label given to the object. The name must be unique among the
other descriptors located on the same controller. The name is limited from 1 to 67
printable characters.
Reliability
This property provides an indication of the status of the object regarding reliability
of data. This property will have one of the following values at any given time:
LINKnet Offline This indicates that the Door Module (ADM) associated with
the door controller is offline.
Missing cfg Object This indicates that there are missing parameters, or that
the referenced input or output is missing.
Not Available This is Delta’s proprietary reliability code, which indicates that
the output does not physically exist in the Door Controller object.
Once the logged alarms reach the maximum size, the oldest alarms are deleted,
allowing for new alarms to be added to the Log tab.
Historian Note: This field is not adjustable for EVLs created on the Historian
Device. EVLs on Historian can hold a theoretically unlimited number of events.
Warning: Adjusting the Maximum Log Entries value will result in the Event Log
being reinitialized and all entries being removed.
Event Class The Event Class drop-down box allows the notification's event
class to be chosen. The choices available reflect the EVC's that are in the
controller. When the threshold is exceeded, a notification dialog displays if the
Event Class has Operator Acknowledged enabled for "Return to Normal"
transitions.
Threshold The Threshold field specifies the number of log entries recorded
before an event occurs. When the number of records is exceeded, the threshold
count is reset. Another event will occur if the number of records exceeds the
threshold value. This setting causes an event to occur at multiples of one plus the
threshold value. For example, if the Threshold is set to 5, then an event occurs at
6, 12, 18, etc. record counts.
Records Since Last Notification The Records Since Last Notification field
shows the number of samples since a notification was issued.
HVAC/Access/Lighting Checkboxes
These checkboxes are used to indicate which application(s) the object is being
used for. Any combination of HVAC, Lighting and Access Control can be
selected. Leaving all checkboxes blank is the same as checking them all. For
more information, see the section on Security in the SUG/SUA objects.
Alarm Filtering
The Alarm Filtering tab allows you to monitor alarms that have been
acknowledged or any other Events or Event Classes you would like to log. These
Logs can be sent to Historian, where you can generate reports specific to your
requirements. For further information on using Historian and generating reports,
see the ORCAview Technical Reference Manual – Chapter 6 – Trending and
Archiving Data.
Log Acknowledgements When this checkbox is checked, every time an
alarm pops up and the operator/user acknowledges the alarm, it is logged. Using
Historian, you can now view a list of all the alarms that have been acknowledged.
Schedule Reference Entering a schedule here allows you to specify when
you want to log alarm acknowledgements. When the schedule is ON,
acknowledgements will be logged, and when the schedule is OFF, they will not. If
there is no schedule, acknowledgements will be logged all the time.
The fields in the Class and/ or Events to Log section provide a way to filter the
Alarms / Events that are logged by the EVL object.
The Classes/Events to log are entered in this field. Any specified alarms or
notifications from alarms which reference an Event Class found in this
Class/Event list are logged.
Class / Event The user selects or enters the class of alarm notifications that are
to be logged to the EVL.
The user may also enter the Remote Events. The choices in the dropdown include
all the EVCs and EVs that are in the controller.
Since Event classes of the same instance in all devices must be the same
(100.EVC1 == 200.EVC1), if EVC1 is referenced in the Event Log as a class of
alarms to log, then all Events of that class, regardless of which device they
originate from, are logged.
This field specifies which events to log based on transitions defined in the Setup
and Destination List tabs of EVC objects. Event objects use EVC objects to
specify behavior based on the assigned Event Class.
Transition Bits
The available options for the Transition Bits field are To Alarm, To Fault and To
Normal. If you double click on an entry within a selected row, then an Edit Values
dialog appears. Modify the selected values and then click OK.
Min Priority
The Min and Max Priority fields work together to specify events to log.
The range of this field is from 0 to 255 with a default value of 0. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected value by clicking on one of the arrows or by entering a value
into the field.
The Priority for the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Max Priority
The Min and Max Priority fields work together to specify events to log.
The range of this field is from 0 to 255 with a default value of 254. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected value by clicking on one of the arrows or by entering a value
into the field.
The Priority that the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Event Flag
The available options are Ack Req, Ack Not Req and Send Ack. If you double
click on an entry within a selected row, then an Edit Values dialog appears.
Modify the selected values and then click OK.
Description
Overview
The Access Control Setup (AS) object is used to set up the access control system
parameters of the controller it is in. The only valid instance for an AS is 1. In an
Access System Manager (ASM), it is created automatically. In the DSC and
eBCON products, it is created when the first ADM is connected.
When the controller comes online or if site information is changed, all Site Codes
information as well as the PIN Size and the Degraded Mode Pulse Time
information are automatically sent to the Access Door Module(s) from the Access
Control Setup (AS), Door Controller (DC) and Card Reader (CR) objects. This
information is also sent when an ADM comes online or is powered up to ensure
all settings are current.
Description
The Description field can contain up to 2000 printable characters.
The Description field will often be used for a detailed functional definition. For
the Access Control Setup, the Description field would typically describe any
information pertaining to the controller it exists in, and the parameters it defines.
Setup
Name
Name is a descriptive label given to this object. Although it is not necessary, the
name should be unique within the BACnet network. The name must be unique
among the other descriptors located on the same controller. Name is limited to 67
printable characters.
PIN Size
PIN Size is the length of the PINs entered by card users at keypads in the access
control system. This setting applies to all the card user (CU) objects in the ASM.
PIN Size must be entered before any CU object PINs are entered or problems with
the users PINs can occur. PIN Size defaults to 4. If a longer PIN Size is desired,
be sure to change this setting before creating card users.
When you change the PIN Size within the AS object, you must go to each CU
object and update the size of the CU’s PIN length to match the PIN Size in the AS
object.
Note: If the CU objects have not been updated to the PIN Size, no match will be
made when searching for a card user’s PIN.
The maximum PIN size that the ASM can handle is 9 digits. Keypads using the
26-bit Wiegand format allow a 4 digit PIN only. The PIN Size has a lower limit of
1 digit. For security reasons, it is recommended to use a minimum of 4 digits as
PIN Size.
When a PIN which is fewer digits than the PIN Size setting is entered into a CU
object, it is assumed that the missing digits are filled with zeros. For example,
when the PIN Size is 4 and a user’s assigned PIN is 1, the user would have to
enter a PIN of 0001 into the keypad.
Example
The Front Entrance ADM is not communicating with the ASM and someone
presents a card and is granted access to the door. Assuming that Degraded Mode
Pulse Time is set to 15 seconds, then the door is pulsed unlocked for 15 seconds.
Anti-Passback
Scheduled Reset Reference The System Programmer/User can enter in a
valid Scheduled Reset Reference or Binary Output (BO), Binary Input (BI),
Binary Value (BV), which when it turns On causes an Anti-passback Local Reset
in the controller. This resets all CU APB details when the object goes on. The
reference to the object can be either local or remote.
Example
Within the AS object, there can be a scheduled global reset at the end of every
day, so that anyone who left the building without swiping out can re-enter the next
morning.
Local APB Reset The operator can globally reset all the current anti-passback
information in all the Card Users (CU) on the ASM by pressing this button. It will
run through all the CU objects, resetting the anti-passback status for each object.
Example
Local APB Reset would be used if there were a fire drill and everyone had to
leave the building without having the opportunity to present their credential to exit
properly and therefore causing anti-passback errors. Anti-passback would be reset,
allowing the people to re-enter.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Site Codes
The operator enters one or more site codes for cards to be used by the ASM when
ADMs are operating in degraded mode. The site codes are transmitted to the
ADM for use when in degraded mode when the ASM is reset. Site codes are sent
to the ADMs only when an ADM comes online or the site codes are changed in
the AS object.
If you do not using degraded mode, then do not enter site codes. You can always
configure doors on a door-by-door basis from the CR objects.
Site codes can have a range of 0 to 4294967294. You can use 10 site codes only
on an ASM.
Overview
To eliminate the need to assign access rights for each individual card user, access
rights are assigned using an access group. All card users assigned the same access
group are granted access at same doors and elevators at the same scheduled times.
Description
The Description field may contain a character string of up to 2000 characters in
length. The character string is limited to printable characters.
The Description field is often be used for a detailed group definition.
Setup
Name
Name is a descriptive label given to this object. The name must be unique among
the other descriptors located on the same controller. To name the AG object, enter
up to 67 printable characters. Typically, the AG object name describes or
identifies the role that the group performs in the organization, for example,
custodians, employees, managers and so on.
Door List
Use the Door List area to associate doors and door groups with a schedule to
define when and where credential presentation triggers the access granted / denied
decision for card users who are assigned the access group.
Door/Door Group A list of doors (DC objects) and door groups (DG objects)
that defines the area or zone associated with the access group.
To add a member to the door list or to remove a member, double click on the
white space in the Door List area to display the Select Door/Door Groups dialog.
The Select Door/Door Groups dialog provides two methods for adding a door or
door group to the Door List:
Select one or more doors or door groups from the list titled Select Door/Door
Group and click >>
Type the object reference in the form Device ID.object instance in the field titled
Manually enter an object reference below; for example, 3400.DG2, and click
Add. This method allows you to add a door or door group that can’t be found
on the network so you can engineer the database when the complete network
is not available.
Click OK to add the doors and door groups listed in the area titled Current
Door/Door Group Selections.
Schedule The schedule defines when credential presentation triggers the
access granted / denied decision for associated doors. Enter a SCH object to
specify when card users who are assigned this AG object will be granted access to
the corresponding area or zone.
Enter a SCH object or a wildcard as follows:
When a SCH object is entered, then access is granted during the scheduled hours.
When a SCH is On, access is granted and when it is Off, access is denied.
When the schedule is left blank or wildcard, then access is granted at all times. A
blank field indicates a wildcard.
If the SCH object does not exist, access is never granted as the missing schedule is
viewed as being in a permanently Off state.
A Calendar (CAL) object can be linked to the SCH object when dealing with
holidays, overrides, etc. See the Schedule and Calendar documentation in the
OWS Technical Reference Manual for details.
IT personnel need access to the server room and building entrance so that they can
respond to emergencies at all hours. IT employees are assigned the IT Employees
access group, as shown below. The All Hours Access schedule is set up to be On
24 hours per day, seven days per week.
Access during specified times This example shows how access rights are
configured to allow card users to be granted access to the doors for specified time
period only.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Elevator Setup
Use the Elevator Setup tab to define the access rights for elevators.
Floor List
Floor List defines the floor buttons or landing numbers that card users who are
assigned the access group have access to and when access is granted.
To add a member to the floor list or to remove a member, double click on the
white space in the Floor List to display the Select Elevator Controller dialog.
The Select Elevator Controller dialog provides two methods for adding an
elevator and landing to the Floor List:
• Select an elevator controller from the list titled Select Elevator Controller,
select one or more numbers from the list titled Select Landing Number and
click >>
• Type the object reference in the form Device ID.object instance and Floor
number in the field titled Manually add an Elevator Reference below; for
example, 3400.EC2, and click Add. This method allows you to add an
elevator controller and floors that can’t be found on the network so you can
engineer the database when the complete network is not available.
Click OK to add the elevator controller and floors listed in the area titled Current
Elevator Controllers Selections.
For a shortcut method to add all floors, enter the EC object reference and floor
number = 0 in the fields titled Manually add an Elevator Reference below, and
click Add. In the Floor Name column, ALL FLOORS is displayed.
To remove an EC object and landing from the door group, select the EC
object/landing number in Current Elevator Controllers Selections and click <<.
Elevator EC object to which card users who are assigned the access group have
access. Wildcard entries are not valid. The EC object must be an existing, valid
object.
Landing Number number associated with the floor to which card users who
are assigned the access group have access. Landing Number = 0 means all floors.
Floor Name The Floor Name associated with the Landing Number as defined
in the EC object is displayed when Apply is clicked.
Schedule defines when credential presentation triggers the access granted /
denied decision for associated floor. Enter a SCH object to specify the times when
card users who are assigned this AG object will be granted access to the
associated floor.
Enter a SCH object or a wildcard as follows:
When a SCH object is entered, then access is granted during the scheduled hours.
When a SCH is On, access is granted and when it is Off, access is denied.
When the schedule is left blank or wildcard, then access is granted at all times. A
blank field indicates a wildcard.
If the SCH object does not exist, access is never granted as the missing schedule is
viewed as being in a permanently off state.
The Calendar (CAL) object can be linked to the SCH object when dealing with
holidays, overrides, etc. See the Schedule and Calendar documentation in the
OWS Technical Reference Manual for details.
Exceptions
Use the lists in the Exceptions tab when you want to override the AG object’s
Door List.
Group Exceptions
Group Exceptions define the exceptions that apply to all card users who are
assigned this access group. Group Exceptions are exceptions to the access group’s
Door List. These exceptions either extend card users access rights by adding a
door or by extending a door which already exists in the Door List; or restrict the
card user access rights, restricting access to a common area for a certain time
period. The Group Exceptions override the Door List. For the order of precedence,
see below.
Exceptions should be used with caution as they can make it difficult to determine
why someone does or doesn’t have access. The best solution is usually to create
another AG object.
Door/Door Group Enter a DC object or DG object reference, to which card
users who are assigned this access group will have access exceptions. The door
may already exist in the Door List, or it can be a new door. Wildcard entries are
not valid.
Schedule Enter a SCH object that specifies the times you want the card users
who are assigned this access group to have access to the corresponding DC object
or DG object to be denied or extended. If the SCH is on, then access is granted.
User Exceptions
User Exceptions grants or restricts access for individual card users who are
assigned this access group. User Exceptions can be defined to give an individual
in the group access rights that the others don’t have, or to suspend access for a
user. This can be done for doors, which already exist in the Door List, or doors
that do not exist in the Door List. User exceptions override group exceptions. For
an order of precedence, see below.
Card User Enter CU objects for card users who are assigned this access group
and for whom the exception applies.
Door/Door Group Enter a reference to an existing Door Controller (DC) or
Door Group (DG) for which this exception refers to.
Schedule Enter an existing schedule (SCH) specifying the times you would
like the Card User’s (CU) access to the corresponding Door Controller (DC) or
Door Group (DG) to be suspended. If nothing is entered, it defaults to a blank. If
the schedule is left blank or wildcard, then access will be granted at all times.
Note: When the SCH is on, access is granted, when there is no SCH or the SCH is
off, access is denied.
The Calendar (CAL) object can be linked to the SCH object when dealing with
holidays, overrides, etc. See the section on Calendar and Schedule objects.
Enter the CU object reference in the User Exceptions List for the card users you
want to grant access for.
Enter the DC and DG objects you want to set the access for.
Enter the SCH object reference with the associated On and Off times for user
access.
List Precedence
The three lists you define in an AG object work together only for that object and
with following precedence levels.
The first and any instance of access rights that grant access to a card user will
grant access for that DC object or DG object. No other groups will be searched. If
access rights are not found, or if access has been denied in the first group, then the
next AG will be searched for access.
A DSC / DAC contains from 3 to 16 universal inputs depending on the model that
can be used with AI objects.
See Appendix E – Working with MS/TP and LINKnet for a discussion of using
LINKnet AI objects.
When a controller object is saved from one controller and loaded into another, the
controller with the loaded object needs to be reset. It is not sufficient to reset only
the loaded object. This issue applies particularly to an input or output (I/O)
object. For example, if an Analog Input (AI) or Analog Output (AO) object is in
manual, and in fault, and is saved as a pob, then the object will remain in fault
when loaded into another controller. To ensure proper function of the new object,
you must reset the controller. Since I/O objects are typically not copied from one
controller to another, this issue is typically not a concern.
This object supports the BACnet Intrinsic Alarming. See page 10–462 for an
overview.
Header
The header also displays icons in the upper right area of the header to indicate the
status of the object:
The Commissioned icon (a lock) indicates that the object has not
been field commissioned.
When the Commissioned checkbox in the Device tab is checked,
then the Lock icon is removed from the header and does not
display in Navigator.
For a controller, the Auto icon (a computer) may display in the
upper right area of the header shows that the HOA switch of the
module for this object is in the Auto position.
For a controller, a Hand icon (HOA - Hand) in the upper right
area of the header shows that the HOA switch for this object is in
the Hand position. Navigator also displays HOA icons in OFF
and Hand columns for objects in the Details view.
HOA present
HOA - OFF
Value
The present value of the Analog Input Object is displayed in this field. The value
is calculated based on the sensor value and the Analog Input Configuration (AIC)
Object that was selected for this input. The value is restricted within the maximum
and minimum values defined in the AIC object.
For Delta devices the Analog Input Configuration Object defines the relationship
between the input voltage and how this voltage represents the process variable.
The Engineering Unit designation displayed by the Analog Input Object is derived
from the AIC Objects as well.
The present value can be viewed in either a fixed point or floating point mode. In
fixed point mode the value will be displayed with the number of decimal places
specified in the Decimal Places field of the Setup tab.
When viewing other vendors’ equipment, Present Value may take any signed real
number value, with decimal places and Engineering Units as assigned by their
Object.
Object Mode
Auto The displayed Present Value is automatically converted from an input
voltage based on the type of sensor connected to this object.
Manual The input voltage is not measured. The last Present Value—or any
value that is entered (within the AIC Min/Max range)—remains until the object is
returned back to Auto. The status indicated shall be “Out of Service”.
As soon as the Manual mode of operation is enabled a spin control opens up to the
right of the Manual button. This spin control is used to allow the operator to enter
an override value.
Sensor
The sensor must have been created previously as an Analog Input Configuration
(AIC) Object. The AIC Object should be created on the controller that the input is
connected to.
If the field is left blank, the voltage at the input is converted to a number from 0 to
100 corresponding to the 0 to 5 volts at the input.
Description
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the Input Object. It may include all relevant
facts pertaining to use, configuration, setup, calibration, wiring, limitations, sensor
location, warnings, etc. In general, any information useful in the installation and
maintenance of the Device could be included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Fixed Point
BACnet values are stored as Real numbers. Real numbers in version 3 go from –
1038 to +1038 and from as small as 1.17549x10-38. A floating point number will
show a maximum of six significant digits with an exponent that can go as high as
1038. Seven significant digits are stored internally for the process of rounding.
This means that the largest number that can be displayed is 3.40282x1038. The
smallest number is 1.17549x10-38.
By selecting Fixed Point, the values on the dialog display the set number of
decimal places. The dialog will automatically round the number to the correct
decimal place.
Calibration
The value entered in this field is added to the value obtained from the associated
AIC Object and is used as an adjustment in the calculation of Present Value. This
will offset the error seen by the controller and make it correspond to the actual
value as measured by a calibration device.
Example If the display was reading 74.3F when a calibration thermometer was
reading 74.0F, a calibration value of -0.3 adjusts the value on the display to 74.0F
to match the calibration thermometer.
Decimals
The value entered in this field allows the operator to set the number of decimals
that display on the dialog. The choice is from 0 to 9 decimal places. The object
value has a restriction of only displaying 6 significant digits so as the number
becomes larger (using more places to the left of the decimal) zeroes will be used
to fill up the specified number of decimal places.
Filter
This field contains a software filter from 0 to 99 (default 80). When the value is
increased, noise that is generated at the input is filtered out. If a filter of 100 is
entered, it is limited internally to 99.
The equation for the filtered value based on the new Object Value, last value, and
the filter is as follows:
Filtered Value = Last Value + [(100 - Filter)/100 * (new input - last value)]
Example
Last Value = 20 Filter = 80 New Input Value = 24
The filtered value after the first scan will be:
Filtered Value = 20 + [(100 - 80)/100 * (24 - 20)]
Filtered Value = 20 + [(0.2 * (4)]
Filtered Value = 20.8
The rate of the filter application is adjusted based on the scan rate of
approximately once per second.
Last Value
This value is used in the filter calculation and it represents the new value, before
filtering, used in the filter calculation of Present Value. The LastValue property is
not guaranteed to be accurate or meaningful when the object is in manual mode.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Sensor
Commissioned
This is a check box which tells the operator whether or not the Object has been
field commissioned. This field affects Alarm generation: when the object is de-
commissioned, Event objects that monitor this object will not transition and
no alarm notifications will be generated for that event.
Reliability Codes
This property provides an indication of whether the present value is reliable. If
any reliability other than No Fault Detected is present, a Wrench Icon will appear
in the object header. This property will display one of the following values at any
given time:
Over Range – The physical input has returned a value greater than the Maximum
Value specified in the referenced Analog Input Configuration Object.
Under Range – The physical input has returned a value less than the Minimum
Value specified in the referenced Analog Input Configuration Object.
Open Loop – The input is in the Over Range state and the A/D value is greater
than or equal to 4083.
Shorted Loop – The input is in the Under Range state and the A/D value is less
than or equal to 12.
Other Fault – Some unspecified error occurred while trying to configure the
input/output.
Not Available – This Delta’s proprietary reliability code indicates that the input
does not physically exist. (Baseboard or Expansion Board not connected to the
DCU).
Missing CFG Object – The AIC, AOC, BDC, MIC, or MOC that is referenced by
the object does not exist.
LINKnet Offline – The LINKnet device associated with this object is offline.
Sensor Type
For Delta equipment, sensor type offers a drop down selection list of the Analog
Input Configuration (AIC) Objects that are available for assignment to this Input.
Upon selection, the scaling information is established for this Input. It defines,
also, the Engineering Units applicable to Present Value.
For non-Delta equipment, Device Type offers the name of their Device Type,
which defines: the physical Device connected to their Analog Input Object.
Sensor Units
Other manufacturers generally hold this information within the Analog Input
Object.
A/D Value
This displays the current A/D value of the physical analog input. This is a
proprietary property for Delta Controls. The range of the A/D is from 0 to 4095.
Resolution
This displays the smallest change in the value of the object that will result in a
change of the A/D value. For linear scale ranges, it is calculated as follows if Min
is 0V and Max is 5 V in the AIC:
Alarming (Intrinsic)
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Intrinsic Alarming tab starting on page 10–464provides a way to
configure basic alarm and event features within an object.
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Alarm Text tab starting on page 10–476 allows a message to be
specified for the Alarm, Fault, and Return to Normal transition messages.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
On Delta Controls hardware, an input can read resistance, current, 0-5 VDC or 0-
10 VDC type signals. However each input regardless of the type, is converted
internally to a 0-5 VDC signal. The AIC Object works with 0-5 VDC for all signal
types.
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Units
Sensor Units indicates the selected BACnet Engineering Unit applicable to the
input sensor being monitored. The BACnet Engineering Units are a
comprehensive list of units that are normally applicable to the HVAC industry.
This list was designated by the BACnet committee.
For non-Delta systems, the assignment of Engineering Units for display with
Present Value is normally obtained directly from the Units Property of their
Analog Input Object.
Indicates the Maximum Expected Value for the input sensor. It is the largest
object value in the Aid’s scale range. The unit that is displayed beside this value is
the BACnet Engineering Unit associated with this AIC.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Scale Range
On Delta Controls hardware, an input can read resistance, current, 0-5 VDC or 0-
10 VDC type signals. However each input regardless of the type, is converted
internally to a 0-5 VDC signal. The AIC object works with 0-5 VDC for all signal
types.
The Scale Range uses a linear equation to calculate the values from the input
voltage. If you only enter two (voltage, value) pairs the Scale Range will linearly
calculate the value points located between the two voltage endpoints.
A very large number of (voltage, value) pairs can be entered into the scale range.
Memory usage for the object increases as you enter more data pairs up to a 64
Kbytes limit. To replicate a sensor characteristic that follows a curve, you would
have to enter a sufficient number of small (voltage, value) steps. This would have
the effect of producing a scale range that approximates a curve even though it was
actually made up of numerous straight lines connected together.
A linear sensor requires two value pairs; one pair for the smallest voltage, and one
pair for the maximum voltage. A minimum of two value pairs must be entered.
The scale range is auto sorting with reference to the voltage axis. If you add a
value pair to the graph that would logically be within existing values, when you
apply the change, the (voltage, value) will move to its proper position in the graph
(according to voltage magnitude).
To delete a (voltage, value) pair simply highlight the pair you would like to
remove (single left click on the line – it will highlight) and press the delete key.
Value
With reference to the voltage above, enter the corresponding value specified in the
engineering units of choice.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
When a controller object is saved from one controller and loaded into another, the
controller with the loaded object needs to be reset. It is not sufficient to reset only
the loaded object. This issue applies particularly to an input or output (I/O)
object. For example, if an Analog Input (AI) or Analog Output (AO) object is in
manual and in fault, and is saved as a pob, then the object will remain in fault
when loaded into another controller. To ensure proper function of the new object,
you must reset the controller. Since I/O objects are typically not copied from one
controller to another, this issue is typically not a concern.
Header
The header also displays icons in the upper right area of the header to indicate the
status of the object:
HOA - OFF
Object Value
The object value of the Analog Output is displayed in this field. The value is
within the range of 0 to 100%.
For Delta Devices the Analog Output Configuration (AOC) Object defines the
relationship between the percent maximum output and the physical output voltage
of the object.
The object value always displays the value that is located in the highest priority
level with a non-null entry.
Object Mode
Auto The displayed Present Value is a percentage of maximum output.
As soon as the Manual mode of operation is enabled a spin control opens up to the
right of the Manual button. This spin control is used by the operator to enter an
override value. Due to the priority array it is possible for the object to have a
present value that is different than the Manual value. (See the section Priority
Array for more detailed information) The position of the manual spin control box
next to the present value display ensures the operator will always be able to see
the value of the object.
Control Signal
Displays the value that the present value will be in Auto mode.
If the Analog Output is being controlled at a priority that is higher than the
currently selected manual priority level (usually from a non-Delta source), the bar
containing both the Control Signal and the Priority Level and Source will be
highlighted RED. This will indicate to the operator immediately that the output
cannot be controlled by the Delta System until the value at the higher priority is
relinquished. This priority level can be relinquished by resetting the object with
the right mouse click. The reset will cause a RelinquishAll command to be sent to
the object that will cause a null to be written into every priority array field. There
is no guarantee that whoever wrote to that field previously will not do so again.
When the AO is put into manual mode and set to a value, the header are should
continue to show the control signal and priority that will be written to the object
when it is released back into auto mode.
The default value for this field when no object is writing to it is 'no signal'.
At Priority
Displays the priority level that the output is being controlled at. If the object is in
manual mode and there is no priority level higher than the manual level with a
value in it, then the priority level will be the next highest level from the manual
level, with a value in it.
When the AO is put into manual mode and set to a value, the header continues to
show the control signal and priority that will be written to the object when it is
released back into auto mode.
The default value for this field when no object is writing to it is N/A (not
available).
From
This will display the device number and name of the control source that is
associated with the control signal and priority. This could be a program,
controller, operator or any other object that has the ability to write to the output
directly.
The default value for this field when no object is writing to it is ‘no source’.
Feedback Value
There are 2 types of feedback available with Delta Controls outputs on a DCU.
These are GCL+ feedback and Module feedback. Relay Feedback is available for
Lighting controllers. The different type of feedback modes are chosen on the
Device tab.
Note: The Feedback Value field in the header of AO is not the same as the
BACnet feedback property.
In a DAC, the choices are From GCL or Disabled as signal conditioning modules
are not available for these products.
From GCL Feedback GCL+ feedback is written in a GCL+ program with the
following syntax, “4.AO1.FBackValue = 40”. A 40 is then written into the
feedback field.
Device
This field contains the reference to the Delta proprietary object: Analog Output
Configuration (AOC). This object defines the relationship between the Present
Value and the physical equipment connected to the physical Output.
When viewing other manufacturers’ equipment, Device holds the name of the
Device Type connected to their Analog Output Object. Engineering Unit
information to display concurrently with their Present Value is obtained directly
from the Units Property of their Object.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the Output Object. It may include all relevant
facts pertaining to use, configuration, setup, calibration, wiring, limitations,
equipment location, warnings, etc. In general, any information useful in the
installation and maintenance of the Device could be included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Manual Override at
This combo-box will let you choose what Priority level MANUAL will write its
value into (5 or 8).
Regardless of the Manual override level, manual will not affect the object value if
there is a value written into a higher priority.
Default Value
The value entered in this field will be assigned to Present Value when all the
priority levels have null values assigned.
This would be useful if you required the object to have a value when you didn’t
have any programming associated with the object. This would guarantee that
when you place the object in Manual and then release it to Auto, the object would
return to its default value. It would also be helpful when you command the object
to reset and a NULL is written into all of its priority fields.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Device
Commissioned
This is a check box which tells the operator whether or not the Object has been
field commissioned. An object monitored by an Event object must be
commissioned for a transition to occur and an Alarm Notification to be sent.
Note: The commissioned field affects alarm generation. Event objects that
monitor a de-commissioned object will not transition and will not generate alarm
notifications.
Reliability Codes
This property provides an indication of whether the present value is reliable. This
property will have one of the following values at any given time:
Missing CFG Object - The AIC, AOC, BDC, MIC, or MOC that is referenced by
the object does not exist.
Unreliable Other – This is displayed when there is a feedback error from the
module.
Not Available – This is Delta’s proprietary reliability code which indicates that the
output does not physically exist. (Baseboard is not connected to the DCU).
Device Type
For Delta equipment, Device Type offers a drop down selection list of Analog
Output Configuration Objects (AOC) available for assignment to this Output.
These objects are stored in the controller, not the workstation. Upon selection, the
Scaling information is established for the Output. It also defines the Engineering
Units applicable to Present Value.
For non-Delta equipment Device type offers the name of their Device Type,
which defines the physical Device connected. The Units Property of this Object
defines the Engineering Units associated with Present Value.
Device Units
Units indicate the selected Engineering Units applicable to Present Value. For
Delta equipment this is always “Percent”.
For non-Delta systems, the assignment of Engineering Units for display with
Present Value is normally obtained directly from the Units Property of their
Object.
Minimum Value
Indicates the Minimum allowable value for Present Value. For Delta Devices the
information proceeds from the Analog Output Configuration Object. Other
manufacturers generally hold this information within the Analog Output Object.
Maximum Value
Indicates the Maximum allowable value for Present Value. For Delta Devices the
information proceeds from the Analog Output Configuration Object. Other
manufacturers generally hold this information within the Analog Output Object.
Resolution
Resolution indicates the smallest step change in the physical Output. The object
looks at the size of the D/A resident on the DCU and calculates the number of
output levels available. This is expressed as a percent of maximum output. For
Delta Controls outputs this value is fixed at 0.392157%. This number comes from
the 8 bit D/A that we use. The D/A allows 2^8-1 changes in output level. 1/ (2^8-
1) = .00392157 = .392157%
Module Type
Applying to Delta Devices only, it indicates the type of Output Module currently
installed on a physical Output. If an Expansion Module is not present, it indicates
the default “None”.
Modules with the HOA feature will indicate the current switch condition as an
icon at the top of the object. The Hand icon indicates the output is in manual mode
and the PC icon indicates the output is in auto mode.
Module Feedback
With the installation of the appropriate module, the choice of providing Output
Feedback is made here. The drop down box offers the choice of enabling or
disabling the feature.
The Feedback may be sent from GCL+ or it may be a physical input connected to
the black terminals of the associated output.
0% Feedback Voltage
This is a calibrating figure for the Feedback Input. The value entered here is the
voltage at which 0% will be displayed at the Feedback value. This voltage is the
voltage seen at the A/D. Regardless of what type of input is selected at the Output
Module (20mA, 5V or 10V as selected by the input jumper on the output module),
the signal type is converted to a 0-5V seen by the A/D.
D to A Value
The D to A (Digital to Analog) Value is the current value of the D/A converter in
the controller for that output. The possible range is 0 to 255 and represents 0 to 10
Volts at the output.
Output Voltage
Output voltage is the current value of the physical Output expressed in voltage,
with a range of (0-10 VDC).
Priority Array
Priority Array
Every output has its own Priority Array. The Priority Array is a collection of
fields that are associated with a specific output. These fields are able to store
output values. If no output value is associated with a priority level a NULL value
is written to it. This NULL value allows the output object to see that there is not
any appropriate information contained within that field.
Each field is given a numeric priority level, the highest priority level is 1 the
lowest is 16. The names of the priority levels can be changed through the Priority
Names (PAN).
When the output object is going through its I/O scan it looks at the Priority Array
for its value. Its starts at Priority 1, if there is a value in that field then the output
object writes that value to the physical output and stops scanning through the
Priority Array. If there is a NULL written into the Priority 1 field the output object
continues scanning through the lower Priority Levels until it finds a non-NULL
value in one of the Priority Array fields. It then takes that value and writes it to the
object value.
A null value in the Priority Array is ignored. Null values are entered in the Priority
Array when the Object writing to a particular priority level relinquishes control of
that level. If all of the Priority Levels contain NULL values, the output object will
write its Default Value (located in the Setup Tab) into the object value.
Objects, local to and remote from the Device, may write values to this array at
distinct levels. The last Object to write to a particular level overwrites the Value
of that level.
The tabular display allows the operator to determine the currently controlling
Object’s Name, as well as the priority level of its action, at a glance. This applies
to Delta Devices only. For other manufacturers, the name of the Device rather
than the Object will appear as current holder of the priority.
Alarming (Intrinsic)
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Intrinsic Alarming tab starting on page 10–464provides a way to
configure basic alarm and event features within an object.
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Alarm Text tab starting on page 10–476 allows a message to be
specified for the Alarm, Fault, and Return to Normal transition messages.
• OVERRIDDEN– Displayed if the output has an HOA type module and the
HOA is not in the AUTO mode.
See the Room Controller Installation Guide for information on setting up the
jumpers for Pulse Width Modulation (PWM) outputs. The jumpers must be
configured for internal power when using PWM.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
When the Automatic checkbox on the Configuration tab of the DEV object is
enabled, the controller calculates the amount of time to delay the outputs using its
address (5 + DeviceAddress Mod 31). This is known as system-wide staggered
startup of equipment. This ensures that if a power outage occurs, not all
controllers will turn on their outputs at the same time once the power is restored,
causing a massive power surge. They will be turned on at different times
depending on their address.
To set the Time Delay:
1 Open the Device (DEV) object of the controller and select the Configuration
tab.
2 Set the Time delay behavior to either automatic or manual:
• Automatic: If you want the controller to calculate its time delay
automatically, leave the Automatic checkbox checked.
- or -
• Manual: If you want the controller to have a manual time delay, uncheck the
Automatic checkbox and enter a time into the Delay Time field. The range of
the Delay Time is 0 to 60 seconds. Entering zero sets the delay time to 0
seconds and disables this feature.
On startup, analog outputs are held at 0 volts for a specified time. The Start-up
Behavior of the Analog Output (AO) object is as follows:
• Priority Array levels 7, and 9 to 16 are cleared.
• Priority Array level 6 (Minimum On/Off) is set to 0% for Direct Acting
outputs and 100% for Reverse Acting outputs. This ensures the outputs stay at
0 volts regardless of whether the output is direct or reverse acting.
• The ‘Min On/Off Delay’ is set to the time that is specified in the Output
Startup Delay section of the controller’s Device (DEV) object. When this
time expires, Priority Array level 6 is cleared and the value of the output is set
to the next highest priority level. If the rest of the Priority Array is blank, the
default value will be written to the output.
Note: GCL begins executing as soon as the controller starts up and (by default)
writes to priority level 10. But since the Min On/Off Delay is writing to level 6,
the outputs are held at 0 volts.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the AOC Object. It may include all relevant
facts pertaining to the type of actuator that this scale range is being created for.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Units
Sensor Units for Delta Controls AOC Objects is fixed to %. This is the only valid
unit for our outputs in this release.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Scale Range
The Scale Range uses a linear equation to calculate the output voltage from the
Analog Output %value. If you only enter two (value, voltage) pairs the Scale
Range will linearly calculate the output voltage between the two %Value
endpoints.
A very large number of (voltage, value) pairs can be entered into the scale range.
Memory usage for the object increases as you enter more data pairs up to a 64
Kbytes limit.
For an actuator that is linear but has a non-zero voltage for minimum position you
would only have to enter two value pairs. One pair for the smallest voltage, and
one pair for the maximum voltage. An example would be Delta Controls Actuator
(part # AF24-SR DE) that has a 2 to 10 VDC control signal. You would only have
to enter two value pairs for this AOC: (0, 2) & (100, 10).
If you enter minimum and maximum values that are not 0 and 100, the AOC
would prevent the associated Analog Output Object from having a voltage beyond
the voltage the programmer specified in the AOC scale range. For example, if the
programmer is split ranging a controller for a small Air Handling Unit and is using
the AF24-SR DE actuator for the Mixed Air Dampers, he could use an AOC scale
range and define two pair as (34,2) & (66,10). He would then set up one Supply
Air Temp controller to control the Heating valve, Mixed Air Damper & the
Cooling valve through GCL+. The Mixed Air Dampers would then stroke from 0
to 100% as the Controller value went from 34 to 66 %.
The scale range is auto sorting. If you add a value to the graph which would
logically be in the middle when you apply the change the (value, voltage) will
move to the proper position in the data-view.
To delete a (value, voltage) pair simply highlight the pair you would like to
remove (single left click on the line – it will turn blue) and press the delete key.
Value (0-100%)
This is a data-view that defines one point of the output scale range that you are
creating. To enter a %Value in this field simply double left click on the next
available position and enter a voltage value. The valid range of %Values is from 0
to 100%.
Because the DCU uses an 8 Bit D/A converter at the outputs, the smallest
noticeable %Value change is (100/((28) -1)) = 0.39 %. Any step change in your
%Value smaller than 0.4% may not be noticeable in the physical output.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
A Totalizer can be reset to zero by operator command. From the right Navigator
pane, right click on the object name. Select Command and Reset. This resets the
value of the Totalizer to zero and stores the time and date of the restart.
Header
Object Value
The object value of the Analog Totalizer Object is displayed in this field. The
value is calculated (integration of the monitored object) based on the monitored
object and the conversion rate.
Object Mode
Auto The displayed Object Value is automatically calculated from the value of
the monitored object and the conversion rate.
Manual The value of the monitored object and the conversion rate will not
affect the object value. The last calculated object Value—or any value that is
manually entered—remains until the object is returned back to Auto. A "hand"
symbol will be displayed in Navigator to indicate that the Object is in Manual.
As soon as the Manual mode of operation is enabled a spin control opens up to the
right of the Manual button. This spin control is used to allow the operator to enter
an override value. If Fixed Point is enabled and Decimal is greater than 2 or,
Fixed Point is disabled, an Edit box will appear in place of the spin control. The
reason for this is that spin boxes cannot enter values with more than 2 decimals.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Units
Sensor Units indicates the selected BACnet Engineering Unit applicable to
Present Value. The BACnet Engineering Units are a list of all the possible units
the BACnet committee felt were required in this industry.
Fixed Point
BACnet values are stored as Real numbers. Real numbers in version 3 go from -
1038 to +1038 and from as small as 1.17549x10-38. A floating point number will
show a maximum of six significant digits with an exponent that can go as high as
10^38. Seven significant digits are stored internally for the process of rounding.
This means that the largest displayable number is 3.40282x10+38. The smallest
number is 1.17549x10-38.
By selecting Fixed Point the AT Dialog will force the value to display a certain
number of decimal places. The dialog will automatically round the number to the
correct decimal place.
Decimals
The value entered in this field provides the ability for the operator to show the
number of decimals that he would like to see. He can display from 0 to 9 decimal
places. Keep in mind that the object value has a restriction of only displaying 6
significant digits so as the number becomes larger (using more places to the left of
the decimal) zeroes will be used to fill up the specified number of decimal places.
Monitored Object
The object entered into this field will be the object on which the calculation is
being performed. The reference can either be entered manually or by selecting an
object from the drop-down list.
The drop down list contains only local AI, AO, AV or PI objects. Any object on
the network (remote or local) with an analog value can be entered manually into
this field.
Conversion Rate
Enter the type of conversion. Set the type to match the units of the Monitored
Object. The conversion rate will increment the value of the AT by the value of the
Monitored object every second/minutes/hours/days (whatever is selected).
Days Set to match the Monitored Object having units of Unit/Day. This would
be an appropriate setting if Deg_Days were being totalized with the Monitored
Object having Degrees as its units.
Totalizer Started At
Displays the time and date when the Monitored object and Conversion rate are
selected and applied after initial AT creation. If the object is Reset, the time will
be set to the current controller time.
COV Increment
Specifies the minimum amount of change in the object value required to cause a
Change Of Value notification event. This property is used for the purposes of
Trending or for COV data exchange configurations. For more information on
Trending, see the Trending and Archiving chapter of the Technical Reference
manual. Chapter 9 Controller Networks covers Data Exchange.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
The status field in Navigator can have the following values for the Analog
Totalizer:
• FAULT – Displayed if the object does not have a Monitored Object or if the
objects Reliability property does not have a value of ‘NO FAULT DETECTED’
e.g. if a Monitored Object, or a Conversion Factor has not been assigned to
the Object, this message will be displayed.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
Header
Object Value
The object value of the Analog Variable is displayed in this field.
BACnet values are stored as Real numbers. Real numbers in version 3 go from
–1038 to +1038 and from as small as 1.17549x10-38. A floating point number will
show a maximum of six significant digits with an exponent that can go as high as
1038. Seven significant digits are stored internally for the process of rounding.
This means that the largest number that can be displayed is 3.40282x1038. The
smallest number is 1.17549x10-38.
Object Mode
Auto The Object Value reflects changes made to the object in a GCL+ program.
Manual The Object Value no longer reflects changes made to the object in a
GCL+ program. The last value—or any value that is manually entered—remains
until the object is returned back to Auto. The status indicated in the navigator
window shall be a manual hand icon
Auto Value
GCL+ Value will display the value that a Delta Version 3 PG Object that is
writing to an AV. Non-Delta systems will not write to this field but will write
directly to the object value, even if the object is in Manual mode.
Control Source
Control Source is a proprietary feature that holds the Name of the Object that is
controlling the Object in the Auto mode. The control source will display the name
of the last object that wrote to the AV. If the object which is writing to the AV is
from a remote controller, the Control source will display the Device number
which that Object is resident on. If an AV object is set to a manual value on the
OWS panel, the control source displays the Username that is currently logged in.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
The BACstat does not try to reset on The BACstat will reset once on the
the loss of communications. loss of communications and try to re-
establish communications.
If the device reset, the mode reverts IF the device reset, the mode is set to
to whatever it was just prior to the DAY.
reset (i.e., last value as stored in non-
volatile memory).
The checkbox allows the user to set the action of the Analog Variable. Reverse
Action is available on Output objects (AV1-3).
The object can be either direct or reverse acting (i.e., a value of 100% places
either 10VDC or 0 VDC on the output terminals). The selection in this field,
determines the voltage values for Active (On) and Active (Off). Depending on the
selection, one will correspond to Energized (10 volts) and the other De-energized
(0 Volts).
When Reverse Acting is unchecked, the ACTIVE (On) state is the object value
when there is an Energized (10 Volts) at the physical input. Likewise, the
INACTIVE (Off) state is the object value when there is a De-energized (0 Volts)
seen at the physical input.
When Reverse Acting is checked, the ACTIVE (On) state is the object value when
there is a De-energized (0 Volts) seen at the physical input. Likewise, the
INACTIVE (Off) state is the object value when there is an Energized (10 Volts) at
the physical input.
Fixed Point
BACnet values are stored as Real numbers. Real numbers in version 3 go from –
1038 to +1038 and from as small as 1.17549x10-38. A floating point number will
show a maximum of six significant digits with an exponent that can go as high as
1038. Seven significant digits are stored internally for the process of rounding.
This means that the largest number that can be displayed is 3.40282x1038. The
smallest number is 1.17549x10-38.
By selecting Fixed Point the AV Dialog will force the value to display a certain
number of decimal places. The dialog will automatically round the number to the
correct decimal place.
Decimals
The value entered in this field allows the operator to set the number of decimals
that he would like to see. He can display from 0 to 9 decimal places. The object
value has a restriction of only displaying 6 significant digits so as the number
becomes larger (using more places to the left of the decimal) zeroes will be used
to fill up the specified number of decimal places.
Units
Units indicate the selected BACnet Engineering Unit applicable to the value of the
object. The BACnet Engineering Units are a comprehensive list of units that are
normally applicable to the HVAC industry. This list was designated by the
BACnet committee.
For BACstat II Release 3 or older, the Units field may be editable for some AV /
AI objects, depending on the BACstat model and algorithm. Typically, the Units
field is Read Only for most objects. For additional information, refer to the
BACstat Application Guide for your product.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
The DAC uses the NET object described on page 10–598 to set these
configuration options.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
ID Column The Dataview at the top of this tab lists all of the available Network
Interfaces in the ID column. Clicking on one of the Network Interfaces will
display additional configuration information (if available) in the area below the
Dataview.
Enabled Column The Enabled column contains one checkbox for each
Network Interface. When the checkbox is checked, this Network Interface will
support communication by the BACnet protocol.
Serial RS-232 networks are automatically given their own unique network number
which is 65535-(Controller Address MOD 5536).
The range of the NetworkNum is 0 to 65534. Note that the number cannot be
changed unless the controller is using software addressing mode.
Tunnel Column The Tunnel column contains one checkbox for each Network
Interface. When checked, all incoming Version 2 traffic will be directed as
Tunneled packets out this interface. Normally, only UDP/IP, Serial and MS/TP
interfaces should have this option checked. For a more through explanation of
Tunneling, see the Version 2 Protocol Settings (V2P) Object. The V2P object is
automatically created in the default database. It is used to configure network
options that pertain to the Delta proprietary Version 2 protocol. If only Version 3
panels are on site, then this option has no purpose. If only Version 3 controllers
are on site, then this option has no purpose. Never enable Tunneling for Ethernet
or IntelliNet.
Protocol This field reflects the PTP type of BACnet connection that is in use.
Parity Bits Parity is a simple method of error detection. The options are None
(default), Even, and Odd. It is provided mainly for compatibility with other
BACnet devices which may insist on a certain type of parity.
Stop Bits The available options are 1, 1.5 or 2 stop bits, with 1 being the
default. Like Baud Rate, all that matters is that both ends use the same setting.
Data Bits This is the number of actual data bits that will be sent in each frame
of RS-232 data. The available options are 8 bits (default) and 7 bits. 8 is almost
universally used, with 7 only being used when Parity is also used.
Idle Time This is the number of seconds that a serial PTP connection can be
idle before it is disconnected. The default is 600 seconds.
Dial Upon Login When this checkbox is checked, then the OWS dials out to a
controller upon login.
SUA for Direct Connect to 3rd Party Specifies the Password to check
when dialing into third party network.
Delta Controls also offers the newer CON-768BT which is a MS/TP to Bluetooth
converter that allows a PC to wirelessly connect to a BACnet network across a
Bluetooth link. The Bluetooth connection forms a virtual COM port link replacing
the need to have an actual RS-232 port on the PC. The CON-768BT connects to
and is powered from an RJ11 service port found on most Delta Controls products.
Note: Changing the speed on any single device and pressing Apply or OK will
automatically cause a speed change on all Delta Controls devices on the same
MS/TP network. Speed change requests will be sent regardless of any baud rate
differences between the requesting device and other devices on the network.
Protocol The field displays the MSTP protocol used for communications.
Max Master The Max Master is the highest addressed controller that this
controller can communicate with over the MS/TP network. It is not recommended
to change it from the default of 127.
Address This is the physical MS/TP MAC address of the controller on the
MS/TP network. It is determined from the controller’s address but for a DCU
controller is always set to 0. Normally, this address is not changed.
Device Type This setting describes how this controller will participate in a
system where there is more than one IP network which is connected by routers.
This would typically be the case where a WAN is expected to carry controller to
controller communications.
• Regular Devices can communicate with other controllers in the same sub-
network, but cannot communicate with controllers in other sub-networks
without the assistance of a BACnet Broadcast Management Device (BBMD).
• Foreign Devices are controllers which are isolated by themselves on a sub-
network which has no BBMD. These controllers can communicate with the
larger network by registering with a remote BBMD device on another sub-
network. The following paragraph explains BBMD devices.
• BBMD Devices operate as regular controllers, but are also responsible for
sending information from the sub-network that the BBMD is connected on to
other BBMD devices on other sub-networks. The remote BBMD then sends
the received information to the controllers in that sub-network. It is important
to note that only one controller on a sub-network can be designated as a
BBMD device. The other controllers must be set as Regular Devices.
Port The port defines which UDP port number that UDP/IP communication will
use. The available range is 0 to 65535 with 47808 being the default. These port
numbers are assigned by Internet standard with 47808 being assigned for the use
of BACnet networks. It is important that this port number is not changed
arbitrarily as many of the other port numbers have other purposes that would
conflict with BACnet. All devices on the same UDP/IP network must use the
same Port number.
BBMD Address This setting is only needed when the Device field is set to
Foreign Device. A foreign device needs to know the IP address of a remote
BBMD in order to participate with that remote network. Any of the controllers
which are set as a BBMD Device could be referenced here.
Registration Timeout This setting is only needed when the Device field is set
to Foreign Device. This field is a time in seconds and is passed along to the
remote BBMD Device. This controller must confirm its existence with the remote
BBMD at this interval or the remote BBMD will assume that this controller no
longer wants to participate in the network.
Dial-Out SUA This setting allows the user to select which SUA object that the
OWS will use to verify against the SUA object on the remote BBMD device. This
setting is only needed if the OWS is attempting to log into the network as a
foreign device, and the remote BBMD device requires an SUA Password Check.
Advanced
Protocol
Version
This is the major version number of the BACnet protocol that is implemented by
this controller. Currently, Version 1 is the only one available.
Revision
This is the minor version number of the BACnet protocol that is implemented by
this controller.
Retry Time
When a network transmission is made that requires an acknowledgement of
success, this field, which defaults to 7000 ms, specifies the time between
re-transmissions if the acknowledgement has not been received. If you are
experiencing problems with controllers dropping off-line, then increasing this
value may help.
Retries
This field specifies the number of times unsuccessful transmissions will be
repeated. If the receiving controller has not received the transmission successfully
after this many attempts, no further attempts will be made. The default is 3 on a
controller and 1 for the OWS.
Segment Timeouts
This field, which is very similar to the Retry Time, specifies the time between re-
transmissions of a single segment of a multi-segment message. When messages
between controllers are necessarily larger than the Max APDU Size (see above),
the message is broken down into multiple, smaller segments. Normally this field
does not need adjustment. The default is 5000ms.
Stats
The Stats tab shows many statistics related to BACnet network communications.
MS/TP Slaves
This tab has a Dataview which lists information about slave devices. See the Slave
Device List (SDL) object on page 10–713 of this chapter. The Dataview has five
heading labels:
Device Number
Enter the device number of the slave device in this field.
Segmentation
Refer to the slave device’s documentation to determine what level of
segmentation the device supports, if any.
If the APDU portion of a message is larger than the maximum APDU value
supported by either of the devices participating in a conversation, the APDU
portion of message may be broken into multiple segments where each segment is
sent in a separate packet.
Vendor ID
This field indicates the manufacturer of the slave device. Refer to the slave
device’s documentation to determine the vendor ID to use. If the vendor ID is not
specified in the documentation, use 0.
MAC Address
This field contains the network number and MAC address of the slave device. The
MAC address is not the device number; it is the physical MS/TP address. Refer to
the slave device’s documentation to determine the MAC address for the device.
Caution: The MAC Address field uses a format that requires care and
attention when entering its value. First enter a valid network number
followed by a comma and then the MAC address for the particular device.
The format of the MAC address differs depending on the physical media
used by the device (Ethernet, MS/TP, ...).
Entering a MAC Address The value for this field begins with a network
number, followed by a comma and then the MAC address. For example, a MAC
address on network 2321 would start out with NET2321. The following examples
use network 50:
Description
Although this is a virtual object, the Description field can be utilized to provide a
detailed functional definition of the physical equipment associated with the
Object. It may include all relevant facts pertaining to use, configuration, setup,
calibration, wiring, limitations, sensor location, warnings, etc. In general, any
information useful in the installation and maintenance of the Device could be
included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Active State
The text entered in this field provides an operator with a meaningful description
for a BI or a BO which references the BDC. The Active State text must contain at
least 1 printable character. Delta Controls restricts the maximum length of this
text description to 128 characters. The text should be less than 20 printable
characters in length as longer entries are impractical in Navigator and can waste
memory.
Inactive State
The text entered in this field provides an operator with a meaningful description
for a BI or a BO which references the BDC. The Inactive State text must contain
at least 1 printable character. Delta Controls restricts the maximum length of this
text description to 128 characters. The text should be less than 20 printable
characters in length as longer entries are impractical in Navigator and can waste
memory.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
A DCU can contain up to 32 Binary Input (BI) Objects on the main board DBB-
060 (using plug-in modules) and up to 96 additional inputs as expansion objects.
These objects are defined in software.
See Appendix E – Working with MS/TP and LINKnet for a discussion of using
LINKnet BI objects.
Header
The header also displays icons in the upper right area of the header to indicate the
status of the object:
The Commissioned icon (a lock) indicates that the object has not
been field commissioned.
When the Commissioned checkbox in the Device tab is checked,
then the Lock icon is removed from the header and does not
display in Navigator.
For a controller, the Auto icon (a computer) may display in the
upper right area of the header shows that the HOA switch of the
module for this object is in the Auto position.
For a controller, a Hand icon (HOA - Hand) in the upper right
area of the header shows that the HOA switch for this object is in
the Hand position. Navigator also displays HOA icons in OFF
and Hand columns for objects in the Details view.
HOA - OFF
Object Value
The value of a Binary Input (BI) will be one of two values. The default values for
a Delta Controls BI, is either ON or OFF. These values represent the physical
condition of the input. The default setup displays ON when there is 0 VDC
(Closed Circuit) at the physical Input, while the OFF state represents 5 VDC
(Open Circuit) at the physical Input.
For non-Delta equipment, the states are named by the Active and Inactive text as
defined within their Binary Input Object.
Object Mode
Auto The Input Object will take the current Input condition (voltage seen by the
A/D converter), apply the configuration criteria from the BDC, and report it as an
Object Value state, (i.e. normal condition).
Manual Any manually entered state for the object Value will operate all
dependent system functions as normal, but the physical Input is de-coupled from
Present Value. For this reason the STATUS field in the navigator will display
“Out of Service”. This is defined in the BACnet standard.
Last On Time
Indicates the date and time at which the input last made a transition from the
INACTIVE (OFF) state to the ACTIVE (ON) state. This is defined in the Device
tab of the BI object.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the Input Object. It may include all relevant
facts pertaining to use, configuration, setup, calibration, wiring, limitations, sensor
location, warnings, etc. In general, any information useful in the installation and
maintenance of the Device could be included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Device
Commissioned
This is a check box which tells the operator whether or not the Object has been
field commissioned.
Note: The Commissioned field affects Alarm generation: when the object is de-
commissioned, Event objects that monitor this object will not transition and no
alarm notifications will be generated for that event. By default, the Commissioned
checkbox is unchecked. A common oversight is to forget to check the
Commissioned checkbox.
Reliability Codes
This property provides an indication of whether the present value is reliable. This
property will have one of the following values at any given time:
No Fault Detected – This is the normal state for the input. Everything is working
from an object execution perspective.
Missing CFG Object - The AIC, AOC, BDC, MIC, or MOC that is referenced by
the object does not exist.
Other Fault – This is displayed when an internal error occurs such as an invalid
property value encountered during execution.
Not Available – This is Delta’s proprietary reliability code, which indicates that
the input does not physically exist. (Baseboard is not connected to the DCU).
Device Type
For Delta equipment, Device Type offers a drop down selection list of Binary
Device Configuration (BDC) Objects available for assignment to this Input. This
list displays the BDCs that are resident on that DCU.
The BDC object defines binary units such as Dirty/Clean, High/Low etc. The
BDC object defines these units and matches them to the corresponding Input state
(OPEN / 5 VDC, or CLOSED / 0 VOLTS).
For non – Delta equipment, Device Type offers the name of their Device Type,
which defines the physical Device connected.
By default, the ACTIVE (On) state is the object value when there is a Closed
Circuit (0 VDC) at the physical input. Likewise, the INACTIVE (Off) state is the
object value when there is an Open Circuit (5 VDC) seen at the physical input.
When the Reverse box is checked the ACTIVE (On) state is the object value when
there is an Open Circuit (5 VDC) seen at the physical input. Likewise, the
INACTIVE (Off) state is the object value when there is a Closed Circuit (0 VDC)
at the physical input.
Alarming (Intrinsic)
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Intrinsic Alarming tab starting on page 10–464provides a way to
configure basic alarm and event features within an object.
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Alarm Text tab starting on page 10–476 allows a message to be
specified for the Alarm, Fault, and Return to Normal transition messages.
The status field in Navigator can have the following values for this object:
• FAULT – Displayed if the objects Reliability property does not have a value of
‘NO FAULT DETECTED’.
• OUT OF SERVICE – Displayed if the object is in Manual Mode.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
A DCU contains 16 Output Objects (OP) on the main board DBB-060. These OP
Objects are defined in the software as either analog or binary objects.
Header
Icons in the upper right area of the header indicate the status of the object:
HOA - OFF
Object Value
The value of a Binary Output (BO) will be one of two values. The default values
for a Delta Controls BO is either ON or OFF. These values represent the physical
condition of the output. The default setup displays ON when there is 10 VDC at
the physical Output, while the OFF state represents 0 VDC at the physical Output.
Object value is selected from the highest priority with a Non-null State, contained
within the array (Priority Array will be defined later in this section).
For other manufacturers, Output objects may or may not have an underlying
Priority Array in which case the State is displayed directly by Control Source and
Object value.
For non-Delta equipment, the states are named by the ACTIVE and INACTIVE
text as defined within their Binary Input Object.
Object Mode
Auto The displayed Object value and output is being set from another
object/device. The highest non-NULL priority array value will be assigned to the
output.
Manual In Manual mode the operator may enter an override value for the
output. The default Manual operator priority level is #5. Only non-NULL priority
array values located in the selected Manual priority level and higher will be
assigned to the output.
Control Signal
Displays the value that the present value will be in Auto mode. The default value
for this field when no object is writing to it is ‘no signal’.
If the Binary Output is being controlled at a priority that is higher than the
selected Manual priority level (Usually from a non-Delta source), the bar
containing both the Control Signal and the Priority Level will be highlighted
RED. This will indicate to the operator immediately that the output is unable to be
controlled by the Delta System until the value at the higher priority is
relinquished. This can be accomplished by Commanding the object to Reset (right
click on the object -> Command -> Reset).
If any Priorities that are being written to that are lower than the Manual Priority,
then the Control Signal will display what the value of the BO will be when it is
returned to Auto mode.
At Priority
Displays the priority level that the Control Signal value is located in.
The default value for this field when no object is writing to it is N/A (not
available).
From
This will display the device number and name of the control source that is
associated with the control signal and priority. This could be a program,
controller, or any other object that has the ability to write to the output directly.
The default value for this field when no object is writing to it is ‘no source’.
Feedback Value
A feedback module must be used to detect a feedback signal. The feedback value
will be either On or Off (or the equivalent as defined in the Binary Device
Configuration).
Last On Time
Indicates the date and time at which the output last made a transition from the
INACTIVE (OFF) state to the ACTIVE (ON) state.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the BO Object. It may include all relevant
facts pertaining to use, configuration, setup, calibration, wiring, limitations, sensor
location, warnings, etc. In general, any information useful in the installation and
maintenance of the Device could be included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Manual Override at
This combo-box will let you choose what Priority level the Manual mode will
write its value into. When you use the default Manual level (Critical Equipment
Control priority 5), the Minimum On/Off timers will not have any effect on the
output value.
If you select manual to write and level 8 (Manual Operator) the Minimum On/Off
timers will not allow the Manual value to take effect until they have completed
their timing sequences. This manual override level would be used when it is
critical that Equipment not be cycled too fast.
Regardless of the Manual override level, manual will not affect the object value if
there is a value written into a higher priority.
Default Value
The value selected from this combo-box will be assigned to the object Value when
all the priority levels have null values assigned.
This would be useful if you required the object to have a value when you didn’t
have any programming associated with the object. This would guarantee that
when you place the object in Manual, and then release it to Auto, the object would
return to its default value.
Minimum ON Time
Indicates the Minimum Time in minutes, that the output must be “ON” before the
output can be turned “OFF”. The valid range for this field is from 0 to 3600
minutes.
If the object value is ON and the time since the last change of state of the object
value is less than the Minimum On Time, then Priority 6 shall contain a value of
ACTIVE (ON), until the Minimum On Time has been fulfilled. When the timer
times out, a NULL will be written into this priority level 6.
If the object value is OFF and the time since the last change of state of the object
value is less than the Minimum OFF Time, then Priority 6 shall contain a value of
INACTIVE (OFF), until the Minimum OFF Time has been fulfilled. When the
timer times out, a NULL will be written into priority level 6.
When the output is waiting for the token, it writes INACTIVE (off) into Priority
Level 9. This prevents the GCL+ value (Level 10) from being written into the
object value. This is because priority Level 9 has precedence over anything
written in priority Level 10. When the output receives the token it relinquishes the
value in priority 9 (writes a NULL to that priority level). This allows the output
value to become whatever is written in the lower priority levels.
Although this delay has primary application after a power failure, it is also active
any time an object with a defined “After ON don’t turn next output on for” delay
is initiated. It may only be noticeable whenever a GCL+ program asks for more
than one binary output to be turned on at the same time.
When an object is manually commanded to start before it receives the token, the
“After ON don’t turn next output on for” value (INACTIVE or OFF) is
relinquished. If the operator then releases Manual control and places the object
back into AUTO, the object will stay ON (nothing is in priority level 9 to prevent
it from being turned on).
Device
Commissioned
This is a check box which tells the operator whether or not the Object has been
field commissioned. This field affects Alarm generation: when the object is de-
commissioned, Event objects that monitor this object will not transition and
no alarm notifications will be generated for that event.
Reliability Codes
This property provides an indication of whether the present value is reliable. This
property will have one of the following values at any given time:
Unreliable Other – This is displayed when there is a feedback error from the
module.
Not Available – This is Delta’s proprietary reliability code which indicates that the
output does not physically exist (baseboard is not connected to the DCU or if there
is a BO1 and an AO1 on another vendor system).
Device Type
For Delta equipment, Device Type offers a drop down selection list of Binary
Device Configuration Objects available for assignment to this Output. These
objects are stored in the DCU, not the workstation. Upon selection, the
relationship between the Object value and the physical Output is established.
If no assignments are made the default, “ON” for Active and “OFF” for Inactive,
are selected. This offers the basic relationship of: “ON” the physical Output is
energized, “OFF” the physical Output is de-energized.
For non-Delta equipment Device Type offers the name of their Device Type,
which defines the physical Device connected. The name text associated with the
“Active” and “Inactive” States displayed by Object value is obtained directly from
the Binary Output Object.
When Direct is chosen, the ACTIVE (On) state is the object value when there is
an Energized (10 Volts) at the physical input. Likewise, the INACTIVE (Off)
state is the object value when there is a De-energized (0 Volts) seen at the
physical input.
When Reverse is chosen, the ACTIVE (On) state is the object value when there is
a De-energized (0 Volts) seen at the physical input. Likewise, the INACTIVE
(Off) state is the object value when there is an Energized (10 Volts) at the physical
input
Active (On)
Shows the name text applicable to Object value to indicate an “Active” State. The
Binary Device Configuration Object that is referenced to this Output Object stores
this information.
Inactive (Off)
Shows the name text applicable to Object value to indicate an Inactive State. This
information is stored by the Binary Device Configuration Object referenced to this
Output Object.
Module Type
Applies to Delta Devices only, it indicates the type of Accessory Module, if
applicable, currently installed on a physical Output. If an Accessory Module is not
present, it indicates the default “None”. This is a read-only field.
Modules with the HOA feature will indicate the current switch condition as an
icon on the “Flags” framework of this object.
Feedback
Note: The Feedback Value field in the header of BO is not the same as the
BACnet feedback property.
From Module This selection allows output feedback through the use of an
Accessory Module. Module Feedback can only be enabled if one of the Modules
in the following table is displayed in the Type field, and the physical input
corresponding to that physical output is not being used (i.e. OP1 - OP16
corresponds to IP17 - IP32). For wiring details see the module installation
documentation.
The value of the measured feedback will be displayed in the Feedback field in the
header of this object.
When Feedback From Module is selected a Feedback Reverse check box will
pop up. If this field is checked then the value in the Feedback field will be the
opposite of the actual output state.
From GCL+ This selection allows the programmer to use a GCL+ program to
provide the Feedback value (e.g. you could equate the Feedback value to an input
which is measuring the feedback). The GCL+ command to use this feature for a
BO on DCU 100 is:
100.BO6.FBackValue = ON
D to A Value
The D to A Value (Digital to Analog) is the current value of the physical Output
expressed as an integer value corresponding to the digital value given to the
Converter. The range is from 0 to 255 which correspond to 0 VDC and 10 VDC.
Output Voltage
Output voltage is the current value of the physical Output expressed in voltage,
with values of either 0 or 10 VDC.
Priority Array
Each field is given a numeric priority level, the highest priority level is 1 the
lowest is 16. The names of the priority levels can be changed through the PAN
object.
When the output object is going through its I/O scan it looks at the Priority Array
for its value. It starts at Priority 1, and unless there is a value in that field,
continues through to Priority 16. Once a value is found in the array scan, the BO
object writes that value to its object value, the physical output, and stops scanning
the array.
If all of the Priority Levels contain NULL values, the output object will write it’s
Default Value (located in the Setup Tab) into the object value.
Objects, local to and remote from the Device, may write values to this array at
distinct levels. The last Object to write to a particular level overwrites the Value
of that level.
A null value in the Priority Array is ignored. Null values are entered in the Priority
Array when the Object writing to a particular priority level relinquishes control of
that level.
The priority array display allows the operator to determine the currently
controlling Object’s Name, as well as the priority level of its action, at a glance.
This applies to Delta Devices only. For other manufacturers, the name of the
Device rather than the Object will appear as current holder of the priority.
Lighting
This tab contains features that extend the operation of the Binary Output object to
include lighting functionality. The Lighting tab is only visible if the BO is created
in a lighting controller (DLC).
Override Input
This field allows an object (BV, BO, BI, MI, SCH) to override the BO object to
ON for the specified Override Time. The BO override is triggered when the
override input object transitions from OFF to ON.
The dropdown contains a list of local BI and BV objects. Click on an object in the
list to select it. If you click on the Filter button to the right of the field, the list
includes BV, BI, BO, MI, and SCH.
Override Time
Specifies how long the BO is overridden to ON by the specified Override Input.
When the timer expires, it relinquishes control of the BO and the value is
recalculated based on the BO’s priority array.
Status On Checkbox
Enables the event tracking when the Status transitions to ON.
Alarming (Intrinsic)
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Intrinsic Alarming tab starting on page 10–464provides a way to
configure basic alarm and event features within an object.
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Alarm Text tab starting on page 10–476 allows a message to be
specified for the Alarm, Fault, and Return to Normal transition messages.
The status field in Navigator can have the following values for this object:
• FAULT – Displayed if the object’s Reliability property does not have a value
of ‘NO FAULT DETECTED’ (i.e. when the output does not physically exist)
• OVERRIDDEN– Displayed if the output has an HOA type module and the HOA
is not in the AUTO mode.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
When the Automatic checkbox on the Configuration tab of the DEV object is
enabled, the controller calculates the amount of time to delay the outputs using its
address (5 + DeviceAddress Mod 31). This is known as system-wide staggered
startup of equipment. This ensures that if a power outage occurs, not all
controllers will turn on their outputs at the same time once the power is restored,
causing a massive power surge. They will be turned on at different times
depending on their address.
To set the Time Delay:
3 Open the Device (DEV) object of the controller and select the Configuration
tab.
4 Set the Time delay behavior to either automatic or manual:
• Automatic: If you want the controller to calculate its time delay
automatically, leave the Automatic checkbox checked.
- or -
• Manual: If you want the controller to have a manual time delay, uncheck the
Automatic checkbox and enter a time into the Delay Time field. The range of
the Delay Time is 0 to 60 seconds. Entering zero sets the delay time to 0
seconds and disables this feature.
HVAC Controllers
On startup of an HVAC controller (not including the DCU), binary outputs are
held at 0 volts for a specified time.
Binary Output (BO) object Start-up Behavior:
• Priority Array levels 7, and 10 to 16 are cleared.
• Priority Array level 6 (Minimum On/Off) is set to Inactive for Direct Acting
outputs and Active for Reverse Acting outputs (This ensures the outputs stay
at 0 volts regardless of whether the output is direct or reverse acting).
• The ‘Min On/Off Delay’ is set to the time that is specified in the Output
Startup Delay section of the controller’s Device (DEV) object. Once this time
expires, Priority Array level 6 is cleared and the value of the output is set to
the next highest priority level. If the rest of the Priority Array is blank, the
default value will be written to the output.
Note: GCL begins executing as soon as the controller starts up and (by default)
writes to priority level 10. But since the Min On/Off Delay is writing to level 6,
the outputs are held at 0 volts.
Lighting Controllers
On startup of a lighting controller, if the relays have feedback, the feedback value
will be written to the outputs for the time that is specified in the Output Startup
Delay section of the controller’s Device (DEV) object. This keeps the relay in its
previous state, and allows GCL to determine and write the proper state. If the
relays do not have feedback and GCL is not used to determine the proper value,
the default value will be written to the output as soon as the controller starts up.
Note: The controller cannot detect if the relays have feedback capability or not. If
the relays do not have feedback (DLC-G1212 with RR7 relays), the user must
select 'Disabled' from the Feedback drop down box in the Device tab of the Binary
Output (BO) object. By default, the Feedback drop down box is set to ‘From
Relay’. The user must also set the default value to the appropriate state since, if
feedback is disabled, the default value will be written to the relay as soon as the
controller starts up.
Binary Output (BO) object Start-up Behavior for lighting controllers with
feedback capability enabled:
• Priority Array levels 7, and 10 to 16 are cleared (as per regular BO objects).
• Priority Array level 6 (Min On/Off Time) is set to the feedback value (This
ensures the relay stays at its previous state).
• The ‘Min On/Off Delay’ is set to the time that is specified in the Output
Startup Delay section of the controller’s Device (DEV) object. Once this time
expires, Priority Array level 6 is cleared and the value of the output is set to
the next highest priority level. If the rest of the Priority Array is blank, the
default value will be written to the output.
Binary Output (BO) object Start-up Behavior for lighting controllers without
feedback (this only applies to GE controllers with RR7 relays):
• Priority Array levels 7, and 10 to 16 are cleared (as per regular BO objects).
As soon as the controller starts up, the value at the highest level in the Priority
Array is then assigned to the value of the output. If the Priority Array is blank, the
default value is written to the output. Therefore, if the user specifies a default
value of ON, the lights go ON.
From the right Navigator pane, right click on the object name. Select Command
and Reset.
This resets the number of hours and starts to zero, and stores the time and date of
the restart.
Header
Object Value
The object value of the Binary Totalizer Object is displayed in this field. The total
number of hours that the monitored object is On (Active) will be displayed.
Object Mode
Manual The value of the BT will not be affected by the state of the monitored
object. The last calculated object Value—or any value that is manually entered—
remains until the object is returned back to Auto. The status indicated in the
navigator shall be “Out of Service”.
When the object is in Manual mode GCL+ can be used to write to the object
value.
As soon as the Manual mode of operation is enabled a spin control opens up to the
right of the Manual button. This spin control is used to allow the operator to enter
an override value. If Fixed Point is enabled and Decimals is greater than 2, or
Fixed Point is disabled, an Edit box will appear in place of the spin control. The
reason for this is that spin boxes cannot enter values with more than 2 decimals.
Description
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Fixed Point
BACnet values are stored as Real numbers. Real numbers in version 3 go from -
10^38 to +10^38 and from as small as 1.17549x10-38. A floating point number will
show a maximum of six significant digits with an exponent that can go as high as
10^38. Seven significant digits are stored internally for the process of rounding.
This means that the largest number that can be displayed is 3.40282x1038. The
smallest number is 1.17549x10-38
By selecting Fixed Point the BT Dialog will force the value to display a certain
number of decimal places. The dialog will automatically round the number to the
correct decimal place.
If the Fixed Point is enabled and the number becomes larger than +/- 214,748 the
number will revert to a floating point display.
Decimals
The value entered in this field provides the ability for the operator to show the
number of decimals that he would like to see. He can display from 0 to 9 decimal
places. Keep in mind that the object value has a restriction of only displaying 6
significant digits so as the number becomes larger (using more places to the left of
the decimal) zeroes will be used to fill up the specified number of decimal places.
This field is disabled when the Fixed Point checkbox is unchecked.
Monitored Object
The object reference entered into this field will be the object on which the
calculation is being performed. The monitored object can be selected from the
drop down list or entered manually. Only the local BI, BO and BV objects are
available in the list. Any object on the network (remote or local) with a discrete
value can be entered into this field.
Number of Starts
This is a read-only field that lets the operator know how many times the
monitored object has turned on.
Totalizer Started At
This is a read-only field that displays the time and date when the monitored object
is selected and applied, after initial BT creation. If the object is reset as described
earlier in this section, the time will be set to the current DCU time.
COV Increment
Specifies the minimum amount of change in the object value required to cause a
Change_Of_Value notification event. This property is used for the purposes of
trending. For more information on Trending read the Trending Chapter of the
Manual. The number of decimal places in this object is dependent on what is
chosen in Fixed Point and Decimals properties.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
Header
Object Value
The value of a Binary Variable (BV) will be one of two values. The default value
for the Delta Controls BV is either ON or OFF. These values represent the
physical condition of the input. The setup displays ON for the Active State and
OFF for the Inactive State.
The Binary Device Configuration (BDC) Object defines what text is displayed for
the ACTIVE/INACTIVE state. If no reference is made to a specific BDC Object
in the Device Type field of the Device Tab, the default relationship is as given
above.
Objects, such as Programs and Control Loop Outputs, local to and remote from
the Device, may write values to the Object Value. The last Object to write
overwrites the value and becomes the Present Value.
For non-Delta equipment, the states are named by the Active and Inactive text as
defined within their Binary Variable Object.
Object Mode
Auto The Object Value reflects changes made to the object in a GCL+ program.
Manual The Object Value no longer reflects changes made to the object in a
GCL+ program. The last value—or any value that is manually entered—remains
until the object is returned back to Auto. The status indicated in the navigator
window shall be “Out of Service”.
Control Source
Control Source is a proprietary feature that holds the Name of the Object that is
controlling the Object in the Auto mode. The control source will display the name
of the last object that wrote to the BV. If the object which is writing to the BV is
from a remote controller, the Control source will display the Device number
which that object is resident on. If a BV object is set to a manual value on the
OWS panel, the control source displays the Username that is currently logged in.
Auto Value
Auto Value will display the value that a Delta Version 3 Program, or Control
Loop Output, is writing to the BV. Non-Delta systems will not write to this field.
They will write directly to the object value, even if the object is in Manual mode.
Description
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Device
Device Type
For Delta equipment, Device Type is a combo-box that lists the Binary Device
Configuration (BDC) Objects available for assignment to this Variable. This lists
the BDCs that are resident on that DCU.
The BDC Object defines binary units such as Dirty/Clean, High/Low etc. The
BDC Object defines these units and matches them to the corresponding
ACTIVE/INACTIVE state (i.e. OPEN / ACTIVE, & CLOSED / INACTIVE).
The status field in Navigator can have the following values for this object:
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
The DSM-RTR will automatically create a second BMD object. Other types of
Ethernet DSC-based devices do not create the second BMD object and also will
not use the second object if it is present. The names of the BMD object's are:
• BBMD List1 #
• BBMD List2 #
# is the Device Address
The first BMD object is used for the first UDP/IP adapter, and the second BMD
object is for the second UDP/IP adapter.
The OWS does not allow a BMD object to be deleted. If a DSM-RTR database is
loaded into a DSC, then the second BMD object will persist forever.
Addressing
Each line of the Remote BBMD Addresses can be used to hold one IP Address. An
example of a typical IP address is 192.168.10.1. Each of these IP addresses is used
to identify other BBMD devices on the network. The local device is not identified
in this table.
Thus in a network where four different IP segments are to be part of the same
BACnet network, each of these BBMD tables would have three addresses.
IP Filter
Ethernet DSC-based controllers are able to utilize only the Block Ethernet
broadcasts from Delta devices filter.
The IP Filter tab of the BMD object is used to eliminate unnecessary incoming
network traffic (packets) from being routed from one network to the IP
network(s). In other words, packet filtering restricts network traffic from entering
other sections of the network. It is intended for use in large Wide Area Network
(WAN) applications by the BACnet/IP Router (DSM-RTR) for improving
network speed by minimizing the amount of network traffic.
Note: Before enabling IP packet filtering, you should have a good understanding
of your network and have determined what type of traffic you want to filter.
These filtering options are only available on the DSM-RTR. However, Ethernet
DSC-based controllers are able to utilize the ‘Block Ethernet broadcasts from
Delta devices’ filter.
IP Filter Function:
Block Ethernet broadcasts from This filter blocks global broadcast packets,
Delta devices received on the Ethernet network that
originated from any Delta device (not
including the OWS), from being routed to
the IP network(s). This filter will not block
global broadcast packets that originated
from any non-Delta device, nor will it block
non-global broadcast packets from any
device.
Disable routing between UDP/IP-1 This filter blocks all packets from being
and UDP/IP-2 routed between one UDP/IP adapter to
the other.
Disable IP Regular support This filter restricts the device from re-
broadcasting packets over the local IP
segment(s). In addition, with this filter
enabled, the device will ignore BACnet/IP
packets from other devices on the local IP
segment. This filter can be specifically
enabled on either UDP/IP port (or both)
Disable routing global broadcasts This filter blocks global broadcast packets,
received on any network port (UDP/IP,
Ethernet, MS/TP), from being routed to
the IP network(s).This filter can be
specifically enabled on either UDP/IP port
(or both)
Disable Foreign to Foreign This filter restricts the device from sending
communication packets from one foreign device to
another foreign device. This filter can be
specifically enabled on either UDP/IP port
(or both).
Disable routing between Ethernet This filter blocks all packets from being
and UDP/IP routed between Ethernet and UDP/IP This
filter can be specifically enabled on either
UDP/IP port (or both).
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
This object defines a group of data items that are exchanged. A user can configure
the settings of the object to suit the data exchange needs. This bulk exchange
eliminates the necessity of a large quantity of Data Exchange Local (DEL) / Data
Exchange Remote (DER) object pairs.
The concept of a bulk data object is not new. Delta Controls Version 2 product
provided a similar feature using its Highway Output (HO) object and IC Screens.
In the Transmit Entries, the BDE object can directly fetch values from local
objects while only GCL can read the received values from the BDE object in the
Receive Entries. The receiver’s BDE object cannot write directly to local objects.
In order for Bulk Data Exchange to occur between controllers, the BDE objects
must have the same object (Channel) name which makes the BDEs function
independent of instance numbers. Whenever a BDE exists on a device it does data
exchange with any other BDE on the network as long as they share the same
Name (Channel). A unique BDE name represents a unique channel for data
exchange between the controllers.
Supported controllers for the BDE object include eBUS and devices with DSC16
and DAC8 images.
Note: If receiving data from multiple controllers to one controller is desired, one
channel must be used for each transmitting controller. For example, if there are 3
transmitting controllers, each transmitting controller must have a BDE object with
a unique Name (Channel) and there must be 3 BDE objects in the receiving
controller corresponding to each transmitting BDE object.
total = 0
i = 0
ForAll Receiver In "BDE*:*"
value = Read ("BDE:" & Receiver.Name & ".IAT")
total = total + value
If i = 0 Then
minval = value
maxval = value
Else
If value < minval Then minval = value End If
If value > maxval Then maxval = value End If
End If
i = i + 1
End For
Average = total / i
Minimum = minval
Maximum = maxval
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
The Setup Tab contains the Name (Channel), Broadcast Interval and Exchange
Type fields.
Name (Channel)
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on other supported controllers such as a DAC.
The name must be unique among the objects located on the same controller.
The Name of a BDE object is not just a name. A unique name represents a unique
channel for data exchange between the controllers at a defined frequency. So
whenever a BDE exists on a device, it does data exchange with any other BDE
on the network as long as they share the same name. The function of BDE
objects is independent of instance numbers.
For more information, refer to the information at the start of this object.
Broadcast Interval
Specifies the interval in seconds at which the BDE transmits. Only the transmitter
uses this parameter. The range of the Broadcast Interval field is 10 to 100 seconds.
The Broadcast Interval field in the Bulk Data Exchange object has a default value
of 120 seconds.
Exchange Type
The Exchange Type dropdown field in the Bulk Data Exchange object contains
the following options: Broadcast and Broadcast & COV.
Transmit Entries
The Transmit Entries tab provides a list of Tag and Object entries that are
transmitted. One BDE object can transmit to multiple controllers at the same time.
Dataview
The Transmit Entries Dataview contains the editable Tag and Object fields and
also the read only Last Value Sent field.
Next Broadcast in
Counts down the time in seconds to the next scheduled broadcast.
Receive Entries
When an entry is added to the transmitter list of a BDE object, the Tag and Last
Received Value dynamically update in the corresponding BDE objects on the
network.
The Receiver lists get dynamically updated when an entry is entered into a
transmitter on the same channel.
The device can read and assign values from the BDE object by using the
following Read command in GCL: AV1=Read("BDE:Channel_Name.Tag")
Last Received
Counts up the time in seconds since the last data exchange was received.
Receive Dataview
The Dataview includes the names of entries transmitted from a BDE object on
another controller. The BDE controllers must have the same object name to form a
channel which shares entry name and data.
Destinations Tab
The Destinations tab contains a Broadcast Destinations edit box. The Broadcast
Destinations field accepts network numbers and device addresses.
If NET0 is entered into the Destinations list, the local broadcast does not get
forwarded to any other ports by the receiving controller. If NET65535 is entered
into the Destinations list, the global broadcast is forwarded onto each of the
receiving device's ports.
If a specific network number is entered into the Destination list, the receiving
device only forwards the BDE packets onto the correct port if that specific
network number exists. If a specific device address is entered into the Destination
list, the receiving device only forwards the BDE packets onto the correct port if
that specified target device exists.
Status
The Status Tab contains the Next Broadcast in, Time Since Last Update and
Received From data view fields.
Next Broadcast in
The Next Broadcast in field displays the number of seconds before the controller's
BDE is required to transmit data again. This field is always decrementing as long
as the controller has data to send via BDE.
COVs Remaining
The COVs Remaining field displays the number of COV updates that the BDE
object can send until it has to wait another broadcast interval to send again. This
field only decrements if Broadcast and COV is the selected Exchange Type.
Heading Function
Device This column contains a list of entries for sending devices.
Time This column contains the time that a data transmission was
Received received from the particular device.
CALENDAR (CAL)
Calendar Objects define a specific day, range of days, or recurring days during the
year when equipment and/or systems will operate differently than they would
otherwise according to normal Schedule Objects.
The Calendar Object can be linked to the Schedule Object starting on page 10–
691. This will provide the operator with a convenient method of overriding the
normal weekly schedule of the Schedule Object.
Header
Object Value
When the Calendar Object is set to Auto and the current date for the Device is
selected in the calendar, the object value will display ON; otherwise it will display
OFF.
When the Calendar Object is set to Manual, select between ON or OFF to override
whatever value is set in the calendar. After you toggle to the desired value you
will have to select APPLY or OK for the change to take effect.
Object Mode
Auto The Object Value or state of the Calendar Object is set automatically by
the Calendar Object on the dates defined in the schedule.
Manual The Object Value or state of the Calendar Object is no longer set
automatically. Manual is set by an operator to test the response of a program to the
Calendar Object or to temporarily override the normally programmed dates.
Calendar
The Calendar object supports four types of calendar date entries and each has an
associated color:
This date format located in the description field is based on the Windows
Regional Settings located in the Windows Control Panel. The description field
content can be overwritten by the operator. This new entry will then be displayed
wherever the Calendar Entry description was.
For example when you go to edit multiple entries (orange colored date), a sub-
menu displays. The sub-menu contains the description field of each date entry.
This feature makes it easier for the operator to distinguish which entry is being
edited.
The Calendar Object has the ability to specify recurring dates. To call up the Add
Calendar Entry dialog, right click on a date in the Calendar and choose New
Entry… The top half of the dialog is where the operator can also set up Single
Date and Date Range entries.
There are also two types of Recurring Pattern dates. There is a single Date
recurrence (i.e.., Dec 31 of every Year) and Week & Day recurrence (i.e. First
Monday of Every Month).
If the recurring event is a single date type entry, then it is entered based on the
Date and it will recur every year on that Date. If the Date checkbox is unchecked,
then the operator has the option to set a whole month in a particular year by
checking the Year checkbox and setting a year, or chose every year by leaving it
unchecked.
If the recurring event is a Week & Day type entry, then it is entered based on the
Week, Day, & Month, that the recurrence will take place. Each entry has a drop
down box to pick the appropriate entry for each week, day and month field. Each
field has the choice to have Wildcard instance set.
For example if the month field has "Every Month" set, then that would be
interpreted as every month of the year would have the specific week and day set.
If the week field has "Every" set, then that would be interpreted as every week of
the month. The same is true for the day field with the "Week" option.
Description
The Description field will often be used for a detailed functional definition of the
object.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
For more detailed information about the Schedule object, see page 10–691 of this
document.
What is a Calendar
When a Calendar object defines special days of the year it overrides the normal
weekly operations specified in the Schedule object. You can use the Calendar to
change the operations for any day/date/month of the current or of a future year.
View a Calendar
You view a Calendar by double-clicking a Calendar object in Navigator. The
Calendar opens to the current month.
Use the month scroll buttons to view the months and years in a calendar. If the
forward month button is pressed once, then the following month displays. If this
button is held down then the months scroll until the button is released.
Legend
When a date on the Calendar is defined, it will be a different color.
The Calendar object contains a Legend defining what each color means.
Configure a Calendar
This section describes how to configure the following entries:
• Single date
• Date Range
• Recurring date
All three types of entries can be added, edited or deleted using right-mouse
commands. The Single date and Date Range can be added or removed using only
left-click, but you must use right-mouse commands to edit them.
4 Click on the description of the entry that you want to delete. (e.g. December
4, 2005)
5 Click Apply or OK to accept the changes. The blank field indicates its
deletion from the Calendar.
You can add or remove the Single date and Date Range types using a left-click
only, but you must use right-mouse commands to edit them.
3 Click the drop-down menu for the Start Date or End Date you want to
modify, and a small calendar displays.
4 After selecting the month you want, click the new date on the small calendar.
5 Click Apply or OK.
Date Recurrence
If the event is a recurring Date type entry, then it is entered based on the Date that
it recurs every year.
The following figure shows how to specify a recurring pattern for December 25 of
each year.
You can edit the Month field using the drop-down list and the Date field using a
spin box.
For example:
• If the Week field has an Every wildcard, then that is interpreted as every
week of the month.
• If the Day field has an Every wildcard, then that is interpreted as every day of
the month.
• If the Month field has an Every wildcard, then that is interpreted as every
month of the year.
The following figure shows how to specify the first week of every month as a
recurring pattern.
To edit dates:
1 On the calendar, right-click an entry and select Edit Entry from the submenu.
3 Select the entry, and then you can edit the date range or description.
What is a Schedule?
Schedules are used to define normal weekly operation of equipment. A Schedule
object contains seven weekdays and can have links to Calendar objects.
The Calendar handles exceptions to the normal weekly operations that are defined
in a Schedule. Equipment can operate with a Schedule based on the day of the
week or with a linked Calendar that is based on the day of the year.
For more detailed information about the Schedule object, see page 10–691 of this
document.
With 3.40, the Schedule object has expanded and enhanced capabilities. Schedule
objects now handle regular weekly and exception schedules that can cover either a
whole or part of a day. Both types function together, and allow partial day
scheduling, where both types can specify scheduling events on the same day. An
Exception Schedule can define a link to a CAL object. A Schedule can now
handle Real values and Multistate values in addition to the previous Binary
(ON/OFF) values.
The instance specifies the name of the Calendar object that is linked to the
Schedule object. Use the drop down list to select the correct Calendar Object.
For more information, see the Exception Schedule – Calendar section of Schedule
object starting on page 10–705.
Overview
Every individual who possesses one or more credentials is represented by a Card
User (CU) object and is referred to as a card user. A card user typically is assigned
one credential only; however, it is common for two to be assigned, for example,
one for facility access and another for the parking garage. The CU object resides
on the ASM.
The CU object is used to assign cards and keep access rights for an individual card
user. It defines which access groups the user belongs to. The CU object also keeps
card user data such as card numbers, PIN and various personal data.
The CU object in its default, as installed, format doesn’t allow you to store
detailed information about the card user such as contact information, physical
description, and photograph that could be used to confirm his/her identity.
However, it can be extended to store this type of information using an SQL
database package and an alternate CU object dialog.
In this section, the two dialogs are described by referring to them as limited and
extended. Instructions to install the SQL database package and the extended CU
object dialog are outside the scope of this document; refer to the Delta technical
support site knowledgebase articles for these procedures.
Header
Limited Header
Value
A read-only field that displays the card user status. There are four card user status
states:
Valid when a credential is presented, access granted or denied will be
determined based card user’s access rights
Inactive card user's activation date is in the future; when credential is presented,
access is denied
Expired card user's expiration date is in the past; when credential is presented,
access is denied
Disabled card user status set to disabled by operator; when credential is
presented, access is denied
Extended Header
The extended header displays a card user photo. The photo is stored in the SQL
database. To add a photo to the SQL database, use the Select Picture button on the
CU object Misc tab.
Description
Limited Description
The limited CU object dialog does not include a Description tab.
Extended Description
The Description tab is available in the extended CU object dialog. It can contain
up to 2000 printable characters. The description information is stored in the SQL
database.
The Description field would typically describe the access groups and anti-
passback privileges
Setup
Name
Name is the card user name and name of the CU object. Name must be unique for
the entire access control system, as enforced by ORCAview.
Choose your approach to naming card users with ease of administration in mind.
Familiarize yourself with the Card Users folder in the ORCAview and ORCAweb
Access tree view before deciding on your name convention. For example, if you
want to view card users ordered by last name then enter card user's last name first
and first name following. If you decide to use a separator other than a space
between names, do not use the characters, (comma) or . (period) as that could
cause problems in other software programs or when using GCL+. The
recommended separator is the underscore character (_).
Note: Longer name use more memory in the ASM, affecting the number of CU
objects you can create. With an average length of 25 characters per name, an ASM
can store 10,000 card users and an eBCON can store 50,000 card users. For details
on memory consumption, see Chapter 5 – Engineering Access Control.
Limited Name
The limited CU object dialog provides the Name field in which you enter the
complete card user name.
Extended Name
The extended CU object dialog provides two fields labeled First and Last. The
Name field is read-only and displays the complete card user and CU object name
as the concatenation of the First and Last field information. The First and Last
name information is stored in the SQL database.
Cards
The Cards section lists all the cards assigned to the card user, along with the status
of each card. Card users may have more than one card when vehicle tags or
different brands of card readers are used on the same site. A park garage tag or
vehicle tag and a facility access card are the most common.
Each card has the following data associated with it:
Site Code The site code is used to verify access, in conjunction with the card
number, under normal operating conditions. In degraded mode the site code read
is compared to the site codes stored in the Access Door Module (ADM).
The site code has a range of 0 to 4294967294. When you enter a site code, note
that the leading zeros are not stored, so a site code of 00020012 is stored as 20012.
If using degraded mode, ensure that all site codes are entered into the Access
Setup (AS) object.
Card Number The card number is used to verify access, in conjunction with
the site code, under normal operating conditions. The card reader scans the
presented credential for its site and card number, compares them to the listed site
and card numbers until a matching card user is found. The ASM then determines
if the card user should be granted access.
The card number has a range of 0 to 4294967294. When you enter a card number,
note that the leading zeros are not stored, so a card number of 00020012 is stored
as 20012.
Card Status each card assigned to the card user has associated status. The
three card status values are:
Card User
The Card User section contains information specific to the card user and is applied
to all cards assigned to that card user.
PIN For a system that uses a Wiegand keypad, this specifies the PIN number
required for the user to gain access. Typically you use a 4-digit code so the PIN
would range from 0 – 9999. When you enter a PIN number, the leading zeros are
not stored, so a PIN number of 0001 is stored as 1.
Note: The system accepts Duplicate PINs on different Card Users. Keep in mind if
you have a Keypad only setup and your Card Users have duplicate PINs then it is
impossible to know exactly who the last user was. Therefore the last user data will
be incorrect in this case.
Activation Time/Date This is the BACnet time and date specifying when the
CU object status is set to Valid. When Activation Time/Date is selected, it
defaults to today’s date. When Activation Time/Date is not enabled, then the Card
User object status is set to Valid.
Expiry Time/Date This is the BACnet time and date specifying when the Card
User object status is set to Expired. When Expiry Time/Date is not selected, then
the Card User object status never goes to Expired.
When Expiry Time/Date is selected, it defaults to one year in the future; ensure
you set the year correctly.
It is also possible to specify both an activation and expiry time. Activation
Time/Date must always be earlier than the Expiry Time/Date.
Example
A janitor who needs extra time to pull all his equipment through the door.
Trace User
The Trace Users function allows an operator to clearly see which doors the card
user has been granted access. The Trace User function can activate an
Alarm/Event every time the card user is granted access at a door so that every
time a CU being traced logs an activity such as entering a door, an alarm pops up
requesting the operator’s acknowledgement. These alarms are also stored in an
Event Log (EVL) and a Compact Event Log (CEL) as determined in the Door
Controller (DC) settings.
Override Anti-passback
It is possible to override Anti-passback for certain users. Overriding the Anti-
passback is used to allow the user access, disregarding any Anti-passback options
set on doors within the Access Groups assigned to the user. APB events and
alarms will be generated for this user if this checkbox is checked, and the APB
details will not be updated.
Access Groups
To add a member to the access groups list or to remove a member, double click on
the white space in the Access Groups List area to display the Select Access
Groups dialog.
The Select Access Groups dialog provides two methods for adding an access
group to the Access Groups list:
• Select one or more access groups from the list titled Select Access Groups
and click >>
• Type the object reference in the form Device ID.object instance in the field
titled Add Access Group object reference, for example, 3400.AG5, and click
Add. This method allows you to add an access group that doesn’t yet exist so
you can engineer the database when the complete system is not available.
Click OK to add the access groups listed in the area titled Current Access Group
Selections.
Contact Info
The extended CU object dialog provides the Contact Info tab which can be used to
store relevant contact information for the card user. All contact information is
stored in the SQL database.
The field names are arbitrary. Any information can be stored in each field subject
to the printed character set and the maximum field length.
Phone Numbers
Home field length = 25 characters.
Work field length = 25 characters.
Pager field length = 25 characters.
Mobile field length = 25 characters.
Address
Address field length = 150 characters.
City field length = 50 characters.
State / Province field length = 50 characters.
Zip Code / Postal Code field length = 15 characters.
Country field length = 50 characters.
Email
Email Address field length = 50 characters.
Emergency Contact
Name field length = 80 characters.
Phone Number field length = 25 characters.
Miscellaneous
The extended CU object dialog provides the Misc tab which can be used to store
detailed identification information for the card user. All miscellaneous
information is stored in the SQL database.
The field names are arbitrary. Any information can be stored in each field subject
to the printed character set and the maximum field length.
Work Information
Employee Number field length = 20 characters.
Company field length = 50 characters.
Department field length = 30 characters.
Supervisor field length = 50 characters.
Personal Information
Select Picture allows you to browse for an image to associate with the card
user. This image is displayed on the CU object dialog header.
Birthday field length = 50 characters.
Height field length = 50 characters.
Weight field length = 50 characters.
Gender field length = 50 characters.
Hair color field length = 20 characters.
Eye color field length = 20 characters.
Vehicle Information
License Plate 1 field length = 20 characters.
License Plate 2 field length = 20 characters.
Anti-passback
Anti-passback Details
Zone 1 – 4 This is a reference to the first, second, third and fourth Door Group
(DG) that the card user is in and the time at which they entered that DG.
Reset Buttons It is possible to reset anti-passback zones individually. To do
this, click on the Reset button corresponding to the zone you would like to clear,
then clicking Apply or OK.
Reset All Zones This button resets all the APB Zones.
Example
The Reset All Zones button would be used if a user is locked out due to an anti-
passback violation and the operator would like to clear his/her anti-passback
completely.
Overview
A credential or card carries a unique set of binary numbers (ones and zeros) that is
transmitted in a Wiegand protocol data stream from the reader via a Wiegand
interface to the Access Door Module (ADM) which forwards it to the ASM for
processing. The reader itself and the ADM have no awareness of card data format
or content, nor are they aware of the card user's access rights. Card data format
information resides only at the ASM in the Card Reader (CR) object; access rights
resides in the Card User (CU) objects.
The Delta access control system supports readers with Wiegand interfaces for a
range of credential types such as proximity card, magnetic stripe card and
biometric readers. The total length of the Wiegand protocol data stream is limited
to a maximum of 64 bits to transmit one or two numerical data fields.
The CR object defines the credential data format that will be recognized from the
associated card reader. The Delta access control system recognizes only one
credential data format per reader.
The CR object receives the Wiegand protocol data stream from the reader and,
when the data stream matches the CR object's expected credential data format,
translates the data stream into a credential number.
The CR object is used to set up the parameters for the Wiegand device, most
commonly a card reader connected to the ADM.
On LINKnet modules, CR objects can only be created as 101, 102, 201, 202…up
to 1201, 1202, for up to 12 ADMs per ASM. Card Reader 101 is Card Reader 1 on
ADM 1 (LINKnet device 1). Card Reader 102 is Card Reader 2 on ADM 1
(LINKnet device 1). Card Reader 401 is Card Reader 1 on ADM 4 (LINKnet
device 4), etc. Other Card Reader objects can be created through software using
GCL for applications where no physical card reader is used.
Header
The Header displays the CR object’s operational status.
Scanning card reader is ready to accept credential presentation. Data is sent
from the Wiegand device to the CR object
Stopped card reader is out of service, no data is sent from the Wiegand device
to the CR object
Description
The Description field can contain information of up to 2000 printable characters.
The Description field is often used for a detailed functional definition. For the CR
object, the Description field would typically describe where the reader is located,
what make of reader it is and so on.
Setup
Name
Name is a descriptive label given to this object. Although it is not necessary, the
name should be unique within the BACnet network. The name must be unique
among the other names located on the same ASM controller. The name is limited
to 67 printable characters.
Reliability
Reliability provides an indication of object status regarding reliability of data.
This property has one of the following values at any given time:
No Fault Detected – CR object is functioning normally.
LINKnet Offline – indicates that the ADM associated with the CR object is
offline.
Missing cfg Object – indicates that there are missing parameters, or that the
referenced input or output is missing.
Not Available – Delta’s proprietary reliability code which indicates that the output
does not physically exist in the Door Controller object.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Card Format
Use the Card Format tab to set up the card data format that you want the CR
object to recognize and decode. The Card Format settings define the format of the
Wiegand protocol data stream sent from the reader when a card is presented or a
keypad entry is made.
The CR object includes several built-in card formats and a capability to configure
the CR object to recognize proprietary formats.
Card Format
The credential formats listed below are built-in to the CR object. You don't need
to know the detailed data stream format:
Wiegand 26 Std - use this setting when credentials are encoded with Wiegand
standard 26 bit data.
AWID Delta Custom – maintained for compatibility; no longer recommended
AWID Keypad 4 digit 26 bit – maintained for compatibility; no longer
recommended
HID 37 bit - use this setting when credentials are encoded with proprietary HID
37 bit data. Originally Hughes Identification Devices, HID Global is now an
ASSA ABLOY brand.
HID Keypad 4 digit 26 bit - use this setting when an HID keypad only with
Wiegand standard 26 bit data is associated
Keri Pyramid 39 bit - the proprietary Keri Pyramid 39 bit credential format is
built-in.
AWID Combo CR & KP 26 Bit 4 Digit – maintained for compatibility; no
longer recommended
Stats
Use the Stats tab to monitor the card number data from cards and PINs presented
at the reader. If the data from a presented card isn't displayed then likely you don't
have the card format configured correctly.
Last Card
Time Read Displays the time and date that the last card was read on this
reader.
Site Code Displays the site code of the last Wiegand data read on this reader.
Number Displays the card number of the last Wiegand data read on this
reader.
Last PIN
Time Read Displays the time and date that the last PIN was entered on this
reader.
PIN Displays the last PIN entered on this reader.
Trouble indicates there is a problem with the respective power to the reader.
Overview
The Compact Event Log (CEL) object records events generated by all Door
Controller (DC) and Elevator Controller (EC) objects on an Access System
Manager (ASM). The CEL object does not record alarms.
CEL1 is a local object that is created automatically on the ASM with or without
the Access Door Module (ADM) connected and named Access Control Event
Log. Only one CELl object is necessary.
For further information on the various events that can be generated, see the DC
object Events tab and the EC object Events tab. In addition to these events, the
CEL object also stores events including Time Change, Reset and LINKnet Offline
which are generated in the Access Control Setup (AS) object. The CEL object
monitors each DC object, EC object and AS object for new events.
The CEL object automatically updates to Historian if you have Historian set up on
your network. For further information on using Historian and generating reports,
see the ORCAview Technical Reference Manual – Chapter 6 – Trending and
Archiving Data.
Event Log
The Event Log tab displays event notifications that are generated by DC objects,
EC objects and the AS object. The event log defaults to store 1000 events; it can
be configured to hold up to 2000.
The Event Log logs all the events that you specify in the DC objects and EC
objects. It also logs events that you cannot select or unselect from an object.
For details about the events generated by the DC object and EC object, see their
respective sections.
Event Type Event Text Description
Time Change Time Change An Operator has set the panel time.
Database Load Database Load A database has been loaded into the
controller. 0 indicates the Load from
file and 1 is from flash.
`Database Save Database Save A database has been saved out of the
controller. 0 indicates the Load from
file and 1 is from flash.
Database Clear Database Clear A database has been cleared from the
controller’s memory.
Device Reset Device Reset The controller has been reset.
LINKnet Online LINKnet Online A LINKnet device has come online,
Arg indicates LINKnet address.
LINKnet Offline LINKnet Offline A LINKnet device is offline, Arg
indicates LINKnet address.
Status The status indicates whether or not the event has been sent to Historian.
If the event has been sent, status displays Sent, otherwise, it displays Not Sent.
Setup
Name
Name is a descriptive label for the compact event log and what it is logging. When
the CEL object is created, it is given the name Access Control Event Log; you
should not change this name. Although it is not necessary the name should be
unique within the BACnet network. The name must be unique among the other
descriptors located on the same controller. The name is limited to 67 printable
characters.
Reliability
This property provides an indication of the status of the object regarding reliability
of data. This property will have one of the following values at any given time:
No Fault Detected – This is the normal state.
Missing cfg Object – This indicates that there are missing parameters, or that the
referenced input or output is missing.
Not Available – This is Delta’s proprietary reliability code, which indicates that
the output does not physically exist in the specific object.
Buffer Size
Buffer size sets the number of events you want stored in the event log. Buffer Size
defaults to 1000 and can adjusted up to 2000 events.
Once the logged events reach the buffer size, the oldest event is overwritten by the
next event.
HVAC/Access/Lighting Checkboxes
These checkboxes are used to indicate which application(s) the object is being
used for. Any combination of HVAC, Lighting and Access Control can be
selected. Leaving all checkboxes blank is the same as checking them all. For
more information, see the section on Security in the SUG/SUA objects.
Alarm Output
Alarm Output
Alarm Reference - The referenced Binary Output (BO) or Binary Variable
(BV) object is turned On when certain events occur. The adjacent filter button
toggles between including only local BO objects or including both local BO
objects and local BV objects in the list. Use the checkboxes in the Alarm Values
section to select which events turn On the Alarm Reference.
If the Alarm Output Reference is relinquished by GCL+, it will never turn back on
again unless additional GCL+ code is executed.
Here is the code to reset the Alarm out:
// CEL Alarm Reset is a user defined variable i.e. BV or BI
// Toggle CEL Alarm Reset from OFF to ON and then OFF again
// Result:
// 1) Alarm Output Reference is automatically turned off
// 2) Alarm Output Acknowledged event is generated
//
IfOnce 'CEL Alarm Reset' Then
'Access Control Event Log.AlarmAck' = TRUE
End If
Alarm Values
Use the checkboxes in Alarm Values section to select events that you want to turn
On the Alarm Reference output. The checkbox options available in the Alarm
Values field change based on the HAL Flags on the Setup tab. For example, if
Access is checked, then only Access type events checkboxes are displayed.
The access control checkboxes are described below:
Device Statuses Indicates the status of a device. Possible values are Device
Reset, Load, Save, Load Flash, Save Flash, Input On/ Offline
Time Change An operator has set the controller time.
Forced Open The door has been opened when it is locked.
Door Ajar The door was unlocked and opened, but has been held open longer
than the Pulse Time plus the Door Ajar Time.
Schedule Unlock Schedule or Lock Schedule input has controlled the door.
Relock Mode Door is unlocked/ locked in Relock Mode.
Door Group The door is controlled by a Door Group (DG) object.
Manual Operator Elevator Control (EC) or Door Controller (DC) is manually
controlled by the operator.
Hatch Elevator hatch has been opened or closed.
Bypass Elevator Controller (EC) is in Bypass. The Bypass input has
transitioned.
Emergency Elevator Controller (EC) emergency input has changed.
Valid Access a card user has been granted access to the door/elevator.
Invalid Access a card user was denied access for Invalid Zone, Time Zone
Violation, or Unrecognized Card etc.
Lost Card A lost card was presented at the door/elevator.
Trace User a card user with Trace user enabled was presented and access
granted at the door/elevator.
Public/Secure Change elevator has transitioned from Public Mode to Secure
or vice versa. Public Mode input has changed.
Override EC floor was overridden to enable floor buttons for anyone.
Request to Exit Request To Exit has been requested.
Motion Detector motion detector has locked / unlocked a door in Relock
Mode.
Approve Access A card presentation was granted device access to a door in
Approve Access Mode.
GCL The door is being controlled through GCL+.
Life Safety The EC/DC object Life Safety input has transitioned and EC/DC is
in Life Safety mode or restored.
Trouble A supervised circuit has been tampered with or the object is in trouble.
Description
The Description field can contain up to 2000 printable characters.
The Description field will often be used for a detailed functional definition. It may
include all relevant facts pertaining to Event Logs and what events you are
logging.
The COM Port field on the Setup tab of the Serial (RS-232) Port Settings (SNS)
Objects sets which Communications (COM) port a serial interface uses.
Although default settings are usually adequate, the PTP (RS-232) Port settings
(SNS) Objects allow for the COM port to be adjusted.
Typically either Com1 or Com2 will be used for communication with the system
from the ORCAview workstation. For a DCU, the available options are Com1 and
Com2, which correspond with the serial ports on the DCU. Com3 on the DCU is
the MS/TP / RS-485 port used to communicate to DACs, Zone Controllers, and
other 485 devices.
Header
The header shows if the port is enabled or disabled.
Object Mode
Communications Port Enabled Communications through the specific port
is enabled.
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
Name
Name is a descriptive label given to this object. The name is automatically
generated by the default database and cannot be modified.
The CO object does not support remote object references for its Input and Setpoint
fields.
Header
Value
This field displays the present value of the Control Loop output. The value will be
a number between 0 and 100%
Object Mode
Auto The Control Loop output is controlled automatically, based on the current
Input value, Setpoint value, and tuning parameters. The value is written to the
selected output at Priority 11.
Manual The value of the Control Loop based on the current Input value,
setpoint value, and tuning parameters is no longer displayed.
Setpoint
The Setpoint is defined as the desired value that the Input should achieve as the
Control Loop manipulates its output value.
This spin control is used to enter the Setpoint, which the Control Loop will use to
run the Control Loop Algorithm. This value may be entered directly in this spin
box.
The setpoint may also be set in the form of an Analog Variable (AV) entered in
the Setpoint (Optional) field in the Setup Tab. The setpoint value may be written
directly to the CO object from GCL+ using the syntax COX.Setpointvalue, where
the X is the instance of the CO Object. Immediately to the right of the Setpoint
field is a read only field, which displays the name of the object that holds the
value of the setpoint. The default setting for the Setpoint is 0.0.
The Analog Variable (AV) entered in the Setpoint (Optional) field in the Setup
Tab must be on the same controller as the Control Loop object. The Setpoint
(Optional) must be a local object and cannot be in another controller.
Bias
The Bias is the value of the Control Loop when the error is 0 (Input = Setpoint).
The Control Loop Output will be equal to the Bias when the Input is equal to the
Setpoint. In a Proportional only Control Loop or when the Reset Rate is set to 0.0,
the Bias remains fixed and is not adjusted by the Reset action. The Bias would
normally be fixed at 50% and that is its default setting. When Integral action is in
effect the bias will be adjusted until the Input value is equal to the Setpoint value
or the output of the Control Loop becomes 0% or 100%.
The Bias can be entered directly in the spin box as a fixed value or it can be set by
equating a variable or fixed value to the Bias through GCL+, using the syntax
COX.Bias where the X is the instance number of the Control Loop within that
Device.
Input
This is a read only field that shows the present value of the Input to the Control
Loop. This would normally be an Analog Input or Analog Variable. The name of
the Input is displayed in a read only field immediately to the right of the Input
Value. The Input is assigned to the Control Loop by entering the Input acronym or
descriptor in the Input field in the Setup Tab.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
Object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
The Input Object can either be selected from the Drop Down list or entered into
the field manually. Only Local AI and AV objects are available for selection in
the drop down list. The input entered in this field must be on the same controller
as the Control Loop object. The input must be a local object and cannot be in
another controller.
Setpoint (Optional) The Setpoint (Optional) must be a local object and cannot
be on another controller. The Setpoint Object can either be selected from the drop
down list which contains only Analog Variable (AV) objects or entered into the
field manually as an acronym or descriptor.
Output (Optional) This edit field allows the operator to enter the acronym or
descriptor of the object that will receive the present value of the Control Loop.
The Output Object can either be selected from the drop down list or entered into
the field manually.
There are 2 filters for this field: the Primary filter and the Secondary Filter. By
default the Primary Filter is enabled and only local AO objects will be available in
the list. To enable the Secondary filter, depress the ellipse button to the right of
the Monitored Object field. The Secondary Filter is enabled and the drop down
menu now contains a list of available Local AO and AV objects. This field does
not support remote objects.
This is an optional field as the present value of the Control Loop may be either
accessed directly or equated to another object using GCL+. This value is written
to the selected output at Priority 11.
Priority
This is the level within the BACnet Priority array that the Control Loop Object
writes, when assigned to an Output Object. The default setting is Priority Level
11.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Tuning
Controller
Type
This combo box is used by the operator to set the type of Control Loop. The
tuning fields are enabled or disabled depending on the controller type selected.
I – The Control Loop will act as an Integral Controller (Reset action only)
PI – The Control Loop will act as a Proportional Controller with Integral (Reset
action)
PID – The Control Loop will act as a Controller with Proportional, Integral and
Derivative action.
Action
This field is used to define whether the Control Loop will be a Direct or Reverse
acting Control Loop.
Direct – When this type of action is selected the Control Loop output increases as
the input increases.
Reverse – When this type is selected, the Control Loop output increases as the
input decreases.
Proportional
Proportional Band The Proportional Band is defined as the amount or span
by which the Input must change in order to cause full change in the Control Loop
Output and has the same units of measurement as the Input. The Proportional
Band is a band around the Setpoint from one half the Proportional Band below the
Setpoint to one half the Proportional Band above the Setpoint. The value of the
Proportional Band is set by entering a fixed value in the Band field using the ▲▼
buttons on the spin control or by entering a value directly.
A Deadband is generally only used when the Control Loop is used to control an
analog output. In this situation, changes in the physical input cause corresponding
fluctuations in the analog output. When the physical input is actually changing,
this is not a problem. A problem exists, however, when small changes in input
(especially around Setpoint)—caused by noise, static or the inaccuracy of the
sensor—result in the constant fluctuation of the analog device and unnecessary
wear on the actuator.
To avoid this problem, use a Deadband to fix the Control Loop Output. When the
input is within the Deadband area, the Control Loop value will not change. The
following figure is reverse acting.
Integral
Reset Rate The Reset Rate affects how fast the Control Loop Bias is adjusted
in an attempt to make the necessary output correction to bring the measured Input
equal to the Setpoint value, and thereby remove any offset. The Reset Rate is
defined as the amount of change that will occur in the Bias each minute. For
example, a Reset Rate of 1 will change the bias at a rate of 1% per minute.
The Reset Rate is entered as a fixed value in the Rate field using the ▲▼ buttons
in the spin control or by entering a value directly.
Reset Band The Reset Band is defined as the band around the Setpoint from
one half the Reset Band above the Setpoint to one half the Reset Band below the
Setpoint, and has the same measurement units as the Input.
If the Input is outside the Reset Band, the effective rate will equal the actual Reset
Rate. When the Input is within the band, the effective Reset Rate will be
proportionally reduced until the Input is within the deadband, the effective Reset
Rate will be 0 and no further Reset action will take place. The Reset Band is
entered as a fixed value in the Band field using the ▲▼ buttons in the spin
control or by entering a value directly.
Derivative
Derivative Gain The Derivative Gain defines the amount of correction that
will be added to the Bias based on the rate of change of the measured input. The
faster the input is changing, accelerating or decelerating, the greater the correction
that is added to the output. The value of the Derivative Gain is set by entering a
fixed value in the Gain field using the ▲▼ buttons on the spin control or by
entering a value directly. Larger values for Derivative Gain will cause a larger
change in the Bias for the same change in the input value.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
Proportional Band The range over which the input must vary to cause a
change in the controller output from to 0 to 100 %. The Proportional Band is
centered around the setpoint.
Output Bias: The Controller Output is equal to the output Bias when the Input is
equal to the Setpoint. In a Proportional Only Controller (i.e., when the Controller
Type is P only), or when the Reset Rate is set to 0.0, the Output Bias remains
fixed (normally at 50.0%) and is not adjusted by Reset action.
When a Controller is defined with Reset action, the Output Bias is continuously
adjusted until the Input is as close to the Setpoint as possible.
Reset Band The Reset Band provides a dynamic means to adjust the amount
of Output Bias added to the controller output. When the Input is outside of the
Reset Band, the effective reset rate is equal to the specified Reset Rate. When the
Input is within the Reset Band, the effective Reset Rate is proportionally reduced.
When the Input is within the deadband, no further reset action occurs.
Reset Rate The Reset Rate determines how fast the controller bias is adjusted
to make the necessary correction so that there is no offset between the signal and
the setpoint. The Reset Rate is defined as the amount of bias change during one
minute. It is expressed as percentage change per minute.
Deadbands should be small enough so that the occupant does not notice the
temperature variations within the deadband. However, setting deadbands too small
will make actuators adjust frequently and unnecessarily thus causing unnecessary
wear.
Tuning a Controller
Typical values for Deadband are rarely above 1 C (0.5 F).
Within the span of the Deadband (around Setpoint), the controller does not change
its output. The intention is to prevent unnecessary modulation of valve and
damper actuators, which could cause premature wear.
To tune a controller:
1 Set both the Reset Rate and Derivative Gain to 0.0 to eliminate any reset or
derivative action.
2 Adjust the Proportional Band as follows:
• If the Controller is unstable, widen the Proportional Band until the
Controller is stabilized.
• If the Controller stabilizes, reduce the Proportional Band until the
Controller becomes unstable. Increase the Band until the Controller
stabilizes again.
3 Introduce a Setpoint change and observe the Controller response. If the
Controller does not stabilize as desired, then increase/decrease the
Proportional Band slightly and repeat this step.
4 As a rule of thumb, set the Reset Band to 1/4 of the Proportional Band.
5 Increase the Reset Rate gradually until the input reaches Setpoint. Be sure not
to set the Reset Rate too high. This could cause the Controller to react faster
than the controlled variable can respond to a Controller output change and
create instability.
6 Once the Controller appears to have stabilized and the input is close to the
Setpoint, introduce a change to the Setpoint and observe the response of the
control loop. If the Controller does not stabilize, reduce the Reset Rate and
repeat this step.
7 Introduce appropriate Derivative action only if the application is suitable and
warrants it. Introduce a Setpoint change and observe the response to the
control loop.
8 If at any point oscillation begins to occur on the output, suspect that either the
Derivative or Reset gains are too high or that the Proportional Band is too
narrow. Try decreasing the Derivative and Reset Rate values first.
A control loop is tuned to the conditions that exist at the time of tuning (both
setpoint and load conditions). It may be necessary to tune a controller at a later
date if the conditions change. This is particularly true for the load conditions (i.e.,
the difference between an unoccupied building and when it has been occupied
with people and equipment and lights have been turned on). There may also be
seasonal considerations. By not tuning too tightly, it is possible to alleviate the
necessity of re-tuning.
Proportional
Deadband Band
Problem: Cycling If the controller is not tuned properly, then it may cycle
rapidly from heating to cooling. The following figure shows cycling.
Cycling
delay
Cycling
Room Temperature
Deadband
Occupant Setpoint
Temperature
Time
Check that the proportional bands for both heating and cooling are wide enough to
allow the system enough time to throttle down as it approaches the deadband.
• The damper and the heating coil are distant from the controlled area;
• The area receives heat from other sources such as machinery, sunlight or
personnel; and,
Check that the reset rate is set properly. The Reset Rate controls the integral gain
of the Controller. A high integral gain can also cause cycling.
Deadband
Cooling Cooling
System On System On
Temperature
Time
In this example, the common solution is to set the reset rate higher. With an
insufficient reset rate, the system will not correct small differences that persist
over a long period of time.
Overview
The Database Information Object provides information on the controller’s current
database. It displays information like memory or whom the last change was done
by, database revision number, etc. This object is a Delta Control proprietary object
and does not appear in other vendor’s products.
The DBI Object is created in every controller (only for BACnet devices and not
3rd party device) on startup and cannot be deleted or created by the user. The DBI
is always DBI<Controller #> and has the name ‘Database Information’ for all
device types.
Description
This tab contains the description field for the DBI Object.
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
For example:
DB created in:
DAC-T305
V3.33 - 35516
Img: DAC
Database
This tab contains information about the database contained in the controller. All
the fields on this tab are read-only.
The database size of the controller would be Total Database Memory minus the
Database Memory Free.
The total number of objects shown here does not match the number that you see in
the status bar in Navigator. The total listed in the DBI includes all objects,
including those not normally visible to the user such as EVA or EVN objects.
Database Revision
This field is used to keep track of the revision number of the controller database.
The database revision is represented by a whole number. The Database Revision
is incremented any time an object is created (including copying and pasting an
object), deleting an object, and modifying an object’s name.
When a database is loaded the database revision number should be the same as it
was when you saved the controller database.
Dictionary Version
The Dictionary Version tells the user what Dictionary Version the controller is
using. This field does not mean anything to the user and is supplied for possible
trouble shooting purposes.
Device Type
The type of device that the DBI is contained in is displayed in this field. It is a
string that represents the Delta Controls product number of the product. For
example when looking at the DBI in a DCU this field would display “DCU050”.
Product
The Product tab is used to give the user information about the product that the
DBI Object is contained in. It gives information like Scan rate, CPU Speed,
Memory Installed, Hardware revision, etc.
Application SW Version
Application SW Version displays the version of software of the device that the
DBI is contained in. Currently the software version for both a DCU and/or an
OWS is 3.30.
Build Number
This field displays the build number of the Application Software Version of the
device that the DBI is contained in. The build number for a DCU and OWS
running 3.30 is different as the two pieces of software are built independently.
Hardware Version
Displays the Hardware Version of the device. If the device is an OWS “N/A” will
be displayed here. The hardware version of the controller will be displayed here.
This allows you to check the version of your hardware without actually going to
the controller.
CPU Speed
Indicates the actual speed of the processor that the controller is using. If you are
looking at an OWS station then “0 MHz” will be displayed here.
A basic DCU comes with 256 kilobytes of static memory installed on board. The
DCU has the capability to expand its SRAM in the future. An OWS has a set size
of 500 kilobytes of static memory available for database creation.
Objects
This tab simply gives a list of all the objects contained in the controller that the
DBI is in.
You can scroll through the list using the scroll bar to the right of the Dataview.
You can open an object from here by right clicking and choosing the Open option.
You cannot double click on an object to open it.
DEVICE (DEV)
The Device (DEV) object contains general information about the controller
including status, setup, and configuration. The object is automatically created by
the operating system and numbered according to the logical address of the DCU
or DAC controller. Thus, controller 1 would have the object acronym of
100.DEV100, while controller 6 would have the object acronym of 600.DEV600.
You can copy a complete panel database to or from a file on disk, by copying to or
from the DEV Object. In Navigator, right click on the desired controller. Select
LOAD to copy from a file; or, select SAVE AS to save to a file.
The Controller Graphic field on the Configuration tab of this object allows a
designated graphic to be defined in a global manner for any OWS. This graphic
can display when the DEV object is opened using the right mouse Open command
in the Left Pane of Navigator. The Device object opens normally in the Right
Pane of Navigator when the object is double clicked.
The Device Graphic tab on NVS provides a way to provide an exception and
make a local definition of the designated graphic. The Device Graphic tab of the
Navigator Settings (NVS) / Device Graphic List (DGL) object defines the
available graphic files in a local manner for a specific OWS.
Header
System Status
This read only value indicates the current state of the device. The status
descriptions are:
• OPERATIONAL
• OPERATIONAL_READ_ONLY
• DOWNLOAD_REQUIRED
• DOWNLOAD_IN_PROGRESS
• NON_OPERATIONAL.
If the controller does not have a real-time clock, this field will be updated when it
receives the current time (i.e. Time Synchronization message or selecting Tools ->
Set Panel Time). It calculates the time that the last reset occurred at by taking the
current time and subtracting the elapsed time since the reset.
Reset Count
This read-only field indicates the number of times that the device has been reset
since the last time the database was cleared.
Reset Reason
This read-only field displays the reason for the last Reset. This field may be blank,
or may have one of the following reasons: Shutdown, Poweroff, Error Reset, or
Null.
Description
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Software Address
This field sets a software address for a controller that is configured for software
addressing.
On the DCU controller, this field defines the address of the controller when all the
DIP switches are set to OFF.
Note: The DCU or DAC controller must be reset to activate the software
addressing option.
On DAC products, the DNA jumper must be removed before the address can be
set using this field. With the room controller, it is possible to adjust the address
using the configuration menu of the controller without removing the DNA jumper.
Currently in the DSC/DAC, the user can set all the DIP switches to OFF. This
results in the controller appearing on the network as DEV0, which will result in
problems with DNA and can cause problems on the network.
Location
This field is where you can enter the physical location of the controller. For
example, you might write: Located in Ceiling above Door in RM211.
Latitude
This field describes the latitudinal geographical location of the controller. For
example you could enter 49.5º north. The latitudes have a resolution of 0.1
degrees. This field is used in the calculation for Sunrise and Sunset algorithms
used in GCL+ (see GCL+ chapter for a description of that function).
Longitude
This field describes the longitudinal geographical location of the controller. For
example you could enter 95º east. The longitudes have a resolution of 0.1 degrees.
This field is used in the calculation for Sunrise and Sunset algorithms used in
GCL+ (see GCL+ chapter for a description of that function).
Site Elevation
The field will be an integer that gives the elevation of the site. This field is critical
to the Enthalpy formula used in GCL+. The Site Elevation value has a resolution
of 1 ft or 1 m.
Elevation Units
This field will be a combo box with either feet or meters. This field is critical to
the Enthalpy formula used in GCL+.
Configuration
Refer to the most recent product specifications sheet for detailed information. The
values given below are examples and vary depending on the controller types.
The default DCU total static RAM is 256 Kbytes. This can be increased to 1,280
Kbytes by adding two SRAM chips in slots SRAM1, SRAM2, and moving
jumpers J7 and J8 to the left.
The default DSC total static RAM is 128 or 256 Kbytes. DSC 1616/1212/1280 are
available with 512 Kbytes.
Additional Dynamic RAM is not available for DAC, DSC, VAV/VVT or Room
Controllers.
The remaining Dynamic RAM should be larger than 500 Kbytes for a DCU.
CPU Speed
This is a read-only field that displays the speed of the CPU on a controller in
MHz.
The rev 1.3 to rev 1.5 DCUs have a clock speed of 25 MHz with a 32 bit
processor.
The Output Startup Delay section in the Device (DEV) object is used to determine
how long the controller waits (after start-up) before it begins processing its
outputs. Checking the Automatic checkbox enables Auto mode. Unchecking the
Automatic checkbox, enables manual mode. In Auto mode, the delay time is
determined by the formula (5 + DeviceAddress Mod 31), resulting in a range of 5
to 35 seconds. This is known as system-wide staggered startup of equipment. This
ensures that if a power outage occurs, not all controllers will turn on their outputs
at the same time once the power is restored, causing a massive power surge. They
will be turned on at different times depending on their address. In Manual mode,
the delay time is user-selectable. (Note: entering zero sets the delay time to 0
seconds and disables this feature.)
Refer to the Analog Output (AO) and Binary Output (BO) objects in chapter 10
for an explanation of what happens for each object during a controller startup.
LinkNet Port
This option allows LinkNet on a particular port to be enabled or disabled. The
options in the drop down are Net1, Net2, or None. The LinkNet option only has
significance on an Application Controller even though it may show on a DCU
controller. This option uses Port 2 on an Application Controller and uses an RS-
485 physical connection at 76,800 baud. LINKnet is not a BACnet standard, but
rather a proprietary extended input/ output scheme developed by Delta Controls.
Note: The controller needs to be reset before the new settings will take effect.
Controller Graphic
A designated GPC graphic can display when the DEV object is opened using the
right mouse Open command in the Left Pane of Navigator. The Device object
opens normally in the Right Pane of Navigator when the object is double clicked.
The Controller Graphic field can be overridden by the Device Graphic defined in
the Navigator Settings (NVS) object. The Device Graphic tab on NVS provides a
way to provide an exception to what is defined in the Controller Graphic field and
make a local definition of the designated graphic for a specific OWS.
Reset Password
This field defines an optional password that restricts the use of the Reset
command for a Device Object in Navigator. The default setting is none. The Reset
Password affects Reset commands for the Device Object but does not affect reset
commands to other objects in the device. With a password in this field, a user
must enter the correct password to use the Reset command.
The Reset command for a Device Object is available when the user selects:
• A DCU or DAC controller in the left pane or
• The Device Object in the right pane of Navigator using the right mouse menu.
Security Enabled
The Security Enabled checkbox is used to restrict unauthorized users from
modifying a controller's database when using DSC or Access Control products.
When the Security is enabled only Delta Controls Inc. ORCAview software can
perform any of the actions described in the following text.
Note: The DST settings on the Time Info tab for both DSC and OWS must be
same before 'Security Enabled' checkbox is checked under the 'Configuration' tab.
Otherwise, the controller will be locked and cannot be manipulated anymore. You
have to re-flash its firmware to remove the lock status.
1 Without DST enabled on DSC, you can enable Packet Security, but you can't
disable it again. You have to re-flash the controller to get rid of the lock.
2 With DST enabled on DSC, i.e. the same as OWS, you can either enable or
disable Packet Security. The Packet Security feature works.
When the Security Enabled checkbox is enabled for a controller, all other BACnet
front ends are blocked from deleting, creating or editing objects, and clearing or
restoring the controller's database.
The Security Enabled checkbox will also restrict requests to create new objects or
edit existing objects. Only authorized users can create or edit objects. In order for
any user to delete objects or clear or restore a database, an authorized user must
first clear the Security Enabled checkbox in the controller. Only authorized users
can create or edit objects. Only users logged in, to a valid SUA object with the
same proper object permissions, username and password as the one present on
your panel will be authorized users. Authorized users are granted authority to
create and/or edit objects.
This feature allows us to prevent other BACnet front ends from attaching to the
network and potentially sabotaging the Access System or any Delta Controls Inc.
system. In addition, in order for the security to work correctly the controller's time
must be synchronized with the rest of the BACnet network, within =+/- 3 minutes.
This is to prevent a replay attack on the controller of older messages.
Note: After performing actions that require the Security to be disabled, be sure to
enable the Security again by checking the Security Enabled checkbox.
The available PC104 boards that can be connected to the DCU are:
• Ethernet Card
• IntelliNet® Card
• Peripherals Card
As a part of OWS security, these checkboxes allow an operator to see only the
objects for a particular application(s). For example, a site may have separate
operators for the HVAC and Access applications. It is possible for each operator
to only see the objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Time Info
Req previous screen GCL Timeout is now read only with default of 20 seconds
Time
This field displays the current local time of the device. It is in a 24-hour clock
format.
Date
This field displays the current local date of the device.
GCL Timeout
The read only GCL Timeout field defines the number of seconds that a GCL+
program can be caught in an infinite loop before it is "kicked" out of the loop.
When a GCL Timeout occurs, GCL+ is kicked out of the infinite loop and starts
executing from the beginning of PG1's first line of code. If the infinite loop
continues to exist, the program execution will be restarted a maximum of three
times, after which the program containing the infinite loop will be halted and will
not be executed again.
On a DAC or DCU controller, the default time for this read only property is 20
seconds. On an OWS or HMI, the default time for this read only property is 5
seconds.
Save/Load Timeout
The Save/Load Timeout field modifies the number of seconds that the controller
will wait if it does not receive any messages related to a save or load procedure
from the OWS, before continuing on with normal operation. The default time for
this property is 20 seconds. The allowed values are from 1 to 250 seconds.
With the exception of a DCU, during a database save, the DSC/DAC controller
first pauses operation (i.e. outputs remain at their last state, programs pause
execution), then it copies the database to flash, resumes operation, and then the
database is saved from the controller by the OWS. Once the database is saved, the
controller then continues on with normal operation.
If a problem occurs during the database save which causes the controller and
OWS to stop communicating for a period of time, the controller will timeout and
end the save procedure (after the time specified in the Save/Load Timeout field).
With the exception of a DCU, during a database load, the controller suspends all
operation for the entire length of the load process. Once the database is loaded
into the controller, it resumes or begins normal operation.
If a timeout occurs (the time specified in the Save/Load Timeout field) in the
middle of loading a database, the controller will reset and load the database saved
in flash (or create the default database if there is no database saved in flash).
To use the UTC feature on a DCU controller, you must check UTC Enable and
enter the UTC Offset for the location of the Device.
On a DSC/DAC controller, the UTC Offset is still used but the UTC Enable
setting is no longer required in the calculations for the Sunrise and Sunset
functions.
Using Navigator, Set the Panel time; the Device Object will now display the local
time referenced to GMT.
The dates in emails and Security settings on Configuration tab of the Device
object also use UTC.
DST Enable
This field is a property that will allow the operator to choose whether or not
Daylight Savings Time (DST) will be in effect
DST in the OWS comes from the Windows configuration. If DST is enabled in
Windows, then DST Enable will be checked in the OWS. Users are not able to
change the DST settings or disable the DST in the workstation. They can only set
it up from Windows.
The OWS Time zone settings, System Time, or the DST settings cannot be
changed. These system parameters can only be changed from Windows settings.
This is done by clicking on START SETTINGS CONTROL PANEL. Then,
click on DATE/TIME.
DST Status
This is a read-only field that indicates whether or not DST is currently in effect
(TRUE indicates In Effect) for the local controller.
DST Standard
This field will allow the operator to choose one of the following:
• North American
• European
• Australian
• Other DST time defaults.
This box will default to North American. If the operator selects European then the
typical values for the European countries DST will appear in the DST fields. The
operator will still be able to modify the affected fields if there are slight
differences from the standard. If the operator does modify the standard, as soon as
he presses APPLY the standard will change to OTHER. This will indicate to the
operator that the standard has been modified.
The purpose of DST is to conserve sunlight during the summer months. This is
accomplished by manipulating the clock time so that both sunrise and sunset will
take place at a later hour. This will have the effect of giving us one extra hour of
sunlight in the evening.
AUSTRALIA:
Start – Last Sunday in October
End – Last Sunday in March
Effective Hour – 2 AM
Offset – 60 Minutes
EUROPE:
Start – Last Sunday in March
End – Last Sunday in October
Effective Hour – 1 AM + UTC offset
Offset – 60 Minutes
OTHER:
No set defaults. User can enter any option that they want.
Transition Time
This time will show the hour:minute:second that the DST algorithm will occur at.
The time is in the 24 hour clock format. This time can be edited. If this field is
modified from what the DST Standard has determined it should be, the DST
Standard is changed to OTHER.
Time Adjustment
This property will indicate the number of Offset minutes that the DST event will
add/subtract from the controller local time. If this field is modified from what the
DST Standard has determined it should be, the DST Standard is changed to
OTHER.
Start DST on
This field will display the start date for the Daylight Savings Time. Week, Day
and Month fields will allow the operator to enter a recurring date that may change
from year to year. If OTHER is selected as the DST, a specific date can be
selected that the DST happens on every year.
End DST on
This field will display the end date for the Daylight Savings Time. Week, Day and
Month fields will allow the operator to enter a recurring date that may change
from year to year. If OTHER is selected as the DST, a specific date can be
selected that the DST happens on every year.
On and After
If the Start/End dates are of the Week & Day type and the operator checks the “On
and After” box, two new fields will appear. If the operator enters a date in this box
then the earliest the DST would be enabled/disabled would be that date of the
selected month.
For example if the DST start on the First Sunday in April (i.e. April 3) and the
“On and After” box is unchecked, DST will start on the 3rd of April. If however
“On and After” box is checked and the date selected in this field is 5 then DST
would not take effect until April 10. This type of DST algorithm is primarily used
in South American countries.
Time Synchronization is used to notify a remote device of the correct current time
so that devices may synchronize their internal clocks with one another. We refer
to the ability of a controller to generate Time Synchronization requests as using a
Time Master. Time Mastering is only supported by system controllers (DSC,
ASM and DCU) and by the OWS, as these devices all have real-time clocks.
By convention, a single controller (at the System or Area level) is chosen to be the
Time Master for an entire site. The Time Master is then configured to broadcast a
Time Synchronization request to all the devices within the site periodically
(typically once every 24 hours). The OWS is usually used to initially set the time
within the site and then occasionally to reset the time (to correct accumulated time
drift or to recover from a Time Master failure).
Note: Controllers do not trend data until they receive the current time (i.e. if
current year = the default year).
This is where the Auto Time Synchronization feature comes into effect. It ensures
that all subnet controllers under a system controller (DSC or ASM) always have
the correct current time and date.
Note: The definition of a subnet network is limited to NET2. The use of NET1 (or
other network adapters) for a controller subnet is a non-standard architecture and
is not recommended. Only NET2 is supported and automatically configured.
The system controller (DSC or ASM) maintains the current time and date (as it
has a real-time clock) and is sensitive to subnet controllers coming on-line and
synchronizes their times automatically. The DSC is also pre-configured to
synchronize its subnet controllers regularly (every hour) at 12 minutes past the
hour. This time was chosen since the DSC synchronizes its software clock with its
real-time clock at 11 minutes past the hour (to avoid problems due to roll-over,
like midnight). This ensures that the real-time clock is read prior to generating the
Time Synchronization message.
Note: The DSC will not synchronize its subnet controllers if it does not have the
current time (i.e. if current year = the default year).
Note: The network address is only put into the Time Synchronization Recipients
list when the default database is created. Changes to the network address (i.e.
reconfiguring the device or changing its MAC address) will automatically be
reflected in the Time Synchronization Recipients list. Loading a database will
NOT automatically add the network address to the Time Synchronization
Recipients list. However, if the database was already configured with Auto Time
Synchronization enabled and it had a different network address, then it will update
the old network address with the new network address and auto timesync will
continue to function normally. Databases not already configured will require the
user to manually configure the Auto Time Synchronization feature.
Note: When Auto Time Synchronization is enabled, additional recipients that are
not on the subnet (e.g. NET10030, DEV4800) may be added to the Time
Synchronization Recipients list and they will receive Time Synchronization
messages, but will NOT trigger Time Synchronization messages.
With Auto Time Synchronization enabled, each new subnet device that comes
“on-line” sets the Time Remaining field to 5 seconds (allowing time for other
devices to come on-line by effectively suppressing/delaying the Time
Synchronization message). This avoids sending a flood of Time Synchronization
messages, should multiple controllers come on-line together (i.e. a mass power
restoration), by suppressing multiple successive Time Synchronization messages
into a single message sent 5 seconds after the last controller comes on-line.
Upon expiry of Time Remaining, the Time Remaining field is again set to be the
number of seconds remaining until 12 minutes past the hour (the next hourly Time
Synchronization).
Manual Enable Manually setting the Time Interval to 3600 seconds and
adding the subnet network address to the Time Synchronization Recipient list will
enable the Auto Time Synchronization feature.
Manual Disable Manually changing the Time Interval from 3600 seconds
disables the Auto Time Synchronization feature and reverts to standard BACnet
Time Synchronization behavior.
The following screenshot displays the Time Sync tab of the Device object. In this
screenshot, Auto Time Synchronization is enabled. LinkNet is enabled on NET1
and the network address of NET1 (NET20003) is added to the Time
Synchronization Recipients list.
Time Interval
This is the number of seconds between controller time updates that are sent to the
list of Time Synchronization Recipients. For the OWS and DCU, the default time
is 86,400 seconds, which is once every 24 hours. If a change is made to the Time
Interval and Apply or OK is pressed, it resets the Time Remaining and begins
counting down.
For DAC products, the default Time Interval is 3600 seconds. If the Time Interval
value is 3600, the Time Remaining does not reset when the Synchronize Time
button is pressed. Additionally, if the Time Interval is changed to a value other
than 3600, then the Time Remaining follows this new value. When the
Synchronize Time button is pressed, the time remaining value is set to the Time
Interval and the countdown starts again.
Time Remaining
This is a read-only field that displays the number of seconds left until the next
Time Synchronization is sent to the Time Synch Recipients.
For DAC products, when Auto Time Sync is enabled, the Time Remaining is set
to expire at 12 minutes past the hour.
To enter a device into this list, simply double left click in the next available entry
position and type in the desired device object number (e.g. 100.DEV1 or
200.DEV2).
In order to delete an entry from this list, single left click on the entry, delete the
name and hit OK or APPLY. The name is highlighted blue before you hit Delete;
if the name field goes into an edit mode the delete will not take effect.
Product
Vendor
This is a read only field that indicates the manufacturer of the BACnet Device.
Vendor ID
This is a read-only field that indicates the unique vendor identification code
assigned by ASHRAE.
Model Name
This is a read-only field that indicates the model name of the BACnet Device.
Platform
This is a read-only field that indicates the device in which the object is resident.
Firmware Version
This is a read-only field that is assigned by the vendor to represent the firmware
version being used in the BACnet device.
Hardware Version
This is a read-only field that indicates the specific model number of hardware.
Application SW Version
This is a read-only field that indicates the specific version of the software being
used.
Hardware Status
The Hardware Status field is used for troubleshooting purposes and displays the
status of the controller’s database memory, EEPROM memory, and whether the
controller has a real-time clock (RTC), LCD, or Ethernet port. This field only
appears on DAC/DSC controllers and not on an OWS or a DCU.
An example of the type of information displayed in this field is: Database OK, EE
OK, RTC Present, LCD Not Present, and Ethernet Present. The presence of a real-
time clock, LCD, or Ethernet port depends on the type of controller.
Protocol
Max Master
This read-only field indicates the highest possible address for master nodes.
Protocol Version
This read only field represents the major version number of the BACnet protocol
that is implemented by this controller. Every revision of BACnet shall increase
this version number by 1. The current Version is 1 and the Revision is 3.
Protocol Revision
This read only field represents the minor revision of the BACnet standard that is
implemented by this controller. Every revision of BACnet shall increase this
version number by 1. The value shall revert to zero upon each change to the
Protocol Version field. The current Version is 1 and the Revision is 3.
APDU Timeout
This field indicates the time, in milliseconds, between retransmission of an APDU
requiring acknowledgement for which no acknowledgement has been received.
APDU Retries
This read-only field indicates the maximum number of times that an APDU shall
be retransmitted.
Segmentation Supported
This read-only field indicates whether the BACnet device supports segmentation
of messages and whether it supports segmented transmission.
Services Supported
This read-only field provides a list of supported BACnet services.
Internet
Note: Some SMTP Servers require that you use a valid E-Mail Account (in the
From field) when sending emails. Check with your network administrator to
ensure you are using a valid email account.
SMTP Server
The field contains the address of the SMTP server. For example, an address might
be something like “mail.yourISP.com”. This field will also accept the IP address
of the SMTP Server (i.e. 192.168.1.200). Your network administrator can provide
you with the SMTP Server address.
You cannot use simple host names like "mail". You have to enter the Fully
Qualified Domain Name (FQDN) (e.g., "mail.deltacontrols.net") to your mailer,
otherwise Email will not work.
SMTP is short for Simple Mail Transfer Protocol which is a protocol for sending
e-mail messages between servers. Most e-mail Internet mail systems use SMTP to
send messages from one server to another. In addition, SMTP is generally used to
send messages from a mail client to a mail server.
However, you only need to specify the SMTP server in the controller and not the
POP or IMAP server since the controller is only able to send emails and not
receive them.
Use DHCP
The Dynamic Host Configuration Protocol (DHCP) is an Internet protocol for
automating the configuration of a controller that uses IP. DHCP is used to assign
temporary or permanent network (IP) addresses to controllers and to deliver
configuration parameters such as the subnet mask and gateway address. In other
words, the controller extracts its configuration from a server (the 'DHCP server').
A controller requests the use of an IP address from the DHCP server. The DHCP
server then allocates and assigns an IP address for the controller to use for a
particular amount of time. The period over which a network address is allocated to
a controller is referred to as a "lease". The amount of time for the lease is
determined by the DHCP server.
The benefit of using DHCP is that it reduces the work necessary to administer a
large IP network. The alternative to using DHCP is manually entering the IP
Address, Subnet Mask, and Default Gateway information into the controller.
If the 'Use DHCP' checkbox is checked, the 'IP Address', 'Subnet Mask', and
'Gateway Address' fields become unavailable since they are acquired using
DHCP. The 'Use DHCP' checkbox is unavailable for BBMD controllers because
they require a static IP Address and cannot have a dynamic address.
The 'Use DHCP' check-box in the Email Tab of the Device object is now disabled
(greyed out) if the device is a BBMD and UDP/IP is enabled in the NET object.
This is done so that the availability of the DHCP checkbox in the DEV object
matches the DHCP checkbox in the NET object. DHCP cannot be used when the
controller is a BBMD device, and so the checkbox is greyed out.
IP Address
This field sets the IP address that the controller will use.
192.168.1.10
Three different address “classes” have been created, which are called Class A,
Class B and Class C. At this point, it is enough to know that addresses which
begin with a number in the range of 1 to 126 are considered Class A, with
numbers in the range of 128 to 191 being Class B and numbers in the range of 192
to 223 being Class C. Thus the complete address shown above would be
considered Class C. Addresses which begin with 127 or 224 - 254 are reserved for
special purposes. It is important to note that these IP addresses cannot simply be
“made up”. If connecting to an existing LAN or WAN, these IP addresses will be
provided by the site network administrator.
Subnet Mask
This field sets the subnet mask for the network that the controller is connected to.
A subnet mask uses the same four-part format as an IP address and is written
using the same dot format. Subnet masks are used to separate the network that the
device is connected to from the device itself. Each device has a subnet mask
associated with it. This allows the device to know what other devices are its peers
(on the same network), and which devices are reachable only by a Gateway or IP
Router. Typically, a subnet mask has only one of two numbers in each of its four
positions. These are 0 and 255. This is why these two numbers cannot be used to
specify an actual IP address. A very common subnet mask is the following:
255.255.255.0
This particular subnet mask specifies that devices which have the identical first
three numbers in their IP address belong to the same network. For example:
This means that these two devices can communicate without the need for a
Gateway. However:
Therefore for these two devices to communicate, at least one Gateway will be
required.
From this, it is clear that if the subnet mask is 255.255.255.0, only 254 devices
can be connected on the same network. Remember, 0 and 255 cannot be used in
an IP address. For some networks this is insufficient, so three different classes of
IP address were created which each have their own subnet mask.
Gateway
This field sets the IP address of the site Gateway or IP Router that is used to
connect to off-site devices. This field is only required if two different networks
need to communicate with each other. This would be the case with a WAN. If
required, this IP address is supplied by the site network administrator.
A Gateway has the job of sending network traffic from one network (subnet 1) to
another network (subnet 2). A Gateway uses the subnet mask of a packet to
determine if it should forward it to the remote network or not. If the destination
address of the packet is not in the local subnet, then the Gateway or IP Router will
send the packet to the remote network.
However, for this to work, the local devices must be given the IP address of the
Gateway. This IP address in the device is typically labeled 'Gateway address’ or
‘Router address’.
Gateways are commonly used in Wide Area Networks (WANs) to join the
individual networks (LANs) at each site to each other.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
Overview
The Door Controller (DC) object is a complex object that implements all aspects
of control for one access point such as a door. It allows you to configure the
control characteristics of the door and to monitor activity at the door. It grants and
denies access on credential presentation based on access rights you provide.
The two most important DC object functions are:
• ensuring the door is locked and unlocked when is should be; and
• generating events to allow activity at the door to be monitored and alarms to
allow proper security to be maintained at the door.
A door's lock state: locked or unlocked, can be controlled from many competing
input sources such as a schedule, the operator, credential presentation resulting
access being granted and so on. A binary control source such as a schedule signals
that it seeks to control the door's lock by transitioning to its active state. The term
active state rather than on and off is used to describe when a control source seeks
to control the door's lock because you can configure whether the control source's
on state or off state is the active state.
To determine which control source has precedence and overrides others to control
the lock, an unchangeable priority array with nine levels is defined by the DC
object.
A door can be set up to use a card reader, a keypad (PIN) or a combination of the
card reader and the keypad for verifying access. The DC object can be used to set
up a door with an entry card reader/keypad or for doors with both an entry and
exit card reader/keypad.
Header
Value
A read-only field that displays the door lock status. There are five states:
Locked door is locked
Unlocked door is unlocked.
Life Safety door is unlocked and remains unlocked.
Lock Down door is unlocked and remains unlocked.
Pulsed Unlocked door is unlocked temporarily and, returns to the locked state
when pulse time expires.
Manual Override
Manual Override allows the operator to control the lock as described below.
Manual override sets the DC object to priority array level 3 control.
Locked door is locked. The operator sets the time interval for which the door is
locked. When the interval expires, door control reverts to highest priority active
control source
Unlocked door is unlocked. The operator sets the time interval for which the
door is unlocked. When the interval expires, door control reverts to highest
priority active control source.
Life Safety the door is unlocked and remains unlocked. An operator manual
control action or higher priority active control source is required to override this
setting.
Lock Down the door is locked and remains locked. An operator manual control
action or higher priority active control source is required to override this setting.
Pulsed Unlocked door is unlocked temporarily. The operator sets the time
interval for which the door is unlocked. When the interval expires, door control
reverts to highest priority active control source.
Manual Time
When Manual Override is used, a time field is displayed. When you are using
Locked, Unlocked or Pulsed Unlocked, you have the option to choose how long
you want the door to remain in that state before returning to auto. Setting the time
to zero causes the time interval to be forever.
Door Controlled By
This read-only field indicates which priority array door control source is
controlling the lock. Priority array is described in the following section.
Door Status
This read-only field displays the current door status detected by the door contact
input. The possible states are:
Open The door is open.
Closed The door is closed.
Pulsed Unlocked The door is being unlocked for the Pulse Time.
Door Ajar The door was unlocked, but has stayed open longer than the Pulse
Time plus the Door Ajar Time.
Forced Open The door has been opened when it is locked.
Unlock Schedule Pending The unlock schedule is active, but the door will
not unlock until the first card is scanned.
Not Available There is no door contact available or it is in trouble.
Description
The Description field can contain up to 2000 printable characters.
The Description field is often be used for a detailed functional definition. For the
DC object, the Description field could be used to describe the door and how it is
being controlled.
Setup
Name
Name is used to describe the door that the door controller is controlling and
monitoring. It is a descriptive label given to the DC object. Although it is not
necessary, the name should be unique within the BACnet network. The name must
be unique among the other descriptors located on the same controller. Name is
limited to 67 printable characters.
Familiarize yourself with the Door Controllers folder and the display options for
DC objects based on their name in the ORCAview and ORCAweb access tree
view before deciding on your name convention. See Chapter 3 – Using Navigator
for more information about the ORCAview access tree view.
Commissioned
The Commissioned checkbox determines whether or not the object is
commissioned.
When Commissioned checkbox is checked, the object is commissioned and the
Lock icon is not displayed in the Header or in Navigator. Events and alarms are
generated and logged.
When Commissioned checkbox is not checked, the object is not commissioned
and the Lock icon is displayed in the Header and in Navigator. No events or
alarms are generated or logged. Objects that monitor this object will not transition
and no alarm notifications will be generated for that event
Reliability
This property provides an indication of the object status regarding reliability of
data. This property has one of the following values at any given time:
No Fault Detected – This is the normal state.
LINKnet Offline – indicates that the Door Module (ADM) associated with the
door controller is offline.
Missing cfg Object – Indicates that there are missing parameters, or that the
referenced input or output is missing.
Not Available – Is Delta’s proprietary reliability code, which indicates that the
output does not physically exist in the DC object.
HVAC/Access/Lighting Checkboxes
The HAL checkboxes are used to indicate which application(s) the object is being
used for. Any combination of HVAC, Lighting and Access can be selected.
Leaving all checkboxes blank is the same as selecting them all. For more
information, see the section on Security in the SUG/SUA objects.
I/O Definition
All inputs except the card reader can be local or remote. Card readers/keypads
accept references to local CR objects only.
Other objects that can be referenced are Multi-State Input (MI), Multi-State
Variable (MV), Binary Input (BI), Binary Variable (BV), Binary Output (BO),
and Schedule (SCH) objects.
When an input type is selected and applied, its behavior options are displayed on
the Input Config tab or the Schedule Config tab.
The input types are described below in the order they appear on the Input Type
drop-down list.
Entry Card Reader For an entry-only door, use this input type to identify the
door's only reader. When antipassback is implemented, a card user presenting
credentials at this reader is deemed to be entering the room. Use the reader
referenced for input type = Exit Card Reader as the reader to exit the area.
The corresponding Input Reference must be a CR object. Two CR objects are
created automatically for each ADM detected by the ASM on its LINKnet
network.
Either CR object can be referenced for this input type and the other CR object is
then referenced in the DC object for another entry-only door or as the Exit Card
Reader input type for the same DC object when antipassback is implemented.
On the ADM, the corresponding reader Wiegand wiring terminals are labeled
Door A and Door B.
Door Contact The door contact senses the door's physical position or status.
This status is the basis for several access control functions including lock control,
door ajar and door forced open alarms. If more than one door contact is used and
one is in trouble, they are all in trouble. All contacts must be closed to indicate
that the door is closed. One open contact then means that the door is open.
When EOL resistors are added to the door contact to create a supervised circuit,
the wiring status from the contact to the ADM is monitored for open and short
circuit conditions and reported as a trouble alarm. Four types of monitored circuits
are supported. For details see the ADM Installation Guide.
The door contact can be configured as Normally Open (N/O) or Normally Closed
(N/C) when the door is closed, by appropriate set up of associated MIC object.
The corresponding Input Reference is usually a BI object when no EOL circuit is
used or a MI object when an EOL circuit monitors wire status. A MIC object is
linked to the MI object to define the voltage levels between states and to define
the state text.
Two MI objects are created automatically for each ADM detected by the ASM on
its LINKnet network.
As well, a selection of MIC objects is created automatically to cover all possible
door contact wiring situations.
Unlock Schedule When an Unlock schedule is in its active state, the door is
unlocked. When the Unlock schedule is in its inactive state, the door is locked.
The Unlock Schedule is normally used to control the lock when you want valid
card users to gain access at a locked door. When a valid card user presents
credential and access is granted, the door is pulsed open and locked again.
More than one Unlock schedule can be configured. All Unlock schedules must be
in their inactive state before the door is locked.
The corresponding Input Reference is usually a SCH object; however, a BI object
can be used.
Relock Schedule When a Relock schedule is in its active state, the door
operates like a typical mechanically-keyed door: credential presentation resulting
in access granted unlocks the door when it's locked and next credential
presentation resulting in access granted locks the door, and so on.
See also the Motion Detector input type to learn how it interacts with the Relock
schedule.
More than one Relock schedule can be configured. All Relock schedules must be
in their inactive state before the Relock function ends.
The corresponding Input Reference is usually a SCH object; however, a BI object
can be used.
Lock Schedule When the Lock schedule is in its active state, the door is
locked. Credential presentations are ignored or reported as access denied.
More than one Lock schedule can be configured. All Lock schedules must be in
their inactive state before the door is unlocked.
The corresponding Input Reference is usually a SCH object; however, a BI object
can be used.
Request to Exit (RTE) When the Request to Exit input transitions to active,
the door is unlocked temporarily (pulsed) for a configured time interval.
The time interval that the door is unlocked for on active RTE is set by the lock
property: Extended/RTE Pulse Time.
When EOL resistors are added to the RTE to create a supervised circuit, the
wiring status from the RTE to the ADM is monitored for open and short circuit
conditions and reported as a trouble alarm. Four types of monitored circuits are
supported. For details see the ADM Installation Guide.
The RTE can be configured as Normally Open (N/O) when the RTE is active or
Normally Closed (N/C) when the RTE is active by appropriate set up of
associated MIC object. The input's active state is configured as either on or off.
When the RTE device is a motion sensor, use the Request to Exit input type not
the Motion Sensor input type.
The corresponding Input Reference is usually a BI object when no EOL circuit is
used or a MI object when an EOL circuit monitors wire status. A MIC object is
linked to the MI object to define the voltage levels between states and to define
the state text.
No MI objects are created automatically for RTE, however, a selection of MIC
objects is created automatically to cover all possible EOL wiring situations.
Caution: When connecting this device, refer to the ADM Installation Guide in
selecting the Request-to-Exit device and configuring it. This device must be
configured properly to work correctly.
Life Safety Input When a Life Safety Input is in its active state, the door is
unlocked. Typically this input references a BI object from another system or
controller such as a fire alarm or smoke alarm.
More than one Life Safety Input can be configured. The door is unlocked when
any Life Safety Input is in its active state.
Caution: Be sure to consult and conform to your local fire laws and regulations for
egress.
Motion Detector The Motion Detector input type works in conjunction with
the Relock Schedule input type. A motion detector is an alternative input to
control the door lock in the Relock function. Positioning one or more motion
sensors inside a room allows you to lock the door when no one is there.
When there is no motion for the specified period of time, the door is locked. When
motion is detected the door is unlocked.
When using multiple inputs, and one is in trouble, the door will be in trouble. All
motion inputs must be off to indicate that there is no motion.
The motion detector function allows you to open the door when someone
approaches, for example, a grocery store's sliding entrance door that opens as you
approach and closes when no one is near.
The Motion Detector input type doesn't act as an RTE motion detector. Use the
Request to Exit input type for that purpose.
The corresponding Input Reference is usually a BI object when no EOL circuit is
used or a MI object when an EOL circuit monitors wire status. A MIC object is
linked to the MI object to define the voltage levels between states and to define
the state text.
Access Approval Input The Access Approval Input function allows an
operator to determine whether to grant or deny access to a card user who has
presented a credential that otherwise would have resulted in access being granted
by the DC object.
The operator signals approved access or denied access by closing a contact
connected to a binary input within a configured time interval. If the operator
doesn't respond within the time interval the card user is denied access.
Notify the operator that a valid credential has been presented by generating an
event or otherwise triggering a specific graphic on the ORCAview workstation.
The image from a video camera may be presented to allow the operator to confirm
the card user's identity. No matter how you choose to notify the operator, it must
be implemented in GCL.
The corresponding Input Reference is usually a SCH object to define when the
Access Approval Input function is active; however, a BI object can also be used.
Exit Card Reader For an entry-only door, this input type is not used.
When antipassback is implemented, a card user presenting credentials at an exit
reader is deemed to be exiting the room. Use the reader referenced for input type
Entry Card Reader as the reader to enter the area.
Entry Keypad For an entry-only door, use this input type to identify the door's
only keypad. When an input type Entry Card Reader is also specified, a card user
must present a valid credential then enter a valid PIN to gain access. When a
keypad only is used, the card user must enter a valid PIN to gain access.
For example, you may only require credential presentation during regular office
hours and for extra security in the evenings and on weekends, you would set the
PIN schedule to be active as well.
When the keypad is integrated with the card reader, reference the same CR object
as the card reader.
When the keypad is a separate device from the card reader and is therefore wired
to the second Wiegand port on the ADM, reference a different CR object from the
card reader.
When a keypad only is used without a reader, reference a CR object.
Exit Keypad For an entry-only door, this input type is not used.
The Exit Keypad features are the same as described above for Entry Keypad.
When antipassback is implemented, a user entering PIN at this keypad is deemed
to be exiting the room. Must use an integrated reader/keypad for a card user to
present a valid credential then enter a valid PIN to gain access.
Alarm Input Not supported
Fail Secure Lock The ADM operates the lock as fail secure. Fail secure means
that when there is no power, the lock remains locked.
Fail Safe Lock The ADM operates the lock as fail safe. Fail safe means that
when there is no power, the lock unlocks.
Caution: In addition to setting this output type, proper ADM jumper placement is
required for fail safe/secure operation. See ADM Installation Guide for details
This output type must reference a BO object. Two BO objects are created
automatically for each ADM detected by the ASM on its LINKnet network. As
well, a BDC object is created automatically to cover lock states.
Door Sounder The door sounder function controls the referenced output when
certain access control events occur, as specified by output configuration options.
Typically, a sound generator device such as a piezoelectric speaker is driven by
this output or you can use the card reader's built-in sounder by wiring its beeper
lead to a binary output.
This output type must reference a BO object. No BO objects are automatically
created for this function.
Auxiliary Output The auxiliary output turns on according to the output
configuration options.
Input Config
The Input Config tab allows you to set up the options for the input types you
entered on the I/O Definition tab. These options specify how the DC object reacts
to the inputs entered. Schedules are configured on the Schedule Config tab.
The input type options are described below in the order that the input types appear
on the Input Config tab Input Type drop-down list.
Door Contact
The Door Contact field is displayed when Door Contact is selected as Input Type.
Door Ajar Time – sets the time interval increment past the time interval
specified by the lock's Pulse Time property or its Extended/RTE Pulse Time
property that an open door which has been unlocked by the DC object can remain
open before a door ajar event, sometimes referred to as door held open event, is
generated.
For example, when Pulse Time is set to 15 seconds and Door Ajar Time is set to
10 seconds, then a door ajar event/alarm is generated 25 seconds after the door is
unlocked and opened regardless of when the door is opened. If the door is not
opened during Pulse Time (the door is unlocked only for Pulse Time duration),
then the door ajar event is not generated.
Request To Exit
The Request To Exit field is displayed when Request To Exit is selected as an
Input Type.
Shunt Events / Do not unlock door – when this option is selected then when
the Request to Exit input transitions to active, the door is not unlocked, however,
when the door is opened using a passage set, no forced open events or alarms are
generated.
Use this property in conjunction with a motion sensor or pressure plate RTE
device. Casual passers-by who inadvertently activate the RTE device don't cause
the door to unlock; users who want to exit unlock the door themselves.
The time interval that the door is unlocked for on RTE is set by the lock property:
Extended/RTE Pulse Time.
IMPORTANT: When this option is selected, don’t connect the RTE device to the
designated RTE inputs IP2 or IP6, as these inputs automatically pulses the door
open due to hardware interlocks. Using the auxiliary inputs, IP4 and IP8 is
acceptable.
Motion Detector
The Motion Detector options are described in the Schedule Config section later in
this chapter.
Keypad
The Keypad field is displayed when Entry or Exit Keypads are selected as Input
Type.
PIN input (PIN required when ON) - specifies when a PIN must be entered
following a credential presentation. Typically this input references a schedule.
Time to enter PIN - sets the time interval allowed for the PIN to be entered
correctly after the credential is presented. If this time interval expires before a PIN
is entered then the user must start again with credential presentation.
PIN Max. Attempts - sets the number of attempts to enter a correct PIN. This
feature is enabled when either of the Disable properties described below is
enabled.
Disable User after Max. Attempts - works in conjunction with a combination
card/PIN credential presentation. When PIN Max. Attempts is exceeded, all
credentials associated with the identified user are disabled.
Setup tab. The PIN Lockout icon is displayed on the DC object dialog
header.
Output Config
The Output Config tab allows you to set up the options for the output types you
entered on the I/O Definition tab. These options specify how the DC object
operates the outputs.
Lock
The Lock field is displayed when Fail Secure Lock or Fail Safe Lock is selected
as Output Type. The properties described below govern timing considerations for
unlocking and locking the lock.
Pulse Time - specifies the maximum time interval for which the lock is unlocked
when access is granted for credentials assigned to card users who do not have the
Extended Pulse Time property selected in their CU object. However, Pulse Time
doesn’t set the time interval the lock is unlocked for RTE requests. The RTE
unlock time interval is set by the Extended/RTE Pulse Time property, described
below. The lock is locked according to the Lock Door After property.
Extended/RTE Pulse Time - specifies the maximum time interval for which
the lock is unlocked when access is granted for credentials assigned to card users
who have the Extended Pulse Time property selected in their CU object. As well,
Extended/RTE Pulse Time specifies the maximum time interval for which the lock
is unlocked for RTE requests. The lock is locked according to the Lock Door After
property.
Lock Door After - specifies when the lock is locked after being unlocked on
access granted or RTE. Options are:
Door Opens – lock is locked when the door is detected as being opened or when
the pulse time expires
Door Closes - lock is locked when the door is detected as being closed after being
opened or when the pulse time expires
Pulse Time Expires - lock is locked when the pulse time expires
Door Sounder
The Door Sounder field is displayed when Door Sounder is selected as Output
Type.
Door Ajar Turns Sounder On - specifies that the sounder function operates
when door ajar is detected. The door sounder output is turned On when door ajar
is detected.
Door Sounder Beep Time - specifies the time interval that the sounder
function turns the door sounder output on for when door ajar is detected. If the
door is closed before the time interval elapses, the door sounder output is turned
off. When you select 0, the door sounder pulses on/off for 5 seconds when the
door is open.
Invalid Attempts Beeps Sounder - specifies that the door sounder output is
turned on momentarily, typically less than one second, and then returned to its off
state, when access is denied on credential presentation.
Auxiliary Output
The Auxiliary Output field is displayed when Auxiliary Output is selected as
Output Type.
Action to Take - The referenced output turns on according to the option described
below.
Single Scan – specifies that the auxiliary output turns On momentarily,
typically less than one second, and then returns to its Off state, when a
credential presentation results in access being granted. The Single Scan
setting allows the auxiliary output to be used to integrate access control with
other building systems such as lighting control. A GCL+ program uses the
momentary on/off transition as a trigger to activate or deactivate the other
system. An example of this would be to turn the lobby lights on when the
first card scan occurs in the morning and to turn them off at 6:00pm.
Always On – specifies that the auxiliary output turns on when a credential
presentation results in access being granted and stays on thereafter. To turn it
off, the referenced BO must be overridden to Off. An example would be in a
private office where unlocking the door also turns the lights on; the user
would turn the lights off by a wall switch when he/she leaves the office.
Door Unlocked – specifies that the auxiliary output turns On when the door is
unlocked. When the door is locked, the output returns to its Off state
Door Open – specified that the auxiliary output turns On when the door is open.
When the door is closed, the output returns to its Off state. An example would
be a rear exit door of a retailer. When the door opens, the alarm sounds. This
would be useful to let the employees or security know that someone has
exited the rear door.
Schedule Config
The Schedule Config tab displays the input options for all the applied schedule
input types. This is where you configure how the door controller reacts to the
schedule inputs and the motion detector input type.
Unlock Schedule
The Unlock Schedule field is displayed when Unlock Schedule is selected as Input
Type.
Unlock when input is - Sets the schedule's active state as either On or Off
Unlock after first use - The door remains locked at its scheduled unlock time;
it is unlocked and remains unlocked when the first card user is granted access and
opens the door.
Lock Schedule
The Lock Schedule field is displayed when Lock Schedule is selected as Input
Type.
Lock Door when input is - Sets the schedule's active state as either On or Off
Relock Schedule
The Relock Schedule field is displayed when Relock Schedule is selected as Input
Type.
Enable Relock when input is - Sets the schedule's active state as either On or
Off.
Lock Door at (Every Day) - Sets the time that the door is locked every day.
Lock After Unlocked for – Sets a time interval since last unlocking credential
presentation after which the door is locked. To disable this function, set the Lock
After Unlocked for time interval to zero.
Motion Detector
The Motion Detector field is displayed when Motion Detector is selected as Input
Type.
Lock After No Motion - Causes door to be locked when no motion is detected
for time interval specified by Lock After No Motion for. When multiple motion
detectors are specified, the door is locked when no motion is detectable by all
detectors.
Lock After No Motion for - Sets the time interval over which there is no
motion detected before door is locked, when Lock After No Motion is selected
Unlock After Motion - Causes door to be unlocked when motion is detected.
Activity
The Activity tab displays information on activities that have taken place at the
door controlled by the DC object.
Entry/Unlock Count Displays the number of entry card presentations, PIN
entries and door unlocks
Exit/Lock Count Displays the number of exit card presentations, exit PIN
entries and door locks.
Access Denied Count Displays the number of access denied card
presentations or PIN entries
Total Activity Count Displays the combined total of the Entry/Unlock Count,
Exit/Lock Count and Access Denied Count.
Last
Resetting the DC object resets all of these statistics.
User Displays the name of the last card user who generated the last activity.
When the last activity was not caused by a card user then the field will be blank.
Activity Displays the last event type that was generated or none if there was no
event.
Time Displays the time and date of the last event.
Events
The DC object Events tab provides 16 built-in event categories that cover a wide
range of possible events to be generated at the door.
The Events tab also allows you to view the events that are recorded in the DC
object’s event log.
Event Generated
The Event Generated field is used to select the categories of events you want
generated. Each event category is selected individually for each door. Each
category generates one or more event messages. The alarm message and the event
message are not always the same.
Events involving a credential presentation don’t report the name of the associated
card user and the card number, however, the corresponding alarms do.
on Valid Access When a credential is presented and access is granted, for
access or for muster. This event is generated whether or not the door is opened.
Event text generated: Valid Access
when Lost Card used When a credential with card status of Lost is
presented. Event text generated: Lost Card
Trouble occurs When a supervised circuit has been tampered with or the DC
object is in trouble. Event text generated: Trouble
When a trouble situation is resolved. Event text generated: Trouble Ended
When a credential with card status of Disabled is presented. Event text generated:
Disabled Card
When a credential with a future activation time and date is presented. Event text
generated: Inactive User <card user name>
Credential with a past expiry time and date is presented. Event text generated:
Expired User
Door is Forced Open When a door is opened unexpectedly without a
credential being presented and access being granted or without a request to exit
request. Event text generated: Forced Open
When a forced open door is closed again. Event text generated: Forced Open
Restored
when operator Overrides door control When an operator unlocks the door
for a specified time period, using DC object. Event text generated: Manual
Unlocked Door
When an operator locks the door for a specified time period, using DC object.
Event text generated: Manual Locked Door
When an operator locks the door using the Lockdown command, using DC object.
Event text generated: Manual Lock Down
When an operator unlocks the door using the Life Safety command, using DC
object. Event text generated: Manual Life Safety
When an operator-initiated override expires and the door control returns to auto.
Event text generated: Manual Relinquish
on Relock Mode use When the relock schedule transitions to active. Event
text generated: Relock Mode Enabled
When a valid credential is presented and the door is then unlocked while a Relock
schedule is active. Event text generated: Relock Mode Unlocked
When a valid credential is presented and the door is then locked while a Relock
schedule is active. Event text generated: Relock Mode Locked
When the Relock schedule locks the door because the Relock schedule Lock After
Unlock time interval has expired. Event text generated: Relock Mode Timeout
When the Relock schedule locks the door because Lock Door at setting is enabled
and the specified time of day occurred. Event text generated: Relock Mode
Schedule Locked
When the relock schedule transitions to inactive. Event text generated: Relock
Mode Relinquished
when GCL+ controls door When a GCL+ program controls the lock. Event
text generated: GCL+ Control
When the GCL+ program is no longer controlling the lock. Event text generated:
GCL+ Relinquished
when door is Ajar When door is held open too long after access is granted.
Event text generated: Door Ajar
When door held open too long is closed again. Event text generated: Door Ajar
Ended
when Request to Exit used When request to exit is activated. Event text
generated: Request to Exit
when Operator denies access When operator denies access via the deny
access input or when time limit for approval elapses before operator approves or
denies access. Event text generated: Approval Denied
When operator approves access via the approve access input. Event text
generated: Valid Access
Event Log
The DC object includes a built-in event log that stores events generated by the DC
object.
The ASM automatically creates a Compact Event Log object CEL1 named Access
Control Event Log that stores events generated by all DC and EC objects on an
ASM. Use the Access Control Event Log to monitor all alarms generated on one
ASM.
For details about the built-in event management system, see Chapter 6 – Events
and Alarms.
Event Queue Size sets the number of events you want to store in the DC
object’s built-in event log. After this number of events is reached, the next event
overwrites the earliest event. The maximum number of events that can be stored in
this event log is 100.
Events stored in the DC object’s event log are also stored in the CEL object.
Selecting zero for Event Queue Size causes all events to be sent the CEL with
none being visible in the DC object event log. This capability is used when
security permissions set in the System User Access (SUA) object define that the
operator shall not be able to view events.
The data fields for each event depend on the event category.
Time date and time event was generated.
Type event text that identified the event category
Card User name of card user associated with the event.
Site Code site code from credential associated with the event.
Card Number card number from credential associated with the event.
Event Argument 0 indicates entry, 1 indicates exit and 2 indicates
undetermined.
Alarms
The DC object Alarms tab allows you to select from 16 built-in alarm categories
that cover a wide range of possible alarms to be generated at the door.
In the Alarm Statistics section the Alarms tab displays information about the last
alarm that was generated by the DC object.
The DC object automatically creates an Event Class object EVC8 named Access
Control Alarm and an Event Log object, EVL1 named Access Control Alarm Log.
Use the Access Control Alarm Log to monitor all alarms generated on one ASM.
The Alarms tab allows you to select alarms which you want to be notified of and
to be logged in the Access Control Alarm Log.
For details about the built-in alarm management system, see Chapter 6 – Events
and Alarms.
Alarms Generated
The Alarms Generated field is used to select the categories of alarms you want
generated. Each alarm category is selected individually for each door. Each
category generates one or more alarm messages. Categories that are in alarm are
highlighted in red.
The alarm message and the event message are not always the same.
Alarms involving a credential presentation report the name of the associated card
user and the card number.
When a life safety input becomes inactive. Event text generated: Life Safety
Relinquish
on Invalid Access When a valid credential is presented but the DC object
denies access because the presentation occurred outside the allowed hours for that
card user or because a Lock schedule is active. Alarm text generated: Time Zone
Violation <card user name>
When a credential is presented that is not assigned to any card user. Alarm text
generated: Unrecognized Card Site=### Card=#####
When a credential is presented that is assigned to a card user who doesn't have
access rights to that door. Alarm text generated: Invalid Zone Access <card user
name>
When a credential with card status of Disabled is presented. Alarm text generated:
Disabled Card for <card user name> Site=### Card=#####
When a credential with a future activation time and date is presented. Event text
generated: Inactive User
Credential with a past expiry time and date is presented. Alarm text generated:
Expired User <card user name>
Door is Forced Open When a door is opened unexpectedly without a
credential being presented and access being granted or without a request to exit
request. Alarm text generated: Forced Open
When a forced open door is closed again. Alarm text generated: Forced Open
Restored
when operator Overrides door control When an operator unlocks the door
for a specified time period, using DC object. Alarm text generated: Manual
Unlocked
When an operator locks the door for a specified time period, using DC object.
Alarm text generated: Manual Locked
When an operator locks the door using the Lockdown command, using DC object.
Alarm text generated: Manual Lock Down
When an operator unlocks the door using the Life Safety command, using DC
object. Alarm text generated: Manual Life Safety
When an operator-initiated override expires and the door control returns to auto.
Alarm text generated: Manual no longer controlling the Door
on Relock Mode use When the relock schedule transitions to active. Alarm
text generated: Relock Mode Locked Door
When a valid credential is presented and the door is then unlocked while a Relock
schedule is active. Alarm text generated: Relock Mode Unlocked Door
When a valid credential is presented and the door is then locked while a Relock
schedule is active. Alarm text generated: Relock Mode Locked Door
When the Relock schedule locks the door because the Relock schedule Lock After
Unlock time interval has expired. Alarm text generated: Relock Mode Locked
Door Relock Mode Timeout Locked Door
When the Relock schedule locks the door because Lock Door at setting is enabled
and the specified time of day occurred. Alarm text generated: Relock Mode
Locked Door Relock Mode Schedule Locked Door
When the relock schedule transitions to inactive. Alarm text generated: Relock
Mode no longer active
when GCL+ controls door When a GCL+ program controls the lock. Alarm
text generated: GCL+ < function>
When the GCL+ program is no longer controlling the lock. Alarm text generated:
GCL+ no longer controlling the Door
when door is Ajar When door is held open too long after access is granted.
Alarm text generated: Door Ajar
When door held open too long is closed again. Alarm text generated: Door Ajar
Restored
when Request to Exit used When request to exit is activated. Alarm text
generated: Request to Exit activated
when Operator denies access When operator denies access via the deny
access input or when time limit for approval elapses before operator approves or
denies access. Alarm text generated: Access Denied <card user name> via entry
reader by Operator
Wwhen operator approves access via the approve access input. Alarm text
generated: Access Granted to <card user name> via entry reader by Operator
Alarm Statistics
The Alarm Statistics field displays information about the last alarm that occurred
for one door.
Current Door Alarms Displays the DC object’s alarm status. For a list of the
various Alarm states, see the definition of Alarm Condition at the beginning of the
DC object section.
Time of Last Alarm Displays the date and time of the last alarm when the
alarm was caused by a change of state event such as door forced open. When the
alarm was caused by an “instantaneous” event such as on Invalid Access, the date
and time of the alarm is displayed in the Time Door returned to Normal field.
Time Door returned to Normal Displays the date and time the last change
of state alarm returned to normal such as door forced open restored. When the
alarm was caused by an “instantaneous” event such as on Invalid Access, the date
and time of that alarm is displayed in this field.
Last Alarm Message Displays the DC object name and alarm text for the
last alarm.
Hidden Properties
AccessGranted
AccessGranted indicates when access has been granted. AccessGranted is TRUE
for a single scan when access has been granted.
For example:
If dc101.AccessGranted then
Lobby Light = ON
End if
AccessDenied
AccessDenied indicates when access has been denied. AccessDenied is TRUE for
a single scan when access has been denied.
For example:
If dc101.AccessDenied then
Lobby Light = OFF
End if
Overview
A door group is a collection of doors that defines a zone or area. Grouping doors
allows for a more efficient way of assigning access rights and for implementing
antipassback
The Door Group (DG) object is used to define a door group consisting of one or
more Door Controller (DC) objects. Grouping doors is advantageous for an area
that a lot of people have access to. It allows for a more efficient way of assigning
access rights by entering groups of doors in the Access Group (AG) object instead
of each door one at a time.
Using the DG object dialog, an operator can override the locks for all doors in the
group with one command.
A typical use is a medium to large size room with more than one door. All the
doors that access the room can be grouped into one group instead. To use APB
you must use door groups.
There are three uses of the DG object:
grouping DC objects to grant access rights to users.
grouping DC objects for anti-passback.
grouping DC objects for operator manual control
There is no imposed limit as to how many DC objects you can include in a DG
object, other than the memory restrictions imposed by the ASM.
Header
Value
When the Value field displays Auto, each DC object in the door group is
controlling its door.
Manual Override
Manual override allows the operator to control the locks of all doors in the door
group as described below. Manual override sets the DC objects to priority array
level 4 control.
Locked All doors in the door group are locked and remain locked until the
operator changes the override. When the doors are set back to Auto, door control
reverts to each DC object’s highest priority active control source.
Unlocked All doors in the door group are unlocked and remain unlocked until
the operator changes the override. When the doors are set back to Auto, door
control reverts to each DC object’s highest priority active control source.
Life Safety All doors in the door group are unlocked and remain unlocked until
the operator changes the override. When the doors are set back to Auto, door
control reverts to each DC object’s highest priority active control source.
Lock Down All doors in the door group are locked and remain locked until the
operator changes the override. When the doors are set back to Auto, door control
reverts to each DC object’s highest priority active control source.
Pulsed Unlocked All doors in the door group are unlocked and remain unlocked
until the operator changes the override. When the doors are set back to Auto, door
control reverts to each DC object’s highest priority active control source.
Description
The Description field can contain up to 2000 printable characters.
The Description field will often be used for a detailed functional definition. For
the Door Group, the Description field would typically describe the zone that the
Door Group defines.
Setup
Name
Name is a descriptive label given to this object. The name must be unique among
the other descriptors located on the same controller. To name the DG object, enter
up to 67 printable characters.
Anti-passback Type
Anti-passback Type sets the type of anti-passback applied to doors in the door
group.
For detailed information on anti-passback, see the Access Group object section.
There are four anti-passback settings:
None – no anti-passback.
Hard – A card user can’t enter a zone until he/she has exited the zone or until anti-
passback is reset by an operator. An entry card reader must be selected for each
door.
Soft – Anti-passback generates events when a card user enters a zone without
exiting. Entry is not prevented. An entry card reader must be selected for each
door.
Timed – A card user can’t re-enter a zone until he/she exits the zone or until a
specified Anti-passback Time interval has expired. An entry card reader must be
selected for each door.
Anti-passback Time
When using Timed anti-passback the Anti-passback Time field sets the time
interval that must elapse before access is granted to the zone after an anti-
passback violation where the card user didn’t exit the zone by presenting his/her
card.
Door List
The Door List field specifies the DC objects that are members of the door group.
Door Controller
A list of references to local or remote DC objects that are members of the door
group. A door group can hold as many references to DC objects as are needed.
To add a member to the door group or to remove a member, double click on the
white space below Door Controller to display the Select Door Controllers dialog.
The Select Door/Door Groups dialog provides two methods for adding a door
controller to the Door List:
• Select one or more doors from the list titled Select Door/Door Group and
click >>
• Type the object reference in the form Device ID.object instance in the field
titled Add Door Controller object reference, for example, 3400.DC102, and
click Add. This method allows you to add a DC object that can’t be found on
the network so you can engineer the database when the complete network is
not available.
Click OK to add the doors listed in the area titled Current Door/Door Group
Selections.
To remove a DC object from the door group, select the DC object in the right
column and click <<.
Overview
The Elevator Controller (EC) object is a complex object that implements all
aspects of access control for multiple floor buttons on one elevator cab. The EC
object allows you to configure the floor button access control characteristics and
to monitor activity. It grants and denies access on credential presentation based on
access rights you provide.
It can also be used to integrate HVAC and lighting. The EC object does all basic
elevator access control, monitoring, event management and alarming so that no
GCL+ or Event objects are required.
The EC object is not used to control an elevator’s motor, door or call system. It
prevents card users from selecting floors for which they do not have access by
interfacing to the elevator control system.
Header
Value
A read-only field that displays the EC object’s operational state. There are five
states:
Automatic the EC object is operating according to its schedules and floor
button configuration. When access control is in effect all floors buttons are
disabled; when credential is presented and access is granted, the floor buttons to
which card user has access rights are enabled. When access control is not in effect
all floor buttons are enabled.
Locked Down all floors buttons are disabled; credential presentations are
ignored.
Bypass all floors buttons are enabled and available to anyone regardless of
access rights.
Emergency all floors buttons are disabled; credential presentations are
ignored.
Life Safety all floors buttons enabled and available to anyone regardless of
access rights.
Manual Override
Manual Override allows the operator to control the floor buttons by setting the EC
object to any of its operational states described above. Manual override sets the
EC object to priority array level 5 Manual Control.
Door Status
This read-only field indicates the elevator door status as determined by the door
contact. The possible states are:
Open – The elevator door is open.
Door Ajar – The elevator door was opened, but has stayed open longer than the
specified Door Ajar time.
Not Available – There is no elevator door contact available or it is in trouble.
Description
The Description field can contain up to 2000 printable characters.
The Description field is often used for detailed functional definitions. It may
include relevant facts pertaining to use such as, configuration, setup, calibration,
wiring, limitations, sensor location and warnings.
Setup
Name
Name is a descriptive label given to the object to describe the elevator or elevator
shaft that the EC is controlling or monitoring. Although it is not necessary, the
name should be unique within the entire network. The name must be unique
among the other descriptors located on the same controller. The name is limited to
67 printable characters.
Commissioned
This setting informs the operator whether or not the EC object is commissioned.
Commissioned When this checkbox is selected, the object is commissioned
and the Lock Icon is removed from the object Header and in Navigator. All events
and alarms are generated and logged.
De-Commissioned When this checkbox is cleared, the object is De-
Commissioned and the Lock Icon displays in the object Header and in Navigator.
When the EC object is not commissioned alarms and events are not generated.
Objects that monitor this object will not transition and no alarm notifications will
be generated for that event.
Reliability
This property provides an indication of the reliability of an object’s data. This
property will have one of the following values at any given time:
No Fault Detected This is the normal state.
LINKnet Offline This indicates that the Door Module (ADM) associated with the
EC is offline.
Missing cfg Object This indicates that there are missing parameters, or that a
referenced input or output is missing.
Not Available This indicates that the output does not physically exist in the EC
object.
HVAC/Access/Lighting Checkboxes
These checkboxes are used to indicate which application(s) the object is being
used for. Any combination of applications can be selected. Leaving all
checkboxes blank is the same as selecting them all. For more information on this
feature, see the section on Security in the SUG/SUA objects.
I/O Definition
Inputs
The Inputs area allows you to configure which inputs are controlled or monitored
by the EC object. This is done by selecting the input type desired and then
selecting the matching input object from the list or typing it in. When an input
type is selected and applied, the options for that input are displayed on the Input
Config tab.
All inputs except the card reader can be local or remote. Card readers/keypads
accept references to local CR objects only. Other inputs that can be used are
Multi-State Input (MI), Multi-State Variable (MV), Binary Input (BI), Binary
Variable (BV), Binary Output (BO) and Schedule (SCH) objects.
Public Mode Input The Public Mode Input schedule determines when
elevator access control is active or in effect. When the Public Mode Input
schedule is On, all floor buttons are enabled to allow access by anyone to any
floor. When Public Mode Input schedule is Off, then the EC object manages
access control as expected by enabling floor buttons when access is granted.
Input Type
Card Reader The Card Reader input associates a card reader with the EC
object. The EC object monitors each referenced card reader for credential
presentation. When a card is presented the access granted/denied decision is made.
The card reader is linked to a Card Reader (CR) object.
Floors
The Floors area is used to set up the landings or floors you want to control access
to.
Landing # Landing # is an arbitrary reference number to identify each landing
relative to the elevator shaft. Landing # is referenced in the Access Group object
elevator floor list.
Name Type the floor name you want to assign to the landing #. Name is the
reference for floor in the alarm text.
Enable Output specifies the BO object that controls the output relay that
enables the floor button for that floor.
Button Input specifies the BI object that monitors the floor button for that
floor. Valid access event and alarm is reported when a button input is active.
Schedule specifies a SCH object that determines when access must be granted
before the floor button is enabled. When the schedule is On, the floor button is
enabled and available to anyone regardless of access rights. When the schedule is
Off, the floor button is disabled; when credential is presented and access is
granted, it is enabled.
Override The Override checkbox allows an operator to enable a floor button
temporarily. When the operator selects an Override check box and clicks Apply or
OK, that floor button is enabled until the Override Time specified on the EC
object dialog Floor Config tab expires or until a floor button is pressed.
Input Config
The Input Config tab displays the input options for the applied input types.
No Inputs Present in the I/O Definition This text is displayed when no
configurable inputs are entered in the I/O Definition. There are no options fields
for the inputs selected.
Door Contact
This field is displayed when Door Contact is selected as an Input Type.
Door Ajar Time specifies the time in seconds that the elevator door must be
open to generate the door ajar event or alarm. The valid range is from 0 – 240
seconds.
Keypad
The Keypad fields are displayed when a Keypad is defined as an Input Type.
PIN input (PIN required when ON) specifies when a PIN must be entered
following a credential presentation. Typically this input references a schedule.
Time to enter PIN – sets the time interval allowed for the PIN to be entered
correctly after the credential is presented. If this time interval expires before a PIN
is entered then the user must start again with credential presentation.
PIN Max. Attempts - sets the number of attempts to enter a correct PIN. This
feature is enabled when either of the Disable properties described below is
enabled.
Disable User after Max Attempts - works in conjunction with a combination
card/PIN credential presentation. When PIN Max. Attempts is exceeded, all
credentials associated with the identified user are disabled.
Disable Elevator after Max Attempts - works in conjunction with a
combination card/PIN credential presentation or PIN only presentation. When PIN
Max. Attempts is exceeded the EC object disables the floor buttons and refuses all
access requests until an operator resets the elevator using the Reset button in the
EC object dialog Setup tab.
Floor Config
Floor Timeouts
The Floor Config tab displays the timeout options for floor buttons controlled by
the EC object.
Select Time specifies the time that the card user has to select a floor after
access is granted and floor buttons are enabled. The default value is 20 seconds
with an allowable range of 1 to 240 seconds.
Override Time specifies the time that the card user has to select a floor button
when that button is enabled from the Override checkbox on the I/O Definition tab.
The default value is 20 seconds with an allowable range of 1 to 240 seconds.
Activity
Activity Counts
Activity is a read-only tab that provides information on activities detected by the
EC object.
Access Granted Count displays the total number of card users that have
been granted access and pressed a floor button.
Access Denied Count displays the total number of access denied for invalid
card number, invalid PIN number or time out for pressing a floor button.
Events
The EC object Events tab provides 13 built-in event categories that cover a wide
range of possible events to be generated by the elevator.
The Events tab also allows you to view the events that are recorded in the EC
object’s event log.
Events Generated
The Events Generated field is used to select the categories of events you want
generated. Each event category is selected individually for each elevator. Each
category generates one or more event messages. The alarm message and the event
message are not always the same.
Events involving a credential presentation don’t report the name of the associated
card user and the card number, however, the corresponding alarms do.
on Valid Access when a credential is presented, access is granted and a floor
button is pressed. Event text generated: Valid Access
when Lost Card used when a credential with card status of Lost is presented.
Event text generated: Lost Card
Trouble occurs when a supervised circuit has been tampered with or the EC
object is in trouble. Event text generated: Trouble
when a trouble situation is resolved. Event text generated: Trouble Ended
when floor override is used when operator uses one or more Override
checkboxes on the I/O definition tab and a floor button is pressed. Event text
generated: Floor Override
on Life Safety when a life safety input becomes active. Event text generated:
Life Safety On
when a life safety input becomes inactive. Event text generated: Life Safety Off
when Bypass is active when a bypass input becomes active. Event text
generated: Elevator Bypass On
when bypass input becomes inactive. Event text generated: Elevator Bypass Off
when Public Mode active when the Public Mode schedule transitions to
active. Event text generated: Public Mode.
when the Public Mode schedule transitions to inactive. Event text generated:
Secure Mode.
on Invalid Access when a credential is presented and access is denied
because the presentation occurred outside the allowed hours for the access group
assigned to card user. Event text generated: Time Zone Violation
when a credential is presented and access is granted but no floor button is pressed
before the timeout expires. Event text generated: Invalid Zone Access
when a credential is presented that is not assigned to any card user. Event text
generated: Unrecognized Card
when a credential is presented that is assigned to a card user who doesn't have
access rights to floor buttons in that elevator. Event text generated: Invalid Zone
Access
when a credential with card status of Disabled is presented. Event text generated:
User Disabled
when a credential with a future activation time and date is presented. Event text
generated: Inactive User <card user name>
credential with a past expiry time and date is presented. Event text generated:
Expired User
when door is Ajar when elevator door is held open too long. Event text
generated: Door Ajar
when door held open too long is closed again. Event text generated: Door Ajar
Ended
when operator Overrides elevator when an operator overrides the EC
object using EC object Manual Override button. Event text generated: Manual
Lock Down, Manual Bypass, Manual Emergency, Manual Life Safety
when a operator returns to auto. Event text generated: Manual Relinquish
for Trace User when a credential is presented, access is granted and a floor
button is pressed and when the credential is assigned to a card user with his/her
CU object's Trace User option selected. Event text generated: Trace User
when Emergency button used when elevator emergency button is pressed.
Event text generated: Elevator Emergency On
Event Log
The EC object includes a built-in event log that stores events generated by the EC
object.
The ASM automatically creates a Compact Event Log object CEL1 named Access
Control Event Log that stores events generated by all DC and EC objects on an
ASM. Use the Access Control Event Log to monitor all alarms generated on one
ASM.
For details about the built-in event management system, see Chapter 6 – Events
and Alarms.
Event Queue Size sets the number of events you want to store in the EC
object’s built-in event log. After this number of events is reached, the next event
overwrites the earliest event. The maximum number of events that can be stored in
this event log is 100.
Events stored in the EC object’s event log are also stored in the CEL object.
Selecting zero for Event Queue Size causes all events to be sent the CEL with
none being visible in the EC object’s event log. This capability is used when
security permissions set in the System User Access (SUA) object define that the
operator shall not be able to view events.
The data fields for each event depend on the event category.
Time date and time event was generated.
Type event text that identified the event category
Card User name of card user associated with the event.
Site Code site code from credential associated with the event.
Card Number card number from credential associated with the event.
Event Argument 0 has no meaning, other numbers indicate the landing #
associated with floor button that was pressed.
Alarms
The EC object Alarms tab allows you to select from 13 built-in alarm categories
that cover a wide range of possible alarms to be generated by the EC object.
The Alarms tab displays information about the last alarm that was generated by
the EC object in the Alarm Statistics section.
The ASM automatically creates an Event Class object EVC8 named Access
Control Alarm. Use the Access Control Alarm Log to monitor all alarms
generated on one ASM.
The Alarms tab allows you to select alarms which you want to be notified of and
to be logged in the Access Control Alarm Log.
For details about the built-in alarm management system, see Chapter 6 – Events
and Alarms.
Alarms Generated
The Alarms Generated field is used to select the categories of alarms you want
generated. Each alarm category is selected individually for each door. Each
category generates one or more alarm messages. Categories that are in alarm are
highlighted in red.
The alarm message and the event message are not always the same.
Alarms involving a credential presentation report the name of the associated card
user and the card number.
when door is Ajar when elevator door is held open too long. Alarm text
generated: Door Ajar
when door held open too long is closed again. Alarm text generated: Door Ajar
Restored
when operator Overrides elevator when an operator overrides the EC
object using EC object Manual Override button. Alarm text generated: Manual
Lock Down, Manual Bypass, Manual Emergency, Manual Life Safety
when a operator returns to auto. Alarm text generated: Manual no longer
controlling the Elevator
for Trace User when a credential is presented, access is granted and a floor
button is pressed and when the credential is assigned to a card user with his/her
CU object's Trace User option selected. Alarm text generated: Trace User
when Emergency button used when elevator emergency button is pressed.
Alarm text generated: Emergency
when elevator emergency button is released. Alarm text generated: Elevator
Emergency Relinquished
when Hatch is open when elevator hatch is opened. Alarm text generated:
Hatch Open
when elevator hatch is closed after being open. Alarm text generated: Hatch
Closed
Alarm Statistics
The Alarm Statistics field defines the information of the last generated alarm.
Elevator Alarm Condition This read-only field displays the current alarm
status of the EC object. For a list of the various Alarm states, see the definition of
Alarm Condition at the beginning of the Elevator Controller (EC) object section.
Time of Last Alarm displays the date and time of the last alarm when the
alarm was caused by a change of state event such as when Bypass is active. When
the alarm was caused by an “instantaneous” event such as on Invalid Access, the
date and time of the alarm is displayed in the Time Door returned to Normal field.
Time Door returned to Normal displays the date and time the last change
of state alarm returned to normal such as Bypass no longer active. When the alarm
was caused by an “instantaneous” event such as on Invalid Access, the date and
time of that alarm is displayed in this field.
Last Alarm Message This read-only field displays the alarm message from
the most recently generated alarm.
Hidden Properties
AccessGranted
AccessGranted can be used to indicate when access has been granted. This value
is TRUE for a single scan when access has been granted. This can be used to tell
when a user has access and to turn the lobby light on.
For example:
If EC1.AccessGranted then
Lobby Light = ON
End if
AccessDenied
AccessDenied can be used to indicate when access has been denied. This value is
TRUE for a single scan when access has been denied. This can be used to tell
when a user does not have access and to turn the lobby light off.
For example:
If EC1.AccessDenied then
Lobby Light = OFF
End if
EVENT
The Event object’s main purpose is to provide a method for identifying the
conditions that warrant an alarm notification. This is done by selecting an alarm
type and accompanying parameters. The type of Event is selected within the Event
object. The Event object monitors the named property of an object.
Note: An Event object does not function until the monitored Input or Output
object is commissioned. Each Input and Output has a Commissioned field. This
field must be checked. When an Input or Output object is Decommissioned, a Lock
symbol is shown beside it in Details view in Navigator. The Commissioned field
applies only to the products of Delta Controls.
Note: To disable alarm pop-ups dialogs open the user’s SUA object on the Local
OWS, click on the User Data tab and place a checkmark in the field labeled
Disable Alarm Pop-ups. For the changes to take effect the user must log out and
log back in.
Event Header
The header area of the Event object gives details about that particular Event and
its alarm input object.
The header displays the alarm type. The parameters for the particular alarm type
are displayed directly below it. Directly below the parameters the Alarm Input
object is displayed along with its present value.
The header area also displays the Pending Alarm box. The Delay countdown is
also displayed to the immediate right of Pending Alarm. Pending Alarm prevents
the system from sending alarms unless an alarm condition persists for the Time
Delay defined on the Setup tab of the Event object.
The Last Alarm Input Value field displays in the header only for a Change of
Value alarm type when the Value Type field is set to Increment. This field shows
the last value that caused an alarm.
Object Mode:
The Event (EV) object has Auto and Manual modes. You toggle from one mode
to the other by clicking on the hand icon near the top of the dialog. In Auto mode,
the object will function normally and display the status of the monitored object. A
typical status is Normal
In Manual mode, the Event object ceases to monitor the Alarm Input defined in its
Setup tab. When in Manual mode, it is possible to set the status value using the
dropdown list that appears when the object is in manual.
Event Value:
The value of the Event object is dependent on the alarm type that is monitoring
the alarm input.
The Event can have the following values:
Normal The Monitored value is operating as expected for all alarm types.
High Alarm The Monitored value is greater than the High Limit for an Out of
Range or Floating Limit alarm type.
Low Alarm The Monitored value is less than the Low Limit for an Out of
Range or Floating Limit alarm type.
Fault The fault flag of the monitored object is set. This may indicate an I/O
problem such as a broken wire or a device that is off-line. For example, if an
Event object monitors an Analog Input (AI) and a DCU controller is not properly
connected to a Baseboard, then the AI goes into Fault. The Event issues a Fault
alarm.
Trouble This value is part of the BACnet standard but Delta Controls does not
use it.
Unknown This value is part of the BACnet standard but Delta Controls does
not use it.
Further descriptions for the Event values and transitions are given in the
description for each alarm type.
General
The General tab gives general information about the transitions of the Event
object. It displays the time and date when that transition last happened as well as a
transition count since it was last acknowledged. When a transition is
acknowledged the "Transitions since Ack" count is reset back to 0.
Time of last
Shows that operator
transition.
acknowledgement is
not necessary for the
transition.
Setup
The monitored object the conditions that warrant an Event transition are specified
on the Setup tab. The Setup tab contains such items as the alarm type and
accompanying parameters for the selected alarm type.
Name
This is the name given to the Event object at creation. This is an editable field.
Alarm Type
This field specifies the type of algorithm that will be performed on the alarm input
object and property. When an alarm type is selected the parameters specific to the
type will appear for setup.
Alarm Input
This field specifies the object and its property that is to be monitored by the Event.
The field will accept entries in the following form: *.obj*.property. By default the
property is "Value" but may be changed to any other valid property of the
referenced Alarm Input object.
The following list some examples of Alarm Input entries used to monitor the
following:
• value of analog input 1 on device #1, enter: 1.AI1.Value
• status flags of binary input 1 on device #2, enter: 2.BI1.statusFlags
• fault flags of binary input 1 on device #2, enter: 2.BI1.Flags
In the OWS/DCU, there is a time delay when transitioning to Alarm and when
returning to Normal. Fault transitions do not use the time delay. The time delay is
enforced as follows in the OWS/DCU:
Normal Fault No
Fault Normal No
Alarm Fault No
Fault Alarm No
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
Messages
The Messages tab allows a message to be specified for the Alarm, Fault, and
Return to Normal transition messages.
The message text edit boxes accept event messages up to 255 characters long for
each transition. The messages are included when the alarm notification is
displayed on the workstation, printed to a printer, or logged to Event Log (EVL).
Note: Note: If a large message is entered and you are using alphanumeric paging
or short text message format to send alarm notifications, then the notification is
truncated to 130 characters.
With a DCU controller, you need to manually enter messages so that the alarm
printouts or print to files are useful. Typically a message would include a concise
description of the problem with a typical response to the alarm. The message can
include the object references (e.g. 890000.AI8) for an object.
The following Alarm Notification shows the Alarm message that was entered in
Alarm field on the Messages tab of the Event (EV) object.
A print out or a print or file using EVR1 might look like the following.
If there is text in the event message fields, then this will be included first with a
space separating it from the auto generated alarm message that follows.
Note: There is a ‘Use Auto Generated Messages’ checkbox in the Messages tab of
the EV object. If it is checked, the Alarm Notification will contain the auto
generated alarm message and the text entered in the message text box. When you
select an Alarm Type of Change Of Bitstring or Change of Value, the Use Auto
Generated Messages checkbox is automatically disabled. These two alarm types
do not automatically generate a message. If the checkbox is unchecked, the Alarm
Notification will only display the text entered in the message text box.
The following figure shows a high limit alarm message for an Out of Range
Alarm Notification.
Event Class
The Event Class object contains user settings like priority levels and
acknowledgement settings. Once an Event Class is selected its settings are
displayed. This makes it easier for the operator to confirm their choice. The data
displayed is not editable from within the Event and must be adjusted through the
Event Class itself. For more details about the Event Class see the Event Class
section starting on page 10–341 of this chapter.
If the EVC field is blank or invalid then by default notifications are sent to EVC1
but Acknowledgement is not required.
Notification Method
Notifications can be specified as either Alarms or Events in the Event Class
(EVC) object. When Event is selected, transitions for this Event Class will not
cause the alarm bell to show up in the monitored object’s dialog header nor in
Navigator's alarm state column for the monitored object or the taskbar tray. When
the Notification Method is set to "Event", the external Alarm Flag is not set in the
status flags of the monitored object. Operation is normal if the Notification
Method is set to Alarm.
This column allows the user to enter either a logical address (e.g., 1.DEV1) or a
physical network address (e.g., NET1).
Note: The default setting of “Broadcast” will not establish dial up connections. In
order to establish a modem connection for an alarm transition, the specific
network number must be entered into the “Device Address” column.
If the device address does not have ‘BROADCAST’ and if ORCAview is NOT
named in the destination list:
1 The Operator Workstation will not display an alarm notification for Events of
that class.
2 The active alarm will not be loaded when commanding the Active Alarms
Folder to Update Alarms.
3 The active alarms of that class cannot be reloaded from a device.
4 ORCAview will not automatically load the active alarms of that class at login.
For a logical address, just enter the <device>.<object><instance> or object name
of an object (e.g., 1.DEV3).
The physical network address needs a little more explanation. A physical address
is distinguished from a logical address in that it begins with NETn (where n is a
decimal number or *) or BROADCAST (which is equivalent to NET*). (This may
be entered in lower or mixed case.) A comma (,) is used to separate this from the
network address. 5 formats are supported for the network address.
They are listed below with an example of how you would enter them in the data
view. In each case, ddd is a decimal number in the range 0-255, and x is a
hexadecimal digit (0-F).
• MS/TP or PTP address (1 byte, formatted as ddd) (e.g., broadcast,42)
• 2-byte LonTalk address (formatted as ddd,ddd) (e.g., NET*,9,6)
• 7-byte LonTalk address (formatted as xxxxxxxxxxxxxx) (e.g.,
NET16,45C3B376A60DF8)
• IP address in 3.33: (6 bytes, formatted as xxxx:ddd.ddd.ddd.ddd) (e.g.,
NET46000,BAC0:192.168.8.60)
• where: NET46000 refers to the network that the destination device resides on
and BAC0 is the hexidecimal translation of port 47808 which is the IP Port #
that the destination device is using.
• IP address in 3.40: The format of the IP Address has changed in 3.40. The
Port # has been moved to the end as follows:
• IP address (6 bytes, formatted as ddd.ddd.ddd.ddd:xxxx) (e.g.,
NET46000,192.168.8.60:BAC0)
• where: NET46000 refers to the network that the destination device resides on
and BAC0 is the hexidecimal translation of port 47808 which is the IP Port #
that the destination device is using.
• Ethernet address (6 bytes, formatted as xxxxxxxxxxxx) (e.g.,
NET1,034CFFFF0005)
Input that does not fit any of the above formats is rejected.
Note: Since IP and Ethernet addresses are both 6-byte addresses, they will be
displayed in the IP address format once entered, since there is no way for the
OWS to distinguish between the two in their internal representation.
Retry
If the device fails to send the notification (either because the remote device did not
respond or because a connection could not be established - i.e. dialup failed) the
notification is placed onto the notification retry queue. It is re-sent at a later time.
Description
The Description tab is provided for the user to give a description of the Event.
This is the standard BACnet description field and can be used for any comments
the user may have. The field can contain up to 2000 printable characters and has
no bearing on the execution of this object.
Out of Range
The Out of Range alarm type is used in situations where an analog property is
monitored and a notification will be generated if its value goes out of a specified
range.
Time Delay The amount of time between the alarm input satisfying the
conditions to alarm and the actual transition. If the alarm input returns to a normal
condition before the timer counts down, the Event will not transition. See the
Setup tab Time Delay field on page 10–311 for information on the handling of
transitions between Normal, Alarm and Fault in DAC/DSC and OWS/DCU
product.
Low Limit The low limit parameter specifies the minimum value the alarm input
can drop to before an Alarm (Low Limit) transition is generated.
High Limit The high limit parameter is used to specify the maximum value that
the alarm input property can become before an Alarm (High Limit) transition is
generated.
Deadband The deadband parameter is set for Return to Normal calculations.
The role that the deadband plays in the alarm type is shown in the formulas below.
Change of State
The Change of State alarm type is used when a binary or multi-state object
property is to be monitored. Some examples are freeze status indicators, air
handler filters, smoke detectors, etc.
Time Delay The amount of time the Event will wait, after the alarm input has
changed to an alarm value, before it transitions. See the Setup tab Time Delay
field on page 10–311 for information on the handling of transitions between
Normal, Alarm and Fault in DAC/DSC and OWS/DCU product.
Alarm Values This is a list of values that are compared to the alarm input
property. If the alarm input object property matches one of these values an alarm
transition is generated.
Examples:
The change of state alarm type is also used to monitor multi-state objects. The
following example shows a change of state alarm that monitors the value of a
Device object.
Double clicking in
the “Alarming
Values” field will
produce a list of
possible states for
the Alarm Input
object.
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Floating Limit
The Floating Limit alarm type is used in situations where the high and low limits
must be based on a changing setpoint value. For example, an alarm makes a
transition if the temperature in a room is 3 degrees above or below the adjustable
setpoint for the room.
Time Delay The amount of time that the Event will wait, after the alarm input
object has changed to an alarm value, before it transitions. See the Setup tab Time
Delay field on page 10–311 for information on the handling of transitions between
Normal, Alarm and Fault in DAC/DSC and OWS/DCU product.
Setpoint Reference This field is for specifying the object and its property that
is to provide the setpoint reference. The field will accept entries in the following
form: *.obj*.property. By default, the property is "Value" but may be changed to
any other valid property of the object entered in Alarm Input field.
Low Differential Limit The Low Differential limit parameter specifies the
amount by which the alarm input value must drop below the setpoint reference to
generate a Low-Limit transition.
High Differential Limit The high differential limit parameter specifies the
amount by which the alarm input must rise above the setpoint reference to
generate a High-Limit transition.
Deadband The deadband parameter is set for return to normal calculations. The
role that the deadband plays in the alarm type is shown in the formulas below.
• Alarm Input < ((Setpoint value + High Differential Limit setting) – deadband
setting)
Command Failure
The command failure alarm type is used in situations where it must be confirmed
that one object is controlling another. For example you want to know if the fan
turned on based on the current relay feedback value. The command failure alarm
type cannot be used with analog references.
Time Delay The amount of time that the Event will wait, after the alarm input
has changed to an alarm state, before it transitions. See the Setup tab Time Delay
field on page 10–311 for information on the handling of transitions between
Normal, Alarm and Fault in DAC/DSC and OWS/DCU product.
For both external and intrinsic alarming, the Alarm Time Delay for Command
Failure alarm can be set for 0 - 65534 seconds. When using feedback value of a
physical output, the Time Delay must be greater than the time it takes to toggle the
output. Otherwise, a Command Failure alarm will be triggered every time the
alarm input value is commanded ON/OFF.
Feedback (Object Reference) This parameter identifies the object and its
property that provides the feedback to verify that the commanded property has
changed value. This parameter may reference only object properties that have
enumerated values or are of the type Boolean. For Example: 1.BO1.FBackValue
The command failure alarm type works as follows:
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Change of Value
The change of value alarm type will never generate an off normal alarm
transition. It will only generate a Return to Normal transition for basic notification
purposes. The change of value alarm type can be used to monitor analog or
bitstring data.
Note: In order for ORCAview to display an alarm notification for return to
normal transitions the referenced Event Class must be setup so that an
acknowledgement is needed for the return to normal transition.
Last Alarm Input Value This field shows the last value that caused an alarm.
The Last Alarm Input Value field only displays in the header when a Change of
Value alarm type is defined and the Value Type field is set to Increment.
Value Type The value type field is for selecting what type of property is going
to be monitored. The user can select bitstring or increment. Increment is the
default selection.
Value Type: Increment The incremental change of value alarm type is used
anytime it is necessary to monitor the incremental changes of a certain analog
value.
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Bitmask The bitmask parameter is used to specify which bits in the string are to
be monitored. Before the Bitmask Dataview will work, a valid alarm input and
bitstring property must be entered and the apply button clicked.
When this has been done, the user may double click on the Dataview and the
following dialog will appear:
The dialog provides a list of flags in the bitlist. The bits that are to be monitored
can be checked here. The example shown above is set up to send a notification
every time the “Out of Service” bit for a binary input changes.
Double clicking on the BitMask field will produce the Edit Bitlist dialog.
Change of Bitstring
The change of bitstring alarm type is used when the object property that is to be
monitored is a bitstring type. The event generates an alarm transition when the
result of an AND function of the specified bitstring with the Bitmask matches any
of the bitstrings in the list of Alarm Bitstring Values.
Alarm Input This field is for specifying the object and its property that is to be
monitored by the event. The field will accept entries in the following form:
*.obj*.property. By default the property is "Value" but may be changed to any
other valid property of the referenced Alarm Input object.
When you press Apply, the changed Alarm Input information is saved. However,
any existing Bitmask and Alarm Bitstring Values data is zeroed to avoid a
potential internal bitstring mismatch. You can now set the other fields such as
Bitmask and Alarm Bitstring Values in the normal way and press Apply / OK
when done.
Time Delay The amount of time the Event will wait, after the alarm input object
has changed to an alarm value, before it transitions. See the Setup tab Time Delay
field on page 10–311 for information on the handling of transitions between
Normal, Alarm and Fault in DAC/DSC and OWS/DCU product.
Bitmask The Bitmask field determines what bits in the monitored bitstring are
of interest to the algorithm.
Before you change either the Bitmask or Alarm Bitstring Values fields, you need
to press Apply immediately if the Alarm Input field is changed; this action zeroes
the existing Bitmask and Alarm Bitstring Values data to avoid a potential internal
bitstring mismatch. You can now set the other fields such as Bitmask and Alarm
Bitstring Values in the normal way and press Apply / OK when done.
Alarm Bitstring Values These are the list of bitstrings that are compared to the
result of the ANDed referenced property and the bitmask. If a match is established
the Event will generate an alarm transition.
The List of Alarm Bitstring Values can be made up of many different bit
combinations.
Before you change either the Bitmask or
Alarm Bitstring Values fields, you need
to press Apply immediately if the Alarm
Input field is changed; This action zeroes
the existing Bitmask and Alarm Bitstring
Values data to avoid a potential internal
bitstring mismatch. You can now set the
other fields such as Bitmask and Alarm
Bitstring Values in the normal way and
press Apply / OK when done.
1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
Before you change either the Bitmask or Alarm Bitstring Values fields, you need to press Apply
immediately if the Alarm Input field is changed; this action zeroes the existing Bitmask and Alarm
Bitstring Values data to avoid a potential internal bitstring mismatch. You can now set the other
fields such as Bitmask and Alarm Bitstring Values in the normal way and press Apply / OK when
done.
9. Click OK.
EVENT CLASS
Event Class objects are used to specify the devices to which event notifications
are sent. An event notification may need to be sent if the other device has a printer
or an Event Log. The Event Class that the Event is to use is referenced inside the
Event on its Event Class tab. The destination could be a single device such as a
DCU, DSC or Operator Workstation, all devices on a specific network, or
broadcast to all devices on all networks.
An Event that does not reference an Event Class will continue to transition
normally, and notifications are generated based on the EVC1 settings but no
acknowledgements are required.
Event Class objects are present in the default database. By default there are nine
Event Class objects in a device. They are named Maintenance, Network, Security,
Critical, Notification, Fire, Access Control Event, Access Control Alarm, and
Archival. The user may create more Event Class objects if needed.
The Event Class assigns each type of transition a priority value. The priority level
is used to determine the order in which notifications are sent out. The Event Class
also specifies what transitions need an operator acknowledgement. Finally the
EVC contains a list of devices to which the notifications are sent.
Note: Event Class objects must be configured in the same way on all devices for a
site. The Critical Event Class on device 1 must be configured the same as the
Critical Event Class on device 2.
Status
The operator can adjust the value of the Event Class. If the value is set to Not
Sending, the notifications for that class of Events will not be sent to any devices.
Setting the value back to Sending, results in the notifications being sent out.
The following figure shows the Event Class tab of the AHU1 Filter Event.
A Binary Totalizer is often used to record the run time of equipment for
maintenance purposes. Typically, the total run time in hours and number of starts
are recorded for equipment such as a fan and pump. Most electric motors need
periodic maintenance such as lubrication, or changing of belts. A Binary Totalizer
may be linked to a Maintenance Event object to signal when maintenance is
needed.
An Out of Range Event monitors the Binary Totalizer object and transitions when
maintenance is needed..
The following figure shows two DCU controllers (one an area and one a system
device) and a V3 Zone Device connected by Ethernet and BACnet MS/TP.
If communication fails between the System Device 1 and the Zone Device 2, an
alarm transition will occur.
The following figure shows the Event Class Tab of a Change of State Event that is
monitoring a motion detector.
A Change of State Event monitors the status of a fan motor. The operator is
notified when the return fan motor fails.
The following figure shows the Event Class tab of a Change of State Event object
that monitors a return fan.
An Out of Range event monitors the Supply Air Temperature. The following
figure shows the Event Class tab of the Out of Range Event.
An alarm transition will occur if the Supply Air Temperature is out of the set
range.
Fire Class A Fire Alarm reports conditions that show a fire or smoke alarm.
For example, a Fire alarm might be monitoring the input from a fire panel on site
or from a sensor connected directly to the DCU. The Change of State alarm
monitors the Return Air Smoke Detector Input that detects smoke inside the air
handler.
A Change of State Event monitors the status of a smoke detector in an air handler.
The operator is notified when smoke is detected inside the air handler.
Access Control Event This Event Class is specifically used for Access Control
events, and set up internally in the system. The user normally does not have to set
anything up, but can modify the object. See the Access Control Documentation on
Events and Alarms for more information.
Access Control Alarm This Event Class is specifically used for Access Control
alarms, and set up internally in the system. The user normally does not have to set
anything up, but can modify the object. See the Access Control Documentation on
Events and Alarms for more information.
Archival Event Class On sites with Historian, polling Trend Logs use this
event class to send notifications to Historian each time a set threshold of samples
are recorded. See the Chapter 6 - Trending, Archiving and Reporting of the
ORCAview Technical Reference manual for more information.
Diagnostic This class is used to notify the user of a diagnostic event such as a
Device Reset. The Diagnostic Event Class (EVC10) is in the default database on a
controller that has a default Event object for Diagnostic events. Currently only an
entelliBUS controller has this EVC10.
Setup
The Setup tab contains settings for transition priorities and acknowledgement. In
most applications the default settings for the Setup tab will not need to be
adjusted.
Send at Priority The Send at Priority setting is used in cases where two Events
become active at the same time. The Event management system uses the priority
value to order event notifications in a notification queue. This includes both
notifications generated by the local device and notifications received from a
remote device. The queue is sorted from 0 (highest priority) to 255 (lowest
priority). Items are taken off of the queue and are routed to local peripherals and
distributed to remote devices.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Device Address The device address is the address of each BACnet device that
will be sent a notification from any Events that reference this class. By default the
column is set to BROADCAST and the notifications will be sent to every device
on the network.
This column allows the user to enter either a logical address (e.g., 100.DEV100)
or a physical network address (e.g., NET1).
Note: The default setting of “Broadcast” will not establish dial up connections. To
establish a modem connection for an alarm transition, a specific device reference
must be entered into the “Device Address” column.
If the device address does not have ‘BROADCAST’ and if ORCAview is NOT
named in the destination list:
1. The Operator Workstation will not display an alarm notification for Events of
that class.
2. The active alarm will not be loaded when commanding the Active Alarms
Folder to Update Alarms.
4. ORCAview will not automatically load the active alarms of that class at login.
The physical network address needs a little more explanation. A physical address
is distinguished from a logical address in that it begins with NETn (where n is a
decimal number or *) or BROADCAST (which is equivalent to NET*). (This may
be entered in lower or mixed case.) A comma (,) is used to separate this from the
network address. 5 formats are supported for the network address. They are listed
below with an example of how you would enter them in the data view. In each
case, ddd is a decimal number in the range 0-255, and x is a hexadecimal digit (0-
F).
Note: Since IP and Ethernet addresses are both 6-byte addresses, they will be
displayed in the IP address format once entered, since there is no way for the
OWS to distinguish between the two in their internal representation.
Retry If the device fails to send the notification (either because the remote
device did not respond or because a connection could not be established - i.e.
dialup failed) then the notification will be placed onto the notification retry queue.
The notification will be re-sent at a later time.
This setting specifies the maximum size of the alarm notification buffer.
The default Max Notification Buffer size on a DCU is 10. The Setup tab of the
Events and Settings (EVS) object, has the Max. Notification Buffers field. Each
alarm transition uses one space in the notification buffer. This means that if an
alarm were to transition , then return back to normal and be acknowledged, the
notification buffer would have three spaces in use. If it is expected that a device
will sending out more than three or four alarms at any one time it may be
necessary to increase the Notification buffer size in the device’s Event Settings
object..
Alarm notifications that are relying on modems for transmission can take minutes
to be sent to their destinations. The DCU uses the Notification Buffer to hold
alarm notifications that have not yet been successfully sent to their destinations. If
a specified destination has gone offline, and there are many notifications that are
waiting to be sent, the notification buffer may become full and overflow. Any
alarms that become active, while the Notification Buffer is full, will not have the
notifications sent. If this situation arises it may be necessary to increase the
notification buffer size.
On a DAC, the maximum value depends on the image size of the controller. The
4Mbit DAC image allows for a maximum value of 100 and the 8Mbit DAC image
allows for a maximum value of 500. On a DSC, the value will be between 1 and
500 inclusive.
Transitions (new for 3.40) The Edit Values dialog provides a way to enable
or disable the To Alarm, To Fault and To Normal options. By default, all three
transition options are selected and notifications for these transitions are sent.
Always Send Checked Always Send checkbox is enabled by default and the
Event Class always sends alarm notifications. If the Always Send checkbox is
disabled, additional setup parameters become available for configuring a specific
window of time that the class is to send alarm notifications to the set destinations.
Valid Days Double clicking in the Valid Days column will produce an Edit
Bitlist dialog that allows the user to specify the days that the Event Class will send
the alarm notifications. The Edit Bitlist dialog contains a checkbox for each of the
days of the week. An enabled checkbox shows that the Event Class is to send
alarm notifications to that destination on that day.
From Time The From Time shows the time of day that the Event Class is to
begin sending alarm notifications. The time in this field applies to all enabled days
of the week. The time needs to be entered in the following format 12:00:00.
To Time The To Time shows the time of day that the Event Class is to stop
sending alarm notifications. This time applies to all the enabled days of the week.
The time needs to be entered in the following format 12:00:00.
Description
The Description tab is provided for the user to give a description of the Event
class. This is the standard BACnet description field and can be used for any
comments the user may have. The field can contain up to 2000 printable
characters and has no bearing on the execution of this object.
EVENT FILTER
Certain sites may find it useful to display only certain alarm notifications to
specific users. For example the maintenance personnel may only need to see
Events that are of the maintenance class while they are logged in. This object
allows the user to:
• Filter out Events or classes of alarm notifications.
• Specify certain Events or Event classes that are not acknowledgeable or
removable by the user.
• Specify a priority level for which notifications will not be filtered out.
An Event Filter can be created in the ORCAview PC only. An Event Filter cannot
be created on DCU or DAC products.
Main
The Event Filter for each user is specified in the System User Access (SUA)
object. Each user can use a different Alarm Notification Filter.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Priority Override
The Priority Override will filter the Events or Event Classes specified in the
Disallowed Alarms Dataview based on their "Send at Priority" property.
Events received with a "Send at Priority" equal or higher than the Priority
Override will not be filtered out by ORCAview. The Priority Override also
removes the user’s ability to acknowledge alarm notifications.
The Priority Override option only applies to V3 alarms. V2 alarms ignore the
priority override value stored in the EVF object.
Disallowed Alarms All entries in this column are filtered out. This means that
the alarm notification dialog will not be displayed for the alarm and the active
alarms folder will not display the active alarm.
EVC1 All Event Class #1 notifications from all controllers are filtered
EV1 Event notification 1 is filtered.
*.EVC All event class notifications from all controllers are filtered.
*.EVC2 All Event Class #2 notifications from all controllers are
filtered.
<Controller All Events and Event Classes from a particular controller are
Address>.* filtered.
e.g. 400.*
<Controller All Event Classes notifications from a particular controller are
Address>.EVC* filtered.
<Controller All Event notifications from a particular controller are filtered.
Address>.EV*
<Controller All Event Class 2 notifications from a particular controller are
Address>.EVC2 filtered.
<Controller All Event 1 notifications from a particular controller are
Address>.EV1 filtered.
*.* All Event and event Classes notifications from all controllers
are filtered.
Event Filter objects need to be referenced in the users System User Access (SUA)
object before the filter will function. This allows the system to be set up such that
each user can use a different Event Filter.
On the User Data tab of the SUA object, select an Event Filter (EVF) object from
the dropdown list for the Alarm Filter field.
With an Event Filter selected, click the Apply for the filter to take effect.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Note: For users who have Historian installed with their ORCAview system
package: The first time Historian is started, three Event Logs and three Event
Routers are created by default in the Historian database. The three default logs
generated by Historian are the Alarm Log, the Access Control Log, and the
Access Control Alarm Log. There is an Event Log for all non-Access related
events (EVC 1-6), an Event Log for Access Events (EVC7) and an Event Log for
Access Alarms (EVC 8). These Event Logs theoretically have an unlimited
maximum number of storable entries. Historian EVLs cannot be deleted. Users
can create additional EVLs on the Historian which will have an unlimited
maximum number of storable entries.
Log Tab
The Log tab contains the entries of alarm notifications that were routed to the
Event Log.
Top Dataview:
The top Dataview is the main Log. It displays alarms in chronological order. Each
transition is displayed in the top Dataview. When an entry in the top Dataview is
highlighted, the bottom area will give more details about the entry.
Alarm Input The alarm input for the Event that transitioned.
Time and Transition This column shows the time of the transition as well as the
specific transition that occurred.
The bottom area gives more details about the entry that is highlighted in the top
data view.
The following four fields are included in the Log Entry Details displayed at the
bottom of the EVL dialog.
Event Class This shows the class that the Event is a member of.
Event Class This shows the class that the Event is a member of.
Last Alarm Input Value This field shows the last value that caused an alarm.
This field displays in the header of the EV object only for a Change of Value
alarm type when the Value Type field is set to Increment.
Alarm Input Value Value of alarm input that caused the transition.
Exceeded Limit The high or low limit that was exceeded. The high limit
parameter is displayed for high limit entries; likewise the low limit parameter is
displayed for low limit entries.
Exceed High/Low Limits The high or low limit that was exceeded. The
calculated high limit is displayed for high limit entries; likewise the calculated low
limit is displayed for low limit entries.
COV Type Indicates if the change of value alarm is monitoring an analog value
or a bitstring.
Increment The final value of the alarm input object after the increment.
Bitmask Indicates the bits in the monitored bitstring that are set.
The details given at the bottom of the Event Log are alarm type specific. In other
words, the details given about an Out of Range alarm are different from the details
given for a Change of State entry.
Note: The details given at the bottom of the Event Log are alarm type specific. In
other words, the details given about an Out of Range alarm are different from the
details given for a Change of State entry.
Exceeded Limit:
The high or low limit that
was exceeded. The high
limit parameter is displayed
for high limit entries;
likewise the low limit
parameter is displayed for
low limit entries.
Deadband:
The deadband parameter
setting for the Event.
Event Status:
Indicates if that transition
required an
acknowledgement.
Exceeded High/Low
Limits:
The high or low limit that
was exceeded. The
calculated high limit is
displayed for high limit
entries; likewise the
calculated low limit is
displayed for low limit
entries.
Setpoint:
The value of the setpoint
object referenced in the
Event.
Feedback (Object
Reference):
Value of feedback object at
time of transition.
COV Type:
Indicates if the change of
value alarm is monitoring an
analog value or a bitstring.
Increment:
The final value of the alarm
input object after the
increment.
Change of Value (Bitstring) Entry
COV Type:
Indicates if the change of
value alarm is monitoring an
analog value or a bitstring.
Bitmask:
Indicates the bits in the
monitored bitstring that were
set.
Acknowledgement Entry
Describes the
user and the
device that
acknowledged
the alarm
notification.
Event Status:
Setup
The Setup tab contains settings.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Reliability The Reliability field shows the state of the reliability flag for the
Event Log object. Under normal operating conditions it displays “No Fault
Detected”
Historian Note: This field is not adjustable for EVLs created on the Historian
Device. EVLs on Historian can hold a theoretically unlimited number of events.
Caution: Adjusting the Maximum Log Entries value will result in the Event
Log being reinitialized and all entries being removed.
Event Class The Event Class drop-down box allows the notification’s event
class to be chosen. The choices available reflect the EVCs that are in the
controller. When the threshold is exceeded, a notification dialog displays if the
Event Class has Operator Acknowledged enabled for “Return to Normal”
transitions.
Threshold The Threshold field specifies the number of log entries recorded
before an event occurs. When the number of records is exceeded, the threshold
count is reset. Another event will occur if the number of records exceeds the
threshold value. This setting causes event to occur at multiples of one plus the
threshold value. For example, if the Threshold is set to 5, then an event occurs at
6, 12, 18, etc. record counts.
Records Since Last Notification The Records Since Last Notification field
shows the number of samples since a notification was issued.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Log Acknowledgement
Enabling this checkbox causes the acknowledgements for transitions to be
recorded at the named destination.
Schedule Reference
If the SCH object referenced in the schedule reference is inactive then the Event
Router will not route to the named destination. This field is optional. The field
accepts only SCH object. If the schedule object is on then the notification will be
sent to the named destination. Schedule object must be on the same device as the
Event Router.
The fields in the Class and/ or Events to Log section provide a way to filter the
Alarms / Events that are logged by the EVL object.
The Classes/Events to log are entered in this field. Any specified alarms or
notifications from alarms which reference an Event Class found in this
Class/Event list are logged.
Class / Event The user selects or enters the class of alarm notifications that are
to be logged to the EVL.
The user may also enter the Remote Events. The choices in the dropdown include
all the EVCs and EVs that are in the controller.
• EVC* - All alarms of all Event Classes are routed on the current
controller
• *.EVC* - All alarms of all Event Classes are routed from all controllers
Since Event classes of the same instance in all devices must be the same
(100.EVC1 == 200.EVC1), if EVC1 is referenced in the Event Log as a class of
alarms to log, then all Events of that class, regardless of which device they
originate from, are logged.
This field specifies which events to log based on transitions defined in the Setup
and Destination List tabs of EVC objects. Event objects use EVC objects to
specify behavior based on the assigned Event Class.
Transition Bits
The available options for the Transition Bits field are To Alarm, To Fault and To
Normal. If you double click on an entry within a selected row, then an Edit Values
dialog appears. Modify the selected values and then click OK.
Highest Priority
The Highest and Lowest Priority fields work together to specify events to log.
The range of this field is from 0 to 255 with a default value of 0. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected value by clicking on one of the arrows or by entering a value
into the field.
The Priority for the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Lowest Priority
The Highest and Lowest Priority fields work together to specify events to log.
The range of this field is from 0 to 255 with a default value of 254. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected value by clicking on one of the arrows or by entering a value
into the field.
The Priority that the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Event Flag
The available options are Ack Req, Ack Not Req and Send Ack. If you double
click on an entry within a selected row, then an Edit Values dialog appears.
Modify the selected values and then click OK.
Description
The Description tab is provided for the user to give a description of what the
Event Router is doing. This is the standard BACnet description field and can be
used for any comments the user may have. The field can contain up to 2000
printable characters and has no bearing on the execution of this object.
The Event Router and the Event Class are used in conjunction with each other.
The Event Class specifies which BACnet devices are to receive a notification.
When the notification is received, the device uses the Event Router to determine
how to handle the notification.
Note: The Event Router is not used to send notifications to other BACnet devices.
The Event Class does this.
The Event Router has 2 states; Routing and Not Routing. These states indicate
whether or not the object is routing based on the Schedule reference. If the state is
Not Routing, the notifications are no longer sent to the specified destination. The
state can be manually changed when the object is in Manual mode.
Name
Name is a descriptive label given to an object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters for the
OWS and DCU, and 1 to 67 characters for DAC products. The name must be
unique among the objects located on the same controller.
Send Acknowledgements
Enabling this checkbox causes the acknowledgements for transitions to be routed
to the specified destination.
Schedule Reference
This field is optional and accepts a Schedule (SCH) or Binary Variable (BV)
object reference. The dropdown only lists the SCH objects but a BV object
reference can be manually typed into this field.
If the object referenced in the Schedule Reference field is inactive then the Event
Router will not route to the specified destination. If the object is active then the
Event Router will route to the specified destination.
The fields in the Class and /or Events to Route section provide the means to filter
the Alarm/Events that are routed by the EVR object.
The Classes and Events that are to be routed by this Event Router are entered in
this field. Alarm notifications from a specified event or an event that references a
specified event class are routed.
Class / Event
Local and remote CEL and EV objects can be referenced in addition to global
EVC objects. Since CEL can only send ACK-not-required events, the Ack Not
Req type has to be filtered in EVR, otherwise email for CEL events will not be
sent out. Ack Not Req is filtered by default, and it can be edited from the Ack
field. The choices in the drop-down include all the EVCs and EVs that are in the
controller.
• EVC* - All alarms of all Event Classes are routed on the current
controller
• *.EVC* - All alarms of all Event Classes are routed from all controllers
Since Event classes of the same instance in all devices must be the same
(100.EVC1 == 200.EVC1), if EVC1 is referenced in the Event Router, then all
Events of that class, regardless of which device they originate from, are routed.
Transition Bits
This field specifies which events to route based on transitions defined in the Setup
and Destination List tabs of EVC objects. If a Transition is selected in the EVR,
then it is routed by this EVR. In the Alarm Filtering tab of the EVR object, the
available options for the Transition Bits field are To Alarm, To Fault and To
Normal.
If you double click on an entry within a selected row, then an Edit Values dialog
appears. Modify the selected values and then click OK.
Min Priority
The Min and Max Priority fields work together to specify events to route.
The range of this field is from 0 to 255 with a default value of 0. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appear.
Modify the selected values by clicking on one of the arrows or by entering a value
into the field.
The Priority that the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Max Priority
The Min and Max Priority fields work together to specify events to route.
The range of this field is from 0 to 255 with a default value of 254. A value of 0
represents the highest priority and a value of 255 represents the lowest priority.
If you double click on an entry within a selected row, then a spin box appears.
Modify the selected values by clicking on one of the arrows or by entering a value
into this field.
The Priority for the Fault, Return to Normal and Ack transitions are sent at is
defined on the Setup tab of the EVC.
Ack
The Ack field provides a way to filter what Events to route based on the setting of
the Operator Acknowledged checkboxes in the EVC object. If you double click on
an entry within a selected row, then an Edit Values dialog appears. Modify the
selected values and then click OK.
Setup
The Setup tab is where the user can set up the type of event router. The Setup tab
is used to select the type of destination, along with destination specific settings,
that the Event Router is routing to.
Destination Type
The Destination Type drop down box is used to select what type of destination the
Event Router will send the notifications to.
The available options in this list depend on the type of device that you create the
EVR object in. Some Destination Types are only available in certain types of
devices. The available Destination Types for the different device types are listed
below:
The following table summarizes the available Destinations and Alarm Escalation
options on the Destinations / Alarm Escalation tab for a DSC controller:
Message Format
This drop down box is available for all the Destination Types. This field is used to
select the format of the notification message. The available options for this field
depend on the Destination Type that is selected.
Long Text has a message limit of about 350 characters and Short Text has a
message limit of about 130 characters. Short Text and Long Text formats apply to
both Email and Printer Destinations.
When using the EVR object to send alarm notifications to an Alphanumeric pager,
messages sent to the pager are limited to 130 characters. If the message is larger
than 130 characters, three dots (...) are appended to the end of the message
indicating that there is more to the message. Since pagers are limited to about 140
characters themselves, a limit of 130 characters was chosen, to leave some
characters for the added timestamp. There is no point sending more characters as
the pager and/or pager system may simply truncate long messages or possibly
discard the entire message.
File Name
Only the Print to File Destination Type, contains the File Name field. The default
file name is Print_Output.txt.
Printer Name
On an OWS, the Printer Name field appears only for an EVR object that was
created for an Windows Printer. This field is not applicable to the DSC.
Port Status
This read-only field is only visible for Printer (Local) and Pager/SMS Destination
Types. This field displays the status of the PTP port of the controller.
When the Destination Type is set to Local Printer, communications on the PTP
port is disabled since the port will only be used to send notifications to the printer
and the Port Status field will display “Driver Disabled”.
When the Destination Type is set to Pager/SMS, the EVR will only use the PTP
port when it needs to send a notification, and as soon as it is done, it will release
the port. When the EVR object is using the PTP port to send out a notification, the
Port Status field will display “Active”. When the EVR object is not using the PTP
port, the Port Status field will display “In Use By”, indicating that the NET object
is using the port for communications.
Baud Rate
This drop down box selects the speed between the PTP port on the controller and
the modem or printer. The following speeds are available: 9600, 19200, 38400;
with 9600 being the default. Both ends of a Point-to-Point connection must use the
same speed.
Dial Retries
This spin box is used to set the number of modem redial attempts. The field
accepts a value from 0-10. The default is 2 retries.
Init String
This field specifies the string that is used to initialize the modem. This string is
sent to the modem when the controller is reset and when the modem ends a call.
Refer to your modem manual for more details on the correct Initialization String.
Modem Type
The initialization string is defined for the modem based on the Modem Type
selection. Select your modem from the drop down list or chose Custom to enter a
user defined Modem initialization string. The choices from the drop-down are:
U.S. Robotics, USR (Quick Connect Disabled), Zoom, Boca, and Custom. Based
on the selection, the initialization string uses standard settings for a particular type
of modem.
Dial Prefix
This field specifies the string that is sent to the modem when starting a
connection. It tells the modem to get ready to dial.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
If the selected Destination Type does not require a destination (Local Printing,
HTTP, File, or Windows Printer), this tab will display “Destination(s) not needed
for the selected Destination Type”.
Email is selected as the Destination Type on the setup tab for the following screen
capture.
Current Selection
The number of the selected record in the Dataview. For example if the Current
Selection is 7, that means that the seventh record in the Dataview is selected.
Status
This field displays messages about whether the last notification was sent
successfully or if there was a problem. For example, a successful message could
be “Page sent Successfully”.
The following table lists some common error messages that could be displayed in
the Status field along with possible reasons for the error.
Alarm Escalation is only applicable for Email and Pager/SMS Destination Types.
If Alarm Escalation is not applicable for the selected Destination Type (HTTP,
Local Printing, File, or Windows Printer), this tab will display “Alarm Escalation
is not applicable for the selected Destination Type”.
Current Destination
This field displays the corresponding entry in the Destinations list that the EVR is
sending notifications to during the escalation cycle. Assuming Auto Escalation is
enabled, this value will begin incrementing at the First Destination to Try, jump
back to the beginning of the list once it reaches the end, and stop at the First
Destination to Try.
Auto Escalation
Auto Escalation means that the EVR object automatically escalates through all of
the destinations one at a time. When Auto Escalation is disabled, GCL is required
to control the Current Destination (EscalationIndex property of the EVR object).
Using GCL to control the Current Destination allows for implementing Alarm
Escalation capabilities that will suit a required purpose. Auto Escalation is enabled
by default.
Retry Interval
This spin box specifies the interval (in minutes) between sending notifications.
The minimum interval that you can specify in this field is 1 minute. The default is
5.
Debug Messages
This field displays the last message that was sent. It is used to ensure the proper
message was sent and ensure its format. It can also be used to compare the
message that the EVR sent with what the user actually received.
Description
The Description tab is provided for the user to give a description of what the
Event Router is doing. This is the standard BACnet description field and can be
used for any comments the user may have. The field can contain up to 2000
printable characters and has no bearing on the execution of this object.
The Event and Alarm Settings is present in the default database. Event and Alarm
Settings cannot be created or deleted.
The Event Setting object contains two tabs.
• Setup
• Stats
Setup
The Setup tab contains general event management settings for the device.
V3 Alarms to Track
The alarms to track menu allows the user to select which active alarms are to be
tracked by the device. The alarm to track menu has three possible selections.
• None– The device will not track any Events. If this is selected the Auto load
active event list and master alarm device properties are not available.
• Local– Tracks only the events on the local device.
• Local & Remote– Events from all devices will be tracked.
By default ORCAview tracks local and remote alarms and the DCU will only
track its own local alarms.
The DAC/DSC does not support being an "Alarm Master", and can only track
local alarms and not remote alarms. The 'V3 Alarms to Track' droplist no longer
has the "Local & Remote" option so that it is clear that the DAC/DSC cannot be
an Alarm Master.
On an OWS/DCU, this value will auto increase to a maximum value of 500 with a
minimum value of 1.
On a DAC, the maximum value depends on the image size of the controller. The
4Mbit DAC image allows for a maximum value of 100 and the 8Mbit DAC image
allows for a maximum value of 500. On a DSC, the value will be between 1 and
500 inclusive.
The default Max Notification Buffer size on a DCU is 10. The Setup tab of the
Events and Settings (EVS) object has the Max. Notification Buffers field. Each
alarm transition uses one space in the notification buffer. This means that if an
alarm were to transition, then return back to normal and be acknowledged, the
notification buffer would have three spaces in use. If it is expected that a device
will sending out more than three or four alarms at any one time it may be
necessary to increase the Notification buffer size in the device’s Event Settings
object..
Alarm notifications that are relying on modems for transmission can take minutes
to be sent to their destinations. The DCU uses the Notification Buffer to hold
alarm notifications that have not yet been successfully sent to their destinations. If
a specified destination has gone offline, and there are many notifications waiting
to be sent, then the notification buffer may become full and overflow. Any alarms
that become active, while the Notification Buffer is full, will not have the
notifications sent. If this situation arises it may be necessary to increase the
notification buffer size.
On an OWS/DCU, this value will auto increase to a maximum value of 500 with a
minimum value of 1.
On a DAC, the maximum value depends on the image size of the controller. The
4Mbit DAC image allows for a maximum value of 100 and the 8Mbit DAC image
allows for a maximum value of 500. On a DSC, the value will be between 1 and
500 inclusive.
Stats
The Stats tab gives details such as the number of times a certain processes have
taken place and the number of times that errors in the event management system
have occurred. The data in this tab is provided for troubleshooting the event
management system.
Active Events Shows the number of events that are currently active on the
device.
Events Generated This provides a count of how many transitions have occurred
on the device.
Activity List Overflows The number of times the device could not provide a
complete update of an event activity list. If this count is increasing the solution is
to increase the “Max. Event Activities in List” setting.
Activity Lists Missing The number of times an event activity list object for an
entry in the active list is not in the database.
Activity List Deletion Failed The number of times the system did not delete a
known existing event activity list. This may happen when the maximum number
of event activity objects is decreased in the event Settings object and the number
of activity lists fails to decrease to the new setting.
General Activity List Error The number of times errors occurred within the
activity list.
Failed to Initialize Destination List The number of times the system was
unable to initialize the destination list in an event notification. The list of
destinations in the notification is based on the one provided by the Event Class.
Event Class Missing The number of times there was no Event Class for the
Event.
Notifications Statistics
The notifications area of the Stats tab contains statistical data about the
notifications received by the device.
Retry Count The number of Event notifications requiring one or more retries to
send.
Notification Buffer Overflows The number of times that an Event Class could
not get a notification buffer.
Event Text Lost The number of times the system was unable to fit the event
text into the notification.
Event Info Lost The number of times the system was unable to fit the Event
information into a notification.
Acknowledge Text Lost Number of times the system was unable to fit the
acknowledgement text into the notification.
Notifications Missing The number of times the notification was in the buffer
but not in the database.
Notifications Missed The number of times a notification was received & not
processed for one reason or another.
Notification Deletion from Buffer Failed The number of times the notification
could not be deleted from the buffer. This may happen when the maximum
number of notification buffers is decreased but some of the entries weren’t
deleted.
WARNING
Warning: If the DCU is to track both local and remote alarms it may be
necessary to increase the Maximum Event Activities in List setting in the device’s
Event Settings object.
2. Adjust the V3
Alarms To Track
setting to “Local
and Remote".
FILE (FIL)
The File (FIL) object is used to transfer out a database. FIL1 is a special database
manipulation object that is included in the default database. It stores the structure
and properties of the database so that it will be saved back in correctly and saved
out correctly. All the fields, with the exception of the Name field on the Setup tab,
are Read Only. The FIL1 object does not directly impact the user of an application
but handles internal database functions.
You can create additional File objects. When the object is created, you can specify
the options on the Setup and advanced tabs.
Delta Controls Inc. supports File Objects for our proprietary database format and
for the BACnet database format.
Description
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
File Content
This field is not currently implemented.
File Size
This field indicates the size of the file data in octets.
Archive
This True or False field indicates if the File Object has been saved for historical or
backup purposes.
Read Only
This True or False field indicates whether it is possible to write to the File.
Advanced
The following figure shows the Advanced tab of the dialog before the Apply of
OK buttons are pressed.
Modification Date
The time and date of the last change to the file. When a file is created or written
to, it is considered modified.
File Type
The File Type is set to Virtual by default and cannot be changed by the user. This
field indicates the intended use of the file.
When you create the object, you can choose either Disk-Based File or In-Database
File.
File Path
The File path field only displays for the Disk-Based file type. It specifies the
location and name of the database file on the local hard drive. You must create the
file that is specified in the path.
The following figure shows the Advanced tab of the dialog before the Apply of
OK buttons are pressed.
GATEWAY (GW)
The special interface controllers of Delta Controls Inc. are capable of acting as a
gateway to interface a BACnet network with third party product(s) using
proprietary non-BACnet protocols. The information from the third party device is
translated into BACnet objects in the special interface controller and is then
available to the rest of the BACnet network.
The available fields in the Gateway object dialog will differ depending on the type
of gateway loaded.
For information specific to the Delta Wireless Gateway, see the Delta Wireless
Gateway section of this topic.
Modbus Gateway
The following information is specific to the Modbus Gateway.
Header (Modbus)
Setup (Modbus)
Enable
This checkbox enables or disables the gateway.
Version
This field displays the version number of the gateway firmware loaded into the
Delta Controller. The version number of the Gateway firmware is different from
the main firmware version number listed in the Device object.
Type
This field displays the type of gateway that is loaded into the Delta Controller.
Status
This field displays the status of the gateway. When the gateway is enabled, this
field displays Running. When the gateway is disabled, this field displays Stopped.
Port
This field is used to select the physical port to connect to the Modbus slave
device(s).
When connecting via PTP, only a single Modbus slave device is supported.
Speed
This field is used to select the baud rate for communication with the Modbus slave
devices(s). The baud rate must be set to the same speed on both devices in order
that they communicate properly. The supported speeds are 2400, 4800, 9600,
19200, and 38400 baud.
Parity
This field displays the parity of the Gateway, and cannot be changed.
Status
This field displays the current status of the selected port. When the port is being
used by the gateway, this field displays Active. When the gateway is disabled, this
field displays Inactive. If the selected port is in use by something other than the
gateway (i.e. NET object), this field displays "In Use By" and lists the name of the
object using the port.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Statistics (Modbus)
Total Sent
This field displays the total number of Modbus packets sent from the Delta
Controller since the last controller reset. The value of this number is not very
important but it should be continuously incrementing. If the Total Sent is not
incrementing, then it means that no packets are being sent.
Total Received
This field displays the total number of packets received from the Modbus slave(s)
since the last controller reset. The value of this field should be incrementing along
with the Total Sent field. If the Total Received is not incrementing along with the
Total Sent field, then it means that the Delta Controller is sending requests but the
Modbus slaves are not responding.
Send Failures
This field displays the total number of sent packets that failed to receive a
response since the last controller reset.
Invalid Received
This field displays the total number of invalid packets received since the last
controller reset. Invalid packets are those that contain an incorrect cyclic
redundancy code (CRC).
A CRC is a number derived from, and transmitted with, a block of data in order to
detect corruption. By recalculating the CRC and comparing it to the value
originally transmitted, the receiver can detect some types of transmission errors.
Protocol Errors
This field displays the total number of exception responses returned since the last
controller reset.
Programming (Modbus)
The Programming tab is not used for the Modbus Gateway but only with the Delta
Wireless Gateway.
Description (Modbus)
The possible states are listed in the table with an explanation of what can cause
each state.
State Explanation
OK Successfully received information.
Protocol Error Data received from the wireless receiver does not
follow the standard packet layout. For instance, the
receiver may not be programmed in ASCII mode.
Select the Programming tab and press the Program
Receiver button.
No Data Received No data was received from the wireless receiver
since the controller was last reset.
Enable
This checkbox enables or disables the gateway.
Version
This field displays the version number of the gateway firmware loaded into the
Delta Controller. The version number of the Gateway firmware is different from
the main firmware version number listed in the Device object.
Type
This field displays the type of gateway that is loaded into the Delta Controller.
Status
This field displays the status of the gateway. When the gateway is enabled, this
field displays Running. When the gateway is disabled, this field displays Stopped.
Port
This field displays the port that the Delta Controller is using to connect with the
wireless receiver. This field is read only because only the PTP port can be used to
communicate with the wireless receiver.
Speed
This field displays the baud rate of communications with the wireless receiver.
This field is read only as the wireless receiver only communicates at 9600 baud.
Status
This field displays the current status of the selected port. When the port is being
used by the gateway, this field displays Active. When the gateway is disabled, this
field displays Inactive. If the selected port is in use by something other than the
gateway (i.e. NET object), this field displays "In Use By" and lists the name of the
object using the port.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Total Sent
This field displays the total number of packets sent from the Delta Controller
since the last controller reset.
Total Received
This field displays the total number of packets received from the wireless receiver
since the last controller reset.
Send Failures
This field displays the total number of sent packets that failed to receive a
response since the last controller reset.
Protocol Errors
This field displays the total number of protocol errors received since the last
controller reset. Protocol errors occur when the Delta Controller receives data that
does not follow the standard packet layout. For example, the receiver is not
programmed in ASCII mode.
Invalid Received
This field displays the total number of invalid packets received from the wireless
receiver since the last controller reset. Invalid packets could be received because
of cabling issues such as interference or improper connection.
Sensor Address
This spin box is used to set the address of the wireless sensor that is being
programmed.
System Number
This spin box is used to set the system number of the transmitter or receiver. The
receiver will only receive information from transmitters with the same system
number if the Enable multiple receiver system checkbox is checked.
Programming Status
This field displays the programming status.
Instructions
This field displays any instructions to be followed in the programming process.
Program Transmitter
This button programs the Transmitter and Receiver with the data entered into the
corresponding fields.
Program Receiver
This button programs the Receiver with the data entered into the corresponding
fields.
You must have a separate GWT object for each Modbus device that you want to
communicate with. Each GWT object must have an instance number equal to the
network address of the Modbus device that it is associated with.
The following information describes the fields in the GWT object dialog.
Setup (Header)
The Setup tab has two fields and a button located above the Dataview.
Name
The name of the Gateway Translation object is displayed in this field.
For example, the first register in the Holding Registers memory block (also
referred to as 4x references) may be documented any of the following ways:
• Holding Register 1 (1-Based Decimal Register Count)
• Holding Register 0 (0-Based Decimal Register Count)
• Holding Register 0000H (0-Based Hexadecimal Register Count)
• Register 40001*
* Note: The leading digit in the last example is used to represent the memory type
(in this case a Holding register) while the remaining digits indicate the register
count in a 1-based decimal format.
Setup (Dataview)
The Data View on the Setup tab lists all of the translated information from the
Modbus device.
Clicking on one of the entries will display additional information below the Data
View.
Name
The Name of the BACnet object that is linked to the Modbus register for this
entry.
Reference
The object reference of the associated BACnet object. Only AV, BV, and MV
object references are supported.
Exceptions
A read only field that shows any exception codes returned from the Modbus
device for that entry. Exception codes are error codes returned from a Modbus
slave device in response to a request from the Master device. Refer to the Delta
Modbus Gateway User Manual for more information on exception codes.
Read
When checkbox is checked, this indicates that the value is being read from the
Modbus device into the associated BACnet object. Unchecked indicates the value
is being written to the Modbus device. This field is read-only in the Dataview. To
change this value you must highlight the desired entry and use the R/W
Configuration drop down box located below the Dataview.
Memory Type
Memory Type determines where the data is stored in the memory of the Modbus
device. Each Memory Type reads or writes to a certain range of memory in the
Modbus device.
Double Integer (special case) Coil Registers (0x References) Each coil
register is a 1-bit piece of data that typically represents the Boolean (ON/OFF)
state of an output or internal variable. These registers can be written to or read
from.
Each Input Status register is a 1-bit piece of data that typically represents the
Boolean (ON/OFF) status of an input or internal variable. These registers are
read-only.
For more information on the different data formats, refer to the Delta Modbus
Gateway User manual. These registers can be written to or read from.
For more information on the different data formats, refer to the Delta Modbus
Gateway User manual. These registers are read-only.
Register
Specifies the starting register for the data value in the Modbus device to be
referenced. Registers are specified without the Memory Type reference (i.e. 0x,
1x, 3x, 4x). For example, for a Memory Type register reference of 40001, enter a
value of 1 assuming a 1-based Register Count.
# of Registers
Specifies the number of registers that the data value in the Modbus device spans.
The value that is entered in this field is determined by the data format selected in
the Data Type field.
Data Type
Specifies the data format used to read/write the data value stored in the Modbus
device. The different Data Types are:
• Integer – 16-bit signed integer (occupies 1 register)
• Long – 32-bit signed integer (occupies 2 register)
• Bit Value – 1-bit Boolean (ON/OFF) (occupies 1 register)
• Double Integer – 32-bit Unsigned Integer (occupies 2 registers)
• Float – IEEE 32-bit floating point Big Endian (occupies 2 registers)
• Float (Reversed) – IEEE 32-bit floating point Little Endian (occupies 2
registers)
• Float (Swapped) – IEEE 32-bit floating point Little Endian with byte-
swapped (occupies 2 registers)
For more information on data types, refer to the Delta Modbus Gateway User
Manual.
Bit
Specifies a particular bit to extract when reading from a 16-bit Holding or Input
register. This can be a value from 0-16 where 1 is the least significant bit (LSB)
and 16 is the most significant bit (MSB) in the selected register. 0 is a special
case in which the entire 16-bit register is evaluated as either zero or non-zero. This
field is only used when mapping a value from a Holding or Input register to a BV
with a data type of Bit Value.
Setup (Fields)
The following four fields are located directly below the Dataview in the GWT
object dialog.
Units
The Units drop-down box is used to select the units that the associated BACnet
object will be created with when the Create BACnet Objects pushbutton is used.
This field only applies when mapping to AV object. MV or BV objects do not
have a units property.
R/W Configuration
This drop-down box is used to select whether you want to read from or write to
the selected data value in the Modbus device.
Note: If you wish to both read and write to a single value in a Modbus device, you
must create two separate entries in the table, one for reading the value and another
for writing to the value. In addition, these two entries must not be referencing the
same BACnet object.
Scaling/MV Offset
This field is used when mapping a Modbus value to an AV or MV object.
Register Address
This is a display only field that displays the full decimal and Hexadecimal
Address for the starting register of the data in the Modbus device for the currently
selected Dataview entry.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Description
The description field may contain a character string of up to 2000 characters. The
character string is limited to printable characters.
Header
Object Mode
The Historian’s current mode of operation is displayed at the top of the header.
Historian’s five modes of operation are as follows:
Initializing Historian is establishing connections to its ODBC database and to
Delta Server and is initializing its schedule.
Archiving Historian is collecting data samples from one or more source TLs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Sleeping Historian is “waiting” for one of three events to occur, it will then
transition into Scheduling mode. Historian enters scheduling mode when any of
the following three events occur:
When the next scheduled polling time is reached.
When a COV buffer ready notification from a TL is received.
When a Forced Update for a Historical TL is requested by the user.
Scheduling Historian is “calculating” which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database, the ODBC
database connection or else the Delta Server is offline. Historian will periodically
attempt to recover from the fault condition by reconnecting.
In Fault mode, Historian does not archive TLs or Alarm/ Event Notifications to its
ODBC database. However, Alarm/ Event Notifications are logged in a separate
MS Access database that is created when Historian is in fault due to database, or
database connectivity problems.
When Historian is in fault due to Delta Server being down, Historian does not log
to the Access database file as it no longer receives Alarm/ Event Notifications.
The backup Access file is called HistorianFaultDB.mdb and is located in the
Historian install folder.
Current Time This field displays the current time of the Historian PC.
Next Poll This field indicates the next scheduled time at which the Historian
Device will archive samples from one or more TL’s. Historian may start to poll
before this time if a forced update is requested, or if a Buffer Ready Notification is
received from a TL.
Last Poll This field indicates the last time that any TLs were polled for new
samples.
Stats
The Stats tab only shows statistics when viewed from the local Historian PC.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
Historian Uptime
Indicates how long the Delta Server has been running on the Historian PC. It
displays the length of time in Days/ Hours/ Minutes/ Second.
Processing Time
Provides a relative indication of the status of Historian over time. The fields
display the percentage of total time which is spent in Archiving, Sleeping,
Scheduling, Initializing and Fault states. It tracks the percentage of time that
Historian is in each state and begins when the first TL is added.
To specify the database name in the DSN for Microsoft SQL server:
1 Open Data Sources (ODBC)
For a 32 bit OS, open Control Panel | Administrator Tools.
For a 64 bit OS, you must use the 64 bit ODBC Data Source dialog (NOT 32
bit one). The Microsoft support provides vital configuration information. See
http://support.microsoft.com/kb/942976
2 Select the System DSN tab. See HistorianDSN listed:
3 Click Configure.
4 Click Next.
5 Select the authenticity type to SQL Server Authentication. Be sure to use the
SQL Server authentication.
6 In Login field, type the UserID displayed on the HS object Setup tab. The
default UserID is “sa”.
7 In Password field, type password you entered during the SQL Server
installation.
8 Click Next.
9 Select the Change default database to checkbox.
10 Select HistorianDB from the Change default database to dropdown list.
If HistorianDB is not an option, leave the Default Database field blank and
finish this procedure. Start and stop Historian which causes the HistorianDB
to be created automatically. Use this procedure to define the Default Database
To ensure that the Stats and Troubleshooting tabs work on the HS, enter the
ODBC data source information on the Setup tab of HS.
11 Click Next.
12 Click Finish.
13 Click Test Data Source … See results similar to:
The configuration steps between the connector and the server are similar to the
previous Configuring DSN for Microsoft SQL Server section of this chapter. The
HS dialog needs to reflect all the changes done with the ODBC data source.
Troubleshooting
Troubleshooting is often difficult and demands many higher-order skills combined
with experience to solve problems in an efficient and effective manner. The
solution to a simple problem can be direct but often with complex systems, it is
difficult to resolve a problem. In many cases, a problem may have multiple
causes. With many components such as systems, equipment, controllers, software,
sensors and transducers, a complex system has a greater possibility of problems
due to multiple causes.
With a simple problem, it is easy to interpret appropriate data that helps to isolate
a reproducible cause and make suitable changes to prevent recurrence while not
introducing new problems.
With a complex problem, the nature of the problem itself is often unclear and may
also involve dynamic effects such as events that are not predictable. Some of the
most difficult troubleshooting issues arise from symptoms which are intermittent.
Your solution needs to prevent recurrence but also must not introduce further
problems within the overall system. After implementing a solution, you need to
observe and collect data to ensure its continued effectiveness.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does NOT indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source must
be set up in Windows.
High Usage Trend Logs This is a list of the ten fastest to fill trends (Poll or
COV). You may not need to do anything about these trends because this list
shows the TLs that use the most Historian resources.
For example, the High Usage list may contain a Trend Log that collects large
amounts of data at frequent intervals. Everything may be fine as you need to
collect this data. Alternatively, the sample rate may be much too high for this
particular variable. It is also possible that the characteristics of the monitored
object value do not match expectations and indicate a possible problem within the
site. You may be using much more Historian resources than intended or needed
for a High Usage TL.
All Archive Trend Logs can be configured so that Historian can archive all Trends
without missing samples. To make sure this is the case on your site, use the
information in this High Usage table and in the Histlog.txt to verify the Trend
Logs in the High Usage list are configured correctly. The Histlog.txt can be
searched to make sure none of these Trend Logs have missed samples reported
and the information in the High Usage Trend Logs table should be reviewed.
The following table explains the information included with a High Usage Trend
Log list item. Each TL entry is followed by two numbers.
8000.TL1 - 3240, 1
Historian will be able to keep up with this trend.
First #: The number of seconds Historian waits between
(PollInterval) successive Trend Log data collection operations. This
is the PollInterval from the ScheduleInfo table in the
3240 database.
(Seconds between TL Historian cannot archive a single Trend Log more
Archives) than once every 120 seconds. This deliberate
constraint prevents a single poorly configured Trend
Log from dominating Historian’s resources.
The following table provides general guidelines for interpreting the information
included with a possible High Usage Trend Logs list item.
Second #:
(PeakRate) Lower 0.125 < 0.4 <1 >6 60
(Number of
Samples per
minute)
The following table provides some examples of possible High Usage Trend Logs
List Items with interpretation of the example.
8000.TL1 - 8100, 0.4 Good: Historian can keep up with this trend.
8000.TL1 - 86400, 0.125 Better: Historian can definitely keep up with this
trend.
Trend Logs with Insufficient Samples This is a list of the top ten trends
(Poll or COV) that Historian will miss data from with the current TL
configurations. If a Trend Log is on this list, it indicates a definite problem that
needs attention. These Trend Logs often do not have a large enough Max Samples
setting in the source Trend Log for Historian to be able to archive all new data at
the rate each Trend Log is storing data.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Generally, you would increase the size of the buffer for the Trend Logs which
provide the most important data. There is a balance between the demands of data
collection, the memory available on a controller and the relative importance of the
data.
For example, a list item might be:
8000.TL1
8353.TL6
If 8000.TL1 is a Poll Trend Log with a Log Interval of one second and a Max
Samples (buffer size) of 100, then Historian cannot archive all the data. Historian
will miss many samples as Historian data collection is restricted to a maximum
interval of 120 seconds for a single Trend Log. This deliberate constraint prevents
a single poorly configured Trend Log from dominating Historian’s resources.
A solution might be to increase the Max Samples and/ or to increase the Poll
Interval. You could increase the Max Samples buffer size assuming that memory
is available on the controller. You could also reduce the data collection rate by
increasing the Poll Interval as it is probably not necessary to collect new data
every second.
If 8353.TL6 was a COV trend log, a typical solution would be to evaluate the
COV Increment of the Monitored Object to make sure that it is reasonable for the
point being measured and then change the COV increment and/or increase the
Max Samples for the TL as appropriate.
In the case of an intermittent problem, you can run a query on the ScheduleInfo
table looking at the MaxPeakRate. The MaxPeakRate provides the highest number
of samples per minute ever recorded in the past.
The following query will help identify trends that have problems due to
intermittent periods of high data samples:
Select * FROM ScheduleInfo ORDER BY MaxPeakRate DESC
When the trends with intermittent high data rates are identified, you can increase
their MaxSamples, decrease their COV rate number or decrease the samples rate.
The extra HistLog info also lists this information.
Setup
The Setup tab contains the setup items for Historian’s auto logon, ODBC
connection, TL polling and error logging.
Auto Logon
UserName This field specifies the name that the Historian Device uses when it
logs onto the Delta Server.
Password This field specifies the password that the Historian Device uses
when it logs onto the Delta Server.
The UserName and Password must match those of a System User Access (SUA)
object in the local database, or in the security panel. For information on changing
the password see Chapter 6: Trending, Archiving and Reporting.
ODBC Info
Historian is installed with a default Database Management System (DBMS), and
the settings are displayed in this section. Most users will not need to change the
following fields unless they choose a different DBMS package or if they need to
apply user security to the Historian database. Users who choose a different DBMS
will need to set these fields up appropriately. For more information on ODBC see
Chapter 6: Trending, Archiving and Reporting.
Driver The Driver field indicates the type of ODBC DBMS that Historian is
configured to use.
UserID The UserID field specifies the name that Historian uses to connect to
the database. The UserID and Password for the database are configured when the
DBMS package is installed. There is no relationship between this UserID and the
user name that the Historian will use to log onto the Delta Server.
DSN The Data Source Name (DSN) field specifies the ODBC DBMS source
that Historian is using. To use an alternate DBMS source, it must first be set up
through the appropriate ODBC Data Source Administrator dialog. Use the 32 or
64 bit version based on your OS..
Password The Password field specifies the password that Historian uses to
connect to the database. UserID’s and Passwords for this database are set up using
the installed DBMS package.
DB Name The DB Name field specifies the database that will store the
archived information. If a database name is not specified then Historian uses the
default database assigned to the selected DSN.
Archive TLs are presented as regular TLs to the other BACnet devices. As such,
they are accessible via any BACnet Operator Workstation (OWS) that supports
TLs as defined in the BACnet Standard (2001b or later). H istorian will not work
with devices implementing trending as defined in versions of the standard prior to
2001b.
Once TLs are archived, these Archived TL’s cannot be removed without using a
database management tool.
Header
In the previous figure, the first section of the header shows the Historical TL’s
operating mode.
Samples
The Samples field displays the number of data samples that are currently stored in
the ODBC database for this TL.
Update Button
The Update button allows users to instruct the Historian Device to immediately
archive any new samples in the source TL.
Graph
The Graph tab contains a visual representation of the monitored object’s values
within a specific time frame.
The graph plots the object’s value on the Y-axis, against the time, which is on the
X-axis. These two axes are automatically scaled to best fit the available data.
Only the 200 most recent samples are graphed. To view the full set of TL data
graphically, create a Multi-Trend (MT).
Setup
All the fields within the Setup tab are read-only, with the exception of the Name
field.
Name
The Name field displays the name of the Archive TL. In the previous figure, the
Name text box shows the default naming convention for Archive TL’s. The Name
field can contain up to 255 characters. The Archive TL is named in this way: the
TL controller number, the TL name and then Archive. For example, an archived
TL for Temperature, on controller 100 would look like this: 100_Temperature
Archive.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security.
When a checkbox is selected, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Monitored Object
The read-only Monitored Object field displays the name of the source TL’s
monitored object. If the source TL’s monitored object is changed, the Historian
Device will detach from the TL and a new TL is created for the new monitored
object.
Log Type
The read-only Log Type field displays whether the source TL is in Polling mode,
or in Change of Value (COV) mode. Depending on the how the TL is configured,
Historian gathers the data in the following ways:
Log Interval
The read-only Log Interval field is only shown when the source TL has a Polling
Log type. The log interval is the amount of time between polled samples of the
source TL. The value in this field is taken from the Log Interval field of the source
TL.
When changes are applied to this field in the source TL, the field is also updated
in the corresponding Archive TL.
Max Samples
The read-only Max Samples field displays the maximum number of samples that
can be stored in the TL. In an Archive TL, this field is set to ‘unlimited’.
Total Samples
The read-only Total Samples field displays the total number of samples that the
archived TL has collected since it was created.
Start Trend At
This field shows the value of the Start Trend At field from the source TL. This
value does not affect the functioning of the archived TL.
Stop Trend At
This field shows the value of the Stop Trend At field from the source TL. This
value does not affect the functioning of the archived TL.
Data
The Data tab contains a text listing of all the data stored in the Archive TL. Each
entry shows the time and date at which the sample was collected, and is presented
with the newest data at the top of the list.
The Value column shows the value of the sample, which is displayed as 1 or 0 for
Binary values. An “Active” state is indicated by 1, and an “Inactive” state is
indicated by 0.
The Value column also displays error and status messages. This helps with
troubleshooting because these error and status messages do not show up in the
graph.
Some of the system messages that are shown in the Data tab include:
• Time Change: the time on the controller changed.
• Log Enabled: the source TL was enabled.
• Log Disabled: the source TL was disabled.
• Missed Sample: Historian missed a sample from the source TL.
• Buffer Purged: the source TL’s buffer was cleared.
• Archive Disabled: the archived TL has been disabled.
• Archive Enabled: the archived TL has been enabled.
If an archived TL is disabled, the log may have an Archive Disabled entry. If the
Archive TL is re-enabled and Historian finds that no samples have been missed,
the Archive Disabled entry in the Data tab is removed.
If, however, samples have been missed, Historian leaves the Archive Disabled
data entry in the Data tab and inserts an Archive Enable entry after the missed
sample entries.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
Description
The Description tab provides the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
Supported devices include all Ethernet controllers except DCU, enteliTOUCH and
DAC-EC (Compact-Ethernet DAC) controllers.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
IP
The Dynamic Host Configuration Protocol (DHCP) is a network protocol for
automating the configuration of a controller that uses IP (Internet Protocol).
DHCP is used to assign temporary or permanent network (IP) addresses to
controllers and deliver configuration parameters such as the subnet mask and
gateway address. The controller automatically extracts its configuration from a
server called the DHCP server.
In a typical DHCP process, a controller requests the use of an IP address from the
DHCP server. The DHCP server then allocates and assigns an IP address for the
controller to use for a particular amount of time. The period over which a network
address is allocated to a controller is called a lease. The amount of time for the
lease is determined by the DHCP server.
The Use DHCP checkbox in the IP Tab of the IPS object is disabled (grayed out)
if the device is a BBMD and UDP/IP is enabled in the NET object. This is done so
that the availability of the DHCP checkbox in the IPS object matches the DHCP
checkbox in the NET object. DHCP cannot be used when the controller is a
BBMD device because they require a static IP Address and cannot have a
dynamic address.
When Use DHCP checkbox is unchecked or grayed out, IP address, Subnet Mask,
Gateway Address and User-denied DNS can be entered manually in the text boxes
by users.
IP Address
This field sets the IP address that the controller will use. Each device
communicating by UDP/IP must have its own unique IP Address.
192.168.1.10
Three different address classes have been created: Class A, Class B, and Class C.
Addresses which begin with a number in the range of 1 to 126 are considered
Class A, numbers in the range of 128 to 191 are Class B, and numbers in the range
of 192 to 223 are Class C. For example, 192.168.1.10 is considered Class C.
Addresses that begin with 127 or 224 - 254 are reserved for special purposes.
Currently, all supported controllers have only a single IP address even for the
device with 2 UDP/IP adaptors.
Subnet Mask
This field sets the subnet mask for the network to which the controller is
connected. A subnet mask uses the same four-part format as an IP address and is
written using the same dot format.
Subnet masks are used to separate the network that the device is connected to
from the device itself. Each device has a subnet mask associated with it. This
allows the device to know what other devices are its peers (on the same network),
and which devices are reachable only by a gateway or IP Router. Typically, a
subnet mask has only one of two numbers in each of its four positions: 0 and 255.
This is why these two numbers cannot be used to specify an actual IP address. A
very common subnet mask is the following:
255.255.255.0
This particular subnet mask specifies that devices which have the identical first
three numbers in their IP address belong to the same network. For example:
This means that these two devices can communicate without the need for a
gateway. However:
Therefore, for these two devices to communicate, at least one gateway will be
required.
If the subnet mask is 255.255.255.0, only 254 devices can be connected on the
same network. Remember, 0 and 255 cannot be used in an IP address. For some
networks this is insufficient, so three different classes of IP address (Classes A, B,
and C) were created, which each have their own subnet mask.
Gateway Address
This field sets the IP address of the site gateway or IP Router that is used to
connect with off-site devices. This field is only required if two different networks
need to communicate with each other. This would be the case with a Wide Area
Network (WAN). This IP address is supplied by the site network administrator.
Gateways are commonly used in WANs to join the individual Large Area
Networks (LANs) at each site to each other.
A gateway has the job of sending network traffic from one network (subnet 1) to
another network (subnet 2). A gateway uses the subnet mask of a packet to
determine if it should forward it to the remote network or not. If the destination
address of the packet is not in the local subnet, then the gateway or IP Router will
send the packet to the remote network.
However, for this to work, the local devices must be given the IP address of the
gateway. The device typically labels this IP address Gateway address or Router
address.
User-Defined DNS
This field defines the IP address of the Domain Name Server (DNS). The DNS
server looks up a name such as deltacontrols.com and associates an IP address
with it. The DNS server is required if you specify a name for the SMTP Server
such as mail.deltacontrols.net
DHCP: Section
A controller requests the use of an IP address from the DHCP server. The DHCP
server then allocates and assigns an IP address for the controller to use for a
particular amount of time called a lease.
DHCP:Server IP Address
This field shows the Server IP address that provides dynamic IP address to the
controller.
Email
The Email feature is used for event or alarm notifications which can be routed by
Event Router (EVR) object. The fields on this tab are hidden for Ethernet
controllers that do not support Email.
Note: Some SMTP Servers require that you use a valid email account in the From
field when sending emails. Check with your network administrator to ensure you
are using a valid email account.
SMTP Server
This field contains the address of the SMTP server. For example, an address might
be “mail.yourISP.com”. This field will also accept the IP address of the SMTP
Server (e.g. 192.168.1.200). Your network administrator can provide you with the
SMTP Server address. If you wish to enter the SMTP address in text format (e.g.
mail.yourISP.com), a User-Defined DNS must be specified.
You cannot use simple host names like “mail”. You must enter the Fully Qualified
Domain Name (FQDN) (e.g. "mail.deltacontrols.net") to your mailer, or email will
not work.
SMTP is short for Simple Mail Transfer Protocol which is a protocol for sending
email messages between servers. Most email Internet mail systems use SMTP to
send messages from one server to another. In addition, SMTP is generally used to
send messages from a mail client to a mail server.
However, you only need to specify the SMTP server in the controller and not the
POP or IMAP server since the controller is only able to send emails and not
receive them.
TCP Port
This field specifies the TCP/IP port number used by Simple Mail Transfer
Protocol (SMTP) server for the Email feature. By default it has a value of 25,
which is the standard port number for SMTP. It is recommended to check with
your server administrator before changing the port number.
Timeout
The Timeout defines how long the controller (email client) waits for the server to
respond. The default value is 10 seconds but it can be increased up to 600
seconds.
SNTP
This feature is supported only on certain types of controllers. The dialog fields on
the SNTP tab are hidden on Ethernet controller that do not support STNP.
Server Address
This field provides the network address of a central NTP server. SNTP can
interpret NTP broadcast messages and synchronize time to a central server. The
internet has many public level-two time servers that can be specified for a server
located in your geographic area. The default SNTP URL is “pool.ntp.org” which
is a world-wide time server providing reliable NTP service.
Poll Interval
This field specifies the time interval between time synchronization of a client with
the central server. The Poll Interval has a range of 10 to 50000 minutes. The
default time interval is 781 minutes (13 hours + 1 minutes) which allows the
controllers to receive time on a different hour of the day each interval. Controllers
also have internal offset (device address MOD 31 minutes) on top of the time set
in the field.
In order to take DST in account when setting controller time, this setting must be
configured properly even though the checkbox is disabled by default.
• North American,
• European,
• Australian or
• Other DST time defaults.
This field defaults to North American. If the operator selects European then the
typical values for the European countries DST will appear in the DST fields. The
operator will still be able to modify the affected fields if there are slight
differences from the standard. If the operator does modify the standard, as soon as
APPLY is pressed the standard will change to OTHER. This will indicate to the
operator that the standard has been modified.
The purpose of DST is to conserve sunlight during the summer months. This is
accomplished by manipulating the clock time so that both sunrise and sunset will
take place at a later hour. This will have the effect of giving us one extra hour of
sunlight in the evening.
NORTH AMERICA:
Effective Hour - 2 AM
Offset - 60 Minutes
AUSTRALIA:
Effective Hour - 2 AM
Offset - 60 Minutes
EUROPE:
Offset - 60 Minutes
OTHER:
No set defaults. User can enter any option that they want.
For example if the DST start on the First Sunday in April (e.g. April 3) and the
"On and After" box is unchecked, DST will start on the 3rd of April. If however
"On and After" box is checked and the date selected in this field is 5, then DST
would not take effect until April 10. This type of DST algorithm is primarily used
in South American countries.
An IOM object provides the means to map the input and output function on a
enteliBUS control system which can map over 500 input and output points. The
IOM object lists and provides information on all connected I/O modules that are
plugged into the backplanes of the EnteliBUS. The enteliBUS Controller
(eBCON) accepts I/O modules (eBM) on the backplane, and multiple expansion
backplanes (eBX) with more eBM mounted can be connected to it. EnteliBUS
supports both Linknet and eBUS protocols for I/O devices.
The enteliBUS controller (eBCON) has a four slot controller backplane and
accepts up to eight enteliBUS expander backplanes (eBX) that each support up to
eight IO Modules. These enteliBUS I/O Modules provide the field I/O interface
for the enteliBUS Control System. The I/O Modules support all the common
control types allowing the controller I/O mix to efficiently meet any application.
Each IO Module can handle a total of eight input and output points.
The following figure shows an enteliBUS Controller with a four slot Controller
Backplane connected to an OWS through an Ethernet hub. The backplane has four
IO Modules.
The eBCON (CPU for enteliBUS) provides the local control and an optional
display and control function through a touch screen (enteliTOUCH).
Setup
Name
A read-only field that displays the default name of the object.
Port
Displays the physical port number that defines the type of IO bus. For eBUS, it is
0 and for LINKnet, it is 2. The Port number is from the address that the I/O is
coming in on. Since BACnet address goes up to 4194303, this means the port is
limited to 0-40.
Network Type
Displays the protocols defined for each physical port. Currently, eBUS and
LINKnet are available.
Enabled
Indicates if the Network Type is enabled for a physical port. It is based on the
protocol defined on the Setup tab of the Network Protocol Settings (NET1) object.
The values are either TRUE or FALSE.
I/O Range
Specifies the maximum range for the hardware with the maximum number of
backplane expanders and the IO modules.
Device
Provides the eBUS address of the module. The first two digits show the address
labeled as eBUS Address physically set on the front of the expansion module
(eBX). The last two digits indicate the slot position on the expansion bus. The first
two digits are actually 00 and are not shown. They indicate the Port which is 00
for eBUS.
Status
Provides the status of the module. Possible status values are Online and Offline.
Online means that expansion module (eBX) is able to query a device. Offline
means that eBX is not able to query a device because a module was plugged in but
it is no longer available. For example, the physical device is no longer plugged in
or it is has problems.
If an eBX goes offline, its slave eBMs (point modules) also go offline. In the
following figure, eBX Module 2000 is offline and all its slave modules (2100 to
2800) also are offline.
If an eBX (e.g. 2000) is unplugged, it shows a Not Present status and none of its
slave eBM’s are listed.
Description
The Description tab is provided for the user to enter a description related to the
object. This is the standard BACnet description field and can be used for any
comments the user may have. The field can contain up to 2000 printable
characters and has no bearing on the execution of this object.
where:
yy physical IO 01 - 04 01-16
terminal on the (depends
module on
Device)
The enteliBUS IO can use the eBUS and/or the LINKnet communication
protocols.
The Sensor for detecting Outdoor Air Temperature is connected to Analog Input
(AI) on terminal1 of the second module mounted on the second backplane of
enteliBUS controller device number 100.
100.AI / 00 / 02 / 2 / 01
which is:
100.AI2201
Any leading zeroes are dropped. Since the port is 0 for eBUS, we drop all leading
zeroes
In the following figure, the IO object reference is broken down in the appropriate
IO object to clearly indicate the physical location of the point.
The Sensor tab for the RTU1 Supply Air Temperature Analog Input
(20100.AI1101) contains information that links the software input object to a
specific hardware location for the point.
Field Description
Label
Port Type of IO bus. e.g, LINKnet,
eBUS
Device Backplane
PM Point Module
Output Physical point location on the
module
100.AI / 02 / 01 / 0 / 01,
which is:
100.AI201001
Any leading zeroes are dropped. Since LINKnet devices do not use modules, this
place holder is always 0.
The following table shows the type of alarm function for each of the objects that
support intrinsic alarming.
The Alarm State field changes color depending on the alarm state. The field is red
if Alarm State is abnormal.
The High Limit, and Low Limit fields change color depending on the Alarm State.
These fields are yellow when the value of the object exceeded the corresponding
limit, and the alarm is waiting for the Alarm Delay to expire. The Alarm State,
High Limit and Low Limit fields become red when the current AlarmState
transitions.
For a status of Return to Normal to occur, the value must first return to the High
(or low) limit plus the magnitude of the deadband. If a new alarm condition occurs
while object is already in an alarm condition, another transition is NOT generated.
Event Enable
Alarm Fault
Values
Dataview
Acked Transitions
Alarm
Fault
Return to Normal
For AI and AO which use Out-of-Range alarm type, either Normal, High Limit,
Low Limit or Fault will be displayed in the field. For BI,and MI which use
Change-of-State alarm type and BO which use Command-Failure alarm type,
either Normal, Alarm or Fault will be displayed. For all intrinsic alarming objects,
the field displays Fault when object’s Reliability fault is present which indicates a
reliability issue from an object execution perspective.
The Alarm State field changes color depending on the alarm state. The field is red
when the Alarm State is abnormal.
For both external and intrinsic alarming, the Alarm Time Delay can be set in the
range of 0 - 65535 seconds with a default of 60.
In supported products, there is no time delay when returning to Normal. All other
transitions apply the time delay. The time delay is enforced as follows in
DAC/DSC products:
Alarm Normal No
Fault Normal No
With Delta Controls equipment, Event Class objects are present in the default
database. By default, there are nine Event Class objects in most supported
products.
With intrinsic alarming, the alarm bell icon always displays on the alarm object’s
header and in the Navigator Alarm state Column for the object or in the taskbar
tray when an alarm is triggered regardless of Notify Type. This behavor differs
from that of external alarming.
The choice of either Alarm or Event depends on how users wish to indicate an
alarm or trouble in the object when it is recorded in historian.
The Alarming tab on the Analog Input object monitors if the value of the AI is
between fixed high and low limits and if the input has no fault detected.
The Out of Range alarm type is used in situations where an analog input value is
monitored and a notification is generated if its value goes out of a range specified
by fixed high and low limits.
The Alarming tab on the Analog Output object monitors if the value of the AO is
between fixed high and low limits, and if the output has no fault detected. The Out
of Range alarm type is used in situations where an analog property is monitored
and a notification is generated if its value goes out of a range specified by fixed
high and low limits. The alarming feature on Analog Out functions exactly the
same as Analog Input as they both use Out-Of-Range alarm.
The High Limit, and Low Limit fields change color depending on the Alarm State.
These fields are yellow when AO.Value or AI.Value has exceeded the
corresponding limit, and the alarm is waiting for the Alarm Delay to expire. The
High Limit and Low Limit fields become red when the current Alarm State
transitions.
The High Limit, and Low Limit fields change color depending on the Alarm State.
These fields are yellow when AO.Value or AI.Value has exceeded the
corresponding limit, and the alarm is waiting for the Alarm Delay to expire. The
High Limit and Low Limit fields become red when the current Alarm State
transitions.
The role that the deadband plays in the alarm type is shown in the formulas below.
Examples
Consider the monitoring of a binary flow sensor which is normally ON. An alarm
is needed if there is no flow in the duct. Since the alarm is to be Off Normal when
the flow sensor is inactive, the alarming value will be OFF'.
Consider a freeze status indicator in a air handler unit. An alarm is needed when
the freeze status sensor is ON. For this case the alarming value will be a ON. This
means that when the sensor is ON, the alarm generates a transition.
The change of state alarm type may also be used to monitor multi state objects.
The Command Failure alarm type is used when a binary object value is monitored.
Some examples are actuators to open or close a valve. For example, you want to
know if the fan turned on based on the current relay feedback value which is
similar to a Command Failure alarm type.
With Feedback Enabled or from GCL on the Device tab, feedback value can be
Active depending on the physical output status or the command in GCL. In this
case, the alarm performs a Command Failure function. The status transitions to
alarm only when the BO value doesn't match the Feedback value.
The change of state alarm type is used when a digital object value is monitored. It
uses a list of Alarm Values and Fault values to monitor MI objects with more than
two input levels. When the Current State is equal to any of the values entered in
the Alarm Values Dataview, the MI generates an Alarm transition. When the
Current State is equal to any of the values entered in the Fault Values Dataview,
the MI generates a Fault transition.
Note: If a large message is entered and you are using alphanumeric paging or
short text message format to send alarm notifications, then the notification is
truncated to 130 characters.
The following Alarm Notification shows the Alarm message that was entered in
Alarm field on the Messages tab of the Analog Input (AI) object being used to
detect the BACstat’s hardware temperature.
A printout, email, pager or SMS message would look like the following.
If there is text in the event message fields, then the text is included first with a
space separating it from the auto generated alarm message that follows.
The Use Auto Generated Messages checkbox is enabled by default and is used to
include standard message in the alarm text. The standard auto generated message
text is shown in tables in the Standard Auto Generated Message Text topic on
page Error! Bookmark not defined. at the end of this section.
If the user leaves the corresponding message field for an event blank, only a
standard message is generated. If the user wishes to add additional messages to the
standard message, then text must be entered in the corresponding message fields.
If the checkbox is disabled, the alarm notification will only display the text
entered in the message text fields.
The following figure shows an Out Of Range (High Limit) alarm Notification
with auto generated message.
Header
The header area (also known as the common area) of the LCD object displays
information that can be seen regardless of which tab is selected. It contains the
value assigned to the LCD object, which type of device the LCD object is
representing, and the last keypress value from the keypad.
Object Value
The Object value is displayed next to the Room Controller icon. The value of the
LCD object is displayed in this field.
The LCD object value can be assigned a text string from the display or the value
of another object. The Header Value dropdown box selection and the Object
Name selection in the Setup tab determines its value.
Device Type
This read-only field displays the type of device that the LCD represents. For a
Room Controller, the Device Type can be DSM-T0, DNT-T305, DSC-T305, or
DAC-T305. For a BACstat I, the device type is DNS-14. For a BACstat II, the
Device Type can be DNS-24, DNT-T103, or DNT-T221. If the LCD is
representing a Linknet device, this field will also contain the Linknet address. For
example, “( Linknet 1 )”.
View
The View tab contains a virtual LCD screen. The virtual LCD screen is a
graphical representation of the actual LCD screen. The virtual LCD screen is used
for verifying what is being displayed on the physical LCD screen from your
workstation.
Since the virtual LCD screens for the Room Controller and BACstat devices are
different, they are described below in different sections.
Room Controller
The following figure displays the virtual LCD screen for a Room Controller.
There are three text sections and numerous icons that can be displayed. The first
text section (Line1) is the largest in character size and is located in the middle on
the top of the screen. Line1 has four characters. The second text section (Line2) is
half the character size of Line1 and is located in the upper right corner of the
screen. Line2 has four characters. The third text section (Line3) has characters
equivalent in size to the characters in Line2 and is located along the bottom of the
screen. Line3 has twelve characters. The following figure highlights the three text
areas of the LCD display.
Line1
Line2
Line3
The following table lists the icons included in the previous figure.
Network Fan
Auto Heating
Humidity Cooling
BACstat I
The following figure displays the virtual LCD screen for a BACstat I.
There is only one text section and no icons that can be displayed on a BACstat I.
The only text section is referred to as Line1. Line1 has three characters. The
Keypress Value field name in the previous figure is out of date and it is now
called Last Key Press.
BACstat II
The following figure displays the virtual LCD screen for a BACstat II.
The Keypress Value field name in the previous figure is out of date and it is now
called Last Key Press.
There are three text sections and numerous icons that can be displayed. The first
text section (Line1) is located at the top of the screen. Line1 has three characters.
The second text section (Line2) is the larger of the three text sections and is
located in the middle of the screen. Line2 has three characters. The third text
section (Line3) has characters equivalent in size to the characters in Line1 and is
located at the bottom of the screen. Line3 has four characters. The following
figure highlights the three text areas of the LCD display.
Line1 Units
Line2 Units
Line2
Line3 Units
Line3
The following table lists the icons included in the previous figure.
Setup
The Setup tab displays different information depending on the type of controller it
is representing. The following figure is for a DNT-T305 controller.
The following figure is for a DSM-PWR controller which has a beeper and a
real-time clock.
Header Value
The Header Value dropdown box defines what is displayed as the object value.
There are four possible choices: Reference, Line1, Line2, and Line3. If Reference
is chosen, another field named Object Name will appear directly below the Header
Value field. The object value will be the value of the object in the Object Name
field. If Line1, Line2, or Line3 are chosen, the Object Name field will disappear
and the object value will be the text on the specified line of the LCD display.
Object Name
This field appears only if Reference is chosen from the Header Value dropdown
box. The object value will be the value of the object in this field.
For example: If AV1 is in the Object Name field, and the value of AV1 is 75, the
value of the LCD object will be 75.
Name
Name is a descriptive label given to an object. Typically, a name is less than 20
characters in length. The valid length of a name is from 1 to 67 characters. The
name must be unique among all objects located on the same controller.
If a key (button) is held, this is the initial delay (in milliseconds) before the button
press is registered again. The default value for this field is 1000 ms (1 second).
When a button is held and after the initial delay (Key Repeat Delay), this is the
interval at which the button press is registered as another press. The default value
for this field is 300 ms (0.3 seconds).
Beeper On
This field is only displayed if the Device Type is a type of Room Controller.
The Beeper On field denotes the amount of time (ms) that the beeper stays on
when it is enabled. At the end of the Beeper On time, the Beeper Off time starts
running.
Beeper Off
This field is only displayed if the Device Type is a type of Room Controller.
The Beeper Off field denotes the length of silence (ms) between beeps. At the end
of the Beeper Off time, the Beeper turns on again for the Beeper On time.
Beeper Repeat
This field is only displayed if the Device Type is a type of Room Controller.
Defines the number of times that the beeper sounds. The duration of each
individual beep is set using the Beeper On and Beeper Off fields.
Contrast
This field is only displayed if the Device Type is a type of Room Controller.
The contrast field displays the level of darkness on the actual and virtual LCD
screens. The contrast field can be anywhere from 0% to 100%. 0% is the lightest
and 100% is the darkest. 50% is a good contrast level for most applications.
Back Lighting
The Back Lighting field displays the level of the Back Lighting on the actual LCD
screen from 0% to 100%. A Back Lighting level of 0% means the light is off. A
Back Lighting level of 100% means the light on the actual screen is at full
brightness. Any level in between is linearly calculated as a brightness level from
0% to 100%. For example: A Back Lighting value of 50% will cause the screen to
illuminate to half brightness.
Note: The virtual screen in the View tab will show a white square around the
screen if the Back Lighting field has a value of anything other than 0%. If the
Back Lighting field value is 0%, the white square will not appear.
Advanced
The Advanced tab allows you to change what is displayed on the different lines on
the LCD. It also tells you what icons are displayed on the LCD. The fields that are
displayed in this tab depend on the type of device the LCD is representing.
Note: If GCL is writing to the LCD, then it takes precedence over anything that
you input for a line in the dialog. When the program scans, it will write over both
the field and the content of the line in the LCD.
There are two choices in this field: None, and GCL. If None is chosen, the Line 3
string will not be formatted, and you can use GCL to write to Line 3 of the
BACstat II. If GCL is chosen, the Line 3 string will be formatted for time (display
a colon “:”) so that GCL can write Time to Line 3 and the BACstat will display
the colon. If you want to display the time on Line 3 of the BACstat II, the local
system or subnet controller will need to use GCL to write the time to Line 3 (see
the examples below).
The following GCL code displays the time (in military time format from 0 to
2400) on Line 3 of the BACstat’s LCD. When using this example, you will need
to set the Time Source to GCL to get it to display the colon (“:”).
LinkLCD1.Line3 = Time
Note: This example will not format the time displayed with leading zeroes. For
example, at 0:00, it will display “ : 0” (note the blank spaces before and after the
colon). This is because this example just writes a value from 0 to 2400 to the
LCD.
The following GCL code displays the time (in military time format from 0 to
2400) on Line 3 of the BACstat’s LCD, and it formats the time displayed with
leading zeroes. For example, at 0:00, it will display “0:00”. When using this
example, you do not need to set the Time Source to GCL because the string being
written to the LCD already has a colon in it.
The following GCL code displays the time on Line 3 of the BACstat’s LCD in
AM/PM (12-hour) format. When using this example, you will need to set the
Time Source to GCL to get it to display the colon (“:”).
Variable strTime As String
If (Hours > 12) Then //If it is past noon
strTime = (Hours - 12) //convert to 12-hour format
LinkLCD1.Line3Units = 6 //Display "PM"
ElseIf (Hours = 12) Then //If it is noon
strTime = (Hours)
LinkLCD1.Line3Units = 6 //Display "PM"
ElseIf (Hours = 0) Then //If it is midnight
strTime = "12" //convert the 0 hour to 12
LinkLCD1.Line3Units = 5 //Display "AM"
Else //If it is between 1AM and 11AM
strTime = (Hours)
LinkLCD1.Line3Units = 5 //Display "AM"
End If
strTime = strTime & Format(Minutes,0,2,"0")
LinkLCD1.Line3 = strTime //Write the finished string
Symbols
The Symbols section of the Advanced tab tells you what icons are being displayed
on the LCD screen. These fields are read-only and can be controlled only through
GCL and Illustrator. Certain fields are only displayed for a Room Controller and
some only for a BACstat I/ BACstat II.
Here is a description of the fields that appear for both a Room Controller and
BACstat II:
Heating There are five possible states for the Heating field: OFF, ON,
Stage 1 Heating, Stage 2 Heating, and Stage 3 Heating. If the value of the
Heating field is OFF, no icon will appear. If the value of the Heating field is
ON, the Heating icon (Flame) will appear. If the value of the Heating field is
‘Stage 1 Heating’, the Heating icon with one bar from the Bar icon (smallest
one) will appear. If the value of the Heating field is ‘Stage 2 Heating’, the
Heating icon with two bars from the Bar icon (two smallest ones) will appear.
If the value of the Heating field is ‘Stage 3 Heating’, the Heating icon with all
three bars in the Bar icon will appear.
Note: The bar icon for Heating appears directly beside the Heating icon.
Cooling There are five possible states for the Cooling field: OFF, ON,
Stage 1 Cooling, Stage 2 Cooling, and Stage 3 Cooling. If the value of the
Cooling field is OFF, no icon will appear. If the value of the Cooling field is
ON, the Cooling icon (Snowflake) will appear. If the value of the Cooling
field is ‘Stage 1 Cooling’, the Cooling icon with one bar from the Bar icon
(smallest one) will appear. If the value of the Cooling field is ‘Stage 2
Cooling’, the Cooling icon with two bars from the Bar icon (two smallest
ones) will appear. If the value of the Cooling field is ‘Stage 3 Cooling’, the
Cooling icon with all three bars in the Bar icon will appear.
Note: The bar icon for Cooling appears directly beside the Cooling icon.
Fan There are five possible states for the Fan field: OFF, ON, Low,
Medium, and High. If the value of the Fan field is OFF, no fan icon will
appear. If the value of the Fan field is ON, the Fan icon will appear. If the
value of the fan field is ‘Low’, the fan icon with one bar from the Bar icon
(smallest one) will appear. If the value of the fan field is ‘Medium’, the fan
icon with two bars from the Bar icon (two smallest ones) will appear. If the
value of the fan field is ‘High’, the fan icon with all three bars in the Bar icon
bars will appear.
Note: The Bar icon for the fan appears directly beside the fan icon.
Humidity If the value of the Humidity field is ON, the Humidity icon will
be displayed. If the value of the Humidity icon is OFF, it will not be
displayed.
Occupancy There are three possible states for this field, DISABLED,
OCCUPIED, and UNOCCUPIED. If the value of the Occupancy field is
‘Disabled’, no icon will appear. If the value of the Occupancy field is
‘Occupied’, the Occupied icon will appear. If the value of the Occupancy
field is ‘Unoccupied’, the Unoccupied icon will appear.
Clear Clear has no icon. If the value of the Clear field is ON, then no icons
will be displayed in the LCD screen. If the value of the Clear field is OFF,
then any icons that have values indicating that they should be on will be ON.
Here is a description of the fields that only appear for a Room Controller:
Auto 1 If the value of the Auto 1 field is ON, the AUTO icon in the top left
corner of the LCD screen will be displayed. This AUTO icon is close to the
Heating and Cooling icons and is generally used to indicate automatic
operation of the Heating or Cooling systems. If the value of the Auto 1 field
is OFF, the AUTO icon is not displayed.
Auto 2 If the value of the Auto 2 field is ON, the AUTO icon on the right
of the LCD screen, under the text in line 2, will be displayed. This AUTO
icon is close to the Fan icon and is generally used to indicate automatic
operation of the Fan. If the value of the Auto 2 field is OFF, the AUTO icon
is not displayed.
Alarm Bell If the value of the Alarm Bell field is ON, the Alarm Bell icon
will be displayed. If the value of the Alarm Bell field is OFF, it will not be
displayed.
Network If the value of the Network field is ON, the Network icon will be
displayed. If the value of the Network field is OFF, it will not be displayed.
Here is a description of the fields that only appear for a BACstat II:
Sun/Moon If the value of the Sun/Moon field is Moon, the Moon icon will
be displayed. If the value of the Sun/Moon field is Sun, the Sun icon will be
displayed. If the value of the Sun/Moon field is None, neither the Sun nor the
Moon icons will be displayed.
Blink If the value of the Blink field is ON, the LCD will start to flash. If the
value of the Blink field is OFF, the LCD will not flash.
For a BACstat I, the only fields that are displayed are Blink and Clear.
Text
This section is only displayed for a BACstat II. The Text section of the Advanced
tab tells you what text is being displayed on the LCD screen. These fields are
read-only and can be controlled only through GCL and Illustrator. The following
is a description of the fields that appear in the Text section:
Line 1 Units The Line 1 Units field indicates if a unit icon is displayed for
Line 1 on the LCD. There are two possible values for this field: 0 or 1. If the value
of the Line 1 Units field is 0, no unit icons will be displayed. If the value of the
Line 1 Units field is 1, “°” will be displayed as the Line 1 units.
Line 2 Units The Line 2 Units field indicates if a unit icon is displayed for
Line 2 on the LCD. There are two possible values for this field: 0 or 1. If the value
of the Line 2 Units field is 0, no unit icons will be displayed. If the value of the
Line 2 Units field is 1, “°” will be displayed as the Line 2 units.
Line 3 Units The Line 3 Units field indicates if a unit icon is displayed for
Line 3 on the LCD. There are seven possible states for this field: 0-6. If the value
of the Line 3 Units field is 0, no unit icons will be displayed. The values 1-6
represent the following units: °, °C, °F, %, AM, and PM.
On The On field indicates if the On text is displayed on the LCD. If the value of
the On field is ON, the On text will be displayed. If the value of the On field is
OFF, it will not be displayed.
Off The Off field indicates if the Off text is displayed on the LCD. If the value
of the Off field is ON, the Off text will be displayed. If the value of the Off field is
OFF, it will not be displayed.
Time The Time field indicates if the Time text is displayed on the LCD. If the
value of the Time field is ON, the Time text will be displayed. If the value of the
Time field is OFF, it will not be displayed.
Set The Set field indicates if the Set text is displayed on the LCD. If the value
of the Set field is ON, the Set text will be displayed. If the value of the Set field is
OFF, it will not be displayed.
Calibrate The Calibrate field indicates if the Calibrate text is displayed on the
LCD. If the value of the Calibrate field is ON, the Calibrate text will be displayed.
If the value of the Calibrate field is OFF, it will not be displayed.
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character. The Description
field is used for notes about the LCD object.
GCL+ Properties
See Appendix E – Working with MS/TP and Linknet for more information on
accessing properties in the LCD object for a Linknet device using GCL+.
Property Value
This table describes some additional properties that can be used in GCL+
programming code.
Property Use
The KeySilent property of the LCD object is a built-in silence timer for the
keypad. If a key has not been pressed for the length of time specified in the
KeyInactive property (in seconds), then the KeySilent property is set to 0. As soon
as a key is pressed, the KeySilent property is set to a non-zero value.
Property Use
The keypad has a built-in silence timer which works for both the room controller
LCD and BACstats in ORCAview 3.22 and 3.30. This property can be used to
change the display after a period of keypad inactivity.
This sample code uses the .KeyInactive and .KeySilent properties and writes Keys
Silent to line 3 if there has not been a keypad entry for more than 10 seconds:
If Lcd.KeyPress = 1 then
Lcd.Line3 = “Key 1”
Lcd.KeyInactive = 10 // Number of seconds to wait
Else if Lcd.KeyPress = 2 Then
Lcd.Line3 = “Key 2”
Lcd.KeyInactive = 10 // Number of seconds to wait
Endif
Lighting outputs are standard BACnet Binary Output (BO) objects. Inputs can be
BACnet objects such as Analog Input (AI), Binary Input (BI), Analog Variable
(AV), Binary Variable (BV), MultiState Inputs (MI), MultiState Variable (MV),
other Lighting Groups (LG) and Schedule (SCH).
Once outputs and inputs are configured, and algorithm options selected, the LG
performs all calculations, measurements, and output control with no GCL+. For
most lighting control applications, no GCL+ is required. However GCL+ can be
used to write customized algorithms to the LG.
Header
The header of the object dialog gives the user the object’s Value, Auto/Manual
Object Mode, Feedback of lighting outputs and what part of the algorithm is
currently controlling the LG.
Object Value
This area displays the current value of the LG object. This value does not
necessarily reflect the status of the lighting outputs in the LG, as lighting outputs
can be switched individually if desired. The value represents the last state that the
LG controlled the lighting outputs to.
Object Mode
Object Mode is used to manually override the LG by clicking on the hand icon,
and forcing it to a particular value.
Auto When in Auto, the Value is calculated based on the internal algorithm
which takes into account, options and inputs from the LG’s configuration, or
external control from a GCL+ program.
Manual In Manual mode, the operator may override the value for the LG.
When Manual mode is enabled by clicking the hand icon, a drop-down menu
opens. This menu is used to select a Manual value for the object.
The priority array on lighting outputs (BO) makes it possible for the output object
to have a present value that is different than the Manual value of the LG object.
When assigning object value manually, the following five options are available:
Current Priority
Current Priority displays the level that the outputs defined in the Lighting Output
list are being controlled. Possible priorities include: Default Value,
Schedule/Photocell/Light Switch, Manual Operator, Flick Warning, Lighting
Group and GCL+.
Default Value This priority indicates that each lighting output is being
controlled by an individual (software/hardware) light switch, and nothing else is
currently controlling the LG.
Flick Warning This priority indicates that the LG object is being in Flick
Warn state.
Lighting Group This priority indicates that the lighting outputs have been ON
due to Common Area Control.
GCL+ This priority generally indicates that the lighting outputs have been
turned ON by GCL+ code.
Feedback
The Feedback field indicates the feedback values of lighting outputs defined in the
Lighting Objects list. The feedback displays ON if any of the defined outputs are
ON, otherwise displays OFF. When N/A is displayed, it means that no outputs are
defined or feedback is not supported on those outputs. When Retrofit Relay
Control is enabled, N/A is always displayed.
The Description tab is provided for the user to give a description of the Lighting
Group. This is the standard BACnet description field and can be used for any
comments the user may have. The field can contain up to 2000 printable
characters and has no bearing on the execution of this object.
The Description field will often be used for a detailed functional definition. It may
include all relevant facts pertaining to the Lighting Group and what areas are
controlled. It may include all relevant facts pertaining to use, definitions,
configuration, setup, limitations, sensor location, warnings, etc.
Name
Name is a descriptive label given to this object. The name must be unique among
the objects located on the same controller, and is limited from 1 to 67 printable
characters.
Fault
Indicates the fault status of the LG object. In most cases, the value reflects the
fault status of the assigned inputs.
If the reliability is anything other than No Fault Detected, the LG object is in fault,
and a Fault status flag displays in upper right area of the dialog. The object also
displays a fault status in the Navigator object list.
Fault This value indicates that a fault has occurred within the LG object.
Trouble This value is part of the BACnet standard but Delta Controls does not
use it.
Unknown This value is part of the BACnet standard but Delta Controls does
not use it.
Not Available This value indicates that the input does not physically exist. All
virtual inputs report a Reliability of Not Available. This is a Delta Controls
Proprietary reliability code.
Linknet Offline This value indicates that the LINKnet device that an assigned
input is mapped to, is not online. This is a Delta Controls Proprietary reliability
code.
Missing CFG Object This value indicates that an input object such as an AI
or MI has an invalid configuration reference such as an AIC or MIC. Any
reference to a configuration object that does not exist in the database will report a
Reliability of Missing CFG Object. A blank reference is acceptable and the
Reliability field does not report it. This is a Delta Controls Proprietary reliability
code.
Unreliable Other This value is generally set when an internal error occurs
such as an invalid property value encountered during execution. For the LG object
only, Unreliable Other, is used to indicate errors in references that are not valid.
Start Type
The Start type field controls what happens to the Lighting Group Outputs when
the controller is reset by software or it comes back online after losing power.
Application Icon
HVAC
Access
Lighting
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7 - Security of the ORCAview Technical Reference
manual. Also, see the SUG/SUA objects.
The LG and the light switch inputs work as “last writers” to the lighting outputs.
For example, if the LG turns On, then all the defined outputs will turn On
regardless of the light switch values. After the LG turns the outputs On, if the light
switch is transitioned Off, then the corresponding output is turned Off (the other
outputs stay On).
When this checkbox is selected, many fields on the dialog are disabled. The
message “Not Available” is displayed in these fields. Also, “N/A” is always
displayed in the Feedback field for Retrofit Relay control.
The Start Type field on Setup tab is grayed out with a default value of “Relays
Recalculated” since no other options are supported for Retrofit Relay control.
Configuring Light Switch is not always necessary as users can leave this field
with default value of “*.*”. For example, a hardwired switch to control individual
light may not be physically wired to any of the inputs on the controller. In that
case, this field is usually left with default value.
Flick Warning
Flick Warning is used to let occupants know that the lights are about to
automatically turn off. In areas that are not regularly occupied, (e.g. a boardroom),
Flick Warning feature can be configured to quickly turn the lights Off, then On, to
warn occupants that the lights are scheduled to turn off in few minutes. In order to
prevent the lights from turning off during the state of Flick Warn, it is possible to
provide occupants a physical switch that can override the flick warn command. A
button on a BACstat/room controller would be a good example for that usage.
Flick Warning generally occurs when the LG object’s value transitions from ON
to OFF, but it does not occur under some types of control.
The following table indicates what can trigger the flick warning:
A typical application might be the parking lot lights at a supermarket. This setup
is useful for exterior lighting which should be On only when the photo sensor
detects insufficient light but Off during a portion of the night when the facility is
not open. In this case, Enable input may be a Schedule (SCH) object that stays ON
during facility hours. This approach adapts to seasonal effects where light level
may be sufficient before the scheduled operating time would normally turn lights
on. Programmable photocell delay timer and astronomical time offset are
available in order to have accurate transition of lighting outputs.
Occupancy Control
Occupancy Control uses an input such as a Schedule or Binary Input from an
occupancy sensor to control a Lighting Group (LG). Occupancy control does NOT
work with Astronomical/Photocell control.
Input
The Input field allows another object (local or remote) to control the LG object.
The dropdown contains a list of local SCH and BV objects. Click on an object in
the list to select it. If you click on the Filter button to the right of the field, the list
includes local SCH, BV, BI, BO, MI, and MV. Additionally, a local or remote
object reference can be manually typed into the editbox portion of the field.
Lights On Checkbox
The Lights On checkbox allows the referenced object to trigger the Lighting
Group On. When the Occupancy Control Input transitions to On, the LG turns On
if this box is checked. Otherwise, the LG stays at its current state. In most
situations where there are no user switches, both the Lights On and Lights Off
checkboxes are enabled.
Lights Off Checkbox
The Lights Off checkbox allows the referenced input object to trigger the LG Off.
When the Occupancy Control Input transitions to Off, the LG turns Off if this box
is checked. Otherwise, the LG stays at its current state. In situations where the
user turns the lights on by a local switch and a schedule or occupancy sensor turns
them off, Lights Off checkbox would be enabled and Lights On would be
disabled.
Note: During holidays, lights are not normally turned On or Off via the Schedule.
They are set in the system by using the Calendar object that is linked to the
Schedule object with no On times. For more information, see the Calendar (CAL)
Object in the ORCAview Technical Reference Manual, Chapter 10 Software
Object Reference.
Delay Time
The Delay Time field sets the amount of time after the referenced Occupancy
Input object transitions to Off before the referencing LG turns Off. The default
value is 0 minutes with a range of 0 to 240 minutes. The Time Delay does not
apply when the Occupancy Input transitions to On.
Daylight Control
Daylight Control is available in two modes: Astronomical and Photocell. With
3.40, the Enable field provides additional control with the Astronomical and
Photocell modes. The available Daylight Control options change depending on
whether the Astronomical Control checkbox is selected or a Photocell input is
defined on this tab. Daylight Control cannot work with Occupancy Control.
Enable (New 3.40)
The Enable field provides additional control when using the Daylight options for
Lighting. The dropdown contains a list of local SCH and BV objects. With the
filter button pressed, the list includes local SCH, BV, BI, BO, MI, and MV. The
value of the object entered here determines at which times the Lighting Group is
able to be turned On or Off with Daylight control measures (Photocell or
Astronomical control). When the field is empty, it is treated as On by default
which is displayed in the Value field.
Value (New 3.40)
This field indicates whether the Enable for Daylight Control is ON or OFF. If
object reference for Enable is not assigned, the value is always ON, otherwise this
field shows the value of the object assigned in the Enable field.
Astronomical/Photocell control does NOT take effect while the enable Value is
OFF.
To use the Astronomical function, the Set Latitude / Longitude for the location
must be entered within the Device (DEV) object. The Universal Time Coordinate
(UTC) Offset must be enabled with an accurate Offset calculation. The UTC
Offset should be set by entering the time as a manual offset in +/- minutes.
For example, a calculated sunset of 7:30pm and an offset entry of -30 minutes
would result in the LG turning On at 7:00pm.
Today’s On Time
Displays the calculated time factoring in the Offset that the Astronomical clock
will turn the LG On.
Lights Off Checkbox
Allows the LG to be commanded Off at sunrise plus or minus the Off Offset time.
For the sunset and sunrise times to be correct, the longitude, latitude, and UTC
offset within the Device (DEV) object must be correct for the location of the
controller.
Off Offset
Defines the time offset that adjusts when the LG turns Off at sunrise. The offset
can be a positive or negative number. The default offset is 0 minutes.
The Photocell mode is used to control the LG via light level or what is called
luminosity. This function turns a Lighting Group On and Off using analog or
binary inputs.
A user defined, photocell input reference object (BI, AI, MI, AV, BV, MV or BO)
measures the light level, in an area and then commands the LG On or Off. The
photocell input reference can be either a local or remote object.
Using analog or digital Photocell input, the LG can be activated after the user-
defined Time Delay for On and Off transitioning to prevent cycling.
The Lighting (LG) object has the ability to enhance Photocell control using an
Analog or Binary Input reference by combining it with Occupancy Input Control
using a Schedule (SCH) or Binary Variable (BV). See the Enhanced Daylight
Control with Enable Input topic. Both analog and digital Photocell have a user-
defined Time Delay for ON and OFF transitioning to prevent cycling.
The following section lists the different options that exist for binary and analog
photocell references:
Binary Photocell Reference
With a binary object acting as the Photocell reference, the value is either On or
Off. The LG object can be made to track either state or both On and Off as
enabled by the Lights On and Lights Off checkboxes.
Lights On Checkbox
This checkbox allows the photocell input reference to trigger the LG On after the
user-defined Time Delay,. When the input reference transitions to On, the LG
turns On if this box is checked. Otherwise, the LG stays at its current state.
Lights Off Checkbox
This checkbox allows the photocell input reference to trigger the LG Off after the
user-defined Time Delay,. When the input reference transitions to Off, the LG
turns Off if this box is checked. Otherwise, the LG stays at its current state.
Analog Photocell Reference
With an analog object acting as the input reference, the value may be based on
luminosity. The LG object can be made to follow either Lights On when
equal/below, Lights Off when equal /above, or both as enabled with the Lights On
and Lights Off checkboxes. The values entered become the relative threshold.
When an analog type object is selected from the Input dropdown field, then the
Lights On when equal/below and Lights On when equal/above fields appear.
Lights On Checkbox
This checkbox allows the input reference to trigger the LG On after the user-
defined Time Delay,. When the input reference value drops below or equal to the
value defined in the “Lights On when equal/below” editbox, the LG turns On if
this box is checked. Otherwise, the LG stays at its current state.
Lights Off Checkbox
This checkbox allows the input reference to trigger the LG Off after the user-
defined Time Delay,. When the input reference value rises above or equal to the
value defined in the “Lights Off when equal/above” editbox, the LG turns Off if
this box is checked. Otherwise, the LG stays at its current state.
Lights On when equal/below
This field defines the analog value from the input reference that turns the LG On.
The default value is 2 with a range of 0 to 65534. The LG is On when the value
from the input is less than or equal to the value defined in the Lights On when
equal/below field. The value in this field must be less than or equal to the value
defined in the Lights Off when equal/above field.
Lights Off when equal/above
This field defines the analog value from the input reference that turns the LG Off.
The default value is 5 with a range of 0 to 65533. The LG is Off when the value
from the input is greater than or equal to the value defined in the Lights Off when
equal/above field. The value in this field must be greater than or equal to the value
defined in the Lights On when equal/below field.
This list defines other LG objects that depend on the current LG object to remain
On while any of them are On. The current LG object is the common area which is
shared by all the other LG’s. When at least one of the defined LG objects is On,
the current LG object will also be On. Once all the defined LG objects turn off the
current LG object will wait for the Exit Delay time before resuming its controller
(or turning off). An LG object cannot reference itself.
Note: A different LG dialog needs to be used for 333 R1 and older devices (3.33).
If an LG object in a controller has a build LESS than Build 95565, then the older
dialog (vn8v3lg_r1.dlg) will be used. Anything equal to or higher than Build
95565 will use the newer one (regular vn8v3lg.dlg).
The Lighting Group (LG) object is used to configure and control the lighting
outputs for a single lighting zone. Various inputs can be linked to the LG to
perform different control strategies such as: assigning switches to relays, timed
override, scheduling, astronomical clock, On/Off, photocell, flick warning,
common areas, and nested lighting zones.
Once outputs and inputs are configured, and algorithm options selected, the LG
performs all calculations, measurements, and output control with no GCL+. For
most lighting control applications, no GCL+ is required. However GCL+ can be
used to write customized algorithms to the LG.
Note: The LG is only available in DLC Lighting Controllers that have the 16
Megabit Flash. Some functionality of the LG such as Flick Warning is only
available in DLC controllers and not DSC or ASM.
Header
The header of the object dialog gives the user the Value, Auto/Manual Object
Mode, and what part of the algorithm is currently controlling the LG.
Object Value
This area displays the current value of the LG object. This does not necessarily
reflect the status of the lighting outputs in the LG, as lighting outputs can be
switched individually if desired. It shows the last state the LG controlled the
lighting outputs to. Possible values are as follows:
Object Mode
Object Mode is can be used to manually override the LG by clicking on the hand
icon, and forcing it to a particular value.
Auto When in Auto, the Value is calculated based on the internal algorithm
which takes into account, options and inputs from the LG’s configuration, or
external control from a GCL+ program.
Manual In Manual mode the operator may override the value for the LG. When
Manual mode is enabled, by clicking the hand icon, a drop-down menu opens.
This menu is used to select a Manual analog value for the object.
Due to the priority array, it is possible for the object to have a present value that is
different than the Manual value. In Manual Mode, the object displays four
override states.
Current Priority
Current Priority displays the level at which the output is being controlled.
When the object is put into Manual Mode, and set to a value, the header displays
Manual Operator, until the object is released back to Auto Mode.
The Description tab is provided for the user to give a description of the Lighting
Group. This is the standard BACnet description field and can be used for any
comments the user may have. The field can contain up to 2000 printable
characters and has no bearing on the execution of this object.
The Description field will often be used for a detailed functional definition. It may
include all relevant facts pertaining to the Lighting Group and what areas are
controlled. It may include all relevant facts pertaining to use, definitions,
configuration, setup, limitations, sensor location, warnings, etc.
Name
Name is a descriptive label given to this object. The name must be unique among
the objects located on the same controller, and is limited from 1 to 67 printable
characters. Typically, a name is less than 20 characters in length.
Fault
Indicates the fault status of the LG object. In most cases, the value reflects the
fault status of the assigned inputs.
If the reliability is anything other than No Fault Detected, the object is in fault,
and a Fault status flag displays in upper right area of the dialog. The object also
displays a fault status in the Navigator object list.
Fault This value indicates that a fault has occurred within the LG object.
Trouble This value is part of the BACnet standard but Delta Controls does not
use it.
Unknown This value is part of the BACnet standard but Delta Controls does
not use it.
Unreliable Other This value is generally set when an internal error occurs
such as an invalid property value encountered during execution. For the LG object
only, Unreliable Other, is used to indicate errors in references that are not valid
Open Loop / Shorted Loop Open Loop indicates that an assigned input is
not connected. Shorted Loop indicates that an assigned input is shorted.
Over Range / Under Range Over Range indicates that an assigned input
exceeds its assigned range. Under Range indicates that an assigned input is under
its assigned range.
Application Icon
HVAC (red)
Access (blue)
Lighting (green)
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7 - Security of the ORCAview Technical Reference
manual. Also, see the SUG/SUA objects.
The I/O definition tab is used to define which lighting outputs or groups are being
controlled and how they are being controlled.
Lighting Outputs
This function links outputs and/or lighting groups to the LG. It also assigns a
specific switch input (digital or multistate) to each output or group.
Light Switch This column contains the reference to the local / remote BV, BI,
MI or MV object that switches the lighting output. The LG normally controls
many outputs, but it can also be set to control one output. A Light Switch
reference assigns an object that can transition a single lighting output On or Off.
The LG and the light switch work as “last writers” to the lighting outputs. If the
LG turns On, then all the defined outputs turn On regardless of the light switch
values. After the LG turns the outputs On, if the light switch is transitioned Off,
then the corresponding output is commanded Off and the other outputs stay On.
Group Control
Group Control allows whole Lighting Groups to be turned On or Off efficiently.
Group Control is used for common areas, so lights stay on when nested Lighting
Groups are on. This function turns the LG On or Off when all nested groups turn
On or Off, following OR logic. For example, it allows the lights in a common area
such as a hallway to remain On if any of the listed Lighting Groups are On.
If a Schedule or Photocell turns the group On, then the group remains the highest
level of control.
Off Time Delay The amount of time after the referenced Lighting Group (LG)
transitions from On to Off before the referencing Lighting Group is relinquished.
The default is 10 minutes with a range of 0 to 240 minutes.
Lighting Groups When the referenced Lighting Group is On, the referencing
LG is On. When the referenced LG transitions from On to Off, the referencing LG
is relinquished and the logic in the Lighting Group resumes control. An LG object
cannot reference itself.
This list defines other LG objects that depend on the current LG object to remain
On while any of them are On. The current LG object is the common area which is
shared by all the other LG’s. When at least one of the defined LG objects is On,
the current LG object will also be On. Once all the defined LG objects turn off the
current LG object will wait for the Exit Delay time before resuming its control (or
turning off). An LG object cannot reference itself.
The Configuration tab contains a variety of sections and fields used to configure
the LG object.
Override
The Override function is used to command the LG On, for a set amount of time,
and then to command it Off by relinquishing control of the override. Override
references can be local and remote BI, BV, SCH, MI or MV objects.
Input Specifies the object that will override the LG from Off to On for the
Override Time. The override is triggered when the override input transitions from
to On.
Time Specifies the time that an object can override the LG. When the time
expires, it relinquishes the LG and returns to its given logical state. The default
value is 120 minutes, and is adjustable from 1 to 240 minutes.
Schedule
The Schedule function is used to control the LG according to a set schedule.
Lighting Groups can be scheduled to turn lights Off in the morning and/or On at
night for areas when building is occupied, and Off outside of normal business
hours. The Schedule function can also be used to command the LG On and Off
when triggered by a motion detector, for rooms that are often unoccupied.
Schedule Input Specifies the Schedule (SCH) object that will control the LG
object. The Lights On and Lights Off set the LG to trigger.
Lights On This checkbox sets the Schedule to trigger the LG On Only, Off
Only, On and Off or neither Off or On
Lights Off This checkbox sets the Schedule to trigger the LG On Only, Off
Only, On and Off or neither Off or On
Note: During holidays lights are not normally turned On or Off via the Schedule.
They are set in the system by using the Calendar object that is linked to the
schedule object with no On times. For more information read about the Calendar
(CAL) Object in the ORCAview Technical Reference Manual, Chapter 10
Software Object Reference.
Astro (Astronomical)
The Astronomical mode uses calculated Astronomical times to turn the LG On
and Off. Astronomical Control is used to enable calculation to choose whether the
lights are turned Off at sunrise (Lights Off), and/or if the lights are turned On at
sunset (Lights On). Based on controller location (latitude / longitude) and UTC,
the On time is calculated by sunset minus an offset, (i.e. dusk or night-time). The
Off time is calculated by sunrise plus an offset, (i.e. dawn or morning).
To use the Astro function, Set Latitude / Longitude for the location must be
calculated within the Device (DEV) object. The Universal Time Coordinate
(UTC) Offset must be enabled with an accurate Offset calculation. The UTC
Offset should be set by time zone list, or by entering the time as a manual offset in
+/- minutes.
On Offset Defines the time offset that adjusts when the LG turns On at sunset.
The offset can be a positive or negative number.
Lights Off Allows the LG to be commanded Off at sunrise plus or minus the
Off Offset time. For the sunset and sunrise times to be correct, the longitude,
latitude, Daylight Savings Time, and UTC offset in the DEV object must be
correct for the location of the controller.
Off Offset Defines the time offset that adjusts when the LG turns Off at
sunrise. The offset can be a positive or negative number.
Today’s On Time Displays the calculated time factoring in the offset that the
astronomical clock will turn the LG On.
Today’s Off Time Displays the calculated time factoring in the offset that the
astronomical clock will turn the LG Off.
Photocell
Photocell is used to control the LG via light level or what is called luminosity.
This function turns a Lighting Group On and Off using analog or binary input
objects.
A user defined, Photocell Input reference object (BI, AI, AV, BV or BO)
measures the light level, in an area and then commands the LG On or Off. The
Photocell Input reference can be either a local or remote object.
With a binary object as the input reference, the value is either On or Off. The LG
object can be made to track either state or both, as enabled by the Lights On and
Lights Off checkboxes.
With an analog object as the input reference, the value may be based on
luminosity. The LG object can be made to follow either Lights On when
equal/below or Lights Off when equal/above or both, as enabled by the Lights On
and Lights Off checkboxes. The values entered become the relative threshold.
Input Allows the user to reference a binary (BI, BV, MI, MV) or analog (AI,
AV) input reference.
The drop-down menu contains a list of local BI and BV objects. Click an object in
the list to select it. If you click the Filter button to the right of the field, the list
includes BV, BI, BO, MI, and SCH.
If an analog object is entered, then the Lights On and Lights Off threshold values
must be entered to define when the LG is commanded ON or OFF.
Lights On when equal / below This field defines the analog value from the
photocell input reference that turns the LG On. The default value is 2 with a range
of 0 to 65534. The LG is On when the value from the input is less than or equal to
this value. The value in this field must be less than or equal to the value defined in
the Lights Off when equal/above field.
Lights Off Specifies whether the object referenced in the Photocell Input
triggers the LG Off.
Lights Off when equal / above This field defines the analog value from the
Photocell input reference that turns the LG Off. The default value is 5 with a range
of 0 to 65534. The LG is Off when the value from the input is greater than or
equal to this value. The value in this field must be greater than or equal to the
value defined in the Lights On when equal/below field.
Flick Warning
Flick Warning lets occupants know that the lights are going to automatically turn
Off soon. In areas that are not regularly occupied, such as a boardroom, or areas
that are controlled by a Photocell (light level) such as an atrium, a Flick Warning
briefly turns the lights Off, then On, to warn occupants that the lights are
scheduled to turn Off. At that point, occupants can override the command by
pressing a button on the local BACstat or room controller.
Enable When Enable is selected, the lights flick off briefly, and then On, a
specified number of minutes before the lights are going to turn Off.
Time This field sets the amount of time, after the Flick Warning is initiated, that
the lights remain On before turning Off. The default value is 5 minutes, and is
adjustable from 1 to 240 minutes.
Note: A different LG dialog needs to be used for 333 R1 and older devices (3.33).
If an LG object in a controller has a build LESS than Build 95565, then the older
dialog (vn8v3lg_r1.dlg) will be used. Anything equal to or higher than Build
95565 will use the newer one (regular vn8v3lg.dlg).
The Lighting Group (LG) object is used to configure and control the lighting
outputs for a single lighting zone. Various inputs can be linked to the LG to
perform different control strategies such as: assigning switches to relays, timed
override, scheduling, astronomical clock, On/Off, photocell, flick warning,
common areas, and nested lighting zones.
Lighting outputs are standard BACnet Binary Output (BO) objects. Inputs can be
BACnet objects such as Analog Input (AI), Binary Input (BI), Analog Variable
(AV), Binary Variable (BV), MultiState Inputs (MI), MultiState Variable (MV),
other Lighting Groups (LG) and Schedule (SCH).
Once outputs and inputs are configured, and algorithm options selected, the LG
performs all calculations, measurements, and output control with no GCL+. For
most lighting control applications, no GCL+ is required. However GCL+ can be
used to write customized algorithms to the LG.
Note: The LG is only available in DLC Lighting Controllers that have the 16
Megabit Flash. Some functionality of the LG such as Flick Warning is only
available in DLC controllers and not DSC or ASM.
Header
The header of the object dialog gives the user the Value, Auto/Manual Object
Mode, Feedback and what part of the algorithm is currently controlling the LG.
Object Value
This area displays the current value of the LG object. This value does not
necessarily reflect the status of the lighting outputs in the LG, as lighting outputs
can be switched individually if desired. The value represents the last state that the
LG controlled the lighting outputs to. Possible values are as follows:
Object Mode
Object Mode is used to manually override the LG by clicking on the hand icon,
and forcing it to a particular value.
Auto When in Auto, the Value is calculated based on the internal algorithm
which takes into account, options and inputs from the LG’s configuration, or
external control from a GCL+ program.
Manual In Manual mode, the operator may override the value for the LG.
When Manual mode is enabled, by clicking the hand icon, a drop-down menu
opens. This menu is used to select a Manual analog value for the object.
Due to the priority array, it is possible for the object to have a present value that is
different than the Manual value. In Manual Mode, the object displays five
override states.
Current Priority
Current Priority displays the level that the outputs defined in the Lighting Output
list are being controlled. Possible priorities include: Default Value,
Schedule/Photocell/Light Switch, Manual Operator, Flick Warning and Lighting
Group.
When the LG object is put into Manual Mode and set to a state, Current Priority
displays Manual Operator, until the object is released back to Auto Mode.
Feedback
The Feedback field indicates whether outputs defined in the Lighting Objects list
are On or Off. The feedback displays On if any of the defined outputs are On or
Off if all the defined outputs are Off. In some situations, it may display N/A
which means that no outputs are defined or feedback is not supported on those
outputs.
The Description tab is provided for the user to give a description of the Lighting
Group. This is the standard BACnet description field and can be used for any
comments the user may have. The field can contain up to 2000 printable
characters and has no bearing on the execution of this object.
The Description field will often be used for a detailed functional definition. It may
include all relevant facts pertaining to the Lighting Group and what areas are
controlled. It may include all relevant facts pertaining to use, definitions,
configuration, setup, limitations, sensor location, warnings, etc.
Name
Name is a descriptive label given to this object. The name must be unique among
the objects located on the same controller, and is limited from 1 to 67 printable
characters.
Fault
Indicates the fault status of the LG object. In most cases, the value reflects the
fault status of the assigned inputs.
If the reliability is anything other than No Fault Detected, the object is in fault,
and a Fault status flag displays in upper right area of the dialog. The object also
displays a fault status in the Navigator object list.
Fault This value indicates that a fault has occurred within the LG object.
Trouble This value is part of the BACnet standard but Delta Controls does not
use it.
Unknown This value is part of the BACnet standard but Delta Controls does
not use it.
Unreliable Other This value is generally set when an internal error occurs
such as an invalid property value encountered during execution. For the LG object
only, Unreliable Other is used to indicate errors in references that are not valid.
Application Icon
HVAC
Access
Lighting
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7 - Security of the ORCAview Technical Reference
manual. Also, see the SUG/SUA objects.
The LG and the light switch inputs work as “last writers” to the lighting outputs.
For example, if the LG turns On, then all the defined outputs will turn On
regardless of the light switch values. After the LG turns the outputs On, if the light
switch is transitioned Off, then the corresponding output is turned Off (the other
outputs stay On).
When this checkbox is selected, many fields on the dialog are disabled. The
message “***Not supported on retrofit***” is displayed in these fields.
Lighting Outputs
This column contains the Lighting Output reference to local Binary Output (BO)
or other local / remote Lighting Group (LG) objects that are part of the group. The
BO or LG objects are controlled by the logic defined in the LG. An LG object
cannot reference itself.
Light Switch
This column contains the reference to the local / remote BI, BV, MI or MV object
that is assigned to the individual lighting output. A light switch reference assigns
an object that can transition a single lighting output On or Off. A light switch
input provides an override to control some of the lights within a lighting group.
Flick Warning
Flick Warning lets occupants know that the lights are going to automatically turn
off. In areas that are not regularly occupied, (e.g. a boardroom), a Flick Warning
quickly turns the lights Off, then On, to warn occupants that the lights are
scheduled to turn off. At that point occupants can override the command by
pressing a button on the local BACstat or a room controller.
Enable Checkbox (Flick Warning)
This field enables the Flick Warning feature which tells the occupants of an area
when the lights are going to turn Off. When Enabled is selected, the lights flick
off briefly, and then on again, a specified number of minutes before the lights are
going to turn off. The amount of advance warning is specified by the Flick
Warning Time.
Time (Flick Warning)
This field sets the amount of time, after the Flick Warning is initiated, that the
lights remain On before turning Off. The default value is 5 minutes, and is
adjustable from 1 to 240 minutes.
First Output Only Checkbox
This checkbox restricts the flick warning to the first lighting output in the group.
Due to the staggering of the output transitions, large areas with many outputs
would only require a single circuit to toggle as a visual indication that the lights
will shortly be turning Off. In hallways where all areas may not be able to see the
visual cue, the checkbox should be disabled so all lights in the group will flick
warn.
A typical application might be the parking lot lights at a supermarket. This setup
is useful for exterior lighting which should be On only when the photo sensor
detects insufficient light but Off during a portion of the night when the facility is
not open. This approach adapts to seasonal effects where light level may be
sufficient before the scheduled operating time would normally turn lights on.
Schedule transitions do not have any delay but photocell transitions include the
built-in delay time.
Occupancy Control
Occupancy Control uses an input such as a Schedule or Binary Input from an
occupancy sensor to control a Lighting Group (LG).
Input
The Input field allows another object (local or remote) to control the LG object.
The dropdown contains a list of local SCH and BV objects. Click on an object in
the list to select it. If you click on the Filter button to the right of the field, the list
includes local SCH, BV, BI, BO, MI, and MV. Additionally, a local or remote
object reference can be manually typed into the edit box portion of the field.
Lights On Checkbox
The Lights On checkbox allows the referenced object to trigger the Lighting
Group On. When the referenced object transitions to On, the LG turns On if this
box is checked. Otherwise, the LG stays at its current state. In most situations
where there are no user switches, both the Lights On and Lights Off checkboxes
are enabled.
Lights Off Checkbox
The Lights Off checkbox allows the referenced input object to trigger the LG Off.
When the referenced object transitions to Off, the LG turns Off if this box is
checked. Otherwise, the LG stays at its current state. In situations where the user
turns the lights on by a local switch and a schedule or occupancy sensor turns
them off, Lights Off checkbox would be enabled and Lights On would be left
disabled.
Note: During holidays lights are not normally turned On or Off via the Schedule.
They are set in the system by using the Calendar object that is linked to the
Schedule object with no On times. For more information read about the Calendar
(CAL) Object in the ORCAview Technical Reference Manual, Chapter 10
Software Object Reference.
Delay Time
The Delay Time field sets the amount of time after the referenced Input object
transitions to Off before the referencing LG turns Off. The default value is 0
minutes with a range of 0 to 240 minutes. The Time Delay does not apply when
the Input object transitions to On.
The Sweep Off every field specifies how often to turn Off any outputs that may
have been overridden by a switch input. For instance, someone could override an
output after the referenced Input object turned Off. Defining a time here would
cause an override to be cleared at the set interval from the time the Input object
turns Off. The default value is 0 minutes with a range of 0 to 480 minutes.
To use the Astronomical function, the Set Latitude / Longitude for the location
must be entered within the Device (DEV) object. The Universal Time Coordinate
(UTC) Offset must be enabled with an accurate Offset calculation. The UTC
Offset should be set by entering the time as a manual offset in +/- minutes.
Astronomical Control Checkbox
With the Astronomical Control Checkbox selected, additional Offset and Today’s
Time fields display on the dialog when the Lights On or Lights Off checkboxes
are selected. The Photocell option is disabled when this checkbox is selected.
Lights On Checkbox
Allows the LG to be commanded On at sunset plus or minus the On Offset time.
For the sunset and sunrise times to be correct, the longitude, latitude, and UTC
offset within the Device (DEV) object must be correct for the location of the
controller.
On Offset
Defines the time offset that adjusts when the LG come On at sunset. The offset
can be a positive or negative number. The default offset is -30 minutes.
For example, a calculated sunset of 7:30pm and an offset entry of -30 minutes
would result in the LG turning On at 7:00pm.
Today’s On Time
Displays the calculated time factoring in the Offset that the Astronomical clock
will turn the LG On.
Lights Off Checkbox
Allows the LG to be commanded Off at sunrise plus or minus the Off Offset time.
For the sunset and sunrise times to be correct, the longitude, latitude, and UTC
offset within the Device (DEV) object must be correct for the location of the
controller.
Off Offset
Defines the time offset that adjusts when the LG turns Off at sunrise. The offset
can be a positive or negative number. The default offset is 30 minutes.
The Photocell mode is used to control the LG via light level or what is called
luminosity. This function turns a Lighting Group On and Off using analog or
binary inputs.
A user defined photocell input reference object (BI, AI, MI, AV, BV, MV or BO)
measures the light level in an area, and then commands the LG On or Off. The
photocell input reference can be either a local or remote object.
Using analog or digital Photocell input activates a 5 minute deadband for On and
Off transitioning to prevent cycling.
With 3.33R2, The Lighting (LG) object has the ability to enhance Photocell
control using an Analog or Binary Input reference by combining it with
Occupancy Input Control using a Schedule (SCH) or Binary Variable (BV). See
the Enhanced Photocell Control with Schedule as Occupancy Input topic.
Lights On Checkbox
This checkbox allows the input reference to trigger the LG On. When the input
reference transitions to On, the LG turns On if this box is checked. Otherwise, the
LG stays at its current state.
Lights Off Checkbox
This checkbox allows the input reference to trigger the LG Off. When the input
reference transitions to Off, the LG turns Off if this box is checked. Otherwise, the
LG stays at its current state.
Analog Photocell Reference
With an analog object acting as the input reference, the value may be based on
luminosity. The LG object can be made to follow either Lights On when
equal/below, Lights Off when equal /above, or both as enabled with the Lights On
and Lights Off checkboxes. The values entered become the relative threshold.
When an analog type object is selected from the Input dropdown field, then the
Lights On when equal/below and Lights On when equal/above fields appear. Both
analog and digital Photocell have a 5 minute for On and Off transitioning to
prevent cycling.
Lights On Checkbox
This checkbox allows the input reference to trigger the LG On. When the input
reference value drops below or equal to the value defined in the “Lights On when
equal/below” editbox, the LG turns On if this box is checked. Otherwise, the LG
stays at its current state.
Lights Off Checkbox
This checkbox allows the input reference to trigger the LG Off. When the input
reference value rises above or equal to the value defined in the “Lights Off when
equal/above” editbox, the LG turns Off if this box is checked. Otherwise, the LG
stays at its current state.
Lights On when equal/below
This field defines the analog value from the input reference that turns the LG On.
The default value is 2 with a range of 0 to 65534. The LG is On when the value
from the input is less than or equal to the value defined in the Lights On when
equal/below field. The value in this field must be less than or equal to the value
defined in the Lights Off when equal/above field.
Lights Off when equal/above
This field defines the analog value from the input reference that turns the LG Off.
The default value is 5 with a range of 0 to 65534. The LG is Off when the value
from the input is greater than or equal to the value defined in the Lights Off when
equal/above field. The value in this field must be greater than or equal to the value
defined in the Lights On when equal/below field.
Exit Delay
The amount of time after all defined Lighting Groups in the list have turned Off
before the LG is turned Off. The default is 10 minutes with a range of 0 to 240
minutes.
Lighting Group
This function leaves the common area lights on when at least one of the defined
Lighting Groups is On. When all the defined Lighting groups are Off, then this
Lighting Group waits the Exit Delay time and then turns off the lights in the
common area.
When the referenced Lighting Group is On, the referencing LG is On. When the
LG transitions from On to Off, the referencing LG is relinquished and the logic in
the Lighting Group resumes control. An LG object cannot reference itself.
This list defines other LG objects that depend on the current LG object to remain
On while any of them are On. The current LG object is the common area which is
shared by all the other LG’s. When at least one of the defined LG objects is On,
the current LG object will also be On. Once all the defined LG objects turn off the
current LG object will wait for the Exit Delay time before resuming its controller
(or turning off). An LG object cannot reference itself.
LINKNET (LNK)
The purpose of the LINKnet Object (LNK) is to physically determine if a
LINKnet device is online. A new LINKnet (LNK) object is automatically created
in the controller database for each LINKnet device on the network. The LINKnet
object shows if the LINKnet device is online, offline or lost. Alarms can be linked
to the object to monitor the status of the device.
Header
The header area contains the object icon, and the LINKnet status.
LINKnet Status
This read-only field displays the status of the LINKnet device. The 3 states are:
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition. It may
include all relevant facts pertaining to use, configuration, setup, calibration,
wiring, limitations, sensor location, warnings, etc.
For example:
LINKnet device status = Lost due to tenant retrofit relocating of LINKnet sensors.
Should be back online by Sept 10, 2011. Dale P.
Setup
The Setup tab contains information about the LINKnet device.
Name
This read-only field displays the name of the LINKnet device. Name is used to
describe the LINKnet object. It is a descriptive label given to the object.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Product
This tab contains information about the hardware and software on a LINKnet
device.
The Application SW Version is the major software version while the Firmware
Version is the minor version/build number.
Model Name
This read-only field displays the model of the LINKnet device.
Firmware Version
This read-only field shows the build number of the firmware in the associated
LINKnet device.
Hardware Version
This read-only field displays the Hardware Version of the LINKnet device. This
allows you to check the version of the hardware without having to go to the
device.
Application SW Version
This read-only field displays the version of the software of the LINKnet device.
For LINKnet devices, the major software version is not really relevant and does
not change much as compatibility is maintained between both major and minor
revisions.
For the DAC products, the Application SW Version field is much more relevant to
the user. While minor build numbers reflected in the Firmware Version field are
compatible, the major SW versions are not.
Protocol Version
This read only field represents the major version number of the Linknet protocol
that is implemented by the LINKnet device controller. Higher numbers indicate
newer implementations.
As of June 2011, the current version is 3. Version 3 and all previous versions are
compatible so different versions can co-exist on the same network.
Input Count
This field shows the physical input count of all inputs on the LINKnet device. For
example, the Access Door Module (ADM) has 16 inputs.
Output Count
This field shows the physical output count of all outputs on the LINKnet device.
For example, the ADM has 9 outputs.
Variable Count
This read-only field displays the number of variables available on the LINKnet
device. These variables are stored in the EEPROM and cannot be created or
deleted.
Reset Count
This field shows the total number of Reset counts for the LINKnet device. This
field is not supported on some LINKnet devices but NEC devices like the
DFM1616 support this feature.
The Load Shed object defines a list of electrical loads that can be shed by the
BACnet device and a means to specify when, for how long and to what level these
loads should be shed. In this way, it allows external control of a device’s loads.
While the Load Shed object can operate in an independent manner, it is more
likely that it will be used as part of a hierarchy of load shed objects and systems to
provide an integrated load control system. Such a coordinated system is best
designed as part of the site’s initial engineering.
In a coordinated load control system, the Load Shed object provides the basic
means to control loads and so forms the lower level of the system. Higher-level
components would include a load manager, with load policies & cost structure
knowledge to make load shed decisions and power measurement devices to
provide feedback to the load manager. The system determines how shedding is
shared across the participating devices and informs each device of its assigned
role and monitor the results.
Theory of Operation
Header
Load Shed
Request
(External or GCL)
Controlled
Objects
(Defined manually)
The Load Shed object consists of a list of outputs that can be shed (the Controlled
Objects list), a means to define when the loads will be shed (the Load Shed
Request) and a status indicating if the loads are being shed.
Before a load shed can occur, the list of controlled objects must be defined. This is
done manually during object setup. The Controlled Objects are the outputs (BO
etc.) that are turned Off, in response to a request for the controller to reduce its
electrical load. Each output can be assigned to one of five Shed Levels which
defines its priority in relation to the Load Shed request. The lower the priority, the
more likely the output is to be turned Off. A level of 0 prevents the output from
ever being shed.
Once the controlled objects are defined, a load manager (automated or human) can
request the device to shed loads by sending it a Load Shed Request. The request
contains the parameters needed to initiate a load shed (Target Time, Duration and
Shed Level). The manager can then monitor the Load Shed object Status to
determine if the request has been met while also monitoring actual power
consumption. The request parameters may be adjusted as needed.
Header
The header displays the Object Mode and Shed State of the object.
Object Mode
The Load Shed (LS) object has two modes - Enabled or Disabled. You toggle
from one mode to the other by clicking on the hand icon.
Enabled The object sheds loads in response to load shed requests and displays
its operational status. A typical status is Inactive which indicates that
the object is waiting for a command.
Disabled The object is prevented from performing load control and ignores load
shed requests.
Shed State
The state of the Load Shed object is dependent on the operation of the object. The
state shows the transitions that occur as the Load Shed object completes a load
request. The object must be in the Enabled mode for the states to change.
As a Load Shed request is processed, the Load Shed object transitions through the
following Shed States:
3. Once Target Time occurs, the LS object tries to turn off all the Controlled
Objects whose Shed Level is less than or equal to the requested Shed Level. If
all the Controlled objects, that should have been shed, actually switched OFF
then the LS object enters the Compliant State. If any of the objects have
remained ON, then the LS enters the Non-Compliant state. The LS object
continues to monitor these outputs every minute until the Duration Time
expires.
4. Once the Duration has expired, the LS relinquishes the controlled objects
(allowing them to switch back on if still desired), resets the Duration and
Target Time, and returns to the Inactive state.
Inactive
Cancel
Complete or Cancel
Shed Request
Compliant or
Pending Target Non-compliant
Time met
Note: A Load Shed request is canceled by modifying either the Target Time or
Duration, so that the Target Time plus Duration is less than the current time. This
cancels the current load shed request and returns the object to the Inactive state.
Description
The Description tab is provided for the user to add descriptive comments. The
field can contain up to 2000 printable characters and has no bearing on the
execution of this object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 67 characters on a DAC.
The name must be unique among the objects located on the same controller.
Target Time
This is the time and date to begin the load shed. The shedding actually starts
several minutes early to ensure that the target time is met. A typical Target Time
might be 16:00:00 or four o’clock in the afternoon on a specific date.
The Target Time field consists of a checkbox and a time and date field.
Note: A Load Shed request can be cancelled by modifying either the Target Time
or Duration, so that the Target Time plus Duration is less than the current time.
This cancels the current load shed request and returns the object to the Inactive
state
Duration
This field defines the time in minutes that the load shedding continues from the
Target Time. For example, given a Target Time of 16:00:00 1-Sept-2005 and
Duration of 180 minutes, then the load will be shed from 16:00:00 to 19:00:00.
Shed Level
This field sets the level of load shedding required. Five levels of shedding are
defined and these correspond to the Shed Levels defined in the Controlled Objects
list. The default setting is No Shedding Required.
Controlled Objects
Defines the list of local outputs that this device may shed to meet a Load Shed
request and their relative importance within the overall Load Shed system.
Level
The requested Shed Level is compared to each output defined Level to determine
if this output load should be shed (turned off). Five levels are available with Level
1 indicating equipment that is most expendable and Level 5, indicating the least
expendable. The default setting for this field is “No Shedding Required” which
excludes a controlled object from the load shed scheme.
Kwh Usage
This column contains the power consumption associated with the equipment for a
controlled object. Click on the corresponding cell to enter a value for a particular
Controlled Object. This optional field is for information purposes only.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7 - Security of the ORCAview Technical Reference
manual. Also, see the SUG/SUA objects.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
MENU (MN) V3
The Menu (MN) object is the interface object between the controller, its objects
and the LCD Keypad. The Menu (MN) allows the user to edit the objects and
functions that the LCD Keypad user can access. The menu object also allows the
user to customize the appearance of the function label on the LCD Keypad.
The Menu object is required to support the LCD keypad. It allows the
organization and formatting of functions to be interfaced and displayed on the
LCD Keypad. The intent is to extend the ability to structure a series of menus. The
Room Controller is used to display and navigate the menu and to view values
specified in a System Display (SD) object.
The Menu object can reference SUA objects with the possibility of multiple
passwords starting different menu functions.
Header
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
descriptors located on the same controller.
Previous Menu
Provides the previous menu from which the current menu was called. This
property is needed as menus can be nested and it is necessary to return to the
calling (previous) menu after the current menu is exited.
Description
Description Field
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
Password Disable
Allows the user to either disable or enable the password function.
If the Password Disable checkbox is selected, then any keypress allows the user to
enter the menu. Since the user is not logged into a specific SUA and no starting
menu reference can be specified, then the starting menu defaults to MN1. The
inactivity timeout is set to 60 minutes as an SUA is not specified. The Menu
object can reference SUA objects with the possibility of multiple passwords
starting different menu functions.
If the Password Disable checkbox is deselected, then the user is prompted to enter
a password prior to entering the menu.
Scroll Delay
Define the delay in seconds before the next object in the System Display object is
displayed. This value is only used in the default display mode when a scrolling
system display is set as the default. The Scroll Delay range is 1-60 seconds with a
default value of 1 second.
Dataview
This Dataview allows the configuration of the LCD object by defining the Object
Name, Menu Function and Item Name fields for an entry.
Object Name
Object name is the type of object to be used by the Menu Function. E.g. Object
Name = SCH* with a Menu Function Display Object will display all Schedule
objects. Not all menu functions require Object Names.
Menu Function
Menu Function is the type of function that is performed when selected by the LCD
Keypad.
Item Name
Item name is an identifying title that appears on the LCD Keypad, and should
describe the Menu Function selected.
1. Double click on the white space immediately below the middle column called
“Menu Function”, and then select the desired function from the list.
2. Then enter the object type the function is to be applied to. Either individual
object instances or Wild card can be used e.g. BO1 or BO*.
Note: Some functions do not require an object reference. The following do not:
Set Time and Date, Display Device info, and Reset.
Common Header
Status
The Status drop-down dialog provides the following choices:
Disabled The object is not in use and MS/TP is used.
Note: In order for MicroNet to work, MS/TP must be disabled on the Setup tab of
the BACnet Protocol Settings (BCP) object. .
Addressing
Get Address
This field provides the system with the capability to obtain and display the address
of a single Zone Controller or a single Micro Controller when a single Zone
Controller or Micro Controller is connected to a BACnet DCU.
Get Address Button When this button is depressed, the address of the Zone
Controller or Micro Controller attached to the BACnet DCU is displayed in the
Present field in the Change Address section and also in the Address field in the
Get Address section. This button is only used when a single Zone Controller or
Micro Controller is attached to the BACnet DCU.
Address (Read Only) This read only field displays the address of the Zone
Controller or Micro Controller attached to the BACnet DCU when the Get
Address Button is pressed.
Change Address
This field provides the system with the capability to change the address of a single
Zone Controller or a single Micro Controller when multiple Zone Controllers or
Micro Controllers are connected to a BACnet DCU.
Set Address Button Enter the address of the controller that you want to
change in the Present Address field. Enter the desired address in the New Address
field.
When the Set Address button is clicked, the address of the Zone Controller or
Micro Controller in the Present field is changed to the address specified in the
New field.
New (Read Write) This field is used by the operator to set the new address of
the Zone Controller or Micro Controller connected to the BACnet DCU.
First Micro
This field, combined with the Last Micro field, provides the system with
the capacity to set and edit the range of addresses within which any Micro
Controllers connected to the BACnet DCU will reside.
The numbering is done in the format of the actual address of the Micro
Controller. If the Device (panel) is Number 900 and the address of the first
Micro is 1, then the entry in this field would be 901. The value is entered
using the ▲▼ buttons on the spin control or by entering the value directly.
Last Micro
This field, combined with the First Micro field, provides the system with
the capacity to set and edit the range of addresses within which any Micro
Controllers connected to the BACnet DCU will reside.
The numbering is done in the format of the actual address of the Micro
Controller. If the Device (panel) is Number 900 and the address of the last
Micro is 48 then the entry in this field would be 948. The value is entered
using the ▲▼ buttons on the spin control or by entering the value directly
Setup
Adapter
The Adapter field displays N/A (Not Apply).
Usage Type
This read only field displays the type of communications within the RS-485
network.
Connection Type
This read-only field displays Enabled.
Advanced
The Advanced tab fields do not display as they are not applicable to the DCU.
Description
The Description field will often be used for a detailed functional definition of the
Object.
The Remote Panel Settings (RPS) Object uses the settings in the MDS Object
when a modem connection is initiated.
With ORCAview 3.30, the Windows modem that comes with your PC or Laptop
can be used for the PC/OWS modem. ORCAview 3.30 now supports many more
brands of modems in comparison to previous versions of ORCAview. You no
longer need to use a terminal program to set the modem string.
US Robotics external 56 K modems, and earlier models 14.4K, 28.8K, 33.6K, are
the only ones supported by Delta Controls for use as a panel modem on a
controller (most Windows compatible modem can be used for the PC/OWS
modem). Compatible US Robotics modem models have DIP switches and operate
under the AT compatible command set.
Description
Setup
An MDS object on an OWS only has the Name field on the Setup tab. When the
MDS object is on a controller, the Setup tab has many fields which are configured
based on the Modem Type field selection.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Modem Type
The initialization string is defined for the modem based on the Modem Type
selection. Select your modem from the drop down list or chose Custom to enter a
user defined Modem initialization string. The choices from the drop-down are:
U.S. Robotics, USR Quick Connect Disabled, Zoom, Boca, and Custom. Based on
the selection, the initialization string uses standard settings for a particular type of
modem. The fields on the Setup tab are editable. If you select Custom, enter the
codes in the fields on the Setup tab. In most cases, you will select US Robotics as
the modem type.
Initialization
The string used when a modem is first connecting. For a Custom modem type,
enter the initialization string for the particular modem here. This string is sent to
the modem before the modem dials. Refer to your modem manual for more
details.
Hangup
This string is sent to the modem port before the modem port hangs up. Refer to
your modem manual for more details.
Reset
This string is sent to the modem port when the device is reset. Refer to your
modem manual for more details.
Dial Prefix
This string is sent to the modem port before the digits of the phone number. Refer
to your modem manual for more details.
Auto Answer
Determines behavior for an incoming call over a modem. This string sets the
modem to answer the phone after one ring.
Command Timeout
This is the time that the device waits for the modem to respond. The field accepts
a value from 0-10,000 seconds. The default time is 2 seconds. If the time is
exceeded, then an error message displays.
Header
The Header Flags are:
• IN_Alarm - Always false. This is used for intrinsic alarms.
• Fault - True if the Reliability property does not have a value of
NO_Fault_Detected.
• Overridden - True if the object has been overridden, false otherwise.
• OutOfService - This is used to put the MI object into the Manual Mode.
Value
The present value of the Multi-state Input object is displayed in this read-only
field. The value is calculated based on the sensor value and the Multi-state Input
Configuration (MIC) object that was selected for this input. The value is restricted
within the maximum and minimum values defined in the MIC object. The value is
used as the index to the Multi-state Input Configuration (MIC) State Text and
Voltage Range arrays to obtain the information about the device type.
For Delta devices, the Multi-state Input Configuration object defines the
relationship between the input voltage and how this voltage represents the process
variable.
Object Mode
As soon as the Manual mode of operation is enabled, a drop down box opens up to
the right of the Manual button. This drop down box is used to allow the operator
to choose an override state. The choices are from the MIC object that is specified
on the Sensor tab of this MV object.
Last State
This read-only field is the last count of the state of the MI object.
Sensor
This field is a drop-down list that allows you to select an existing MIC object. The
sensor must have been created previously as a Multi-state Input Configuration
(MIC) object. The MIC object should be created on the controller that the input is
connected to.
If the field is left blank, the voltage at the input is converted to a number from 0 to
100 corresponding to the 0 to 5 volts at the input.
Description
The Description field may contain a character string of 2000 characters in length.
The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the Input Object. It may include all relevant
facts pertaining to use, configuration, setup, calibration, wiring, limitations, sensor
location, warnings, etc. In general, any information useful in the installation and
maintenance of the Device could be included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
operators for the HVAC and Access applications. It is possible for each operator
to only see the objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Sensor Tab
Commissioned This is a check box which tells the operator whether or not the
Object has been field commissioned. This field affects Alarm generation: when
the object is De-Commissioned, Event objects that monitor this object will not
transition and no alarm notifications will be generated for that event.
Commissioned - When this box is checked, the Object is Commissioned and the
Lock Icon will be removed from the Header and from the display in Navigator.
Reliability Codes This is the read-only box beside the Commissioned check
box. This property provides an indication of whether the present value is reliable.
If any reliability other than NO_Fault_Detected is present, a Wrench Icon will
appear in the object header. This property is read only, and is set during object
execution when OutOfService is False. When OutOfService is True, the reliability
may be set by the operator.
This reliability codes field will have one of the following values at any given time:
• NO_Fault_Detected - This is the normal state for the input. Everything is
working from an object execution perspective.
• Over_Range - This is displayed when the physical input has returned an A to
D Value greater than the maximum VoltageRange value specified in the MIC
object.
• Under_Range - This is displayed when the physical input has returned an A to
D Value less than the minimum VoltageRange value specified in the MIC
object.
• No_Sensor - This is not used with this release.
• Open_Loop - This is displayed when the A to D Value is greater than (4095 -
Open_Short_Range (currently 12)) and the maximum VoltageRange value
defined in the MIC object.
• Shorted_Loop - This is displayed when the A to D Value is less than the
Open_Short_Range (currently 12) and the A to D Value is less than the
minimum VoltageRange value defined in the MIC object.
• Unreliable_Other - This is displayed when an internal error occurs, such as an
invalid property value encountered during execution.
• Rel_Not_Available - This is a Delta proprietary reliability code that indicates
that the input does not physically exist.
• Rel_LinkNet_Offline - This is a Delta proprietary reliability code that
indicates that the LinkNet device to which the input is mapped, is not online.
• Rel_Missing_CFG_Object - This is a Delta proprietary reliability code that
indicates that the MI has an invalid configuration reference.
• Multi_State_Fault - The present value of the Multi-State object is equal to
one of the defined Fault_Values but no physical fault has been detected with
the input or output that the Multi-State represents.
Sensor
The Sensor tab defines the behavior of the MI object's value and its operation.
Value from This field has three options: Configuration (MIC), GCL+ (PG) and
Stepping Function.
Configuration (MIC): The value of the MI object is directly translated from the A
to D Value field using the MIC (sensor type) into a certain state (i.e. Low, Med,
High) when the Configuration (MIC) option is selected in the Value From field.
This option translates a varying voltage input into discrete states.
GCL+ (PG): The value of the MI object is controlled from a Program when the
GCL+ (PG) option is selected in the Value From field. This option is not
commonly used, but could simulate a varying input using GCL for demonstration
or troubleshooting purposes.
Stepping Function: The value of the MI object steps through the states defined in
the MIC object, once per input pulse (Off to On to Off), starting at the first state
and wrapping around at the last state when the Stepping Function option is
selected in the Value From field. This option could cycle through different states
(i.e. for a light switch) using a momentary push button input.
Note: The Direct/Reverse Acting field is only used when the Stepping Function
option is selected in the Value From field. The Configuration (MIC) and GCL+
(PG) options do not use the Direct/Reverse Acting field.
Type For Delta equipment, sensor type offers a drop down selection list of the
Multi-state Input Configuration (MIC) objects that are available for assignment to
this Input. Upon selection, the scaling information is established for this Input.
If no assignment is made, the default is a blank field, but the MI acts like a binary
input.
Current State Value This is a read-only field. This value represents the
current value of the MI object in numerical form. The value is used as the index to
the Multi-state Input Configuration (MIC) State Text and Voltage Range arrays to
obtain the information about the device type.
Number of States This is a read-only field. This value represents the number
of states the MI can take on, as defined within the MIC to which it is linked. If no
MIC is present, then there will be 2 states for the ON/OFF default.
State Text This is an array of text values for the state. The string is limited to
128 characters. This is the value that will be displayed in the MI or MV for the
given state number. State 1 would be the first value entered in the array.
A to D Value
This field displays the current A to D value of the physical Multi-state Input. This
is a proprietary property for Delta Controls. The range of the A to D Value is 0 -
4095.
Stats
Current State
Value This is a read-only field. This value represents the current value of the
MI object in numerical form. The value is used as the index to the Multi-state
Input Configuration (MIC) State Text and Voltage Range arrays to obtain the
information about the device type.
Time of Last State Change This read-only field is the time of the last
change of state of the MI object.
Previous State
Value This is a read-only field. This value represents the previous value of the
MI object in numerical form. The value is used as the index to the Multi-state
Input Configuration (MIC) State Text and Voltage Range arrays to obtain the
information about the device type.
Change of State
Change of State Count This is a read-only field. It counts the number of
state changes of the MI, either when the object is in OutOfService or in manual. It
is the number of changes since the last object was reset.
Change State Count Reset Time This is a read-only field. It holds the time
and date that the last Change of State was reset.
Alarming (Intrinsic)
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Intrinsic Alarming tab starting on page 10–464provides a way to
configure basic alarm and event features within an object.
Intrinsic Alarming (see page 10–462) is available in the AO, AI, BO, BI and MI
objects. The Alarm Text tab starting on page 10–476 allows a message to be
specified for the Alarm, Fault, and Return to Normal transition messages.
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Number of States
This field denotes the number of states defined in the object. The default number
of states is 2. The following screen capture shows the default view of the setup
tab. Once you enter more states, the Number of States will increase. If you start to
delete states, the Number of States will decrease.
State Text
This column displays every state and its name. To change the name of a state,
double click on one of the states. To add another state, double click on a blank
space inside the list box.
Lower Voltage
This column defines the voltage that corresponds to a 0% input value for a state.
Upper Voltage
This column defines the voltage that corresponds to a 100% input value for a
state.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
For example, in security/access control, supervised inputs are used so we can use
the MI and MIC to define values of the input rather than using a number:
In some situations, you might want the voltage ranges in the MIC to overlap. For
example, State A could be from 0 to 2 volts and State B from 1 to 5 volts. When
the voltage increases to a value greater than 2 volts, it indicates State B. The
indication stays as State B until the signal decreases to below 1 volt, and only then
does State A display. So, it is possible to define states in the MIC to create
deadband-like behavior in the MI. The MI defaults to the first state if it is unclear
what state to display.
Header
Value
The current state of the Multi-State Variable is displayed in this field. The state is
based on, and can be only one of, the states in the Multi-State Input Configuration
assigned to the object.
Object Mode
Auto The displayed Present state is defined by the PG Object in the Control
Source field.
Manual The Control Source is ignored. The last Present State, or any value that
is entered, remains until the object is returned back to Auto. The status indicated
shall be “Out of Service”.
As soon as the Manual mode of operation is enabled a drop down box opens up to
the right of the Manual button. This drop down box is used to allow the operator
to choose an override state.
Auto Value
The Auto Value is the Index Value of the state that GCL+ is writing to the object.
GCL+ uses enumerated types and strings to write to an object.
Control Source
The Control Source is the name of the PG Object that is writing to the object. If
there is more than one program controlling the object, the Control Source will be
the name of the last program that has written to the object.
Description
The Description field will often be used for a detailed functional definition of the
physical equipment associated with the Multi-State Variable Object. It may
include all relevant facts pertaining to use, configuration, setup, calibration,
wiring, limitations, sensor location, warnings, etc. Information useful in the
installation and maintenance of the Device could also be included in this field.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters. The name
must be unique among the objects located on the same controller.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Configuration
The Configuration field allows you to select a Multi-State Input Configuration
Object. This MIC Object defines the number of states and the names of the states
that define the operation of the Multi-State Variable.
X States
X represents the number of states. This field shows the states assigned to the
object by the MIC chosen in the configuration tab. The list box shows every state.
If X is the number of states and you try to assign the MV to a state number (e.g.
X+1) greater than the number of states X., then this is not valid because the MV
has only X states. By default MV is assigned "1" which is a called the first state.
Since the possible state values start from "1" an assignment of "0" also defaults to
"1"
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of the Multi-State Variable Object
can be accessed using GCL+.
MULTI-TREND (MT)
The Multi-Trend (MT) is an ORCAview application that graphs the data samples
in Trend Logs (TL). Up to eight TLs can be graphed simultaneously in one MT
Object. The graph will plot new samples as the TLs collect them.
Multi-Trend Components
This section explains how the Multi-Trend object presents information. A Multi-
Trend object has these main components:
• Graph Area
• Dataview
• Slider Bar
• Axes
• Graph Legend (Colored Squares)
• Toolbar
Graph Area
The graph area is where Trend Log data is plotted and displayed. Analog data is
graphed along the top section, and the digital, or binary data, is graphed along the
bottom. The view can be scrolled from side to side to view all the data that the MT
has in its data buffer.
Dataview
The lower portion of the MT object contains the Dataview area. This area displays
information about each monitored object.
Dataview
Monitored Object This column lists each monitored object being plotted. To
the left of the monitored object name are two icons. The first is a checkbox that
shows or hides each line graph. The second icon shows the monitored object’s
corresponding line color on the graph.
Value This column shows either the last sample taken or the sample at the
intersection of the Slider Bar line and each graph.
Min / Last Off and Max / Last On These columns show the minimum and
maximum values for analog Trend Logs and the last on and last off times for
binary Trend Logs.
Average / On Time This column is the calculated average value for analog
Trend Logs, and the time spent in an ON state for binary Trend Logs.
Units This column shows the unit used for the data in each Trend Log.
Slider Bar
The slider bar at the top of the graph area is used to show the value of individual
samples for a specific time. When the slider bar is moved back and forth along the
length of the graph window, the slider caption will change to reflect the time that
the slider bar is positioned at, on the time axis. Where the slider line intercepts the
TL graphs, the value of the graph at that point will be shown at the bottom of the
MT window in the Dataview section, under the Value column.
In order to move the slider bar back and forth, position the mouse cursor over the
slider caption area, press and hold the left mouse button, and then move the cursor
to the left or right.
Slider bar
Axes
Trended objects can be graphed against three axes: the Y1-axis (left-hand side),
and Y2-axis (right-hand side) are used to graph analog data. The X-Axis is used
for time and appears underneath the graph area.
Binary Trend Logs graphed in the Multi-Trend will have their own binary axis
created. The binary data appears at the bottom of the graph when needed.
There can be colored squares on both sides of the Multi-Trend graph area. The
color of the squares corresponds to the color of the graph lines. If the square is on
the left, then that graph is being plotted against the Y1-axis. If the square is on the
right, then the graph is being plotted against the Y2-axis.
Toolbar Components
The Toolbar is used to configure the Multi-Trend object.
The following section describes, from left to right, each of the toolbar buttons, and
the related functions.
TL Setup
This button opens the Line Properties dialog to set each TL up. There are eight
tabs, one for each TL, for a maximum of eight TLs that can be graphed at one
time.
Trend The Trend field is where the TL object name or object reference is
entered.
Axis Assignment These option buttons are where the axis for the Trend Log
is selected. Analog TL’s can be set to use either the Y1-axis or Y2-axis. Binary
TL’s should automatically be set to use the digital (binary) axis.
Graph Properties This drop-down menu is where the color of the Trend Log
graph is selected. For good printing results, select colors that are easy to
distinguish if using a black and white printer.
Remove Trend Button This button is used to remove the Trend Log from the
Multi-Trend. When the Remove Trend button is clicked, the user must click
Apply or OK to remove the TL.
Axis
The Axis button on the Multi-Trend toolbar opens the Axis Properties dialog that
sets the axis properties for Time (X-axis) and Value (Y1-axis, Y2-axis).
X-Axis Tab
These are the fields displayed in the X tab of the Axis Properties dialog.
Start Time This is the time at which the graph started plotting. This time is
displayed as the left-most value along the X-axis. If the Automatic checkbox is
selected, then the Start Time of the graph is automatically configured to show the
oldest Trend Log sample. If the Automatic checkbox is cleared, then time and date
fields are enabled. These fields are used to specify the time at which the graph will
start plotting.
Time Span This is the time span that the graph area will show. If the
Automatic checkbox is selected, then the graph will show all of the Trend Log
samples from the Start Time onwards. If the Automatic checkbox is cleared, then
the time span must be specified. The default value is eight hours.
Scale & Grid Interval This section sets the time interval for the X-axis and
grid lines (if displayed). If the Automatic checkbox is selected, then an interval
time will be calculated. If the Automatic checkbox is cleared, the time interval
may be set by the user.
Show Grid This checkbox enables and disables the X-axis grid lines.
The following fields are displayed in on the Y1, and the Y2 tabs of the Axis
Properties dialog. Both tabs contain the same fields.
Minimum Value This is the lowest value on the Y-axis scale. If the Automatic
checkbox is selected, the minimum value is determined based on the data to be
shown. If the Automatic checkbox is cleared, then the lower end of the Y-axis can
be set manually.
Maximum Value This is the highest value on the Y-axis scale. If the
Automatic checkbox is selected, the maximum value is determined based on the
data to be shown. If the Automatic checkbox is cleared, then the higher end of the
Y-axis can be set manually.
Scale & Grid Interval Selecting this checkbox sets the grid interval for the Y-
axis and grid lines (if displayed). If the Automatic checkbox is selected, then an
interval is calculated. If the Automatic checkbox is cleared, then the grid interval
may be set by the user.
Axis Precision Selecting this checkbox sets the number of decimal places that
are displayed on the Y-axis. If the Automatic checkbox is selected, then an
appropriate Axis Precision will be calculated. If the Automatic checkbox is
cleared, then the Axis Precision may be set by the user.
Axis Title This field displays the title that is shown on the graph.
Show Grid Selecting this checkbox enables Y-axis grid lines. When this
checkbox is cleared the grid lines are disabled.
Settings
The Settings button opens a dialog that sets some general MT properties.
Show Graph Values When this checkbox is selected, the MT displays the
actual Y-axis value for each data sample on the graph.
Note: The Show Graph Symbols must be selected first to enable the Show Graph
Values checkbox.
Polling Intervals This value is the amount of time the MT waits before
retrieving any new data samples that are stored in the TLs. The default MT polling
time is now 1 minute from the previous 10 seconds so as to improve the
performance of the Multi Trend and reduce the CPU usage.
Setting this value lower will speed up the responsiveness of the MT, but at a cost
in terms of network traffic. The minimum value for polling intervals is 10
seconds. If the MT seems sluggish, it is recommended that this value be increased
as necessary. MTs containing eight TLs, with a large number of samples (more
than 1000 each), should have this value increased to more than one minute.
Pause
This button prevents any automatic display updates. The MT keeps graphing and
only freezes the frame so the X axis (time scale) does not resize itself or pan when
the graph reaches the right. This is done so that when using the Back / Fwd and
Zoom In / Zoom Out functions, the display is not changed on the next polling
interval.
Print
This button prints the currently viewed MT. Note that if the connected printer is
capable of color, then the MT printout will be in color. It is also possible to select
the Print to File option on a Windows print driver and click OK. Then, you enter
the file path and name. A Postscript file is created and it is readable by a printer.
Save
This button saves the selected MT’s data, and writes it to a comma-delimited text
file with the default name MT.txt. The Username, Date/Time, and Workstation
name are included at the top of the file. This data can then be imported into a
spreadsheet or another application. All of the MT's data will only be written to the
file if the MT is in Auto mode showing the entire data. If the graph is only
showing a subset of the data, for example zoomed in with Setstart or Range mode,
only the viewable data points will be written to the file
The DCU uses the BCP described on page 10–89 to set these configuration
options.
Header
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Setup
The Setup tab specifies which communication interfaces are active and sets their
parameters.
Port Column The Port column lists the physical ports on the controller.
Clicking on one of the Port numbers displays additional configuration information
(if available) in the area below the Dataview. Port 1 and 2 are EIA-485. Port 3 is
an EIA-232 serial, Port 5 is Ethernet, and Port 7 is UDP/IP. The port number is
internal and cannot be changed.
Type Column The Type column describes the interface for each port.
Enabled Column The Enabled column contains one checkbox for each
network interface. When the checkbox is checked, this Network Interface will
support communication by the BACnet protocol if the port is available.
Status Column The Status column displays the current state of each port.
Note: Changing the speed on any single device and pressing Apply or OK will
automatically cause a speed change on all Delta Controls devices on that MS/TP
subnet (DACs, DCUs and OWSs). Speed change requests will be sent regardless
of any baud rate differences between the requesting device and other devices on
the network.
Force Speed Change This checkbox is used to set the speed of all controllers
on the selected MS/TP network to the speed displayed in the Baud Rate field. This
checkbox is only available for MS/TP ports. This feature is used when you have a
current MS/TP network running at a certain speed, and you can add a controller
that is communicating at another speed. You would select this checkbox and press
Apply or OK and the Baud Rate of all controllers including the new controller is
changed to allow communication on the network.
Max Master This is the maximum number of MS/TP devices that can be in the
network segment. Any devices with a MAC address past this value will be ignored
and will not be visible on the OWS. This number must be the same on all devices
on the network segment.
Max Info Frames This value defines the maximum number of packets that the
MS/TP device can send out when it has the token, before it must pass the token to
the next device.
MAC Address This is the physical MS/TP address of the device. This number
comes from the DIP switch or LCD setup screen on the Room Controller.
Network The Network spin box field sets the BACnet network number for this
interface. Different physical (or logical) BACnet network segments must have
different BACnet network numbers or a value of 0. In order for the network
segment to work properly, all devices on that segment must contain the same
Network Number. Each interface in the Dataview is given a different network
number.
If DNA is disabled by removing the DNA jumper or by turning DNA off then
network numbers must be manually assigned and must match for each device on a
particular network segment. The Network spin box accepts a network number
range of 0 to 65534.
Note: The Network Number spin box field is grayed out if DNA is enabled. The
DNA scheme automatically calculates the proper network number. If DNA is
disabled, then the Network Number field is available, and needs to be set to the
proper value.
Setup Tab: Statistics MS/TP (same fields for PTP, Ethernet, and
UDP/IP)
This view shows some statistics related to BACnet network communications. The
fields for statistics are the same for all the different adapters. The values depend
on the interface selected in the Dataview.
Network Stats
Total Sent Counts the total number of packets sent including tokens for
MS/TP.
Total Received Counts the total number of packets received including tokens
for MS/TP.
Free Queue Counts the total number of packets available for network
communications. If this number stays below 10 for an extended period of time
(minutes), there may be a problem and you should consider resetting the panel.
Transmit Queue Counts the number of packets waiting to be sent out. This
number should normally be 0 or 1.
Application Stats
Total Sent Counts the total number of data packets sent from the BACnet
application code.
Total Received Counts the total number of data packets received from the
BACnet application code.
Invalid Received Counts the total number of errors in the BACnet protocol.
The fields for Setup below the Dataview change depending on the protocol on the
port that is selected in the Dataview.
Parity is set to None. The Data Bits are set to 8 and the Stop Bits are set to 1. The
settings of these three parameters cannot be changed.
Current Connection This field displays the type of connection being used on
the PTP port, either Direct or Modem. The default connection is Direct, and the
controller automatically detects if there is a modem connected and will switch the
connection to Modem.
Modem Dial Retries This field defines the number of redial attempts. The
field accepts a value from 0-10. The default is 2 retries. This field is available only
if the current connection is Modem.
Modem Type The Modem Type drop-down contains a list of different types of
modems. The list includes: U.S. Robotics, Zoom, Boca, and Custom. Selecting a
Modem Type fills in the Modem Init String with the proper string. The
corresponding Modem Init Strings for the different Modem Types are:
Modem Init String The Modem Init String is sent to the modem whenever the
controller is reset and when the modem disconnects. The Modem Init String
initializes the modem to its proper settings. Therefore, it is important to use the
proper settings.
You can either select the type of modem from the Modem Type drop-down list or
manually enter the initialization string for your particular modem here. Refer to
your modem manual for more details. This field is available only if the current
connection is Modem.
Dial Prefix The Dial Prefix is sent to the modem whenever the controller is
attempting to make a modem connection. This field is available only if the current
connection is Modem. The default Dial Prefix is:
ATDT
Note: The telephone number that the device will dial is specified in the RPS
object.
The telephone number that the device will dial is specified in the RPS object.
SUA for Direct Connect to 3rd Party Specifies the Password to check
when dialing into third party network.
This field specifies the local SUA object that is used to check the Password when
connecting directly to a third party device. This field is available only if the
current connection is Direct.
Note: The parameters available on this dialog will be fine in most situations. If
you have an unusual setup requirement, Customer Support can provide
instructions on how to change additional settings.
Network Stats
The fields for PTP Network Statistics are the same as those described for the
MS/TP in the Setup Tab: Statistics MS/TP section on page 10–602.
Application Stats
The fields for PTP Application Statistics are the same as those described for the
MS/TP in the Setup Tab: Statistics MS/TP section on page 10–603.
Network The Network spin box field sets the BACnet network number for this
interface. Different physical (or logical) BACnet network segments must have
different BACnet network numbers or a value of 0. In order for the network
segment to work properly, all devices on that segment must contain the same
Network Number. Each interface in the Dataview is given a different network
number.
If DNA is disabled by removing the DNA jumper or by turning DNA off then
network numbers must be manually assigned and must match for each device on a
particular network segment. The Network spin box accepts a network number
range of 0 to 65534.
Note: The Network Number spin box field is grayed out if DNA is enabled. The
DNA scheme automatically calculates the proper network number. If DNA is
disabled, then the Network Number field is available, and needs to be set to the
proper value.
Ethernet Address This field contains the physical Ethernet MAC address.
The MAC address is not the device number. It is the physical Ethernet address.
Speed Specifies the speed of Ethernet communication for the controller. The
available options are: Auto, 10 Mbps – Half duplex, 10 Mbps – Full duplex, 100
Mbps – Half duplex, and 100 Mbps – Full duplex. Auto detects the current
communication speed. This field can be used for troubleshooting.
Network Stats
The fields for Ethernet Network Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 10–602.
Application Stats
The fields for Ethernet Application Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 10–603.
With the DSM-RTR only, a second UDP/IP adapter is available. UDP/IP-2 uses
the 30000 range for network numbers (3AASS). If there are any INet networks,
this may conflict with their network numbers. If this is the case, DNA should be
disabled and the network number for the UDP/IP-2 adapter should be manually
specified.
The following information is for when UDP/IP is selected in the Dataview on the
Setup tab.
• Regular Devices can communicate with other controllers in the same sub-
network, but cannot communicate with controllers in other sub-networks
without the assistance of a BACnet Broadcast Management Device (BBMD).
• Foreign Devices are controllers which are isolated by themselves on a sub-
network which has no BBMD. These controllers can communicate with the
larger network by registering with a remote BBMD device on another sub-
network. The following paragraph explains BBMD devices.
• BBMD Devices operate as regular controllers, but are also responsible for
sending information from the sub-network that the BBMD is connected on to
other BBMD devices on other sub-networks. The remote BBMD then sends
the received information to the controllers in that sub-network. It is important
to note that only one controller on a sub-network can be designated as a
BBMD device. The other controllers must be set as Regular Devices.
UDP Port The port defines which UDP port number that UDP/IP
communication will use. The available range is 0 to 65535 with 47808 being the
default. These port numbers are assigned by Internet standard with 47808 being
assigned for the use of BACnet networks. It is important that this port number is
not changed arbitrarily as many of the other port numbers have other purposes that
would conflict with BACnet. All devices on the same UDP/IP network must use
the same Port number.
With a DSM-RTR, the second UDP/IP adapter will utilize a different UDP port
than the first, but it will still use the same IP address as the first; thus, the second
adapter can only be enabled if the first is enabled.
BBMD Address This setting is only needed when the Device Type field is set
to Foreign Device. A foreign device needs to know the IP address of a remote
BBMD in order to participate with that remote network. Any of the controllers
which are set as a BBMD Device could be referenced here.
Registration Timeout This setting is only needed when the Device Type field
is set to Foreign Device. This field is a time in seconds and is passed along to the
remote BBMD Device. This controller must confirm its existence with the remote
BBMD at this interval or the remote BBMD will assume that this controller no
longer wants to participate in the network.
A controller requests the use of an IP address from the DHCP server. The DHCP
server then allocates and assigns an IP address for the controller to use for a
particular amount of time. The period over which a network address is allocated to
a controller is referred to as a lease. The amount of time for the lease is
determined by the DHCP server.
The benefit of using DHCP is that it reduces the work necessary to administer a
large IP network. The alternative to using DHCP is manually entering the IP
Address, Subnet Mask, and Default Gateway information into the controller.
If the Use DHCP checkbox is checked, the IP Address, Subnet Mask, and
Gateway Address fields become unavailable since they are acquired using DHCP.
The Use DHCP checkbox is unavailable for BBMD controllers because they
require a static IP Address and cannot have a dynamic address.
IP Address Each device communicating by UDP/IP must have its own unique
IP (Internet Protocol) Address. The address is made up of four distinct numbers,
each of which has a range of 1 to 254. Normally, the site network administrator
provides the IP Address. It is important to note these addresses cannot simply be
‘made up’.
With a DSM-RTR, the IP address settings in the NET object are not displayed
under the second UDP/IP adapter (the DSM-RTR can only have a single IP
address).
Note: If a database is loaded into a DSC controller that doesn't match the
database's original address, then UDP/IP is disabled and Ethernet is enabled. If
UDP/IP is required on the controller, then the settings in the NET object (i.e. new
IP Address) must be set. If the database is reloaded into the original controller,
then UDP/IP is enabled with the settings that are in the database. This approach
avoids circular networks with multiple controllers having the same IP settings and
allows the same database to be loaded in multiple Ethernet DSC's. A DCU
behaves differently as it always disables UDP/IP whenever a database is loaded.
Subnet Mask Like the IP Address, this field also has four distinct numbers,
each of which have a range of 0 to 255. The subnet mask is used to determine
which other devices are on the same physical network segment, and which need to
be reached through an IP Router (Gateway). The most common subnets are
255.255.255.0 and 255.255.0.0. A subnet of 255.255.255.0 means that devices
whose IP address is different from this device in only the last of the four fields can
communicate directly to this device without the need of an IP Router.
For example, with the given subnet a device with an IP address of 192.168.1.1 can
communicate directly with another device which has an IP address of
192.168.1.20. Simplistically speaking, a 0 in the subnet means that devices with
IP addresses differing in this field can be reached directly. A 255 in the subnet
means that to contact a device with an IP address that is different in this field will
require the traffic to be first sent to an IP Router. Like the IP address, the Subnet
Mask would normally be supplied by the site network administrator.
Gateway Address This field also has four distinct numbers, and specifies
the IP address of the IP Router (Gateway) for this network. This field is only
required if two different networks need to communicate with each other. This
would be the case with a WAN. If required, this IP address is supplied by the site
network administrator.
Network The Network spin box field sets the BACnet network number for this
interface. Different physical (or logical) BACnet network segments must have
different BACnet network numbers or a value of 0. In order for the network
segment to work properly, all devices on that segment must contain the same
Network Number.
If DNA addressing is enabled, then the numbers are automatically computed and
this field is grayed out. The other option is to use jumpers or software settings to
enable the software addressing mode.
If DNA is disabled by removing the DNA jumper or by turning DNA off then
network numbers must be manually assigned and must match for each device on a
particular network segment. The Network spin box accepts a network number
range of 0 to 65534.
Note: The Network Number spin box field is grayed out if DNA is enabled. The
DNA scheme automatically calculates the proper network number. If DNA is
disabled, then the Network Number field is available, and needs to be set to the
proper value.
Outgoing Connection SUA This field allows the user to select the SUA
object that the device will use to verify against the SUA object on the remote
BBMD device. This setting is only needed if the device is attempting to log into
the network as a foreign device, and the remote BBMD device requires an SUA
Password Check.
Network Stats
The fields for UDP/IP Network Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 10–602.
Application Stats
The fields for UDP/IP Application Statistics are the same as those described for
MS/TP in the Setup Tab: Statistics MS/TP section on page 10–603.
Advanced
Maximums
BACnet Devices This value defaults to 100 and sets the maximum number of
other BACnet devices that the controller can communicate with. If you increase
the BACnet device’s value above 100, then more controller memory is used.
BACnet Routers This value, which defaults to 10, determines the maximum
number of BACnet routers that this controller can communicate with. A Delta
controller which is performing a routing function between two different network
interfaces would be included as one of these routers.
BACnet APDU
Max APDU Size This field, which defaults to 480 bytes, specifies the largest
size of an Application Protocol Data Unit that this controller can receive. If more
data needs to be transmitted to this controller at a single time than this value, then
the transmitting controller must break up the data into smaller pieces. This is
called 'segmentation'. The range of the value is 50 to 480 bytes. BACnet specifies
that all devices must support a minimum of 50 bytes.
Segment Timeout This field, which is very similar to the Retry Timeout,
specifies the time between re-transmissions of a single segment of a multi-
segment message. When messages between controllers are necessarily larger than
the Max APDU Size (see above), the message is broken down into multiple,
smaller segments. The default value is 5000 milliseconds.
BACnet Properties
Version This is the major version number of the BACnet protocol that is
implemented by this controller. Currently, Version 1 is the only one available.
Revision This is the minor version number of the BACnet protocol that is
implemented by this controller.
Local Network Number This value refers to the BACnet network that this
controller is locally connected to. The range of this number is 0 to 65534.
Essentially, all other devices which have the same Local Network Number can be
considered to be on the same 'logical' network. The only time this number would
have to be changed is if the network numbers for the individual interfaces are
changed.
MS/TP Slaves
This tab has a Dataview which lists information about slave devices. See the Slave
Device List (SDL) object on page 10–713 of this chapter. The Dataview has five
heading labels:
Device Number
Enter the device number of the slave device in this field.
Segmentation
Refer to the slave device’s documentation to determine what level of
segmentation the device supports, if any.
If the APDU portion of a message is larger than the maximum APDU value
supported by either of the devices participating in a conversation, the APDU
portion of the message may be broken into multiple segments where each segment
is sent in a separate packet.
Vendor ID
This field indicates the manufacturer of the slave device. Refer to the slave
device’s documentation to determine the vendor ID to use. If the vendor ID is not
specified in the documentation, use 0.
MAC Address
This field contains the network number and MAC address of the slave device. The
MAC address is not the device number; it is the physical MS/TP address. Refer to
the slave device’s documentation to determine the MAC address for the device.
Caution: The MAC Address field uses a format that requires care and
attention when entering its value. First enter a valid network number
followed by a comma and then the MAC address for the particular device.
The format of the MAC address differs depending on the physical media
used by the device (Ethernet, MS/TP...).
Entering a MAC Address The value for this field begins with a network
number, followed by a comma and then the MAC address. For example, a MAC
address on network 2321 would start out with NET2321. The following examples
use network 50:
Overview
Object Replication allows you to synchronize information across an unlimited
number of ASMs to expand the system to a virtually unlimited number of doors.
An RPL object can only be created in the OWS workstation.
When a change to certain objects is sent to a controller, SI Server propagates the
change to each ASM in the replicated list as well as to the Master ASM.
Possible change requests include a change within an object and/or the creation or
deletion of an object across the controllers. You are able to specify which objects
get replicated. Objects can be replicated across all controllers, or for specific
controllers with ranges.
Object Replication can be applied outside of access control. It can be used in
HVAC and lighting to replicate schedules and calendars across the entire network.
It can also be used for OWS security. The same Security User Access (SUA)
object can be replicated across the network so that it does not have to be created in
each controller.
Object Replication has a replication log files feature that logs failures and
successful replications.
Header
Value
Value indicates the status of the Object Replication (RPL) object. There are two
states:
Replicating the RPL object is replicating from one controller to another and/or
is waiting to replicate when a change occurs. Replicating is the default state.
Stopped replication is out of service. Changes to an object are not replicated to
other devices.
Manual Override
Use the Manual Override button to stop replication and to resume replication.
Replicated Devices
Master Device
The Master Device field is used to select a master device for replication. When
replicating for the first time, all slave devices refer to this controller for the
replicated objects. A change in the slave device will update all devices, if the
master fails, the replication process continues. Once started, the replication
continues for all devices until complete. If replication fails, it is logged in the RPL
log file.
Typically, a controller is selected as a master device.
NOTE: Setting the OWS as a master device allows replication of SCH, CAL and
SUA objects only.
Device List
The Device List is used to select the controllers that objects are replicated to.
Devices can be excluded from replicating or they can be updated individually.
Each device also has an update time.
Only certain objects can be replicated to certain devices. The following table lists
these objects as well as the number of objects which can be replicated using
certain controllers.
Controller Objects Being Number of Objects being
Type Replicated replicated
ASM Card User 10,000
Access Group No Limit
Door Group No Limit
Schedule No Limit
Calendar No Limit
System User Access No Limit
DSC Card User 500
Access Group No Limit
Door Group No Limit
Schedule No Limit
Calendar No Limit
System User Access No Limit
Excluded The Excluded checkbox is used to select the device to exclude from
object replication.
Device The Device field is used to select the devices that you want to replicate
objects to. You can choose to replicate to any device in the OWS network tree up
to 100 devices. For example, you can replicate a schedule to every device that is
on the network. A change in that schedule on any device will result in the change
being replicated to all other devices.
Last Update This field displays the date and time when objects were last
replicated to device.
Replicated Objects
Setup
Name
Name is a descriptive label given to the replication object. Although it is not
necessary the name should be unique within the BACnet network. The name must
be unique among the other objects located on the same controller. The name is
limited to 255 printable characters.
HVAC/Access/Lighting Checkboxes
These checkboxes are used to indicate which application(s) the object is being
used for. Any combination of HVAC, Lighting and Access Control can be
selected. Leaving all checkboxes blank is the same as checking them all. For
more information, see the section on Security in the SUG/SUA objects.
Description
The Description field can contain up to 2000 printable characters.
The Description field will often be used for a detailed functional definition.
With 3.40, the log files are no longer located in C:\Programs Files\Delta
Controls\3.40\Sites.
The log file name starts with RPLLog1.txt and increment up to RPLLog10.txt
each time the Reload Replicated Objects command is executed. After RPLLog10
3200.SCH3 - OK
put/create *.SCH4:
3200.SCH4 - OK
put/create *.SCH5:
3200.SCH5 - OK
put/create *.SCH6:
3200.SCH6 - OK
put/create *.SUA1:
3200.SUA1 - OK
put/create *.SUA3:
3200.SUA3 - OK
put/create *.SUA4:
3200.SUA4 - OK
put/create *.SUA5:
3200.SUA5 - OK
put/create *.AG1:
3200.AG1 - OK
put/create *.AG2:
3200.AG2 - OK
put/create *.AG3:
3200.AG3 - OK
>> Completed processing RPL1
*************************************
>>RESULT: Object Replication update was successful
******************************************************************
Object Replication Ended at: 13:59:10 28-Sep-2011
******************************************************************
put/create *.CU3:
put/create *.CU4:
put/create *.CU5:
put/create *.CU6:
put/create *.CU7:
put/create *.CAL1:
put/create *.DG1:
put/create *.SCH1:
put/create *.SCH2:
put/create *.SCH3:
put/create *.SCH4:
put/create *.SCH5:
put/create *.SCH6:
put/create *.SUA1:
put/create *.SUA3:
put/create *.SUA4:
put/create *.SUA5:
put/create *.AG1:
put/create *.AG2:
put/create *.AG3:
>> Completed processing RPL1
*************************************
>>RESULT: *** Failed to update all replicated objects on All
Devices ***.
******************************************************************
Object Replication Ended at: 14:03:44 28-Sep-2011
******************************************************************
This object security feature works with enteliBUS controllers and DAC/DSC
controllers that have a 16 Mb Toshiba DSC image, or an 8 Mb Toshiba DAC
image.
The status of the ORS object is either Unlocked, Locked, or Temporary Login.
Unlocked In the Unlock state, the controller allows all requests. The rules
defined in any ORS objects are ignored.
Locked In the Lock state, the controller restricts access to the controller
based on the rules specified in ORS1.
Temporary The controller temporarily enters the login state where access is
Login based on a specific ORS, instead of ORS1. This state will remain for
the amount of time specified in the request.
Theory of Operation
Object security is not a complete solution for all security concerns. It provides the
first-level of defense after physical security of the device has been achieved.
Additional layers of network security build upon this feature to create a secure
site.
For each BACnet network request, the controller passes the request through
several phases.
1 The first phase checks if Object Security is enabled by checking for Locked
or Unlocked status.
3 Once the ORS object is determined, the controller applies the rules in the
ORS Device Exceptions list.
4 Finally, if the network request deals with objects, the controller applies the
rules in the ORS Object Exceptions list. A typical net request is a Read or
Write for an object property.
If the selected controller does not support Object security, then the three options
are grayed out. If the selected controller does support Object Security, then the
options are available in the context menu.
When you click on one of the Object Security commands, the following ORS
Login dialog appears:
To request that the controller enter a specific state, the OWS transmits a BACnet
Confirmed Private Transfer containing the requested state, user ID, and password.
The controller response to the BACnet Confirmed Private Transfer is either a
BACnet success or a BACnet error.
Unlock In the Unlock state, the controller allows all requests. The
rules defined in any ORS objects are ignored.
To enter the Unlock state, the request’s User ID and
Password must match the Master SUA specified in
ORS1.
Lock In the Lock state, the controller restricts access to the
controller based on the rules specified in ORS1 (instance
1).
To enter this state: a) the controller is reset, and the
database contains ORS1, or b) the requestor’s User ID
and Password must match the Master SUA specified in
ORS1
Temporary Login In the Temporary Login state, the controller temporarily
enters the login state, where access is based on a
specified ORS other than ORS1. This state remains for
the amount of time specified in the request. If the user
selects Temporary Login, then the request is sent to the
device with a 20 minute timeout.
The ORS that is used is based on the User ID in the
request. The User ID should match one of the SUA’s in
the controller’s database. The ORS used for the rules is
the one specified in the SUA object.
Temporary Login
In lockdown mode, the controller is reasonably secure because only the exposed
points are accessible. The service technician must take the device out of lockdown
mode to change the controller’s Object Security rules.
This service technician feature allows tiered access to the controller’s objects, but
it has limitations since the packets are not encrypted and there is no protection
from spoofing or replay attacks. This feature supports up to five simultaneous
logins. A user remains logged in as long as the controller continues to receive
requests from the requestor device. Users are automatically logged out if they
remain inactive for the SUA Auto-Logoff period.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters long. The length of a name is from 1 to 255 characters on a DCU or an
OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Lock/Unlock SUA
Specifies the SUA object that a requestor’s User ID and Password must match.
If the instance of ORS is 1 then the master SUA is specified. This master SUA is
the one used to lock and unlock the controller
If ORS instance is other than 1, then the specified SUA is used to login to the
controller.
The following figure shows the Object Security field on the Setup tab of the
DELTA SUA.
Object Exceptions
The Object Exceptions tab provides a way to define restrictions or rules for an
object property within a specific range of instances of an object.
The Objects Column accepts an entry that contains the StartID, EndID,
PropertyID, and ArrayIndex parts of the Object Security List.
The following table explains the access permissions options for the specified
object (property) entry. Each option can be turned on independent of the others.
For example, it is possible to have Read enabled but with Visible disabled. For
such an entry, remote devices will have to know the object exists, as reading the
ObjectList will not show the object.
Access Function
Level
Read Reading of the specified object/properties is allowed.
Write Writing of the specified Object/Properties is allowed.
Create Creating objects in the specified range between StartId and EndId is
allowed.
Delete Deleting objects in the specified range between StartId and EndId is
allowed.
Visible Objects in the specified range between Start and EndId are visible by
reading the ObjectList.
When you hover the cursor over a Device Exceptions Permissions entry, a tooltip
displays with a list of enabled permissions. In some situations with multiple
permissions enabled, the tooltip may not be able to display all the permissions.
You can double click on a selected entry and the Edit Bitlist submenu displays
with the selected options shown.
The following example shows how to correctly enter rules to get the intended
function. If you wish to allow full Permissions for AO1, and for AV2-4194303
but otherwise want all other objects to have only Read and Visible permissions,
enter the following rules:
When deciding what time to bring on the equipment, the OS may use a number of
factors:
• History over the past three days
• Outdoor temperature
• Scheduled occupied time
• Actual space temperature while unoccupied
• Desired target space temperature
• Extended unoccupied time (weekends or holidays)
In order to properly utilize the Optimum Start object, it needs to be referenced in
GCL+ code. For a typical fan system, GCL+ code starts the fan if the Schedule or
the Optimum Start is ON.
Common Header
Object Value
Displays the state of the OS Object.
On The OS Object is active in the early start state.
Object Mode
Auto The Object Value is automatically set based on the preset conditions.
Manual The Object Value is not automatically set. When set to Manual by an
operator, the Object Value remains fixed until the object set back to Auto.
Set to Manual to test the response of an output or GCL+ Control Strategy to the
OS Object.
Status
The current status of the object. The possible values are:
Start Type
Specifies whether the object is a Heating or Cooling optimum start.
Indoor Temperature
The current value of the Indoor Temperature is displayed.
Target Temperature
The Target Temperature is the space temperature that you wish to achieve when
the spaces becomes occupied.
Time Remaining
Time remaining before scheduled occupancy.
Schedule
The current status of the Schedule will be displayed.
The OS object references a Schedule object. The Schedule reference tells the
Optimum Start what time the space should be up to the Target Temperature. The
Schedule object linked should be the same schedule that normally runs the
equipment.
Description
Contains an optional description of the OS object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Start Type
If this Optimum Start will be bringing on the equipment to pre-heat the space,
select Heating Start. If this Optimum Start will be bringing on the equipment to
pre-cool the space, select Cooling Start.
Note: It is possible to have two Optimum Start objects for the same system, one
for cooling in the summer, and one for heating in the winter.
Additionally, note that the Optimum Stop capability that existed in Version 2
firmware has been removed.
Target Temperature
The Target Temperature is the space temperature you wish to achieve once the
space becomes occupied.
Example
NONE 68.0
• Enter an object reference for the Target Temperature in the left hand field.
This would typically be an Analog Variable (AV) which stores the space
setpoint. The value of the AV is displayed in the right hand field and is read-
only.
Indoor Temperature
The Indoor Temperature tells the Optimum Start what the current space
temperature is. It is typically an Analog Input (AI), but could be an Analog
Variable (AV) if multiple temperature sensors need to be averaged.
Enter the object descriptor or reference for the Indoor Temperature that is to be
monitored. The current value of the Indoor Temperature is displayed in the right-
hand field.
Example
GYM_ROOM_TEMP 65.9
If the Indoor Temperature is not specified, the OS object will be in a Fault state.
Deadband
If the indoor air temperature is within the Deadband at the Schedule ON time
minus the Max Start Time then the OS object does not calculate a start time. If the
indoor air temperature moves outside of the Dead Band during the Max Start
Time then the OS objects calculates a Start time. The default is 2º.
Schedule Object
The Schedule reference tells the Optimum Start the time that the space should be
at the Target Temperature. The referenced Schedule object should be the same
schedule that normally runs the equipment.
The Schedule Object field has a dropdown box which contains all the local SCH
objects. When a schedule is selected, the start time for the current day will be
displayed to the right of the field.
If the Schedule Object is not specified, the OS object will be in a Fault state.
Note: The OS object only looks at the first ON/OFF period within a day. After the
first OFF / ON period, the OS object will ignore any other periods within the day.
The OS object will not shut down before the Schedule turns OFF.
If the OS object is referencing a Schedule (SCH) that has multiple time blocks in
the same day, the OS will only turn ON for the first time block and none of the
other time blocks during that same day. It will turn ON again for the first time
block on the following day.
When the OS is active, it typically takes between 1-4 hours to warm up a building
in the morning depending on the heating capacity. In practice, there are not
enough hours in a day to actually have multiple OS start periods because of the
warm-up time requirement. Also, once a building is up to normal temperature, it is
best to leave it there until the day is done.
For example, if the Schedule enters the occupied period at 8:00AM, and the
Maximum Start Time was set to 2 hours, the equipment is limited to starting at
6:00AM, regardless of the space conditions.
Like the Target Temperature, the Maximum Start Time can be either a fixed
number entered using the spin box or an analog Object Reference. The following
figure shows a Max Start Time defined by a reference to an Analog Variable
object AV1 called StartTime in the first part of the field. The fields to the right of
the object reference show the start time (1.7 Hours) specified in the analog object
and its status. For example, if a referenced Analog Variable object is in Manual
mode, the field displays Out Of Service.
Normally, the fixed number of hours defined using the spin box should be
sufficient and the analog object reference in the first field is usually left blank.
The Maximum Start Time or stop period is specified in hours and set using the
spin box. The selected value ensures that the calculated start period does not
exceed this hourly maximum.
Optional Parameters
There are three optional parameters.
• Outdoor Temperature
• Outdoor Influence
• Unoccupied Influence
Example
You can enter in the left hand field the object descriptor or acronym for the
Outdoor Air Temperature. The actual Outdoor Temperature is displayed in the
right hand field.
OUTDOOR_AIR_TEMP 50.0
If the Outdoor Temperature field is linked to the outdoor air temperature, then the
next field, labeled Outdoor Influence, determines how much effect variations in
the outdoor temperature will have on the warm-up/ precool time. The default for
this field is 0.10, which means that for every degree change in outdoor
temperature from the previous history days, the warm-up/ precool Heat Rate is
adjusted by 0.1 deg/hr. The units of the Outdoor Influence are (deg/hr)/ (deg
OAT).
As another example with the default of 0.10, every 10° of change in the outdoor
temperature will change the Heat Rate by 1 degree per hour. Setting this value to 0
will disable any adjustment in the Heat Rate based on OAT changes.
Note: The Influence percentage does not take into account whether the outdoor
temperature is in °C or °F, thus this factor will have to be adjusted accordingly.
Building dynamics play a large part in selecting an appropriate value for this field,
but 50% should be a reasonable starting point.
History
The history log contains information on the optimal start time results for the last 3
days. The history data is used in the optimal start calculations. The data is
organized under the following headings:
On
Time and Date when the OS object value changed to ON for that day. This time
must always be between the scheduled on time and Maximum Start Time hours on
the Setup tab before the scheduled time.
Indoor °C
The indoor temperature when the OS object value changed to ON. This can give
an indication of how well the night setback is working in the facility.
Outdoor °C
The outdoor temperature when the OS object value changed to ON. This will
show 0° always if the Outdoor Temperature reference has not been filled in.
Target Achieved
Time and Date when the OS object value changed to OFF after reaching the
Target temperature for that day. If this time is beyond the actual scheduled start
time, then perhaps the Outdoor Influence or Unoccupied Influence parameters
should be increased. The OS object will not return to an OFF from an ON state
until the Schedule time is meet.
Status
Status value when the OS object value changed to OFF. This field gives the status
once the scheduled period for that day began. It can be either Achieved (indicating
that warm up was completed in time), Off (indicating that the Optimum Start
period ended prior to the Indoor Temperature achieving Target Temperature), or
Unknown (during the Optimum Start period).
Target °C
The Target Temperature that the Optimum Start was trying to achieve for that day.
Indoor °C
Indoor temperature value when the OS object value changed to OFF. This is the
Indoor Temperature when the scheduled occupied period began. If the Optimum
Start is setup properly, this value should be very close to the previous field (Target
Temperature).
Rate °C/ hr
The temperature rate per hour during the OS Value ON time. Units are degrees
per hour. This field is a calculated Heat Rate based on the temperature rise during
the Optimum Start period divided by the number of hours the Optimum Start ran
for. The Optimum Start averages the three heat rates in order to determine when to
bring on the equipment the following day.
These fields remain fixed if the previous day was a weekend or a holiday.
Note: A negative number appearing as the Rate value of any one of the Last Day,
Second Last Day or Third Last Day fields indicates a mechanical equipment
failure. The negative value is excluded from the averaged Heat/Cool Rates,
affecting Optimum Start/ Stop period calculations.
Parameter Description
Optimum Start Time OST = Schedule On Time – (Indoor Time + Unoccupied Influence Effect (UIE))
(OST)
Optimum Start Time When the History Tab has no data in it, the Optimum Start Time is calculated by:
(OST)
OST = Schedule On Time – Max Start Time
(History Tab has no
data)
Indoor Time (IT) When the History Tab has data in it, the Indoor Time is calculated by:
If Heating Start then
IT = Limit((Target Temperature – Indoor Temperature) / Effective_Heat_Rate, 0,
24)
Parameter Description
UIE = Unoccupied Influence / 100 * Indoor Time
Heat Or Cool Rate: Temperature Change = ( IAT @ [ Status = “On” ] ) – ( IAT @ [ Status = Achieved
(Degrees / Hours ) OR Off ] )
Heat Or Cool Rate: Period of Change = ( Time @ [ Status = “On” ] ) – ( Time @ [ Status = Achieved
(Degrees / Hours ) OR Off ] )
Heat Or Cool Rate: Rate = Temperature Change / Period of Change
(Degrees / Hours )
Changing Outdoor temperature sets the object reference for the outdoor
temperature. The Outdoor Influence allows the user to set how much the outdoor
temperature affects the OS objects startup time.
The Unoccupied Influence allows the user to set the effect of a 24 hour
unoccupied period.
The OS object turns OFF when the referenced Schedule turns ON. The OS stays
ON even after it has achieved its target temperature and only turns OFF when the
Schedule turns ON. When the Object is in Manual Mode the present value will no
longer be affected by the OS calculation.
Object Description
The Priority Names (PAN) Object is used to identify what/who is writing at which
priority level, by allowing you to assign a meaningful name (test label) for each
priority level in a controller. Objects utilizing a priority array obtain the name for
each priority level from the PAN1 Object located in the same controller.
Delta Controls supports the Priority Array object with the BACnet Binary Output
and Analog Output objects.
There is a PAN1 object located in every BACnet controller with default priority
level names. This object can only be modified and cannot be created and/or
deleted from a controller.
When entering in a label for a priority level, do not exceed the space given or the
label will not fit in other dialogs. The space provided is the same size as the
display area in the outputs.
Example
The following figure shows the PAN from controller 4. Priority Level 13 was
modified from the default to Alerton Control Level. This shows the operator that
anything written to Priority Level 13 is coming from an Alerton device.
All outputs in controller 4 will now display Priority Level 13 as Alerton Control
Level. This is shown below using AO2 from the same controller.
PROGRAM (PG)
The Program (PG) Object is the Object that is used to enter GCL+ programs into
the database.
Multiple PG Objects may be entered into the database with one basic rule: a PG
Object with Object Number 1 must exist, without it GCL+ programs will
NOT execute. PG1 will always be the Main program. From the PG1 Object other
PG Objects may be called.
The PG Object has several features that make it easy to manipulate the database.
A counter, on the right side of the program name, records the program size as it is
being written. If the program exceeds its maximum size an exclamation mark (!)
appears to the left of the counter. A warning message appears if you try to save a
program that exceeds the maximum size.
Each program line can have up to 255 characters. The appearance of the text in the
PG object is determined by the GCL Editor Settings (GCS) object.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Priority
This is a read only field that indicates the Priority level at which GCL+ operates.
6 - Minimum On/Off
8 - Manual Operator
State
This drop down box allows the programmer to choose whether the program is
executing or not. Selecting Run will allow the program to execute; selecting Halt
will terminate execution of the program.
With the DFM-400P board, the Pulse Input (PI) object counts pulses from one of
the four pulse inputs on the DFM-400P. One PI object is associated with each of
the four inputs on the board. PI1 and PI2 monitor pulse rates up to 2000 HZ while
PI3 and PI4 monitor pulse rates up to 200 HZ. All four pulse inputs have an
optional debounce filter available which eliminates electrical noise caused by
electrical contacts.
With the DBB060 board, the Pulse Input (PI) object counts pulses on the single
input on the DBB060. Only PI1 will connect to a physical input. The pulse input
monitors pulse rates up to 1000 Hz.
With OWS 3.40, a Pulse Input (PI) object is creatable on all DAC/ DSC
controllers (except for older smaller memory DACs) but the object is not fully
functional. The DFM400P and DCU are the only devices that fully support the PI
object. In DAC/DSC controllers the PI object can be used to store larger numbers
with greater precision than is possible using an analog variable. A number with up
to 9 significant figures can be stored without loss of precision using the
PI.TotalPulses object property. An AV can only store up to 6 significant figures
before it starts to lose precision. This allows increased accuracy when trending
data from large accumulators in metering devices such as a Modbus power meter.
Header
Value
The Object Value displays the instantaneous flow rate or demand of the resource
being measured. The value depends on the type of measurement, and the
conversion factor and units. Typical measurements might be gpm, l/s, btu/hr or
kwh.
Object Mode
Auto The Pulse Input is controlled automatically, based on the current Input
pulses, and any Conversion Factor.
Manual The value of the Pulse Input is no longer based on the current Input
pulses, or any conversion factor. The status indicated shall be “Out of Service”.
As soon as the Manual mode of operation is enabled, an edit box opens up to the
right of the Manual button. This manual entry box is used to allow the operator to
enter an override value.
Total Pulses
This is the total number of pulses received by the Pulse Input Object since the
Object was created or since it was last reset.
Last Reset
This is the time and date of the last time the PI Object was reset.
The Description field will often be used for a detailed functional definition of the
Object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS, 1 to 67 characters on a DAC, and 1 to 16 characters for the
DFM-400P. The name must be unique among the objects located on the same
controller.
Fixed Point
BACnet values are stored as Real numbers. Real numbers in Version 3 go from –
1038 to +1038 and from as small as 1.17549x10-38. A floating point number will
show a maximum of six significant digits with an exponent that can go as high as
1038. Seven significant digits are stored internally for the process of rounding.
This means that the largest number that can be displayed is 3.40282x1038. The
smallest number is 1.17549x10-38.
By selecting Fixed Point the PI Dialog will force the value to display a certain
number of decimal places. The dialog will automatically round the number to the
correct decimal place.
Decimals
This field allows the operator to set the number of decimals places that display.
The range is 0 to 9 decimal places (0 to 3 for DFM400P). The object value has a
restriction of only displaying 6 significant digits so as the number becomes larger
(using more places to the left of the decimal) zeroes will be used to fill up the
specified number of decimal places.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
If the duration is set too small, a single pulse may be counted more than once.
This occurs in situations where the pulse has a large width. If the duration is set
too large, it may result in pulses being missed. The maximum pulse duration is
65535 milliseconds (65.5 seconds).
Sample Interval
This is the time, in seconds, to sample the number of pulses received. When the PI
object is created, the sample interval will default to 60 seconds. The maximum
sample interval that can be entered is 65535 seconds (18.2 hours). The minimum
sample interval is one second. This value may be set by using the spin control or
entering a value directly in the field.
Advanced
Commissioned
This is a check box which tells the operator whether or not the Object has been
field commissioned. This field affects Alarm generation: when the object is de-
commissioned, Event objects that monitor this object will not transition and
no alarm notifications will be generated for that event.
Reliability Codes
This property provides an indication of whether the present value is reliable. If
any reliability other than No Fault Detected is present a Wrench Icon will appear
in the object header. This property will have one of the following values at any
given time:
Not Available – This means that no value is available, and the Wrench Icon will
appear.
Average
Number of Sample Intervals This is the number of previous sample
intervals which are kept to calculate the Average Pulse Rate. The default setting is
5. The maximum number is 254 while the minimum number is 1.
Averaged Pulse Rate This is the pulse rate that is calculated over the n
sample periods, where n is specified in the Number of Sample Intervals. If the
Sample Interval is set for 60 seconds and the Number of Sample Intervals is set to
5, the Average Pulse Rate is the pulse rate measured over the most recent 300
seconds.
Conversion
Factor This is the Conversion Factor that allows the user to convert the pulse
rate value and total number of pulses to the units given in the Conversion Units
field. This is a floating point number and fraction conversion factors may be
entered. The minimum factor is 0.01 and the largest number that can be entered is
9999999.00. You can use the spin box then to get numbers larger than 9999999.00
You cannot enter these larger numbers directly.
Units These units represent the actual unit that each pulse represents after
conversion. The units are the BACnet engineering units.
Data
Instantaneous Pulse
Rate This is the current pulse rate calculated from the previous Sample Interval.
The Instantaneous Pulse Rate is given in the units specified in the Pulse Rate Unit
field. This is the value that is read into present value if no Conversion Factor is
specified.
Maximum Pulse Rate This field displays the value of the Maximum
Instantaneous Pulse Rate since the PI Object was created or last reset.
Rate Time This field displays the date and time that the Maximum
Instantaneous Pulse Rate was last updated.
Average Pulse
Maximum Average Pulse Rate This field displays the value of Maximum
Average Pulse Rate since the PI Object was created or last reset.
Rate Time This field displays the date and time that the Maximum Average
Pulse Rate was last updated.
Converted Pulse
Rate This field displays the pulse rate after the conversion factor has been
applied to the Instantaneous pulse rate. This is the value that is displayed in
present value.
Average Converted Pulse Rate This field displays the pulse rate after the
conversion factor has been applied to the Average pulse rate.
Total Converted Pulses This field displays the total number of pulses after
the conversion factor has been applied to the total number of pulses actually
received.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
Selecting a given city with the LCD Keypad applies the location settings of the
given city to the device. The Latitude, Longitude, DST, and UTC offset can be
edited individually.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
City
This tab contains entries with configuration information for different cities.
Name
Provides the name of the city which is referenced to apply the location settings of
the given city to the device.
Latitude
This field describes the latitudinal geographical location of the controller. For
example you could enter 49.5º north. The latitudes have a resolution of 0.1
degrees.
Longitude
This field describes the longitudinal geographical location of the controller. For
example you could enter 95º east. The longitudes have a resolution of 0.1 degrees.
European Daylight Savings Time – see DST STANDARD which follows for
more information.
The dates in emails and Security settings on Configuration tab of the Device
object also use UTC.
Daylight Savings
This field contains the Daylight Savings Time information for the selected city:
• North American
• European
• Australian
• Other DST time defaults.
This box will default to North American. If the operator selects European then the
typical values for the European countries DST will appear in the DST fields. The
operator will still be able to modify the affected fields if there are slight
differences from the standard. If the operator does modify the standard, as soon as
he presses APPLY the standard will change to OTHER. This will indicate to the
operator that the standard has been modified.
The purpose of DST is to conserve sunlight during the summer months. This is
accomplished by manipulating the clock time so that both sunrise and sunset will
take place at a later hour. This will have the effect of giving us one extra hour of
sunlight in the evening.
NORTH AMERICA:
• Start – Second Sunday in March
• End – First Sunday of November
• Effective Hour – 2 AM
• Offset – 60 Minutes
AUSTRALIA:
• Start – Last Sunday in October
• End – Last Sunday in March
• Effective Hour – 2 AM
• Offset – 60 Minutes
EUROPE:
• Start – Last Sunday in March
• End – Last Sunday in October
• Effective Hour – 1 AM + UTC offset
• Offset – 60 Minutes
OTHER:
• No set defaults. User can enter any option that they want.
The RPS object uses the settings defined in the Modem Settings (MDS) object.
The RPS object is typically used to dial out Alarm Notifications from a controller
to an ORCAview workstation. Delta does not support dialing via modems from a
DCU or DSC controller to another DCU or DSC controller.
Note: Once the RPS Object is created or edited, the controller must be reset in
order for it to take effect.
Main
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Phone Number
The phone number for the device that is to be dialed. This field accepts the Area
Code and the Long distance prefix. Communications are established with a device
using a modem when the phone number is dialed.
Password
The Password is needed if the ORCAview OWS is attempting to dial into a Third
Party Vendor’s Device that requires a remote password check. This password will
be compared to the Devices own internal security settings.
If the password matches the connection will be successful. If the password does
not match the dialup connection will fail and the OWS will not be able to
communicate with the network. If the OWS is dialing into a Delta Controls
device, disable this field by selecting the Delta Device checkbox and selecting the
Dialup SUA from the drop down menu (if required).
Dial-out SUA
This field allows the user to select which SUA will be used when connecting to a
Delta Controls Device that Requires a Remote SUA Password check when using a
dial-up connection. The Controller to which the OWS is dialing into will compare
the Username and Password of the selected SUA Object and compare them to
those contained in the SUA in the controller database. If the SUA settings on the
OWS do not match those of the Controller, the connection will be dropped and the
OWS will not be able to communicate with the network.
Delta Device
If this checkbox is checked, the device expects to dial out to a controller or OWS
created by Delta Controls. The default is checked. If this checkbox is unchecked,
the Password field for third party devices displays.
Setup
Baud Rate
Sets the baud rate for the port.
You can adjust the baud rate for the port to one of the following speeds:
300, 1200, 2400, 4800, 9600, 19200, 38400
This setting must match the “Baud Rate” setting for the “PTP (RS-232) Port
settings” in the BACnet Protocol Settings (BCP) Object on the ORCAview
workstation. If the baud rate settings do not match, an Unable to Connect error
message is issued.
Object System
This field sets the type of objects expected on the remote device. The choices are
BACnet or Delta V2. When Delta V2 is selected, the Network Number field does
not display.
Panel Number
The address of the device that will be dialed.
Network Number
The number of the network that the device is on. To identify the Local Network
Number of a certain device open its BCP Object and click to the Advanced tab.
REPORTS (RPT)
Reports (RPT) is a feature in ORCAview that generates commonly used technical
reports of the system. RPTs are created through the local Operator Workstations
(OWS) just like standard ORCAview objects.
Report Setup
The Report Setup tab is used to select and configure the Query, Tenant Billing,
Access Configuration, Access, Controller Configuration, and Controller reports.
When a new RPT is created the Setup tab defaults to Query report. The overall
layout of this tab changes based on which report type is selected.
Query Generates a report listing the objects, based on user-defined criteria. For
example:
• Calendar Configuration
• Schedule Configuration
CAL and SCH objects are used with other objects besides Access Controls ones. It
helps the building owners to know Calendar and Schedule setups in other control
devices.
Controller Reports Generates reports for Input and Output objects only.
The following sections describe the Setup tab for each report. This tab changes
based on the report type selected. The Destination/Layout tab and the Description
tab are the same for all six report types.
Query Setup
The following section describes all the fields and dialogs in the Setup tab when a
Query report is selected.
Devices
The Devices section of the Setup dialog contains three options for selecting object
filter criteria for individual devices or a range of devices.
All Devices Selecting All Devices filters for criteria related to all Version 2,
and all BACnet devices. If All Devices is selected, the query report displays
results from all devices that meet the object filter criteria.
Area Selecting this option enables the Area, System, and Subnet drop-down
menus, and allows the selection of devices based on the Area-System-Subnet
(DNA) architecture. Only BACnet devices are listed in these menus.
When an Area device is selected, the System drop-down menu shows all the
System devices under that area. Selecting All Devices from the System drop-down
menu generates reports on all devices in that Area.
If a specific System device is selected, the report is generated on all devices under
that system.
When a System device is selected, the Subnet drop-down menu contains all the
Subnet devices under that System. Users can generate a report on a single subnet
device by selecting a device in the subnet drop-down menu.
Note: If there is no applicable device for the drop-down menu, that specific drop-
down menu is disabled.
Specific Selecting Specific filters for specific devices or device ranges. Some
examples of acceptable entries are:
• 23000
• 23000 - 40000
• 40000
• 23000, 30000 - 45000, 60000
Object Filter
The Object Filter box is used to enter specific search criteria in the same way
information is entered into the Navigator Filter Bar in ORCAview. The Object
Filter box limits which objects are displayed in the report. Objects can be filtered
in the following ways: by object name, object type, object instance, or by property
values. The following table provides examples of filtering criteria that can be
used.
Report Format
The Report Format section is used to configure how each column of the report
information is displayed.
Clicking the column headers sorts content in ascending or descending order. The
columns and cells within each section can be modified in a variety of ways. The
right-click function is used to Add, Remove and Edit columns based on the report
information required.
Once modified, any report changes can be viewed by clicking the Preview button
on the lower left corner of the Setup dialog.
Property The Property cells define the object property shown in the report.
Using the cursor, click the cell, and select one of the predefined properties (as
shown in the following figure), or enter an object property that is relevant to a
specific object type.
Alignment The Alignment cells define the text alignment (left, center, right)
within that column. Click the cell to change the alignment.
Format The Format cells define how the properties are displayed, which can be
either text or decimal values. For example, if the object property is True/False and
"Text" is selected as the Format, then "True/False" is displayed in the column. If
the number signs (#.#####) are selected as the Format, then "1.00000/0.00000" is
displayed in the column.
Add, Edit & Remove The Add, Edit and Remove functionality becomes
available by right-clicking in the Dataview area of the Report Format section.
Add Column This dialog contains two fields for adding new columns to a
report, the Property field and the Column Name field.
• The Property field defines the object property that is shown in the column. It
contains a drop-down menu of predefined properties or a desired property can
be entered.
• The Column Name field defaults to the predefined property chosen. This field
can be customized by typing in a chosen name. This name then appears as the
column header.
Edit Column This dialog is used to edit any columns by changing either the
Property field, or the Column Name field.
Remove Column This feature removes columns from the Report Format
Dataview and from the report. Using the right-click function within a column,
click Remove Column to delete it.
Period
The Period drop-down menu is used to define the range of data used to calculate
the billing time period.
The options available are Previous Month, Current Month, or any of the 12
calendar months (January through December). When one of these calendar
months is selected, the Year box is enabled.
Invoice #
The Invoice field is used to enter the invoice number that appears on the Tenant
Billing report. Each time a new report is auto-generated, the invoice number is
incremented automatically. A new invoice number can be chosen, and then the
report numbers increase incrementally from that point forward.
Trend Logs
The Trend Logs Dataview displays a list of the TLs used to calculate the tenant
billing amount. The Trend Logs Dataview contains the following four columns:
Rate Displays the amount charged per hour for each TL entry.
+/- Displays any temporary adjustments made for that specific TL entry.
Because this value is temporary, the information is deleted when the RPT dialog is
closed.
Add Button
The Add button opens the Add Trend Log dialog, so that single or multiple TLs
can be added to the Trend Logs Dataview.
Trend Logs The Trend Logs area displays a list of all TLs found in the
selected devices.
Rate The Rate field is for setting the hourly dollar rate that is used to calculate
the overall transaction cost for that specific TL. This field only accepts positive
numbers. By highlighting multiple TLs, the rate is applied to all of those selected.
Edit Button
The Edit button opens the Edit Trend Log dialog to modify the Description, Rate,
or the Temporary Adjustment value of a selected entry in the Trend Logs
Dataview.
Trend Log Displays the TL name and the TL object reference (for example,
2000.TL2).
Rate ($/hr) This field is used to set the hourly rate for the TL.
Remove Button
The Remove button deletes any highlighted entry from the Trend Log Dataview.
Minimum Charge The Minimum Charge drop-down menu sets the minimum
time charge for transactions. This menu has the options 0, 5, 10, 15, 30, or 60
minutes, or enter a value of 0 - 6000. These amounts are displayed in the Tenant
Billing Report. For example:
Note: Access Configuration Report templates show how specific objects are
configured. Instead of going to a specific object, or group of objects, to see the
configuration, a report can be generated for that object or group of objects.
Devices
The Devices section contains three options for selecting object filter criteria for
individual devices or a range of devices. These fields are the same as the fields in
the Query report Setup tab.
All Devices Selecting All Devices filters for criteria related to all Version 2,
and all BACnet devices. If All Devices is selected, the query report displays
results from all devices that meet the object filter criteria.
Area Selecting this option enables the Area, System, and Subnet drop-down
menus, and allows the selection of devices based on the Area-System-Subnet
(DNA) architecture. Only BACnet devices are listed in these menus.
When an Area device is selected, the System drop-down menu shows all the
System devices under that area. Selecting All Devices from the System drop-down
menu generates reports on all devices in that Area.
If a specific System device is selected, the report is generated on all devices under
that system.
When a System device is selected, the Subnet drop-down menu contains all the
Subnet devices under that System. Users can generate a report on a single subnet
device by selecting a device in the subnet drop-down menu.
Note: If there are no applicable devices for the drop-down menu, that specific
drop-down menu is disabled.
Specific Selecting Specific filters for specific devices or device ranges. Some
examples of acceptable entries are:
• 23000
• 23000 - 40000
• 40000
• 23000, 30000 - 45000, 60000
Object Filter
The Access Configuration report template selected limits what information can be
entered into the Object Filter field. For Example, if the report style selected is
Schedule Configuration, then the object filter only applies to the SCH object (e.g.,
*=ON shows only the SCH objects that have an ON state).
Layout/Destination
The Layout/Destination Tab is used to customize report templates, configure
automated report generating schedules, and to choose report destinations.
Name
The Name field displays the name of the monitored object.
Title
The Title field is used to include descriptive information about the report. This
field only applies to Query Reports and Access Reports. When creating a new
RPT object, the RPT object name is filled into the Title field by default.
Notes
The Notes field is used to enter descriptive text into the heading area of a Query or
an Access Configuration report. For Tenant Billing reports, the text appears in the
Notes box. The maximum number of characters that can be entered is 254.
Footnote
The Footnote field is used to enter descriptive text at the end of a Query, Tenant
Billing, or Access Configuration Report. The maximum number of characters that
can be entered is 254.
Triggered By
The Triggered By field is used to enter an object reference, which can then
generate reports automatically. When the referenced object transitions from a
False state to a True state, a report is generated and sent to the chosen
destinations.
Destinations
The Destinations area is used to select where and how a report is sent. The Add
and Edit buttons are used to select and modify the destinations for the reports. The
Remove button is used to remove any of the report destinations no longer needed.
Add
The Add button is used to add a new destination. When selected, the destination is
displayed in the Destinations list area.
The Type drop-down menu contains three options: Printer, File, and Email.
Selecting these options determines which fields are available.
Printer When Printer is selected as the destination, the dialog shows all
available printers connected to the system.
File When File is selected as the destination, the dialog displays a Save As…
button which is used to select the desired file format and storage location. The
default is “C:\Programs\Delta Controls\3.30\Sites\[Site Name]. When entering the
filename, the correct file extension must be used (pdf, rpt, csv, tsv, xls, htm, doc,
xml) or an error dialog appears.
Note: For files generated automatically, a suffix needs to be added to the report
name to prevent any previous reports from being overwritten. To create the suffix
a notation is used. These notations add specific information to each file name.
Multiple notations can be added to file names (see Add the Time), and these
notations can be used in any order. The Add an Invoice Number is used for Tenant
Billing only. When entering a file name the following notations are used.
Email When Email is selected as the destination, the dialog displays the address
fields and a Format field, as shown in the following figure. Format choices
include: Acrobat, Crystal Reports, Comma Separated Values, Tab Separated
Values, Excel, Word Document, HTML Document, or XML.
Edit
The Edit button is used to make changes to any selected destinations. Once a
destination is selected, click Edit to open the current destination settings and make
any required changes.
Remove
The Remove button is used to select, and then remove a report destination.
Description
The Description tab provides the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
Devices
This tab has a Dataview which lists devices that are currently communicating with
the controller.
In the first entry on the following screen capture, the network number is 20004
indicating communication with system controller 4 (400 DNA address) to the
Lighting Controller 9 (409 DNA address).
Device Number
Lists the device number of each device which is communicating with the
controller. BACnet allows the range of the Device Number to span between 0 and
4,194,302
MAC Address
This is the physical address of the device.
The format of the MAC address differs depending on the physical media used by
the device (Ethernet, MS/TP ...). The first digit which is enclosed in brackets
indicates the length of the MAC, in bytes.
Network Number
This value refers to the BACnet network that this controller is connected with
locally. The range of this number is 1 to 65534. Essentially, all other controllers
which have the same Local Network Number can be considered to be on the same
'logical' network.
Routing
This tab has a Dataview which lists information about routing. The Dataview has
three heading labels:
Network Number
Lists the network number of devices which are performing routing functions. The
range of the Network Number is 1 to 65534.
MAC Address
This is the physical address of the router which the controller uses to reach this
network.
Port
This value is the port from which the network is reachable. The values range from
1 to 8, and correspond to the Port numbers in the Net object.
Description
The Description tab is provided for the user to add descriptive comments. The
field can contain up to 2000 printable characters and has no bearing on the
execution of this object.
Note: The term Value or Schedule Value is used to describe the value property of
an object, defined according to a definition specific to Delta Controls.
Present_Value is the name used to describe the value property as defined in the
BACnet standard. They are interchangeable for the purposes of the Schedule
Object.
Schedule objects have two types of schedules: regular weekly and exception. Both
types can cover either a whole or part of a day. The Weekly Schedule is defined
on a standard Sunday to Saturday calendar. Exception Schedules can be set to
occur on recurring days, or on specified dates of the calendar year. Both types
function together, and allow partial day scheduling, where both types can specify
scheduling events on the same day.
Partial day scheduling can designate partial day, full day, or recurring exceptions
to the normal occupancy hours of a building based on calendar dates. Partial day
scheduling is sometimes called Event Scheduling and is a simplified way to
manage the many schedules and exceptions required for larger facilities. Operator
effort is reduced as it is not necessary to frequently revisit the SCH to make
adjustments when unique Events come up. When an Event is passed, the
occupancy hours revert back to normal and the Event is deleted.
The Schedule object includes a header, and four tabs. The Main tab provides a
way to define graphical time blocks using a calendar style interface. The Setup tab
is used to configure controlled objects and the Schedule Default value. The
Details tab shows the underlying data as a list of Time / Value pairs. And the
Description tab is a simple text box where a description of the schedule can be
written.
Schedule Types
The Schedule Type determines which type of objects can be controlled by the
Schedule. A Schedule is able to control three types of objects. Once one data type
has been chosen, only that data type will be used. While the Schedule can control
any number of objects, the objects must all use the same data type.
The type of object that is controlled by the Schedule determines the possible
Values that can be assigned to the Schedule.
Header
The header displays basic information about the Schedule. This includes the
current Present Value, an Auto/Manual Mode button, and the Controller
Time/Date. Icons indicate if the Schedule is controlling HVAC, access and/or
lighting objects. Additional icons may also appear to indicate status changes.
Mode
A Schedule can either be in Auto mode or Manual mode. Click the hand icon to
switch between modes.
Auto The Present Value, or state of the Schedule Object, is set automatically,
based on the defined times and the exceptions set out in the current day in the
Schedule.
Manual The Present Value is set manually. Use this feature to test the response
of a program to the Schedule Object, or to temporarily operate equipment outside
the normal time settings in the schedule. The scheduled times and exceptions
outlined in the Schedule Object will not apply when in manual mode.
Schedule Value
The Schedule Object Value (Present Value) can be binary (ON/OFF), analog
(-65534 to + 65534) or multistate (1 to + 65534), depending on which objects are
controlled by the Schedule. A Schedule can control only one type of object, so a
Schedule configured to control binary objects cannot also control analog objects.
A specific value can be assigned to any time period, either as a regular weekly
schedule, or as part of an exception schedule. As long as the Schedule Object is in
Auto Mode, the Schedule Value will equal the value assigned for the current
Controller Time, first by the highest priority Exception Schedule, then by the
Weekly Schedule, and finally by the default value if neither of the first two are
available.
Note: Click the Hand icon to return to Auto Mode. The Value immediately
changes to reflect the value assigned by the current Exception or Weekly Schedule
if one applies. Otherwise, it returns to the Default Value.
HAL Icons
The HAL icons indicate which system the Schedule is a part of. HAL is an
acronym for HVAC, Access, and Lighting. This can be used to limit some
operators from having access to some Schedules. Operators who only have
permission to access HVAC equipment can be limited to only viewing Schedules
which control HVAC objects. This is connected to OWS security.
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Status Icons
These icons may appear in the upper right area of the object dialog, indicating the
status of the object. No icon appears if the object is functioning normally.
Icon Meaning
The Fault Notification icon indicates that the object is in fault.
The Alarm Notification icon indicates that an external alarm has been
triggered.
Tabs
There are four tabs that can be selected from the Header.
Main The Main tab is a calendar view for editing and scheduling Weekly and
Exception values.
Setup The Setup tab is used to identify Controlled Objects, HAL systems, and
the default value for the object. The Schedule can also be renamed from this tab.
Details The Details tab is a listed breakdown of the Weekly and Exception
Schedules.
Main
The Main tab is the primary interface for inputting Weekly and Exception Values.
It displays a standard weekly calendar, which can be scrolled to display any future
or past date. Scheduled times are visible on the calendar as color coded blocks of
time. A legend explains the color.
The current time is identified with a thin yellow bar on the calendar.
Legend
The legend is in the upper right area of the Main tab. When you hover over the
icon, the legend appears and the meaning of the different colors can be seen.
Selecting a Week/Date
There are multiple ways of selecting a specific date or week on the Schedule
calendar. The calendar will always display a Sunday to Saturday week.
3 Click on a specific date on the calendar. The arrows can be used to scroll to
different months.
4 The calendar updates to show the Sunday to Saturday week that contains the
selected date.
Or
2 The specified day and time period appears by default. The time is rounded to
the half-hour. If required, adjust the day(s) of the week and time period.
3 Input the desired Schedule Value in the Value field.
4 Click Add to save the Schedule.
Note: For more detailed information about Weekly and Exception Schedules, see
Weekly/Exception Schedules.
Exception Types
There are five Exception Types to select from.
Single Date Create an Exception Schedule for a single day of the year, i.e.
January 15th, 2012.
Date Range Creates a Schedule for a single date range, i.e. May 2nd – May 5th,
2012.
Recurring Week & Day Creates a Schedule for a recurring day or week. This
could vary from a specific day of a specific month, or a particular week of every
month.
Recurring Date Creates a Schedule for a specific date, which recurs regularly,
i.e. Christmas day.
Weekly Schedule
A Weekly Schedule is used for regular tasks like turning the lights on in the
morning or operating an HVAC system on weekdays. These Schedules can occur
on one or more days every week.
Month
Select the month when this Schedule is active. This can be a specific month, every
month, or odd/even months (where January is considered #1).
Week
Select the week when this Schedule is active. Choose between every week, the
first-fifth week, or the last week (of the selected month(s)).
Day
Select the day of the (selected) week when this Schedule is active. Choose
between a specific day, or every day of the week.
Priority
If multiple Exception Schedules overlap, and are active at the same time, the
Schedule with the lowest Priority number will be used to determine the Present
Value of the Schedule Object.
Start Time
This field displays the time when the Schedule Object will set the Present Value to
the set value.
End Time
This field displays the time when the Schedule Object will set the Present Value to
the default value.
Value
Identify the desired value that will be set as the Present Value (Schedule Value)
during the identified time.
Description
Give the Exception Schedule a description to explain why it was created.
• Year – type in a specific year, or select Every from the drop down menu by
clicking on the down arrow.
• Month – select the specifc month, or select every, odd, or even months.
• Day – select the specific day, or select every day, or the last day of the month.
• Day of Week – Select a specific day of the week, or every day of the week.
Note: If Every year is selected, and no Day of Week is specifically selected, the
Day of Week will automatically change to Every when Add is clicked. If a Day of
Week is selected, then the Schedule will only apply to years when the specified
date also occurs on the specified Day of Week. If the Schedule is being updated to
Every year after it has been added to the calendar, make sure to select Every Day
of Week, or it not correctly update to Every year.
Start Time
This field displays the time when the Schedule Object will set the Present Value to
the set value.
End Time
This field displays the time when the Schedule Object will set the Present Value to
the default value.
Priority
If multiple Exception Schedules overlap, and are active at the same time, the
Schedule with the lowest Priority number will be used to determine the Present
Value of the Schedule Object.
Start Time
This field displays the time when the Schedule Object will set the Present Value to
the set value.
End Time
This field displays the time when the Schedule Object will set the Present Value to
the default value.
Value
Identify the desired value that will be set as the Present Value (Schedule Value)
during the identified time.
Description
Give the Exception Schedule a description to explain why it was created.
Calendar Instance
The instance specifies the name of the Calendar object that is linked to the
Schedule object. Use the drop down list to select the correct Calendar Object.
Priority
If multiple Exception Schedules overlap, and are active at the same time, the
Schedule with the lowest Priority number will be used to determine the Present
Value of the Schedule Object.
Start Time
This field displays the time when the Schedule Object will set the Present Value to
the set value.
End Time
This field displays the time when the Schedule Object will set the Present Value to
the default value.
Value
Identify the desired value that will be set as the Present Value (Schedule Value)
during the identified time.
Description
Give the Exception Schedule a description to explain why it was created.
Modify Schedule
The Modify Schedule dialog is displayed when a Schedule is double-clicked. Each
dialog is unique to the type of Schedule. The Schedule can be modified or deleted
from this dialog. The Next and Prev arrows are used to scroll through the different
Schedules, as long as they are of the same type. A Weekly Schedule will not scroll
to an Exception Schedule, just as a Single Date Schedule will not scroll to a
Recurring Date Schedule.
• Click Advanced to view or modify the Time/Value Pairs for the week.
• Click on the desired field to modify the contents. Type cannot be modified.
• Double click the blank line at the very bottom of the list to define a new
Time/Value pair.
• Click Apply or Ok to save the changes.
• Click Advanced to close the Time/Value pair dialog.
Setup
Name
The Schedule name is identified in the Name field. Modify it if needed, but ensure
that the Schedule has a unique name from all other objects on the controller.
Reliability
The Reliability field is used to provide status notifications. If a problem is
detected in the Schedule object, it will be displayed here and a Wrench Icon
appears in the dialog box header. No Fault Detected indicates that there is no
problem.
The drop-down list is used to set Reliability in Manual Mode; however, only one
of the following appears in Auto Mode: No Fault Detected, Configuration Error,
and Other Fault.
Default Value
This field holds the value that is used when no scheduled value is in effect. This
value will usually be OFF or 0 by default.
Effective Period
When the Specify Start Date and Specify End Date checkboxes are selected, a
specific start and stop date range for when the Schedule object is in effect can be
set. If these boxes are unchecked, then the Start Date and End Date will default to
No Start Date and No End Date.
Controlled Objects
This field specifies the objects controlled by the Schedule. When the value of the
Schedule changes, it changes the values of the objects to match the Schedule
value. Objects in remote controllers can also be controlled. If an object with a
property is specified, then it must be able to accept a write value of the specific
data type.
As a part of OWS security, these checkboxes can be used to limit which objects
are visible to an operator. For example, a site may have separate operators for the
HVAC and Access applications. It is possible for each operator to only see the
objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
Manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog
box. The three application domains are:
Details
The Details tab can be used to review the various Schedules created on the
Schedule Object.
Raw Data
The Raw Data window displays a list of all Weekly and Exception Schedules
created on the current Schedule. The Weekly Schedules are listed from Monday to
Sunday, and includes the time and value for each entry.
The Exception Schedule list includes all types of Exception Schedules, listed in
order of occurrence. The left window includes the Exception type, and applicable
date(s). The right window displays the time and value.
Details
The Details section displays the next Schedule that will be occurring, and the
previous Schedule that most recently passed.
Exceptions
The Exception field displays the total number of exceptions on a Schedule. The
upper limit is 100.
Description
The Description tab is used to explain the purpose of the Schedule Object. In
some cases, multiple Schedule Objects may be created, and the Description can
help identify why each was created.
The description field may contain up to 2000 characters. The character string is
limited to any printable character.
An MS/TP slave device cannot send network responses and as such cannot
respond to network requests. This means that a slave device cannot be
automatically found. Therefore any device that needs to communicate with a slave
device must be manually configured.
The Slave Device List tells other devices that there is a slave device at a particular
address.
The previous figure shows an MS/TP MAC address 34 on net 20031 that is
entered as:
Net20031,34
The MS/TP Slaves tab of the BCP or NET object on the local controller would
automatically include the Slave Device List entry shown in the previous figure.
MS/TP Slaves
This tab has a Dataview which lists information about slave devices. The
Dataview has five heading labels:
Device Number
Enter the device number of the slave device in this field. BACnet allows the range
of the Device Number to span between 0 and 4,194,302.
Segmentation
Refer to the slave device’s documentation to determine what level of
segmentation the device supports, if any.
Vendor ID
This field indicates the manufacturer of the slave device. Refer to the slave
device’s documentation to determine the vendor ID to use. If the vendor ID is not
specified in the documentation, use 0.
MAC Address
This field contains the network number and MAC address of the slave device. The
MAC address is not the device number; it is the physical MS/TP address. Refer to
the slave device’s documentation to determine the MAC address for the device.
Caution: The MAC Address field uses a format that requires care and
attention when entering its value. First enter a valid network number
followed by a comma and then the MAC address for the particular device.
The format of the MAC address differs depending on the physical media
used by the device (Ethernet, MS/TP ...).
Entering a MAC Address The value for this field begins with a network
number, followed by a comma and then the MAC address. For example, a MAC
address on network 2321 would start out with NET2321. The following examples
use network 50:
For example, the Structured View could provide a simplified view of zone
controller and Access Control architecture targeted towards the needs of an
operator such as security guard.
Description
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters long. The length of a name is from 1 to 255 characters on a DCU or an
OWS and from 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Node Type
This field provides a general higher-level classification of the object within the
hierarchy of objects. The following choices are available in the list.
Node Subtype
This field contains an optional string of printable characters. It describes the node
and provides a way to further classify the object within the overall hierarchy.
Profile
This field defines the name of an object profile to which this object conforms. To
ensure uniqueness, a profile name must begin with a vendor identifier code in base
10 integer format, with a dash following it.
A profile defines a set of additional properties, behaviors and requirements for the
object beyond the basic BACnet specification. The BACnet standard only defines
the format of the names of the profiles.
Subordinates
Dataview
The Subordinates Dataview contains the Subordinates and Annotations columns.
Subordinates
This field defines the members of the structured view. It can include references to
child Structured View objects that allow multilevel hierarchies to be created. It is
important to reference a particular Structured View object only once in the
hierarchy.
Annotations
This field contains an optional text string description for each member of the
Subordinates list.
Header
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
descriptors located on the same controller.
Update Rate
Sets the time interval that the list of object is scanned to update the values. The
default value is 10 seconds with a range of 5 to 240 seconds.
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
Object Ref
The Object Ref field allows input for any valid specific local or remote objects. If
two or more objects in the network have the same name, the panel address appears
as the prefix of the objects name, otherwise the Object Ref is simply displayed as
the object’s name.
Value
Displays the Object Value of each listed object.
Units
Displays the Object Units of each listed object.
Flags
Displays the status of the specific object referenced in this entry.
Descriptor
Displays the descriptor or text name for the object referenced in this entry.
The SUA object is evaluated during a security check when logging in before
providing system access to an operator, and then determines Access Levels for
both BACnet and System Objects. Version 2 object permissions are set in a
separate User Access (UA) object.
The User (via the SUA object) resides in both the OWS and the Security Panel.
When creating the SUA object, it is created in both the OWS and the specified
BACnet and Version 2 Security Panel. When editing the SUA object, the changes
are only applied to the particular SUA object in the location that it was opened
from. For example, if you edit the SUA name in the OWS, then you must also edit
the SUA in the Controller to match.
The SUA object for the HMI has only three tabs: Description, Setup, and User
Data. The User Data tab has a number of fields that are specific to the HMI.
Common Header
The SUA in the controller and OWS will have a Status field.
Status
The status of the SUA is read-only and not editable by the user.
Logged Out The Logged Out SUA Status indicates that nobody is logged into
the system using this particular SUA. If someone is to log into the system using
this SUA, then the SUA Status must be initially be Logged Out.
Disabled A user with sufficient permissions to the SUA can set the User
Enabled field on the setup tab of the SUA to disable the SUA. When the SUA
Status is Disabled, nobody can log into the system using this SUA until it is
returned to the Logged Out state. The Status must be returned to the Logged Out
state by setting the User Enabled field on the setup tab of the SUA.
Security Locked When the number of Login Failures on the Login tab of the
SUA reaches the Login Maximum Failure setting, the SUA is locked, thereby
preventing anyone from logging in with this SUA. The Login Lockout on the
Login tab of the SUA is checked (True) and the SUA is set to Security Locked and
remains locked until any one of three conditions occurs:
Inactive If the current date and time within the BACnet Security Panel and/or
OWS is not within the Password Start Date and Password Expiry date specified in
the SUA, the SUA Status will be set to Inactive. The Password Auto Expire
checkbox must be enabled for the Inactive state to be valid. When the Status is
Inactive, nobody can log into the system with this SUA.
If the SUAs’ Status changes to Disable, Security Locked, or Inactive while the
SUA is Logged In, the SUA Status does not change until the SUA is Logged Off.
For example, if SUA1 is logged in, and the time and date within the BACnet
Security Panel is outside of the Password Start Date and Expiry Date, then the
SUA Status does not change until the SUA is logged off.
Last Logged In at
This field shows the last time and date the SUA Status was Logged In. In the PC it
shows the last time someone logged into the workstation. The time is taken from
the PC clock.
The SUA Status in the controller shows the last time that the SUA Status in the
controller was in the Logged in state. In this case, the time is taken from the
controller.
The SUA Status in the controller shows the last time that the SUA Status in the
controller was in the Logged Off state. In this case, the time is taken from the
controller.
Description
This tab contains the description field.
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
Name
Name is a character string that represents the Name of the user. It is compared
against the username typed in for login purposes. Both the Name and the
Password in the SUA object have to match the username and password entered in
the login dialog to successfully log into the system.
User Enabled
When this field is toggled to Disabled it will set the SUA Value to Disabled and
prevent anyone from logging into the system with this SUA. Toggling this field to
Enable will enable the SUA again and set the Status of the SUA to Logged Off.
When a new SUA is created, the User Enabled field is set to Enabled by default.
Security - Password
Password holds the password for the SUA. It is the character string that is used to
compare against the password provided by the operator. The Password is not
shown visually when the SUA is displayed. It is shown as a series of ‘*’ each
representing a character in the password. As characters are added to the password
or edited they also appear as ‘*’.
• Maximum 14 characters
• Forced to be Uppercase
• Only Version 2 acceptable characters are accepted. Do not use characters
such as ( \ /:*?"< >| ).
• Minimum 4 characters
These restrictions are in place to keep the SUA compatible with the Version 2
User Access object (UA).
The Password Auto Expire occurs if the current date and time within the Security
Panel is not within the Password Start Date and Password Expiry date. The SUA
Status will be set to Inactive. When Inactive, no one will be able to log into the
system with the Inactive SUA.
To get it out of Inactive, a user with sufficient permissions to the SUA must set
the Password Start Date and/or Password Expiry Date so that the current date is
within these two values or turn the Password Auto Expire off. Once the user has
done this and applied the changes the SUA Status will be set to Logged Off.
The default value for the Password Auto Expire is unchecked (Off).
The Menu (MN) object basically allows the organization and formatting of
functions to be interfaced and displayed on the LCD Keypad.
Object Security
Provides a way to select an optional Object Security Restrictions (ORS) object
from a list.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
User Data
This tab contains information about the user and some of the settings for the user
when using ORCAview.
Alarm Filter
This field is used to specify an Event Filter (EVF) object for this SUA. By default,
the Alarm Filter field is blank and Alarms Notifications are not filtered out for this
user. The user will receive Alarm Notification for all Event Classes.
If an Alarm Filter field has an Event Filter (EVF) object specified, then Alarms
Notifications are filtered. The user will not receive Alarm Notification for the
Event Classes listed in the EVF object.
For details on the Event Filter object, see Chapter 5 Event (Alarms) Management
System of the Technical Reference manual.
Disable Navigator
This field is used to disable Navigator for a user. The user would typically use a
site graphic to access the system. The Disable Navigator checkbox is unchecked
by default when an SUA is created. The default allows Navigator to display for a
user.
When this field is checked, the user must log out of ORCAview and then log back
in again for the change to take effect. When the user logs in, only the ORCAview
Dashboard (main toolbar) is visible. The user cannot see Navigator or any
controllers through Navigator. The ability to create multiple instances of
Navigator is disabled in the Tools menu.
Disable Illustrator
This field is used to disable the Illustrator drawing tool for a user. The Disable
Illustrator checkbox is unchecked by default when an SUA is created. The default
allows Illustrator to operate in either the Run or Edit mode.
When this field is checked on the user's SUA in the OWS, it is necessary to log
out of ORCAview and then log back in again for the change to take effect. When
the user logs in, the ORCAview Dashboard and Navigator window is visible but
the Illustrator options are unavailable. A site graphic drawing may be opened but
the Illustrator is only available in the Run mode and not in Edit mode.
Once checked, if an alarm goes off, the user does not see a pop-up alarm
notification. Alarm notifications can still be monitored from the Active Alarms
Folder. To disable alarm pop-ups, a checkmark must be placed in this field for the
SUA object on the local OWS only.
Once checked, the user does not see a pop-up window when a server message is
received. Typically these messages relate to network issues. To disable server
messages, a checkmark must be placed in this field for the SUA object on the
local OWS only.
Process ID
The field displays the numerical ID for the user. This ID is used as the Process ID
in alarm acknowledgements to identify the user that acknowledged the alarm. The
information is provided for use with 3rd party products that only allow the
acknowledgement of alarms by Process IDs that the alarm has been directed to. In
these cases, this value should be used in the Recipient List of the Event Class
object in the 3rd party device.
If HMI Login Required is checked (enabled), this field defines the first graphic to
display on the HMI touch screen after a particular user logs in if a Starting graphic
is not assigned to that user. If HMI Login Required is unchecked (disabled), this
field defines the default start graphic for all users after the device starts up. All
graphics that are stored in the HMI are listed in the dropdown box. The order of
the list is based on FIL object instance. (Site graphics are saved as FIL objects on
the HMI device).
If HMI Login Required is enabled (enabled), this graphic displays before the user
logs in or after the user logs out. All graphics that are stored in the HMI are listed
in the dropdown box. The order of the list is based on FIL object instance. (Site
graphics are saved as FIL objects on the HMI device).
Note: The Refresh Rate for Objects field is not currently used by HMI. It is
reserved for future features.
Language
This indicates what language OWS will operate in for this User. This tells the
OWS what language to use in when this User logs in to the system. This property
is a list of the supported languages.
Note: This field is not currently used by HMI. It is reserved for future features.
Starting Screen
The Starting Screen is the name of the graphic that is opened each time this user
starts ORCAview. ORCAview will look in the Default graphic path for the logged
in site specified in ORCAview Settings. A path must be supplied along with the
graphic name if the graphics are located somewhere other than the default
graphics path.
Full Name
This field is used to keep track of the user’s actual name.
It is a character string that has the same restrictions as the Description field.
E-mail Address
This field is used to enter the user’s email account if they have one, and may also
be used for event paging by the Event Router.
It is a character string that has the same restrictions as the Description field.
Phone Number
This field is used to save the user’s phone number and may also be used for event
paging by the Event Router. The Phone Number can be used for the TAP Gateway
(in the EVR).
It is a character string that has the same restrictions as the Description field.
Fax Number
The user’s fax number will be saved in this field.
It is a character string that has the same restrictions as the Description field.
Pager Number
This field is used to save the user's pager number and may also be used for event
paging by the Event Route.
It is a character string that has the same restrictions as the Description field.
Cellular Number
The user’s mobile phone number.
It is a character string that has the same restrictions as the Description field.
Login
This tab contains information and setup for logins and logouts.
Device This field shows the name of the last device (OWS) that logged in using
this SUA. This field is read-only.
Network Inactivity Time If ORCAview stops running and the Delta Server
continues to run, then the system may not let the user log in again. The system
thinks that the user is already logged in.
This field counts up to 5 minutes for network inactivity, checks to see if the user is
still logged in, the system then waits another 2 minutes and logs the user out.
ORCAview automatically pings each security panel every 5 minutes to ensure that
a connection exists. After the Network Inactivity Time Setting (7 minutes), the
user can log in again.
Network Inactivity Time Setting This is the time that the device will wait
for a response from the workstation before setting the SUA to Logged Out. The
field defaults to 7 minutes and cannot be changed. There is a 2 minute delay in
addition to the Network Inactivity Time default count time of 5 minutes, to ensure
that there is sufficient time to complete any network activity.
Failures This is the field where the consecutive failed login attempts are
displayed. A failed attempt is defined as the username and password that was
specified in the login dialog does not match an SUA in the OWS and/or the
controller.
Once a successful login has been established this will reset the Failures to 0.
Once Failures is equal to the Maximum Failures then the SUA Status will be set to
Security Lockout for the specified Login Lockout Period.
Maximum Failures This field is used to specify how many consecutive failed
login attempts will be allowed before the SUA Status is set to Security Lockout.
Login Lockout
Date This field displays the time and date that this SUA was locked out due to
Failures becoming equal or greater than the Maximum Failures.
Lockout This field is used to unlock an SUA that is in the Security Lockout. If
this field is unchecked (Unlocked) the SUA will return to the Logged Out state. It
can also be used by a user with edit access to the SUA object to lockout an SUA,
by checking (Locking) this field.
Period This field is used to specify the period for which the SUA State will be
set to Security Lockout. The Period is specified in minutes and must be a whole
number.
If the Period is set to 0 then the SUA State will be set to Security Lockout
permanently. The only way to get an SUA out of this state when Period is set to 0
is for an SUA with Edit access to SUA objects to uncheck the Lockout field.
Auto-Logoff
Period The Auto-Log off period is the amount of time that ORCAview will sit idle
before automatically logging off of the network. You can disable this feature by setting
the period to 0. In order for any changes in this field to take effect, you must log out then
log back in to ORCAview. The default Auto-Logoff period is 10 minutes.
Object Overrides
This tab is used to define the Object Access Exceptions for the user. User specific
exceptions are set to the Access Levels for BACnet Standard and System Objects.
The settings here override the SUG settings for that object.
Security Group
The Security Group drop down box allows the user to be linked to a Security User
Group (SUG) object. Once linked, that SUA object inherits all the SUG
permissions.
The Objects field allows input for any BACnet Standard and System Objects.
The Access Level field has a drop down box that appears when you click in it.
The drop down displays six different Access Levels which are in top down order
from most restrictive to least restrictive.
When entering object restrictions based on the same object type, the most
restrictive entry will take precedence. The order in which the entries are created
does not affect the restrictive precedence with one exception.
The exception to the ordering of restrictions occurs when there are duplicate
entries in the table. With duplicate entries, the first (top) entry takes precedence.
Least restrictive
Most restrictive
What will happen in the example picture above is the first entry *. AV* will set all
AV (Analog Variable) objects on every controller including the local OWS to the
Nothing access level. Because the second entry 300.AV* is a more specific or
higher restrictive entry it will take precedence. So on panel 300, Analog Variable
15 will have Command access and any other AV objects on controller 300 or any
other controller will have Nothing access.
Note: Setting an Access Level to nothing in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of Nothing, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to Nothing, the user will not
have any access to custom views.
The SUG object has the ability to set restrictions for a group of users in three
different ways:
• Restricted Device
• Object Application Restriction
• Object Access Permissions
Description Tab
This tab contains the Description and Name fields
Description Field
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
The order of precedence for the fields on the Object Security tab from highest to
lowest are:
Example:
To restrict devices ranging from a software address of 100 to 600, double click on
the Dataview row under Device Range and enter:
DEV100 - DEV600
Note: Note: Exceptions cannot be made for a restricted device. For example, if
you make controller 100 restricted, then you cannot make an exception for a
specific object in the SUA on that controller as Device Restrictions have the
highest level of precedence.
Object Application Restrictions have the second highest precedence after Device
Restrictions. Applications Restrictions, like Device Restrictions, cannot be
overridden by Object Permissions Exceptions on a SUA object.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Object Access Permissions have the lowest level of precedence. They can be
overridden by Object Permission Exceptions entered in a SUA object.
In the previous graphic, the following restrictions are set in this SUG object:
• Under Object Application Restrictions, the users cannot view any Access and
Lighting objects.
• The 100.AI1 object has command access,
• 100.AO2 has Edit/Modify access and
• The user has no access to Device 900
The user has full access to all HVAC objects or objects that have no application
restriction except 100.AI1 and 100.BO2. The user will have command access to
100.AI1 and Edit / Modify access to 100.AI1.
Note: Setting an Access Level to nothing in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of Nothing, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to Nothing, the user will not
have any access to custom views.
If you upgrade from 321, 322 to 330, 333, the 8 default SUG objects are not
created.
To use these objects on a BACnet Security Controller, they must be copied from
the OWS to the Security Controller. If no BACnet Security Controller is specified,
then the objects do not need to be copied and can be access directly on the OWS.
The eight default SUG's fall into three pre-configured categories; Administrator,
Programmer and Operator. Programmer and Operator are then broken down into 3
sub categories; HVAC, Access and Lighting.
The Administrator SUG will have full access to all controllers and their associated
objects.
The Programmer SUG objects are configured so that the appropriate access is
given to the objects that a Programmer would use. Also, because there are three
different programmer SUG objects, the Administrator can assign the user the
HVAC, Access, or Lighting permissions depending on the area of the BACnet
Network the Programmer is working on. This same approach is applied to the
Operator SUG objects.
The eight default configurations are there to provide the Administrator a starting
point when setting up BACnet Object Security. These objects can be modified to
better suit the application or can be deleted if not needed.
Polled TLs collect new data samples based on a time interval, which can be set by
the user. This time interval is called the Log Interval. By default, a new TL will
have a Log Interval of one minute, which means that a new data sample will be
taken every minute.
The Archival Buffer Notification Setup enables a notification to occur once a set
threshold of samples has been recorded. This functionality can be used to perform
automated archival of trend data to prevent data loss.
Historian Note: V3.40 now supports multiple Historians on one site and as a
result this Archived checkbox is not editable and is grayed out. The Archived
checkbox was available in 3.33. In V 3.40, you must select a TL, or group of TL's,
from a selected controller in the right pane of Navigator and then right click. From
the menu, select the Command option and click on Add to Historian.
Header
While a Trend Log is in “Enabled” mode, the object collects data samples and the
current date is between the Started Trend At date and the Stop Trend At date.
When a Trend Log is in “Disabled” mode, the object goes into auto shutdown.
This prevents existing data samples from being overwritten. When in Disabled
mode, the user must manually set the object to “Enabled” to start trending again.
Started Trend At
If the TL is set up to start archiving at some time in the future, this field is visible
and shows the scheduled start time.
Stop Trend At
If the TL is archiving and is set up to stop archiving at some time in the future,
this field is visible and shows the scheduled stop time.
Samples
This field displays the current number of data samples stored in Historian’s data
buffer.
Graph
The Graph tab contains a visual representation of the monitored object.
The graph plots the object’s value on the Y-axis, against time, which is on the X-
axis. The two axes are automatically scaled to best fit the available data. The
graph provides a fixed, 200 sample width. Only the most recent 200 samples are
graphed, regardless of how many samples the Trend Log is capable of storing. In
order to see the full set of data, use the Multi-Trend (MT) object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security.
When a checkbox is selected, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Monitored Object
The Monitored Object is the object that is being trended. Any analog or binary
value can be trended. By default, the value property of the monitored object is
trended. If a property name is specified, then that property is monitored. For
example, 9100.AI1 Commissioned, would trend the commissioned flag of this
analog input object.
The result of this procedure is that the Historical TL that archived the TL in its
original configuration becomes detached, and a new Archive TL is created
according to the new monitored object.
Historian Note: Detached Trend Logs — If the source TL (of an Archive TL) is
deleted, or the monitored object is changed, or the archived checkbox is cleared,
the associated Archive TL becomes detached. Detached TL’s are set to “Disabled”
and do not collect new data, but they do keep all the data they have accumulated.
Log Type
Change of Value Change of Value TLs use the monitored object’s Change of
Value (COV) minimum increment to determine when a new sample should be
taken. When the monitored object’s value changes by more than the COV
minimum increment, a new data sample will be collected in the TL. All objects
default to a COV minimum increment of 1.0, but this can be changed on an
object-by-object basis.
Polled Polled TLs collect new data samples based on a time interval, which can
be set by the user. This time interval is called the Log Interval. By default, a new
TL will have a Log Interval of one minute, which means that a new data sample
will be taken every minute.
Historian Note: Changing the Log Type field in a TL that is being archived may
cause Historian to change the manner in which it archives the TL’s data samples.
See the following table for details.
Log Interval
This is the amount of time between polled samples. The log interval can be set
from a minimum of one second, to a maximum of 23:59:59 hours.
If a TL is polling a remote object, then the time should not be set to less than 30
seconds as remote data exchange cannot achieve intervals faster than once every
30 seconds.
Historian Note: When the Log Interval is altered in a TL that is being archived,
the change affects how frequently Historian archives data samples from the source
TL.
Daily Checkbox
When the Daily checkbox is enabled, samples are taken once per day at a
specified time. The Daily sample time is determined by the Start Trend At
spinbox.
Max Samples
The Max Samples field is the maximum number of data samples that can be stored
in the TL’s data buffer. The range of this value is between one and 6000, with the
default being 100. The larger this number is, the more memory used by the
controller. As a rough guide, each sample takes about 10 bytes. Thus, a 100
sample TL would require 1000 bytes of memory. Obviously, not very many 6000
sample TLs (each occupying about 60,000 bytes) can be created in one controller.
Historian Note: Changing the Max Samples field affects the frequency at which
the Historian gathers samples if the TL is being archived. Increasing the Max
Samples value will improve Historian performance and help ensure the safety of
the data.
Total Samples
This number is the total number of samples that the TL has collected since it was
created. This field is read-only and cannot be reset.
Start Trend At
This field is used to specify the time and date at which the TL will start sampling.
When the checkbox is cleared, “No Start Date” will be displayed in the field and
the TL will start sampling immediately. When the checkbox is selected, enter the
desired start time into the field. The time format is HH:MM:SS.
When a new TL is created, the Start Trend At Date defaults to 00:00:00 Jan 2000
which is the base time. The Trend At date is enabled with no Stop Trend At Date.
When the start date is enabled, sample times are calculated using the Time Start
when Polling is used. The object calculates time interval on even periods if the
entered Start Trend At Time is divisible by 60 for minutes and seconds, or
divisible by 24 for hours. The Log Interval spin box allows a max of 23:59:59. If
you need to use a daily sample rate, you can enable the Daily checkbox beside the
Log Interval spin box.
The following examples show the behavior of the sampling for different entries:
• 00:00:00 15 min polling samples on hour, 15 minutes past, ½ past, and 45
minutes past hour.
• 00:00:10 15 min polling samples at 10 after hours, 25 minutes past, 40
minutes past, and 55 minutes past hour
• 00:00:00 1 Hour polling sample every hours on the hour
• 00:00:30 1 hours polling sample every hour at ½ past the hour
• 17:00:00 24 Hours polling sample every day at 17:00:00
• 00:00:00 2 hours polling sample at 0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22
• 01:00:00 2 hour polling sample at 1, 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23
If the sample time does not follow the rules of divisibility, then it is polled based
on the Trend Log start time or reset and simply counts the time period from this
start time. On Reset or DST/Time change, the new algorithm does not sample
immediately. It calculates the projected time for the next sample and then samples
at this time but cannot maintain the interval.
For example, a controller is reset at 12:30:30 and interval is 11 seconds. Then the
first sample will be at 12:30:41 the next and + 11 seconds so 12:30:52 instead of
being lined up on even intervals.
When the Start Trend At time is disabled, the Trend Log works in the standard
way. It begins taking samples on Reset/ Time Change/ creation of new TL and
then after the Polling Interval.
Stop Trend At
This field is used to specify the time and date at which the TL will stop sampling.
When the checkbox is cleared, “No End Date” will be displayed in the field and
the TL will never stop sampling. When the checkbox is selected, enter the desired
end time into the field. The time format is HH:MM:SS.
In V 3.40, you must select a TL or group of TL’s from a selected controller in the
right pane of Navigator and then right click. From the menu, select the Command
option and click on Add to Historian.
4 If there are multiple Historians installed on the site, select the particular
Historian that you wish to archive the selected trend(s) to.
The previous dialog only appears if the site has more than one historian.
5 When the trend is marked as Archived, the Setup tab will show that it is being
archived.
The Archived checkbox cannot be edited from the Setup tab of the TL.
The Reporting checkbox can now be disabled for DAC and DSC controllers.
Event Class The Event Class drop-down menu is used to select the
notification’s event class. The choices available will reflect the EVCs that are set
up in the controller.
Threshold The Threshold field is where the number of log entries recorded
before an event occurs is set. When the number of records has been exceeded, the
threshold count will be reset and an event will occur again once the number of
records exceeds the threshold value.
Records Since Last Notification The Records Since Last Notification field
displays the total of new records acquired by the TL since the last time an
Archival Buffer Notification was sent to Historian. This can be polling or COV
TLs.
Data
The Data tab is a text listing of the data in the TL’s buffer. Each entry shows the
time and date at which the sample was collected. The data is presented with the
newest data at the top of the list.
The Value column shows the value of the sample, which is displayed as a binary
value, 1 indicates On, and 0 indicates Off. Error and status messages are also
displayed in the Dataview. These are to aid with troubleshooting and will not
show up in the graph.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
Note: A Trend Log object will trend a maximum period of around 490 days or the
date-time information for the old data is lost. Any trended data or error/event data
that is older than 490 days is automatically removed from the TL on a weekly
basis. This does not apply to Archive TL’s.
Description
The description tab contains the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
Main
The Main tab contains the fields that allow you to define a specific Custom view.
Description
Description is a label or name for the View Groups as it will appear in Navigator.
This field should describe which objects are included within the View Group.
Physical
Each Dataview row in the Viewgroup has a Physical checkbox and descriptor
filter associated with it. The Physical checkbox allows you to filter objects by
either their descriptor name or by their physical object references.
To filter by descriptor for objects with names that contain the text "AHU1".
1 Uncheck the physical checkbox.
2 Under the descriptor column, double click and type in *AHU1*
3 Click Apply.
All objects with a name containing AHU1 will appear in the custom view folder
To filter by descriptor for objects with names that begin with the text "AHU1".
1 Uncheck the physical checkbox.
2 Under the descriptor column, double click and type in AHU1*
3 Click Apply.
All objects with a names beginning with AHU1 will appear in the custom view
folder
Descriptor
Each Dataview row in the Viewgroup has a Physical checkbox and descriptor
filter associated with it.
The Descriptor filter allows you to enter in the criteria for filtering objects. The
following are a few examples of filter parameters that can be entered under the
descriptor column.
If you plan to filter by descriptor, double click in the area immediately below the
descriptors. Type your filter using wildcards. For example, A* will place all
objects with descriptors starting with A in the folder.
Click Apply to record your filter. The folder will contain objects according to the
filter you typed.
With Physical checkbox Checked, enter a filter like one of the following
examples:
*.AV*
100.AV*
100.AV1
*.AV1
100.AV1
With the Physical checkbox Unchecked, enter a filter like one of the following
examples:
*AHU1*
AHU1*
*AHU1
Custom Views
The View Group (VGS) Object is used to create a custom view. Custom views
help to organize the information on your site. Custom views are stored on the PC.
They provide a quick way to display the status of any device that needs to be
checked regularly. You can sort information by area, by systems, by type, or by
almost any criteria you wish. ORCAview contains a set of sample custom views
that provide guidelines for users.
Custom Views sort the controller objects from the project into a hierarchy of
folders. The folders appear in the left Navigator pane in a tree structure.
Folders can contain sub-folders or objects. The folder contents are displayed in the
right hand Navigator window.
Filtering
The contents of the various folders in a custom view are sorted by filters. One or
more filters can be used for each folder. The different filtering methods are
described:
Filter by a character string to an object descriptor name.
Filter by object types such as inputs, outputs, programs and variables, Schedules,
and Zone Controllers.
The selected object can be filtered from a number of selected controllers or from
the entire network. In a large network a single device can be located by its
descriptor name.
A number of folders filtering a similar object type can be grouped together as sub-
folders under a main folder. These folders can be then named by category.
You open a Custom View whenever you need to display the selected object(s).
This provides a quick way to check the status of any device.
A Custom View folder can be exported to a directory as a cvx file. In turn this cvx
file can be imported to another folder as a sub folder or can be imported as the
root of a new custom view.
2. The New Custom View dialog box will appear. Type a name in the
Description field for your custom view.
3. Click OK. Navigator will display the newly created view. The new view
contains the default special folders, Active Alarms and Graphics.
In the example the following folders were added to the folder Group By Name:
Objects containing A
Objects on Panel 1 with A
Objects start with A, B, C
Also in the example, the following folders were added to the folder
Group By Object Type:
All Inputs
All Outputs
Program and Variables
Schedules
Zones and Controllers
2. In the Description field, type the new subgroup name, and click OK. In the
example, the new group name is Group by Name.
3. In the example, the new sub group is under the main Sample Custom View
folder. Create the sub folders required for your custom view.
4. You can add sub folders to your Custom View at any level. To add a sub
folder, right click any folder and select New Folder.
The instructions for creating various types of folders in the Sample Custom View
follow.
2. Double click on a row under the Descriptor column and type *A*. Click
Apply to accept changes and OK to exit. This folder will filter for all objects
with an A in their descriptor name.
3. In the Navigator Left Hand pane click on the folder Objects containing A. All
objects in the network with an A in their descriptor names will be listed in
Navigator Right Hand pane.
2. Double click a row under the Descriptor column and type 1.*A*. Click Apply
to accept changes and OK to exit.
3. In the Navigator Left Hand pane click on the folder Objects on Panel 1 with
A. All the objects in Panel 1 that have an A in their descriptor names are
listed in the Navigator Right Hand pane.
2. Double click on the 1st row under the Descriptor column and type A*.
3. Double click on the 2nd row under the Descriptor column and type B*.
4. Double click on the 3rd row under the Descriptor column and type C*.
5. Click Apply to accept changes and OK to exit.
6. In the Navigator Left Hand pane click on the folder. All the objects in the
Network that have descriptor names starting with an A or B or C, will be
listed in the Navigator Right Hand pane.
5. Double click on the 1st row under the Physical column to enable the
checkbox.
6. Double click on the 1st row under the Descriptor column and type *.AI*.
7. Click Apply to accept changes and OK to exit.
8. In the Navigator Left Hand pane click on the folder. All the input objects in
the Network, will be listed in the Navigator Right Hand pane.
2. To create a filter for All Output folder, right click on the folder and select
Properties from the pop-up menu. The Custom View Group dialog comes up.
3. Double click on the 1st row under the Physical column to enable the
checkbox.
4. Double click on the 1st row under the Descriptor column and type *.AO*.
5. Click Apply to accept changes and OK to exit.
6. In the Navigator Left Hand pane click on the folder. All the output objects in
the Network will be listed in the Navigator Right Hand pane.
To filter by object type for all the Programs and Analog Variables:
1. Right Click on the folder and select Properties. The ViewGroup dialog box
opens.
2. Double click on the 1st row under the Physical column to enable the
checkbox. Double click on the 1st row under the Descriptor column and type
*.PG*.
3. Double click on the 2nd row under the Physical column to enable the
checkbox. Double click on the 2nd row under the Descriptor column and type
*.AV*.
4. Click Apply to accept changes and OK to exit.
5. In the Navigator Left Hand pane click on the folder. As a result all the
Program and Analog Variable Objects in the Network will be listed in the
Navigator Right Hand pane.
To filter by object type for all the Schedules and Calendar Objects:
1. Right Click on the folder and select Properties. The ViewGroup dialog box
opens.
2. Double click on the 1st row under the Physical column to enable the
checkbox. Double click on the 1st row under the Descriptor column and type
*.SCH*.
3. Double click on the 2nd row under the Physical column to enable the
checkbox. Double click on the 2nd row under the Descriptor column and type
*.CAL*.
4. Click Apply to accept changes and OK to exit.
5. In the Navigator Left Hand pane click on the folder. All the schedule and
Calendar Objects in the Network will be listed in the Navigator Right Hand
pane.
To filter by object type for all the zones and controller schedules:
1. Right Click on the folder and select Properties. The ViewGroup dialog box
opens.
2. Double click on the 1st row under the Physical column to enable the
checkbox. Double click on the 1st row under the Descriptor column and type
*.ZC*.
3. Double click on the 2nd row under the Physical column to enable the
checkbox. Double click on the 2nd row under the Descriptor column and type
*.CO*.
4. Click Apply to accept changes and OK to exit.
5. In the Navigator Left Hand pane click on the folder. All the Controller (CO)
and Zone Controller (ZC) Objects in the Network will be listed in the
Navigator Right Hand pane.
To filter by object type for all modems and filter by descriptor names for all
objects starting with P:
1. Right Click on the folder and select Properties. The ViewGroup dialog box
opens.
2. Double click on the 1st row under the Descriptor column and type *.MD*.
3. Double click on the 2nd row under the Physical column to enable the
checkbox. Double click on the 2nd row under the Descriptor column and type
*.P*.
4. Click Apply to accept changes and OK to exit.
5. In the Navigator Left Hand pane click on the folder. All the Modem (MD)
Objects and objects with descriptors starting with P in the Network will be
listed in the Navigator Right Hand pane.
You could export a custom view, save it to a disk and then import it into a
different ORCAview workstation of the same version. This could save time if the
sites have similar objects.
Custom views can be exported and saved to the hard drive on the ORCAview PC.
They can be imported from the computer hard drive and recreated in ORCAview.
The custom view files can be emailed, copied onto floppies and treated like any
other file.
When a custom view folder is saved to the PC hard drive, all of the sub-folders
below the custom view folder are also saved. To save an entire custom view, it is
only necessary to save the top-most folder.
2. From the ORCAview Menu Bar, click File and then click Import.
3. In the Import Custom View dialog box, specify the file you wish to import.
4. To import as a new custom view, select Import as Root. To import as a sub
folder, select Import under the current folder. If no folder is selected in the
current custom view, only the Import as Root option is available.
5. Click Open.
See the Glossary enteliMESH section starting on page 10–794 for some
terminology.
Header
The Header has a dropdown that issues a Device Command based on the options
selected from the list. The status field provides information about the operation of
the device.
The following device commands are available from the dropdown in the header:
None – No command selected.
Pairing On - Commands Association ON. A deviceis allowed to join the
network. With Zones, it means that a subPAN device is allowed to join.
Pairing Off - Commands Association OFF. A device to not allowed to join the
network. With Zones, it means a subPAN device is not allowed to join.
Network Reset - Clears the current wireless network settings. The device goes
offline after this is complete.
Device Reset – Resets the device.
Flash Load (only valid on the eTCH WSD object). Use this feature from the
enteliTOUCH screen. (not supported by any released product)
Delete Sub-Devices - Remove subPAN devices from an application controller
(currently in development) without removing the application controller from
the network. (not supported by any released product)
Description
Setup
Name
This read / write field contains the name of the wireless object. The name must be
unique among the other descriptors located on the same controller. The name is
limited from 1 to 67 printable characters.
Reliability
This property provides an indication of the status of the object regarding reliability
of data. This field has limited function at present. This property will have one of
the following values at any given time:
Product
This tab contains wireless information such as the protocol and version. These
fields are all read-only.
Vendor
This is a read only field that indicates the manufacturer of the BACnet Device.
Vendor ID
This is a read-only field that indicates the unique vendor identification code
assigned by the ZigBee Alliance. This field is reserved for future use.
Model Name
This is a read-only field that indicates the model name of the BACnet Device.
Firmware Version
This is a read-only field that is assigned by the vendor to represent the firmware
version being used in the BACnet Device.
Hardware Version
This is a read-only field that indicates the specific model number of hardware.
Input Count
This read-only field shows the physical input count of all inputs on the ZigBee
device. The range is from 0 to 32 with a default value of 0.
Output Count
This read-only field shows the physical output count of all outputs on the ZigBee
device. The range is from 0 to 32 with a default value of 0.
Protocol
This tab contains wireless information such as the MAC address, and current
network address. These fields are all read-only.
Profile Name
This is a read-only field that indicates the name of the ZigBee protocol profile.
Protocol Version
This is a read-only field that indicates the specific protocol version number of the
communication protocol.
This read only field represents the major version number of the protocol that is
implemented by this controller.
MAC Address
This read-only field contains the MAC address of the device. The MAC address is
not the device number, it is the physical address. This is a unique 64 bit address.
Network Address
This read-only field contains the 16-bit ZigBee network address. The address is
assigned when the device joins the network.
Stats
Reset Count
This read-only field indicates the number of resets of the ZigBee device. The
range is 0 to 65535 with a default of 0.
Signal Strength
This read-only field indicates the signal strength in dBm. The range is 0 to 200
with a default of 0. A lower value indicates a stronger signal. A value of 70 or
lower is recommended for a stable wireless network. This field provides an RSSI
(Radio Signal Strength Indicator) calculation of signal strength.
Expired Timestamp
This read-only field displays the Timestamp that the device was last marked as
offline.
See the Glossary enteliMESH section starting on page 10–794 for some
terminology.
Header
The header has a dropdown that lets a user set the mode and also a Status field.
Join Mode
The Join Mode provides a means to add new devices to a wireless network.
Description
The Description field is unavailable for user comments on this object. You can
add information to the Description field but when the dialog updates, the system
removes the additional information.
Parameter Meaning
Replace Address Indicates the current number of entries in the device
table. A value of 255 indicates that feature is not
selected.
If a device is added from the enteliTOUCH, then the
Replace Address value changes and shows the
number of communicating wireless devices.
Flat Network Recovery Flat Network Recovery = 0
This is the default which is disable.
Flat Network Recovery = 1
The feature is enabled by setting the value to 1. It
then keeps track of the number of devices on the
network and if one goes offline, the enteliTOUCH
immediately tries to recover the device.
Setup
Name
This read / write field contains the name of the wireless object. The name must be
unique among the other descriptors located on the same controller. The name is
limited from 1 to 67 printable characters.
Reliability
This property provides an indication of the status of the object regarding reliability
of data. This field has limited function at present. This property will have one of
the following values at any given time:
Device List
Device
This read-only field contains the device name and 16-bit ZigBee network address
MAC Address
This read-only field contains the network number and MAC address of the device.
The MAC address is not the device number but it is the physical address. This is a
unique 64 bit MAC address.
Status
This read-only field indicates the status of a device listed in the Dataview.
Possible values are: Online, Offline and Not Joined
Status Meaning
Online Device is communicating over the
network in a normal manner.
Offline Device is not communicating over the
network for some unknown reason.
Not Joined Device has not been added to the
wireless network.
See the Glossary enteliMESH section starting on page 10–794 for some
terminology.
http://www.digi.com/technology/rf-articles/wireless-zigbee
The 802.15.4 specification upon which the ZigBee stack operates gained
ratification by the Institute of Electrical and Electronics Engineers (IEEE) in 2003.
The specification is a packet-based radio protocol intended for low-cost, battery-
operated devices. The protocol allows devices to communicate in a variety of
network topologies and can have battery life lasting several years.
If the ZigBee Wireless Card is listed in the Expansion I/O Boards list on the
Configuration tab, this indicates proper installation.
For the ZigBee wireless network to work, the Enabled checkbox must be selected
on the Setup tab of the ZBS object. The Setup tab on the ZBS is not directly
writable but must be set from the enteliTOUCH screen.
Header
Indicates the current operational status value of the object. The normal state is
Connected.
Description
The Description field is unavailable for user comments on this object. You can
add information to the Description field but when the dialog updates, the system
removes the additional information.
Parameter Meaning
ConfigurationMode ConfigurationMode 0
An entry of 0 indicates that the object is in runtime mode.
ConfigurationMode 1,
An entry of 1 indicates that the object is in configuration
mode and setting up the network.
Setup
Name
This read-write field contains the name of the wireless object. The name must be
unique among the other descriptors located on the same controller. The name is
limited from 1 to 67 printable characters.
Reliability
This property provides an indication of the status of the object regarding reliability
of data. This field has limited function at present. The normal state is No Fault
Detected.
Enabled Checkbox
This checkbox enables the ZigBee Wireless. For the ZigBee wireless network to
work, the Enabled checkbox must be selected.
Settings
The fields on the Settings tab are not writable but must be set from the
enteliTOUCH (eTCH) screen.
Channel ID
The ZigBee channel refers to the radio frequency that the wireless devices use to
communicate within a PAN. A Personal Area Network (PAN) is a collection of
cooperating devices which are associated and share the same address space or
PAN ID.
The enteliTOUCH can automatically determine what channel to use based on the
amount of energy detected on each channel in the ZigBee range. The ZigBee
channel can also be selected from the enteliTOUCH wireless setup screen.
Once the enteliTOUCH has determined the channel, each wireless device that
joins the network will automatically use this channel.
Pan ID
The PAN ID defines an address space shared by a collection of cooperating
devices which are associated. The range is from 1 to 255.
Operating ID
This field displays an internal ID that cannot be changed by the user.
MAC Address
This field specifies the MAC address of the device. The MAC address is not the
device number; it is the physical 8 byte HEX address. This is a 64 bit MAC
address. (Currently not fully implemented)
Statistics
Online Devices
This field indicates the number of communicating ZigBee devices. Each node can
have a number of subunits such as physical devices, sensors, or switches.
Received Packets
This field displays the total number of packets received from the wireless receiver
since the last controller reset.
Transmit Packet
This field displays the total number of packets sent from the Delta Controller
since the last controller reset.
Sent Failures
This field displays the total number of packets that failed to send out over the
radio since the last controller reset.
Response Failures
This field displays the total number of packet that the destination did not respond
to since the last controller reset.
Network Utilization
This field indicates the percentage of network load used. (Currently not fully
implemented)
GLOSSARY ENTELIMESH
Associate
Describes a routing relationship between wireless devices within a PAN. For
example, consider the case where a WNS (wireless sensor) uses an eM-RPT
(repeater) to extend its range when communicating with an enteliTOUCH or
DFM-ZBEE. The WNS in this case is associated with the eM-RPT.
Coordinator
A coordinator controls the formation and security of a ZigBee wireless network.
One of the three types of components in a ZigBee wireless network, the other two
being routers and end devices.
Join
Describes the process of how new devices are added to a wireless network. This
term also describes an operational mode in which an enteliTOUCH-7E or DFM-
ZBEE that allows new devices to be added to the wireless network.
Mesh network
A network with multiple possible routes between nodes over which a packet can
be routed.
ZigBee
The following definition is from:
http://www.digi.com/technology/rf-articles/wireless-zigbee
The 802.15.4 specification upon which the ZigBee stack operates gained
ratification by the Institute of Electrical and Electronics Engineers (IEEE) in 2003.
The specification is a packet-based radio protocol intended for low-cost, battery-
operated devices. The protocol allows devices to communicate in a variety of
network topologies and can have battery life lasting several years.
ZigBee channel
The ZigBee channel refers to the radio frequency in which wireless devices
communicate within a PAN.
The enteliTOUCH can automatically determine what channel to use based on the
amount of energy detected on each channel in the ZigBee range.
The ZigBee channel can also be selected from the enteliTOUCH wireless setup
screen.
Once the enteliTOUCH has determined the channel, each wireless device that
joins the network will automatically use this channel.
The ZF Object must reside in the local OWS workstation. If the various Zone
Controllers share the same generic format and object names, then only one ZF
Object need be created. Separate ZF Objects should be created if the Zone
Controller format differs or if unique names are used for each input/ output
instead of generic names. An example of this would be the case where objects are
named based on location or unit number.
Inputs / Outputs
Inputs / Name
This field allows the operator to define the names of the 8 inputs in the associated
Zone Controller Object. The length of the name must be at least 1 character and
no more than 16 characters. Any printable character, including spaces, is allowed.
The only restriction is that the first character cannot be a space.
Inputs / Units
This text field allows the operator to define the units to be displayed by the 8
inputs in the associated ZC Object. Analog units are entered as text (i.e., Percent,
Deg F, etc.) and the binary units are entered as text using a vertical separator
between the Active and Inactive states (i.e., ON | OFF, HIGH | LOW, etc.)
Note: For binary units, the system interprets the text preceding the vertical
separator as the active state and the text following the vertical separator as the
inactive state.
Outputs / Name
This field allows the operator to define the names of the 8 outputs in the
associated Zone Controller Object. The length of the name must be at least 1
character and no more than 16 characters. Any printable character, including
spaces, is allowed. The only restriction is that the first character cannot be a space
Outputs / Units
This text field allows the operator to define the units to be displayed by the 8
outputs in the associated ZC Object. The analog units are entered as text (i.e.,
Percent, Deg_F, etc.) and the binary units are entered as text using a vertical
separator between the Active and Inactive states (i.e., ON | OFF, HIGH | LOW,
etc.)
Note: For binary units, the system interprets the text preceding the vertical
separator as the active state and the text following the vertical separator as the
inactive state.
Setpoints
Setpoints 1 – 8 / Name
This field allows the operator to define the names of Setpoints 1 – 8 in the
associated Zone Controller Object. The length of the name must be at least 1
character and no more than 16 characters. Any printable character, including
spaces, is allowed. The only restriction is that the first character cannot be a space.
Setpoints 1 – 8 / Units
This text field allows the operator to define the units to be displayed by Setpoints
1 - 8 in the associated ZC Object. The analog units are entered as text (i.e.,
Percent, Deg_F, etc.) and the binary units are entered as text using a vertical
separator between the Active and Inactive states (i.e., ON | OFF, HIGH | LOW,
etc.) It is important to note that in the case of binary units, the system interprets
the text preceding the vertical separator as the active state and the text following
the vertical separator as the inactive state.
Setpoints 11 – 24 / Name
This field allows the operator to define the names of Setpoints 11 – 24 in the
associated Zone Controller Object. The length of the name must be at least 1
character and no more than 16 characters. Any printable character, including
spaces, is allowed. The only restriction is that the first character cannot be a space.
Setpoints 11 – 24 / Units
This text field allows the operator to define the units to be displayed by Setpoints
11 - 24 in the associated ZC Object. These are fixed setpoints and the units vary
depending on the algorithm being run. Refer to the Zone Controller Algorithm
Manual for specific details. The analog units are entered as text (i.e., Percent,
Deg_F, etc.) and the binary units are entered as text using a vertical separator
between the Active and Inactive states (i.e., ON | OFF, HIGH | LOW, etc.) It is
important to note that in the case of binary units, the system interprets the text
preceding the vertical separator as the active state and the text following the
vertical separator as the inactive state.
Description
Description
The description field may contain a character string of up to 2000 characters in
length. The character string is limited to any printable character.
The Description field will often be used for a detailed functional definition of the
Object.
See Appendix D – Using ORCAview with Version 2 Sites for further information.
Header
Object Value
This field displays the present value of the ZC object, as defined by the algorithm
currently operating in the associated Zone Controller.
Object Mode
Auto The ZC value and field values are automatically updated from the V2
Zone controller. The status indicated is “In Service”.
Manual The ZC value and field values are no longer automatically updated.
The last Present Value (or any value entered) remains until the object is returned
to auto. The status indicated is “Out of Service”.
When the Object is in Manual mode, GCL+ cannot write to the Object properties.
The Present Value field can be edited in Manual mode to allow the operator to
enter an override value.
Network Status
Online Indicates the BACnet Controller is communicating with the Zone
Controller.
Last Communication
This read only field displays the time and date that the last successful
communications occurred between the BACnet Controller and the Zone
Controller. The display is of the format HR:MIN:SEC DAY-MO-YEAR
Control Mode
The Control Mode of the ZC Object is used by the algorithm to determine its
operating parameters (i.e., NIGHT mode indicates night setback for most
algorithms). For a complete description of the valid modes for each algorithm, see
the appropriate chapter in the Version 2 Zone Controller manual. The possible
modes are:
Status
This read only field indicates the current status of the associated Zone Controller
as set by the algorithm that it is currently running. For a complete description of
the valid status types for each algorithm, see the appropriate chapter in the
Version 2 Zone Controller manual. The possible status types are:
Update EEPROM
This button is used to update the values of setpoints (1 to 8) from the ZC Object
into EEPROM on the Zone Controller so the values are not lost in the event of a
power failure. After pressing the Update EEPROM button, you must
then click the APPLY button. When the Update EEPROM button is released,
the Zone Controller has been successfully updated.
Refresh
When the ZC object dialog is initially opened, all values are refreshed and display
the current values. While the dialog remains open, most values are automatically
refreshed, with the exception of a few values (i.e. Scan Rate, Run Time). The
Refresh button forces the values to be refreshed.
I / O Value
Inputs and
fields
Setpoints
The names and units of these fields are specified by Setpoints 1 – 8 in the
associated Zone Controller Format (ZF) Object.
The values in these fields are Setpoints 1- 8 from the Zone Controller. The values
may be entered by the operator or set through GCL+ (e.g. ZC1.SetPoint[1] = 72).
Note: These fields are invisible unless they are defined in the associated ZF
Object. The Format field on the Operation tab contains the name of the ZF.
Inputs
The names and units of these fields are specified by Inputs 1 – 8 in the associated
ZF object.
The values in these fields contain the current values of the Inputs in the Zone
Controller. These values can be accessed from GCL+. (e.g.: AV1 = ZC1.Input[1])
Note: These fields are invisible unless they are defined in the associated ZF
Object. The Format field on the Operation tab contains the name of the ZF.
Outputs
The names and units of these fields are specified by Outputs 1 – 8 in the
associated ZF object.
The values in these fields contain the current values for the Outputs in the Zone
Controller. The values may be entered by the operator or set through GCL+. (e.g.:
ZC1.Output[1] = On)
Note: These fields are invisible unless they are defined in the associated ZF
Object. The Format field on the Operation tab contains the name of the ZF.
Setpoints
Setpoints 11 to 24
in these fields
Setpoints
The names and units of these fields are specified by Setpoints 11 – 24 in the
associated ZF Object.
The values in these fields are Setpoints 11- 24 from the Zone Controller. The
values may be entered by the operator or set through GCL+. (e.g.:
ZC1.ISSetPoint[1] = 2.0).
Please refer to the V2 Zone Algorithm documentation for the purposes of these
values.
Note: These fields are invisible unless they are defined in the associated ZF
Object. The Format field on the Operation tab contains the name of the ZF.
I / O Setup
fields
Input
This field defines the type of input. The valid types are:
Analog The input will be an analog value, and the specified Input Scale Range
and Input Calibration will be applied.
Digital The input will be a digital value and have a value of 0.0 or 1.0.
Switch The input is the 4-button sensor switch and will produce a value of 0.0
if no button is pressed, 2.0 if the down switch is pressed, 3.0 if the up switch is
pressed, 4.0 if the unoccupied switch is pressed and 5.0 if the occupied switch is
pressed.
Direct This input type is used for Zone Controller Multiplexors, in conjunction
with the AD_12 scale range.
Pulse This input type is used for the Zone Controller Pulse Input board only.
Long Pulse This input type is used in a specific Algorithm which may be
attached.
LedSense This input type is used to communicate with one or more Intelli-Stat
Sensors.
LedSw (Reserved)
Calibration
These fields contain the calibration values for the inputs on the Zone Controller.
This value is added into the current scaled input value to produce the final value
displayed on the ZC dialog.
Scale Range
These fields contain the scale range to use for each input. The valid types are:
Percent The input value will range from 0.0 to 100.0 percent (full scale) for an
analog input of 0 to 5 VDC, and is also used for digital object types.
DegC The input value will indicate degrees Celsius with a standard 10K-
thermistor sensor connected.
DegF The input value will indicate degrees Fahrenheit with a standard 10K-
thermistor sensor connected.
MuxValue The value will range between 0 (0v) and 4095 (5v). This range is
used in Multiplexor Mode. The value displayed on the ZC dialog will be 10 times
less than the actual A/D value (i.e. 4095 will be displayed as 409.5).
VPSense This scale range is used for the velocity pressure sensor on the VAV
Zone Controller that is connected to input 8.
HWSense This scale range is used for the hot wire sensor on the VAV Zone
Controller that is connected to input 8.
PPS This scale range is used to measure pulses per second with the Zone
Controller Pulse Input board. In this case the fixed setpoints are used as the
sample time in seconds.
PPM This scale range is used to measure pulses per minute with the Zone
Controller Pulse Input board. For this case the fixed setpoints are used as the
sample time in seconds.
PPH This scale range is used to measure pulses per hour with the Zone
Controller Pulse Input Board. In this case the fixed setpoints are used as the
sample time in seconds.
Mux10K The value will be in the range between 0 and 4095, and is used in
Multiplexor Mode. The value displayed on the ZC dialog will be 10 times less
than the actual A/D value (i.e. 4095 will be displayed as 409.5).
Mux4K7 The value will be in the range between 0 and 4095, and is used in
Multiplexor Mode. The value displayed on the ZC dialog will be 10 times less
than the actual A/D value (i.e. 4095 will be displayed as 409.5).
OutdoorAirC This scale range is used to indicate degrees Celsius with a 10K
outdoor air sensor (OTS430).
Output
This field defines the types of the outputs. The valid types are:
Analog The output will be analog with the output value ranging from 0 to 10
VDC.
LongPulse The odd numbered output will be paired together with the even
numbered output as linked pulse objects and is available only with the MUX
algorithm.
Operation
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is up to 255 characters in a DCU and up
to 67 characters in a DSC.
The name must be unique among the objects located on the same controller.
Units
Indicates the selected BACnet Engineering Unit applicable to the Zone Controller.
The BACnet Engineering Units are a list of all the possible units the BACnet
committee felt were required in this industry.
Algorithm
This field is used to set the algorithm that will run in the associated Zone
Controller. If the selected algorithm is not available, then “not available” will be
displayed. The following algorithms are available; depending on the Zone
Controller.
None This value indicates the controller is not running any algorithm. Micros,
Pzones, and V2 DACs display “None” for Algorithm.
Type15, Type16, Type17, Type18, Type19 These settings are reserved for
special custom algorithms.
Version
This read-only field displays the current Software Version of the Zone Controller.
(Micros, Pzones, and V2 DACs display 4.0).
Control Type
LocalControl Indicates the Zone Controller is running normally according to
the selected fixed algorithm.
Timeout
This field is used by Zone Controller multiplexors to determine how many
seconds to wait after communication is lost before the Zone Controller reverts to a
fixed algorithm. Other algorithms may use this timeout to re-establish
communication by initiating a software reset. (Refer to individual algorithm
documentation for further information)
Note: Each controller must have a unique address within the same network. Make
sure the new address does not conflict with another controller. Communication
problems will occur if two controllers share the same address.
Run Time
This read-only field displays the number of hours since the Zone Controller was
last reset. This counter’s maximum is 3000 hours.
Scan Rate
This read-only field displays the current Scan Rate for the current algorithm (in
number of times per second).
Format
The name of the Zone Controller Format Object (ZF) associated with this ZC
object. The ZF determines both the layout and object names displayed on the ZC
dialog. The dropdown list contains local ZF objects rather than the ones on the
OWS.
Commissioned
This check box indicates whether the Object has been field commissioned.
Description
Description
The description field may contain a character string of up to 2000 printable
characters.
It is often used for a detailed functional definition of the operation of the Object.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Chapter 11 Contents
OVERVIEW ..........................................................................................................11-5
MAIN DIFFERENCES BETWEEN GCL AND GCL+ ................................................11-6
Are You New to GCL+ .........................................................................11-6
Current GCL Users ..............................................................................11-6
GCL+ TABLES OF NEW AND OLD .......................................................................11-9
Table of New or Modified GCL+ .........................................................11-9
Table of Old GCL with Corresponding New GCL+ ..........................11-11
GCL+ CONSTRAINTS ........................................................................................11-12
Reading and Writing Objects .............................................................11-13
STATEMENTS, EXPRESSIONS AND OPERATORS ..................................................11-14
CREATING A NEW GCL+ PROGRAM..................................................................11-18
GCL+ LANGUAGE SUMMARY ...........................................................................11-19
Statements ..........................................................................................11-20
Command Statements .........................................................................11-21
Functions............................................................................................11-21
Status Operators ................................................................................11-24
Logical Operators ..............................................................................11-24
Comparison Operators ......................................................................11-25
Mathematical Operators ....................................................................11-25
Bitwise Operators ..............................................................................11-26
String Concatenation Operator..........................................................11-26
System Variables ................................................................................11-26
OPERATOR PRECEDENCE...................................................................................11-27
GCL+ EDITOR AND FUNCTION KEYS ................................................................11-30
RECOMMENDED PROGRAMMING PRACTICE ......................................................11-32
Formatting a Program .......................................................................11-32
Spacing and Indenting a Program .....................................................11-32
Commenting a Program .....................................................................11-32
Using Modular Programming ............................................................11-33
Ensuring Logical Programming Flow ...............................................11-34
USING DOEVERY, ONFOR AND OFFFOR ...........................................................11-34
Behavior of DoEvery..........................................................................11-34
Behavior of OnFor and OffFor: .........................................................11-35
GCL+ Code Usages to Avoid.............................................................11-36
GCL+ Code Usages to Use ................................................................11-37
PROGRAM EXECUTION ......................................................................................11-37
PG1 Defines Execution Order ...........................................................11-37
Data Update .......................................................................................11-37
Branching to a Program Line ............................................................11-39
Branching to Subroutines...................................................................11-40
Conditional Branching.......................................................................11-41
PROGRAMMING CONSIDERATIONS ....................................................................11-42
Program Value ...................................................................................11-42
Program State ....................................................................................11-43
Priority ...............................................................................................11-43
Program Status in Navigator .............................................................11-44
Overview
General Control Language Plus (GCL+) is an easy-to-learn programming
language that combines the best features of standard programming languages with
advanced functions and features specifically designed for use in Building
Management and Control Systems.
Using GCL+, you can quickly and efficiently create over 900 custom control
programs per controller—subject to the system’s overall memory availability—to
directly control outputs based on logical and/or mathematical relationships
between any combination of:
• Inputs
• Outputs
• Variables
• Application programs
• System Variables, such as TIME and DATE.
• Allows programs to read and write local and remote BACnet and V2 system
objects in the database. You can access almost all the fields in these objects.
The following section aims to ease the transition to GCL+ for those familiar with
the Version 2 GCL found in Commander 3.10. Version 3 GCL+ is found in 3.20
BACnet and following products.
1. Variables are now properly local and cannot be accessed outside the program.
GLOBAL VARIABLES are no longer used in GCL+ code. GCL+ Programs
from different controllers can now be copied to other controllers without
having the problem of GLOBAL VARIABLES with the same names
overwriting each other.
2. The GCL ARRAY statement has been combined into the GCL+ VARIABLE
statement.
3. The GCL TABLE function has been combined into the GCL+ CONSTANT
statement. The CONSTANT statement creates a user defined constant or
array of constants.
4. Subroutines now process DOEVERY and ONFOR statements correctly.
5. Subroutines now pass and return information in an optional argument list that
is contained in the CALL and SUB statements.
6. Additional Operators including:
Mathematical (exponentiation ^, MOD)
Bitwise (Bitwise Negate, Bitwise And, Bitwise Or, Bitwise Exclusive Or)
Status (Changed)
String (Concatenation)
Command (Relinquish)
1. The ‘Reset’ function in GCL+ now has the same functionality as Resetting
the Object from Navigator. The ‘Set’ function is no longer a valid function in
GCL+.
2. Almost all fields from V2 and BACnet objects on both local or remote
controllers now have READ and WRITE access from any GCL+ program.
Previously in GCL programs, only selected fields from V2 objects were
available for use as inputs.
3. When reading Remote Objects (Objects from another controller), GCL+ reads
the actual current value of the object, and not the value that was currently
written. For example, suppose the user has a remote AV (67.AV1) with a
value of 45. In GCL+ the following is entered:
67.av1 = 60
ao1 = 67.av1
In the first scan of the PG, the analog output will have a value of 45. Of
course, subsequent scans will have the correct value of 60 if the remote AV
object accepts the value that was written to it by the GCL+ program.
1. Any line of code that has a GLOBAL VARIABLE is commented out by the
compiler. The programmer must modify the old GCL GLOBAL VARIABLE
code so that the program functions properly as GCL+ code.
2. The compiler has more error icons and improved messages. Detailed error
messages appear when users hover over the error Icons
3. The compiler automatically converts changed keywords and code in the old
GCL syntax to the new GCL+ syntax. The source code itself changes. The
compiler automatically does these conversions with some exceptions. These
exceptions include COMMAND, CURRENT, CLEAR, GLOBAL, HOUR,
LAST_OFF, LAST_ON, MDAY, NEXT_OFF, NEXT_ON, and SET.
4. Multiple statements on one line are allowed in GCL+. The statements are
separated by a space. The compiler accepts the GCL convention of separating
multiple statements with a backslash \ .
5. It is no longer necessary to use underscores to avoid spaces or reserved
characters in object names. The system accepts a name with spaces such as
AHU1 Supply Fan Status; single quotes appear around the entire name
‘ AHU1 Supply Fan Status ‘ in the GCL+ programs. This is to define that all
the characters within the quotes represents a single Object
6. The GCL+ compiler supports 32 bit floating point and 32 bit integer
calculations. If a statement contains a mixed integer and floating point
expression, data type conversions are done automatically when required. The
resulting value from a mixed type expression will always be of data type
Real.
GCL+ Comment
ARCCOS
ARCSIN
ARCTAN
AVERAGE Replaces AVG.
BETWEEN Modified
The BETWEEN status operator in 3.20 GCL+ excludes the
endpoints of the range. The 3.10 GCL included the end points
of the range.
Bitwise Four new operators:
Operators
! (Bitwise negation)
&& (Bitwise AND)
|| (Bitwise OR)
^^ (Bitwise XOR)
GCL+ Comment
LENGTH
LN
LOG
Mathematical New operators:
Operators
^ (exponentiation)
MOD
MAX
MID
MIN
MINUTES
MOD New mathematical operator.
MONTHDAY
POWERUP
PRINT To Prints from the OWS Workstation using the Event Router
(EVR) object as the PRS object is no longer available.
RELINQUISH
RIGHT
ROUND
SCALE
SECONDS
SIN
Status New Operator:
Operators
CHANGED
String New Operator:
Concatenation
Operator &
SUB The modified SUB statement now has an optional list of
values or objects that it accepts from the CALL statement.
END Sub
SUNRISE Uses latitude and longitude information entered in the
DEVICE object.
SUNSET Uses latitude and longitude information entered in the
DEVICE object.
GCL+ Comment
System New:
Variables
Hours
Minutes
Monthday
Seconds
Sunrise
Sunset
Year
Modified:
Date
Time
TAN
TRUNCATE
VARIABLE ARRAY, LOCAL,VAR
YEAR
NEXTON Replaces NEXT_ON
NEXTOFF Replaces NEXT_OFF
ONFOR Replaces ON_FOR
OFFFOR Replaces OFF_FOR
GCL+ Constraints
GCL+ has the following constraints:
1. The FORALL statement cannot contain DOEVERY, ONFOR, OFFFOR,
IFONCE, or CHANGED
2. You cannot GOTO a program.
3. A program cannot call itself.
4. You cannot have nested FORALL statements within a FORALL statement.
5. The maximum text string size for a variable that can be used in GCL+ is 128
bytes. If the user wants to append a string to the existing Description field for
an object, the user must use the string concatenation operator. For example,
the code to append today’s date to the Description field, would look like the
following:
IfOnce Time = 1 then
av1.Description = av1.Description & Date
End If
6. The Changed function in GCL+ works well with binary variables. The
slightest change to an analog variable will result in the Changed function
becoming true. For example, if an analog input changes from 1 to 1.0000001,
the variable will be considered Changed.
7. If only integers are used in a mathematical equation, the result may be an
integer or a real depending on the situation.
For example, the following in GCL will yield x = 0.5
Variable x
x = 1 / 2
// The result is X equals 0.5
Variable y as Integer
y = 1 / 2
// The result is Y equals 0
2300.AV1 = 45
AV2 = 2300.AV1
AV2 will not equal ‘45’, it will instead be equal to the current value of
‘2300.AV1’ which is ‘12’. If at the end of the program scan, ‘45’ was written to
‘2300.AV1’ then ‘AV2’ would equal ‘45’ on the next program scan.
The exceptions to this are for local Analog and local Binary Objects. GCL+ reads
the recently assigned value (also called the GCLValue) For example:
AV1 = 23
If AV1 = 23 Then
AO1 = 0
Endif
The IF statement is executed even if the AV is not currently at 23.
AO1 = 45
AO1 = Max(AO1, AV1)
The program will not read a value of 45 for AO1, but rather its actual, present
value (23). As a result, an incorrect result is written in the second line.
All remote objects work similarly to Analog and Binary Outputs. As a result, the
user should avoid mathematical operations on remote objects as well.
Writing to Output Objects GCL+ will always write to the priority array of
Output Objects. GCL+ writes to priority level 10.
Writing to Variable Objects GCL+ will check to see if the Variable object is a
Delta Object. If it is a Delta Object, it will write to the ‘GCL Value’ property of
the object. This means that GCL+ will use the newly written value in subsequent
calculations.
If the Variable Object is from a third party device, GCL+ will determine whether
the Object has a Priority Array, if it has one it will write to it, otherwise it will
attempt to write to the ‘value’ property of the object.
Note: The status of the OutOfService property will not be taken into account
when writing to third party Variable Objects.
The following material describes and defines the basic concepts used in GCL+
programs.
Objects The main components of the ORCAview software are software objects.
A property is a characteristic of a software object.
For example:
// The following will not work if the descriptor name
//is manually typed in.
AHU1 Supply Fan Status = 5
// The following works.
‘AHU1 Supply Fan Status’ = 5
You do not have to type in long descriptor names enclosed with single quotes in
programs. It is much easier to type the Object Reference and it is then
automatically changed by the system to the object descriptor name enclosed with
single quotes.
The Programs Program objects contain lines of valid GCL+ code. Most GCL+
programs use and modify objects.
Some examples of valid statements follow: These statements would need the
variables in them to be defined.
X = 5
For NumStep = 1 To 10
Value = Value + NumStep
End For
operator expr
expr operator
The operator is applied to a variable or expression that is an expr. The expr may
be an object or property in the system, a user defined constant, a predefined
constant or a function call or another complex expression.
The following expressions are only examples and need an operator to make them
executable code. Some examples of valid expressions:
Count + 2
(5 * Count) + 3.2 / 8
NumberStarts Mod 7
Functions A built-in named and stored procedure that returns a value is called a
function. Functions perform specific computations, returning values useful for
assignment within programs. Functions such as AVERAGE and DEWPOINT are
built into the GCL+ programming language.
Some object properties have drop-down boxes associated with them. Within those
drop-down boxes there is a selection of values that the object property can be.
GCL+ can write to these object properties using the actual names found in the
drop-down box or a number associated to the drop-down box entries. The first
entry in the drop-down list has a value of 1 and the list goes down numerically
from there. You do not need to append a # as was needed in version 2.
Note: If you are using a selection from a drop-down box that happens to also be a
system variable, such as DAY, you must place the text in ‘single quotes’.
System Variables These variables store system information such as time and
date for use by all the programs on a controller. System variables such as HOURS,
MINUTES and SECONDS are predefined and included in GCL+.
Variable Data Type Data type indicates the kind of data that a variable may
hold. The GCL+ VARIABLE statement supports the following data types for a
variable:
• An Integer is a variable data type that holds only whole numbers. A integer
value can be between –2147483647 and 2147483647. Typical integers are
475 and -68.
• A Real is a variable data type that represents a floating decimal point number.
Very large or very small numbers can be represented but the accuracy of the
number is always only six digits in size. If a number gets larger or smaller
than six digits, zeros will be added to the number to keep the correct
placement of digits. The six accurate digits can float around on either side of
the decimal point. A real number value can be between -1*1038 and 1*1038 for
real numbers in GCL+. Values are equated to the closest real value that can
be represented using a rounding mechanism. Rounding errors can affect the
results of complex calculations. Typical real numbers are -7.89 *10^0 or 6.85
*10^1. Integers would be used if you required a large number to be accurate
and you did not require fractional numbers
2. Type in a program name, such as Sample Program. Press OK. The screen
then displays the following.
This is the program editing window.
Program lines may either be blank or contain a program statement. Blank lines are
used to format programs so that blocks or modules of code are clearly separated.
If a line ends with a mathematical operator such as +, then the line continues to
the next line. Enter up to 255 characters per program line.
See GCL+ Language Reference starting on page 11-67 of this chapter for detailed
information. The GCL+ Language Reference is organized in alphabetic order.
The GCL+ Language Summary, that follows, provides basic information about
GCL+ Language. The following GCL+ Language Summary is presented in tables
and organized alphabetic order under the following headings:
• Statements
• Command Statements
• Functions
• Status Operators
• Logical Operators
• Comparison Operators
• Mathematical Operators
• Bitwise Operators
• String Concatenation Operator
• System Variables
Statements
Statements define and control the structure and flow of GCL program execution.
Command Statements
Commands statements specify the value or state that an object takes after program
execution.
Functions
Functions perform specific computations, returning values useful for assignment
within programs.
Laston LAST_ON Obtains the last time a Schedule turned ON. 11-99
Nextoff NEXT_OFF Obtains the next time a Schedule will turn OFF 11-106
Status Operators
Status Operators assess the value or status of objects.
Logical Operators
Logical operators assess relationships between objects and their values or states.
Comparison Operators
Comparison operators perform operations involving equalities, greater than,
greater than or equal, less than, less than or equal, or inequalities. These operators
compare the value of one object to the value of another object.
Mathematical Operators
Mathematical operators perform exponentiation, negation, multiplication,
division, modulus, addition, or subtraction.
Bitwise Operators
Bitwise operators perform bitwise negation, bitwise And, bitwise Or, and bitwise
Exclusive Or.
11-73
|| Performs bitwise Or.
value1 || value2
11-73
^^ Performs bitwise Exclusive Or.
value1 ^^ value2
System Variables
System Variables store system information for program use.
Operator Precedence
Operators An operator compares, assesses the value, status or the relationships
between objects and their values and states. An operator acts on a value or
expression. GCL+ has the following types of operators:
• Status
• Logical
• Comparison
• Mathematical
• Bitwise
• String
The Comparison (5) and Logical (6) operators have equal precedence down the
table and are evaluated from left to right as they occur in the expression.
After the right hand side expression is evaluated, the state or expression on the left
side of the assignment operator (=) is set equal to the state or expression on the
right side.
The fonts used to display GCL+ code, are defined in the GCL Editor Settings
(GCS) object. In Navigator, choose Tools from the main menu, select Preferences
and then click GCL. In the Current font field, click the Change Settings button. In
3.30, all fonts installed and available in Windows display in the font selection
dialog. Previously, the choices were limited to the fixed-width True Type fonts
that were installed on your system.
When the cursor is placed over an object or local variable on a GCL+ program
line, a small text box displays the current value of the object. When displaying a
PG object, the object remains fully operational. However, the values in the
program do not refresh unless the cursor is moved from the object and then placed
over it again.
The text of the GCL+ program appears on the screen. Any editing changes are
checked and interpreted on a line by line basis. When you are fully satisfied with
the changes, click the Apply or OK buttons to replace the previous object.
The GCL+ Editor has a search and replace function. This function can be found in
the Search menu on the ORCAview toolbar. The search looks at the text in a PG
and returns the first match that it finds. The user can search for additional matches
with the Find Next menu. The Replace menu allows the user to replace any text
that matches the Find field with text in the Replace field.
Note: The compiler automatically converts GCL code to the equivalent GCL+
code. Also the compiler translates abbreviations such as var or const to the full
GCL+ keyword. In both cases, the source code in the PG line changes.
The following are the various mouse functions available within the GCL+ Editor:
Button(s) Description
Selection Lingering on an object Name with the cursor displays current
value.
Left Button Click Locates cursor to selected position.
Left Button Click Selects and Highlights text for editing use.
and Drag
Right Button Has four actions, context sensitive:
Click
If the selected item is a Keyword, it invokes a menu containing
the option to view an example for the keyword.
If the selected item is an Object Name, it opens the Command
Menu for the object.
If the selected item is Highlighted Text, it opens the Edit Menu
for cutting & copying.
If there is no item selected, it opens the Statement Menu for
insertion of chosen menu item at current location.
The following are the various keys and their functions within the GCL+ Editor:
Key(s) Description
Enter (or Return) Interprets the current line up to the cursor and moves the
remaining contents of the line to the next line.
Up Arrow Interprets the current line and moves the cursor up one line.
Down Arrow Interprets the current line and moves the cursor down one
line.
Right Arrow Moves the cursor one character to the right.
Left Arrow Moves the cursor one character to the left.
Delete Deletes the current character under or to the right of the
cursor.
Back Space Deletes the character to the left of the cursor.
Formatting a Program
Proper indentation, spacing and comments are very important when writing GCL+
programs. Reading and troubleshooting programs is easier with proper indenting.
All declarations of variables and constants are usually put at the beginning of a
program.
Delta Control’s standard for horizontal indenting is to indent two spaces after
every loop statement. For example, the lines following an IF condition in an
IF-THEN-ELSE-END IF statement, should be indented two spaces from the
margin of the IF condition. If you have nested statements, each statement is
indented an additional 2 spaces. The END IF statements are then put at the same
indent as the corresponding IF statement.
If ‘AHU1 OCCUPIED’ Then
Start ‘AHU1 Return Fan’
If ‘AHU1 Return Fan Status’ OnFor 10s Then
Start ‘AHU1 Supply Fan’
End If
Else
Stop ‘AHU1 Return Fan’
End If
Commenting a Program
Commenting your code in a conscientious manner may be the single most
important task in programming GCL+. Comments allow yourself and others to
quickly understand any Program, even if written in the distant past. If a program is
commented properly, it is easy to find where a particular task is performed.
The amount of detail in the Program comments depends on how much memory is
available and how knowledgeable the user is.
Placing all the code for a piece of equipment in one place makes the code easier to
troubleshoot. For example, you only need look in one block to see why the mixing
dampers do not open.
The Priority Array allows the system to handle output objects that are manipulated
by more than one control source. If the action of two or more control sources
conflict with regard to the value of a property, then the priority scheme provides a
way to arbitrate the disagreement. Each commanding entity (control source) in the
system has an assigned priority level and objects with a commandable property act
on commands in order of priority. GCL+ has a writing Priority Level of 10.
With time-based functions such as DoEvery, OffFor, and OnFor, there have some
instances where the behavior of a program did not conform to expectations. The
problem is that OffFor OnFor were placed within a conditional statement. The
correct approach is to first have the time-based statements such as OffFor or
OnFor and then to have the conditional statements following.
Behavior of DoEvery
A GCL+ statement of "DoEvery 1M" is essentially equivalent to the following
GCL code:
DoEvery calculates a time in the future every time it trips. If a DoEvery is placed
in an IF block, then the DoEvery will likely be true and execute the first time that
the IF is true. The DoEvery frequency is likely greater than the occurrences of IF
changes from True to False.
The key is to be careful whenever DoEvery is used in a conditional block and not
executed every scan. Use the previous GCL code to judge what your GCL code
will actually do.
The key in GCL+ is that the IfOnce part above executes EVERY scan, regardless
of whether the OnFor is buried in a conditional block or not. This is different from
V2 behavior. This means that conditionally executed OnFors will likely be true
the moment the condition above the OnFor is true, since the OnFor time is likely
less than the time for the condition to change state.
As an example to try and better explain this behavior, consider the following
program:
If SCH1 = On Then
If BO1 OnFor 1M Then
Start BO2
Endif
Endif
Variable OnForTime
IfOnce BO1 = On Then
// calculate the time when the output
// will be on for 1 minute
OnForTime = DecimalTime + (1 * 100/60)
Endif
If SCH1 = On Then
If DecimalTime > OnForTime Then
Start BO2
Endif
Endif
The previous code has been written with the intent that after the schedule turns on,
a 5 minute delay will occur before BO2 is turned on (in this example, BO1 is a
heating pump and BO2 is a boiler enable). The problem that occurs is that if BO1
was already running before the schedule came on, the IfOnce will be true right
away, with no delay. Furthermore, if BO1 had not been Off in the time that the
schedule was Off, then the IfOnce would never be true and the boiler wouldn't
start.
// Avoid code like this!
IfOnce SCH1 = On Then
DoEvery 5M
AV1 = AV1 + 1
Enddo
Endif
Code like the previous does not operate properly because the IfOnce line is only
true for one scan per schedule on period (typically one day). Thus, the DoEvery is
never executed.
// Avoid code like this!
// Needs brackets around AI1 > 5
If AI1 > 5 OnFor 1M Then
Start BO1
Endif
The previous code tends to be unreliable because of the order in which GCL reads
the If line. With proper bracketing, this code will work properly:
For best results, always bracket the condition that OnFor is supposed to be
checking.
// Examples: Brackets in Condition That OnFor Checks
// Write code like this!
If (BO1 = On) OnFor 1M Then
When brackets are used as in the previous example, then it does not matter which
action the Binary Object has, the code still does what is desired.
Program Execution
Every Delta Control Unit automatically scans Program 1 (PG1) after it is created.
GCL+ programs always scan from the top to the bottom of the Program, one line
at a time. All other programs are not scanned unless there is a specific CALL for
the program within PG1 or within a program called from PG1.
Data Update
All data is accessed via the program symbol table that is stored with the program.
Data is extracted from the symbol table prior to executing the program and stored
back only after the complete program is executed. The symbol table consists of
names, acronyms, data types, and data offsets into the variable data area. The
variable data area is allocated separately so that most of GCL+ can be stored in
flash memory.
Inputs and Outputs objects update in a unique manner from other objects in a
Program. An Input or an Output object only updates at the end of a Program scan.
This is very important with regards to Outputs. If a program manipulates an
Output object many times, the program only assigns its new value to the Output
object when the processor completes a scan of the entire Program.
Any safety functions required in a system should be written at the end of the
Program.
Example There are four GCL+ programs in a controller (PG1 to PG4). PG2,
PG3, and PG4 are treated as subroutines that are called from the Master Program
PG1.
It is easy for the user to locate the data exchange code. Some programmers may
instead use the convention of always putting data exchange code on each
controller in a program named DataExchange.
Sometimes, two separate programs are created to operate the same equipment. In
this case, use an IF statement in PG1 to determine which program executes.
Example PG2 controls an air handling system only during the wintertime. For
the other seasons besides winter, PG3 controls the air handler.
Branching to Subroutines
When a subroutine CALL statement is encountered in a program, execution of the
program branches to the subroutine and then returns to the next statement after the
calling statement.
Conditional Branching
The program branches to a specific line name, program name or subroutine based
on whether an expression tested by an IF Statement is TRUE or FALSE.
Example When the outdoor temp is above 22, execute PG3; otherwise, execute
subroutine FRED.
Programming Considerations
When working with Program objects (PG), you need to understand the following
information:
Program Value
The PG object can have four different values ; Running, Idle, Loading and Halted.
PG Object Description
Value
Running The program is currently executing.
Idle The program is either in Manual or has not been called from
PG1.
Loading The program changes are being saved to the Controller.
Halted The program has been halted, either by the user or a GCL
Timeout.
A program halts if the time it takes to execute the program exceeds the GCL
Timeout three times in a row. The GCL Timeout is stored in the Time Info tab of
the Device object. When a program is Halted, the user must set the program back
to Run.
Program Value
On a DAC or DCU controllers, the default time for the read only GCL Timeout
property is 20 seconds.
On an OWS or HMI, the default time for the read only GCL Timeout property is 5
seconds.
Program State
A program can be controlled by the user from two different locations. A program
can be set to or from Auto or Manual by right clicking and commanding the object
from ORCAview or the program can be set to Run or Halt State using the
dropdown located at the lower right corner of the program.
Running a Idle PG When a program has been set to Halted by the user, the
program does not execute and the value is set to Halted. The Program object must
be set to Run from within the Program, before it will run again.
Priority
Priority is a read only field that indicates the Priority level at which GCL+
operates.
6 - Minimum On/Off
8 - Manual Operator
Program Status
GCL Timeout
The GCL Timeout is used to limit the amount of time a program takes to execute.
The GCL timeout is the maximum number of seconds a program has to execute
before the controller will move onto the next program.
The read only GCL Timeout can be found in the Device object on the Time Info
tab. On a DAC or DCU controller, the default time for this read only property is
20 seconds.
On an OWS or HMI, the default time for this read only GCL Timeout property is
5 seconds.
The GCL Timeout field defines the number of seconds that a GCL+ program can
be caught in an infinite loop before it is "kicked" out of the loop. When a GCL
Timeout occurs, GCL+ is kicked out of the infinite loop and starts executing from
the beginning of PG1's first line of code. If the infinite loop continues to exist, the
program execution will be restarted a maximum of three times, after which the
program containing the infinite loop will be halted and will not be executed again.
If a GCL Timeout occurs, a red X (Execution error) appears at the location where
the Timeout occurred. If three GCL Timeouts occur in a row, the entire program
that the timeouts occur in is set to a Halted state.
In Navigator, if the user hovers over the name of the Halted program, an
explanation of why the program was halted appears.
The Save / Load Timeout field on the Time Info tab of the DEV object relates to
wait time for a database save or load operation from the OWS.
In the following example PG3 ‘AHU1 Program’, a GCL Timeout occurred three
times in a row PG1 and the program was Halted.
Program Size
Each program is restricted to a maximum size of 5.5 or 10 Kbytes on a DAC/DSC
depending on the hardware revision and 23.7 Kbytes on a DCU. Remember that
longer program can be harder to read and troubleshoot. It is recommended to leave
at least 1 Kbyte free for future upgrades or changes. For a DAC/DSC, the
recommended maximum program size would be 4.5 or 9.0 Kbytes depending on
the hardware revision. The following table shows the Max Program size for
different controllers.
A counter, on the right side of the program name, records the program size as it is
being written. If the program exceeds its maximum size an exclamation mark (!)
appears to the left of the counter.
A warning message appears if you try to save a program that exceeds the
maximum size.
Each program line can have up to 255 characters. The appearance of the text in the
PG object is determined by the GCL Editor Settings (GCS) object.
Numbers
Numbers are stored in the database as signed 32-bit integers that range between
- 2147483647 and 2147483647 or as 32-bit floating point numbers that range
between -1*1038 and 1*1038.
When you define the VARIABLE or CONSTANT statement and use a name
containing spaces or reserved characters, you must enter the delimited name with
single quotes. The compiler does not do it for you automatically in these cases.
You must also enter the delimited name with single quotes where the code refers
to the VARIABLE or CONSTANT. When naming a VARIABLE or
CONSTANT, it may be easier to avoid using spaces or reserved characters.
Also, if you want to use the descriptor name to reference an object, you have to
use the single quotes.
For example:
// The following does not work.
AHU1 Supply Fan Status = 5
// The following works.
‘AHU1 Supply Fan Status‘ = 5
Program Comments
Include your own non-executable comments in a program. Comments have two
slashes // at the beginning of the line in GCL+. It is also possible to add a
comment at the end of a line of code. The previous version of GCL used square
parenthesis at the beginning and end of a line to indicate a comment.
During debugging, lines of code are often temporarily commented out so that they
do not execute. The commented characters can be later removed from the start of
each line so that they execute.
The compiler accepts the old GCL convention of using a backslash \ to separate
multiple statements on a line.
Line Continuation
If an expression or statement is not complete on a line, GCL+ will attempt to
continue the line by processing the next line. Thus, to use automatic line
continuation you must make sure that a line ends on an operator such as +.
//This will work correctly
VALUE = 5 +
7
The compiler does not translate the old GCL continuation \C.
Program Inputs
System Variables, objects, enumerated values, and Variables defined by the
VARIABLE and CONSTANT statements have values that can be used as inputs
in GCL+ programs.
Input Objects (AI , BI ) The Values of AI and BI objects can be used as an input
to any GCL+ program, in any controller.
Output Objects (AO, BO) The Values of AO and BO objects can be:
Schedule Object (SCH) Use the Status of the SCH object as an input to any
GCL+ program, in any controller.
Calendar Object (CAL) Use the Status of the CAL object as an input to any
GCL+ program, in any controller.
Control Loop Object (CO) Use the Value of the CO object as an input to any
GCL+ program, in any controller.
Set the CO object’s Setpoint using any GCL+ program in the same controller.
Totalizer Object (TZ) Use the Value of the TZ object as an input to any GCL
programs, in any controller.
Security User Access Object (SUA) Use the Value of the SUA/UA object as an
input to any GCL program, in any controller.
Example 2 Set the mixed air Control Loop (CO object) Setpoint to 60.
If any errors are discovered in the line, or the program has been allowed to
execute, then various characters will appear in the Program Status Column, each
with its specific meaning.
A program that has any errors in it displays Fault in the status column of
Navigator.
Note: You can get more detail on a particular error by hovering the mouse cursor
over the error icon in the Program Status Column.
The name Chiller is defined as a name for a Binary Output object (BO).
Invalid Syntax
The program line contains invalid syntax and displays a Yellow Octagon with a
cross in the Program Status Column. This line does not execute.
Undefined Symbol
If the program line contains an undefined word (symbol) then it displays a Yellow
Octagon with a question mark in the Program Status Column. This line will not be
executed. A Symbol is undefined if the system does not recognize it as a valid
object or as a defined name, variable or subroutine.
Example The word Schedule 3 in line 1 is not recognized by the system because
it has not been created yet.
Execution Error
The program line cannot be processed, such as when the execution time for a
GCL+ program is greater than the GCL Timeout setting in the Device (DEV)
object. This line will not execute. The read only GCL Timeout can be found in the
Device object on the Time Info tab. The GCL Timeout default value is 20 seconds
on a DAC or DCU controller and 5 seconds on an OWS or HMI.
If a program is in error:
• The Program Status Column displays a Red Octagon with an “X” inside it,
beside the line containing the execution error; and,
• The program State is flagged as being in fault or Halt.
• The program object will show as ‘Fault’ or Halted in Navigator.
Example The loop times out as the execution time required for the For statement
exceeds the allowable maximum time.
Missing Statement
The program line cannot be processed, such as when an IF, IFONCE, DOEVERY,
FOR, or FORALL statement is missing its corresponding END IF, END DO, or
END FOR. This line will not execute.
If a program is in error:
• The Program Status Column displays a Yellow Octagon with a Hand beside
the line containing the execution error; and,
• The program object will show as ‘Fault’ in Navigator
Example The IF statement is missing an END IF, the For statement in line 5 is
missing an End For and the Sub lacks an End Sub.
Execution Trace
The program line has executed since the program was last displayed or edited and
displays a Green Dot in the Program Status Column.
Example This program line, and thus the program, has executed successfully.
If the Program Status field of a line remains blank after the program executed, the
line did not execute during the last scan. This may mean one of the following:
• The line is within a subroutine not currently being called.
• The entire program is not tracing. No other program contains a CALL
statement that calls for this program to execute.
• The line is within a DOEVERY loop that has not executed since the last time
the program displayed or executed.
• The line has been jumped over by a GOTO statement.
• The line is part of an IF-THEN-ELSE statement that has not executed since
the last time the program was edited.
Convention Description
{...} Anything shown inside curly
parenthesis is optional.
[ ] Square brackets are used to define
array sizes, array indexes, and string
sizes. For example, the VARIABLE
statement uses square parenthesis [ ]
to define the array dimensions.
( ) The regular parenthesis ( ) indicate
an expression to evaluate.
result = These statements assign the right
hand side of the equation to the result
variable =
or variable on the left hand side.
operator An operator acts on an expr or value.
expr An expr may be an object or property
in the system, a user defined constant,
a predefined constant or a built-in
function call or another complex
expression.
Expr1 (exprN) indicates a similar
expression to that defined as expr. An
expression may have a prefix or suffix
to help make its purpose clearer. For
example: input-expr, on-expr, off-expr,
or length-expr.
variable1, variable2 ... variableN Items that end in 1,2...N such as
variable1, variable2 ... variableN
indicate a list of 1 or more items.
element Element defines a particular entry in an
array. Elements define the dimensions
of a CONSTANT array or a
VARIABLE. A 2 by 2 VARIABLE would
have 4 elements.
type Type is one of Integer, Real, String, or
Object.
Each symbolic name also has a data type. All data will be converted to one of
these data types before use. GCL+ supports seven different data types:
• 32 bit floating point
• 32 bit integer
• text strings
• date (as integer days since January 1, 1980)
• time (as integer seconds since midnight)
• DecimalTime (as in decimal representation of military time)
• enumerated values
ABS
Function Calculates the absolute value of an input or expression.
Comment The result may be Real or Integer. This expression may be real or
integer. The absolute value of a number is its unsigned magnitude. For example,
Abs(-1) and Abs(1) both return 1. If the input expression is integer, an integer
result is returned. If the input expression is real, a real result is returned.
Example
AND
Logical Operator Returns TRUE(1) if both expressions are true.
Example Start the PUMP if the schedule and the FAN are on.
ARCCOS
Function Calculates the arc-cosine of a value. The result is specified in degrees.
Comment The result is a real number between 0 and 180 degrees. The
expression can be any valid numeric expression either integer or real within the
range of -1 to +1. If the input is not within range, it uses either the minimum or
maximum values of 1 and –1.
ARCSIN
Function Calculates the arc-sine of a value. The result is specified in degrees.
Comments The result is a real number between –90 and 90 degrees. The
expression can be any valid numeric expression either integer or real within the
range of -1 to +1. If the input is not within range, it uses the minimum or
maximum values of 1 and –1.
ARCTAN
Function Calculates the arc-tangent of a value. The result is specified in
degrees. When two arguments are present, the arc-tangent is calculated and the
sign of the expression and expression1 are used to give the correct four quadrant
result.
Comments The result is a real number between -180 and 180 degrees. The
expression can be any valid numeric expression either integer or real.
Example ARCTAN Function
MyNumber = Arctan(0.57735) // MyNumber equals 30
MyNumber = Arctan(-0.57735,-1.0) //MyNumber equals -150
Assignment
Statement Sets the value of an output or variable. Assigns the value of an
expression to a variable or property.
Comments The state or value of the object or variable on the left side of the
equal sign is set equal to the value of the object, variable or expression on the
right hand of the equal sign.
The type of assignment statement is based on the type of the target variable or
property. GCL+ attempts to do reasonable conversions to the target type. For
example assigning TEXTVAR = 22.5 stores the string 22.5 in TEXTVAR if it
is a string.
//Sample Assignments
Dampers = 50
Valve = Dampers + 40
Chiller = On
AVERAGE
Function Calculates the average value of a list of inputs or values.
You may type in avg or AVG and the compiler translates it to Average.
Example 1
Examples 2
BETWEEN
Status Operator Compares the value of an expression with two other values.
Comments If the expr is greater than or equal >= value1 and less than or equal
<= value2, the result is True (ON); otherwise, False (OFF)—not between or equal
to one of the values. If the expr is = value1 or = value2, the result is True (ON).
The BETWEEN status operator in 3.2x GCL+ excludes the endpoints of the
range.
Note: In 3.30 and following, the BETWEEN status operator now includes the
endpoints unlike in 3.2x GCL+. In 3.2x GCL+, the endpoints are excluded. The
GCL with Commander 3.10 for use with 2.92 hardware includes the endpoints of
the range. For both 3.30 GCL+ and 3.10 GCL, the result is True if the expr is
greater than or equal to value1 and less than or equal to value2.
Reference CHANGED
The result of the comparison are an integer representing the bitwise binary
operation.
CALL
Statement Causes the execution of the program to branch to the program or
subroutine specified.
Comments The program execution returns to the next statement after the calling
statement when the end of the called program is encountered.
CALL SAMPLE_PROGRAM
CALL PG6
CALL UNOCCUPIED (Mode, 3, Fans)
Changed
Status Operator Tests if a value has changed.
Comments The Changed function Tests if a value has changed since the last
time that the program line was traced. The Changed operator returns 1 only when
the value is different from the last program scan, otherwise it returns 0 indicating
that the value is the same as the last program scan.
The Changed function works well with binary variables. Sometimes Changed is
used with Analog Input (AI) or Analog Output (AO) objects. The slightest change
to an analog variable will result in the Changed function becoming true. For
example, if an analog input changes from 1 to 1.0000001, the variable will be
considered Changed.
Reference BETWEEN
Command Statements
Command Statement Specifies the value or state that an object takes after the
program finishes execution.
• RESET
• START
• STOP
• RELINQUISH
Start Fan1
Relinquish AO5
COMMENT
Statement Places a user comment in the program.
Comments Comments start with two slashes // and continue to the end of the
line. This means that comments cannot be inserted in between program elements –
they can only appear at the end of a line. You can add a comment at the end of a
line of code.
The use of comments is crucial as it makes the logic of a program clear and aids
future troubleshooting or modification of a program by yourself or others.
Comments Operators:
= (equals)
> (greater than)
>= (greater than or equal to)
< (less than)
<= (less than or equal to)
<> (not equal)
CONSTANT
Statement Creates a user defined constant or array of constants.
The type of the constant is determined by the type of data stored. If a number has
a decimal, it is real otherwise it is integer. If a string is assigned, the type is string.
The user may enter Const and it translates to Constant. Version 2 GCL Table
statements are accepted and converted to Constant.
Constant Size = 10
Constant Maximum = 88.5
Constant Title = "This is the title"
Constant Text = "First", "Second", "Help", "Stop"
Constant Translate = 1,2,3,4,5,6,7,8,9,10
Constant BigArray = (1,2,3,4,5),(1,2,3,4,5),(1,2,3,4,5)
COS
Function Calculates the cosine of a value. The input is specified in degrees.
DATE
System Variable Returns Date expressed as internally coded number: 01-JAN
through 31-DEC.
Comments Both the DATE and TIME System Variables return an internally
coded number. These are typically used with Comparison Operators.
Example
DAY
System Variable Returns current day of year expressed as a integer from 1 to
365 (366).
DAYON
Function Returns 1 (TRUE) if the specified date is ON in the Calendar object.
Otherwise, it returns 0 (False).
Reference DATE
DECIMAL
Function Calculates the decimal fraction of a value.
Reference TRUNCATE
DECIMALTIME
System Variable Returns current time of the day as an number from 0 to 2400
Minutes are converted to 0 to 100, so 12:42 is returned as 1270.
i.e., 1:30 PM will return a value of 1350.0. DECIMALTIME has the same
function as the old GCL HOUR system variable. The compiler does not convert
the old GCL HOUR to the GCL+ DECIMALTIME.
The previous short code segment converts the returning TIME value from the
NextOn function into a DECIMALTIME value and returns a continuous scale
instead of having to use multiple IfOnce statements.
The following longer code segment also determines if the schedule is going to
come on in 15 minutes using two IfOnce statements without using
DECIMALTIME.
Ifonce (NextOn(sch1) - Time) <= 65 then
// if the schedule starts at the top of the hour
// (i.e. NextOn = 0700, Time = 0645)
Ifonce (NextOn(sch1) - Time) <= 15 then
// if the schedule starts at the middle of the hour
//(i.e. NextOn = 0730, Time = 0715)
DEWPOINT
Function Calculates the Dewpoint using humidity, temperature and unit of
temperature (Fahrenheit or Celsius).
Comments The Humidity and Temperature values are usually based on inputs
that have been calibrated and scaled from voltage to engineering units.
Reference ENTHALPY
DOEVERY
Statement Executes block of statements at a given time interval. The DoEvery
statement must be executed to be processed i.e. it will not be executed in the
background when the timer expires, but only if the program calls it.
See the Using DoEvery, OnFor and OffFor section starting on page 11-34 for a
description of the proper use of these statements.
Syntax
STATEMENTS END DO
The DOEVERY statement must be called to be processed. The statement for the
interval-expr does not execute in the background when its timer expires.
DoEvery 10m
Setpoint = Setpoint+ 1
End Do
DoEvery Error:S
Valve = Limit(Valve + 1,0,100)
End Do
Example 3 :Increment the value of the variable Counts on a variable time basis
using INCR1.
Variable INCR1 as Integer
INCR1 = 5
Variable Counts as Integer
//M defines the time scale
DoEvery INCR1:M
Counts = Counts + 1
End Do
ELSE
Statement Indicates that the statements that follow are to be executed if the
matching IF or IFONCE statement is FALSE(0).
Syntax ELSE
ELSEIF
Statement Executes the statements that follow if the condition is TRUE(1). You
can have as many ELSEIF clauses as you want in a block but none of them can be
after an ELSE. This statement is used within IF and IFONCE statements.
END
Statement Stops execution of a program at the object where the statement is
executed.
Syntax END
IF ERROR THEN
END
END IF
END DO
Statement Indicates the end of a DOEVERY sequence of statements. If the
DOEVERY statement does not execute, the program skips to the statement
following the END DO.
Syntax END DO
Reference DOEVERY
END IF
Statement Indicates the end of an IF or IFONCE statement.
Syntax END IF
Comment The compiler does not convert the GCL ENDIF to End If.
END FOR
Statement Indicates the end of a FOR or FORALL statement loop.
Comment The compiler converts the GCL statement ENDFOR to END FOR.
END SUB
Statement Denotes the end of a subroutine statement.
ENTHALPY
Function Calculates the Enthalpy or amount of energy in the air using humidity,
temperature, and unit of temperature (Fahrenheit or Celsius).
Rm12_Enthalpy = Enthalpy(Rm12_Humid,Rm12_Temp, F)
Reference DEWPOINT
FOR...END FOR
Statement Repeats a group of statements a specified number of times.
Performs a counted loop with start and end values using a step value to reduce the
number of loops to be performed.
Syntax
At the start of the loop, the counter is assigned the start-expr. For each loop
(including the first time through), if the step-expr value is positive or zero and the
counter <= end-expr, then the loop statements are executed. At the end of the
loop, step-expr is added to counter and the value tested to see if the loop should
execute again. If it does not execute, the code following the End For statement is
executed.
The Exit For statement is used to exit the loop early and may only appear in a For
loop or FORALL loop.
//Counts Increments
Variable Value1 As Integer
Variable Counts As Integer
Value1 = 0
For Counts = 1 To 5
Value1 = Value1 + Counts
End For
//Counts Decrements
//Show how to get a decremented step
FORALL...END FOR
Statement Repeats a group of statements for each element in a wildcard
selection of objects.
This statement allows mass changes to a large numbers of objects that match a
descriptor wildcard.
{ statements}
{ EXIT FOR }
{ statements }
END FOR
Comment The FOR ALL…END FOR statement has the following parts:
An execution error may occur in a large databases (greater than 700KB) where a
ForAll function is used to read or write several objects. It may take longer to
execute the code in the ForAll than the read-only GCL Timeout will allow. The
GCL Timeout default value is 20 seconds on a controller and 5 seconds on an
OWS. These default Timeout values are read only and it is not possible to adjust
them.
Example 4: Calculates the average room temperature for multiple inputs every
two minutes.
// Program that averages room temperature
// every 2 minutes
Variable Elements As Integer
Variable Total as Integer
DoEvery 2M
Elements = 0
Total = 0
ForAll Inputs In "AI*:*RT"
Elements = Elements + 1
Total = Total + Inputs.Value
End For
'Average RT' = Total / Elements
End Do
Comments The Format function is used to set the appearance of the Room
Controller display using the LCD And Keypad Access (LCD) object. The Format
function works with the String Concatenation Operator ‘&’.
The following code examples convert the numeric value of AV1 into a formatted
string. The formatted string is assigned to a line property of the LCD object.
Example 1 Format a object’s value and include a filler character at the start of
the string.
Example 2 Format a temperature value to display two decimal places and add °F
to the string for the LCD display.
Lcd.Line3 = Format (Temperature,2,5) & "^F"
//Temperature has a value of 70.245
//String concatenation operator ‘&’
//"^" = degree symbol
//the string "70.24°F" is displayed on line 3
GOTO
Statement Causes the program execution to jump unconditionally to a specified
line name within a program.
GOTO label
label:
Comments A line is given a label (name) by following the line label with a
colon. There is not any space between the label and the following colon.
TEST:
Examples 2 If temperature is above 30, Status equals OFF and ON when less
than 30.
If OAT > 30 Then
GoTo Test
End If
Status = ON
GoTo Done
Test:
Status = OFF
Done:
The previous code is illustrative only and it would be clearer to use code similar to
the following.
If OAT > 30 Then
Status = OFF
Else
Status = ON
End If
HOURS
HOURS can be used as a System Variable or as a Function.
Comments Do not confuse HOURS with the old GCL HOUR that was replaced
by DECIMALTIME.
IF...THEN...ELSE...END IF
Statement Conditionally executes a group of statements, depending on the value
of an expression.
IF condition Then
{statements}
ELSEIF condition-n THEN
{elseif-statements}
ELSE
{else-statements}
END IF
Comments The IF...THEN statement has the following parts:
Statements can be on one or more lines. Also it is possible but not recommended
to put several statements on the same line by separating the statements with one or
more spaces.
The ELSE and ELSEIF clauses are both optional. You can have as many ElseIf
clauses as you want in a block, but none can appear after the Else. Also, ENDIF
will be accepted and converted to END IF
// Day 2 is Tuesday
If Oat > 30 And Weekday = 2 Then
Setpoint = 19
Elseif Oat = 20 Then
Setpoint = 20
Elseif Oat < 10 Then
Setpoint = 15
Else
Setpoint = 0
End If
Example 2 If the outdoor temperature is above 22.5, the FAN will START. If
the temperature is below or equal to 22.5, the FAN will STOP.
IF ‘OUTDOOR AIR’ > 22.5 THEN
START FAN
ELSE
STOP FAN
END IF
Example 3 More than one command may follow a THEN or ELSE statement as
follows:
IF OCCUPIED THEN
IF ROOM > 24 THEN
START FAN, CHILLER
ELSE
STOP FAN
END IF
ELSE
STOP FAN, CHILLER
END IF
Although additional levels of nesting are possible, for program clarity, it is not
generally recommended.
IFONCE...THEN...ELSE...END IF
Statement Conditionally executes a statement or a group of statements the first
time that the expression is TRUE. The condition is only considered TRUE the first
time it changes to TRUE. After that, the expression is considered FALSE until it
changes from FALSE to TRUE again.
Statements can be on one or more lines. Also it is possible but not recommended
to put several statements on the same line by separating the statements with one or
more spaces.
You may also place a single statement or multiple statements separated by one or
more spaces immediately following the THEN.
The ELSE and ELSEIF clauses are both optional. You can have as many ELSEIF
clauses as you want in a block, but none can appear after the ELSE. Also, The
compiler converts ENDIF to END IF.
Supported controllers include the enteliBUS, DSC and DAC controllers having
3.40 or newer firmware. This function is NOT supported on the enteliTOUCH.
When this parameter T is passed within the brackets of IntDate, the function
returns the corresponding date as an integer in the yymmdd format. For the year,
only the last 2 digits are used.
If no parameter is passed, the function returns the system date of the controller as
an integer in the yymmdd format:
Comments
On supported controllers, GCL now accepts TimeDate properties which are stored
as 32-bit signed integers and represent the number of seconds since Jan. 1, 1980.
To allow for the fullest range of TimeDate comparisons, Jan. 1, 1980 is assigned
the smallest value (-2,147,483,648), 0 is ~Jan. 19, 2048 and the maximum value is
in the year 2116 (1980 + 136 years).
The yymmdd format from the IntDate function can be assigned to a Real property
such as an. AV.Value. However, assigning a TimeDate to a Real property (e.g.
AV.Value) loses precision as Real values are only accurate to 6 or 7 digits
whereas signed 32-bit values are accurate to 10 digits. In this case, the year is two
digit year and this provides a value with 6 digits so that results can be assigned to
an Analog Variable object.
timeInSeconds = BV1.TimeOfLastWrite
//timeInSeconds = some very large signed
//integer value representing a # of seconds
//from Jan-1-1980 to last time BV1 was written
//ex:-1153153146
BVLastWrittenDate = IntDate(timeInSeconds)
//BVLastWrittenDate = Date in the yymmdd
//format that BV1 was last written on.
//ex:110705 is July 5, 2011
systemDate = IntDate
X = IntDate(BV1.TimeOfLastWrite)
Y = IntDate
IfOnce X = Y then //When BV1 is written today
//Do Something
Endif
curDate = IntDate
curTime = IntTime
4hoursInSec = 14400
//4hours = 4*60*60 = 14400 seconds
Supported controllers include the enteliBUS, DSC and DAC controllers having
3.40 or newer firmware. This function is NOT supported on the enteliTOUCH.
When this parameter T is passed within the brackets of IntDate, the function
returns the corresponding time as an integer in the hhmmss format.
If no parameter is passed, the function returns the system time of the controller as
an integer in the hhmmss format:
timeInSeconds = BV1.TimeOfLastWrite
//timeInSeconds = some very large signed //integer
value representing a # of seconds //from Jan-1-1980 to
last time BV1 was written //ex:-1153153146
BVLastWriteTime = IntTime(timeInSeconds)
//BVLastWriteTime = Time in the hhmmss
//format that BV1 was last written on.
//ex:110705 is July 5th, 2011
systemTime = IntTime
//systemTime = Current controller time
//ex:1330 is 1:30PM
X = IntTime(BV1.TimeOfLastWrite)
curDate = IntDate
curTime = IntTime
4hoursInSec = 14400
//4hours = 4*60*60 = 14400 seconds
LASTOFF
Function Returns the last time that a Schedule turned OFF in TIME format. As
well, this function only works for the ‘current’ day.
Syntax
Comments The result is the return value, an integer number. The schedule is a
reference to a Schedule object.
Example 1 Stop the fan 1 hour after the LASTOFF time in SCH1.
Variable TimeValue
TimeValue = LastOff(SCH5)
LASTON
Function Returns the last time that a Schedule turned ON in TIME format. As
well, this function only works for the ‘current’ day.
Syntax
Comments The result is the return value and is an integer number. The schedule
is a reference to a Schedule object.
Example 1 Stop the fan 1 hour after the LASTON time in SCH1.
Variable TimeValue
TimeValue = LastOn(SCH5)
LEFT
Function Returns a specified number of characters from the left side of a string.
Syntax
Example
LENGTH
Function Returns the length of a string.
Syntax
Example
LIMIT
Function Limits the value of an object between specified low and high values.
Syntax
Example 1 Set the value of the heating valve to that of Control Loop CO1 and
maintain the heating valve within a 20% minimum and an 80% maximum value.
HEATING_VALVE = LIMIT (CO1, 20, 80)
Example 2 Set the heating valve to a specific value and maintain this value
within a range of 0% minimum and 100% maximum.
//Limits Valve to 0% to 100%
Valve = Limit(Valve, 0, 100)
Reference BETWEEN
LN
Function Calculates the natural log of a value.
Syntax
Comments The result is a Real number. The expr is a valid numeric expression
that is greater than zero. If the expr is an integer, the compiler converts it to a real.
Reference LOG
Syntax
LoadFromFlash
Comments - When using LoadFromFlash, you must be sure that the desired
database is saved to flash in the controller. Otherwise, the wrong database could
be loaded, and the current database will be lost.
Note: The controller pauses operation (i.e. outputs remain at their last state,
programs pause execution) during a Load From Flash. Once the database is
loaded into the controller, it begins operation of the loaded database.
Reference SaveToFlash
LOG
Function Calculates the log (base 10) of a value.
Syntax
Comments The result is a Real number. The expr is a valid numeric expression
that is greater than zero. If the expr is an integer, the compiler converts it to a real.
Reference LN
Syntax
Syntax
Comments
MAX
Function Returns the largest value in the list.
Syntax
Comments The result is a Real number. The expr is a valid numeric expression.
If the expression is an integer, the compiler converts it to a real. The expr-n term
denotes an element in a list of values.
There may be an arbitrary number of values in the list. The compiler converts the
GCL HSEL to MAX.
MID
Function Extracts a substring from another string.
Syntax
The length-expr is the optional expression for length to extract. If not specified,
the rest of the string after the start position is extracted.
MIN
Function Returns the smallest value in the list.
Syntax
Comments The result is a Real number. The expr is a valid numeric expression.
If the expr is an integer, the compiler converts to a real. The optional expr-n term
denotes an element in a list of values.
There may be an arbitrary number of values in the list. The compiler converts the
GCL function LSEL to MIN.
MINUTES
System Variable Returns current number of minutes past the hour as an integer
from 0 to 59. If an optional time is passed in, the number of minutes is extracted
from the time.
Syntax
If Minutes = 1 Then
Start Fan
End If
MONTH
System Variable Returns the month of year expressed as a number—1 through
12.
Syntax
variable = MONTH
MONTHDAY
System Variable Returns current day of the month as an integer from 1 to 31. If
an optional date is passed as an argument, the day of the month is extracted.
Syntax
Comments The compiler does not convert the GCL Mday to MonthDay
If MonthDay = 1 Then
STOP FAN
END IF
NEXTOFF
Function Returns the next time that a schedule will turn OFF in TIME format
for the current day. This function only works for the ‘current’ day.
Syntax
If it is not the current day, or if the there is no NEXTOFF time for the current day
then a current TIME value of 2400 is returned.
Example 1 Stop the fan 1 hour before the NEXTOFF time in SCH5.
Variable TimeValue
TimeValue = NEXTOFF (SCH5)
NEXTON
Function Returns the next time that a schedule will turn on in TIME format for
the current day. This function only works for the ‘current’ day.
Syntax
If it is not the current day, or if the there is no NEXTON time for the current day
then a current TIME value of '2400' is returned.
Example 1 Start the fan 1 hour before the NEXTON time in SCH1.
Variable TimeValue
TimeValue = NEXTON( SCH5 )
NOT
Logical Operator Returns TRUE(1) if the expression is FALSE(0).
Syntax
NOT expr
OFF
Status Operator Determines the state of a variable. The state is TRUE (1) if the
variable is OFF and is otherwise FALSE (0).
Syntax
variable OFF
OFFFOR
Status Operator Returns False (0) until the variable has been off for the
specified time interval, then returns True (1) until the variable goes on.
See the Using DoEvery, OnFor and OffFor section starting on page 11-34 for a
description of the proper use of these statements.
Syntax
Comments The time interval is from 0 seconds to 3276 hours. Enter the time
value followed by the time units:
The time value is a number or an analog variable. The time units are S (seconds),
M (minutes), or H (hours). To specify the time interval as an analog variable, use
a variable:time units format.
If the analog variable value is changed, the new time is not effective until after the
previous value has finished counting down.
OFFFOR provides a time delay between sensing a change in input state and taking
action based on that change.
OFFFOR runs on a timer. Although the timer runs continuously, the value is only
tested when the statement is scanned by the PG (which runs on its own timed
circuit). Consequently, the OFFFOR value may not change on schedule because
the line of code will not be read until the PG completes its circuit.
Example 1 Stop the PUMP after the CHILLER is off for 30 minutes :
Example 2 It is also possible to run the PUMP for a variable number of minutes
after the CHILLER stops based on a status variable.
Variable TIME_INTERVAL As Real
Variable STATUS_FLAG As Integer
IF STATUS_FLAG THEN
TIME_INTERVAL = 30
ELSE
TIME_INTERVAL = 20
END IF
IF CHILLER OFFFOR TIME_INTERVAL:M THEN
STOP PUMP
END IF
ON
Status Operator Determines the state of a variable. The state is TRUE(1) if the
variable is ON and is otherwise FALSE(0).
Syntax
variable ON
IF FAN ON THEN
START PUMP
ELSE
STOP PUMP
ENDIF
ONFOR
Status Operator Returns False (0) until the variable has been on for the
specified time interval, then returns True (1) until the variable goes off.
See the Using DoEvery, OnFor and OffFor section starting on page 11-34 for a
description of the proper use of these statements.
Syntax
Comments The time interval is from 0 seconds to 3276 hours. Enter the time
value followed by the time units.
The time value is a number or a variable The time units are S (seconds), M
(minutes), or H (hours). To specify the time interval as a variable, use a
variable:time units format.
If the variable value is changed, the new time is not effective until after the
previous value has finished counting down.
ONFOR provides a time delay between sensing a change in Input State and taking
action based on that change.
ONFOR runs on a timer. Although the timer runs continuously, the value is only
tested when the statement is scanned by the PG (which runs on its own timed
circuit). Consequently, the ONFOR value may not change on schedule because
the line of code will not be read until the PG completes its circuit.
Example Start the SUPPLY FAN 15 seconds after the RETURN FAN has
started:
If Return_Fan Onfor 15s Then
Start Supply_Fan
End If
OR
Logical Operator Returns TRUE(1) if at least one expression is true.
Syntax
(expr1) OR (expr2)
Example Stop the FAN if the Schedule is OFF or the outdoor temperature is
below 18 C.
IF (SCHEDULE OFF) OR (OUTDOOR_TEMP < 18) THEN
STOP FAN
END IF
POWERUP
Function Returns TRUE(1) during the first scan when a controller starts up.
Syntax
result = POWERUP
Comments The result is an Integer number. The result is TRUE (1) only during
the first scan of the controller and is otherwise FALSE (0).
Example
If PowerUp Then
Print "Hello World"
End If
PRINT
Function Sends a text string to a specified EVR object to be printed, sent to a
text file, emailed, or sent to a pager or Short Messaging Service (SMS) capable
device. Printing is now done through the Event Router (EVR) object. The PRS
object is no longer available and the EVR object is used instead. The PRINT
command only works with local EVR's. You cannot Print to an EVR object on a
remote device.
Syntax
Comments The specific Event Router object (e.g. EVR1) is required in the Print
function as it specifies where text is sent.
Note: Since GCL+ programs are called continuously, you must ensure that Print
statements are not executed every program scan. Make sure that you put the Print
function in a conditional test such as an IfOnce or DoEvery statement. Otherwise,
t will print every scan of the program ( i.e. it will print 5 pages every second).
The Print function works on the OWS, the DCU and the DSC. DAC controllers do
not support the Print function since they do not support the EVR object. On the
OWS, you can print to a text file or a printer. When printing, you have to specify
the destination using the EVR objects. By default, the system creates EVR1 on the
OWS and it is configured to print to a file. If you have other printers installed in
Windows, the system automatically creates EVR objects for them in the OWS.
To use the PRINT command in a controller, an EVR object must be created in the
controller and configured for local printing. The controller must be reset after
creating the EVR object so that the EVR object can obtain the PTP port.
If you are using the EVR object only for the GCL+ PRINT function, you need to
delete all entries in the ‘Class and/or Events to Route’ list. This ensures that the
EVR does not print out alarms to the printer.
Note: You cannot ‘print to file’ or print to network printers directly from a DCU
or DSC controller. However, the Print function prints to both local and network
printers from the OWS. The DCU, DSC and DAC can all direct Alarm
Notifications to the OWS for printing using an EVC.
DCU Controller On the DCU, you must have a DXC053-PC104 card for
printing to work. The printer is connected to the DXC053 through a printer cable
and the parallel interface of the card.
DSC Controller To send text to a printer using a DSC, you must have a serial to
parallel converter connected to the serial port. The printer is connected to the
serial to parallel converter through a printer cable that connects to the parallel port
on the printer.
On the DSC, the PrintStatus function needs to be used whenever using the PRINT
function to send text to a printer. The PrintStatus function is not required for other
destinations. The DSC could drop characters if the PRINT function is sending
characters to the serial port faster then it can transmit out the line. This can occur
if the controller is using multiple PRINT statements.
On the DSC, it is not recommended to send long strings. Using a single PRINT
statement, the DSC is limited to sending up to 368 characters. Anything greater
than 368 characters is truncated. Since each string in GCL can't be more than 128
characters long, if you use concatenation ‘&’ in the Print function, you can print
up to 368 characters using a single PRINT statement.
On a DSC, when using the Print function to a printer, you must select "Line Feed"
or "Form Feed" from the 'End of Job Insert' field in the Setup tab of the associated
EVR object. If you leave it set as the default value "None", the printer may print
excess unwanted characters or drop characters.
DSC Ability to PRINT any ASCII character Any ASCII character can be
included in the text string when using the PRINT function with a DSC, including
non-printable characters. This allows for customizing the layout of the printed text
or for interfacing with equipment through the RS-232 port such as CCTV systems,
etc.
Note: The ability to print any ASCII character is only available with a DSC (not
the OWS or DCU).
To include an ASCII character in the text string, use the '\' character followed by
the 3-digit decimal value of the ASCII character.
World
Syntax:
• The number following the '\' character is a 3-digit number, in the range 000 to
255. Leading zeros are required if the value is less than 100.
• This syntax is restricted to the GCL PRINT command. All other GCL string
functions will treat the string literally.
• To print the '\' character, use two consecutive slashes "\\".
(e.g. PRINT to EVR1 "Hello World\\")
In the EVR object, if the End of Job Insert is set to Line Feed, a Carriage Return
(CR) and Line Feed (LF) will be inserted after each PRINT command. If the End
of Job Insert is set to None, the Carriage Return (CR) and/or Line Feed (LF) codes
can be inserted manually into the string. For example:
PRINT To EVR1 "Hello World\013" //CR
PRINT To EVR1 "Hello World\010" //LF
PRINT To EVR1 "Hello World\013\010" //CR and LF
Reference PRINTSTATUS
Example The following code segments show the use of the Print function. You
need to specify the EVR object defined on your device that prints to the desired
location.
// Print a single line of text every 30 minutes
//Your device may use an EVR object other than EVR2
DoEvery 30M
Print To EVR2 "This is a test"
End Do
DoEvery 30M
Print To EVR2 "The value of AV1 is " & AV1
End Do
Variable Setpoint
Variable OAT1 as Real
IfOnce OAT1 > 86 and Weekday = 1 Then
Setpoint = 66
Print To EVR1 "OAT1 value >86 on a Monday (" & OAT1 &")"
End If
In the following figure, the names of the EVR objects are displayed in the Program object. EVR1 displays as
‘Print to File’ and EVR2 displays as ‘Lexmark Optra S 1855’.
Syntax
result = PrintStatus
Comments The PRINTSTATUS GCL function only works in the DSC and not
on the DAC, DCU, or OWS.
On the DSC, the PrintStatus function needs to be used whenever using the PRINT
function .The DSC could drop characters if the PRINT function is sending
characters to the serial port faster then it can transmit out the line. This can occur
if the controller is using multiple PRINT statements.
The following GCL code will print every 10 minutes as soon as any previous
characters have been printed.
If PrintStatus = 0 Then
DoEvery 10M
Print To EVR1 "The value of AV1 is " & AV1
End Do
End If
Reference Print To
A BDE object defines a group of data items that are exchanged together. The
exchanged item values are directly GCL accessible using the READ function.
Since the values are available in an object, the powerful GCL+ FORALL
command is available. See Example 3 for more detail.
Syntax READ accepts one string parameter and returns the reference's value.
The format of the string parameter is either:
“BDE:<BDEName>.<NetworkNameTag>”
For example:
av1 = READ( "BDE:GlobalVariables.OAT" )
//GlobalVariables is the name of the BDE object
//OAT is the name tag of the entry in the BDE object
//On the Receive Entries tab
“<ObjectPropertyReference>”
For example:
Even though the parameter does not have prefix, double quotes are required
before and after the object property reference.
READ() only determines the reference value when it is called and is undefined at
the start of the PG scan.
The example of common properties that Read() can handle are: (present) value,
name, and description.
The value property does not need to be specified. If no property name is given, the
default Read/Write property in the object definition is used which typically is the
value property.
av1 = Read("BDE:GlobalVariables.OAT")
Example 3 Use ForAll to find the maximum, minimum and average of all
remote variables with “IAT” network name tag from the Receive Entries of
the local BDE objects.
total = 0
i = 0
i = i + 1
End For
averageval = total / i
Example 4 Read various type of properties and write them on Description tab
of AV dialog
AV1.Description = Read ("sch1.Description")
AV2.Description = Read ("cal1.Name")
AV3.Description = Read ("av1.Value")
Reference ForAll
RELINQUISH
Command Statement This command is used to remove GCL control of an
object or value. Relinquish writes a null value to the priority level that the
particular Program uses to write to. For example, if the Program is writing to the
default priority 10, then the Relinquish command will write a null to priority 10.
If the object you are trying to relinquish does not have a priority Array, (for
example Delta's AV, BV, and MV objects), it will write a null to the GCL Value
(Auto Value) property and not the Present Value. Relinquish may be useful for
3rd party AV, BV, MV objects that have priority arrays.
Syntax
Examples
Relinquish AO1, BO2
RESET
Command Statement Resets the state of a particular object.
Syntax
RIGHT
Function Returns a specified number of characters from the right side of a
string.
Syntax
result A String.
string-expr A valid string expression.
length-expr An integer number from 0 to N that determines the number of
characters to return. If negative or 0, a zero-length string is
returned. If greater or equal to the number of characters in the
string-expr, the entire string is returned.
Example
ROUND
Function Rounds a real value to the specified number of decimal places.
Syntax
Syntax
SaveToFlash
Note: The controller pauses operation (i.e. outputs remain at their last state,
programs pause execution) during a Save To Flash. Once the database is saved, it
continues operation.
Reference LoadFromFlash
SCALE
Function Scales an input expression using linear interpolation of (x,y) data
pairs. The X data point defines the horizontal axis value and the Y data point
defines the vertical axis of a standard Cartesian coordinate system.
input-expr , The input-expr and bias-expr define the values to scale using
bias-expr , linear interpolation of (x,y) data pairs. The input-expr is an x
value and the bias-expr (x,y) is a vertical bias value
The result cannot exceed the value of the y2-expr plus the bias-expr. In the
following example, the value will not exceed 102 for a positive Input value. In the
following example, the value will not exceed 2 for a negative input value.
Typically, this function is used to calculate a y value that is within the 0-100 range
for a each x Input value. The Scale function is often used with Analog Inputs and
Analog Outputs.
SECONDS
System Variable Returns current number of seconds past the minute as an
integer from 0 to 59.
Syntax
result = SECONDS
Example
where D is in date format, e.g. SetDate(8-May-2011) will set the date to May, 8
2011
where D = Day, M = Month, and, Y = Year e.g. SetDate(15, 3,2011) sets the date
to 15-March-2011
Comments The SetDate Function sets the date on the controller and returns 0
indicating invalid date/fail or 1 indicating valid date/success.
Note: Because GCL+ programs are called continuously, you must ensure that
statements such as SetTime and SetDate are not executed every program scan.
Ensure that you put the function in a conditional test such as an IfOnce or
DoEvery statement. Otherwise, it will execute every scan of the program.
Example 2 Set date on a controller using input in the dd, mm, yyyy format
Variable Result as Integer
Result = SetDate (15, 3, 2009)
//Sets date to March 15, 2009
The SetSchedule function displays a menu on the LCD of a Room Controller. The
following block diagram illustrates how to navigate through this menu.
Key 5
↓
→ On time → Off time →
Monday “Add”* → Next day…
← ↑↓- Adjust ← ↑↓- Adjust ←
↑↓
→ On time → Off time →
Tuesday “Add”* → Next day…
← ↑↓- Adjust ← ↑↓- Adjust ←
↑↓
↑↓ * “Add”
New On → New Off
Sunday → ↑↓- Adjust ↑↓- Adjust →
←
Legend:
← (Left) Key 6 → (Right) Key 7 ↑ (Up) Key 3 ↓ (Down) Key 2
Keypress Identifies the number relating to the function command that you
want the function to execute.
# of SCH Defines the object number of the Schedule that is referenced
object when the SetSchedule function is called.
The following table lists the purpose of each number that can be used as the
Keypress parameter for the SetSchedule function:
SetSchedule Purpose
Keypress
Parameter
Subfunction
Number
1 Nothing
2 Decrements the minutes (or hours) of the displayed time
3 Increments the minutes (or hours) of the displayed time
4 If this button is held down when either 2 or 3 is pressed, then 2
or 3 will adjust the hours of the displayed time
5 Turns the SetSchedule mode on and off
6 Scrolls backwards through on and off times
7 Scrolls forwards through on and off times
8 Nothing
Note: When you call SetSchedule or SetTimeDate, then you must ensure that your
GCL+ programming allows you to continue to call the function. Otherwise, you
will not be able to exit the function.
If Lcd0.keypress = 1 then
SetSchedule(5 ,3)
End If
The recommended way to use this function is with the keypress property of the
LCD object as the variable. This approach requires only 3 lines of code to provide
a fully functioning schedule adjustment routine.
Result = SetTime(H,M)
Comments The SetTime Function sets the time on the controller and returns 1
if the Time was set successfully, and 0 if the Time is invalid. The SetTime
function does not change the time if an invalid value is specified.
Note: Because GCL+ programs are called continuously, you must ensure that
statements such as SetTime and SetDate are not executed every program scan.
Ensure that you put the function in a conditional test such as an IfOnce or
DoEvery statement. Otherwise, it will execute every scan of the program.
CurTime =IntTime
//CurTime should have an integer value representing the
//current controller time in the hhmmss format
//ex:152500
Hrs= 15
M = 25
Result = SetTime(Hrs,M)
//SetTime(15,25) set the time to 15:25 (3:25 p.m.)
Variable Result3 as Integer
CurTime = IntTime
//CurTime is 152500
Result = SetTime(2430)
//2430 is invalid – 0030 should be entered for 12:30am
//Result is 0, and controller time is not set to 12:30am
Syntax SetTimeDate(Keypress)
Keypress Identifies the number relating to the function command that you
want the function to execute.
The following table lists the purpose of each number that can be used as the
Keypress parameter for the SetTimeDate function:
SetTimeDate Purpose
Keypress
Parameter
Subfunction
Number
1 Nothing
2 Decrements the minutes (or hours) of the displayed time
3 Increments the minutes (or hours) of the displayed time
4 Nothing
5 Nothing
6 Scrolls backwards through the adjustable parameters
7 Scrolls forwards through the adjustable parameters
8 Turns the SetTimeDate mode on and off
It is recommended that you use only the following approach to prevent confusion.
Example
//SetTimeDate Test
If Lcd0.keypress <> 0 then
SetTimeDate (Lcd0.keypress)
End if
Note: When you call SetSchedule or SetTimeDate, then you must ensure that your
GCL+ programming allows you to continue to call the function. Otherwise, you
will not be able to exit the function.
SIN
Function Calculates the sine of a value. The input is specified in degrees.
Syntax
Comments The result is a Real number within the range of -1 to +1. The expr is
a valid numeric expression. If the expr is an integer, the compiler converts it to a
real.
SQRT
Function Calculates the square root of a value.
Syntax
The result is a Real number. The expr is an arbitrary numeric expression that is
greater than zero. If the expression is an integer, the compiler converts it to a real.
START
Command Statement Turns the state or value of each object property in the list
to ON (1).
Syntax
Syntax
Example Concatenation
STOP
Command Statement Turns the state or value of each object property in the list
to OFF (0).
Syntax
SUB...END SUB
Statement Creates a user defined subroutine.
Example 1 Use any program other than PG1, as a subroutine. Enter the program
name or acronym and number in a statement or program line:
CALL PG3
Example 2 Create subroutines for assigning a value to Status and for finding the
absolute value of a number.
Sub Common
STATUS = 5
End Sub
Example 3 Create two subroutines to control an air handling unit with single
stage heating and cooling.
The operating requirements are as follows:
• During occupied hours, run the fan continuously and cycle the heating and
cooling to maintain the space temperature between 21.5°C and 24°C.
• During unoccupied hours, stop the cooling and cycle the fan and heating to
maintain the night setback temperature at 15°C.
//
If Sch1 On Then
Call Occupied
Else
Call Unoccupied
End If
Sub Occupied
Start Fan
If Temp > 24 Then
Start Cooling
End If
If Temp < 23 Then
Stop Cooling
End If
If Temp < 21.5 Then
Start Heating
End If
If Temp > 22.5 Then
Stop Heating
End IF
End Sub
Sub Unoccupied
Stop Cooling
If Temp < 15 Then
Start Fan, Heating
End If
If Temp > 16 Then
Stop Fan, Heating
End If
End Sub
SUNRISE
System Variable Returns the time that the sun rises in DECIMALTIME format
as a number from 0 to 2400. In 3.30 or later, both the Sunrise and Sunset GCL
function adjust for Daylight Savings Time (DST).
Syntax
Comments This function requires that the latitude and longitude be correctly
stored on the Description tab of the DEV object, along with the correct adjustment
for UTC which was previously called GMT. The UTC (or GMT) offset is entered
on the Time Info tab of the DEV object.
For the DCU, check the UTC Enable checkbox and then enter a signed offset in
minutes in the UTC Offset field.
Note: Small image DAC's do not support SUNRISE or SUNSET because the
controller needs a real-time clock to determine the UTC Offset and DST settings.
Since small image DAC's do not have a real-time clock, these functions do not
work. These functions work on any other controller that has a real-time clock (i.e.
DSC, DCU).
Example Calculate the Sunrise time for a day and turn off parking lot lights
Reference SUNSET
SUNSET
System Variable Returns the time that the sun sets in DECIMALTIME format
as a number from 0 to 2400. In 3.30 or later, both the Sunrise and Sunset GCL
function adjust for Daylight Savings Time (DST).
Syntax
Comments This function requires that the latitude and longitude be correctly
stored on the Description tab of the DEV object, along with the correct adjustment
for UTC which was previously called GMT. The offset is entered on the Time
Info tab of the DEV object.
For the DCU, check the UTC Enable checkbox and then enter a signed offset in
minutes in the UTC Offset field.
Note: Small image DAC's do not support SUNRISE or SUNSET because the
controller needs a real-time clock to determine the UTC Offset and DST settings.
Since small image DAC's do not have a real-time clock, these functions do not
work. These functions work on any other controller that has a real-time clock (i.e.
DSC, DCU).
Example Calculate the Sunset time for a day and then turn on the parking lot
lights an hour earlier.
Variable TimeValue As Integer
TimeValue = DecimalTime
IfOnce TimeValue > 1 Then
SunsetTime = (Sunset (Date)) - 100
End If
IfOnce TimeValue > SunsetTime Then
Lights = On
End If
Reference SUNRISE
SWITCH
Function Switches a value ON or OFF based on analog input values. The value
being switched must be binary.
Syntax
Examples 1 If the temperature is below 16, then the Switch function is ON and
stays on till the temperature exceeds 18. As the temperature decreases below 18,
the switch function stays OFF till it reaches 16 and then turns ON.
HTG_PUMP = SWITCH (HTG_PUMP, OUTDOOR_TEMP, 16, 18)
System Variable
System Variable Store system information such as time and date for use by all
the programs on a controller.
• SUNSET
• TIME
• WEEKDAY
• YEAR
The DATE returns an internally coded number. The DATE is typically used with
Comparison Operators.
TAN
Function Calculates the tangent of a value. The TAN function is SIN/COS. The
input is specified in degrees.
Syntax
Comments The result is a Real number. The expr is a valid numeric expression.
If the expression is an integer, the compiler converts it to a real.
THEN
Statement Indicates the end of the IF or IFONCE expression. The statements
that follow execute when the IF expression is TRUE.
Syntax
THEN
Comment The THEN statement must be on the same line as the IF, ELSEIF or
IFONCE.
TIME
System Variable Expresses the current time of day as an integer in a military
time format from 0 to 2400.
Syntax
variable = TIME
Comment Previously, the GCL System Variable TIME used a 00:00 to 23:59
format but the GCL+ TIME is a 0 to 2400 format. The compiler accepts either 730
or 7:30.
Example
Supported controllers include the enteliBUS, DSC and DAC controllers having
3.40 or newer firmware. This function is NOT supported on the HMI.
Where:
Date is the integer value in the yymmdd format, and time is the integer value in
the hhmmss format.
Example 1 Proving that ToSeconds( date, time ) is the inverse of IntTime &
IntDate
Variable TimeInSeconds as Integer
Variable TimeVar as Integer
Variable DateVar as Integer
Variable Result as Integer
TimeInSeconds = bv1.TimeOfLastWrite
TimeVar = IntTime(TimeInSeconds)
DateVar = IntDate(TimeInSeconds)
Result = ToSeconds(DateVar,TimeVar)
//Result is the same as TimeInSeconds
curDate = IntDate
curTime = IntTime
4hoursInSec = 14400
//4hours = 4*60*60 = 14400 seconds
TRUNCATE
Function Removes the decimal part of a real number.
Syntax
Example
You may type in var or Var and the compiler translates it to VARIABLE. The
compiler converts the GCL statements Local and Array to VARIABLE.
Reference CONSTANT
WEEKDAY
System Variable Expresses the weekday as an integer from 1 (Monday) to 7
(Sunday). If an optional date is passed, then the day of the week is extracted.
Syntax
Comments The WEEKDAY system variable now defines the days of the week
as 1 (Monday) to 7 (Sunday) to conform to the BACnet standard. Before in GCL,
it was 1 (Sunday) to 7 (Saturday).
Example 3 Use the WEEKDAY system variable to run Fan6 on each Monday.
If Weekday = 1 Then
Start Fan6
End IF
Specifically this function allows the user to write to object properties without
hard-coding the references into the GCL code.
For example:
BV1 = Write("AV1",AV2)
Where the value of AV1 is the target property and the value of AV2 is the source
property. The Write function returns 1 if the write was successful, and 0 if
unsuccessful.
Write() only determines the reference value when it is called and is undefined at
the start of the PG scan.
The example of common properties that Write() can handle are: (present) value,
name, and description.
The value property does not need to be specified. If no property is given, the
default Read/Write property in the object definition is used which typically is the
Value property.
Supported controllers for READ/ WRITE include the enteliBUS, DSC and DAC
controllers having 3.40 or newer firmware. A BDE object may be used in the
function but is only supported on eBUS and devices with DSC16 and DAC8
image.
Comments The Write() function behaves differently than if the reference was
coded directly into GCL, e.g. av1 = av2.Value. The value of the reference is only
written when Write() is called, where as if the reference was hard coded the
property is written at the start of the PG scan. Using Write() will also be a little
slower, but allows the GCL code to dynamically construct the reference.
XOR
Logical Operator Returns TRUE if one expression is true and the other is
FALSE.
Syntax
Comments Start the FAN if either PUMP1 or PUMP2 is on, but stop the FAN if
both PUMP1 and PUMP2 are on.
YEAR
System Variable Returns the current year as a four digit integer. If an optional
date is passed as an argument, the year of that date is extracted.
Syntax
Index GCL+
—A — execution of programs · 11-36 to 11-40
ABS · 11-68 execution order · 11-36
AND · 11-68 —F —
ARCCOS · 11-68 FOR...END FOR · 11-84
ARCSIN · 11-69 FORALL · 11-85
ARCTAN · 11-69 FORMAT (Room Controller) · 11-88
Assignment = · 11-69 Function
AVERAGE · 11-70 DECIMAL · 11-78
—B — DEWPOINT · 11-80
BDE function keys
Read · 11-115 GCL+ Editor · 11-29
BETWEEN · 11-71 Functions · 11-20
Bitwise Operators · 11-72 ABS · 11-68
table listing · 11-25 ARCCOS · 11-68
blank space ARCSIN · 11-69
GCL+ program · 11-60 ARCTAN · 11-69
branching to a program line · 11-38 AVERAGE · 11-70
COS · 11-76
—C — DAYON · 11-78
CALL · 11-73 ENTHALPY · 11-83
Commands IntDate · 11-95
RELINQUISH · 11-118 IntTime · 11-96
RESET · 11-119 LASTOFF · 11-98
START · 11-129 LASTON · 11-98
STOP · 11-130 LEFT · 11-99
table listing · 11-20 LENGTH · 11-99
Comment · 11-74 LIMIT · 11-100
commenting programs · 11-31 LN · 11-100
Comparison Operators · 11-75 LOG · 11-101
table listing · 11-24 MAX · 11-103
CONSTANT · 11-75 MID · 11-103
COS · 11-76 MIN · 11-104
—D — NEXTOFF · 11-105
DATE · 11-77 NEXTON · 11-106
DAY · 11-77 POWERUP · 11-110
DAYON · 11-78 PRINT · 11-100, 11-110
DECIMAL · 11-78 PRINTSTATUS, DSC only · 11-114
DECIMALTIME · 11-79 Read · 11-115
delimited user defined names · 11-46 RIGHT · 11-119
DEWPOINT · 11-80 ROUND · 11-119
DOEVERY · 11-33, 11-80 SaveToFlash, DAC/DSC only · 11-120
equivalent · 11-33 SCALE · 11-121
SetDate · 11-122
—E — SetTime · 11-126
Editor for GCL+ · 11-29 SIN · 11-128
ELSE · 11-82 SQRT · 11-129
ELSEIF · 11-82 SWITCH · 11-134
END · 11-82 table listing · 11-20
END FOR · 11-83 TAN · 11-136
END IF · 11-83 ToSeconds · 11-137
END SUB · 11-83 TRUNCATE · 11-138
ENTHALPY · 11-83 Write · 11-141
Table of Contents
OVERVIEW ........................................................................................................... B-6
ORCAVIEW SETTINGS (CMS) B-6
Always on Top ....................................................................................... B-6
Auto Hide .............................................................................................. B-6
Show Navigator on Startup ................................................................... B-6
Alarm Sound File .................................................................................. B-7
Site Graphic Path .................................................................................. B-7
NAVIGATOR SETTINGS (NVS) B-7
SETUP TAB ........................................................................................................... B-7
Splitter Bar Full Drag ........................................................................... B-7
Show Graphics folder............................................................................ B-8
Refresh Rate .......................................................................................... B-8
Fixed Point ............................................................................................ B-8
Decimal Places ..................................................................................... B-8
DEVICE GRAPHIC TAB.......................................................................................... B-8
DRAWING SETTINGS (DWS) B-9
Snap to Grid ........................................................................................ B-10
View Grid ............................................................................................ B-10
Grid Settings ....................................................................................... B-10
Use White Grid ................................................................................... B-10
Lasso must enclose to select ................................................................ B-10
Site Graphic Resizing Checkbox ......................................................... B-10
GCL SETTINGS (GCS) B-11
Current Font: Name ............................................................................ B-11
Current Font: Size............................................................................... B-11
Current Font: Change Settings Button................................................ B-11
Font Settings: Tab Spacing ................................................................. B-12
Font Settings: Enable Line Numbering ............................................... B-12
Styles and Colors ................................................................................ B-12
Reset Button ........................................................................................ B-12
SERVER STARTUP SETTINGS (SSS) B-13
Periodic Device Check: Enable Device Check ................................... B-13
Periodic Device Check: Device Check Interval .................................. B-13
Periodic Device Check: Start a New Round Every ............................. B-14
General Server Options: Language .................................................... B-14
General Server Options: Auto Load Descriptors ................................ B-14
General Server Options: Auto Find Devices....................................... B-15
Advanced Server Options: Verify Client Connection .......................... B-15
Advanced Server Options: Close After ORCAview ............................. B-15
Advanced Server Options: Enable Remote Descriptor File Loading [New
3.40] .................................................................................................... B-16
DEVICE (DEV) B-17
Overview
All Preferences and Setup options are documented here. Preferences are set by
software objects that provide display options for the main ORCAview menu, the
Navigator and other software objects. The display options are set to a default
selection by the installation program.
The Setup options are selected using software objects that configure and setup
various functions. For example, you must use the GCL Settings software object to
configure how the programs will be displayed by Navigator.
To open this object, from the ORCAview Dashboard, select Preferences and then
click ORCAview.
Always on Top
Select this option to always place the ORCAview Dashboard on top of any other
programs currently running.
Auto Hide
When the Dashboard is docked against one the top or bottom edge of your screen,
it will be automatically hidden unless you place your mouse cursor over the area
of the hidden Dashboard.
You can open the Navigator Settings (NVS) object from the ORCAview
Dashboard. Choose tools, select Preferences and then click on Navigator.
Setup Tab
Navigator Preferences allow you to select the following:
Refresh Rate
Sets the frequency of information updates when the Navigator is set to Details
view. This box can have a value of 5, 10, 30, or 60 seconds.
Fixed Point
If this box is checked the Value column in Navigator will display the amount of
decimal places as defined in the Decimal Places field.
Decimal Places
Sets the number of decimal places that the Value column will display when
Navigator is set to Details view.
A designated GPC graphic can display when the Device (DEV) object is opened
using the right mouse Open command in the Left Pane of Navigator. The DEV
object opens normally when the object is double clicked in the Right Pane of
Navigator.
The Device Graphic tab of the Navigator Settings (NVS) / Device Graphic List
(DGL) object defines the available graphic files in a local manner. This Device
Graphics tab on NVS provides a way to provide an exception to what is defined in
the Controller Graphic field on the Configuration tab of the Device (DEV) object.
It makes a local definition of the designated graphic for a specific OWS. The
Controller Graphic field can be overridden by the Device Graphic defined in the
Navigator Settings object.
The Device graphic tab of NVS is intended to define local exceptions for a
specific OWS while Controller Graphic field on the Configurations tab in the
Device (DEV) object allows a designated graphic to be defined in a more global
manner for any OWS that opens the controller from its left pane.
The dataview for the Device Graphic has the following two column headings:
Graphic File The Graphic File field designates the graphic file. A path must be
supplied along with the graphics name if the graphic is located somewhere other
than the Graphics folder.
Device The Device field assigns the graphic file to the device number.
To assign the graphic file, double click under the Device heading. Then, type the
appropriate Device number. For a DCU, you might type 1600 and the name of the
device object Air Handling Unit 2 displays. Existing entries can be deleted by
clicking on the row and pressing the delete key.
This feature only works in the left pane of Navigator. If a controller or device is
enabled, then the designated graphic opens.
With 3.30 Release 3, the default size of the drawing area is 22,000 X 30,000
pixels The size in the property menu includes the caption and border and so is
slightly larger than just the drawing area.
Snap to Grid
Enable this box to force objects to align themselves to the grid when they are
drawn. This assists in aligning and proportioning objects. If Snap to Grid does not
allow you to position objects as you would like, change the grid settings. Usually
checking Snap to Grid is the best option for most drawing work. For extremely
fine positioning, you may wish to uncheck Snap to Grid.
View Grid
When this box is enabled, the grid is visible.
Grid Settings
Sets the grid size. The larger the number, the larger the grid squares.
Reset Button
The Reset button returns all the options to the default setting of the object.
Note: Changes to these settings do not take effect until ORCAview is restarted.
If Auto Load Descriptors is enabled, ORCAview will load descriptors every time
it detects that an object is created, deleted or renamed while the Operator
Workstation was not online.
If Auto Load Descriptors feature is disabled, ORCAview will not load descriptors
upon startup and will only load a device’s descriptors when you select the device
in navigator. By disabling the Auto Load Descriptors feature, you can reduce
and/or spread out network traffic on slow or congested networks. This feature is
especially useful for technicians that connect to sites via modem.
There are 3 choices in the Auto Load Descriptors Drop down Menu:
• Always
• Never
Note: Descriptors will only be loaded when ORCAview's cached set of descriptors
is not in sync with the set of descriptors in the device. If Auto Load Descriptors is
disabled, some advanced features of ORCAview may not work correctly, such as
Custom Views. Occasionally ORCAview will present "Unknown Object" instead
of the object's descriptor. This occurs when ORCAview does not have the up to
date set of descriptors for a device.
Enabled When Auto Find Devices is enabled, the OWS looks for unknown
devices upon startup.
Disabled When Auto Find Devices is disabled, the OWS does not attempt to
locate devices on startup or when connecting to a remote network. Even though
the OWS does not actively search out devices, the OWS will notice any device
that does indicate its presence. Any device that indicates its presence on the
network, and is thus found by the OWS, will be confirmed and its descriptors will
be loaded.
There are 3 options for the Auto Find Devices field in the SSS object: Never,
Always, or Always except over RS232. The default value is Always except over
RS232. If the OWS has multiple adapters enabled and at least one of them is a
PTP or V2 Serial adapter, then Auto Find Devices will be disabled.
Example If the DDE server and ORCAview are both running and the DDE
server ceases to respond, then the SI Server will close the DDE server.
Example If the DDE server and ORCAview are both running, the Delta Server
will not close when ORCAview closes. Both clients must exit before the Delta
Server will close.
DEVICE (DEV)
The Device (DEV) object contains general information about the controller
including status, setup, and configuration. The object is automatically created by
the operating system and numbered according to the logical address of the DCU
or DAC controller. Thus, controller 100 would have the object acronym of
100.DEV100, while controller 600 would have the object acronym of
600.DEV600.
You can copy a complete panel database to or from a file on disk, by copying to or
from the DEV Object. In Navigator, right click on the desired controller. Select
LOAD to copy from a file; or, select SAVE AS to save to a file.
The Controller Graphic field on the Configuration tab of this object allows a
designated graphic to be defined in a global manner for any OWS. This graphic
can display when the DEV object is opened using the right mouse Open command
in the Left Pane of Navigator. The Device object opens normally in the Right
Pane of Navigator when the object is double clicked.
The Device Graphic tab on NVS provides a way to provide an exception and
make a local definition of the designated graphic. The Device Graphic tab of the
Navigator Settings (NVS) / Device Graphic List (DGL) object defines the
available graphic files in a local manner for a specific OWS.
Header
System Status
This read only value indicates the current state of the device. The status
descriptions are:
• OPERATIONAL
• OPERATIONAL_READ_ONLY
• DOWNLOAD_REQUIRED
• DOWNLOAD_IN_PROGRESS
• NON_OPERATIONAL.
If the controller does not have a real-time clock, this field will be updated when it
receives the current time (i.e. Time Synchronization message or selecting Tools ->
Set Panel Time). It calculates the time that the last reset occurred at by taking the
current time and subtracting the elapsed time since the reset.
Reset Count
This read-only field indicates the number of times that the device has been reset
since the last time the database was cleared.
Reset Reason
This read-only field displays the reason for the last Reset. This field may be blank,
or may have one of the following reasons: Shutdown, Poweroff, or Error Reset.
Description
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller. It is recommended that each name be
unique within a BACnet network.
Software Address
This field sets a software address for a controller that is configured for software
addressing.
On the DCU controller, this field defines the address of the controller when all the
DIP switches are set to OFF.
Note: The DCU or DAC controller must be reset to activate the software
addressing option.
On DAC products, the DNA jumper must be removed before the address can be
set using this field. With the room controller, it is possible to adjust the address
using the configuration menu of the controller without removing the DNA jumper.
Currently in the DSC/DAC, the user can set all the DIP switches to OFF. This
results in the controller appearing on the network as DEV0, which will result in
problems with DNA and can cause problems on the network.
Location
This field is where you can enter the physical location of the controller. For
example, you might write: Located in Ceiling above Door in RM211.
Latitude
This field describes the latitudinal geographical location of the controller. For
example you could enter 49.5º North. The latitudes have a resolution of 0.1
degrees. This field is used in the calculation for Sunrise and Sunset algorithms
used in GCL+ (see GCL+ chapter for a description of that function).
Longitude
This field describes the longitudinal geographical location of the controller. For
example you could enter 95º East. The longitudes have a resolution of 0.1 degrees.
This field is used in the calculation for Sunrise and Sunset algorithms used in
GCL+ (see GCL+ chapter for a description of that function).
Site Elevation
The field will be an integer that gives the elevation of the site. This field is critical
to the Enthalpy formula used in GCL+. The Site Elevation value has a resolution
of 1 ft. or 1 m.
Elevation Units
This field will be a combo box with either feet or meters. This field is critical to
the Enthalpy formula used in GCL+.
Configuration
Refer to the most recent product specifications sheet for detailed information. The
values given below are examples and vary depending on the controller types.
The default DCU total static RAM is 256 Kbytes. This can be increased to 1,280
Kbytes by adding two SRAM chips in slots SRAM1, SRAM2, and moving
jumpers J7 and J8 to the left.
The default DSC total static RAM is 128 or 256 Kbytes. The DSC
1616/1212/1280 are available with 512 Kbytes.
Additional Dynamic RAM is not available for DAC, DSC, VAV/VVT or Room
Controllers.
The remaining Dynamic RAM should be larger than 500 Kbytes for a DCU.
The rev 1.3 to rev 1.5 DCUs have a clock speed of 25 MHz with a 32 bit
processor.
The Output Startup Delay section in the Device (DEV) object is used to determine
how long the controller waits (after start-up) before it begins processing its
outputs. Checking the Automatic checkbox, enables Auto mode. Unchecking the
Automatic checkbox, enables manual mode. In Auto mode, the delay time is
determined by the formula (5 + DeviceAddress Mod 31), resulting in a range of 5
to 35 seconds. This is known as system-wide staggered startup of equipment. This
ensures that if a power outage occurs, not all controllers will turn on their outputs
at the same time once the power is restored, causing a massive power surge. They
will be turned on at different times depending on their address. In Manual mode,
the delay time is user-selectable. (Note: entering zero sets the delay time to 0
seconds and disables this feature.)
Refer to the Analog Output (AO) and Binary Output (BO) objects in chapter 10
for an explanation of what happens for each object during a controller startup.
LinkNet Port
This option allows LinkNet on a particular port to be enabled or disabled. The
options in the drop down are Net1, Net2, or None. The LinkNet option only has
significance on an Application Controller even though it may show on a DCU
controller. This option uses Port 2 on a Application Controller and uses an RS-485
physical connection at 76,800 baud. LINKnet is not a BACnet standard, but rather
a proprietary extended input/ output scheme developed by Delta Controls.
Note: The controller needs to be reset before the new settings will take effect.
Controller Graphic
A designated GPC graphic can display when the DEV object is opened using the
right mouse Open command in the Left Pane of Navigator. The Device object
opens normally in the Right Pane of Navigator when the object is double clicked.
The controller Graphic field can be overridden by the Device Graphic defined in
the Navigator Settings (NVS) object. The Device Graphic tab on NVS provides a
way to provide an exception to what is defined in the Controller Graphic field and
make a local definition of the designated graphic for a specific OWS.
Reset Password
This field defines an optional password that restricts the use of the Reset
command for a Device Object in Navigator. The default setting is none. The Reset
Password affects Reset commands for the Device Object but does not affect reset
commands to other objects in the device. With a password in this field, a user
must enter the correct password to use the Reset command.
The Reset command for a Device Object is available when the user uses the right
mouse button to select:
• A DCU or DAC controller in the left pane, or
• The Device Object in the right pane of Navigator.
ecurity Enabled
The Security Enabled checkbox is used to restrict unauthorized users from
modifying a controller's database when using DSC or Access Control products.
When the Security is enabled, only Delta Controls Inc. ORCAview software can
perform any of the actions described in the following text.
Note: The DST settings on the Time Info tab for both DSC and OWS must be the
same before 'Security Enabled' checkbox is checked under the 'Configuration' tab.
Otherwise, the controller will be locked and cannot be manipulated anymore. You
have to reflash its firmware to remove the lock status.
1 With DST disabled on the DSC, you can enable Packet Security, but you can't
disable it again. You have to reflash the controller to get rid of the lock.
2 With DST enabled on DSC, i.e. the same as OWS, you can either enable or
disable Packet Security. The Packet Security feature works.
When the Security Enabled checkbox is enabled for a controller, all other BACnet
front ends are blocked from deleting, creating or editing objects, and clearing or
restoring the controller's database.
The Security Enabled checkbox will also restrict requests to create new objects or
edit existing objects. Only authorized users can create or edit objects. In order for
any user to delete objects or clear or restore a database, an authorized user must
first clear the Security Enabled checkbox in the controller. Only authorized users
can create or edit objects. Only users logged in to a valid SUA object with the
same proper object permissions, username and password as the one present on
your panel will be authorized users. Authorized users are granted authority to
create and/or edit objects.
This feature allows us to prevent other BACnet front ends from attaching to the
network and potentially sabotaging the Access System or any Delta Controls Inc.
system. In addition, in order for the security to work correctly the controller's time
must be synchronized with the rest of the BACnet network, within =+/- 3 minutes.
This is to prevent a replay attack on the controller of older messages.
Note: After performing actions that require the Security to be disable, be sure to
enable the Security again by checking the Security Enabled checkbox.
The available PC104 boards that can be connected to the DCU are:
• Ethernet Card
• IntelliNet® Card
• Peripherals Card
As a part of OWS security, these checkboxes allow an operator to see only the
objects for a particular application(s). For example, a site may have separate
operators for the HVAC and Access applications. It is possible for each operator
to only see the objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Time Info
Time
This field displays the current local time of the device. It is in a 24-hour clock
format.
Date
This field displays the current local date of the device.
GCL Timeout
The read only GCL Timeout field defines the number of seconds that a GCL+
program can be caught in an infinite loop before it is "kicked" out of the loop.
When a GCL Timeout occurs, GCL+ is kicked out of the infinite loop and starts
executing from the beginning of PG1's first line of code. If the infinite loop
continues to exist, the program execution will be restarted a maximum of three
times, after which the program containing the infinite loop will be halted and will
not be executed again.
On a DAC or DCU controller, the default time for this read only property is 20
seconds. On an OWS or HMI, the default time for this read only property is 5
seconds.
Save/Load Timeout
The Save/Load Timeout field modifies the number of seconds that the controller
will wait if it does not receive any messages related to a save or load procedure
from the OWS, before continuing on with normal operation. The default time for
this property is 20 seconds. The allowed values are from 1 to 250 seconds.
With the exception of a DCU, during a database save, the controller first pauses
operation (i.e. outputs remain at their last state, programs pause execution), then it
copies the database to flash, resumes operation, and then the database is saved
from the controller by the OWS. Once the database is saved, the controller then
continues on with normal operation.
If a problem occurs during the database save which causes the controller and
OWS to stop communicating for a period of time, the controller will timeout and
end the save procedure (after the time specified in the Save/Load Timeout field).
With the exception of a DCU, during a database load, the controller suspends all
operation for the entire length of the load process. Once the database is loaded
into the controller, it resumes or begins normal operation.
If a timeout occurs (the time specified in the Save/Load Timeout field) in the
middle of loading a database, the controller will reset and load the database saved
in flash (or create the default database if there is no database saved in flash).
To use the UTC feature on a DCU controller, you must check UTC Enable and
enter the UTC Offset for the location of the Device.
On a DSC/DAC controller, the UTC Offset is still used but the UTC Enable
setting is no longer required in the calculations for the Sunrise and Sunset
functions.
Using Navigator, Set the Panel time; the Device Object will now display the local
time referenced to GMT.
European Daylight Savings Time – see DST STANDARD which follows for
more information.
The dates in emails and Security settings on Configuration tab of the Device
object also use UTC.
DST in the OWS comes from the Windows configuration. If DST is enabled in
Windows, then DST Enable will be checked in the OWS. Users are not able to
change the DST settings or disable the DST in the workstation. They can only set
it up from Windows.
The OWS Time zone settings, System Time, or the DST settings can not be
changed. These system parameters can only be changed from Windows settings.
This is done by clicking on START SETTINGS CONTROL PANEL. Then,
click on DATE/TIME.
The purpose of DST is to conserve sunlight during the summer months. This is
accomplished by manipulating the clock time so that both sunrise and sunset will
take place at a later hour. This will have the effect of giving us one extra hour of
sunlight in the evening.
NORTH AMERICA:
Effective Hour – 2 AM
Offset – 60 Minutes
AUSTRALIA:
Effective Hour – 2 AM
Offset – 60 Minutes
EUROPE:
Offset – 60 Minutes
OTHER:
No set defaults. User can enter any option that they want.
For example if the DST start on the First Sunday in April (i.e. April 3) and the
“On and After” box is unchecked, DST will start on the 3rd of April. If however
“On and After” box is checked and the date selected in this field is 5 then DST
would not take effect until April 10. This type of DST algorithm is primarily used
in South American countries.
Time Synchronization is used to notify a remote device of the correct current time
so that devices may synchronize their internal clocks with one another. We refer
to the ability of a controller to generate Time Synchronization requests as being a
Time Master. Time Mastering is only supported by system controllers (DSC,
ASM and DCU) and by the OWS, as these devices all have real-time clocks.
By convention, a single controller (at the System or Area level) is chosen to be the
Time Master for an entire site. The Time Master is then configured to broadcast a
Time Synchronization request to all the devices within the site periodically
(typically once every 24 hours). The OWS is usually used to initially set the time
within the site and then occasionally to reset the time (to correct accumulated time
drift or to recover from a Time Master failure).
Note: Controllers do not trend data if it does not have the current time (i.e. if
current year = the default year).
This is where the Auto Time Synchronization feature comes into effect. It ensures
that all subnet controllers under a system controller (DSC or ASM) always have
the correct current time and date.
Note: The definition of a subnet network is limited to NET2. The use of NET1 (or
other network adapters) for a controller subnet is a non-standard architecture
and is not recommended. Only NET2 is supported and automatically configured.
The system controller (DSC or ASM) maintains the current time and date (as it
has a real-time clock) and is sensitive to subnet controllers coming on-line and
synchronizes their times automatically. The DSC is also pre-configured to
synchronize its subnet controllers regularly (every hour) at 12 minutes past the
hour. This time was chosen since the DSC synchronizes its software clock with its
real-time clock at 11 minutes past the hour (to avoid problems due to roll-over,
like midnight). This ensures that the real-time clock is read prior to generating the
Time Synchronization message.
Note: The DSC will not synchronize its subnet controllers if it does not have the
current time (i.e. if current year = the default year).
Note: The network address is only put into the Time Synchronization Recipients
list when the default database is created. Changes to the network address (i.e.
reconfiguring the device or changing its MAC address) will automatically be
reflected in the Time Synchronization Recipients list. Loading a database will
NOT automatically add the network address to the Time Synchronization
Recipients list. However, if the database was already configured with Auto Time
Synchronization enabled and it had a different network address, then it will
update the old network address with the new network address and auto timesync
will continue to function normally. Databases not already configured will require
the user to manually configure the Auto Time Synchronization feature.
Note: When Auto Time Synchronization is enabled, users may add additional
recipients that are not on the subnet (e.g. NET10030, DEV4800) to the Time
Synchronization Recipients list and they will receive Time Synchronization
messages, but will NOT trigger Time Synchronization messages.
With Auto Time Synchronization enabled, each new subnet device that comes
“on-line” sets the Time Remaining field to 5 seconds (allowing time for other
devices to come on-line by effectively suppressing/delaying the Time
Synchronization message). This avoids sending a flood of Time Synchronization
messages, should multiple controllers come on-line together (i.e. a mass power
restoration), by suppressing multiple successive Time Synchronization messages
into a single message sent 5 seconds after the last controller comes on-line.
Upon expiry of Time Remaining, the Time Remaining field is again set to be the
number of seconds remaining until 12 minutes past the hour (the next hourly Time
Synchronization).
Manual Enable Manually setting the Time Interval to 3600 seconds and adding
the subnet network address to the Time Synchronization Recipient list will enable
the Auto Time Synchronization feature.
Manual Disable Manually changing the Time Interval from 3600 seconds
disables the Auto Time Synchronization feature and reverts to standard BACnet
Time Synchronization behavior.
The following screenshot displays the Time Sync tab of the Device object. In this
screenshot, Auto Time Synchronization is enabled. LinkNet is enabled on NET1
and the network address of NET1 (NET20003) is added to the Time
Synchronization Recipients list.
The Using Time Sync section starting on page B-32 provides an introduction to
the concepts associated with this function. The following content explains the
fields on the Time Sync tab.
Time Interval
This is the number of seconds between controller time updates that are sent to the
list of Time Synchronization Recipients. For the OWS and DCU, the default time
is 86,400 seconds, which is once every 24 hours. If a change is made to the Time
Interval and Apply or OK is pressed, it resets the Time Remaining and begins
counting down.
For DAC products, the default Time Interval is 3600 seconds. If the Time Interval
value is 3600, the Time Remaining does not reset when the Synchronize Time
button is pressed. Additionally, if the Time Interval is changed to a value other
than 3600, then the Time Remaining follows this new value. When the
Synchronize Time button is pressed, the time remaining value is set to the Time
Interval and the countdown starts again.
Time Remaining
This is a read-only field that displays the number of seconds left until the next
Time Synchronization is sent to the Time Synch Recipients.
For DAC products, when Auto Time Sync is enabled, the Time Remaining is set
to expire at 12 minutes past the hour.
To enter a device into this list, simply double-click in the next available entry
position and type in the desired device object number (e.g. 100.DEV1 or
200.DEV2).
In order to delete an entry from this list, left-click on the entry, delete the name
and hit OK or APPLY. The name is highlighted blue before you hit Delete, if the
name field goes into an edit mode the delete will not take effect.
Product
Vendor
This is a read only field that indicates the manufacturer of the BACnet Device.
Vendor ID
This is a read-only field that indicates the unique vendor identification code
assigned by ASHRAE.
Model Name
This is a read-only field that indicates the model name of the BACnet Device.
Platform
This is a read-only field that indicates the device in which the object is resident.
Firmware Version
This is a read-only field that is assigned by the vendor to represent the firmware
version being used in the BACnet device.
Hardware Version
This is a read-only field that indicates the specific model number of hardware.
Application SW Version
This is a read-only field that indicates the specific version of the software being
used.
Hardware Status
The Hardware Status field is used for troubleshooting purposes and displays the
status of the controller’s database memory, EEPROM memory, and whether the
controller has a real-time clock (RTC), LCD, or Ethernet port. This field only
appears on DAC/DSC controllers and not on an OWS or a DCU.
An example of the type of information displayed in this field is: Database OK, EE
OK, RTC Present, LCD Not Present, or Ethernet Present. The presence of a real-
time clock, LCD, or Ethernet port depends on the type of controller.
Protocol
Max Master
This read-only field indicates the highest possible address for master nodes.
Protocol Version
This read only field represents the major version number of the BACnet protocol
that is implemented by this controller. Every revision of BACnet shall increase
this version number by 1. The current Version is 1 and the Revision is 4.
Protocol Revision
This read only field represents the minor revision of the BACnet standard that is
implemented by this controller. Every revision of BACnet shall increase this
version number by 1. The value shall revert to zero upon each change to the
Protocol Version field. The current Version is 1 and the Revision is 4.
APDU Timeout
This field indicates the time, in milliseconds, between retransmission of an APDU
requiring acknowledgement for which no acknowledgement has been received.
APDU Retries
This read-only field indicates the maximum number of times that an APDU shall
be retransmitted.
Segmentation Supported
This read-only field indicates whether the BACnet device supports segmentation
of messages and whether it supports segmented transmission.
Services Supported
This read-only field provides a list of supported BACnet services.
Internet
Note: Some SMTP Servers require that you use a valid E-Mail Account (in the
from field) when sending emails. Check with your network administrator to ensure
you are using a valid email account.
SMTP Server
The field contains the address of the SMTP server. For example, an address might
be something like “mail.yourISP.com”. This field will also accept the IP address
of the SMTP Server (i.e. 192.168.1.200). Your network administrator can provide
you with the SMTP Server address.
You cannot use simple host names like "mail". You have to enter the Fully
Qualified Domain Name (FQDN) (e.g., "mail.deltacontrols.net") to your mailer,
otherwise Email will not work.
SMTP is short for Simple Mail Transfer Protocol which is a protocol for sending
e-mail messages between servers. Most e-mail Internet mail systems use SMTP to
send messages from one server to another. In addition, SMTP is generally used to
send messages from a mail client to a mail server.
However, you only need to specify the SMTP server in the controller and not the
POP or IMAP server since the controller is only able to send emails and not
receive them.
Use DHCP
The Dynamic Host Configuration Protocol (DHCP) is an Internet protocol for
automating the configuration of a controller that uses IP. DHCP is used to assign
temporary or permanent network (IP) addresses to controllers and to deliver
configuration parameters such as the subnet mask and gateway address. In other
words, the controller extracts its configuration from a server (the 'DHCP server').
A controller requests the use of an IP address from the DHCP server. The DHCP
server then allocates and assigns an IP address for the controller to use for a
particular amount of time. The period over which a network address is allocated to
a controller is referred to as a "lease". The amount of time for the lease is
determined by the DHCP server.
The benefit of using DHCP is that it reduces the work necessary to administer a
large IP network. The alternative to using DHCP is manually entering the IP
Address, Subnet Mask, and Default Gateway information into the controller.
If the 'Use DHCP' checkbox is checked, the 'IP Address', 'Subnet Mask', and
'Gateway Address' fields become unavailable since they are acquired using
DHCP. The 'Use DHCP' checkbox is unavailable for BBMD controllers because
they require a static IP Address and cannot have a dynamic address.
The 'Use DHCP' check-box in the Email Tab of the Device object is disabled
(grayed out) if the device is a BBMD and UDP/IP is enabled in the NET object.
This is done so that the availability of the DHCP checkbox in the DEV object
matches the DHCP checkbox in the NET object. DHCP cannot be used when the
controller is a BBMD device, and so the checkbox is grayed out.
IP Address
This field sets the IP address that the controller will use. Devices do not support
IPv6.
192.168.1.10
Three different address “classes” have been created, which are called Class A,
Class B and Class C. At this point, it is enough to know that addresses which
begin with a number in the range of 1 to 126 are considered Class A, with
numbers in the range of 128 to 191 being Class B and numbers in the range of 192
to 223 being Class C. Thus the complete address shown above would be
considered Class C. Addresses which begin with 127 or 224 - 254 are reserved for
special purposes. These IP addresses cannot simply be “made up”. If connecting
to an existing LAN or WAN, these IP addresses will be provided by the site
network administrator.
Subnet Mask
This field sets the subnet mask for the network that the controller is connected to.
A subnet mask uses the same four-part format as an IP address and is written
using the same dot format. Subnet masks are used to separate the network that the
device is connected to from the device itself. Each device has a subnet mask
associated with it. This allows the device to know what other devices are its peers
(on the same network), and which devices are reachable only by a Gateway or IP
Router. Typically, a subnet mask has only one of two numbers in each of its four
positions. These are 0 and 255. This is why these two numbers cannot be used to
specify an actual IP address. A very common subnet mask is the following:
255.255.255.0
This particular subnet mask specifies that devices which have the identical first
three numbers in their IP address belong to the same network. For example:
This means that these two devices can communicate without the need for a
Gateway. However:
Therefore for these two devices to communicate, at least one Gateway will be
required.
From this, it is clear that if the subnet mask is 255.255.255.0, only 254 devices
can be connected on the same network. Remember, 0 and 255 cannot be used in
an IP address. For some networks this is insufficient, so three different classes of
IP address were created which each have their own subnet mask.
Gateway
This field sets the IP address of the site Gateway or IP Router that is used to
connect to off-site devices. This field is only required if two different networks
need to communicate with each other. This would be the case with a WAN. If
required, this IP address is supplied by the site network administrator.
A Gateway has the job of sending network traffic from one network (subnet 1) to
another network (subnet 2). A Gateway uses the subnet mask of a packet to
determine if it should forward it to the remote network or not. If the destination
address of the packet is not in the local subnet, then the Gateway or IP Router will
send the packet to the remote network.
However, for this to work, the local devices must be given the IP address of the
Gateway. This IP address in the device is typically labeled 'Gateway address’ or
‘Router address’.
Gateways are commonly used in Wide Area Networks (WANs) to join the
individual networks (LANs) at each site to each other.
GCL+ Properties
Refer to the Program Inputs section of Chapter 11 General Command Language
(GCL+) for information on which properties of this object can be accessed using
GCL+.
The RPS object uses the settings defined in the Modem Settings (MDS) object.
The RPS object is typically used to dial out Alarm Notifications from a controller
to an ORCAview workstation. Delta does not support dialing via modems from a
DCU or DSC controller to another DCU or DSC controller.
Note: Once the RPS Object is created or edited, the controller must be reset in
order for it to take effect.
Main
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller. It is recommended that each name be
unique within a BACnet network.
Phone Number
The phone number for the device that is to be dialed. This field accepts the Area
Code and the Long distance prefix. Communications are established with a device
using a modem when the phone number is dialed.
Password
The Password is needed if the ORCAview OWS is attempting to dial into a Third
Party Vendor’s Device that requires a remote password check. This password will
be compared to the Devices own internal security settings.
If the password matches the connection will be successful. If the password does
not match the dialup connection will fail and the OWS will not be able to
communicate with the network. If the OWS is dialing into a Delta Controls
device, disable this field by selecting the Delta Device checkbox and selecting the
Dialup SUA from the drop down menu (if required).
Dial-out SUA
This field allows the user to select which SUA will be used when connecting to a
Delta Controls Device that Requires a Remote SUA Password check when using a
dial-up connection. The Controller to which the OWS is dialing into will compare
the Username and Password of the selected SUA Object and compare them to
those contained in the SUA in the controllers database. If the SUA settings on the
OWS do not match those of the Controller, the connection will be dropped and the
OWS will not be able to communicate with the network.
Delta Device
If this checkbox is checked, the device expects to dial out to a controller or OWS
created by Delta Controls. The default is checked. If this checkbox is unchecked,
the Password field for third party devices displays.
Setup
Baud Rate
You can adjust the baud rate for the port to one of the following speeds:
300, 1200, 2400, 4800, 9600, 19200, 38400
On the device, the default baud rate is 9600.
This setting must match the “Baud Rate” setting for the “PTP (RS-232) Port
settings” in the BACnet Protocol Settings (BCP) Object on the ORCAview
workstation. If the baud rate settings does not match, an Unable to Connect error
message is issued.
Object System
This field sets the type of objects expected on the remote device. The choices are
BACnet or Delta V2. When Delta V2 is selected, the Network Number field does
not display.
Panel Number
The address of the device that will be dialed.
Network Number
The number of the network that the device is on. To identify the Local Network
Number of a certain device open its BCP Object and click to the Advanced tab.
The Remote Panel Settings (RPS) Object uses the settings in the MDS Object
when a modem connection is initiated.
Starting with ORCAview 3.30, the Windows modem that may come with your PC
or Laptop can be used for the PC/OWS modem. ORCAview supports many
brands of modems. You do not need to use a terminal program to set the modem
string.
The US Robotics external 56 K modems and earlier models 14.4K, 28.8K, 33.6K
are the only ones supported by Delta Controls for use as a panel modem on a
controller. (Most Windows-compatible modem can be used for the PC/OWS
modem.) The compatible US Robotics modem models have DIP switches and
operate under the AT compatible command set.
Setup
An MDS object on an OWS only has the Name field on the Setup tab. When the
MDS object is on a controller, the Setup tab has many fields which are configured
based on the Modem Type field selection.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller. It is recommended that each name be
unique within a BACnet network.
Modem Type
The initialization string is defined for the modem based on the Modem Type
selection. Select your modem from the drop down list or chose Custom to enter a
user defined Modem initialization string. The choices from the drop-down are:
U.S. Robotics, USR Quick Connect Disabled, Zoom, Boca, and Custom. Based on
the selection, the initialization string uses standard settings for a particular type of
modem. The fields on the Setup tab are editable. If you select Custom, enter the
codes in the fields on the Setup tab. In most cases, you will select US Robotics as
the modem type.
Initialization
The string used when a modem is first connecting. For a Custom modem type,
enter the initialization string for the particular modem here. This string is sent to
the modem before the modem dials. Refer to your modem manual for more
details.
Hangup
This string is sent to the modem port before the modem port hangs up. Refer to
your modem manual for more details.
Reset
This string is sent to the modem port when the device is reset. Refer to your
modem manual for more details.
Dial Prefix
This string is sent to the modem port before the digits of the phone number. Refer
to your modem manual for more details.
Auto Answer
Determines behavior for an incoming call over a modem. The string ATS0=1 sets
the modem to answer the phone after one ring.
Command Timeout
This is the time that the device waits for the modem to respond. The field accepts
a value from 0-10,000 seconds. The default time is 2 seconds. If the time is
exceeded, then an error message displays.
Description
General
You may select these options for the currently selected site:
Site Name
The name given to the particular site.
The rest of the blank spaces on this tab are where the user may fill in address
information appropriate to the specific site.
Advanced
The advanced tab is used to specify the Master and Security Panels on the
network. User logging can be set up here as well.
V2 Master Panel
If the V2 Master Panel is specified, ORCAview will automatically reload the
system objects such as Units and Scale Ranges from that panel each time that site
is logged into. If this field is set to a number other than zero, the system object
used by OWS will be loaded from the specified panel.
V2 Security Panel
The V2 Security Panel is used to set which controller the PC uses to verify the V2
Network security. It must be set to a valid controller number that is present in the
V2 network or 0 for your PC. If you are using a serial connection (direct or
modem) and the V2 Security Panel is set to anything other than 0, this setting is
overridden for the V2 network security and the physically attached controller is
used to verify the V2 network security.
After the V2 network security has been verified then the OWS will look at the UA
in the V2 Security Panel to obtain the V2 Object Permission levels. This field
does not accept an entry of 0.
The BACnet Security Panel is used to set the controller that the PC will look at to
verify the BACnet network security. It must be set to a valid controller number
that is present in the BACnet network or 0 for your PC. If you are using a serial
(direct or modem) connection and the BACnet Security Panel is set to anything
other than 0 this setting is overridden for the BACnet network security and the
physically attached controller is used to verify the BACnet network Security.
User Logging
The User Logging is used to record activities from users who are logged into the
system. These activities are recorded to a text file, UserLog.txt stored in their site
name directory. Hence, each individual site could have their own UserLog.txt file
in their site name folder. There are 4 different options for user logging:
Application Protocol
The Site Settings also indicates what protocols are used on the site in the
Application Protocol tab. If a protocol is not enabled (checked) in this tab, then
the security checks will not be done for that protocol.
For example if the site only had Delta Version 2 enabled but we supplied a
BACnet Security Controller in the Advanced tab. The BACnet network would not
appear even if the username and password provided at the login dialog matched a
SUA in the BACnet Security Controller because the BACnet security check
would not be done because the BACnet protocol is not enabled for this site.
BACnet
If this tab is checked the BACnet protocol will be enabled. ORCAview must be
restarted before any network changes will be in effect.
Delta Version 2
If this tab is checked, the Delta Version 2 protocol tab will be enabled.
ORCAview must be restarted before any network changes will be in effect.
Note: When you add a protocol, you may have to create the corresponding
protocol in Windows’ Network Neighborhood.
The SUA object is evaluated during a security check when logging in before
providing system access to an operator, and then determines Access Levels for
both BACnet and System Objects. Version 2 object permissions are set in a
separate User Access (UA) object.
User information (in the form of an SUA or UA object) resides in both the OWS
and any Security Panels.
When creating the SUA object, a corresponding SUA or UA is created both in the
OWS and in any specified BACnet and Version 2 Security Panel. When editing
the SUA object, the changes are only applied to the particular SUA object in the
location that it was opened from. For example, if you edit the SUA name in the
OWS, then you must also edit the SUA (and/or UA) in the Controller to match.
Header
The SUA in the controller and OWS will have a Status field.
Status
The status of the SUA is read-only and not editable by the user.
Logged Out The Logged Out SUA Status indicates that nobody is logged into
the system using this particular SUA. If someone is to log into the system using
this SUA, then the SUA Status must be initially be Logged Out.
Disabled A user with sufficient permissions to the SUA can set the User
Enabled field on the setup tab of the SUA to disable the SUA. When the SUA
Status is Disabled, nobody can log into the system using this SUA until it is
returned to the Logged Out state. The Status must be returned to the Logged Out
state by setting the User Enabled field on the setup tab of the SUA.
Security Locked When the number of Login Failures on the Login tab of the
SUA reaches the Login Maximum Failure setting, the SUA is locked, thereby
preventing anyone from logging in with this SUA. The Login Lockout on the
Login tab of the SUA is checked (True) and the SUA is set to Security Locked and
remains locked until any one of three conditions occurs:
Inactive If the current date and time within the BACnet Security Panel and/or
OWS is not within the Password Start Date and Password Expiry date specified in
the SUA, the SUA Status will be set to Inactive. The Password Auto Expire
checkbox must be enabled for the Inactive state to be valid. When the Status is
Inactive, nobody can log into the system with this SUA.
If the SUAs’ Status changes to Disable, Security Locked, or Inactive while the
SUA is Logged In, the SUA Status does not change until the SUA is Logged Off.
For example, if SUA1 is logged in, and the time and date within the BACnet
Security Panel is outside of the Password Start Date and Expiry Date, then the
SUA Status does not change until the SUA is logged off.
Last Logged In at
This field shows the last time and date the SUA Status was Logged In. In the PC it
shows the last time someone logged into the workstation. The time is taken from
the PC clock.
The SUA Status in the controller shows the last time that the SUA Status in the
controller was in the Logged in state. In this case, the time is taken from the
controller.
The SUA Status in the controller shows the last time that the SUA Status in the
controller was in the Logged Off state. In this case, the time is taken from the
controller.
Description
This tab contains the description field.
This is the standard BACnet description field. It can be used for any comments the
user may have. It has no bearing on the execution of this object. It can contain up
to 2000 printable characters.
Setup
Name
Name is a character string that represents the Name of the user. It is compared
against the username typed in for login purposes. Both the Name and the
Password in the SUA object have to match the username and password entered in
the login dialog to successfully log into the system.
User Enabled
When this field is toggled to Disabled it will set the SUA Value to Disabled and
prevent anyone from logging into the system with this SUA. Toggling this field to
Enable will enable the SUA again and set the Status of the SUA to Logged Off.
When a new SUA is created, the User Enabled field is set to Enabled by default.
Security - Password
Password holds the password for the SUA. It is the character string that is used to
compare against the password provided by the operator. The Password is not
shown visually when the SUA is displayed. It is shown as a series of ‘*’ each
representing a character in the password. As characters are added to the password
or edited they also appear as ‘*’.
• Maximum 14 characters
• Forced to be Uppercase
• Only Version 2 acceptable characters are accepted. Do not use characters
such as ( \ /:*?"< >| ).
• Minimum 4 characters
These restrictions are in place to keep the SUA compatible with the Version 2
User Access object (UA).
The Password Auto Expire occurs if the current date and time within the Security
Panel is not within the Password Start Date and Password Expiry date. The SUA
Status will be set to Inactive. When Inactive, no one will be able to log into the
system with the Inactive SUA.
To get it out of Inactive, a user with sufficient permissions to the SUA, must set
the Password Start Date and/or Password Expiry Date so that the current date is
within these two values or turn the Password Auto Expire off. Once the user has
done this and applied the changes the SUA Status will be set to Logged Off.
The default value for the Password Auto Expire is unchecked (Off).
Menu Reference
The SUA Menu Reference allows a given password to reference a designated
Menu object. The administrator can use this feature to set up a LCD keypad
permissions structure.
The Menu (MN) object basically allows the organization and formatting of
functions to be interfaced and displayed on the LCD Keypad.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
User Data
This tab contains information about the user and some of the settings for the user
when using ORCAview.
Alarm Filter
This field is used to specify an Event Filter (EVF) object for this SUA. By default,
the Alarm Filter field is blank and Alarms Notifications are not filtered out for this
user. The user will receive Alarm Notification for all Event Classes.
If an Alarm Filter field has an Event Filter (EVF) object specified, then Alarms
Notifications are filtered. The user will not receive Alarm Notification for the
Event Classes listed in the EVF object.
For details on the Event Filter object, see Chapter 5 Event (Alarms) Management
System of the Technical Reference manual.
Disable Navigator
This field is used to disable Navigator for a user. The user would typically use a
site graphic to access the system. The Disable Navigator checkbox is unchecked
by default when an SUA is created. The default allows Navigator to display for a
user.
When this field is checked, the user must log out of ORCAview and then log back
in again for the change to take effect. When the user logs in, only the ORCAview
Dashboard (main toolbar) is visible. The user cannot see Navigator or any
controllers through Navigator. The ability to create multiple instances of
Navigator is disabled in the Tools menu.
Disable Illustrator
This field is used to disable the Illustrator drawing tool for a user. The Disable
Illustrator checkbox is unchecked by default when an SUA is created. The default
allows Illustrator to operate in either the Run or Edit mode..
When this field is checked on the user's SUA in the OWS, it is necessary to log
out of ORCAview and then log back in again for the change to take effect. When
the user logs in, the ORCAview Dashboard and Navigator window is visible but
the Illustrator options are unavailable. A site graphic drawing may be opened but
the Illustrator is only available in the Run mode and not in Edit mode.
Once checked, if an alarm goes off, the user does not see a pop-up alarm
notification. Alarm notifications can still be monitored from the Active Alarms
Folder. To disable alarm pop-ups, a checkmark must be placed in this field for the
SUA object on the local OWS only.
Once checked, the user does not see a pop-up window when a server message is
received. Typically these messages relate to network issues. To disable server
messages, a checkmark must be placed in this field for the SUA object on the
local OWS only.
Process ID
The field displays the numerical ID for the user. This ID is used as the Process ID
in alarm acknowledgements to identify the user that acknowledged the alarm. The
information is provided for use with 3rd party products that only allow the
acknowledgement of alarms by Process IDs that the alarm has been directed to. In
these cases, this value should be used in the Recipient List of the Event Class
object in the 3rd party device.
If HMI Login Required is checked (enabled), this field defines the first graphic to
display on the HMI touch screen after a particular user logs in if a Starting graphic
is not assigned to that user. If HMI Login Required is unchecked (disabled), this
field defines the default start graphic for all users after the device starts up. All
graphics that are stored in the HMI are listed in the dropdown box. The order of
the list is based on FIL object instance. (Site graphics are saved as FIL objects on
the HMI device).
If HMI Login Required is enabled (enabled), this graphic displays before the user
logs in or after the user logs out. All graphics that are stored in the HMI are listed
in the dropdown box. The order of the list is based on FIL object instance. (Site
graphics are saved as FIL objects on the HMI device).
You have the following choices for the Refresh Rate for Objects:
• 5 Seconds
• 10 Seconds
• 30 Seconds
• 60 Seconds
All graphics and/or dialogs that are opened by the user will update at this rate. For
example if the Refresh Rate for Objects for an SUA was set at 5 Seconds and the
user opened a graphic with 10 links on it, all 10 links would update every 5
seconds.
Language
This indicates what language OWS will operate in for this User. This tells the
OWS what language to use in when this User logs in to the system. This property
is a list of the supported languages.
Starting Screen
The Starting Screen is the name of the graphic that is opened each time this user
starts ORCAview. ORCAview will look in the Default graphic path for the logged
in site specified in ORCAview Settings. A path must be supplied along with the
graphic name if the graphics are located somewhere other than the default
graphics path.
Full Name
This field is used to keep track of the users actual name.
It is a character string that has the same restrictions as the Description field.
E-mail Address
This field is used to enter the user’s email account if he/she has one and may also
be used for event paging by the Event Router.
It is a character string that has the same restrictions as the Description field.
Phone Number
This field is used to save the user’s phone number and may also be used for event
paging by the Event Router. The Phone Number can be used for the TAP Gateway
(in the EVR).
It is a character string that has the same restrictions as the Description field.
Fax Number
The user’s fax number will be saved in this field.
It is a character string that has the same restrictions as the Description field.
Pager Number
This field is used to save the user's pager number and may also be used for event
paging by the Event Route.
It is a character string that has the same restrictions as the Description field.
Cellular Number
The user’s mobile phone number.
It is a character string that has the same restrictions as the Description field.
Login
This tab contains information and setup for logins and logouts.
Device This field shows the name of the last device (OWS) that logged in using
this SUA. This field is read-only.
Network Inactivity Time If ORCAview stops running and the Delta Server
continues to run, then the system may not let the user log in again. The system
thinks that the user is already logged in.
This field counts up to 5 minutes for network inactivity, checks to see if the user is
still logged in, the system then waits another 2 minutes and logs the user out.
ORCAview automatically pings each security panel every 5 minutes to ensure that
a connection exists. After the Network Inactivity Time Setting (7 minutes), the
user can log in again.
Network Inactivity Time Setting This is the time that the device will wait for a
response from the workstation before setting the SUA to Logged Out. The field
defaults to 7 minutes and cannot be changed. There is a 2 minute delay in addition
to the Network Inactivity Time default count time of 5 minutes, to ensure that
there is sufficient time to complete any network activity.
Failures This is the field where the consecutive failed login attempts are
displayed. A failed attempt is defined as the username and password that was
specified in the login dialog does not match an SUA in the OWS and/or the
controller.
Once a successful login has been established this will reset the Failures to 0.
Once the Failures is equal to the Maximum Failures then the SUA Status will be
set to Security Lockout for the specified Login Lockout Period.
Maximum Failures This field is used to specify how many consecutive failed
login attempts will be allowed before the SUA Status is set to Security Lockout.
Login Lockout
Date This field displays the time and date that this SUA was locked out due to
Failures becoming equal or greater than the Maximum Failures.
Lockout This field is used to unlock an SUA that is in the Security Lockout. If
this field is unchecked (Unlocked) the SUA will return to the Logged Out state. It
can also be used by a user with edit access to the SUA object to lockout an SUA,
by checking (Locking) this field.
Period This field is used to specify the period for which the SUA State will be
set to Security Lockout. The Period is specified in minutes and must be a whole
number.
If the Period is set to 0 then the SUA State will be set to Security Lockout
permanently. The only way to get an SUA out of this state when Period is set to 0
is for an SUA with Edit access to SUA objects to uncheck the Lockout field.
Auto-Logoff
Period The Auto-Log off period is the amount of time that ORCAview will sit idle
before automatically logging off of the network. You can disable this feature by setting
the period to 0. The default Auto-Logoff period is 10 minutes.
Object Overrides
This tab is used to define the Object Access Exceptions for the user. User specific
exceptions are set to the Access Levels for BACnet Standard and System Objects.
The settings here override the SUG settings for that object.
Security Group
The Security Group drop down box allows the user to be linked to a Security User
Group (SUG) object. Once linked, that SUA object inherits all the SUG
permissions.
The Objects field allows input for any BACnet Standard and System Objects.
The Access Level field has a drop down box that appears when you click in it.
The drop down displays six different Access Levels which are in top down order
from most restrictive to least restrictive.
When entering object restrictions based on the same object type, the most specific
entry will take precedence. The order in which the entries are created does not
affect the restrictive precedence with one exception.
The exception to the ordering of restrictions occurs when there are duplicate
entries in the table. With duplicate entries, the first (top) entry takes precedence.
Least restrictive
Most restrictive
What will happen in the example picture above is the first entry *. AV* will set all
AV (Analog Variable) objects on every controller including the local OWS to the
Nothing access level. Because the second entry 300.AV15 is more specific, it will
take precedence. So on panel 300, Analog Variable 15 will have Command access
and any other AV objects on controller 300 or any other controller will have
Nothing access.
Note: Setting an Access Level to nothing in the SUA or SUG objects may affect
the function of the object. For example, if the EV object is restricted such that it
has an Access Level of Nothing, then the user will not receive any alarm
notification. Likewise, if the VGS object is restricted to Nothing, the user will not
have any access to custom views.
EVENT FILTER
Certain sites may find it useful to display only certain alarm notifications to
specific users. For example the maintenance personnel may only need to see
Events that are of the maintenance class while they are logged in. This object
allows the user to:
• Filter out Events or classes of alarm notifications.
• Specify certain Events or Event classes that are not acknowledgeable or
removable by the user.
• Specify a priority level for which notifications will not be filtered out.
An Event Filter can be created in the ORCAview PC only. An Event Filter cannot
be created on DCU or DAC products.
Main
The Event Filter for each user is specified in the System User Access (SUA)
object. Each user can use a different Alarm Notification Filter.
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller. It is recommended that each name be
unique within a BACnet network.
Priority Override
The Priority Override will filter the Events or Event Classes specified in the
Disallowed Alarms Dataview based on their "Send at Priority" property.
Events received with a "Send at Priority" equal or higher than the Priority
Override will not be filtered out by ORCAview. The Priority Override also
removes the users ability to acknowledge alarm notifications.
The Priority Override option only applies to V3 alarms. V2 alarms ignore the
priority override value stored in the EVF object.
Disallowed Alarms All entries in this column are filtered out. This means that
the alarm notification dialog will not be displayed for the alarm and the active
alarms folder will not display the active alarm.
Event Filter objects need to be referenced in the users System User Access (SUA)
object before the filter will function. This allows the system to be set up such that
each user can use a different Event Filter.
On the User Data tab of the SUA object, select an Event Filter (EVF) object from
the dropdown list for the Alarm Filter field.
When the Event Filter has been selected, click the Apply button for the filter to
take affect.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security of the ORCAview Technical Reference
manual.
When a checkbox is checked, an indicator icon appears at the top of the dialog.
The three application areas are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
CUSTOM VIEWS
Use custom views to organize the information from your site. Custom views are
stored on the PC. They provide a quick way to display the status of any device
that needs to be checked regularly. You can sort information by area, by systems,
by type, or by almost any criteria you wish. The ORCAview CD-ROM contains a
sample set of custom views.
2. The New Custom View dialog box will appear. Type a name in the
Description field for your custom view.
3. Click OK. Navigator will display the newly created view. The new view
contains the default special folders, Active Alarms and Graphics.
In the example the following folders were added to the folder Group By Name:
• Objects containing A
• Objects on Panel 1 with A
• Objects start with A, B, C
Also in the example, the following folders were added to the folder
Group By Object Type:
• All Inputs
• All Outputs
• Program and Variables
• Schedules
• Zones and Controllers
INDEX
—A — splitter bar full drag · B-7
Alarms network
select sound · B-7 open object · B-9
Always on Top · B-6 NVS · B-7
auto hide · B-6 —O —
—C — Objects
client connection CMS · B-6
verify · B-15 Device · B-17
Close after Commander · B-15 DWS · B-9
Commander Event Filter · B-76
Dashboard auto hide · B-6 GCS · B-11
Dashboard on top of other programs · B-6 Modem Settings · B-51
modem configuration · B-51 NVS · B-7
Preferences · B-6 Pemote Panel Settings · B-47
select site graphic · B-7 Site Settings · B-54
select sound to notify operator of an alarm · B- SSS · B-13
7 —P —
show Navigator on startup · B-6 Preferences
Custom Views Commander · B-6
creating · B-80 Protocol
—D — selecting in Site Settings Object · B-57
DDE —R —
close when ceases to respond · B-15 refresh rate (Navigator) · B-8
Delta Version 2 protocol tab resizing graphic · B-10
enable, disable · B-57 Runtime Graphic Resizing · B-10
Drawing Settings · B-10 —S —
—G — Security Panel
GCS · B-11 as entered in Site Settings Object · B-56
graphic function · B-56
resizing, runtime · B-10 show Graphics folder · B-8
Graphics folder Show Navigator on Startup · B-6
show · B-8 SI server
grid close after Commander · B-15
size · B-10 Site
snap to · B-10 master panel · B-55
Use White Grid · B-10 protocol selecting · B-57
visible · B-10 site name · B-54
Grid Settings · B-10 Site Object · B-54
—L — Site Graphic Path · B-7
lasso select objects · B-10 site name · B-54
snap to grid · B-10
—M — Splitter Bar full drag · B-7
master panel SS · B-54
as entered in Site Settings Object · B-55
function · B-55
—V —
View Grid · B-10
—N — —W —
Navigator
Preferences, set · B-7 White Grid · B-10
.
Table of Contents
OVERVIEW .......................................................................................................... C–3
This Document ..................................................................................... C–3
What Is DNA? ...................................................................................... C–3
Definitions ............................................................................................ C–4
DNA HARDWARE CONSIDERATIONS................................................................... C–5
Auto-Controller Addressing ................................................................. C–5
Auto Network Numbering..................................................................... C–5
How To Enable DNA............................................................................ C–5
How DNA Works .................................................................................. C–5
What Controllers are Supported .......................................................... C–8
NAVIGATOR AND DNA ....................................................................................... C–9
Introduction.......................................................................................... C–9
Collapse and Expand the Network Tree ............................................... C–9
Controller Conformity........................................................................ C–10
CAPABILITIES .................................................................................................... C–14
Larger Networks ................................................................................ C–14
Duplicate Physical Controller Numbers ............................................ C–14
Logical Representations ..................................................................... C–14
System Devices Remember their Area and Network .......................... C–15
LIMITATIONS OF DNA ...................................................................................... C–15
Manual Adjustment ............................................................................ C–15
Network Number Conflicts ................................................................. C–15
Locations of Area Devices ................................................................. C–16
Area Controller Added to Existing Network ...................................... C–16
ARCHITECTURES TO AVOID............................................................................... C–18
DCUs on MS/TP Segments ................................................................ C–18
Multiple Area Devices on Same Network Segment ............................ C–19
Non-Area Devices as BBMDs ............................................................ C–21
Addressing V2 Micros and Zones ...................................................... C–21
SAMPLE NETWORK ARCHITECTURES ................................................................ C–23
New Single Floor Building Installation ............................................. C–23
New Multiple Floor Building Installation .......................................... C–24
New Multiple Building Installation .................................................... C–25
Dial-up Sites....................................................................................... C–26
NETWORK NUMBERS......................................................................................... C–26
Introduction........................................................................................ C–26
Network Number Assignments ........................................................... C–27
UDP/IP .............................................................................................. C–27
Examples ............................................................................................ C–28
ERROR MESSAGES............................................................................................. C–29
Circular Network ............................................................................... C–29
Duplicate Controller Addresses ......................................................... C–30
Duplicate Network Numbers (Duplicate Routers) ............................. C–30
Overview
The Derived Network Addressing (DNA) feature in ORCA hardware allows you
to organize and configure devices on a network segment in an efficient manner.
This Document
Audience This appendix is intended for Programmers, Engineers, or Site
Commisioners, involved in the design and implementation of Network
Architectures.
What Is DNA?
Derived Network Addressing (DNA) is a method developed by Delta Controls for
organizing and configuring devices on a network segment. It is a simple scheme
whereby Area Devices can group System Devices and System Devices can group
Subnet Devices. This setup provides an easy way to monitor and manage the
devices attached to a network. It provides a managable representation of the
relationships between the devices on the network.
If one of the controllers on the network segment is set as the Area Device, it then
reconfigures all of the other devices on the network to follow the address and
Network Number scheme of the Area device. The System Device appears
underneath the Area, takes the addresses from the Area Device, and adds on its
own address. The System Device will also take the Area’s Network Number.
Subnet Devices follows the same rules as the System Devices except that they
inherit from the System Device above them. The Left Pane of Navigator groups
the devices together so that the network architecture is clear.
The DNA addressing scheme makes it easier to set up a site and greatly reduces
problems relating to duplicate Network Numbering. When a device is set up on a
network segment such as an Ethernet hub, it derives a unique Network Number.
When other devices are attached to that segment, they take on that Network
Number. If another Ethernet hub is set up in the same manner, these two hubs can
be connected by another media type and not have conflicting Network Numbers.
Note: Since 3.22, Area controllers no longer pass DNA information over a
UDP/IP connection. Only the Network Number is passed. This approach
eliminates possible DNA addressing problems.
Definitions
Area Controller This is the highest level of the Network Architecture. It is
primarily used for Wide Area Networks (WAN’s) but is also used on sites with
more than 100 System Devices. (ORCAview 3.30 has the Remove Area
command, which allows a controllers mistakenly set as area to be removed
without excess effort.)
System Device This is the second highest level in the network Architecture. It
is made up of controllers that control air handlers, boilers, chillers, and other large
equipment.
Note: Currently in the DSC/DAC, the user can set all the DIP switches to OFF.
This results in the panel appearing on the network as DEV0, which will result in
problems with DNA and functionally can cause problems on the network.
Auto-Controller Addressing
If a System Controller is addressed to be (000100) and is connected to an Area
Device (090000); the System Device address automatically becomes (090100)
when it is automatically reconfigured. The Auto-Controller Addressing feature
makes the physical connections of controllers clear from their addresses.
On a DCU controller, DNA is enabled by setting the DCU’s DIP switches. DNA
is switched off by setting all the DCU DIP switches to OFF. This mode with DNA
disabled is called Software Addressing. Controllers using Software aaddressing
are not included in the DNA hierarchy.
The DIP switches on each controller are used to set a value in the range from 1 to
99 into the corresponding level in the address. The type of controller determines
which part of the address is updated by the DIP switches.
Note: Currently in the DSC/DAC, the user can set all the DIP switches to OFF.
This results in the panel appearing on the network as DEV0, which will result in
problems with DNA and functionally can cause problems on the network.
For example, if a DCU has a DIP switch address of 12, its final address is 001200.
If a VAV Controller with a DIP switch address of 32 is connected to this DCU,
then the VAV Controller has an address of 001232. The 00 in the first two digits
of the address 001232 indicate that the network does not yet have an Area Device.
The following figure shows the Navigator display for this example.
Note: Since 3.22, Area controllers no longer pass DNA information over a
UDP/IP connection. Only the Network Number is passed. This approach
eliminates possible DNA addressing problems..
How Areas are Set Address DIP Switch #8 (labeled 128) on a DCU
controller indicates whether that DCU controller is designated as an Area or
System Device. On a DSC, a jumper is set for Area, System, or Subnet operation.
The physical address of the controller is set using switches 1 through 64.
Note: Under the Version 3 DNA addressing scheme, only DIP switches 1 through
64 are required to set an address between 1 and 99. Switches 128, 256, and 512, if
existing, are not used to set a controller's address. On DAC or DSC product, a
jumper determines whether a controller is at the Area, System, or Subnet level.
The Final Addresses In the following figure, the System DCU (1) has only
DIP switch 1 set in the ON position. Since switch 128 is in the OFF position, this
DCU is a System Device.
When the DNA addressing scheme is applied, the System Device has a final
address of 080100.
Why is the address 080100 and not 000100? The System Device knows that an
Area Device 8 is on the same network, and System Device 1 inherits the Area
number (08) from the Area Device.
In the previous figure, the Subnet VAV Controller (2) has only DIP switch 2 set in
the ON position. Version 3 Zone controllers (DAC-304) are locked as Subnet
Devices and therefore do not need a jumper or DIP switch to set as an Area,
System, or Subnet. When the DNA addressing scheme is applied, this VAVs final
address becomes 080102. Like the System DCU (1), the VAV inherited the Area
(8) and the System (1) to come up with its final address of 080102.
Introduction
Navigator defaults to the Network View. This view shows all of the network
devices in the Left Pane of Navigator. They are sorted by Area, System, and
Subnet Devices.
In Logical or Custom view, controllers are referenced the same way as in the
Network View. However, they do not display in the same hierarchical structure.
In Network view, the entries in the network tree in the Left Pane of Navigator are
indented to show the hierarchical structure of the BACnet controllers. In the
following figure, the Area Device 14 is shown in Network view with all other
System and Subnet devices in the proper hierarchy:
Click on the + symbol associated with the Area Device to see any System Devices
or Subnet Devices. When the network tree expands, the symbol changes to a -
symbol.
By collapsing or expanding these views you can view the sections of the network
that you want to see. The expanding and collapsing features of the network tree
work much like Microsoft Windows Explorer.
Controller Conformity
V3 Devices All Delta Controls Version 3 hardware now conforms to DNA
structuring. All Version 3 devices are organized under this hierarchical structure
and displayed under the BACnet Protocol tree.
V2 Micro off of
V3 DCU 140000
Note: Currently in the DSC/DAC, the user can set all the DIP switches to OFF.
This results in the controller appearing on the network as DEV0, which will result
in problems with DNA and can cause problems on the network.
Software
Addressed DCU
Third Party Devices Any third party BACnet devices that are connected to
the BACnet network display under the BACnet Protocol. Third Party BACnet
devices do not participate in DNA and will never fall under the collapsible tree
even if the address is similar to a System Device as shown in the following figure.
Third Party
Device 01
Workstation
Capabilities
Larger Networks
With DNA, a large network can be setup quickly with minimal manual
configuration of controller addresses. Area Controllers allow DNA to break up
large networks into network segments. The Area Controllers allow separate
network segments for floors or buildings. If Internet Protocol (IP) routers and
BACnet Broadcast Management Devices (BBMDs) are involved, you can add
Area Devices to the networks to group controllers together by address. This
approach clearly show which network that each controller belong to. It is
important not to connect two area controllers on the same network segment.
Logical Representations
With DNA, you can quickly identify the position of a controller in the network
hierarchical structure. This feature is very useful when connected to a site with
many controllers. You can quickly navigate through the system.
Limitations of DNA
Manual Adjustment
When DNA is enabled, you cannot manually change the Device Addresses or
Network Numbers. In most situations, the DNA Auto-Configuration feature
simplifies the addressing process by creating unique addressing schemes. If a
problem does occur, software addressing can resolve it. It is recommended to use
manual software addressing with caution, as it may cause more problems than it
solves.
See the Software Addressing section starting on page C–32 of this appendix for
more information.
See the Sample Network Architectures section of this Appendix starting on page
C–23 for more information on how to commission a network segment.
UDP/IP
R Routers R
BBMD
Ethernet Network #1 Ethernet Network #2
Devices
Other Other
Controllers Controllers
DCU DCU
Area 14 Area 02
DCU DCU
System System
140100 020300
The previous figure shows a valid arrangement of multiple Area devices as
BBMDs in order to connect buildings or networks together correctly.
Note: Since 3.22, Area controllers no longer pass DNA information over a
UDP/IP connection. Only the Network Number is passed. This approach
eliminates possible DNA addressing problems.
The one exception is a System controller that is promoted to an Area (e.g. 100 to
10000). The controller will see itself as 10000 and correctly reference objects in
remote controllers. However, the other controllers will look for 10100 and not be
able to handle remote references properly.
If Remove Area is not sufficient, then you can try the following procedure.
If this approach fails to restore the original controller addresses, then you must
segregate the network into smaller sections (by breaking up the System level
network) and proceed section by section until all sections are reconfigured. When
all sections are reconfigured, you can then re-connect the sections back into a
continuous network segment.
Architectures to Avoid
Some architectures are invalid or problematic when used with the DNA scheme.
Ethernet
MS/TP
Area Level
DSM-050 DSM-050
System Level
BACnet MSTP Network
communicating @ 76.8
LINKnet Newtork
LINKnet Newtork
Kbaud
LINKnet Level
This architecture shows how the DSM-050 can be used to route information
across Internet routers. The DSM-050 has BACnet/IP protocols and can send data
across a WAN, Intranet, or Internet network to another DSM-050. The DSM-050
is required to have a unique IP address on the network and when the two DSMs
know each other’s IP addresses, the two network segments can communicate with
each other.
This following figure shows a valid network arrangement as the Area Devices also
act as the BBMD devices.
UDP/IP
R Routers R
BBMD
Ethernet Network #1 Ethernet Network #2
Devices
Valid Arrangement
Area Devices 14 and 02 Other Other
Controllers Controllers
DCU DCU
Area 14 Area 02
DCU DCU
System System
140100 020300
The BBMD device contains the IP addresses of all other BBMD DCUs set up to
communicate with each other.
See the UDP/IP section of this appendix starting on page C–27 for more details.
For example, if you are attaching a V2 Subnet device to a System Controller (63),
it is recommended to use the numbers ranging from (6301) to (6399). These
addresses can be set either in the MNP object of the V3 System Devices or the CP
object of a V2 System Device. Using this addressing convention, it is easy to
identify the System Controller that the subnet devices are connected to within
Navigator.
Workstation Ethernet
120800
DCU DCU
Area 12 System 08
120000
120801
RC 01 MS/TP
120802
RC 02
120803
RC 03
Note: Do not mix System Devices and Subnet Devices on the same MS/TP
network. This means that the subnet would have a single system controller
communicating with multiple Subnet controllers.
When the devices are first powered on, they should be started in a particular order.
Start up the Area controllers, then the System controllers and then the Subnet
devices. Wait two minutes after each group of controllers is powered up, before
powering up the next set of controllers. This approach gives each device time to
verify its settings and DNA addressing and avoids possible network conflicts. This
approach is only required the first time.
Note: The Area Device should be the device least burdened with I/O tasks and
calculations and should be on an Ethernet network segment. It should also be
relatively accessible for cabling. If you expand in the future, the Area Device can
then handle more duties without overloading the Area Device. You might decide
to designate the Area Controller as a BBMD device in the future.
Ethernet Network #1
MS/TP Network #2
MS/TP Network #1
Floor Two
RC 01 RC 02 RC 03 RC 04 RC 05
010201 010202 010203 010204 010205
Floor One
RC 01 RC 02 RC 03 RC 04 RC 05
010101 010102 010103 010104 010105
Numbering each System Device by the floor number allows easy location of a
device using the numbers that show in Navigator. It makes sense to do something
simple such as System Device 1 on floor 1 and System Device 2 on floor 2.
Building 1 Building 2
UDP/IP
(Internet)
Hub Hub
Ethernet #2
Ethernet #1
Other Controllers
DCU DCU
Other Controllers
Area 01 Area 02
BBMD Devices
In this example, the Internet is used to make the connection between these two
buildings. Area 01 and Area 02 are used as the BBMD devices to route
information between Building 1 and Building 2.
By using the layout shown in the previous figure, several benefits are realized.
• The need for extended cabling or modem connections to connect two
buildings is avoided by using an existing framework of cabling (the Internet).
Dial-up Sites
Dial-up sites can be used where cabling an Internet connection or Ethernet cabling
is impractical. Dial-up connections using modems are slower: For example:
• ORCAview to a remote DCU controller for dial-in and dial-out of alarms.In
the following figure, the DCU controller dials-out alarms to a remote
ORCAview station.
Ethernet #2
Modem Modem
Workstation
DCU DCU
Area 02 System 02
020000 020200
Note: It is not possible to have two controllers connected by any media that
contains the same physical hardware address. For example, you cannot connect
two Area devices that both have an address of 020000.
Note: DNA information does not pass through Point to Point connections, but
Network Numbers and Device Addresses do. Do not dial into a remote Device that
has a duplicate Network Number or Device Addresses on its network or you will
receive duplicate controller errors. An error message displays if this problem
occurs.
Network Numbers
Introduction
In BACnet, each physical network is assigned a unique Network Number.
Network Numbers identify the location of devices on a network and are used
when packets of information are routed between networks. When a new
controller, with DNA enabled, is attached to a network segment, the new
controller probes the network to determine the Network Number of all other
controllers on the same network. The new controller adopts the existing Network
Number as its own.
A controller can have more than one Network Number if it is attached to multiple
networks. For example, a DCU controller will have different Network Numbers
assigned for Ethernet, UDP/IP, MS/TP, and IntelliNet networks.
In order for the network segment to work properly, all devices on that segment
must share the same Network Number so that all the devices recognize that they
are on the same network. When DNA is enabled, the first controller that is
powered up on the network sets the Network Number for that segment. It will then
tell subsequent controllers that are powered on what the Network Number should
be.
Note: The only way to reset a Network Number from a controller once it has been
set is to have the device reconfigure itself to conform with other controllers or to
change the Physical Address of the controller. Right click on the controller in the
left side pane of Navigator, choose Command and then select Reconfigure.
Another way to change the Network Numbers is by turning off the controller and
changing the physical address of the controller using the DIP switches.
UDP/IP
As with all Network Segments, connecting devices using UDP/IP assigns a
Network Number. If one Area Device, that is configured as a BACnet Broadcast
Management Device (BBMD), is turned ON first, it sets the Network Number for
all other BBMDs that are within the list to 4AA00 where AA is the Area Number.
Note: Since 3.22, Area controllers no longer pass DNA information over a
UDP/IP connection. Only the Network Number is passed. This approach
eliminates possible DNA addressing problems.
Examples
The order that the devices are powered up sets the Network Numbers.
Ethernet
Network Number 10800
Powered Up
First
DCU DCU
Area 08 System 22
In the following figure, if the Area Device was powered up first, a Network
Number of 10800 would be assigned to the Ethernet Network, since the Area
Device is 08.
In the following figure, if the System Device was powered up first, a Network
Number of 10022 would be assigned to the Ethernet Network, since the System
Device is 22. Adding an Area Device at a later point will reconfigure the Address
of the System Controller but the Network Number will remain the same.
Ethernet
Network Number 10022
Powered Up
First
DCU DCU
Area 08 System 22
Error Messages
When setting up the controllers with the DNA scheme, helpful messages are
sometimes displayed on ORCAview. This section discusses the common error
messages that may occur when configuring, commissioning, and troubleshooting a
site.
Circular Network
Ethernet
I-Net
DCU
Area 08
Workstation
OWS 27216
When you have duplicate Controller addresses, an error message displays that is
very similar to the previous Circular Network error message. This error occurs if
you have two controllers with identical DNA addresses on the same network as
shown in the following figure.
Ethernet
DCU DCU
System 059 System 059
565900 565900
If you have two network segments using the same Network Number, the previous
error message displays. If this error occurs, sections of the network may not
display in the Left Pane of Navigator. As long as you turn ON the controllers, one
at a time, and wait two minutes for each device to configure, this error should not
occur. If this error does occur, use the following procedure to correct the problem:
The yellow wrench will display on the controller icon in the Left Pane of
Navigator indicating that the controller is mis-configured. To fix this problem,
right click on the controller, choose Command, and then select Reconfigure.
Software Addressing
Introduction
It is recommended to use the DNA addressing scheme in all situations. However,
there are some special cases where software addressing is the preferred approach.
Software addressing needs more effort to configure, and may cause additional
problems. Whenever possible, use the DNA scheme to Auto-configure controller
addresses.
The DCU on the other hand will go into software addressing mode when all the
DIP switches are OFF. When set into software addressing mode, the DCU will
retain the previous address it had until the user changes it. This helps to avoid any
conflicts in addresses.
Note: Currently in the DSC/DAC, the user can set all the DIP switches to OFF.
This results in the controller appearing on the network as DEV0, which will result
in problems with DNA and can cause problems on the network.
6 From the Navigator window, open the BACnet Protocol Settings (BCP) or the
Network Protocol Settings (NET) object on the Software Addressed
controller.
7 Set the Network Number of the segment to be the same as the rest of the
controllers. This is the number that is recorded in Step 3. Double click on the
Network Number that needs to be changed and enter the correct Network
Number that the rest of the controllers are using.
8 In the Left pane of Navigator, right click on the software addressed controller
if it has a yellow wrench indicating that it is mis-configured. Choose
Command and select Reset.
Note: While the controller is in the Configuration menu, it will not perform any of
its database functions (i.e. Inputs/Outputs, Data Exchange, Networking, Event
Management, etc.). If a button is not pressed within 30 seconds, the controller
automatically exits the Configuration menu and resumes normal operation.
ON
DNA
b. Use either of the two inner buttons in the top row of the controller’s
keypad to turn DNA OFF.
OFF
DNA
3. Next, you need to enter an Address for the controller. There are four separate
menu options that are only available after you disable DNA: ADDRESS,
SYSTEM, AREA, and OEM. When each of these values is specified, the
controller’s Address is determined by putting them together in the following
sequence:
<OEM><AREA><SYSTEM><ADDRESS>
The AREA, SYSTEM, and ADDRESS portions take up two digits, while the
OEM portion takes up only one digit in the controller’s Address.
Note: This is the same addressing format that the controller uses when DNA is
enabled, except the controller automatically calculates these values. The range of
the Address that you can enter is 1 to 4,194,303.
a. Press the right-most button in the top row of the controller’s keypad
until the LCD screen appears as shown below.
1
ADDRESS
b. Use either of the two inner buttons in the top row of the controller’s
keypad to select the ADDRESS portion of the controller’s Address
(0 – 99).
Note: The controller uses the ADDRESS value as its MAC address on its local
MS/TP network segment. Therefore, this value must be unique from all the other
device MAC addresses on its local MS/TP network segment.
c. Press the right-most button in the top row of the controller’s keypad
until the LCD screen appears as shown below.
0
SYSTEM
d. Use either of the two inner buttons in the top row of the controller’s
keypad to select the SYSTEM portion of the controller’s Address (0
– 99).
e. Press the right-most button in the top row of the controller’s keypad
until the LCD screen appears as shown below.
0
AREA
f. Use either of the two inner buttons in the top row of the controller’s
keypad to select the AREA portion of the controller’s Address (0 –
99).
g. Press the right-most button in the top row of the controller’s keypad
until the LCD screen appears as shown below.
0
OEM
h. Use either of the two inner buttons in the top row of the controller’s
keypad to select the OEM portion of the controller’s Address (0 – 4).
4. Exit the Configuration menu and return the controller to normal operation by
following these steps:
a. Press the left-most button in the top row of the controller’s keypad
until the LCD screen appears as shown below.
NO
EXIT
b. Use either of the two inner buttons in the top row of the controller’s
keypad to select YES.
YES
EXIT
c. Press either the right-most or left-most button in the top row of the
controller’s keypad to exit the menu.
Note: As an alternative, do not press any buttons for 30 seconds. This will cause
the controller to automatically exit the menu. You can also unplug power to the
controller, and then connect the power again to resume normal operation. In both
these situations, it will save any changes done while in the Configuration menu.
Once the controller is configured with DNA disabled, you can change its Address
to any value you want using Navigator. To do this, open its Device (DEV) object
and enter the desired address for the controller in the Software Address field on
the Description tab. Click OK. The controller will then reappear in Navigator with
the address you entered into its Device object.
Appendix D Contents
APPENDIX D CONTENTS .......................................................................................D-1
OVERVIEW ...........................................................................................................D-3
SITE SETTINGS .....................................................................................................D-3
To enable or disable the Delta Version 2 protocol for a
particular site: ....................................................................D-3
SECURITY WITH VERSION 2 CONTROLLERS ..........................................................D-4
Site Settings Object ...............................................................................D-4
Creating a New User.............................................................................D-5
To create a new User: ..............................................................D-6
Deleting a User from the System ...........................................................D-7
Logging in with a New User..................................................................D-7
Setting Permissions for Version 2 Objects ............................................D-9
To set the permissions for a specific type of object: ...............D-9
To set all objects to the same permissions for a user:............ D-10
ALARMS FROM VERSION 2 CONTROLLERS ......................................................... D-10
Alarm Notifications ............................................................................. D-10
Viewing Active Version 2 Alarms in Navigator................................... D-11
Loading Active Version 2 Alarms at Login ......................................... D-12
Routing V2 Alarm Notifications to Printers, Files, and Event Logs ... D-12
To configure the individual Version 2 alarms to print to
the Windows printer: ....................................................... D-13
To use an Event Router to send the Version 2 notification
to a printer: ...................................................................... D-14
To log the Version 2 notification to an Event Log: ............... D-15
Filtering Version 2 Alarm Notifications from ORCAview .................. D-16
To filter Version 2 Security type alarms from the OWS: ...... D-17
ORCAVIEW AUTO-ANSWER FOR V2 ALARMS ................................................... D-21
To configure ORCAview to only wait for Alarm
Notifications: ................................................................... D-22
To configure ORCAview to receive Alarm Notifications
and allow immediate network connection: ...................... D-23
V2 DCU Communicate with OWS via Modem .................................... D-25
Examples of Trend Log Options .......................................................... D-28
VERSION 3 DCUS WITH A SUB-NET OF VERSION 2 MICROS / PZONES / DACS .. D-30
To configure V2 security and enable V2 protocol for the
site: .................................................................................. D-31
To add a sub network of Version 2 Micro panels to a V3
DCU: ............................................................................... D-32
CHANGING MICRO ADDRESSES IN V3 ORCAVIEW............................................ D-34
To change a V2 micro address using MicroNet .................... D-34
DATA EXCHANGE BETWEEN VERSION 2 CONTROLLERS AND VERSION 3 DCUS D-36
Writing a Version 3 Value to a Version 2 Global Variable ................ D-36
To write a Version 3 value to a Version 2 controller: ........... D-37
Version 3 Reading a Value from a Version 2 Point ............................ D-37
Overview
This appendix provides information for sites that use ORCAview as the front end
for sites that are running Version 2 controllers.
The Delta Controls Wiring and Installation Guidelines, Rev. 1.0 contains wiring
practices and guidelines for Power, I/O, RS485, Ethernet and RS232 in one
document. A PDF file of this document is on the ORCAview CD-ROM.
Site Settings
The Delta Version 2 protocol must be enabled in the Site Settings (SS) object to
use ORCAview with Version 2 controllers.
2. Select the Application Protocol tab on the Site Settings (SS) object and enable
or disable the Delta Version 2.
—OR—
The flowchart below shows the process that the OWS uses when a new user is
created:
Is a V2 Security
Yes no
panel online?
1. From ORCAview Dashboard, chooses File, select New and click User… A
new System User Access object appears.
2. On the Setup tab of the SUA, enter a username and password and press
Apply.
3. When the object is applied, the OWS automatically checks for the V2
Security Panel.
4. The OWS then creates a User Access object on the V2 Security Panel with
matching username and password.
SUA object is compatible with the User Access (UA) object in Version 2
controllers.
4. Enter a valid
password (Limited to
4 -14 characters).
If the previous dialog displays, click OK and adjust the password in the SUA on
the OWS and in the V2 UA object.
When deleting users, you are presented with 2 dialogs. The first one is a
confirmation to delete the object:
Click yes on the Deleting object dialog, the following dialog displays:
If you click Yes on this dialog, the corresponding UA object in the V2 Security
Panel is deleted, and also the SUA in the V3 Security Panel.
If the user passes the check with the SUA objects in ORCAview, then ORCAview
verifies that this user is valid according to the specified Security Panel(s). This
check is performed independently for Version 3 security and Version 2 security.
No
1. At the Logon dialog, the user enters their username and password.
2 When the OK button is clicked, ORCAview verifies the username and
password against the SUA objects inside the workstation.
3 If ORCAview passes its own security check it moves on and begins verifying
the username and password on the Version 3 security controller. If
ORCAview fails the security check against itself, then login is denied
completely.
4 ORCAview verifies the username and password against the SUA objects in
the Version 3 security controller.
5 If the Version 3 security check fails then no Version 3 controllers display in
Navigator. If the security check passes, then Navigator displays Version 3
controllers. Regardless of the outcome ORCAview moves on to verify the
Version 2 security check.
6 ORCAview verifies the username and password against the UA object in the
V2 Security Panel. If the check fails, then no Version 2 controllers display in
Navigator. If the check passes, Navigator displays Version 2 controllers.
The specified Version 2 Security Panel always determines the level of permissions
for all Version 2 objects. You must have full edit access of the User Access object
in your User Access (UA) object to set the Version 2 object permissions for a user
2. Open the User Access object in the right hand pane of Navigator.
5. Click OK or Apply.
5. Click the Set All button. This will duplicate the permissions onto all the
Version 2 objects.
6. Click OK or Apply.
Alarm Notifications
You are informed of a Version 2 alarm by an Alarm Notification dialog box. The
Alarm Notification dialog provides the following information:
• the name of the alarm
• the name of the monitored object
• the status of the alarm object
Total Active
Alarms
Active V2 Alarm
V2 Alarm Status
V2 Alarm
Message
You can choose to view either the monitored object or the alarm itself from the
Alarm Notification Dialog box. To do so, click the Open buttons beside either the
Monitored Object name or the Event Object name.
You can acknowledge the alarm or dismiss the alarm notification without
acknowledgement.
Active Alarms
Folder
Active Version 2 alarms can be acknowledged and deleted from the Active
Alarms Folder. They will automatically be removed from the folder when the
alarm has been acknowledged and the monitored object has been restored to a
normal condition.
When Navigator is set to show only active alarms, it will show the Active Alarm
List on the selected V3 controller. Version 2 controllers do not contain Active
Alarm Lists and do not display when Navigator is in this view. When Navigator is
set to display only active alarms, a Version 2 controller will display a message
saying No Active Alarm List from this controller.
Version 2 Controller Only Sites In sites where there are only version 2.9x
controllers the OWS will look to the Alarm Report (AR) objects on each
controller. Refer to the Commander Technical Reference version 3.10 manual for
further instructions regarding configuring Alarm Report objects in your system.
Version 2 DAC / Micro / PZone off V3 DCUs V3 DCUs are configured to
automatically track all active Version 2 alarms that come from Version 2
controllers sub-netted off them. When the OWS logs into the site it will load any
active alarms from the Active Alarm List on the V3 DCU.
When configuring a subnet of Version 2 Micros from a Version 3 DCU, you must
create an Alarm Report (AR) object on each Micro Panel and have the alarms
reference them. The Alarm Report does not actually track the alarm activity but
allows V3 controllers to route the notifications to printers or logs.
A V3 DCU controller that acts as a router must have an address lower than 32767
if there are V2 devices on the network.
Printing to Windows Printer There are two different methods for sending
Version 2 alarm notifications to a Windows printer.
1. Utilize the “Direct Report To” fields in the Alarm (AL) object
-OR-
2. Utilize a Event Router (EVR) object in ORCAview
4. Click OK.
3. Click OK.
The previous example routes only alarm 101.AL1 to the Epson printer.
Class/Event Function
Field Entry
101.AL* Routes all alarm notifications generated by controller 101
*.AL* Routes all Version 2 alarm notifications generated on the
network.
Maintenance Routes all V3 Maintenance class alarms and all Version
2 alarms of the Maintenance type.
Note: The Event Log reference cannot be entered into the Direct Report to fields
in the actual Version 2 Alarm (AL) object. An Event Router object must be used on
the controller with the Event Log.
The following example will log all Critical type Version 2 alarms to a critical
event log on a DCU.
2. On the Alarm
Filtering tab,
enter Critical as
the class of
event to log
3. Click OK.
Note: This note only applies to sites containing both Version 2 and V3 controllers.
The procedure outlined above will also result in any V3 alarms that reference the
“Critical” class being routed to the log as well as the Version 2 alarms.
If this is not the desired functionality you can rename the default Event Class
objects in the system so that they are identified as Version 2 classes. For example
rename “Critical” EVC4 to “Critical (V2)” and then create a new class called
“Critical (BACnet)”.
WARNING
Warning: Creating EVC10 as “V2 Critical” will not work. V2 alarms types are
equated directly to EVC1 - EVC6.
The Priority Override option only applies to V3 alarms. V2 alarms ignore the
priority override value stored in the EVF object.
Once a certain alarm type is filtered from the OWS any alarms generated in the
future will not be displayed in the Active Alarms Folder nor will an Alarm
Notification dialog be displayed.
WARNING
Warning: Before the Event Filter (EVF) object will filter the Version 2 alarm
notifications the alarms need to reference an Alarm Report (AR) object. This
applies to Version 2 alarms that are generated by Version 2 DCUs, and also to
Version 2 alarms generated by Micro panels subnetted off of a V3 DCU.
The following example outlines the steps required to filter out Version 2 alarm
notifications from the workstation.
4 From the EVF dialog, double click in the first column of the Disallowed
Alarms dataview and select Security from the drop-down list.
7 From the User Data tab of the SUA, use the Alarm Filter field to select the
Event Filter that was created in steps 1 through 5.
If this is not the desired functionality you can rename the default Event Class
objects in the system so that they are identified as Version 2 classes. For example
rename “Critical” EVC4 to “Critical (V2)” and then create a new class called
“Critical (BACnet)”.
Warning: Creating EVC10 as “V2 Critical” will not work. V2 alarms types are
equated directly to EVC1 - EVC6.
WARNING
There are two methods to set ORCAview up in auto answer mode. The first
method provides security for the network and will not allow anyone to connect to
the network until ORCAview is restarted. The second method allows the user to
reconnect to the network at any time while ORCAview is running.
The Remote OWS is configured to wait for V2 Alarm Notifications that are
coming in via the modem.
2. Enter the
Username and
Password.
4. Select the
Connect Type.
5. Select the
modem
7. Click OK
Any active alarms that come in are displayed in a alarm notification dialog as well
as being loaded into the active alarm list. Alarms will appear just as they do on a
dedicated ORCAview PC.
2. In Application Protocol tab of the Site Settings (SS) object on the OWS,
ensure that the Delta Version 2 is checked.
3. Enter the
Username and
Password here.
5. Select the
Modem Dial-Out
Connect type.
6. Select Modem
(MDS) object.
9. Click OK.
10. ORCAview will now ask for the Remote Panel number. Enter the address of
the device that is being dialed and click OK.
11. ORCAview will begin to dial out to the device and fail the first time. Click
OK. This step needs to be done only once.
12. The logon screen will reappear. Enter the data as in steps 2 – 9 and click OK.
13. The second attempt to dial in will be successful and the network will appear
in Navigator.
14. Once the network is logged into the Remote Panel Settings (RPS) object can
be used to disconnect from the network. Right click on the RPS object and
select “Disconnect”
Note: The ORCAview PC that is to receive the alarm notification must establish a
connection to the network before any object names will be displayed, logged, or
printed properly in the future.
ORCAview has a Version 2 Trend Log (TL) object. New Trend Log features
include:
• Larger graph area
• Improved printout
• Auto scaling
• Adjustable Y axis scaling
.
Auto Range automatically High Range adjusts the Low Range adjusts the
adjusts the y axis values to maximum value of the minimum value of the
fit the range of sample Y axis. Y axis.
values.
Note: Any changes made to the Auto, High, and Low Range values in ORCAview
are lost when the Trend Log object is closed. This is because these parameters are
for display only and are not stored in the Version 2 controllers’ TL object on the
controller.
Display Samples The Display Samples setting allows the user to adjust the
number of samples that will be displayed along the time (x) axis. This can be any
number up to 200.
Auto Range When the Auto Range checkbox is enabled the Trend Log will
automatically adjust the minimum and maximum values of the Y axis. These
adjustments are based on the minimum and maximum values of the samples.
When this setting is disabled, the user can adjust the minimum and maximum
values of the Y axis.
High Range The High Range setting is available when the Auto Range
checkbox is disabled. The setting allows the user to adjust the upper limit of the Y
axis.
Low Range The Low Range setting is available when the Auto Range
checkbox has been disabled. The setting allows the user to adjust the lower limit
of the Y axis.
In the following figure, Auto Range is disabled and the High Range is adjusted to
exceed the maximum sample value.
In the following figure, Auto Range is disabled and the High and Low Ranges are
adjusted to focus around the Room Temp and setpoint lines.
In the following figure, Auto Range disabled with High and Low Ranges adjusted
to focus around the Room Temperature and setpoint lines.
Note: Any changes made to the Auto, High, and Low Range values in ORCAview
are lost when the Trend Log object is closed. This is because these parameters are
for display only and are not stored in the Version 2 controllers’ TL object on the
controller.
With 3.33, the DSC-R2424E controller also supports communication with Version
2 subnets. See the sections “DSC-R2424E Communication with V2 Controllers”
starting on page D-40 or “Transferring Values between DSC-R2424E and V2
Controllers” starting on page D-42 in this Appendix.
Fixed algorithm Zone Controllers can simply be connected to the RS485 port of
the BACnet DCU in the same manner as version 2 DCUs. The addresses of the
Zone Controllers must be beyond the address of the last micro address. A Zone
Controller Object (ZC) must be created for each Zone Controller that is on the
network, and the instance number of the ZC Object must match the address of the
Zone Controller.
currently unconnected device, put the ZC in Manual mode until the device is
connected.
Zone Controller Format Objects (ZF), which replace the version 2 IF Objects,
must be created on the DCU controller now. In versions prior to 3.33, the ZF
object was created on the OWS local workstation. The number of ZF Objects
required will depend on the similarity of operation of the Zone Controllers and the
naming convention of the various objects. Generally speaking, generic naming
conventions allow the number of ZF Objects to be reduced.
For Micro Controllers to display in the Navigator network tree, Version 2 Protocol
must be enabled.
The Security Panel must have a UA for any user who wishes to log in to V2.
3 Click on the Application Protocol tab and ensure that the Delta Version 2 and
BACnet Protocols are enabled.
4 Click OK.
3. Click OK.
7. Click OK.
8. Reset the Version 3 DCU by right clicking in the left Navigator pane on the
Device object that will host the micros and then selecting Command > Reset.
A V3 DCU always needs to be reset after making any network configuration
changes.
When adding a subnet of Version 2 Micro Panels or DACs to a Version 3 DCU,
logical micro ranges should be used. For example, DCU 100 should use a micro
range of 101 – 199. Likewise DCU 200 would use a micro range of 201 – 299.
There should not be any micros missing in the middle of a range. If the specified
range is 101-109, then there must be 9 micros or network performance will be
impaired.
WARNING
Warning: Avoid using micro ranges such as 1 – 10. These micros appear in the
system as Micros 1 through 10 and will conflict with any micros networked from
other devices that have their micro ranges configured the same way. The micro
range should also not exceed the true number of micros on the network.
2. Enter the number equivalent to the new address in the new field and click Set
Address Button, then the Get Address button.
(The new address will appear in the Present field.).
3. Click OK.
4. The Micro with the previous address will X out and the Micro with the new
address will be displayed as valid in Left Pane of Navigator.
Note: The 292 Build 27 is not available for general release, contact Delta
Customer Solutions for more information.
The process for writing data to a Version 2 controller is done with GCL+ on the
Version 3 DCU. The example below shows how to write the outdoor air
temperature to a global variable in a Version 2 controller.
Note: Data can only be written to Global Variables. Outputs cannot be written to
directly.
Note: When coding values for a remote controller, DoEvery is not recognized. By
default, V2 controllers only send data every minute.
The 1 in 1.IP in the previous code is the address of the V2 controller that is
read from the V3 controller.
The following is a brief outline of the steps to get a value from a Micro Panel to a
Version 3 DCU:
I. Set up Zone Controller (IC) and Zone Controller Format (IF) Version 2
objects on the Micro Panel.
II. Create a Program on the Micro that sets the value of Input 1 of the Zone
Controller (IC) to the desired value.
III. Create a Zone Controller (ZC), a Zone Format (ZF) and a Variable on the
Version 3 DCU. The ZFs must be on the OWS.
IV. Create a Program on the Version 3 DCU that sets the value of the
variable to the value of Input 1 in the ZC object.
The following detailed example shows how to get the Room Temperature (IP1)
from a Micro Panel (101) and into an analog variable on the Version 3 DCU
(DEV100).
1. On the Micro Panel, create a new Zone Control Format (IF) object.
2. Click on the Inputs tab of the IF. In the Input #1 field, type Room Temp.
3. In the field beside the Input name, use the drop down to select the appropriate
units.
4. Click OK.
5. Select the Micro Panel in the left hand pane of Navigator. Then right click on
it and choose Reload System Objects.
6. Reopen the IC object on the Micro Panel and select the newly created IF in
the Zone Controller Format field. Check the Commissioned box.
7. Click Apply. Ensure that the IC object displays Online.
Note: The IC and ZC do not function until they are commissioned. Each IC and
ZC has a Commissioned field. This field must be checked. When IC and ZC is
Second Task: Create a Program on the Micro that sets the value of Input 1 of
the IC to the desired value.
1. On the Micro Panel, create a Program (PG). Name it something like
IC_Transfer.
2. In the program add the line:
DoEvery 1M
IC1.I1 = IP1
End Do
3. In the Main Program (PG1), add a line to CALL the new PG created above.
Third Task: Create a ZC, ZF and a Variable on the Version 3 DCU.
1. Create a Zone Controller Format (ZF) object on the Version 3 DCU and name
it ZF1. In the first Input field of the Inputs/Outputs field enter Room Temp.
2. Click OK.
3. Select the Version 3 DCU in the left hand pane of Navigator. Then right click
on it and choose Reload and select System Objects.
4. Select the Version 3 DCU that the Micro Panel is attached to and create a new
Version 2 Zone Controller object on it. Type a name. (This assumes that the
Micro is Micro 101).
5. Switch to the Operation tab of the ZC and select the newly created ZF in the
Format field. Check the Commissioned box.
6. Click Apply. Ensure that the ZC object displays Online.
7. Create an Analog Variable (AV1) on the Version 3 DCU and name it Room
Temp.
Fourth Task: Create a program on the Version 3 DCU that sets the value to
the variable to the value of Input 1 in the ZC object.
1. Create new Program (PG) on the Version 3 DCU and name it ZC
Transfer.
2. In the program add the line:
DoEvery 1M
AV1 = ZC1.I1
End Do
3. Click OK on the Program.
4. In the Main Program (PG1), add a line to CALL the new PG created above.
Zone Controller Format Objects (ZF) replace the V2 IF Objects. These ZF objects
should be stored on the DSC-R2424E. The number of ZF Objects required
depends on the similarity of operation of the Zones and the naming convention of
the various objects. (Generic naming allows the number of ZF Objects to be
reduced.)
Note: These steps are intended for an existing Zone network. If the network needs
to be rewired, or Zone addresses are changed, then it is suggested to connect one
or a few Zones at a time to the DSC-R2424E and manually create a ZC object for
each Zone.
DSC-R2424E
3. Click the “Go” button and then the “Apply” button to start an automatic scan.
The DSC-R2424E will automatically create ZC objects with an instance
number matching the address of the Zones it detected.
4. Increase the polling Interval field if you encounter communication problems
with the Zones. In most cases, the default 200 milliseconds polling interval
should be satisfactory.
The addresses of Zones do not have to be continuous but they must be within the
range of 1 to 998. To change the Zone address, open the corresponding ZC object
dialog and click the Operation tab.
Note: Each controller must have a unique address within the same network. Make
sure the new address does not conflict with another controller. Communication
problems will occur if two controllers share the same address.
After the Zone’s address is changed, the New Address field in the ZC object
dialog will revert to the old address, and all values will no longer update. In order
to communicate with the Zone, you can either manually create a ZC object with
an instance number matching the new Zone address or trigger an automatic scan
to detect and automatically create a ZC object in the DSC-R2424E.
Note: You need an OWS to access the Micro directly through Micronet in order to
create IC, IF and PG objects in the Micro controller.
The following is a summary of the tasks required to transfer a value from a Micro
to a DSC-R2424E. Each task is further described in the following example:
1. Set up Zone Controller (IC) and Zone Controller Format (IF) objects on the
Micro controller
2. Create a Program on the Micro that sets the desired value into the IC
3. Connect the Micro to the DSC-R2424E’s Zone port and create a Zone
Controller (ZC), a Zone Format (ZF), and a Variable on the DSC-R2424E
4. Create a Program on the DSC-R2424E that assigns the variable to the value
from the ZC object
Second Task: Create a Program on the Micro that sets the value of Input 1 of
the IC to the desired value.
1. On the Micro, create a Program (PG) “IC_Transfer” containing:
DoEvery 1M
IC1.I1 = IP1
End Do
2. In the Main Program (PG1), add a line to CALL the new PG.
Call ‘IC_Transfer’
Fourth Task: Create a program on the DSC-R2424E that sets the value of the
variable to the value of Input 1 in the ZC object.
1. Create a new Program (PG) “ZC Transfer” on the DSC-R2424E
containing: (assuming the Micro has an address of 1)
AV1 = ZC1.I1
2. Click OK.
3. In the Main Program (PG1), add a line to CALL the new PG.
Example: Using DoEvery Statement to set Control Mode and Setpoint1 of Zone1
DoEvery 10M
ZC1.ControlMode = ‘Day’
ZC1.SetPoint[1] = 72
End Do
The following procedure requires that the V3 DCU controller already be flashed
with firmware included with the ORCAview 3.22 release or latter. This firmware
contains code to enable or disable IntelliNet routing restrictions.
Note: Also any V3 DCUs used as IP routers that have local V2 controllers (DCUs
or Turbos, etc) need to be addressed lower than 32767. The address of the OWS
must also be below 32767.
Also any V3 DCUs used as IP routers that have local V2 controllers (DCUs or
Turbos, etc.) need to be addressed lower than 32767.
Example 1:
Consider 2 networks of V2 controllers with a total of 125 controllers each
connected using IntelliNet and joined with Ethernet and two V3 DCUs. The
controller numbers are scattered between the two networks, but devices 30-35 are
on network 1 and need to communicate with devices 110-115 and network 2.
To allow these, but no other devices to communicate across the V3 DCUs, do the
following in each of the V3 DCUs:
Example 2:
The network described in Example 1 has an OWS added to the Ethernet that is
numbered as device 200. The OWS needs to see all devices and both subnets.
To allow the OWS to see all devices and both subnets, add the following to each
of the V3 DCUs:
If you use the V3 DNA addressing convention with the existing V2 addressing
convention, you should not encounter any problems as the V2 System Controllers
are by convention addressed as 1-99 and the V3 System Controllers are addressed
as 0100-9900.
Unlike the V3 DNA scheme, you must be careful when controllers are moved
around the network during an upgrade. You cannot have the same DIP switch
address in any V2 controllers under any circumstance, unlike V3.
Ethernet
BACnet MS/TP
V2 Micronet
V2 Micronet
V2 DCU V3 DCU V3 DCU
System 11 System 12 System 13
V2 RC V2 RC
V2 RC V3 RC V2 RC
Existing V2 Room
Existing V2 Room
Controllers attached
New V3 Room Controllers being
to an existing V2
Controllers attached attached to a newly
System Devices.
to newly installed V3 installed V3 System
V3 RC device.
System devices.
The following figure shows one valid way to address the V2 controllers on a
subnet so that they match the V3 controllers on the network.
Ethernet Network
MS/TP (RS-485)
1300
V3 DCU
System 13
1301
Range for V2 RC V2 RC
devices in the MNP
1302
object is 1301-1302. V2 RC
You have to manually adjust the range in the MNP object. If the range for all of
the Room Controllers on the network were simply 1-3, a conflict would occur for
the V2 Subnet controllers. However, by adjusting the V2 controller addresses to
match the V3 controller, the previous valid arrangement can be configured and
used.
Table of Contents
INTRODUCTION .................................................................................................... E-2
This Document ...................................................................................... E-2
Supported Protocols for RS-485 (NETx) Ports ..................................... E-2
MS/TP AND LINKNET NETWORKING .................................................................. E-3
Communications Setup.......................................................................... E-3
Service Port Access on MS/TP or LINKnet ........................................... E-4
LINKNET BASICS................................................................................................. E-5
LINKnet Defined ................................................................................... E-5
Limits on Number of LINKnet Devices ................................................. E-5
Connecting LINKnet Devices ................................................................ E-7
Enabling LINKnet ................................................................................. E-8
Accessing Objects from LINKnet Devices ............................................. E-9
LINKNET DFM I/O BEHAVIOR .......................................................................... E-10
Persistent-COV Communications ....................................................... E-10
Communication Failure (Degraded Mode)......................................... E-10
HOA Switches ..................................................................................... E-11
Required DFM Firmware ................................................................... E-11
Introduction
This Document
Audience This appendix is intended for Partner service personnel, involved in
the installation and support of a facility control system.
Depending on the controller, there are several different protocols that can use
these ports:
BACnet MS/TP – All DSC/DAC controllers and BACstats (with the exception of
the DNS-24L) support BACnet MS/TP on their primary RS-485 port. Only
System and Area level DSC controllers support BACnet MS/TP on their
secondary RS-485 port. In addition, the DFM-200, DFM-400 and DFM-400P
support BACnet MS/TP.
Note: DFM’s with outputs are not supported on a BACnet MS/TP network
because the network may have poor performance response time for controlling
outputs, particularly on a large network.
Note: The DNT-T221 and DNT-T103 BACstats should only be used on LINKnet
when the algorithm is set to “none” and all output control is done through its
associated ‘parent’ controller.
The protocol that the NET1 and NET2 ports use varies depending on the
controller and the application. The typical configurations are:
DAC-Based Controller
Port Protocol
NET1 BACnet MS/TP (subnet level)*
NET2 LINKnet or Modbus
*Refer to Appendix C – Derived Network Addressing (DNA) and the Delta System
Description for more information on the distinction between system and subnet
level controller networks.
Note: It is recommended to use Ethernet controllers at the system level for large
networks, as BACnet MS/TP does not have enough bandwidth for the amount of
traffic a large network generates at the system level.
Communications Setup
When setting up an MS/TP or LINKnet network, ensure:
• All controllers are operating at the same speed
• All controllers have unique addresses
• The network installation follows the recommended guidelines for cabling,
power supply and connecting MS/TP and LINKnet devices
Refer to the Delta Controls Wiring and Installation Guidelines document for
wiring practices and guidelines for power, I/O, RS-485, Ethernet and RS-232.
All of the following factors are extremely important. If any one of these is
overlooked, it could cause network problems and it may be difficult to locate the
problem.
Connecting MS/TP and LINKnet Devices When the address of a new device is
set (with the default factory settings), it should communicate on the network
without any further hardware or software configuration changes required. Since
all Delta devices are shipped with a default baud rate of 76800, the network
should communicate immediately. The entire network can be connected together,
and then powered up at the same time or one at a time.
Local access to the entire network is possible when using a CON-768 or CON-
768BT to connect an OWS on a Laptop to the network through this service port.
For further information on how the service port works and how it is used, refer to
Appendix F – Service Port Access.
LINKnet Basics
LINKnet Defined
Delta has created a proprietary protocol for use with our Native BACnet
controllers called LINKnet. LINKnet uses a BACnet MS/TP backbone with some
additional proprietary network services for mapping remote I/O information into a
DSC/DAC controller as virtual I/O. The DSC/DAC controller can then use these
virtual I/O objects to execute control strategies through GCL.
The following table lists the maximum number of LINKnet devices supported by
each controller, as well as the maximum number of LINKnet DFM’s supported,
when this document was revised.
Max DFM Devices is the total number of LINKnet DFM devices supported.
The total number of DFM devices is significantly less than the maximum number
of LINKnet devices so that the DSC/DAC is not overloaded with remote I/O.
Ethernet
System Level
Subnet Level
LINKnet on LINKnet on
NET2 NET2
LINKnet Network
LINKnet Network
LINKnet Network
LINKnet Network
LINKnet Level
BACstat BACstat BACstat BACstat
Each LINKnet device must have a unique address on a given LINKnet network
segment. BACstats can be addressed from 1 to 12, whereas DFM’s can be
addressed from 1 to 99 (even though, in most cases, the maximum number of
DFM’s is 2).
Enabling LINKnet
LINKnet is enabled in the Device (DEV) object.
Note: The controller must be reset when changing the LINKnet setting.
To enable LINKnet:
1. Using Navigator, open the DEV object of the DSC/DAC device.
2. Select the Configuration tab.
3. Specify the LINKnet Port.
Specify the
LINKnet port
(NET1 or NET2)
4. Reset the controller by selecting it in the left pane and right clicking. From
the submenu, select Command | Reset.
A LINKnet (LNK) object that refers to each LINKnet device will be created in the
DSC/DAC database. For a LINKnet device addressed as 1, LNK101 will be
created; for a LINKnet device addressed as 2, LNK201 will be created; etc.
For each BACstat, an LCD object will also be automatically created in the
DSC/DAC database. For a BACstat addressed as 1, LCD101 will be created; for a
BACstat addressed as 2, LCD201 will be created; etc.
For example, AI301 in a DSC/DAC would be used to access AI1 on a DFM with
a device address of 3 on the DSC/DAC’s LINKnet network.
Analog, Binary, and Multi-State input objects (AI, BI, MI) can be created to refer
to the physical inputs on a LINKnet device. Analog and Binary output objects
(AO, BO) can be created to refer to the physical outputs on a LINKnet device.
Analog Variable objects (AV) can be created to refer to the variables in a
BACstat.
Refer to the BACstat Application Guide for a list of variables that can be accessed
in a BACstat, in addition to information on accessing the LCD and Keypad.
Any objects linked to an offline LINKnet device will be in Fault with a Reliability
of ‘Linknet Offline’. Once the LINKnet device comes online, the objects will no
longer be in Fault and their Reliability will be ‘No Fault Detected’. If an object is
created to reference a non-existent input/output/variable on a LINKnet device, the
object will be in Fault with a Reliability of ‘Not Available’.
Persistent-COV Communications
LINKnet communications are ‘Persistent-COV’ – meaning input status (from the
DFM) and output commands (from the DSC/DAC) are sent persistently (every 10
seconds), in addition to whenever there is a change-of-value (COV). This hybrid
approach provides the reliability (and redundancy) of continuously repeated
messages, as well as the quick response time of COV detection.
In addition, COV messages require the recipient (either the DSC/DAC or the
DFM) to acknowledge that it received the message. This improves the speed of
response, ensuring values are re-sent quickly when not received the first time
(instead of waiting for the next periodic update).
The DFM monitors communications with the DSC/DAC and will revert outputs to
a pre-defined default or ‘Fail-Safe’ state if communications fail (no
communication with the DSC/DAC for 30 seconds). The fail-safe remains in
effect until communications are re-established.
Note: DFM’s on a BACnet MS/TP network should not be used to control critical
equipment.
The default value that the DFM’s outputs use is specified in the AO/BO objects
within the DSC/DAC.
In addition, the DSC/DAC monitors communications with the DFM and sets the
corresponding LNK and I/O objects to Fault if communications fail (no
communication with the DFM for 30 seconds). In the Priority Array of the output
objects referencing the DFM, the default value will be written to priority 4. Once
communications has been re-established, priority 4 will be relinquished and the
LNK and I/O objects will no longer be in Fault.
Note: Input objects that reference a DFM will retain their last value while the
DFM is offline.
HOA Switches
Currently, the only LINKnet device with HOA switches is the DFM-1616. The
HOA switch status is reflected in the AO/BO objects within the DSC/DAC
(putting the switches in the HAND or OFF position will cause the corresponding
AO or BO object to have a status of Overridden).
LINKnet DFM’s with firmware prior to these versions are not suitable for
controlling critical equipment because the DFM will retain its output values if
communications fail (outputs that are ON, stay ON). In addition, output
commands are NOT persistent; they are only based on COV. If you command a
DFM output to ON, and the DFM resets, the output will no longer be ON.
Note: A LINKnet DFM loaded with the above listed firmware will not work with a
DSC/DAC loaded with firmware prior to 3.33.
Table of Contents
TABLE OF CONTENTS ............................................................................................ F-1
OVERVIEW............................................................................................................ F-2
This Document ....................................................................................... F-2
Definitions ............................................................................................. F-2
REQUIREMENTS .................................................................................................... F-3
Product Requirements ........................................................................... F-3
Service Port Capable Hardware ........................................................... F-3
SUMMARY OF CAPABILITIES ................................................................................. F-3
Service Port Features ............................................................................ F-3
Functional Description .......................................................................... F-4
CONNECTION & SETUP ......................................................................................... F-4
Software Installation ............................................................................. F-4
Service Tool Products............................................................................ F-4
Connection and Configuration of a PC and ORCAview ....................... F-4
Flashing a Panel through the Service Tool Port ................................... F-6
To prepare to run Flash Loader:............................................... F-6
To run Flash Loader: ............................................................... F-7
To select a Flash Loader upgrade file: ..................................... F-8
To change the Flash Loader connection settings: .................... F-8
To transmit the upgrade file: .................................................... F-8
To verify flashing was successful: ........................................... F-8
Overview
Service Port Access provides a user with system-wide access to an entire network of
BACnet devices by means of an easily accessible connection point on a BACstat II or
MS/TP-based Delta controller. The specific capabilities and functions will depend on the
user interface device that is connected to the Service Port.
A PC running ORCAview can be connected to the Service Port jack on devices operating
on an MS/TP or a LINKnet network through a CON-768 or CON-768BT converter.
Most of the newer DAC and DSC controllers as well as the BACstat II line of products
have a Service Port jack. Refer to specific product documentation to see if a particular
controller comes with a Service Tool port.
For more information, refer to the Install and Application Guide specific to the CON-768
and CON-768BT.
This Document
Audience This appendix is intended for Site Commisioners and Partner service
personnel, involved in the installation and support of a facility control system, as well as
End Users.
Purpose This appendix describes how the Service Port operates and how it provides
system-wide access from a suitable user interface device connected to the port.
Definitions
Interface Device Equipment or unit that provides a user interface for an operator
to access information from the control system and send manual
commands.
Jack The physical plug-in connection point – the RJ-11 jack.
Port The entry portal (hardware and software) for communicating to
and from peripherals or a network of devices.
RJ-11 Connector with six conductors, which is also commonly used as
a telephone jack in buildings.
Service Port The overall capability supported by both hardware and software
Access to provide system-wide access to users with an appropriate
interface device connected to an RJ-11 jack.
System-wide The ability to access all BACnet devices throughout a control
Access system, including across all network segments and over all
BACnet network media.
Bluetooth Wireless communication requires a Bluetooth USB dongle or
internal module on the PC.
Requirements
Product Requirements
In order to obtain system-wide access through the associated Service Port, the following
is required:
• A Delta Controller or Network Stat with a working Service Port jack.
• An approved RS-232 to RS-485 converter (i.e. CON-768) must be used when a PC
with ORCAview software is used as the Service Tool device. The CON-768BT is a
newer, wireless, Bluetooth to RS-485 converter, manufactured by Delta Controls.
• At least V3.22 firmware and software (ORCAview 3.22 Build 556 or higher) must
be installed on-site.
• An available MAC address on the MS/TP network segment being connected to.
Summary of Capabilities
• The Service Tool device can plug into the jack of any product located on any
segment of an MS/TP network and provide system-wide user access to the entire
network, including devices located on other network segments.
• The Service Tool device can be hot swapped from the jack on one product to another
seamlessly, whereby all the devices in the network are automatically informed of the
move. (The user should log off and then log on again at the new location.)
• Multiple Service Tool devices can be connected and can communicate
simultaneously on the network – including multiple devices on the same MS/TP
segment.
• Besides MS/TP, a Service Tool device can connect to products located on a LINKnet
network (i.e. BACstats) and gain system-wide user access to the entire network.
• As well as using the Service Port to connect to the network it can be used to flash the
controller firmware. (Requires 3.30 Flash Loader Software.)
Functional Description
When a Service Tool device is connected to a jack, it functions like an independent
BACnet device on the network. The following is a general description of the automated
events that take place when you connect an appropriate device to a Service Port jack.
Software Installation
If you have V3.22 or later firmware and software installed on the site, then no additional
software installation is necessary. The system of controllers and their Service Port jacks
provide system-wide access for user interface devices.
For the CON-768, the PC is connected to the converter via RS-232, and the converter is
connected to the Service Port jack via RS-485. For the CON-768BT, an external
Bluetooth USB dongle or internal Bluetooth hardware provides a wireless connection via
the CON-768BT adapter. Refer to the CON-768 or CON-768BT Installation Guide
documentation for further connection details.
ORCAview Login through Service Port Run ORCAview and enter your
Username and Password when the login dialog is displayed on the screen. Then, click on
the Advanced tab. Ensure that the connection method is properly configured by verifying
these settings:
• CON-768 CONNECT USING: Serial (BACnet MS/TP) or CON-768BT CONNECT
USING:Bluetooth : BACnet MS/TP.
• COM PORT: COM1 (or whichever port the converter is connected to)
• BAUD RATE: Set the Baud Rate to match the network speed the device with the
Service Port jack is communicating at on its network. LINKnet networks should be
set to 76800 bps, and MS/TP networks default to 76800 bps (but could be set to
something else as required).
• ADDRESS: The address field on the MS/TP login dialog is the MS/TP MAC address
that the CON-768/OWS will use to identify itself on the network. This number
defaults to 127 and typically will not need to be changed.
The address must be a value between 1-127 and unique on the MS/TP network
segment that the converter is connected to. Since Delta typically only uses MAC
address ranges 1-99 for panel addresses using the 100-127 range for the
OWS/converter will help reduce the possibility of creating duplicate network
addresses for a site.
Once the connection settings are verified, click OK to login. The system communicates
using the settings defined in the System User Access (SUA) object. Devices display in
the Navigator network tree and system-wide access to all BACnet devices and their
objects across the network is available, including through the use of graphics.
Earlier Version 3.22 Controllers Some of the earlier version 3.22 controllers may
not accept 127 as a valid MAC address. This is because on earlier versions the valid
MAC address ranges were limited as follows:
• For controllers configured to reside on a MS/TP network segment the valid address
range was set from 1-99.
• For controllers configured to reside on a Linknet network segment the valid address
range was set from 1-13.
Attempting to login to one of these controllers with the address field set to 127 can cause
a login failure. The appropriate address setting to use in this case will vary depending on
whether or not the connection is to a MS/TP or Linknet network segment:
2. Place the controller into loader mode by powering off the controller then turning all
of its address dip switches to the on position and powering it back up.
3. Use a CON-768 and RJ11 cable to connect the PC COM port to the service port on
the controller. (The controller should not be connected to any other controllers over
the NET 1 MS/TP port while being flashed in loader mode.) Or connect the CON-
768BT to the service port on the controller and use Bluetooth to connect to the PC.
2. Click the Program button. (Depending on the version you are upgrading to/from, a
flash lock with sufficient upgrade counts may be required before Flash Loader will
allow you to upgrade the panel.)
3. The Flash Loader transmits the new firmware. The Status and Progress fields
indicate the current upgrade operation. Once the upgrade is complete the Status field
will show Update Complete.
2. Log into the controller, open the Device object and select the Product tab. Verify the
Firmware version and Application SW Version fields match the firmware file that
was downloaded to the controller.
For more detailed information on the Delta Flash Loader refer to the Flash Loader
Users Guide.