EDIT>SEARCH
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)
Copyright © Delta Controls Inc. All rights reserved Document Title: Document Number Current Edition Date of current revision
ORCAview Version 3.40 Technical Reference Manual None – PDF files included on Release CD 1.80 ORCAview 3.40 Release 1 Final December 9, 2011
No part of this manual may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language (natural or computer), in any form or by any means, without the prior written permission of Delta Controls Inc. Limited permission is granted to reproduce documents released in Adobe Portable Document Format (PDF) electronic format in paper format. Documents released in PDF electronic format may be printed by end-users for their own use using a printer such as an inkjet or laser device. Authorized distributors of Delta Controls Inc. products (Delta Partners) may print PDF documents for their own internal use or for use by their customers. Authorized Delta Partners may engage a printing or copying company to produce copies of released PDF documents with the prior written permission of Delta Controls Inc. 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, 2000
Original manual for Version 3.20 ORCAview. Released as PDF files only.
1.01
June 22, 2000
Revised document for release as paper-based manual DOC810-20. Added Data 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, 2001
Revised manual for Version 3.21 ORCAview. Released as PDF files only. Added new 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 28, 2001
Revised manual for Version 3.22 ORCAview. Released as PDF files only. The DAC 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, 2004
Revised manual for ORCAview 330 Release 1. Released as PDF files only.
1.40
April 30, 2005
Revised manual for release with ORCAview 330 Release 2. Includes improved printing of objects and alarms
1.50
September 30, 2005
1.6
May 3, 2006
1.7
November 22, 2009
Supports Vista and Windows 7 plus multi-core processors. Support for DHMI, CON768BT 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 9, 2011
The headings of sections with significant changes have a green highlight. Document new 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
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–1
1–2
Introduction
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
Matching Products for Release The following is a list indicating the matching builds of product for ORCAview V3.40 Build 3073 or later. •
ORCAview OWS (Build 3073)
•
ORCAweb™ (Build 3073)
•
Flash Loader (Build 3073)
•
System Loader (Build 3073)
•
Rainbow Sentinel Drivers (7.5.1 or later)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–2 Total Pages in this Section: 46
System Requirements •
DSC/DAC – BN155693
•
Tetra – EN155693
•
DFM /DRP– FM155693
•
V2 Micro – – RC114575
•
DCU – 340.3073
1–3
System Requirements To run the Delta Controls ORCAview® software, Delta Controls offers the following minimum requirements: Minimum Requirements Operating System
Windows XP 32 Pro; Server 2003/Win2K3; Vista 32/64 (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
Total Pages in this Section: 46
Operating System
Vista 32/64 (Business, and Ultimate); 2008 Server; Windows 7 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
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–3
1–4
Introduction
Hard Disk Drive
10 GB of free space
Video Settings
1280 x 1024 resolution with 32-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
Suite Installer Function This section lists the scenarios that the V3.40 Suite Installer supports and the ones it does not. The aim is to provide information that helps to make the behavior of the installer clearer.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–4 Total Pages in this Section: 46
Suite Installer Function
1–5
Supported Scenarios Case
See
Action
Clean Install
New Installation section on page 1–3
Suite installation with no existing Delta product installed
Suite Build-toBuilt upgrade
Upgrade Installation section on page 1–18
Upgrade ALL installed product from older build to latest build of the current version. 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
Suite Version Upgrade, keep previous OWS
Upgrade Installation section on page 1–18
Upgrade Installation section on page 1–18
Upgrade ALL installed product from older version to current version. All site specific files are upgraded.
E.g. 3.33.1917 suite -> 3.40.3073 suite If Historian is installed, it will not be possible to keep old OWS on upgrade. 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 of OWS only (with 3.40 now includes Coexistence of Loaders)
Coexistance Installation on page 1–23
Install the current version of OWS and Loaders alongside the existing older version suite (excluding Historian). Or, install the current version suite (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
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–5
1–6
Introduction
Supported Scenarios Case
See
Action
suite Complete Removal
Uninstall Software topic in Application Maintenance section on page 1–30
Modify Components, Add or Remove
Add/Remove Software topic in Application Maintenance section on page 1–27
Repair
Repair Software topic in Application Maintenance section on page 1–29
Uninstall ALL installed product of current Version only.
E.g. 3.40.3073 suite -> no product Add and/or Remove individual suite components to current installation of Delta product.
E.g. 3.40.3073 OWS and ORCAweb -> 3.40.3073 OWS and Historian If a malfunction occurs such as power failure and a software application no longer runs, it is possible to repair the installation quickly. The core files are refreshed and it is not necessary to do an uninstall / install of the 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–6 Total Pages in this Section: 46
OWS Default Directories
1–7
OWS Default Directories The Install Path is consistent between Windows XP/Server2003/Vista/7. It depends on processor bit-width. If 32-bit, install directory will be: C:\Program Files\Delta Controls\3.40\ If 64-bit, install directory will be: C:\Program Files (x86)\Delta Controls\3.40\ The users/custom directory is different between Windows XP/Server 2003 and Windows Vista/7, however, it is consistent between processor bit-width. If Windows XP/Server 2003, user directory will be: C:\Documents and Settings\Public\Delta Controls\3.40\ If Windows Vista/7, user directory will be: C:\Users\Public\Delta Controls\3.40\ C:\Users\Public maps to the environment variable %PUBLIC%.
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. The Suite Installer handles multiple applications in one installation process. •
Total Pages in this Section: 46
ORCAview 3.40 (includes Illustrator but needs to be enabled on a hardware key)
•
Delta Historian
•
ORCAweb
•
Delta ODBC Driver
•
Delta Flash Loader
•
Delta System Loader
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–7
1–8
Introduction 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. Devices requiring unique numbers include the following: •
All connected Controllers or Workstations
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–8 Total Pages in this Section: 46
New Installation
1–9
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.
Any V3 DCU that is used as an IP router to local V2 devices (DCU's or Turbos, etc) must be addressed lower than 32767. If the Version 2 protocol is being installed, the workstation number must: •
not be greater than 32766 (If greater than 32766, then a message on the dialog warns that this Workstation Address is invalid with Version 2 networks.)
•
not include any number from 250 to 255,
•
not be 999
If an invalid number is typed in during install, it will be increased to the next valid number or decreased if it cannot go any higher. For example, if you enter 254 for a workstation number for a site that has V2 Hardware, the system changes it to 256.
Concise: Installation Procedure
To install Delta products from the ORCA Suite CD:
•
Insert the CD. If the autorun brings up the interface, select the installer and follow the instructions to complete the installation process
OR: 1.
Total Pages in this Section: 46
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–9
1–10
Introduction 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.
See the detailed Installation Procedure section starting on page 1–11 for more information. To install Delta products from the desktop:
1
Click on the ORCA Suite folder that you downloaded.
2
Use the My Computer icon or the Explorer view to find the ORCA Suite Setup.exe file.
3
Double-click the ORCA Suite Setup.exe file to start the Suite Installer.
4
Follow the instructions from the Welcome screen to complete the installation process.
See the detailed Installation Procedure section following on this page for more information.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–10 Total Pages in this Section: 46
New Installation
1–11
Detailed: Installation Procedure 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. To install ORCAview from the ORCAview CD:
1.
Preliminary Steps
a.
Check that the programs identified on the software key are correct for the site. Use only the specific software key that came with the software for the site.
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.
•
Parallel Port: This software key attaches to a Parallel port. Attach the software key, shown in the following figure, to the computer parallel port at the back of the PC. The thumbscrew heads should point away from the PC. The pins go into the computer parallel port plug.
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.
Note: If a software key is not present at installation or a product is not enabled on the key (indicated by a Red checkbox), you have the option to proceed with the complete installation of the ORCA products or exit. If installation is completed without the software key, the products will not run.
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–11
1–12
Introduction
2.
c.
Exit all other programs.
d.
Insert the CD into the CD-ROM drive.
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.
Welcome screen. a.
At the Welcome screen, click Next.
b.
Check the dialog for a list of installed ORCA Suite software.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–12 Total Pages in this Section: 46
New Installation 2.
Application Maintenance (Check for installed ORCA software).
a. 3.
Click next.
Software License Agreement. a.
Total Pages in this Section: 46
1–13
After reading the agreement, click Yes to accept the terms of the agreement.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–13
1–14
Introduction 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–14 Total Pages in this Section: 46
New Installation 5.
1–15
Chose Destination Folder.
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. b. 6.
Click Next to continue.
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.
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–15
1–16
Introduction
7.
8.
c.
Enter your PC’s Workstation Number on the local network. The workstation number must be unique. See the workstation Number section on page 1–8 for more information.
d.
Click Next to continue.
e.
If any entries are invalid, a warning message appears. The errors must be corrected before you can begin.
Ready to Install
a.
This dialog box shows the software selected for installation
b.
Click < Back if you wish to make any changes or review your decisions.
c.
Click Next to continue.
Copying ORCAview Files. a.
A status bar shows the current status of the procedure. Files are now copied to your PC.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–16 Total Pages in this Section: 46
New Installation
b.
9.
1–17
If any special adapters are needed, or if any conflicts occur during installation, a message displays. Write down any such messages for future reference.
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.
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–17
1–18
Introduction
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.
Windows 95, Microsoft Windows 98, Windows NT and Windows Millennium Edition (ME) are NOT supported. Windows 2003and 2008 Server are supported for installing ORCAweb. 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. Do the Upgrade Procedure that follows on this page. Note: Commander Version 3.10 cannot be directly upgraded to ORCAview Version 3.22, 3.30, 3.33 or 3.40.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–18 Total Pages in this Section: 46
Upgrade Installation
1–19
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.
To upgrade ORCAview 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.
•
If the autorun brings up the interface: Select the installer and follow the instructions to complete the installation process. Go to step 2.
•
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.
•
If you want to do a New Installation, See Step 2 on page 1–12. a.
Total Pages in this Section: 46
The Welcome screen displays and the ORCAview installation starts.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–19
1–20
Introduction 4.
Welcome screen.
a. 5.
At the Welcome screen, click Next.
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– If ORCAview detects a compatible previous installation:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–20 Total Pages in this Section: 46
Upgrade Installation
1–21
In the following figure, 3.33.1917 can be upgraded to 3.40.3073
Total Pages in this Section: 46
6.
The Ready to Upgrade dialog box appears. Click Next to continue the Upgrade procedure.
7.
Copying and Configuring Delta Controls ORCA Suite Files
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–21
1–22
Introduction 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.
c.
All files should be successfully upgraded or converted.
d.
Click OK to continue.
10. Setup Complete
a.
Click Finish to complete Setup.
The Upgrade Procedure is finished. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–22 Total Pages in this Section: 46
Coexistance Installation
1–23
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. Note: ORCAview Version 3.20/3.21/3.22/3.30/3.33 must be installed before ORCAview Version 3.40 can be installed as coexistance.
To coexist ORCAview 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.
•
If the autorun brings up the interface: Select the installer and follow the instructions to complete the installation process. Go to step 4.
•
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. The Welcome screen displays and the ORCAview installation starts.
4.
Welcome.
a.
Total Pages in this Section: 46
At the Welcome screen, click Next.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–23
1–24
Introduction 5.
6.
Application Maintenance: Detected ORCA Suite Software
a.
Select the second option "Install ORCA Suite (3.40.3073) product(s) alongside the existing product(s)".
b.
Click Next.
Select Products
a.
Select the products for installation and uncheck the one that you do not want installed.
b.
Click Next.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–24 Total Pages in this Section: 46
Coexistance Installation 7.
8.
Total Pages in this Section: 46
1–25
Destination Folder
a.
Select the Program and data folders. You can just accept the default paths.
b.
Click Next.
Workstation setup
a.
Enter the workstation settings.
b.
Click Next.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–25
1–26
Introduction 9.
Ready to Install
a.
Click Next to do the actions in the Ready to Install list.
b.
A dialog indicates that Windows is preparing to install the ORCA Suite.
c.
A dialog indicates the progress as Windows configures the ORCA Suite.
10. Setup Complete
a.
Click Finish to complete setup.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–26 Total Pages in this Section: 46
Application Maintenance:
1–27
Application Maintenance: The Suite Installer allows you to change your install by adding, removing, repairing or uninstalling selected software. In some situations, Application Maintenance options would be offered while running the suite. See the tables in the Suite Installer Function section starting on page 1–4 for supported and unsupported install scenarios.
Add/Remove Software
Total Pages in this Section: 46
1.
In the following figure, the Add/remove 3.40 ORCA Suite software option is selected.
2.
Click Next.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–27
1–28
Introduction 3.
Select the Products to install.
a.
To remove an application, uncheck the box so that the checkmark is removed. In this example, the Delta Flash Loader needs to be unchecked.
b.
Press the Next button.
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
a.
Click next to remove the selected products.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–28 Total Pages in this Section: 46
Application Maintenance:
1–29
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.
2.
Application Maintenance
a.
Select the repair option.
b.
Click Next.
c.
The Ready to Repair dialog appears.
Ready to Repair
a.
Total Pages in this Section: 46
Click Nest if you wish to repair the list product(s).
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–29
1–30
Introduction
Uninstall Software Uninstall provides a way to remove selected software. 1.
2.
Application Maintenance
a.
Select the Uninstall option.
b.
Click Next.
c.
The Ready to Uninstall dialog appears.
Ready to Uninstall
a.
Click Next to begin removal of the listed software products.
b.
Wait until the Installer completes uninstalling the software.
c.
A dialog indicates that Windows is preparing to install the ORCA Suite.
d.
A dialog indicates the progress as Windows configures the ORCA Suite.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–30 Total Pages in this Section: 46
Concise Installation of Historian 3.
1–31
Setup Complete
a.
Click Finish.
Concise Installation of Historian 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. 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.
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–31
1–32
Introduction 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.
To install Historian from the ORCA Suite CD:
•
Insert the CD-ROM. If the autorun brings up the interface, select the installer and follow the instructions to complete the installation process
—OR — 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.
To install Historian from the desktop:
1
Click on the ORCA Suite folder that you downloaded.
2
Use the My Computer icon or the Explorer view to find the ORCA Suite Setup.exe file.
3
Double-click the ORCA Suite Setup.exe file to start the Suite Installer.
4
Follow the instructions from the Welcome screen to complete the installation process.
Because Historian requires access to a large database, a Database Management System (DBMS) is included with Historian. The default DBMS included with 3.40 is Microsoft SQL Server 2005 Express which the installer prompts you to let it install automatically. If Microsoft SQL Server 2005 Express or SQL Server is already on the system, you may not need to install a DBMS.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–32 Total Pages in this Section: 46
Concise Installation of Historian
1–33
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.
Historian Install Microsoft SQL Server 2005 Setup 1
Total Pages in this Section: 46
When you first install Historian, you may need to Install a database server. The default is Microsoft SQL Server 2005 Express.
a.
Enter a password.
b.
Click next.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–33
1–34
Introduction 2
3
License Agreement
a.
Click the checkbox to accept the agreement.
b.
Click Next.
Installing Prerequisites
a.
Inspect the list of prerequisite components
b.
Click the Install button to continue.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–34 Total Pages in this Section: 46
Concise Installation of Historian c.
4
Total Pages in this Section: 46
1–35
A dialog shows the progress on installing the prerequisites.
System Configuration Check
a.
Wait while the SQL Server Setup scans your computer.
b.
A dialog shows the progress in installing SQL components.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–35
1–36
Introduction
5
Completing Setup
a.
Inspect the summary logs to see if any failures occurred during setup.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–36 Total Pages in this Section: 46
Concise Installation of Historian 6
7
Total Pages in this Section: 46
1–37
Password
a.
Enter a password for DQL Server Express.
b.
Click the Install SQL Server Express button.
c.
Click Next.
ORCA Suite – Ready to Install
a.
Inspect the install list of ORCA software.
b.
Click Next.
c.
A dialog shows the progress of the install process.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–37
1–38
Introduction 8
ORCA Suite
a.
Click Finish.
b.
Inspect the install list of ORCA software.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–38 Total Pages in this Section: 46
Windows XP / Windows 7 Sentinel Driver Update
1–39
Windows XP / Windows 7 Sentinel Driver Update You may need to manually update the Sentinel Driver System. The installer handles the initial installation of the Sentinel driver but not handle the upgrading of the Sentinel Driver. 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:
Total Pages in this Section: 46
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
•
Click Next to continue.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–39
1–40
Introduction 7
Sentinel System Driver – InstallShield Wizard
•
Click Next to continue.
8
Sentinel System Driver – InstallShield Wizard
In some situations, you may upgrade the Sentinel driver.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–40 Total Pages in this Section: 46
Customizing the Desktop Shortcut for Automatic Login •
Click Install to continue.
9
Sentinel System Driver – InstallShield Wizard
•
Click Finish to complete the installation of the Sentinel Drivers.
1–41
Customizing the Desktop Shortcut for Automatic Login These instructions create a desktop shortcut that allows automatic login to ORCAview. This icon automatically provides the username and password to ORCAview and bypasses the ORCAview security features. 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:
Total Pages in this Section: 46
•
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.)
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–41
1–42
Introduction To create a shortcut for automatic ORCAview login:
1.
Right click the ORCAview shortcut icon and click Properties. An ORCAview.exe Properties dialog will appear. Click on the Shortcut tab as shown.
"C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe" 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. For Windows XP: "C:\Program Files\Delta Controls3.40\System\ORCAview.exe" user=username/password site=sitename.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–42 Total Pages in this Section: 46
System Architecture
1–43
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
Networking Information in Other Chapters See Chapter 9 — Controller Networks of this manual for a treatment of networking concepts and practices. See Appendix C — Derived Network Addressing (DNA) of this manual for a detailed explanation of the DNA addressing scheme included in ORCAview 3.30. Chapter 3 — Navigator provides a basic explanation of DNA. 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.
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–43
1–44
Introduction
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–44 Total Pages in this Section: 46
System Architecture
1–45
SYSTEM Level controllers are used to logically distribute networks into manageable building segments. SYSTEM Level Controllers are I/O controllers for major equipment systems such as AHU’s. SYSTEM Level controllers have Real-Time Clocks, EIA-232 serial ports, and battery backup. This will allow the individual segments to function normally if network cabling is damaged and communications between SYSTEM Level controllers is not possible or interrupted. Only DSC and DSM model controllers can be placed at the SYSTEM Level. Any DSC model can have a subnet of controllers beneath it. DAC model controllers cannot be installed in the SYSTEM Level.
Ethernet – BACnet MS/TP The following architecture illustrates the flexibility of the Delta ORCA Native BACnet control system. Here, two SYSTEM level controllers have the Ethernet option. This allows them to route from Ethernet to BACnet MS/TP at both the SYSTEM Level (NET1 MS/TP port) and the SUBNET Level (NET2 MS/TP port). OWS 3.40 supports the newer enteliBUS™ family of controllers including the enteliTOUCH™ HMI and associated enteliBUS hardware.
Ethernet
DSC
DSC
DSC
Subnet Level
LINKnet Level
DAC DAC LINKnet Newtork communicating @ 76.8 Kbaud
DACs
BACnet MSTP Network
DSC-1616E or DSC-1212E or DSC-1280E or DSC-1616EX
BACnet MSTP Network
System Level
BACnet MSTP Network
BACnet MSTP Network
DNS-24
DFM-202
Total Pages in this Section: 46
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 1–45
1–46
Introduction
Operator Workstation Connections This diagram shows the possible workstation connections. A distinctive connection point is the BACstat Service Port. Using Delta’s 232/485 converter (CON-768) or the newer CON-768BT you can connect any laptop running ORCAview software to the BACstat Service Port and see the entire Delta Controls Network. This simplifies commissioning and troubleshooting, allowing the Engineer to connect a workstation through a BACstat® near the problem area. There are also several standard connection points such as EIA-232 ports using BACnet PTP, directly or through a modem. ORCAview connects directly to the Ethernet network through a Standard Ethernet Network Interface Card connected to the ORCAview PC. It is also possible to use ORCAview to connect to the network across the Internet using BACnet/IP protocols 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. ORCAweb and the newer enteliWEB™ provide additional means to access a network. Ethernet
Modem
DSC-1616E, DSC-1212E, DSC-1280E, DSC-1616EX, DSM RTR
BACnet MSTP connection through the Service Port using Delta's CON-768 (EIA-232 / EIA-485 Converter)
BACnet MSTP Network
INTERNET
Laptop computer Workstation
BACnet MSTP connection through the Service Port using Delta's CON-768 (EIA-232 / EIA-485 Converter)
LINKnet Newtork communicating @ 76.8 Kbaud
Laptop computer
Workstation
IBM Compatible
BACnet MSTP connection through the Service Port using Delta's CON-768 (EIA-232 / EIA-485 Converter)
DNS-24 Object created virtually in Device 101
DFM-202 Object created virtually in Device 101
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 1–46 Total Pages in this Section: 46
Laptop computer
Chapter 2 – GETTING STARTED 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
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 2–1
2–2
Getting Started
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:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–2
Total Pages in this Chapter: 33
Starting ORCAview
2–3
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.
Logon Dialog Box
The Logon dialog contains the following fields: Username Enter a name that corresponds to an SUA object. 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. Connection The network settings include details such as the communications port, the network speed and the type of network connection. The network connection settings are configured during installation and shown at the bottom of the dialog box.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–3
2–4
Getting Started 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.
The following Windows figure shows three main components: •
ORCAview Dashboard
•
Navigator
•
Delta Server Icon
ORCAview Dashboard
Navigator
Delta Server Icon The ORCAview Dashboard In the previous figure, the Dashboard displays the site name which is International Airport. The Dashboard contains a menu bar and toolbars for controlling ORCAview. Navigator Navigator is used to monitor and make adjustments to your control system. Using easily-identified software objects within Navigator, you can do most site functions, including alarming, trending, scheduling, and adjusting setpoints. 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. The page Identifying Main Components of ORCAview section of this chapter starting on page 2–20 contains more details about these components.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–4
Total Pages in this Chapter: 33
Starting ORCAview
2–5
Logon Dialog: Advanced Button Connections Advanced Button The Advanced button on the Logon Dialog allows you to change the type of connection used to log onto your site. The selected connection type is shown at the bottom of the dialog box to the right of the Connection name. The Advanced button is grayed out if Historian or ORCAweb is already running on the PC. Note: Click on the Advanced button to see other communication parameters.
Place the cursor in a field and then press F1 to get help.
In the previous figure, ORCAview uses the Ethernet card(s) already installed through Windows. Connect Using Options The available Connect Using options are: • • • • • •
Total Pages in this Chapter: 33
Ethernet (Can have more than one Ethernet card) on this page Bluetooth: BACnet MS / TP on page 2–6 Serial (BACnet MS/TP) on page 2–7 Serial (BACnet PTP) [Direct, Modem Dial-out, Modem Answer] on page 2–8 Serial (Version 2) on page 2–10 UDP/IP (Local network, Remote network) on page 2–11
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–5
2–6
Getting Started
Connect Using Ethernet Options
This connection uses the Ethernet card(s) that were installed by Windows. With an Ethernet connection, there are no parameters to configure. You do need to ensure that the correct Ethernet card is selected. To reconfigure ORCAview with multiple connections, the network setup must be modified using the BACnet Protocol Settings (BCP) object once you are logged in. See the Multiple Connections section starting on page 2–12.
Bluetooth: BACnet MS / TP
With Bluetooth: BACnet MS/TP selected in the Connect Using dropdown, the following fields display on the dialog. Bluetooth BACnet MS/TP is selected when connecting OWS via wireless Bluetooth CON-768BT.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–6
Total Pages in this Chapter: 33
Starting ORCAview
2–7
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. Address For a Bluetooth: BACnet MS/TP connection, an editable Address box displays to the right of the Speed dropdown. This is the address the OWS will use on the MS/TP network and must be a unique address on the particular MS/TP network that the OWS is connecting to. A value of 0 to 127 can be entered in this field. The default value is 127. You can use any number in this field as long as it is not used by another device on the MS/TP network. It is suggested to use a restricted range of 100 to 127 for this field which will help to ensure that the OWS address does not conflict with any controller communicating on the MS/TP network. This field maps directly to the Address field under the MS/TP Protocol on the Setup tab of the BACnet Protocol Settings (BCP) object in the OWS. Serial 1 (BACnet MS/TP)
Total Pages in this Chapter: 33
With Serial BACnet MS/TP selected in the Connect Using dropdown, the following fields display on the dialog. Serial BACnet MS/TP is selected when connecting OWS via wired CON-768.
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–7
2–8
Getting Started 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. Address For an MS/TP connection, an editable Address box displays to the right of the Speed dropdown. This is the address the OWS will use on the MS/TP network and must be a unique address on the particular MS/TP network that the OWS is connecting to. A value of 0 to 127 can be entered in this field. The default value is 127. You can use any number in this field as long as it is not used by another device on the MS/TP network. It is suggested to use a restricted range of 100 to 127 for this field which will help to ensure that the OWS address does not conflict with any controller communicating on the MS/TP network. This field maps directly to the Address field under the MS/TP Protocol on the Setup tab of the BACnet Protocol Settings (BCP) object in the OWS.
Connect Using Serial: BACnet PTP Options
Following the Login process, the network objects in the OWS are automatically re-configured to reflect the desired BACnet modem connection. The objects affected are the BACnet Protocol Settings (BCP) object, the Version 2 Protocol Settings (V2P) object, the Serial (RS-232) Port Settings 1 (SNS) object, and the Remote Panel Settings (RPS) object. The new settings that will be applied when you log in are shown in the following dialog:
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–8
Total Pages in this Chapter: 33
Starting ORCAview
2–9
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. Chapter 8 – Modems and Printers of the ORCAview Technical Reference manual describes how to use the Advanced Button options of the Logon dialog for a serial modem connection. 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.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–9
2–10
Getting Started 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–10
Total Pages in this Chapter: 33
Starting ORCAview
2–11
Connect Using UDP/IP Option
The following figure shows the Connect Using field with UDP/IP and the Connect To field with Local Network 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.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–11
2–12
Getting Started Select Remote network in the Connect to field and enter a Remote Panel IP Address
Remote Panel IP Address This field becomes available when Remote network is selected in the Connect To field. This is the IP Address of the remote BBMD device.
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.
Note: If ORCAview is configured with multiple connections, clicking the
Advanced button will clear the multiple selections immediately. To reconfigure ORCAview with multiple connections, the network setup must be modified using the BACnet Protocol Settings (BCP) object once you are logged in.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–12
Total Pages in this Chapter: 33
OWS Directory Conventions
2–13
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.
The Advanced button is grayed out if Historian or ORCAweb is already running on the PC.
OWS Directory Conventions The Install Path is consistent between Windows XP/Server2003/Vista/7. It depends on processor bit-width. If 32-bit, install directory will be: C:\Program Files\Delta Controls\3.40\ If 64-bit, install directory will be: C:\Program Files (x86)\Delta Controls\3.40\ The users/custom directory is different between Windows XP/Server 2003 and Windows Vista/7; however, it is consistent between processor bit-width. If Windows XP/Server 2003, user directory will be: C:\Documents and Settings\Public\Delta Controls\3.40\ If Windows Vista/7, user directory will be:
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–13
2–14
Getting Started C:\Users\Public\Delta Controls\3.40\ C:\Users\Public maps to the environment variable %PUBLIC%.
Customizing the Desktop Shortcut for Automatic Login These instructions create a desktop shortcut that allows automatic login to ORCAview. This icon automatically provides the username and password to ORCAview and bypasses the ORCAview security features. 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.)
To create a shortcut for automatic ORCAview login:
1.
Right click the ORCAview shortcut icon and click Properties. An ORCAview.exe Properties dialog will appear. Click on the Shortcut tab as shown.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–14
Total Pages in this Chapter: 33
Customizing the Desktop Shortcut for Automatic Login
2–15
"C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe" 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. For Windows XP: "C:\Program Files\Delta Controls3.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: ! \ / * ? : “ ‘ < > | $ #
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–15
2–16
Getting Started
Start Graphic through a Command Line The command line structure now supports a new graphic launch command. When ORCAview is running, a new graphic can be launched through Run... using the CMD prompt. This new graphic command can also be added to the target field in a desktop shortcut for ORCAview. This new option in the form of: graphic=mystartgraphic.gpc
For example, a valid desktop shortcut might be:
For Windows 7 – 32 bit:
"C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe" graphic=Gauges.gpc
For Windows XP:
"C:\Program Files\Delta Controls\3.40\System\ORCAview.exe" graphic=Gauges.gpc
If no path is provided, the system searches the default locations. Alternatively you can specify a path.
With Windows 7 – 32 bit, the default location might be:
C:\Users\Public\Delta Controls\3.40\Sites\International Airport Terminal 1\Graphics
With XP, the default location might be:
C:\Documents and Settings\Public\Delta Controls\3.40\Sites\International Airport\Graphics
If you use spaces you must use double quotes to enclose the part with spaces. graphic=”my start graphic.gpc” For example, a valid desktop shortcut might be: For Windows 7 – 32 bit: "C:\Program Files (x86)\Delta Controls\3.40\System\ORCAview.exe" graphic="Propane Gas Gauges.gpc" For windows XP: "C:\Program Files\Delta Controls\3.40\System\ORCAview.exe" graphic="Graphic with Basic Shapes.gpc" 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. A graphic can be launched from outside the OWS. For example, from the CMD prompt: Orcaview.exe graphic=mygraphic1.gpc Orcaview.exe graphic=mygraphic2.gpc Orcaview.exe graphic=mygraphic3.gpc
The previous code will launch the OWS if it is not already running and open these three specified graphics. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–16
Total Pages in this Chapter: 33
Solving First Time Logon Problems
2–17
Solving First Time Logon Problems The first time you log in to your network after installing ORCAview, you may be unable to immediately view your network. These are some possible causes: •
Windows XP Firewall Blocks Siserver
•
Power to the controller(s) was turned off at login
•
ORCAview PC is not properly connected to the network or controller(s)
•
For Ethernet, incorrect Ethernet card is selected
•
For a serial connection, Baud Rate or COM Port may be incorrect
•
Delta Version 2 Protocol is not enabled
Windows XP Firewall Blocks Siserver 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.
Controller Turned Off You will be unable to see your network if you only have one controller on your network and the controller is turned off when you try to log in. Turning on the controller after ORCAview has started will not immediately allow you to log into the network. You need to re-initialize the Descriptors to get the controller to appear.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–17
2–18
Getting Started To access your network: 1. Click File on the ORCAview menu bar, and select Logoff. When the message box appears stating that all ORCAview windows will close click Yes. A login
dialog box appears.
2.
Turn on the controller.
3.
Log in to ORCAview using the Logon dialog box.
ORCAview PC is Not Properly Connected to the Controller Chapter 8 Modems and printers provides wiring diagrams to ensure that the controller is wired properly.
Incorrect Ethernet Card Selected Make sure that you have the correct Ethernet card selected. On the Logon dialog, press the Advanced button and select the card in the Connect Using field.
Delta Version 2 Protocol is not Enabled By default, for new installations, ORCAview will assume that the Version 2 protocol is disabled. When you enter the login name and password, ORCAview provides access to ORCAview alone. It will not allow access to any of the Version 2 devices on the network. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–18
Total Pages in this Chapter: 33
Solving First Time Logon Problems
2–19
To manually enable Version 2 Security and designate a Security Panel:
1.
From the ORCAview Dashboard, choose Tools. Select Setup and click on Site. The Site Settings object displays.
2.
Click the Advanced tab and change the Security Panel number to match a panel on your network.
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.
Enter the address of your V2 Security panel here. Enter the address of your BACnet Security panel here.
The following section explains the main components of ORCAview in more detail.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–19
2–20
Getting Started
Identifying Main Components of ORCAview This section introduces the main components of ORCAview. Each component has a specific function for building control. The main components of ORCAview are: •
ORCAview Dashboard on this page
•
Navigator starting on page 2–26
•
Delta Server starting on page 2–26
•
General Control Language Editor starting on page 2–27
•
Illustrator Graphic Program starting on page 2–27
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
Standard Dashboard
Menu Bar
PC / System Time
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–20
Total Pages in this Chapter: 33
Identifying Main Components of ORCAview
2–21
To set the ORCAview Preferences:
1.
From the ORCAview Dashboard, click Tools.
2.
Select Preferences and then click ORCAview. The following dialog box opens. Select your preferences by clicking the checkboxes.
In the previous figure, the Windows 7 Graphic Path is: C:\Users\Public\Delta Controls\3.40\Sites\International Airport Terminal 1\Graphics\
3.
4.
Total Pages in this Chapter: 33
Set the following display preferences at this time: •
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 the top or bottom edge of your screen, it is automatically hidden unless you place your mouse at that edge of the screen.
•
Show Navigator on Startup: The Navigator always open when you start ORCAview.
Click OK to close the ORCAview Settings dialog box and save your settings.
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–21
2–22
Getting Started Dashboard Menus The ORCAview Dashboard has the following main menus: •
File
•
Edit
•
Search
•
View
•
Tools
•
Window
•
Help
The Dashboard File Menu provides the following commands: •
Create New panel object, site graphic, view, report, user, and site.
•
Open object dialog and site graphic.
•
Saving and loading databases, and importing and exporting files.
•
Save as Web Page available in Illustrator mode with a site graphic file open
•
Save as HMI Page available in Illustrator mode with a site graphic file open
•
Print, Print Preview and Print Setup.
•
Recent File List.
•
Logoff and Exit.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–22
Total Pages in this Chapter: 33
Identifying Main Components of ORCAview
2–23
The Dashboard Edit Menu provides the following commands: •
Cut
•
Copy
•
Paste
•
Delete
•
Select All
The Dashboard Search Menu allows you to find text and objects.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–23
2–24
Getting Started The Dashboard View Menu provides the following commands: •
Select which toolbars are visible.
•
Select ORCAview status bar to be visible or invisible.
•
How Navigator organizes Networks.
•
How Navigator displays objects.
•
Filtering.
•
Refresh.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–24
Total Pages in this Chapter: 33
Identifying Main Components of ORCAview
2–25
The Dashboard Tools Menu provides the following commands: •
Set Controller Time
•
Set Password
•
Convert Graphics (Convert V2 Graphics, Convert Graphics to Web pages)
•
Controls system setup
•
Command outputs plus Communication Control… and Reconfigure
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
Menu Change
Navigator
Total Pages in this Chapter: 33
Menu Change
Menu Change
GCL Editor
Illustrator
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–25
2–26
Getting Started Taskbar Icons When ORCAview is operating, icons are placed in the Windows Taskbar to tell you of other components that are running. Taskbar Icon
Meaning Shows that an active alarm is present. Shows that the Delta Server is running.
Navigator Navigator displays system information and provides operator interface to building equipment. Navigator is a component of the ORCAview. See Chapter 3 – Navigator of the ORCAview Technical Reference Manual for details. 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.
Delta Server Icon
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–26
Total Pages in this Chapter: 33
Identifying Main Components of ORCAview
2–27
To see the Delta Server operation:
1.
Right click on the server icon in the taskbar.
2.
Select Server Windows and then click Status.
Other commands available on this right click menu are as follows: •
Descriptors – Displays memory used by the Descriptors and provides option to reinitializes Descriptors.
•
About – Displays version and build numbers.
•
Exit Delta Server.
General Control Language The General Control Language (GCL+) Editor is used for creating, editing and displaying GCL+ programs. The editor displays GCL+ code using colors that depend on the particular GCL+ keywords in each program line. The use of color helps to clarify the structure of the GCL+ programs. The Editor provides line by line checking of syntax. 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.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–27
2–28
Getting Started
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.
Place the cursor in any entry field and press F1
Click the Help button
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–28
Total Pages in this Chapter: 33
Getting Help
2–29
To read or print the help files: 1. Click Help on the ORCAview Dashboard. Choose Help Topics from the
drop-down menu.
2.
Select Contents (or Index). A window opens, and the display shows topics arranged in books by subject. See the following figure.
3.
To read a help file, double click on a book or topic.
4.
To print a help file, right click on any book or topic and click the Print… button.
Book
Topic
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–29
2–30
Getting Started 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.
Set Time and Date in Windows for the PC ORCAview uses the time produced by the PC. The time and date for the PC is set from the Windows® control panel. To set the Windows Date and Time:
1.
From the Windows Start button, choose Settings.
2.
Select Control Panel and double click on Date/Time.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–30
Total Pages in this Chapter: 33
Adjust Time
2–31
You could also display the Date/Time Properties by: •
Double clicking on the time in the task bar.
-OR•
Right clicking on the time in the task bar and selecting Adjust Date/Time.
Check Controller Time You may want to confirm the time on a particular controller. A Schedule that uses the time on a controller may not run at the expected time. Over the course of a year, an offset may have developed between the Controller Time and actual time. You can confirm the controller time by opening the Device (DEV) object for a controller and selecting the Time Info tab.
To check the time on a particular controller:
Total Pages in this Chapter: 33
1.
In Navigator, select a controller in the left pane.
2.
Then open the Device (DEV) object for the controller in the right pane of Navigator.
3.
Click on the Time Info tab.
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–31
2–32
Getting Started 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.
To send the current PC Time to all controllers:
1.
From the Tools menu on the Dashboard, choose Set Controller Time.
2.
Confirm that Date shown is correct. If not, adjust PC Time.
3.
Then click OK to send this information to all the controllers.
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 2–32
Total Pages in this Chapter: 33
Exiting ORCAview
2–33
To Exit, click the X here, -ORSelect File and Exit
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– •
Log on to ORCAview through another network connection.
To Log on ORCAview as another user or through another network connection: 1. From the ORCAview Dashboard, choose File and click Logoff. 2.
When the Logon dialog box appears, enter your Username and Password.
3.
To change network connection, click the Advanced tab. Select the correct network connection information.
4.
Click OK.
The Advanced button is grayed out if Historian or ORCAweb is already running on the PC.
Total Pages in this Chapter: 33
ORCAview Version 3.40 Technical Reference Manual Ed.1.80 Original Page 2–33
Chapter 3 – NAVIGATOR Chapter 3 Contents OVERVIEW .............................................................................................................. 3–4 DESCRIPTION .......................................................................................................... 3–4 NAVIGATOR FUNCTIONS ......................................................................................... 3–6 Viewing your System ................................................................................. 3–6 Monitoring and Control of Equipment ....................................................... 3–6 Responding to Alarms ................................................................................ 3–6 Managing Databases ................................................................................... 3–6 THE NAVIGATOR WINDOW ..................................................................................... 3–7 Left Pane ..................................................................................................... 3–7 Network Object Types ................................................................................ 3–8 Right Pane................................................................................................. 3–10 To adjust the size of the left and right panes: ................................... 3–10 LEFT PANE VIEWS................................................................................................. 3–10 To change left pane views: ............................................................... 3–10 Network .................................................................................................... 3–11 Logical ...................................................................................................... 3–12 Custom ...................................................................................................... 3–12 Options...................................................................................................... 3–13 Network Connection Information: Status Icons........................................ 3–13 Controller Addressing ............................................................................... 3–17 VERSION MISMATCH WARNING FEATURE (REGISTRY ENABLED)......................... 3–17 Enable with Registry Key ......................................................................... 3–18 Version Mismatch Function Explained .................................................... 3–18 Resolving a Mismatched Version Problem............................................... 3–19 Example: Compatible and Mismatched BBMD Controllers..................... 3–20 NAVIGATOR: NEW DESCRIPTION COLUMN FEATURE (REGISTRY ENABLED) ........ 3–23 Enable with Registry Key ......................................................................... 3–23 Initial Setup of Column Display in Navigator .......................................... 3–24 Description Column Function Explained .................................................. 3–24 VIEWING CONTROLLER OBJECTS .......................................................................... 3–25 Using Details View ................................................................................... 3–25 To switch Show Real-Time Data ON or OFF: ................................. 3–25 To change the rate at which data is updated automatically: ............. 3–26 Organizing Details View .......................................................................... 3–27 To sort by column: ........................................................................... 3–28 To resize a column: .......................................................................... 3–28 To move columns: ............................................................................ 3–28 Filtering Basics ......................................................................................... 3–29 Filtering Advanced ................................................................................... 3–30 System Objects ......................................................................................... 3–32 To Hide System Objects:.................................................................. 3–32 Active Alarms Filter ................................................................................. 3–33 WORKING WITH CONTROLLER OBJECTS ............................................................... 3–34 Selecting an Object ................................................................................... 3–34 To Select a Single Object: ................................................................ 3–34 To select a group of adjacent objects: .............................................. 3–34 To select a group of non-adjacent objects: ....................................... 3–34 Opening an Object .................................................................................... 3–34 Object – Right-Click Menu....................................................................... 3–36
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–1
3–2
Navigator
To save a database for a single controller device: ........................... 3–37 Creating New Objects .............................................................................. 3–38 To create a new object using the dialog box: ................................... 3–38 NAVIGATOR (RIGHT PANE) COMMAND >COPY... ................................................. 3–39 Copying Objects Dialog ........................................................................... 3–40 Copy and Paste Single Object .................................................................. 3–41 To create a single new object using copy and paste: ....................... 3–41 Copy and Paste Multiple Objects ............................................................. 3–42 To copy and paste multiple objects: ................................................ 3–42 NETWORK VIEW – RIGHT-CLICK MENU ............................................................... 3–43 Controller Commands .............................................................................. 3–44 Controller Off-Line .................................................................................. 3–44 Controller On-Line (Right-click) ............................................................. 3–45 To remove an unwanted Area Number setting from the network:... 3–47 Object Security (Lock, Unlock and Temporary Login Commands) ........ 3–48 To save a database for a single controller device: ........................... 3–51 Delta Network Commands ....................................................................... 3–52 To use the Load All Descriptors feature: ......................................... 3–52 To connect through ORCAview using a CON-768BT .................... 3–54 To save databases for all network devices ....................................... 3–55 Graphics Folder ........................................................................................ 3–56 To make the Graphics folder appear in the Navigator left pane: ..... 3–56 PRINTING FORMS IN NAVIGATOR ......................................................................... 3–56 To select long or short form: ........................................................... 3–56 Printing Objects........................................................................................ 3–57 To print a single object: ................................................................... 3–58 To print multiple adjacent objects: .................................................. 3–58 To print multiple non-adjacent objects: ........................................... 3–58 Searching .................................................................................................. 3–58 To open the Search dialog box: ....................................................... 3–59 To find objects using the Object Reference: .................................... 3–59 CREATING MULTIPLE SITES ................................................................................. 3–60 Overview .................................................................................................. 3–60 To create a new Site Settings object: ............................................... 3–60 GENERAL.............................................................................................................. 3–61 ADVANCED........................................................................................................... 3–61 V2 Master Panel ....................................................................................... 3–61 V2 Security Panel ..................................................................................... 3–61 BACnet Master Panel ............................................................................... 3–62 BACnet Security Panel ............................................................................ 3–62 User Logging............................................................................................ 3–62 User Log File ........................................................................................... 3–62 APPLICATION PROTOCOL...................................................................................... 3–63 AUTO SITE CREATION .......................................................................................... 3–64 Using Auto Site Creation ................................................................. 3–64 Deleting a Site Settings Object................................................................. 3–64 CUSTOM VIEWS .................................................................................................... 3–65 Sample Custom Views ............................................................................. 3–65 To open the sample custom view:.................................................... 3–65 To create new sub-folders:............................................................... 3–66 Creating New Custom Views ................................................................... 3–67 To create a custom view folder:....................................................... 3–67 To filter objects for custom view folders: ........................................ 3–67 To filter using object references: ..................................................... 3–67 Filter Examples ........................................................................................ 3–68
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–2
Total Pages in this Chapter: 74
Overview
3–3
To filter by descriptor name for all objects containing the letter A: ................................................................................................ 3–68 To filter by descriptor name for objects in controller 100 containing the letter A: ............................................................... 3–68 To filter by descriptor name for all objects starting with an A, B, C: ................................................................................................ 3–69 To filter by object type for all Analog Inputs: .................................. 3–69 To filter by object type for all the Programs and Analog Variables:.................................................................................... 3–70 Export & Import ....................................................................................... 3–71 To Export a Custom View:............................................................... 3–71 To Import a Custom View:............................................................... 3–71
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–3
3–4
Navigator
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.
•
Reconnect Bluetooth Command starting on page 3–52.
•
Optional Version Mismatch Warning starting on page 3–17.
•
Optional Navigator Description Column Feature starting on page 3–23.
•
New in 3.40 – new controller icons starting on page 3–8.
•
New in 3.40 – improved Copy OK to All starting on page 3–39.
•
New in 3.40 – new Lock / Unlock commands for Object Security starting on page 3–48.
•
New 3.40 – Access Folder
•
New in 3.40 – improved Communication Control to All starting on page 3– 46.
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:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–4
Total Pages in this Chapter: 74
Description
3–5
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–5
3–6
Navigator
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.
Viewing your System Navigator provides different methods of viewing your application and the components within it: •
View the system as a network of controllers.
•
View the system as a logical collection of systems.
•
View the system as a collection of customized folders.
•
Navigate among the devices / systems.
Monitoring and Control of Equipment Objects provide monitoring and control of field equipment and the Delta Controls system. Objects allow you to: •
Manage alarms and equipment control.
•
Adjust setpoints.
•
Sort the objects in your system.
•
Create, copy, and edit objects.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–6
Total Pages in this Chapter: 74
The Navigator Window
3–7
The Navigator Window This chapter introduces the Navigator Window and describes the functions available with the window. 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
Splitter Bar
Right Pane
Navigator in Small Icon View
Left Pane The Navigator left pane includes a network tree that shows the connected controllers and ORCAview PCs. Typical network elements include the following:
Total Pages in this Chapter: 74
•
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)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–7
3–8
Navigator
Network Object Types Types of objects visible in the default setting include the following: NAVIGATOR LEFT PANE ICONS Icon 3.40
Icon 3.33R2
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–8
Item
Meaning
Delta Network
The top of a network at the current site.
Protocol
The communications protocol that connects the controllers. Protocol is visible only in network view.
Local ORCAview PC
The local PC with the ORCAview software.
Remote ORCAview PC
A remote PC on the network with the ORCAview software
Gateway
A gateway such as a Modbus application.
Historian
A Historian PC. OWS 3.40 supports multiple Historians on a site.
Controller
A Delta Control Unit, programmable Zone Controller, Plus Panel, Turbo or Mini-Turbo Panel, Micro Panel.
BACnet VAV or VVT Zone Controller
A Version 3 VAV or VVT Room Controller such as a DAC-V304 or DAC-304.
BACstat I
A device that acts as a temperature sensor on MS/TP.
BACstat II
A device that acts as a temperature sensor on MS/TP or LINKnet networks. Also could be a Zone controller.
3rd Party Controller
A BACnet controller supplied by another vendor.
BACnet Room Controller DSC
A Version 3 Room Controller such as a DAC-T305.
HVAC Delta Application Controller (Medium Enclosure, Red PCB)
A medium Universal Controller such as a DAC-606.
HVAC Delta System Controller (Large Enclosure, Red PCB)
A large HVAC DSC controller such as DSC1616/DSC-1212/DSC-1280.
Total Pages in this Chapter: 74
The Navigator Window
3–9
NAVIGATOR LEFT PANE ICONS HVAC Delta System Controller Plus (Large Enclosure, Red PCB)
Indicates an older large image DSC controller.
Lighting Controller (Green PCB)
A Lighting Controller such as DLC-G1212/DLCP1036.
Lighting Controller Plus
An older Lighting Controller such as DLC-G1212.
Access Delta System Controller (Medium Enclosure, Blue PCB)
An Access Controller such as ASM-24X/24EX.
LINKnet Device
A LINKnet device such as a DFM-200 or DFM-400
Fancoil
A Fan Controller such as a DFC-304
enteliTOUCH
A Delta enteliTOUCH device such as the eTCH7ET
enteliBUS Controller
A BACnet Building Controller such as an eBCON which supports I/O modules.
enteliBUS Manager
A device that performs a function similar to an RTR router controller but on an enteliBUS network.
enteliBUS Touch Manager
An enteliBUS manager but with a HMI provided by an enteliTOUCH screen.
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–9
3–10
Navigator
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. To adjust the size of the left and right panes:
You can vary the size of the left and right panes by dragging the splitter bar.
1.
Place the mouse cursor over the splitter bar.
2.
Click the splitter bar and hold down the left mouse key.
3.
Move the mouse cursor left or right and the splitter bar will follow.
Left Pane Views To change the left pane view, right-click on any blank area in the left pane and select a new view from the menu. The following views are available: •
Network — View the system as a network of controllers. This is the default view.
•
Logical — View the system as a collection of physical devices.
•
Custom — Allow views to be created that show the system by mechanical systems, instead of by controller. Custom views are further explained at the end of this section. A sample custom view is provided.
•
Options — View the setup and preference objects as groups of folders.
To change left pane views:
Right-click once on the white area of the left pane. Select the view you wish to use.
–OR–
From the ORCAview Dashboard click on View and select Network, Logical, or Custom view.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–10
Total Pages in this Chapter: 74
Left Pane Views
3–11
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 Network Tree collapsed.
The following figure shows Navigator with the Network Tree expanded.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–11
3–12
Navigator
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–12
Total Pages in this Chapter: 74
Left Pane Views
3–13
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.
Network Connection Information: Status Icons The controller icons shown provide information about the quality of the network connection between controllers and the ORCAview workstation. The following figure
shows the status icons that may appear on a controller icon in the left pane:
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
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–13
3–14
Navigator
Off Line Controller When a controller is not responding, or is responding incorrectly to ORCAview requests, a red X is shown on top of the controller.This may be caused by a broken network connection to the controller, or loss of power to the controller.
16x0 Controller 103 (103) Unable to Connect
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–14
Total Pages in this Chapter: 74
Left Pane Views
3–15
Misconfigured Controller The yellow wrench appears when ORCAview detects a controller with a misconfigured address.
Device 30100 (30100) is Misconfigured.
Note: When a misconfiguration occurs it will normally be accompanied by the display of
an on screen message like the following:
Address misconfigurations are normally handled by right-clicking on the controller in the Navigator left pane and selecting Reconfigure in the Command sub-menu. 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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–15
3–16
Navigator
(103) does not exist
Software Version Mismatch on Controller ORCAview has an optional feature that warns the operator when the ORCAview (or ORCAweb) software version does not match the firmware version (controller operating system) in a controller. In some situations, an operator may have a WAN network with different buildings running different firmware. This feature is enabled using a Windows registry key entry. Refer to the Version Mismatch Warning Feature (Registry Enabled) section starting on page 3–17 for details. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–16
Total Pages in this Chapter: 74
Version Mismatch Warning Feature (Registry Enabled)
3–17
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)
See Appendix C: Derived Network Addressing for detailed information on addressing.
Version Mismatch Warning Feature (Registry Enabled) ORCAview has a feature that warns the operator when the ORCAview (or ORCAweb) software version does not match the firmware version (controller operating system) in a controller. In some situations, an operator may have a WAN network with different buildings running different firmware. The intention is to allow the operator to view most of the data on the network but to avoid database integrity problems that may result when a modified database is saved to a controller using a mismatched software version. If the operator must write data to a controller, a matching version of the software is required. For example, an operator might shut down OWS 3.40 and instead use OWS 3.33R2 to make changes to a controller.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–17
3–18
Navigator
Enable with Registry Key A registry DWORD key (DetectControllerVersion) must be set to 1 for the feature to work. If the registry key is 0 or is not present, warnings do not appear. By default, the version mismatch feature is enabled. You can edit the registry using a utility such as regedit.exe which is included with Microsoft Windows.
The registry key is:
KEY_LOCAL_MACHINE | SOFTWARE | Delta Controls | 3.40 | Commander | DetectControllerVersion
Version Mismatch Function Explained The Version Mismatch feature manifests itself in three specific ways: 1. 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 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–18
Total Pages in this Chapter: 74
Version Mismatch Warning Feature (Registry Enabled)
3–19
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.
Resolving a Mismatched Version Problem With the general knowledge that there is a mismatch between the OWS and the firmware version on a controller, you would need to get specific version information to resolve the problem if you wished to save a database. 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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–19
3–20
Navigator
Example: Compatible and Mismatched BBMD Controllers The following figure shows OWS 12345 with two BBMD’s shown in a partial left pane Navigator tree. BBMD1 is compatible with the OWS 12345 software version. BBMD2 indicates a mistmatch with the OWS version. [3.40 matches OWS 3.40]
[3.33 NOT match OWS 3.40] [3.40 OWS]
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–20
Total Pages in this Chapter: 74
Version Mismatch Warning Feature (Registry Enabled)
3–21
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).
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–21
3–22
Navigator
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–22
Total Pages in this Chapter: 74
Navigator: New Description Column Feature (Registry Enabled)
3–23
Navigator: New Description Column Feature (Registry Enabled) ORCAview has a feature that provides a means to display the contents of the Description tab for an object 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 features 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. 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.
Enable with Registry Key A registry DWORD key (ShowNADescription) must be set to 1 for the feature to work. If the registry key is 0 or not present, the Description field does not appear. By default, the Description column is not enabled and the property is not included in the registry. You can use a utility such as the standard MS Windows regedit.exe to add the required entry to the appropriate place in the registry.
The registry key is:
KEY_LOCAL_MACHINE | SOFTWARE | Delta Controls | 3.40 | Commander | ShowNADescription
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–23
3–24
Navigator
Initial Setup of Column Display in Navigator Depending on the status of the ShowNADescription registry property, a new Description column will appear as the last column in the upper right of the Navigator window.
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.
Description Column Function Explained This feature provides means to view enlarged amounts of text that is saved in the Description tab of an object. To view the complete text for an object, first open the particular object and then read the entire text included on the Description tab. It is possible to adjust the width of the Description column so that more text is visible in Navigator.
The following figure shows the column headings of Navigator arranged to allow a very wide Description column.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–24
Total Pages in this Chapter: 74
Viewing Controller Objects
3–25
Viewing Controller Objects When a controller is selected in the Navigator left pane, the right pane displays the objects contained within the controller. These objects include alarms, inputs, outputs, trend logs, and schedules. 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.
Viewing Controller Objects Icon
Item
Meaning
Large Icon
Displays objects as large icons. The icon shows object type.
Small Icon
Displays objects as small icons. The icon shows object type.
List
Displays objects in a list form with their small icons.
Details
Displays objects in columns with their icons and information received from the controller. The objects can be sorted by column. The operator can vary the refresh rate for the data in Details view. Information updating can also be turned off.
Using Details View Details View presents the most information about your site. Details View shows live dynamic data with sort, find, and filter tools. In Details View, the Navigator display varies depending on whether the data is being updated. The Show Real-time Data command on the right mouse menu toggles the display of dynamic data ON or OFF. 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. To switch Show Real-Time Data ON or OFF:
1.
Total Pages in this Chapter: 74
Right-click on a blank area of the Navigator right hand pane.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–25
3–26
Navigator
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
Refresh Bar
Auto Refresh Rate
To change the rate at which data is updated automatically: Updates increase network traffic. Depending on the demands on your system, you may wish to slow down the rate of data updates. The choices for Auto Refresh are 5, 10, 30, or 60 seconds.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–26
Total Pages in this Chapter: 74
Viewing Controller Objects
3–27
Organizing Details View The following figure shows the information in the Details View columns. Alarm State Value Name
Object Reference
Units
Manual or Automatic Commissioned or not commissioned
Object Status 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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–27
3–28
Navigator
Auto Refresh and Manual Refresh Auto Refresh
The Auto Refresh rate choices are 5, 10, 30, or 60 seconds.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–28
Total Pages in this Chapter: 74
Viewing Controller Objects
3–29
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–29
3–30
Navigator
Type in both objects with a space between them and press ENTER to see more than one type of object.
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. Filter For
Filter Box Entry
Comment
Object Reference
bi
This entry finds all Binary Input objects. BI* would give the same result.
Object Reference Multiple Entries Separated by a Space
bi bo AI AO
This entry finds all Input and Output objects. (Not case sensitive)
Descriptor Name
ahu2
These entries are not case sensitive. AHU2 gives the same result as ahu2
Wildcard
bi*
This entry finds all instances of Binary Input objects.
Descriptor Name with Wildcard
ahu*
This entry finds all names that start with ahu and is not case sensitive.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–30
Total Pages in this Chapter: 74
Viewing Controller Objects
Default to Value Property
av > 70
If a property is not specified, then by default the value property is tested in any operation. The entry av.Value > 70 would give the same result.
Equality Operator
*=Stopped
This entry finds all objects whose value is equal to Stopped.
Inequality Operators
AV90
AV90 with a comma after 10 would give the same result.
Object Property
*.OutofService = 1
This entry finds all objects with a status of Out of Service.
Logical Operator:
AV.(Name = "*A*" and Value > 74)
The "and" "or" operators only apply to Property Conditions.
AV.(Name = "*A*" or Value > 74)
The "and" "or" operators only apply to Property Conditions.
Object Instance
av(1,3,5)
This entry finds all Analog Variable objects with the specified instance numbers.
Object Instance Range
av(1-7)
This entry finds all Analog Variable objects within a range of instance numbers.
Real-time Property Query
ai.Calibration > 0
This entry checks a property condition.
Object Search by Name
Temp > 23
This entry finds the object named Temp that has a value greater than 23.
Array Property, Text Comparison
eva.TransitionText[1] = "*fail*"
This entry checks a text property.
Multiple Object Type with Shared Property
(ai(1-7), av, ao).ManualOverride = TRUE
This entry finds Analog Input objects with instances numbers of 1-7, all Analog Variable objects, and all Analog Output objects that are in a manual Override condition.
Multiple Property Criteria
(ai, ao).(ManualOverride = TRUE and Value > 50)
This entry finds all Analog Input and all Analog Output objects that are in a manual Override condition and have a value greater than 50.
Multiple Query String Separated by a Comma
ai > 6, bv = "Fan On"
This entry finds all Analog Input objects with a value greater than 6 and also any Binary Output objects with a value of Fan ON.
Logical OR Operators with Other Criteria
AV.(Value 74)
This entry finds all Analog Variable objects that have a value that is less than 26 OR greater than 74.
Logical AND Operators with Other Criteria
AV.(Value > 26 and Value < 74)
This entry finds all Analog Variable objects that have a value that is greater than 26 AND less than 74.
AND Logical Operator: OR
Total Pages in this Chapter: 74
3–31
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–31
3–32
Navigator
The "and" "or" only apply to Property Conditions. e.g. AV.(Name = "*A*" or Value > 74) Your filter could be done by •
AV74
•
AV74
•
AV.(Value 74)
In case you need "and", the first 2 option will not work. You will need to type: •
AV.(Value > 26 and Value < 74)
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. The following are examples of System Objects: •
System User Access (SUA)
•
Event Class (EVC)
•
Analog Input Configuration (AIC)
•
Analog Output Configuration (AOC)
•
Binary Device Configuration (BDC)
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 Only System Objects Show All To Hide System Objects:
•
Right-click on the filter icon in the lower right corner of the Navigator window. Click on Hide System Objects.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–32
Total Pages in this Chapter: 74
Viewing Controller Objects
3–33
Active Alarms Filter Navigator can also display the active alarms that are on each individual Controller. This is done by right-clicking on the object filter at the bottom right hand corner of Navigator and selecting Active Alarms.
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–33
3–34
Navigator
Working with Controller Objects When you select a controller in the left hand Navigator pane, the objects within the controller's database are shown on the right hand Navigator pane.
Selected Controller
Controller Objects
Selecting an Object A single click on any object will select the object. Objects may also be selected in groups. To Select a Single Object:
Click once on the object with the left mouse key. To select a group of adjacent objects:
1.
Click the first object in the group.
2.
Press and hold down Shift.
3.
Click the last object of the group.
To select a group of non-adjacent objects:
1.
Press and hold the Ctrl key.
2.
Click on each object once to select it.
Opening an Object All objects can be opened by double-clicking the object, or by choosing open in the rightclick 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–34
Total Pages in this Chapter: 74
Working with Controller Objects
OK button makes the changes you select and closes the dialog
Cancel button discards the changes you made and closes the dialog
Apply button makes the changes you select without closing the dialog box.
3–35
Help [ ? ] button provides information about the object
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–35
3–36
Navigator
Object – Right-Click Menu When an object or a group of objects is selected in the Navigator right pane, the objects can be commanded by clicking once with the right mouse button.
The following commands are available from the right-click menu: Open Opens the selected object(s). 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.
Right-Click Menu Item
Dashboard Button
Function
Auto
Switches the object to Auto Mode.
Manual
Puts and analog object into Manual Mode.
Manual Value
Assigns a value to the selected object.
Manual On
Sets a binary object to manual ON.
Manual Off
Sets a binary object to manual OFF.
Acknowledge
Permits the operator to acknowledge an Alarm. See Chapter 5 on Alarming for further information.
Reset
Clears any historical information stored in an object. Typical object types would be trend log and totalizer. The Reset function varies depending on the particular object.
Add to Historian
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–36
N/A
Instructs Historian to begin archiving the selected Trend Log if there is a Historian device on the network. For more information please read Chapter 6 and 10 (Data Trending and Archiving and Software Objects Reference)
Total Pages in this Chapter: 74
Working with Controller Objects
3–37
Next Object
Skips to the next object from the list in the right hand Navigator pane.
Next Panel
Skips to the next controller (panel) from the list in the left hand Navigator pane.
Previous Object
Skips to the previous object from the list from the right hand Navigator pane.
Previous Panel
Skips to the previous controller (panel) from the list in the left hand Navigator pane.
Find Object Find Object allows you to search for objects throughout your system. Use wildcards for a partial name search. Cut [Cut is not available] Copy Places a copy of the selected object into temporary memory. Paste Places copied object into the selected controller. Delete Erases the selected objects from the controller database. 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, rightclick and select the Load option). To save a database for a single controller device: 1. Select the controller device in the left pane of Navigator.
2.
Right-click and choose Save As from the pop-up menu.
3.
Type in a suitable File name.
4.
Click Save. The file is saved in the Site folder by default.
Print Prints to any Windows printer attached to the PC. See page 3–56 for more information about printing.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–37
3–38
Navigator
Creating New Objects New objects are easily created in Navigator. You can create new objects using a dialog box or you can copy and paste an existing object. 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. To create a new object using the dialog box:
1.
In the left hand Navigator pane, select the controller in which you want to create a new object.
2.
In the right hand Navigator pane, right-click on the empty white space. From the popup menu, select New…. The Create Object dialog box will open.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–38
Total Pages in this Chapter: 74
Navigator (Right Pane) Command >Copy...
3–39
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 Object Type and Number 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.
Navigator (Right Pane) Command >Copy... The Copy command has been improved so that it is easier to copy and paste objects within a controller or to another controller. Typically, you would select and copy multiple objects on one controller and then paste them into another controller. You can use the Shift and Ctrl keys to define blocks that form a collection of objects to copy.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–39
3–40
Navigator
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.
Copying Objects Dialog The Copying Object submenu provide a flexible and efficient copy and paste function. It has following fields and buttons: Object Name
This is the name of the object. For example: AHU1 Supply Air Temperature. Underscores are not needed between words when creating objects in BACnet controllers, but are required in Version 2. Avoid names that contain the special characters: ' " * &. The name is specified when the object is created. Object Number
This is 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. The object number is specified when the object is created. Buttons
The Copying Objects dialog has the following buttons.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–40
Total Pages in this Chapter: 74
Navigator (Right Pane) Command >Copy...
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 All
Pressing this button cancels the creation of any more objects in 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.
3–41
Copy and Paste Single Object A new object can be created using the copy and paste functions of the Navigator right-click menu. To create a single new object using copy and paste: 1. Select an object in the right pane of Navigator.
2.
Right-click and select Copy.
3.
Select the controller where the new object is needed.
4.
In the right pane of Navigator, right-click and select Paste.
5.
ORCAview suggests an object number.
If the object is copied to the same controller, then the object number is the next available number, and ORCAview asks for a new object name.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–41
3–42
Navigator
Copy and Paste Multiple Objects
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.
To copy and paste multiple objects: 1. Select a collection of object in the right pane of Navigator using the Shift and Ctrl keys.
2.
Right-click and select Copy.
3.
Select the controller where the new objects are needed.
4.
In the right pane of Navigator, right-click and select Paste.
5.
For each object, ORCAview suggests an object number.
• •
If the object is copied to the same controller, then the object number is the next available number, and ORCAview asks for a new Object Name. If the object is copied to a different controller, then the object number is the next available number and the same Object name is used.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–42
Total Pages in this Chapter: 74
Network View – Right-Click Menu
6.
3–43
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 7.
and Object Name for the next copied object to paste displays in the dialog. 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.
Network View – Right-Click Menu When, in Network View, the left pane of the Navigator window shows all the connected controllers. Right-clicking on a controller provides the following commands.
Note: All Right-Click Menu options can also be accessed within the Logical view, except for commands directly related to Protocol.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–43
3–44
Navigator
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.
Query Device Tries to reestablish communication with the off-line controller. Command When a controller is offline, the Communication Control…, Remove Area, Reconfigure and Reset commands are available. The commands are explained in the next section titled Controller On-Line (Right-click). Delete Removes this controller from the Navigator left pane network. No further tries to communicate with this controller will be made.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–44
Total Pages in this Chapter: 74
Network View – Right-Click Menu
3–45
Controller On-Line (Right-click) The controller is on-line when it is communicating with ORCAview. Right-click on the controller to access the following commands.
Open Opens the controllers Device (DEV) or CP object. 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. Command This opens a sub-menu. The Command sub-menu follows: 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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–45
3–46
Navigator
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. Communication Control The Communication Control submenu specifies how a device communicates over the network using the Enable, Disable, or Disable Initiation commands and an optional time duration setting. A Password is needed to change the selected option. You need at least Edit permissions to the Device object to modify this password. The Communication Control submenu is used to: •
Stop a device from sending too much traffic down a network for a specified duration.
•
Set a device to only respond to requests and not initiate communication for a specified duration.
•
Locate the device causing problems when troubleshooting a network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–46
Total Pages in this Chapter: 74
Network View – Right-Click Menu
3–47
Three Communication Modes are available: •
Enable allows a device to communicate normally on both its peer and subnet levels. This is the default setting.
•
Disable stops a device from communicating on both its peer and subnet levels. Only Communication Control and Reinitialize Device messages are processed and no messages are initiated.
•
Disable Initiation stops a device from initiating communication. All messages received are processed and responded to as required, but no messages are initiated.
The Disable and Disable Initiation choices can be applied for a fixed duration. When the duration expires, the device reverts back to the Enable mode and full communication resumes. Selecting the Enable Duration checkbox and specifying a Duration causes the Disable option to be applied temporarily. If no duration is applied, then the Disable option applies indefinitely until an Enable command is received or until the disabled device is reset.
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. To remove an unwanted Area Number setting from the network:
1.
Right-click a single controller with the Area setting that you wish to remove.
2.
Select Command and click Remove Area. The unwanted Area Number will be removed from the BACnet address of all the controllers that inherited it.
Reconfigure The Reconfigure command is used to resolve address conflicts when connecting new controllers onto a network. A wrench icon on a controller shows that Reconfigure changes the address of a controller so that it can communicate on the network. See Appendix C: DNA for more information. Reset Performs a reset on the selected controller. This is the end of the Command sub-menu. Find Object Search for an object. Use wildcards for a partial name search. Connect This function is not currently used.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–47
3–48
Navigator
Reload Reload opens a sub-menu that allows descriptors or system objects to be relocated from the selected controller to ORCAview.
The Reload sub-menu follows: Descriptors Reloads descriptors from the selected controller to ORCAview. 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. Reload Replicated Objects Reloads replicated objects to the selected controller. This feature is mainly used for Access Control. This is the end of the Reload sub-menu.
Object Security (Lock, Unlock and Temporary Login Commands) With a controller selected in the left pane of Navigator, right-click to open the command menu. Selecting the Object Security option provides the Unlock, Lock, and Temporary Login command options. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–48
Total Pages in this Chapter: 74
Network View – Right-Click Menu
3–49
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–49
3–50
Navigator
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. New Creates new objects in the controller. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–50
Total Pages in this Chapter: 74
Network View – Right-Click Menu
3–51
Unavailable Objects for Certain DAC, DNT, DLC Access Event Log (AEL)
Elevator Controller (EC)
Access Group (AG)
Event Router (EVR)
Access Keypad (AK)
Gateway (GW)
Access Setup (AS)
Gateway Translation (GWT)
BBMD List (BMD)
Pulse Input (PI)
Card User (CU)
Remote Panel Settings (RPS)
Card Reader (CR)
System User Access (SUA)
Door Controller (DC)
System User Groups (SUG)
Door Group (DG)
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. To save a database for a single controller device: 1. Select the controller device in the left pane of Navigator.
2.
Right-click and choose Save As from the pop-up menu.
3.
Type in a suitable File name.
4.
Click Save. The file is saved in the Site folder by default.
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–51
3–52
Navigator
Delta Network Commands Right-clicking on the Delta Network gives five options: Find New Devices, Find Device, Load All Descriptors, Reconnect Bluetooth, and Save All.
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. To use the Load All Descriptors feature:
1.
Right-click the Delta Network or BACnet Protocol icon at the top of the network tree in the left pane of Navigator
2.
Select Load All Descriptors. The OWS will load descriptors for all Devices that have not had their descriptors loaded.
Navigator: Reconnect Bluetooth ORCAview has a feature within Navigator for reconnecting if the Bluetooth connection is lost. The feature is available when a Bluetooth device is present. The Reconnect Bluetooth command is in the Network context menu and performs the same function as logging out and then logging back into OWS typically using a portable laptop PC.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–52
Total Pages in this Chapter: 74
Network View – Right-Click Menu
3–53
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 CON768BT 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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–53
3–54
Navigator
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. To connect through ORCAview using a CON-768BT Connecting through ORCAview with a CON-768BT follows a similar procedure to the original CON-768.
1.
From Start, click Programs | Delta Controls | ORCAview.
2.
From the Logon dialog, click Advanced.
3.
In the Connect Using drop-down, select Bluetooth: BACnet MS/TP.
4.
Choose the virtual COM port associated with the CON-768BT.
5.
Leave the Speed as default. The CON-768BT automatically determines and connects at the correct baud rate to match the MS/TP network.
6.
If necessary, set the Address. In most cases, the OWS MS/TP Address can be left at the default 127. If another OWS is connected to the same MS/TP segment, their addresses must not conflict. Each address must be unique on the MS/TP network.
7.
Click OK to initiate connection.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–54
Total Pages in this Chapter: 74
Network View – Right-Click Menu
3–55
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. To save databases for all network devices
Total Pages in this Chapter: 74
1.
Select the Delta Network in the left pane of Navigator
2.
Right-click and choose Save All from the pop-up menu.
3.
If necessary, use the Browse button to set the Path where the database will be saved.
4.
Type in a Base Name that serves as the root name for all the different devices on the network in the Save Database dialog box that pops up. A typical Base Name might be Mar_2011 or Mar07_2011. You would type in a new Base name each time that you did a backup of all databases.
5.
Click OK
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–55
3–56
Navigator
Graphics Folder These commands are available when the Graphics Folder is right-clicked in Navigator. If the folder is not visible, do the following: To make the Graphics folder appear in the Navigator left pane:
1.
From the ORCAview Dashboard, select Tools and then Preference. Click Navigator.
2.
Select Show Graphics Folder.
3.
Click OK.
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.
Printing Forms in Navigator This section will teach you how to print objects in long or short form. For information on printing alarms, see the Printing Alarm Notifications section in Chapter 5 – Event Management System. For information on printing the Active Alarms Folder, see the Printing to a Windows Printer section in Chapter 5 – Event Management System. 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. Long form Prints most of the properties of the selected object. Short form Prints a one line summary of the selected object. Short form is the default setting. To select long or short form:
1.
In the ORCAview Dashboard, choose File and then click Print Setup. A Print Options dialog will appear with the following options:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–56
Total Pages in this Chapter: 74
Printing Forms in Navigator
2.
3–57
Choose either Long form or Short form and click OK.
The object printing features are enhanced in ORCAview. Printouts have headers and footers that contain identification information. A solid line separates the header or footer from the body. 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: 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: 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 of The Print preview features is no longer available for objects in ORCAview.
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.
Total Pages in this Chapter: 74
[ Symbol ]
Meaning
!
Alarm
#
Overridden
X
OutOfService
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–57
3–58
Navigator
A
Auto
M
Manual
H
HVAC,
A
Access, or
L
Lighting object
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. To print a single object:
1.
Right-click on the object in the Navigator and select Print from the menu. A Print window will appear.
2.
Click OK to print or Cancel to exit Print. This is also a good time to select the the appropriate windows printer.
To print multiple adjacent objects:
This method prints objects that are listed together in the Navigator window.
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.
To print multiple non-adjacent objects:
This method prints objects that are not adjacent to each other.
1.
Click on the first object to print.
2.
Hold down the Ctrl key and continue to click on the objects to print. Each clicked object will be highlighted.
3.
Right-click on the object in the Navigator and select Print from the menu A Print window will appear. Click OK to print or Cancel to exit Print.
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*
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–58
Total Pages in this Chapter: 74
Printing Forms in Navigator
3–59
To open the Search dialog box:
1.
Select an object in either the left or right hand pane of Navigator. Right-click on the selected object and select Find Object on the menu. The Find Object dialog box opens. (From the ORCAview Dashboard, select Search and click on Find Object.)
2.
Type the name of the object you wish to search for, e.g.: AHU2 Mixed Air Dampers. Use wildcards for a partial name search. Click the Find button. The object name and reference appears in the lower part of the dialog box. When the object is selected, click Open to view the object. Also, double-clicking on the selected object opens it.
Note: Object names are case sensitive.
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.
To find objects using the Object Reference:
It is also possible to search for objects based on their object reference or ID. This is done on the following Object ID tab:
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–59
3–60
Navigator
Creating Multiple Sites 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. To create a new Site Settings object:
1.
Select File/New Site from the ORCAview Dashboard. A new Site Settings (SS) object displays.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–60
Total Pages in this Chapter: 74
General
3–61
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.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–61
3–62
Navigator
BACnet Master Panel The BACnet Master Panel works similarily to the V2 Master Panel. However, this capability is not normally needed in the Version 3 system.
BACnet Security Panel The BACnet Security Panel can be used to verify the username and password typed at the logon screen when the BACnet Security Panel feature is in use. The Security Panel must contain a valid user access object that matches an SUA object in the workstation. See Chapter 7: Security for more information.
User Logging The User Logging is used to record activities from users who are logged into the system.
User Log File The name of the text file that the User Logging uses to write information.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–62
Total Pages in this Chapter: 74
Application Protocol
3–63
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.
Choosing OK will create the new site.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–63
3–64
Navigator
Auto Site Creation Auto Site Creation allows you to copy the site information from one workstation to another workstation without having to manually recreate the site. In order to use the Auto Site Creation feature, the originating workstation and the destination workstation must have the same version and builds of ORCAview. Ensure that the destination workstation does not already have a site with the same site number. If a site already exists on the destination workstations with the specified site number then only one of the sites will be available in ORCAview. Using Auto Site Creation
The site folder is located at C:\Users\Public\Delta Controls\3.40\Sites on Workstation 1.
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.
Deleting a Site Settings Object If, at some point, you want to delete a previously created site, it is possible. However, ORCAview will not allow the original Site Settings object (SS1) to be deleted. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–64
Total Pages in this Chapter: 74
Custom Views
3–65
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. ORCAview automatically saves any custom views that are created.
Sample Custom Views A Sample Custom View is provided with ORCAview to demonstrate some of the possibilities available to a user. To open the sample custom view:
1.
Right-click in a blank area of Navigator’s left pane.
2.
From the pop-up menu select Custom and then click Sample Custom 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:
Total Pages in this Chapter: 74
•
All Inputs
•
All Outputs
•
Program and Variables
•
Schedules
•
Zones and Controllers
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–65
3–66
Navigator
To create new sub-folders:
1.
Right-click on your Sample Custom View folder.
2.
Select New Folder. The Create New SubGroup dialog box appears.
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.
You can add sub-folders to your Custom View at any level.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–66
Total Pages in this Chapter: 74
Custom Views
3–67
Creating New Custom Views Creating a custom view occurs in three steps: •
Create new views
•
Create folders and sub-folders
•
Change the folder properties to filter on certain objects.
To create a custom view folder:
1.
Right-click on a blank area of Navigator’s left pane.
2.
From the pop-up menu, select Custom and click New View.
3.
The New Custom View dialog box appears. Type a name in the Description field for your custom view.
4.
Click OK. Navigator will display the newly created view. The new view automatically contains the special folders Active Alarms and Graphics.
To filter objects for custom view folders:
The contents of the various folders in a custom view is sorted by filters. One or more filters can be used for each folder. The different filtering methods are described: •
Filter by object names. (The filter is case sensitive.)
•
Filter by object types such as inputs, outputs, schedules, programs, or variables.
To filter using object references:
Total Pages in this Chapter: 74
1.
Right-click on any folder in your custom view. Select Properties… The ViewGroup dialog box appears.
2.
Double click in the area immediately below Physical. A check mark will appear. Type the object reference in the Descriptor area. For example, AI* will place all analog inputs for all controllers in the folder.
3.
Click Apply to record your filter. If you wish to close the ViewGroup dialog, click OK. The folder displays objects according to the filter you typed.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–67
3–68
Navigator
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–68
Total Pages in this Chapter: 74
Custom Views
3.
3–69
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.
To filter by descriptor name for all objects starting with an A, B, C:
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 A*
3. 4. 5. 6.
Double-click on the 2nd row under the Descriptor column and type B* Double-click on the 3rd row under the Descriptor column and type C* Click Apply to accept changes and OK to exit. 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.
To filter by object type for all Analog Inputs:
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.
3.
Double-click on the 1st row under the Descriptor column and type *.AI*
4.
Total Pages in this Chapter: 74
Click Apply to accept changes and OK to exit.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–69
3–70
Navigator
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*
4.
Click Apply to accept changes and OK to exit.
5.
In the left Navigator pane click on the folder. As a result all the Program and Analog Variable objects in the system will be listed in the right Navigator pane.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–70
Total Pages in this Chapter: 74
Custom Views
3–71
Export & Import The Export and Import commands on the ORCAview Dashboard allow existing custom Views to be used on other ORCAview stations. 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. To Export a Custom View:
1.
Right-click any custom view folder. Select Export…
2.
Select the drive and directory where you want to save the folder. Type a file name in the File name field. Click Save.
3.
The selected folder and all its sub-folders will be saved to the selected directory.
To Import a Custom View:
1.
Select a folder in a Custom View. Right-click and Select Import
–OR–
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.
Note: Custom Views are saved with a .cvx extension.
Total Pages in this Chapter: 74
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–71
3–72
Navigator
INDEX CHAPTER 3 NAVIGATOR —A —
active alarms filter · 3–33 Apply · 3–34
—B —
Bluetooth configuration · 3–53
—C —
command Lock / Unlock / Temporary Login · 3–48 CON-768BT range · 3–54 controller addressing · 3–17 CON-768BT Bluetooth · 3–53 icons, meaning of · 3–14 misconfigured address · 3–15 network status icons · 3–13 off line · 3–14 off-line · 3–44 on-line · 3–45 red question mark · 3–15 red X · 3–14 remove area · 3–47 software version mismatch · 3–16 yellow question mark · 3–13 yellow wrench · 3–15 cts right mouse menu · 3–36 custom views export and import · 3–71 Custom Views · 3–65
—D —
database Clear Database · 3–46 find object · 3–47 load · 3–50 Load From Flash · 3–45 save all · 3–55 Save To Flash · 3–45 descriptors reload · 3–48 Descriptors case sensitive · 3–59 Load All Descriptors · 3–52 reload · 3–48 Detail View · 3–25 Columns · 3–28
—F —
Filter Icon · 3–32 Filtering · 3–66
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–72
—G —
Graphics folder new folder or site graphic · 3–56 Graphics Folder delete folder · 3–56 delete with Site Settings Object · 3–64 find object · 3–56 make visible · 3–56 properties · 3–56 right click menu · 3–56 with new site · 3–60
—L —
Lock Unlock · 3–48 long form, printing · 3–56
—M —
master · 3–62 master panel function · 3–61 Site Settings Object · 3–61
—N —
Navigator · 3–4 Auto Refresh icon · 3–27 controllers and workstations · 3–44 create new object · 3–38 Description column display · 3–23 Detail View · 3–25 details view · 3–27 filter · 3–29 filter active alarms · 3–33 filtering, advanced · 3–30 Find Device · 3–52 Find New Devices · 3–52 functions · 3–6 graphics folder right click menu · 3–56 icons in left pane · 3–8 left pane objects · 3–8 left pane right click menu · 3–43 left pane views explained · 3–10 Load All Descriptors · 3–52 Lock Unlock · 3–48 Logical view · 3–12 manual Refresh icon · 3–27 Network View · 3–11 Object Security · 3–48 Object Type column · 3–23 ORS Login · 3–49 Refresh Rate Real Time data · 3–26 remove area · 3–47 right click menu · 3–44 right click menu, controllers and workstations · 3–44
Total Pages in this Chapter: 74
Custom Views
right click menu, Graphics Folder · 3–56 right mouse menu · 3–36 right pane · 3–10 search menu · 3–58 Show Real-time Data · 3–25 software version mismatch · 3–17 sort objects · 3–28 sort, Details View · 3–27 temporary login · 3–50 Temporary Login · 3–48 Navigator Window · 3–7 network Bluetooth connection · 3–52 delete controller · 3–44 query device · 3–44 save all databases · 3–55 network connection disconnected or connected · 3–13 network object types · 3–8
—O —
Object Reference · 3–39 Object Restriction Settings (ORS) · 3–48 Object Security · 3–48 Object Type · 3–23 Objects copy and paste · 3–39 copy, Navigator right click menu · 3–37 create new · 3–38 create new, Navigator right click menu · 3–50 cut, Navigator right click menu · 3–37 filtering, advanced · 3–30 filtering, basics · 3–29 find database object · 3–47 find object · 3–59 find, Navigator right click menu · 3–37 help · 3–35 object number · 3–39 Object Security · 3–48 opening · 3–34 paste, Navigator right click menu · 3–37 paste, Navigator right click menu · 3–50 print information, Navigator right click menu · 3–37
print, Navigator right click menu · 3–15 print, Short or Long Form · 3–51 printing · 3–58 refresh indicator · 3–35 rename · 3–37 save as, Navigator right click menu · 3–37 Selecting and organizing in Navigator right pane · 3–34 selecting in Navigator · 3–34 unavailable certain products · 3–50 ORS Login · 3–49
Total Pages in this Chapter: 74
3–73
—P —
Preference menu view · 3–13 Printing Long Form · 3–56 Objects · 3–58 Print Options dialog · 3–56 Short Form · 3–56 symbols, meaning of · 3–57
—R —
red question mark · 3–15 red X · 3–44 refresh indicator, objects · 3–35 reload descriptors · 3–48 replicated objects · 3–48 system objects · 3–48 remove area · 3–47 replicated objects reload · 3–48 Right click graphics folder · 3–56 right hand Navigator pane objects · 3–34
—S —
Search · 3–58 Security Panel as entered in Site Settings Object · 3–61 function · 3–61 Short Form, printing · 3–56 Show Real-time Data · 3–25 site Auto Site Creation · 3–64 Site configuration · 3–61 delete Site Settings Object · 3–64 master panel · 3–61, 3–62 multiple sites · 3–60 protocol · 3–63 security panel · 3–62 Site Settings Object, function · 3–60 Site Settings Objects, multiple · 3–60 Site Settings Object how to configure a new site · 3–61 software version mismatch · 3–17 system object hide or show · 3–32 system objects · 3–32 hide or show · 3–32 reload · 3–48
—T —
Temporary Login · 3–48
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 3–73
3–74
Navigator
—U —
Update Detail View · 3–25
—V —
version mismatch · 3–17
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page: 3–74
—W —
workstation or controller right click menu · 3–44
—Y —
yellow question mark · 3–13 yellow wrench · 3–15
Total Pages in this Chapter: 74
Chapter 5 – EVENT MANAGEMENT SYSTEM 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
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–1
5–2
Event Management System ALARM FILTERING (UPDATED 3.40) ................................................................. 5–67 Name ................................................................................................. 5–67 Send Acknowledgements ............................................................... 5–67 Schedule Reference ........................................................................ 5–67 Classes and/or Events to Route .................................................... 5–68 SETUP ............................................................................................................... 5–70 Destination Type .............................................................................. 5–71 Message Format .............................................................................. 5–72 URL Address (HTTP Destination Type) ....................................... 5–73 End of Job Insert .............................................................................. 5–74 File Name .......................................................................................... 5–74 Printer Name .................................................................................... 5–74 Port Status ........................................................................................ 5–74 Baud Rate ......................................................................................... 5–75 Dial Retries ....................................................................................... 5–75 Init String ........................................................................................... 5–75 Modem Type ..................................................................................... 5–75 Dial Prefix .......................................................................................... 5–75 HVAC, Access, and Lighting Checkboxes ................................... 5–76 DESTINATIONS / ALARM ESCALATION TAB....................................................... 5–76 Current Selection ............................................................................. 5–77 Status................................................................................................. 5–77 First Destination to Try .................................................................... 5–79 Current Destination .......................................................................... 5–79 Auto Escalation ................................................................................ 5–79 Number of Alarm Retries ................................................................ 5–79 Retry Interval .................................................................................... 5–79 Debug Messages ............................................................................. 5–79 DESCRIPTION .................................................................................................... 5–80 EVENT LOG (EVL) ........................................................................................ 5–81 LOG TAB ........................................................................................................... 5–81 Top Dataview: .................................................................................. 5–82 Details on Highlighted Events ........................................................ 5–82 Buffer Ready ..................................................................................... 5–88 SETUP ............................................................................................................... 5–88 Name ................................................................................................. 5–88 Reliability ........................................................................................... 5–89 Maximum Log Entries ..................................................................... 5–89 Archival Buffer Notification Setup: ................................................. 5–89 HVAC, Access, and Lighting Checkboxes ................................... 5–90 ALARM FILTERING (UPDATED 3.40) ................................................................. 5–90 Schedule Reference ........................................................................ 5–91 Classes and/or Events to Log ........................................................ 5–91 DESCRIPTION .................................................................................................... 5–93 EVENT AND ALARM SETTINGS (EVS) ................................................... 5–94 SETUP ............................................................................................................... 5–94 V3 Alarms to Track .......................................................................... 5–95 Auto Load Active Event List(s) ....................................................... 5–95 Max Event Activities in List ............................................................. 5–95 Max Notification Buffer .................................................................... 5–96 Notification Retry Interval ............................................................... 5–96 STATS ............................................................................................................... 5–96 Event Activity Statistics ................................................................... 5–97 Event Class Statistics:..................................................................... 5–98
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–2 Total Pages in this Section: 176
Overview
5–3
Notifications Statistics ...................................................................... 5–98 ACTIVE ALARM LISTS ........................................................................................ 5–99 Active Alarm List Sizing ................................................................... 5–99 Tracked Alarms in the Active Alarm List of a Device .................. 5–99 Auto Loading Active Alarm Lists on Startup ............................... 5–101 VIEWING ACTIVE ALARMS WITH NAVIGATOR.................................. 5–103 ACTIVE ALARMS FOLDER ................................................................................ 5–103 Update Active Alarms .................................................................... 5–104 ACTIVE ALARMS FILTER .................................................................................. 5–104 Update Active Alarm List ............................................................... 5–105 ROUTING NOTIFICATIONS TO PRINTERS, FILES, PAGERS AND EMAILS................................................................................................... 5–106 PRINTING ALARMS........................................................................................... 5–106 PRINTING TO A W INDOWS PRINTER................................................................ 5–107 Printing the Active Alarms Folder ................................................. 5–108 INSTALLING A DOT MATRIX PRINTER DRIVER ................................................ 5–109 PRINTING TO FILE............................................................................................ 5–113 Event Router Object 1 ................................................................... 5–113 ROUTING ALARM NOTIFICATIONS TO AN ALPHANUMERIC PAGER ................. 5–114 Setup for Alphanumeric Paging ................................................... 5–115 ROUTING ALARM NOTIFICATIONS TO A NUMERIC PAGER .............................. 5–118 Setup for Numeric Paging ............................................................. 5–118 ROUTING ALARM NOTIFICATIONS TO EMAIL ................................................... 5–121 Notification Buffers ......................................................................... 5–126 HTTP ALARM NOTIFICATION.................................................................. 5–127 INTRODUCTION ................................................................................................ 5–127 FEATURES ....................................................................................................... 5–127 LIMITATIONS .................................................................................................... 5–127 HTTP POST REQUEST MESSAGE CONTENT ................................................ 5–128 Example: HTTP POST request message ................................... 5–130 CONFIGURING HTTP ALARM NOTIFICATION .................................................. 5–130 Notification Buffers ......................................................................... 5–131 STATUS MESSAGES ........................................................................................ 5–132 W EB SERVER ASP/PHP EXAMPLES.............................................................. 5–132 Microsoft-IIS ASP Example........................................................... 5–133 Apache PHP Example ................................................................... 5–134 Generated Alarm Log .................................................................... 5–134 DSC PRINTING ............................................................................................ 5–135 DSC SERIAL PRINTING ................................................................................... 5–135 Selecting a Serial-to-Parallel Converter for a DSC ................... 5–135 Configure Event Router for Local Printing .................................. 5–136 ALARM NOTIFICATIONS .......................................................................... 5–137 SENDING ALARM NOTIFICATIONS OVER MODEM CONNECTIONS ................... 5–137 Sending Alarm Notifications to ORCAview via Modem ............ 5–137 ORCAVIEW AUTO-ANSWER FOR ALARMS ..................................................... 5–142 ALARM ESCALATION ............................................................................... 5–146 TABLE OF CONTENTS ...................................................................................... 5–146 INTRODUCTION: ALARM ESCALATION ............................................................. 5–147 Definitions ........................................................................................ 5–147
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–3
5–4
Event Management System 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 EXAMPLE 2: IT GROUP ................................................................................... 5–167 Determining the Policy .................................................................. 5–167 Implement the Policy ..................................................................... 5–168 EXAMPLE 3: MANUAL ESCALATION ................................................................ 5–174 IMPLEMENTATION GUIDELINES ....................................................................... 5–175
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–4 Total Pages in this Section: 176
Overview
5–5
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. Event Class objects provide a method of classifying Events as well as the distribution of Event notifications. The Event Class object specifies a list of devices that the event notifications are to be sent to and also determines the Notification Retry intervals. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–5
5–6
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–6 Total Pages in this Section: 176
Overview
5–7
Event Sequence Flow Chart
Sequence for the High Limit Transition of an Event on a DCU 1 Event Transitions to High Limit
2 Event Management System checks the Event Class
3 Alarm Notification is loaded into Alarm Notification buffer
A
4 Alarm Notification is sent to Destination Devices
C
B
5 Remote DCU receives alarm notification
5 Local controller receives alarm notification
6 Event Log (EVL)
Local controller tracks its own active alarms in its Active Alarm List
6 Event Router (EVR)
7 Physical Printer
Total Pages in this Section: 176
5 ORCAview PC receives alarm notification
ORCAview tracks all active alarms in its Active Alarm List
6 Event Router (EVR)
7 Physical Printer
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–7
5–8
Event Management System The following sequence of events is shown in the previous figure: 1
The Event goes through a Normal to High Limit transition. Ex: Room temp goes out of range.
2
The event management system looks to the referenced Event Class and determines which devices are to receive the alarm notification. By default the event management system will broadcast alarm notifications to every device on the network. (Except non-established modem connections)
3
The alarm notification is then loaded into the local device’s alarm notification buffer.
4
The local device then begins sending the notification to the each device listed in the Event Class objects. This part of the process happens in milliseconds unless a modem connection is needed to send the notification, which can take minutes. The local device is the device that contains the alarm.
5
The destination controller and ORCAview handle tracking remote alarms in a slightly different manner. A remote alarm is an alarm that was generated on another device.
6
7
A. The local controller will track its own active alarms in its Active Alarm List. B. A remote controller will not track active alarms from other devices in its Active Alarm List. C. A remote ORCAview workstation will track active alarms if the alarms are broadcast, or if the workstation is listed in the Destination List of the Event Class object. When a device receives a notification, the event management system looks to the Event Router and the Event Log for instructions on how to process it. A device can print and/or log Event notifications from these classes regardless of whether it is tracking remote alarms in its Active Alarm List. The notification is then routed to the destination 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–8 Total Pages in this Section: 176
Event Header
5–9
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. When a temperature or other monitored object is in an alarm condition, the system can delay sending the alarm. The Pending Alarm field displays the specific alarm condition such as High-Alarm. This approach eliminates spurious alarm notifications caused by noise on a monitored value.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–9
5–10
Event Management System 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. Alarm The Monitored value is not as expected for a Change of State or Command Failure. High Alarm The Monitored value is greater than the High Limit for an Out of Range or Floating Limit alarm type.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–10
Total Pages in this Section: 176
General
5–11
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.
Transition count since an operator acknowledged.
Time of last transition.
Total Pages in this Section: 176
Shows that operator acknowledgement is not necessary for the transition.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–11
5–12
Event Management System Note: If a transition does not need an operator acknowledgement the message
“No Acknowledgement Required” is displayed under the Transitions since Ack column.
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. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–12
Total Pages in this Section: 176
Setup
5–13
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. Available alarm types are: •
Out of Range on page 5–24
•
Change of State on page 5–27
•
Floating Limit on page 5–30
•
Command Failure on page 5–33
•
Change of Value on page 5–35
•
Change of Bitstring on page 5–40
See the Alarm Types for Events section starting on page 5–24 for more information. 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
Alarm Lockout (Optional) This setting is optional. It is provided for situations when the Event is to stop transitioning based on the state of a binary object. If the referenced binary object goes to its OFF state the Event will stop transitioning. 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 lockout object.
Setup: Time Delay The amount of time in 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–13
5–14
Event Management System 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: From-State
To-State
Delay Applied
Normal
Alarm
Yes
Alarm
Normal
No
Normal
Fault
Yes
Fault
Normal
No
Alarm
Fault
Yes
Fault
Alarm
Yes
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: From-State
To-State
Delay Applied
Normal
Alarm
Yes
Alarm
Normal
Yes
Normal
Fault
No
Fault
Normal
No
Alarm
Fault
No
Fault
Alarm
No
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–14
Total Pages in this Section: 176
Messages
5–15
When a checkbox is checked, an indicator icon appears at the top of the dialog. The three application areas are:
Application HVAC (Red)
Icon
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 Use Auto Generated Messages checkbox is available on DSC/DAC controllers. Enter a message for the transition here. On a DCU controller, you need to enter messages for the Alarm, Fault, and Return to Normal fields. With a DSC/DAC, you can use the Use Auto Generated Messages feature or enter your own messages.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–15
5–16
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–16
Total Pages in this Section: 176
Messages
5–17
Auto Generated Alarm Messages (DSC/DAC Only) The Use Auto Generated Messages checkbox applies only to DAC and DSC controllers. If the user leaves the corresponding message field for an event blank or the event is intrinsic, then a standard message is generated and no additional message or spaces are appended to the printout or notification.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–17
5–18
Event Management System The following figure shows a high limit alarm message for an Out of Range Alarm Notification.
Auto Generated Alarm Text
Alarm Messages (DSC/DAC Only) Alarm Type
Description
Change of Bitstring
Not Applicable
Change of State
() is in ALARM
Change of Value
Not Applicable
Command Failure
() does not match ()
Example: AHU1 Filter Status (Dirty) is in ALARM
Example: AHU1 Supply Fan Control (Start) does not match AHU1 Supply Fan Status (Stopped) Floating Limit
High-Limit () has exceeded its HIGH LIMIT () Example: AHU1 Supply Air Temperature (32.3) has exceeded its HIGH LIMIT (30.0)
Floating Limit
Low-Limit () has dropped below its LOW LIMIT () Example: AHU1 Supply Air Temperature (11.8) has dropped below its LOW LIMIT (13.0)
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–18
Total Pages in this Section: 176
Messages
5–19
Alarm Messages (DSC/DAC Only) Alarm Type
Description
Out of Range
High-Limit () has exceeded its HIGH LIMIT () Example: AHU1 Mixed Air Temperature (28.9) has exceeded its HIGH LIMIT (26.0)
Out of Range
Low-Limit () has dropped below its LOW LIMIT () Example: AHU1 Mixed Air Temperature (8.0) has dropped below its LOW LIMIT (11.0)
Fault and Acknowledged Messages (DSC/DAC Only) Fault Messages
All fault messages are be in the same format. is in FAULT and needs attention Example: AHU1 Supply Fan Control is in FAULT and needs attention
Acknowledged Messages
All of the Alarms will have the same format for a generated Acknowledgement message. Delta Alarms Alarm Acknowledged by () Example: AHU1 SAT HIGH LIMIT Alarm Acknowledged by Wen (Wen’s PC) rd
3 Party Alarms Alarm Acknowledged by Example: AHU1 SAT LOW LIMIT Alarm Acknowledged by Alerton PC
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–19
5–20
Event Management System
Returned to Normal Messages (DSC/DAC Only) Alarm Type
Description
Change of Bitstring
Not Applicable
Change of State
> () has returned to Normal
Change of Value
Not Applicable
Command Failure
() has returned to Normal ()
Example: AHU1 Filter Status (Clean) has returned to Normal
Example: AHU1 Supply Fan Control (Start) has returned to Normal AHU1 Supply Fan Status (Start) Floating Limit
() has returned to Normal Example: AHU1 Supply Air Temperature (23.4) has returned to Normal
Out of Range
() has returned to Normal Example: AHU1 Mixed Air Temperature (15.9) has returned to Normal
Event Class Tab on Event Object The Event Class tab is where the user selects which Event Class the Event is to be a member of. All Events default to the Notification class. The Event Class is mainly used to specify the devices that the event notifications are to be sent to. By default notifications are broadcast to all devices on the network.
Event Class tab gives details about the selected Event Class.
The Notification Method is defined in the Notification EVC
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–20
Total Pages in this Section: 176
Event Class Tab on Event Object
5–21
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.
Transitions, Send at Priority and Operator Acknowledged The dialog displays the Send at Priority and Operator Acknowledged settings for the Alarm, Fault and Return to Normal Transitions of the assigned Event Class (EVC) object. The data displayed is not editable from within the Event object and must be adjusted through the Event Class object itself. Send at Priority (Defined in EVC)
The Send at Priority setting is necessary 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 lowest priority number (highest priority) to highest priority number (lowest priority). Items are taken off of the queue and are routed to local peripherals and distributed to remote devices. A remote critical notification that is received at the same time as a local maintenance notification will be placed ahead of the maintenance alarm in the queue and will be routed before the maintenance alarm.
Operator Acknowledged (Defined in EVC)
Operator Acknowledged checkboxes determine whether or not an operator must acknowledge that transition. Events will remain in the active alarm list until the transition has returned to normal and has been acknowledged. By default the Alarm and fault transitions require acknowledgement.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–21
5–22
Event Management System
Destination List Dataview The Destination List dataview displays the Device Address, Retry, Confirmed Transmission, and Process ID columns. Device Address (Defined in EVC)
The device address is the address of the 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. For an event to be sent to only a specific remote controller, the corresponding EVC objects in both the OWS and controller where the event originates must be identical. 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 . 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–22
Total Pages in this Section: 176
Event Class Tab on Event Object
5–23
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. The Retry parameter specifies if the device is to retry sending notifications. If disabled notifications are sent only once. If the field is enabled the device will retry sending the notification until successful. Retry column is disabled at default.
Confirmed Transmission
Total Pages in this Section: 176
Confirmed Transmission specifies if the destination device is to send back a confirmation that the notification was received. If the confirmed transmission is not enabled and the Retry column is, then it becomes a matter of whether the notification was sent or not. This could be a problem in cases where a PTP line has to be brought before that notification can be sent. Version 3 of ORCAview does not provide any indication if the alarm notification was confirmed.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–23
5–24
Event Management System
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.
Alarm Types for Event The Event provides different alarm types. This allows for a variety of monitoring capabilities. The alarm types are: •
Out of Range on page 5–24
•
Change of State on page 5–27
•
Floating Limit on page 5–30
•
Command Failure on page 5–33
•
Change of Value on page 5–35
•
Change of Bitstring on page 5–40
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–24
Total Pages in this Section: 176
Alarm Types for Event
5–25
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.
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.
The Event generates a High Limit alarm when: • Alarm Input value > High Limit Setting
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–25
5–26
Event Management System High Limit alarm returns to normal when: • Alarm Input value < (High Limit Setting – Deadband Setting) The Event generates a Low Limit alarm when: • Alarm Input value < Low Limit Setting Low Limit alarm returns to normal when: • Alarm Input > (Low Limit + Deadband) To configure an Out of Range Event:
1. In Navigator, right click on the device where you wish to create a new alarm and select New. 2.
In the Create Object dialog, enter the name of the new alarm.
3.
Select the Event (EV) type.
4.
Press Enter or click OK and the Event (EV) object displays.
5.
On the Setup tab, select the Out of Range Alarm Type.
6.
Enter the Alarm Input using either its name or Object Reference.
7.
Enter the Alarm Lockout using either its name or the object number. (This entry is optional)
8.
Adjust the Time Delay.
9.
Adjust the Low Limit setting.
10. Adjust the High Limit setting. 11. Adjust the Deadband setting. 12. Click the Apply or OK button.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–26
Total Pages in this Section: 176
Alarm Types for Event
5–27
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. If a new alarm condition occurs while object is already in an alarm condition, another transition will NOT be generated.
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:
1.
Total Pages in this Section: 176
Consider monitoring a binary flow sensor that is normally “On”. The programmer needs to provide an alarm if there is no flow in the duct. Since the alarm is to be in alarm state when the flow sensor is inactive, the alarming value would be “Off”.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–27
5–28
Event Management System 2.
Consider monitoring a freeze status indicator which is in an air handler unit. The programmer needs to provide an alarm for when the freeze status sensor is “On”. For this case the alarming value will be “On”. This means that when the sensor is ON, the alarm generates an Alarm transition.
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.
If the value of AHU1 Freeze Status changes to freeze, an alarm transition is generated.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–28
Total Pages in this Section: 176
Alarm Types for Event
5–29
To configure a Change of State Event: The following example shows how to configure an Event to alarm when an AHU filter is dirty. 1.
In Navigator, right click on the device that you wish to create a new alarm on and select New.
1.
In the Create Object dialog, enter the name of the new alarm.
2.
Select the Event (EV) object type.
3.
Press Enter or click OK and the Event (EV) object displays.
4.
On the Setup tab, select the Change of State Alarm Type.
5.
Enter the Alarm Input object using its name or object reference.
6.
Adjust the Time Delay.
7.
Double click in the first blank row of the Alarming Values dataview and select the state that the alarm is to transition to an alarm state.
8.
Click the Apply or OK button
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–29
5–30
Event Management System
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–30
Total Pages in this Section: 176
Alarm Types for Event
5–31
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. The Event generates a High Limit alarm when: • Alarm Input value > (Setpoint value + High Differential Limit setting)
High Limit alarm returns to normal when: • Alarm Input < ((Setpoint value + High Differential Limit setting) – deadband setting) The Event generates a Low Limit alarm when: • Alarm Input value < (Setpoint value - Low Differential Limit Setting) Low Limit alarm returns to normal when: • Alarm Input value > ((Setpoint value - Low Differential Limit setting) + deadband setting) To configure a Floating Limit Event:
The following example shows how to configure an alarm that makes a transition if the temperature in a room is 3 degrees above or below the adjustable setpoint for the room. 1.
In Navigator, right click on the device that you wish to create a new alarm on and select New.
2.
On the Create Object dialog, enter the name of the new alarm.
3.
Select the Event (EV) object type.
4.
Press Enter or click OK and the Event (EV) object displays.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–31
5–32
Event Management System
5.
On the Setup tab, select the Floating Limit alarm type.
6.
Enter the Alarm Input object using its name or object reference.
7.
Enter the Setpoint Object Reference) using its name or Object Reference.
8.
Adjust the Time Delay.
9.
Adjust the Low Differential Limit setting.
10. Adjust the High Differential Limit setting. 11. Adjust the Deadband setting. 12. Click the Apply or OK button.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–32
Total Pages in this Section: 176
Alarm Types for Event
5–33
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:
The Event generates an alarm when: • Alarm Input value ≠ feedback value The alarm returns to normal when: • Alarm Input value = feedback value
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–33
5–34
Event Management System To configure a Command Failure Event: Follow the instructions below to configure a Command Failure alarm. This example outlines an alarm that generates a notification if the lights in a room do not come on when the Schedule (SCH) comes on. 1.
In Navigator, right click on the device that you wish to create a new alarm on and select New.
2.
On the Create Object dialog, enter the name of the new alarm.
3.
Select the Event (EV) object type
4.
Press Enter or click OK and the Event (EV) object displays.
5.
On the Setup tab, select the Command Failure Alarm Type.
6.
Enter the Alarm Input object using either its name or the Object Reference.
7.
Enter the Feedback (Object Reference) using either its name or the Object Reference.
8.
Adjust the Time Delay.
9.
Click the Apply or OK button.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–34
Total Pages in this Section: 176
Alarm Types for Event
5–35
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.
Increment The increment parameter is used to specify the minimum increment
that warrants a notification. The algorithm that this alarm type uses is shown below: The Event generates a Normal alarm when: • | New alarm input property value - Old alarm input value | > Increment setting
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–35
5–36
Event Management System An alarm occurs when the absolute value of the difference between the new and old alarm input values is greater than the Increment setting. To configure a Change of Value (Incremental) Event:
This Change of Value alarm example generates a Return to Normal notification when the analog setpoint increments by more than 3°C. 1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
2.
In the Create Object dialog, enter the name of the new alarm.
3.
Select the Event (EV) type.
4.
Press Enter or click OK and the Event (EV) object displays.
5.
Select the Change of Value alarm type.
6.
Enter the Alarm Input object using its name or Object Reference.
7.
Enter the incremental value that needs a notification.
8.
Click the Apply or OK button.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–36
Total Pages in this Section: 176
Alarm Types for Event
5–37
Value Type: Bitstring This type of change of value Event is used when a notification must be generated if certain bits in bitstring change states.
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:
a) First enter a valid alarm input and bitstring property and then click Apply. Then, double click in the “Bitmask” dataview so the Edit Bitlist dialog will appear.
b) Select the bits that are to be monitored by enabling the checkbox.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–37
5–38
Event Management System
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. The Event generates an alarm when: • The bits set in the “bitmask” setting change
To configure a Change of Value (Bitstring) Event:
This Change of Value example generates a notification any time the Overridden or Out of Service bits for an input have changed. 1. In Navigator, right click on the device that you wish to create a new alarm on and select New.
2.
In the Create Object dialog, enter the name of the new alarm.
3.
Select the Event (EV) object type.
4.
Press Enter or click OK and the Event (EV) object displays.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–38
Total Pages in this Section: 176
Alarm Types for Event
5.
Select the Change of Value alarm type.
6.
Enter the Alarm Input object using its name or Object Reference.
5–39
Note: When monitoring a bitstring data type the property must be named. For this example the “Flags” property is named after the object reference. The reference is 2.BI1.Flags or 2.BI1.statusFlags. 7.
Select the Bitstring Value Type.
8.
Double click in the Bitmask field.
Double clicking on the BitMask field will produce the Edit Bitlist dialog.
9.
Enable the “Overridden” and “Out of Service” bits by clicking on their checkboxes.
10. Click the Apply button.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–39
5–40
Event Management System
The bits selected in the “Edit Bitlist” dialog will appear in the “BitMask” field.
11. Click the Apply or OK button.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–40
Total Pages in this Section: 176
Alarm Types for Event
5–41
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.
For example, to monitor if the: •
status flag of a binary input on device #2 (enter: 2.BI1.Flags) changes
When the Alarm Input field is changed, you need to press apply immediately for the Bitstring Alarm Type. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–41
5–42
Event Management System 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.
This example shows how more than one combination of bits can generate an alarm notification. If either one of the bit combinations defined in the Alarm Bitstring Values dataview occur an Alarm Notification will be generated.
The Event generates an alarm when: • Alarm input property AND Bitmask = value in list of Alarm Bitstring Values The Alarm returns to normal when: • Alarm input property AND Bitmask ≠ value in list of Alarm Bitstring Values
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–42
Total Pages in this Section: 176
Alarm Types for Event
5–43
To configure a Change of Bitstring Event:
This Change of Bitstring example generates a notification any time the Overridden and Out of Service bits for a BI are set. 1.
In Navigator, right click on the device that you wish to create a new alarm on and select New.
2.
In the Create Object dialog, enter the name of the new alarm.
3.
Select the Event (EV) object type.
4.
Press Enter or click OK and the Event (EV) object displays.
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. 5.
Select the Change of Bitstring alarm type.
6.
Enter the Alarm Input object using its name or Object Reference. Click Apply.
Note: When monitoring a bitstring data type the property must be named. For this example the “Flags” property is named after the object reference. The reference is 2.BI1.Flags or 2.BI1.statusFlags. 7.
Double click in the “Bitmask” field. Double clicking on the Bitmask field will produce the Edit Bitlist dialog.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–43
5–44
Event Management System
8.
Enable the Overridden and Out of Service bits by clicking on their checkboxes.
Since none of the other bits are selected, the alarm is only concerned with the Overridden and Out of Service bits. 9.
Click OK.
10. Now double click in the first row of the Alarm Bitstring Values dataview in the Event.
11. Enable the Overridden and Out of Service bits by clicking on their checkboxes. This shows that the alarm is to transition when both the Overridden and Out of Service bits are set. If the situation required that the alarm transition when the Overridden bit is not set, then just uncheck the Overridden checkbox. 12. Click the Apply button.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–44
Total Pages in this Section: 176
Alarm Types for Event
5–45
Next the Event will appear as follows:
The Bitmask and Alarm Bitstring Values fields will now reflect the settings that have been made.
13. Click the OK button.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–45
5–46
Event Management System
EVENT CLASS (EVC) 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.
Event transitions
Event checks the referenced event class object for devices which are to receive a notification.
Event management system sends the notification to the destination devices specified in the event class object.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–46
Total Pages in this Section: 176
Default Database Event Classes
5–47
Default Database Event Classes This section describes the Events Classes defined in the default database. •
Maintenance on page 5–47
•
Network on page 5–49
•
Security on page 5–52
•
Critical on page 5–53
•
Notification on page 5–54
•
Fire on page 5–55
•
Access Control Event on page 5–55
•
Access Control Alarm on page 5–55
•
Archival Event on page 5–55
•
Diagnostic on page 5–55
Maintenance Class A maintenance alarm alerts personnel when a piece of mechanical equipment needs service or periodic maintenance. For example, a Change of State Event monitors the status of an air filter in an air handler unit. The Change of State maintenance Event monitors the filter switch that alerts maintenance to replace the dirty filters. The alarm indicates when the filter is dirty. The following figure shows the Event Class tab of the AHU1 Filter Event.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–47
5–48
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–48
Total Pages in this Section: 176
Default Database Event Classes
5–49
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.
Network Class A Network Alarm monitors the activity on a BACnet network and notifies the operator of problems. For example, an Event could detect if a device stops communicating. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–49
5–50
Event Management System One Change of Bitstring Event will be needed to monitor communications between the Zone Device 2 and the System Device 1. There must be a Data Exchange Remote Object (DER) in the System Device 1 that is referencing the Zone Device 2. The System Device 1 will automatically create a DER referencing the Zone Device 2 when it requests information from the Zone Device 2. If the DER is not present, then a GCL+ program must be created that requests information from the Zone Device 2. The following is a GCL+ program that serves no other function than to get the System Device 1 to create a DER that references the Zone Device 2. DOEVERY 1M IF 80102.AI1 THEN ENDIF ENDDO The following figure is the DER referencing the Zone Device 2 Analog Input 1.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–50
Total Pages in this Section: 176
Default Database Event Classes
5–51
A Change of Bitstring Event monitors the Exchangeflags of the DER referencing the Zone Device 2. The Bitmask and the Alarm Bitstring Values are set to the “Network Fault” bit. The following figure shows the Setup Tab of the Zone Device 2 Communication Event.
If communication fails between the System Device 1 and the Zone Device 2, an alarm transition will occur.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–51
5–52
Event Management System Security Class A Security Alarm notifies the operator of security problems. For example, a change of state security alarm can monitor a set of contacts on a closed door or window. Also a change of state security alarm can monitor a motion detector input. The following figure shows the Event Class Tab of a Change of State Event that is monitoring a motion detector.
An alarm transition will occur if the motion dector is triggered.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–52
Total Pages in this Section: 176
Default Database Event Classes
5–53
Critical Class A Critical alarm shows a situation that needs immediate attention from the operator. For example, if the supply fan motor fails, an Air Handling Unit will not function properly. 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 alarm transition will occur if the Return Air Fan fails.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–53
5–54
Event Management System Notification Class A Notification Alarm shows non-critical Events and provides alarm information. For example, a Notification alarm might be for the Supply Air Temperature that may tend to go outside the set range often. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–54
Total Pages in this Section: 176
Default Database Event Classes
5–55
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–55
5–56
Event Management 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. 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.
Tabs on Event Class Object The Event Class has three separate tabs. They are the Setup, Destination List and Description tabs.
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.
Notification Method Notifications can be specified as Alarms or Events. 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. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–56
Total Pages in this Section: 176
Tabs on Event Class Object
5–57
A remote critical notification that is received at the same time as a local maintenance notification will be placed ahead of the maintenance alarm in the queue and will be routed before the maintenance alarm. This is because the Send at Priority of a critical alarm is set by default at a higher level than that of a maintenance alarm. Operator Acknowledged Operator Acknowledged checkboxes determine
whether or not an operator must acknowledge that transition. Events will remain in the active alarm list until the Event object has returned to normal and all transitions that require acknowledgments have been acknowledged. By default the alarm and fault transitions require acknowledgement.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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 areas are:
Application HVAC (Red)
Icon
Access (Blue) Lighting (Green)
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–57
5–58
Event Management System
Destination List Tab The Destination List tab displays the list of destinations for the notifications. The class of alarm notifications can be “BROADCAST” to all devices. The class of alarm notifications can be sent to a specific network number. The class of alarm notifications can be sent to a single device.
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.
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 . or object name of an object (e.g., 1.DEV3).
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–58
Total Pages in this Section: 176
Tabs on Event Class Object
5–59
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 (0F). •
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) 4 hexadecimal digits, representing the port, followed by a colon (:) followed by 4 decimal values in the range 0-255 separated by periods (.) (e.g., NET50,BAC3:128.67.255.0); (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.
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. The Retry parameter specifies if the device is to retry sending notifications. If disabled, notifications are sent only once. If the field is enabled the device will retry sending the notification until successful.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–59
5–60
Event Management System Notification Buffer Overflows Due to Retries 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 Notification Buffer range 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. Note: Event Acknowledgements are also Notifications; if many events are
acknowledged quickly, then the Notification Buffer could overflow.
Confirmed Transmissions Confirmed Transmission specifies whether or not the destination device is to send back a confirmation that the notification was received. If confirmed transmission is not enabled and the Retry column is enabled, then it becomes a matter of whether the notification was sent or not. 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 uses 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 BACnet vendor's devices. For example a vendor may have process ID #1 as a printer and process ID #2 as a file. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–60
Total Pages in this Section: 176
Tabs on Event Class Object
5–61
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.
Choose Valid Days by enabling the checkboxes
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–61
5–62
Event Management System
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–62
Total Pages in this Section: 176
Main
5–63
EVENT FILTER (EVF) 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–63
5–64
Event Management System
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. Valid entries are: 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.
.*
All Events and Event Classes from a particular controller are filtered. e.g. 400.*
.EVC*
All Event Classes notifications from a particular controller are filtered.
.EV*
All Event notifications from a particular controller are filtered.
.EVC2
All Event Class 2 notifications from a particular controller are filtered.
.EV1
All Event 1 notifications from a particular controller are filtered.
*.*
All Event and event Classes notifications from all controllers are filtered.
Unacknowledgeable Alarms Events or Event notifications from these classes
are not acknowledgeable or removable by the user. This means that the user cannot acknowledge or delete active alarms, but they may view them in Navigator. A local or remote controller address can also be entered. The field accepts * which is the wildcards character. Valid entries are:
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–64
Total Pages in this Section: 176
Main
5–65
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.
.*
All Events and Event Classes from a particular controller are filtered. e.g. 400.*
.EVC*
All Event Classes notifications from a particular controller are filtered.
.EV*
All Event notifications from a particular controller are filtered.
.EVC2
All Event Class 2 notifications from a particular controller are filtered.
.EV1
All Event 1 notifications from a particular controller are filtered.
*.*
All Event and event Classes notifications from all controllers are filtered.
Reference an EVF in an SUA
System User Access
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.
Specify the Filter to apply here.
When the Event Filter has been selected, click the Apply button for the filter to take effect.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–65
5–66
Event Management System
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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 areas are:
Application HVAC (Red)
Icon
Access (Blue) Lighting (Green)
EVENT ROUTER (EVR) The Event Router provides a method of routing an Event notification to a printer, file, pager, web server, Short Messaging Service (SMS) device, or email. It can only route to one destination type. However, multiple event routers can be created, each routing to different destinations or destination types. The Event Router can: •
Send acknowledgements
•
Reference a schedule by which the Event Router is enabled and disabled
•
Specify a list of Events and/or Event Classes that are to be routed
The Event Router only needs to be created in an alarm-distributing controller. An alarm-distributing controller directs notifications to various destinations for logging purposes or for notifying users. If the Event Router receives alarm notifications that occur on remote BACnet devices, it forwards them to their destinations as long as the notifications match an Event Class and / or Event that needs to be routed.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–66
Total Pages in this Section: 176
Alarm Filtering (Updated 3.40)
5–67
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.
Alarm Filtering (Updated 3.40) The Alarm Filtering tab in the Event Router specifies which Event notifications are to be routed. These notifications are specified by entering the names of the events or the event classes.
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
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–67
5–68
Event Management System 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.
Classes and/or Events to Route The Alarm Filtering tab of the Event Router object works in conjunction with the EVC and EV objects in the system. Classes and/or Events to Route 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.
The Class / Event column accepts entries in the following forms: •
EVC1 – All alarms of Event Class #1 on the current controller
•
*.EVC1 – All alarms of Event Class #1 from all controllers
•
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
•
100.EV1 – Alarm 1 on device 100
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–68
Total Pages in this Section: 176
Alarm Filtering (Updated 3.40) •
100.EV* – Any alarm from device 100
•
CEL1 - All events from Access Control Event Log 1
5–69
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–69
5–70
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–70
Total Pages in this Section: 176
Setup
5–71
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: Device OWS
Destination Types File
Windows Printer
DSC
Email
HTTP Local Printer Pager/SMS
Total Pages in this Section: 176
Use Logs notifications to a text file on the computer. This requires that the OWS is running on the computer in order for it to receive and log the notifications to file. Logs notifications to a printer that is connected to the computer (either directly or over a network). This requires that the OWS is running on the computer in order for it to receive and print the notifications. Sends notifications to an email address in order to notify a user. Fields on the Setup tab mirror the fields on the Internet tab of the Device object. Sends notifications to a web server using HTTP for logging purposes. Logs notifications using a printer that is directly connected to the DSC controller. Sends notifications to a pager or an SMS capable
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–71
5–72
Event Management System
Device
Destination Types
DCU
Local Printer
Use device such as a cellular phone in order to notify a user. Logs notifications using a printer that is directly connected to the DCU controller.
Destinations / Alarm Escalation Tab Options Depending on the Destination Type selected on the setup tab, different fields display on the Setup tab. Also the fields on the Destinations and Alarm Escalation areas of Destinations / Alarm Escalation tab change based on the Destination Type selection. The following table summarizes the available Destinations and Alarm Escalation options on the Destinations / Alarm Escalation tab for a DSC controller: Destination Type Email
Destinations Area
Alarm Escalation Area Supported
HTTP
SUA Reference E-Mail Address Destination(s) not needed
Local Printer
Destination(s) not needed
Pager/SMS Alphanumeric
SUA Reference Pager Number TAP Gateway SUA Reference Pager Number
Pager/SMS Numeric
Alarm Escalation is not applicable Alarm Escalation is not applicable Supported
Supported
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. The following table describes the available Message Formats: Destination Type Email, Local Printer , File, and Windows Printer
Message Format Long Text
Description This format contains the following information in the notification: the Event Class (EVC) that is associated with the notification, the type of notification (i.e. Alarm, Acknowledgement, Return to Normal, Fault), the time and date that the notification occurred, and the message that was generated by the notification.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–72
Total Pages in this Section: 176
Setup
Destination Type
Message Format
5–73
Description The layout of this format is: --------------------------------------- - --------------------------------------- An example of this format is displayed below: ---------------------------------------Notification - Alarm ---------------------------------------16:09:57 11-Apr-2006 Supply Air Temp (0.0) has dropped below its LOW LIMIT (15.0)
Short Text
Pager/SMS
Alphanume ric (TAP) Numeric Only
HTTP
HTML Post Data
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: - An example of this format is displayed below: Notification - Supply Air Temp (0.0) has dropped below its LOW LIMIT (15.0) This formats the notification so it can be displayed on an alphanumeric pager or SMS device using the short text format shown above. This option is only available if the Destination Type is set to Pager/SMS. This is used to send messages to a numeric pager. It does not send a notification message to the pager, but rather numeric characters that are appended to the phone number. This option is only available if the Destination Type is set to Pager/SMS. This formats the notification as a text string containing all relevant information and sends it to the Web server in HTML format as a POST request. For more information, refer to the HTTP Alarm Notifications section.
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.
URL Address (HTTP Destination Type) Address of the web server that receives notifications of alarms via HTTP.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–73
5–74
Event Management System
End of Job Insert Allows the user to specify a Form Feed or a Line Feed after the Alarm Notification is printed. This drop down box is only visible for Printer Destination Types (Local Printer). This feature only works with a dot matrix printer. The different options are: End of Job Insert Options Form Feed
Line Feed
None
Printer Function Performs a form feed after each notification is sent. This option is used if you want to print one notification per page. Performs a line feed after each notification is sent. This will separate each notification printed with a blank line. Makes the printer print one notification after another without blank lines in between the notifications.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–74
Total Pages in this Section: 176
Setup
5–75
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. A typical basic Init String is “AT”.
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. A typical Dial Prefix is “ATDT”.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–75
5–76
Event Management System
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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 HVAC (Red)
Icon
Access (Blue) Lighting (Green)
Destinations / Alarm Escalation Tab The Destinations / Alarm Escalation tab is used for: •
Specifying the Destination where the Event/Alarm notifications will be sent.
•
Ensuring that there is an action or response to the alarm within a designated time. If there is no action or response, the escalated alarm is resent and may also be sent to a different destination.
The Destinations area of the Destinations / Alarm Escalation tab contains a list for entering the System User Access (SUA) objects of all the users that will receive the Event/Alarm notifications. The SUA objects contain the destination information (i.e. email address, phone number). To add a destination, double click on an available row under the SUA Reference column and select the SUA from the list that appears. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–76
Total Pages in this Section: 176
Destinations / Alarm Escalation Tab
5–77
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.
Status
Possible Reasons
Pager/SMS, Destination Type Unable to initialize modem
The modem is disconnected. Check the serial cable between the DSC and the modem and ensure it is connected. Ensure the modem is plugged in and is turned on.
Unable to send. Will retry later.
The PTP port is currently busy (i.e. NET object or another EVR object is using the port). It will be tried again later.
Modem in use
Unable to use the modem because it is in use (i.e. NET object or another EVR object is using the port and is not releasing it).
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–77
5–78
Event Management System
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).
Local Printer Destination Type Port is in use by NET1
The NET object is using the PTP port. The controller needs to be reset in order for the EVR to gain control of the PTP port.
E-Mail Destination Type Couldn’t initialize email
Missing settings in the Device (DEV) object (i.e. Email Address, SMTP Server, IP settings). Unable to find the SMTP server.
No email destination
Missing email address in the SUA object. There are no SUA objects in the Destinations tab.
Timed out for…
Failed to receive a response from the SMTP server.
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”.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–78
Total Pages in this Section: 176
Destinations / Alarm Escalation Tab
5–79
First Destination to Try This field specifies the corresponding entry in the destinations dataview that the EVR object will start with when starting escalation and sending notifications (i.e. 1, 2, 3, etc.). It is only used when the EVR object is using Auto Escalation. The field is not used when the EVR object is using Manual Escalation, since a PG is required to fully control this value.
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.
Number of Alarm Retries The Number of Alarm Retries field specifies the number of times that the EVR will resend notifications to each destination in the Destinations list before moving onto the next destination. The total number of notifications that each destination will receive is one more than this number (original notification plus Number of Retries). Setting this to a value of 0 will send 1 notification to each destination. The default is 3.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–79
5–80
Event Management System
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–80
Total Pages in this Section: 176
Log Tab
5–81
EVENT LOG (EVL) The Event Log (EVL) provides a method of recording a history of alarm notifications. The Event Log can record more than one events or events of classes on the same log at the same time. Event Log can be created on ORCAview or on any controller. 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. The Event Log object has these tabs: •
Log starting on page 5–81
•
Setup starting on page 5–88
•
Alarm Filtering starting on page 5–90
•
Description starting on page 5–93
Log Tab The Log tab contains the entries of alarm notifications that were routed to the Event Log.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–81
5–82
Event Management System
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.
Message The message for that transition. The following four fields are included in the Log Entry Details displayed at the bottom of the EVL dialog. Time The time that the Event occurred.
Alarm Type The monitoring algorithm used in the Event to monitor the alarm input. Event Class This shows the class that the Event is a member of. Event Status Indicates if that transition required an acknowledgement.
Details on Highlighted Events 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. The following is a list of all the details available. Time The time that the Event occurred.
Alarm Type The monitoring algorithm used in the Event to monitor the alarm input. 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. Deadband The deadband parameter setting for the event. Event Status Indicates if the highlighted transition requires an acknowledgement. Setpoint The value of the setpoint object referenced in the event.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–82
Total Pages in this Section: 176
Log Tab
5–83
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. 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. Bitmask Indicates the bits in the monitored bitstring that are set. Acknowledged by Indicates the device that the event was acknowledged from. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–83
5–84
Event Management System
Out of Range entry
Message: The message for that transition. 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. Deadband: Field no longer exists. Event Status: Indicates if that transition required an acknowledgement.
Floating Limit Entry
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–84
Total Pages in this Section: 176
Log Tab
5–85
Change of State Entry
Alarm Input Value: Value of alarm input that caused the transition.
Command Failure Entry
Alarm Input Value: Value of alarm input that caused the transition.
Feedback (Object Reference): Value of feedback object at time of transition.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–85
5–86
Event Management System
Change of Value (Incremental) Entry
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.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–86
Total Pages in this Section: 176
Log Tab
5–87
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. Change of Bitstring Entry
Alarm Input Value: Value of alarm input that caused the transition.
Acknowledgement Entry
Describes the user and the device that acknowledged the alarm notification.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–87
5–88
Event Management System
Buffer Ready Event Status: Shows that this event requires an Acknowledgement.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–88
Total Pages in this Section: 176
Setup
5–89
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”
Maximum Log Entries This field specifies the maximum amount of entries that can be contained in the log. Increasing the count will result in the Event Log using more memory in the device. The maximum amount of notifications that may be stored in an event log is 100. 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.
Archival Buffer Notification Setup: Reporting Checkbox If the Reporting checkbox is checked, three other fields become visible in the Archival Buffer Notification Setup area. These include Event Class, Threshold, and Records Since Last Notification.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–89
5–90
Event Management System
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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 HVAC (Red)
Icon
Access (Blue) Lighting (Green)
Alarm Filtering (Updated 3.40) The Alarm Filtering tab in the Event Router specifies which Event Notifications are to be routed. These notifications are specified by entering the names of the events or their classes.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–90
Total Pages in this Section: 176
Alarm Filtering (Updated 3.40)
5–91
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.
Classes and/or Events to Log The Alarm Filtering tab of the Event Log object works in conjunction with the EVC and EV objects in the system.
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. Classes and/or Events to Log
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. The Class / Event column accepts entries in the following forms:
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–91
5–92
Event Management System
•
EVC1 – All alarms of Event Class #1 on the current controller
•
*.EVC1 – All alarms of Event Class #1 from all controllers
•
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
•
100.EV1 – Alarm 1 on device 100 is routed
•
100.EV* - Any alarm from device 100 is routed.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–92
Total Pages in this Section: 176
Description
5–93
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 This field specifies which Events to log based on Event Flags.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–93
5–94
Event Management System
EVENT AND ALARM SETTINGS (EVS) The Event and Alarm Settings (EVS) object contains settings for how the Event management system will operate within the device. It specifies such parameters as: • • • • • •
what Events to track, (None, Local, and Local & Remote) which device is the master alarm list device whether or not to load active alarm lists from other devices on startup maximum size of the active alarm list on the device maximum number of the device notification buffers amount of time to wait between tries to re-send a notification
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–94
Total Pages in this Section: 176
Setup
5–95
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.
Auto Load Active Event List(s) This is enabled if the user wants the device to retrieve active lists from each device. If there is a Master Panel named then it alone will be queried. If there is no Master Panel named then each individual device will be queried. This will mainly be set in the Event and Alarm Settings in ORCAview. A DCU may auto load from another DCU in the situation where another Master Panel is on a network. The Alarm Master Panel will also automatically load the active alarm list from a device that was offline and comes online again.
Max Event Activities in List Specifies the maximum number of active alarms that the device may track at any one time. This value may need to be increased in the case where the device will be holding larger amounts of active alarms. The value will then automatically decrease on restart. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–95
5–96
Event Management System
Max Notification Buffer 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 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. Note: Event Acknowledgements are also Notifications; if many events are
acknowledged quickly, then the Notification Buffer could overflow.
Notification Retry Interval This is the amount of time (in seconds) that the device will wait before retrying to send a failed notification to a destination device.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–96
Total Pages in this Section: 176
Stats
5–97
Event Activity Statistics The event activity area of the Stats tab contains statistical data about active events on the device. To reset the stats simply reset the Event Settings object. Active Events Shows the number of events that are currently active on the device. Unacknowledged Events Shows the number of active alarms that are on a device and have not yet been acknowledged. 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. Acknowledges for Unknown Events The number of times an acknowledgment was received for an event that is not in the activity list. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–97
5–98
Event Management System
Event Class Statistics: The event class area contains statistical data about Event Class objects that are being used in the device. 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. Invalid Destination The number of times an Event Class lacked valid destination information.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–98
Total Pages in this Section: 176
Active Alarm Lists
5–99
Active Alarm Lists Each DSC on the network is setup by default to maintain a list of local active alarms. By default the maximum size of the active alarms list on a DSC is 20. Every time an alarm becomes active on the device, it uses a position in the list. The position will remain in use until the alarm is no longer active. Alarms remain active until they have returned to normal and been acknowledged.
Active Alarm List Sizing If it is expected that the number of active alarms on a controller will exceed the default value of 20, the maximum size of the list will need to increase. Likewise, the maximum size of the list on a device can be decreased. This can be done in the devices Event Settings object. To adjust the size of the active alarm list on a device:
1.
2.
3.
Find and open the Event Settings object in the device. Make the necessary adjustments to the “Max. Event Activities in List” setting.
Reset the device.
Tracked Alarms in the Active Alarm List of a Device By default the DCU or DAC controller will track only the alarms that are local to it. Only alarms that are in the database of the device are tracked by its active alarm list.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–99
5–100
Event Management System
Tracking no Alarms
1.
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. To configure the device to track no alarms:
Find and open the Event and Alarm Settings object in the device.
2.
3.
Set the “Alarms to Track” field to “None”.
Reset the device.
Tracking Local and Remote Alarms
The device may be configured such that it is to track its own local alarms as well as any other remote alarms that are broadcast to it. This configuration will generally be used when the device is acting as a master alarm list device. A DAC cannot act as a master.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–100
Total Pages in this Section: 176
Active Alarm Lists
1.
To configure the device to track local and remote alarms:
Find and open the Event and Alarm Settings object in the device.
2.
3.
5–101
Adjust the Alarms to Track setting to “Local and Remote”.
Reset the device.
Auto Loading Active Alarm Lists on Startup By default ORCAview is configured to automatically load the active alarm lists from other devices at startup. When ORCAview logs into a network it will automatically ask every device on the network for an update of their active alarm lists. Likewise the active alarm list will be automatically loaded from any new devices that come online in the future. The DSC is configured so that it will not automatically load the active alarm lists of other devices on startup.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–101
5–102
1.
Event Management System To configure a device to automatically load active alarm lists from all devices:
Find and open the Event Settings object in the device.
2.
Adjust the V3 Alarms To Track setting to “Local and Remote".
3.
Enable the “Auto Load Active Events List(s)” checkbox.
4.
Increase the Max. Event Activities in List setting if necessary.
5.
Reset the device.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–102
Total Pages in this Section: 176
Active Alarms Folder
5–103
VIEWING ACTIVE ALARMS WITH NAVIGATOR ORCAview and both the DCU and DAC controllers maintain active alarm lists. Navigator has the ability to show both the active alarm list that is in ORCAview as well the active alarm list on another device on the network.
Active Alarms Folder The Active Alarms folder is found in the left hand Navigator pane. When the Active Alarms folder is selected, all active alarms are shown in the right hand Navigator pane. Alarms are only removed from the Active Alarms folder after the alarm has been restored and acknowledged. 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.
Alarm Name
Alarm Status
Time of Alarm
Alarm Input Object
Class
Alarm Message
Alarm Type
Active alarms Folder
The above figure shows how two transitions of the alarm are displayed in the active alarm folder.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–103
5–104
Event Management System
Update Active Alarms The active alarms folder can be manually updated. This may be necessary if ORCAview is logged into the network without auto loading the active alarm lists or if the active alarms list on ORCAview becomes out of synch with the active alarm lists on the other devices.
To update active alarms folder, right click and select “Update Alarms”
Note: An Alarm has to be Acknowledged and Restored to remove it from the
Active Alarms List.
Active Alarms Filter Navigator can also display the active alarms that are on each individual device. This is done by right clicking on the object filter at the bottom right hand corner of Navigator. In this mode, Navigator is retrieving the list of active alarms from the device itself, it is not displaying ORCAview's local active alarm list.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–104
Total Pages in this Section: 176
Active Alarms Filter
5–105
From this view the active alarms can be opened, acknowledged or deleted just as they can when the viewing the active alarms folder.
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 active alarm list on the controller becomes out of synch with the active alarm lists on the other devices. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–105
5–106
Event Management System
ROUTING NOTIFICATIONS TO PRINTERS, FILES, PAGERS AND EMAILS 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. DAC products do not support printers and so cannot print alarms. Alarm notification printouts will look like the following: Alarm and Device Event Class Time and Transition Alarm Input Example of Alarm Transition.
Event Class User and device who acknowledged the notification (only shown if acknowledgement was from an ORCAview OWS)
DSC and DAC controllers support auto generated text alarm messages.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–106
Total Pages in this Section: 176
Printing to a Windows Printer
5–107
Printing to a Windows Printer To send an alarm to a printer there must be a printer installed and properly configured in Windows. The following section, Installing a Dot Matrix Printer Driver, starting on page 5–109 describes how to install a dot matrix printer. When a Windows printer is installed, ORCAview will automatically detect the installed printer at startup and create an Event Router (EVR) object for it. The EVR object is found in the ORCAview PC. The following figure shows an example of an EVR object:
Once the Windows printer is installed it is only a matter of setting up an Event Router on the workstation. The Event Router will be used to route alarm notifications through to the Local Printer.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–107
5–108
Event Management System To print all alarms to the ORCAview printer:
1
Open an Event Router object for a particular printer (automatically created at ORCAview startup).
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.
3
Select the classes or Events to be routed here. The Notification class is entered in the dataview.
Printing the Active Alarms Folder ORCAview allows you to print the entire contents of the Active Alarm folder. Print Preview is not available for the Active Alarm Folder. To print the contents of the Active Alarm folder:
1
From the left pane of the Navigator, click on the Active Alarms folder.
2
From the ORCAview dashboard, choose File and Print. The entire contents of the Active Alarm folder will print.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–108
Total Pages in this Section: 176
Installing a Dot Matrix Printer Driver
5–109
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.
Installing a Dot Matrix Printer Driver This section describes the installation and configuration of a dot matrix printer for use with ORCAview. 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:
Total Pages in this Section: 176
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.
3.
Click Next to continue.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–109
5–110
Event Management System
4.
Select Local Printer. Click Next to continue.
5.
Under Manufacturers select “Generic” and under Printers select “Generic / Text Only”. Click Next to continue.
6.
Select “LPT1”. Click Next to continue.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–110
Total Pages in this Section: 176
Installing a Dot Matrix Printer Driver
Total Pages in this Section: 176
5–111
7.
Click Next to continue.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–111
5–112
Event Management System
10. Switch to the Paper tab.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–112
Total Pages in this Section: 176
Printing to File
5–113
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.
Event Router Object 1 The File Name field contains the Path to the location where the file is created.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–113
5–114
Event Management System To print all alarms to a file: 1. Create an Event Router object 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.
3.
Select the classes or Events to be routed here.
To view the Print-to File:
Use WordPad to open the alarm file. To open the file easily, do the following: 1.
Open WordPad.
2.
Click the Open button or from the File menu click Open.
3.
At the Open dialog box File Name area, enter the path or browse for “C:\Program Files\Delta Controls\3.30\Sites\Your Site\Print_Output.txt”.
Routing Alarm Notifications to an Alphanumeric Pager DSC controllers are capable of sending event notifications to an alphanumeric pager or Short Messaging Service (SMS) compatible devices such as a cellular phone. The DCU does not support alphanumeric paging. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–114
Total Pages in this Section: 176
Routing Alarm Notifications to an Alphanumeric Pager
5–115
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. Using SMS, a short alphanumeric message (160 alphanumeric characters) can be sent to and displayed on a mobile phone. SMS messaging works much like an alphanumeric pager system. The message is buffered by the GSM network until the phone becomes active. 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).
Setup for Alphanumeric Paging The following is needed to set up the controller to send notifications to a pager:
Total Pages in this Section: 176
•
TAP Gateway phone number
•
List of all pager phone numbers
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–115
5–116
Event Management System 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 The following objects need to be setup for alphanumeric paging: •
System User Access (SUA)
•
Event Router (EVR)
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–116
Total Pages in this Section: 176
Routing Alarm Notifications to an Alphanumeric Pager
5–117
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. To configure the Event Router object for alphanumeric paging
Total Pages in this Section: 176
1
Create a new Event Router (EVR) object.
2
In the Class and/or Events to Route dataview, enter the Classes and Events that require Pager notifications. The default will route all Event Notifications to the Pager.
3
Click the Setup tab.
4
In the Destination Type field, select Pager.
5
In the Message Format field, select Alphanumeric TAP format.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–117
5–118
Event Management System 6 7
Click the Destinations tab. Enter the SUA of the recipient of the alphanumeric page into the dataview.
The controller is now setup for alphanumeric paging.
Routing Alarm Notifications to a Numeric Pager DSC and DCU controllers are capable of sending numeric information to a numeric pager. When using the EVR object to send alarm notifications to a numeric pager, messages sent to the pager are entered in the SUA object.
Setup for Numeric Paging The following objects need to be setup for numeric paging: •
System User Access (SUA)
•
Event Router (EVR)
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–118
Total Pages in this Section: 176
Routing Alarm Notifications to a Numeric Pager
5–119
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 Pager Number field is left blank. To configure the Event Router (EVR) object for numeric paging
Total Pages in this Section: 176
1
Create a new Event Router (EVR) object.
2
In the Class and/or Events to Route dataview, enter the Classes and Events that require Pager notifications. The default, EVC*, will route all Event Notifications to the Pager.
3
Click the Setup tab.
4 5
In the Destination Type field, select Pager/SMS. In the Message Format field, select Numeric Only.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–119
5–120
Event Management System
6 7
Click the Destinations/ Alarm Escalation tab. Enter the SUA Reference of the recipient of the numeric page into the dataview.
8
Click OK or Apply. The controller is now setup for numeric paging.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–120
Total Pages in this Section: 176
Routing Alarm Notifications to Email
5–121
Routing Alarm Notifications to Email Ethernet controllers are capable of sending alarm notifications using email (the DCU does not support email notifications). 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
The following objects need to be setup: •
Device Object (DEV)
•
Event Router (EVR)
•
System User Access (SUA)
To configure the Device object for email notifications
1
Open the Device Object of the controller that will be sending out the email notifications.
2
In the Panel’s E-Mail Account field under the Internet tab, enter the text that you want to appear in the From field of the emails. In the SMTP Server field under the Internet tab, enter the address of the SMTP server. For example, mail.yourISP.com. Your network administrator can provide this address.
3
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–121
5–122
Event Management System
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–122
Total Pages in this Section: 176
Routing Alarm Notifications to Email
5–123
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.
Total Pages in this Section: 176
Uncheck DHCP. Enter the IP address, subnet mask, gateway address and DNS Server.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–123
5–124
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–124
Total Pages in this Section: 176
Routing Alarm Notifications to Email
5–125
To configure the Event Router object for email notification
Total Pages in this Section: 176
1.
Create a new Event Router (EVR) object.
2.
Switch to the Setup tab.
3.
In the Destination Type field, select E-Mail.
4.
In the Message Format field, select either the Long Text or Short Text format. The Short Text format is useful if the controller is sending the email directly to a mobile phone or alphanumeric pager.
5.
Switch to the Destinations / Alarm Escalation tab.
6.
Enter the SUA of the recipient of the email into the dataview.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–125
5–126
Event Management System
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).
By default, the Max Notification Buffers is 10. In most cases, 10 notification buffers are sufficient (assuming the EVR receives only the occasional alarm). However, the notification buffers can be increased up to 500. It should be increased if many alarms (local and remote) may occur at the same time, or if there are multiple EVR objects. A good rule of thumb is twice the number of event objects that each EVR object is set-up to route. The drawback to increasing the notification buffers is that it uses available database space (about 1 kB per 10 notification buffers). 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–126
Total Pages in this Section: 176
Introduction
5–127
HTTP ALARM NOTIFICATION This section details HTTP alarm notification, its use, and gives some examples for Microsoft-IIS ASP and Apache PHP web-scripted programming languages. This feature is only available for Ethernet DSC-based controllers.
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. Note: Configuring an SQL-type database is beyond the scope of this document.
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. An Ethernet DSC-based controller, set-up as an alarm routing controller, is required to route BACnet alarms to the Web server.
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:
Total Pages in this Section: 176
•
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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–127
5–128
Event Management System
HTTP POST Request Message Content The HTTP alarm notifications are sent as a standard HTTP 1.1 POST request to the Web server. The message content is in a pre-parsed format so the alarm contents can be easily recorded in an SQL-type database. The message is formatted as a single string of concatenated = pairs in accordance with standard ‘CGI Form Input’ conventions. The content of the message is formatted as follows: Id=&Time=&Class=&Type=&Algo=&Msg=&To=&From=&MValue=&P1=&P2= Each of the parameters in the message is described in the table below. Parameter
Description
Example
Id
Event Object Reference
100.EV4
Time
Transition Time
11:23:16 11-Feb-2006
Class
Event Class
Maintenance Network Security Critical Notification Fire Access Control Event Access Control Alarm Archival
Type
Notification Type
Event Alarm Acknowledgement
Algo
Event Object Algorithm
Change of Bitstring Change of State Change of Value Command Failure Floating Limit Out Of Range Buffer Ready
Msg
Transition Message Text
AHU1 Supply Air Temperature is out of range
To
Transition To State
Normal Fault Alarm High-Limit Low-Limit
From
Transition From State
MValue
This parameter can be any of the following:
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–128
81.3000
Total Pages in this Section: 176
HTTP POST Request Message Content
Parameter
Description
Example
Monitored Object’s Value
Central OWS
5–129
Acknowledging Device (OWS Name) P1
This parameter can be one of various values. See the table below.
P2
This parameter can be one of various values. See the table below.
The MValue parameter varies depending whether the Notification Type is an acknowledgment or an alarm/event. If the Notification Type is an acknowledgement, the MValue parameter is the name of the acknowledging device (OWS). Otherwise, it is the monitored object’s value. The P1 and P2 parameters vary depending on the Event Object Algorithm as follows: Event Object Algorithm
P1
P2
Change of Bitstring
Not Used
Not Used
Change of State
Not Used
Not Used
Change of Value
Not Used
Not Used
Command Failure
Feedback
Not Used
Floating Limit
Setpoint
Exceeded Limit (High Limit or Low Limit –depending on the transition)
Out Of Range
Deadband
Exceeded Limit (High Limit or Low Limit –depending on the transition)
The following items are important to note:
Total Pages in this Section: 176
•
If the P1 parameter is not used, its value will be “[16]”. If the P2 parameter is not used, its value will be “[17]”.
•
The exceeded limit (high limit or low limit) for floating limit does not take into account the setpoint value. It is just the value specified in the EV object. For example, if the setpoint value is 20 and the high limit is 10, for a high limit transition the exceeded limit will be 10 (not 30).
•
The maximum allowable message content length is about 300 characters. If the transition message text is too long (more than about 200 characters), the message content will be truncated, causing some or all of the To, From, MValue, P1, and P2 parameters to be dropped.
•
Alarm notification messages should not contain any ‘+’ or ‘&’ characters (in the Messages tab of the EV object). The ‘+’ character is used to represent a space in the message content. The ‘&’ character is used to separate = pairs in the message content.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–129
5–130
Event Management System
Example: HTTP POST request message The following is an example of the HTTP POST request message content sent to the Web server. 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
Configuring HTTP Alarm Notification HTTP alarm notification is configured in the EVR object of the alarm routing controller. Note: Make sure to specify IP settings (IP Address, Subnet Mask, Gateway, and
DNS Address) in the Device (DEV) object, under the Internet tab.
To configure HTTP alarm notification:
1
Using Navigator, create an EVR object.
2
In the Alarm Filtering tab, specify the Event Classes or Event objects to be routed.
3
Select the Setup tab.
4 5
Specify “HTTP” for the Destination Type. Enter the URL Address of the Web server.
The following items are important to note: •
In order for the EVR object to route alarm notifications that originated from other controllers, make sure to set-up the destination list in the EVC objects in the other controllers such that the alarm routing controller will receive the notifications.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–130
Total Pages in this Section: 176
Configuring HTTP Alarm Notification
5–131
•
Because the destination is a Web server, the human convenience features (Alarm Escalation and Flood Suppression) are not available.
•
Unless specifically specified in the URL Address, the POST requests will be sent using TCP/IP port 80. Entering the following into the URL Address will send the POST requests to port 8080, “http://192.168.1.15:8080/CSMS/Alarm_Input.cgi”.
•
For HTTP alarm notification, the EVR object will route ‘Return to Normal’ notifications whether or not the Operator Acknowledgement is enabled in the EVC object.
•
Multiple EVR objects can be created to send alarm notifications to multiple destinations (URL’s). This allows for filtering or segregating alarm notifications (since the URL is defined on a per EVR basis).
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. By default, the Max Notification Buffers is 10. In most cases, 10 notification buffers are sufficient (assuming the EVR receives only the occasional alarm). However, the notification buffers can be increased up to 500. It should be increased if many alarms (local and remote) may occur at the same time, or if there are multiple EVR objects. A good rule of thumb is twice the number of event objects that each EVR object is set-up to route. The drawback to increasing the notification buffers is that it uses available database space (about 1 kB per 10 notification buffers). 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–131
5–132
Event Management System
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. Status
Possible Causes
No Http Server’s URL
Web server address (URL) is not specified in the EVR object
Unable to send request
Web server is offline or not responding
Unable to connect to web server
IP settings are not specified in the DEV object
Unable to find web server
An invalid Web server address (URL) is specified
Web Server ASP/PHP Examples Any Web server capable of accepting CGI formatted ‘form input’ can receive alarm notifications sent via HTTP alarm notification. This includes Apache and Microsoft-IIS Web servers. 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. The following simplified examples demonstrate Microsoft ASP (Active Server Pages) and Apache PHP (Hypertext Preprocessor). In these examples, the Web server generates a text file “log.txt” that contains all received alarm notifications.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–132
Total Pages in this Section: 176
Web Server ASP/PHP Examples
5–133
Microsoft-IIS ASP Example
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–133
5–134
Event Management System
Apache PHP Example
Generated Alarm Log The following is an example of the alarm log (text file) that the above examples generate.
Server Time Id Time Class Type Algo Msg P2 5:22:34 PM 8600.EV6 17:23:50 17-Mar-2006 Maintenance 1 - Freezestat has tripped! Alarm Normal 1 [16] [17] 5:23:17 PM 8600.EV6 17:24:34 17-Mar-2006 Maintenance AHU xxx Freezestat Acknowledged from DELTA (Devins OWS) Alarm [17] 5:25:15 PM 8600.EV5 17:26:32 17-Mar-2006 Maintenance 1 - Return Air Humidity is out of a normal range! High-Limit Normal 5:25:25 PM 8600.EV5 17:26:42 17-Mar-2006 Maintenance AHU xxx Return Air Humidity Acknowledged from DELTA (Devins OWS) [16] [17] 5:25:33 PM 8600.EV5 17:26:51 17-Mar-2006 Maintenance 1 - Return Air Humidity is normal. Normal High-Limit 30.0000 5:25:49 PM 8600.EV6 17:27:06 17-Mar-2006 Maintenance 1 - Freezestat has been reset. Normal Alarm 0 [16] [17]
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–134
To
From
MValue
Alarm
Change of State
P1
Air Handler
Acknowledgement Change of State Devins OWS [16] Alarm Out Of Range Air Handler 100.0000 5.0000 65.0000 Acknowledgement Out Of Range High-Limit Devins OWS Alarm 5.0000 Alarm
Out Of Range 65.0000 Change of State
Air Handler Air Handler
Total Pages in this Section: 176
DSC Serial Printing
5–135
DSC PRINTING This section explains printing for: •
DSC Serial Printing starting on this page
DSC Serial Printing The DSC controller is capable of local printing via the DSC’s serial port using a serial-to-parallel converter to a simple, dot-matrix, line printer. The recommended serial printers: Panasonic KX-1131, …, KX-3696 printer family http://www.panasonic.com/business/psna/products-document-imaging/printers/dot-matrix.aspx Note: Parallel printers require a serial-to-parallel converter in order to connect the DSC to it.
Selecting a Serial-to-Parallel Converter for a DSC A DSC can send alarm notifications to a local printer for alarm logging purposes. A local printer is a printer that is directly connected to the PTP port on a DSC. 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. Note: The ATEN SXP-325A is recommended by Delta Controls as it has been
tested and confirmed that it works for local printing. It can be purchased online at www.iec.net using the following part number: ADP3000-512 http://www.iec.net/adp3000-512.html
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–135
5–136
Event Management System The following Serial-to-Parallel converter is recommended by Delta Controls as it has been tested and confirmed that it works for local printing: ATEN SXP-325A: This converter has 512KB of memory allowing it to serve as a printer buffer. It can be purchased online at www.iec.net using the following part number: ADP3000-512 (http://www.iec.net/adp3000-512.html)
The following Serial-to-Parallel converters are known not to work: ATEN SXP-320A This converter will work only for local printing. Black Box Serial Parallel Converter III (PI115A-C) This converter does not work reliably. Black Box Serial Parallel Converter IV (PI125A-R2) 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.
Configure Event Router for Local Printing To configure the Event Router object for local printing:
1.
Create a new Event Router object.
2.
Switch to the Setup tab.
3.
In the Destination Type field, select Local Printer.
4.
In the Message Format field, select Long Text or Short Text.
5.
Select the corresponding Baud Rate that is set for the serial-to-parallel converter.
6
Click on the OK button to close the Event Router object dialog.
7
Reset the controller.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–136
Total Pages in this Section: 176
Sending Alarm Notifications over Modem Connections
5–137
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.
Sending Alarm Notifications over Modem Connections A DCU or DSC controller can be configured to dial out an alarm to a certain ORCAview workstation based on its classification. Likewise ORCAview can be configured to sit in Auto Answer mode and wait for an alarm notification to come in over the modem.
Sending Alarm Notifications to ORCAview via Modem The controller is capable of sending alarm notifications to ORCAview via the modem. In order for the DCU to establish a modem connection to ORCAview for alarm notification purposes, some objects need to be configured: •
A Remote Panel Settings (RPS) object on the controller(s).
•
Serial Port Settings (SNS) object on DCU only
•
An Event Class (EVC) object on the controller.
•
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:
Total Pages in this Section: 176
1.
Check that the DCU controller contains a Modem (MDS) object. Select the USR Robotics modem type.
2.
Attach a modem to COM 2 of the DCU (COM1 on a DAC) using a CBL9312 modem cable.
3.
In the controller with the modem attached, create a Remote Panel Settings object.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–137
5–138
Event Management System
4.
Enter the telephone number for ORCAview that will be dialed.
5.
Select the Dial-out SUA.
6.
Click the Setup tab.
7.
Choose the correct Baud Rate. The setting must match the baud rate selected in the BCP object on ORCAview.
8.
Enter the address of ORCAview that is to be dialed.
9.
Enter the network number of ORCAview that will be dialed.
10. Click OK.
11.
Reset the controller. 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–138
Total Pages in this Section: 176
Sending Alarm Notifications over Modem Connections
5–139
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.
Do not enter a telephone number.
Total Pages in this Section: 176
3.
Choose the correct Baud Rate. The setting must match the baud rate selected in the BCP object on ORCAview.
4.
Enter the address of the ORCAview PC that is to be dialed.
5.
Enter the RS-232 Port Setting network number of the ORCAview PC that will be dialed. See the Setup tab of the BCP object on the remote ORCAview PC.
6.
Click OK.
7.
Reset the controller.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–139
5–140
Event Management System
Serial Port Settings (SNS) object
•
Select the proper COM Port and Modem Reference. (this object would actually be on the remote OWS PC 27101.)
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–140
Total Pages in this Section: 176
Sending Alarm Notifications over Modem Connections
5–141
To configure the Event Class to send alarm notifications to a specific device:
1.
Open the Event Class.
2.
Enter the device that the alarm notification is to be sent to.
3.
Enable the “Retry” and “Confirmed Transmission “ settings for more reliable transmission of alarm notifications over modems.
4.
Click the OK button.
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.
Note: The destination ORCAview PC must establish a dial-in connection to the network before any object names will be displayed, logged, or printed correctly.
More about Retry and Confirmed Transmission Fields When an alarm notification is to be sent out to an ORCAview PC over the modem, it is strongly recommended to enable both the “Retry” and the “Confirmed Transmission” checkboxes in the Event Class. This approach provides a much more reliable transmission of an alarm notification. 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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–141
5–142
Event Management System Notification Buffer Overflows 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. Note: Event Acknowledgements are also Notifications; if many events are
acknowledged quickly, then the Notification Buffer could overflow.
ORCAview Auto-Answer for Alarms ORCAview can be configured to accept Alarm Notifications that are coming in via modem connection. ORCAview will wait for the modem to receive a transmission, establish a connection with the remote network and finally accept the Alarm Notification. There are two methods to set ORCAview up in auto answer mode. Two Auto-Answer Methods: •
Wait for Call
•
Login & Disconnect
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–142
Total Pages in this Section: 176
ORCAview Auto-Answer for Alarms
5–143
Method 1: Wait for Call To configure ORCAview to only wait for Alarm Notifications:
1.
Start up ORCAview.
2.
Enter the Username and Password here.
3.
Select the proper connection here.
4.
Select “Wait for Modem Answer here.
5.
Select the proper Modem here.
6.
Click OK.
Once ORCAview is successfully logged into, it is ready to receive alarm notifications that are coming in via the modem. Navigator will appear as shown below. No devices will appear in the network tree since a network connection has not actually been established.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–143
5–144
Event Management System 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. Method 2: Login & Disconnect To configure ORCAview to receive Alarm Notifications and allow immediate network connection:
1.
Start up ORCAview.
2.
Enter the Username and Password here.
3.
Select the proper connection here.
4.
Select “Modem Dial-Out” here.
5.
Select the proper Modem 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–144
Total Pages in this Section: 176
ORCAview Auto-Answer for Alarms
5–145
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”
Once the network is disconnected ORCAview is still in auto-answer mode and will receive any alarms that are dialed into it. Also the Remote Panel Settings can be right clicked on and reconnected to at any time.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–145
5–146
Event Management System
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
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–146
Total Pages in this Section: 176
Introduction: Alarm Escalation
5–147
Introduction: Alarm Escalation Previously, event notification (in Delta’s 3.22 architecture) was a two-part process involving a detecting controller and an enunciating workstation. The event (or alarm) is detected within the controller (DAC/DSC/DCU) and then relayed to the OWS for enunciation to the building operator. The usefulness of such a system is necessarily restricted to installations that contain an always-available OWS (either on-site or remote but reachable via modem) that is continuously monitored by an operator who can take some action to resolve the alarm generating condition. If either the workstation or the operator is absent then the usefulness of detecting the alarm condition is negated. 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. Alarm escalation is a means of automatically distributing alarm notifications to various users through a hierarchy of responsibility to ensure the situation is resolved. 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.
Total Pages in this Section: 176
Alarm Escalation
The process of distributing alarm notifications to various users through a hierarchy of responsibility.
Escalate
The process of sending the alarm notification to the next user in the destination list.
Escalation Policy
A guideline on how to implement Alarm Escalation (i.e. how, when and to whom to send the alarm notifications).
Notification
A message sent to a user to inform them of an alarm condition.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–147
5–148
Event Management System Acknowledge
The process of a user confirming that they are aware of the alarm. A user must acknowledge an alarm using an Operator Workstation (OWS).
TAP Gateway
A computer system that receives alphanumeric messages via a modem connection and sends the messages to an alphanumeric pager or text message capable cellular phone. It is usually part of the Telephone company’s / pager service provider’s equipment infrastructure. The Telocator Alphanumeric Protocol (TAP) is an industry standard protocol for sending alphanumeric messages.
Pager ID
The ID of the pager. Often considered the phone number of the pager.
Alarm-Distributing Controller
The controller that directs the notifications to a pager or email account.
Alarm-Generating Controller
The controller that initially detected the Alarm condition and generated the original alarm notification. The number of times an alarm notification is resent to a specific user before alarm escalation will escalate the notification to the next recipient in the hierarchy.
Alarm Retries
Retry Interval
The amount of time between sending alarm notifications to a specific user.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–148
Total Pages in this Section: 176
Introduction: Alarm Escalation
5–149
The following flowchart illustrates the basic operation of alarm escalation. Alarm occurs and is sent to alarm-distributing controller
EVR determines whether or not to route the notification
Don't Route
Route Send notification to user
Escalate to next user
Has Retry Interval Expired?
No
Is it at the end of the list?
Yes
Does it need to be retried?
No
Yes
No
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. Note: It does not have to be an acknowledgement to the alarm that it is escalating
to cause it to stop. The reason for this is that if someone is able to acknowledge another alarm that is directed to the alarm-distributing controller, then they should be able to acknowledge the alarm that is being escalated as well.
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–149
5–150
Event Management System
Subsequent Alarms while escalating
If another alarm occurs while it is still escalating the first alarm, it will continue escalating without interruption, but will switch to sending the second notification and the first notification will be dropped. This eliminates a flood of alarms from being sent by only sending the last alarm that the alarm-distributing controller received.
No Acknowledgement
If the alarm-distributing controller does not receive any acknowledgement before reaching the end of the destination list, alarm escalation will stop, until it receives another alarm, at which point it will start escalation from the beginning of the list again.
Alarm Flood Suppression Alarm Flood Suppression prevents pager and email users from being overwhelmed or “flooded” with alarms by suppressing and controlling their transmission. 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: [] (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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–150
Total Pages in this Section: 176
Introduction: Alarm Escalation
5–151
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. System Level Network
Email Pager Modem System Controller
System Controller Subnet Controllers
Subnet Controllers
Alarm-distributing (System) Controller
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 users that will receive alarm notifications.
•
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. Email ▪ This is by far the most preferred method of sending alarm notifications, as it is the most reliable and quickest way to notify a user. It is also the most flexible as it has numerous types of destination devices (i.e. PC, cell phone, PDA, etc…). However, it can be expensive depending on the type of network setup used.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–151
5–152
Event Management System In order to use Email, the following are required (in addition to an Ethernet-capable controller to use as the alarm-distributing controller): 1.
An Ethernet network connecting the alarm-distributing controller to an ‘always-on’ Internet connection (i.e. ADSL or Cable Internet connection) ensuring constant email availability. This requires the purchase or rental of special equipment (i.e. Cable/ADSL modem) plus Internet connection fees.
2.
An email server (SMTP server), which can either be provided by the Internet Service Provider (ISP), or an on-site email server. Both of which have drawbacks and benefits. •
If the ISP is providing the email server, availability and technical support relies upon the Service Provider. However, it is cheaper than having an on-site email server.
•
If an on-site email server is used, it ensures constant email availability, but relies upon the site’s I.T. staff for technical support and is more expensive. For medium to large sites, it is recommended to use an on-site email server to ensure constant email availability.
3.
If extra security is required or multiple IP connections need to share the same IP Address, a Router/Firewall is also required.
4.
If required, the purchase of an Email capable pager or cell phone to send the notifications to, plus the cost of service for these devices.
Alphanumeric Pager ▪ If sending notifications by email is not possible, then sending them to an alphanumeric pager via modem to a TAP Gateway is the next preferred method. This method is a little cheaper than Email, but is less reliable and not as quick to send notifications as email is. In order to send notifications to an alphanumeric pager, the following are required (in addition to a controller with a PTP port to use as the alarmdistributing controller): 1.
A modem connected to the alarm-distributing controller.
2.
A phone line connection. This includes the cost of the phone line service.
3.
An alphanumeric pager. This includes the cost of the pager plus the service.
4.
Access to a TAP Gateway (i.e. phone number and communication settings). Most telephone/pager service providers allow access to a TAP Gateway. Check with your service provider.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–152
Total Pages in this Section: 176
Setting up Alarm Escalation and Implementing the Policy
5–153
Numeric Pager ▪ This is the least preferred method of notifying a user. This notification method is only recommended if an alphanumeric pager is not an available option, or for existing setups. It is not recommended for new installations because this method is limited in that it cannot send a text message and can only send a numeric message. In order to send notifications to a numeric pager, the following are required: 1.
A modem connected to the alarm-distributing controller.
2.
A phone line connection. This includes the cost of the phone line service.
3.
A numeric pager. This includes the cost of the pager plus the service.
Setting up Alarm Escalation and Implementing the Policy Once you have determined the escalation policy, the following objects need to be setup in the alarm-distributing controller: • •
System User Access (SUA) Event Router (EVR)
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.
System User Access (SUA) The SUA object contains the destination information (i.e. email address, phone number) of the user. A separate SUA object is required for each user that will be notified, but a single SUA object may contain multiple methods to reach that user (i.e. email and pager). 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. • •
Total Pages in this Section: 176
Email (including text message capable cellular phones) If the SUA object is used to send email notifications to the user, enter the email address of the user into the Email Address field. Alphanumeric paging If the SUA object is used to send notifications to an alphanumeric pager, enter the phone number of the TAP Gateway into the Phone Number field as well as the Pager ID (phone number) of the alphanumeric pager into the Pager ID field.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–153
5–154
Event Management System •
Numeric Only Paging If the SUA object is used to send notifications to a numeric pager, enter the phone number of the pager plus a simple numeric message into the Phone Number field.
Enter the phone number of the TAP Gateway (if using Alphanumeric paging) or the phone number of the Pager (if using Numeric Only paging) followed by a numeric message (i.e. 5551111,,,123#).
Enter the Email address of the user here (i.e.
[email protected] or
[email protected]). Enter the phone number of the pager here if using alphanumeric paging (i.e. 5554321).
Event Router (EVR) The EVR object handles alarm escalation. It controls how and when to send specific notifications to predefined users. 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.
Enter any specific Event objects or Event Classes that you want the users to receive notifications for. The default "*.EVC*" will route any event.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–154
Total Pages in this Section: 176
Setting up Alarm Escalation and Implementing the Policy
5–155
Select the type of destination the Event Router will send the notifications to (Email or Pager).
Select the Message Format: “Alphanumeric (TAP)” or “Numeric Only” for the Pager Destination Type; “Long Text” or “Short Text” for the Email Destination Type.
These settings are only displayed for the Pager Destination Type. The default settings should be
sufficient.
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.
Enter the SUA objects of the users that you want to send the notifications to.
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
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–155
5–156
Event Management System GCL can be used to implement more complex escalation handling to suit a particular application, otherwise known as “Manual Escalation”. In order to do Manual Escalation, the Auto Escalation checkbox in the Alarm Escalation tab of the EVR object must be disabled. A Program then needs to be created to control the EscalationIndex, RetryCount, and EscalationStatus properties of the EVR object. Refer to the Examples section for an example on how to implement Manual Escalation. 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 Note: If the 'EnableEscalation' property (Escalation Start Index) is written to from GCL 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 the 'EnableEscalation' property is changed 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).
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–156
Total Pages in this Section: 176
Setting up Alarm Escalation and Implementing the Policy
5–157
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
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–157
5–158
Event Management System
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 1: Two Separate Groups (Daytime/ and Evenings/Weekends) This example describes a setup where you have two different groups of people that receive alarm notifications. One group receives notifications during the day, and the other group receives notifications in the evenings and on weekends. 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. Example 3: Manual Escalation This example describes using GCL to control escalation. With manual escalation, you can add more complex restrictions like who to escalate to depending on the status of a schedule. 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.
Example 1: Two Separate Groups (Daytime/Evening) This example describes a setup where you have two different groups of people that receive alarm notifications. One group receives notifications during the day (8:00 to 17:00 Monday to Friday), and the other group receives notifications in the evenings and on weekends. The people that receive notifications during the day are generally in the office and therefore the notifications are sent via email to their desktop computer. They will receive notifications of all alarms that occur. The people that receive notifications in the evenings and on weekends are not in the office and need to be notified via alphanumeric pagers. They will only be notified of Critical alarms that require immediate attention.
Determining the Policy The first thing to do is to sort the users into groups. In this case there are two groups, a Daytime group and an Evening/Weekend group. Each group will receive the same types of alarms during the same times. The Alarm Escalation policy for each group is as follows:
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–158
Total Pages in this Section: 176
Example 1: Two Separate Groups (Daytime/Evening)
5–159
Group 1 - Daytime Hours Users:
Alarms to route: Times: Destination Type: Destinations:
Number of Retries: Retry Interval:
Bill Bob Fred John All Alarms Daytime hours (8:00 to 17:00 Monday to Friday) Email Bill (
[email protected]) Bob (
[email protected]) Fred (
[email protected]) John (
[email protected]) 0 10
Group 2 - Evening/Weekend hours Users: Andrew Dave Sarah Ryan Alarms to route: Critical EVC Times: Evening/Weekend hours (all remaining times) Destination Type: Alphanumeric Pager (TAP Gateway phone number: 604-555-1234) Destinations: Andrew (555-1111) Dave (555-2222) Sarah (555-3333) Ryan (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
Implement the Policy The next thing to do is to convert this information into applicable objects. From this information, the following objects need to be created in the AlarmDistributing Controller:
Total Pages in this Section: 176
•
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–159
5–160
Event Management System •
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.
Create and setup the SUA objects
1.
Create the eight SUA objects since there are eight separate people (Bill, Bob, Fred, John, Andrew, Dave, Joe, and Ryan).
2.
Enter the destination information into the User Data tab of each of the SUA objects. For Bill, Bob, Fred, and John, enter their email address into the Email Address field. For Andrew, Dave, Joe, and Ryan, enter the phone number of the pager’s TAP Gateway into the Phone Number field and the phone number of their pager into the Pager ID field.
Create and setup the Schedule objects
The Schedule objects are used to set the hours of the different groups of people. They are referenced by the EVR objects and the EVR will only send notifications when the referenced Schedule is active. 1.
Create two Schedule (SCH) objects - one for the daytime people and one for the evening/weekend people. In this example, we will name these schedules “Daytime EVR Schedule” and “Evening/Weekend EVR Schedule”.
2.
Enter the desired time blocks for each day into the different schedules. As specified earlier in this example, time blocks of 8:00 to 17:00 for Monday to Friday need to be created in the Daytime EVR Schedule. Time blocks 0:00 to 8:00 and 17:00 to 24:00 for Monday to Friday, as well as the entire weekends, need to be created in the Evening/Weekend EVR Schedule.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–160
Total Pages in this Section: 176
Example 1: Two Separate Groups (Daytime/Evening)
5–161
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–161
5–162
Event Management System
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.
Create and set up the EVR objects
The Event Router (EVR) objects are used to set up how, when, and in what order users are notified. They contain links to the SUA objects and a link to a schedule object to determine when to send notifications. 1.
Create two Event Router (EVR) objects - one for the daytime people and one for the evening/weekend people. In this example, we will name these Event Routers “Daytime EVR” and “Evening/Weekend EVR”.
2.
Select the corresponding Schedule from the Schedule Reference drop down box in the Alarm Filtering tab of each of the EVR objects. In the Daytime EVR object, select the Daytime EVR Schedule. In the Evening/Weekend EVR object, select the Evening/Weekend EVR Schedule. The following figure shows the Daytime EVR object with the Daytime EVR Schedule selected as its Schedule Reference.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–162
Total Pages in this Section: 176
Example 1: Two Separate Groups (Daytime/Evening)
Total Pages in this Section: 176
5–163
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–163
5–164
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–164
Total Pages in this Section: 176
Example 1: Two Separate Groups (Daytime/Evening)
5–165
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–165
5–166
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–166
Total Pages in this Section: 176
Example 2: IT Group
5–167
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.
Determining the Policy For this example, the times and destinations of the people that will receive the notifications are: Daytime Hours Users:
Alarms to route: Times: Destination Type: Destinations:
Number of Retries: Retry Interval:
Bill Bob Fred John All Alarms Daytime hours (8:00 to 17:00 Monday to Friday) Email Bill (
[email protected]) Bob (
[email protected]) Fred (
[email protected]) John (
[email protected]) 0 10
Evening/Weekend hours Users:
Alarms to route: Times: Destination Type: Destinations:
Number of Retries: Retry Interval:
Total Pages in this Section: 176
Bill Bob Fred John Critical EVC Evening/Weekend hours (all remaining times) Alphanumeric Pager (TAP Gateway phone number: 604-555-1234) Bill (555-1111) Bob (555-2222) Fred (555-3333) John (555-4444) 2 10
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–167
5–168
Event Management System 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
Implement the Policy From this policy information (times and destinations), the following objects need to be created in the Alarm-Distributing Controller: •
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.
Create and setup the SUA objects
Create a separate System User Access (SUA) object for each person that you want to receive notifications. The SUA object is where you specify how to reach the person (i.e. email address, phone number). 1.
Create four SUA objects since there are four separate people (Bill, Bob, Fred, and John).
2.
Enter the destination information into the User Data tab of each of the SUA objects. Since each person will be notified by email and by their pager, you will have to enter their email address into the Email Address field and enter the phone number of the pager’s TAP Gateway into the Phone Number field and the phone number of the pager into the Pager ID field.
Create and setup the Schedule objects
The Schedule objects are used to set the hours of the different destinations. The Schedule objects will be referenced from the EVR objects and the EVR object will only send notifications when the referenced Schedule is active. 1.
Create two Schedule (SCH) objects - one for daytime hours and one for evening/weekend hours. In this example, we will name these schedules “Daytime EVR Schedule” and “Evening/Weekend EVR Schedule”.
2.
Enter the desired time blocks for each day into the different schedules. As specified earlier in this example, time blocks of 8:00 to 17:00 for Monday to Friday need to be created in the Daytime EVR Schedule. Time blocks 0:00 to 8:00 and 17:00 to 24:00 for Monday to Friday, as well as the entire weekends, need to be created in the Evening/Weekend EVR Schedule.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–168
Total Pages in this Section: 176
Example 2: IT Group
5–169
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–169
5–170
Event Management System Create and setup the EVR objects
The Event Router (EVR) objects are used to setup where to send the notifications. They contain links to the SUA objects (to determine where to send the notifications), and a link to a schedule object to determine when to send notifications. 1.
Create two Event Router (EVR) objects - one for daytime hours and one for evening/weekend hours. In this example, we will name these Event Routers “Daytime EVR” and “Evening/Weekend EVR”.
2.
Select the corresponding Schedule from the Schedule Reference drop down box in the Alarm Filtering tab of each of the EVR objects. In the Daytime EVR object, select the Daytime EVR Schedule. In the Evening/Weekend EVR object, select the Evening/Weekend EVR Schedule. The following figure shows the Daytime EVR object with the Daytime EVR Schedule selected as its Schedule Reference
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–170
Total Pages in this Section: 176
Example 2: IT Group
5–171
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–171
5–172
Event Management System 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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–172
Total Pages in this Section: 176
Example 2: IT Group
5–173
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.
Total Pages in this Section: 176
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–173
5–174
Event Management System
Example 3: Manual Escalation This example describes using GCL to control escalation. With manual escalation, you can add more complex restrictions like who to escalate to depending on the status of a schedule. The following properties of the EVR object can be controlled from a Program to implement Manual Escalation: Property
Description
EscalationStatus
This property is used to monitor when the notification (including retries) has been sent to the current destination. This property is automatically set to a value of 1 by the EVR object when this occurs. Once this property is set to a value of 1, it needs to be set back to a value of 0 using GCL in order for it to get set the next time.
EscalationIndex
This property corresponds to the entry in the Destination list that the notification is currently being sent to (for example: 1,2,3,etc…). Write to this property in order to specify which SUA in the Destination list to send the notification to.
RetryCount
This property sets the number of times to send the notification to the current user. This is not the number of retries, but the total number of times to send the notification (i.e. initial one plus additional retries).
AutoEscalation
This property corresponds to the status of the ‘Auto Escalation’ checkbox in the Alarm Escalation tab of the EVR object. If the checkbox is checked, this property is equal to TRUE. If the checkbox is unchecked, this property is equal to FALSE.
NumOfRetry
This property corresponds to the value in the ‘Number of Alarm Retries’ spin box in the Alarm Escalation tab of the EVR object.
SUACount
This property corresponds to the number of destinations (SUA objects) entered in the Destination list in the Destinations tab of the EVR object.
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
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–174
Total Pages in this Section: 176
Implementation Guidelines
Else
5–175
EVR1.RetryCount = EVR1.NumOfRetry + 1
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:
Total Pages in this Section: 176
•
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.
•
It is not possible to have escalation between multiple EVR’s. For example, escalate through all the destinations in EVR1, and then start escalating through EVR2 when EVR1 is finished. Escalation starts at the same time in each EVR object.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 5–175
5–176
Event Management System •
It is not possible to send notifications to every destination at once. The amount of time between sending the notification to each user is specified by the ‘Retry Interval’ setting in the EVR object which has a lower limit of 1 Minute.
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.
ORCAview Version 3.40 Technical Reference Manual Ed.. 1.80 Original Page 5–176
Total Pages in this Section: 176
Chapter 6 – TRENDING, ARCHIVING & REPORTING INTRODUCTION ............................................................................................. 6–9 Intended Audience ................................................................................. 6–9 INTRODUCTION TO HISTORIAN............................................................. 6–11 Features .............................................................................................. 6–11 System Requirements........................................................................... 6–12 Historian Database Growth and Management ................................... 6–12 MULTIPLE HISTORIANS SUPPORTED IN VERSION 3.40........................................ 6–13 HOW HISTORIAN WORKS ................................................................................... 6–13 How Does Historian Connect to the Network? ................................... 6–13 What is an Archive TL and How is it Created? ................................... 6–14 How are Archive TL's Named? ........................................................... 6–16 How Does Historian Gather Data for Archiving ................................ 6–17 What is Historian’s ODBC Database? ............................................... 6–17 INSTALLING HISTORIAN .......................................................................... 6–18 INSTALLATION ................................................................................................... 6–18 STOP OR RESTART HISTORIAN SERVICE ............................................................. 6–20 CHANGING HISTORIAN STARTUP BEHAVIOR ...................................................... 6–22 HISTORIAN SETTINGS (HS) ...................................................................... 6–24 CONFIGURING HISTORIAN .................................................................................. 6–24 Stats Tab ............................................................................................. 6–25 Troubleshooting Tab ........................................................................... 6–26 Setup Tab ............................................................................................ 6–27 Configuring DSN for Microsoft SQL Server ....................................... 6–28 Configuring DSN for MySQL .............................................................. 6–30 CHANGING THE DATABASE MANAGEMENT SYSTEM .......................................... 6–30 Installing MySQL ................................................................................ 6–31 Setting the MySQL DSN ...................................................................... 6–32 Connection Polling ............................................................................. 6–33 SECURING HISTORIAN’S DATABASE................................................................... 6–35 Changing Password for MS SQL Server 2005 Express/ SQL Server .. 6–35 VIEWING HISTORIAN’S STATUS ......................................................................... 6–36 Connection to Delta Server ................................................................. 6–36 Historian’s Status Modes .................................................................... 6–37 DOES HISTORIAN ARCHIVE EVENTS IN EVLS? ................................. 6–38 SETTING UP CONFIRMED EVENT AND ALARM TRANSMISSIONS TO HISTORIAN .. 6–38 1) Locate your Historian ..................................................................... 6–39 2) Choose a controller ........................................................................ 6–39 3) Setup Access Control Event (EVC7) ............................................... 6–39 4) Setup Access Control Alarm (EVC8) .............................................. 6–40 5) Save Database to Flash and/or File ............................................... 6–41 TREND LOG (TL) .......................................................................................... 6–42 ARCHIVE TREND LOGS....................................................................................... 6–42 CONFIGURING A TREND LOG.............................................................................. 6–43 Creating a Trend Log Object .............................................................. 6–43
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–1
6–2
Trending, Archiving & Reporting Archiving Trend Logs ......................................................................... 6–43 Changing the Log Type in a Trend Log .............................................. 6–44 Clearing the Databuffer of a Trend Log ............................................. 6–45 Setting up a Trend Log to Stop When Full ......................................... 6–45 Setting Start or Stop Time for a Trend Log ........................................ 6–45 Changing Maximum Samples in a Trend Log .................................... 6–46 MULTI-TREND (MT) ................................................................................... 6–47 CONFIGURING A MULTI-TREND ......................................................................... 6–48 Creating a Multi-Trend Object ........................................................... 6–48 Adding Trend Logs Using the Line Properties Dialog ....................... 6–49 Viewing a Multi-Trend ....................................................................... 6–49 CHANGING THE MULTI-TREND DISPLAY APPEARANCE ..................................... 6–50 Changing the Line Color for a Trend Log .......................................... 6–50 Changing the Monitored Axis of an Analog Value ............................. 6–50 Changing the Sampling Interval for a Multi-Trend ............................ 6–50 Changing the Y1 or Y2 Axis Titles ...................................................... 6–51 MAINTAINING ARCHIVE TREND LOGS ............................................... 6–52 Enabling or Disabling an Archive Trend Log .................................... 6–52 Updating Database Samples .............................................................. 6–52 Changing the Name of an Archive TL ................................................ 6–53 Deleting Archive TLs .......................................................................... 6–53 PERFORMING BASIC TROUBLESHOOTING USING HS.................... 6–54 TROUBLESHOOTING TAB ................................................................................... 6–54 HIGH USAGE TREND LOGS DATAVIEW .............................................................. 6–56 TREND LOGS WITH INSUFFICIENT SAMPLES DATAVIEW .................................... 6–58 MISSED SAMPLES: INTERMITTENT HIGH DATA RATE PROBLEMS ...................... 6–59 IMPROVING HISTORIAN PERFORMANCE............................................................. 6–60 Avoiding Missed Samples ................................................................... 6–60 Investigate Communication Issues Using HistLog File ...................... 6–61 TROUBLESHOOTING HISTORIAN DEVICE ......................................... 6–62 DETERMINING HISTORIAN’S CONNECTION STATUS ........................................... 6–62 Historian Connection ......................................................................... 6–62 FREQUENTLY ASKED QUESTIONS ...................................................................... 6–63 Why Are No Samples Collected When Updating an Archive TL? ...... 6–63 What Does it Mean When an Archive TL Shows “Fault”? ................ 6–64 What Does it Mean When the Archive TL is “Detached”? ................ 6–65 What Might be the Cause When an Archive TL is Disabled? ............. 6–66 What Happens When Running Historian and ORCAview on the Same PC? ..................................................................................................... 6–66 USING HISTORIAN’S DATABASE TABLES ........................................................... 6–67 ACEvent .............................................................................................. 6–67 DevOff ................................................................................................ 6–68 Enum_BAC_AC_Event ....................................................................... 6–68 EVL ..................................................................................................... 6–68 EVLData ............................................................................................. 6–69 EVLFilters Table ................................................................................ 6–72 Historian............................................................................................. 6–73 HistorianDebug .................................................................................. 6–73 ObjectMap .......................................................................................... 6–74 Ops ..................................................................................................... 6–74 Refnames ............................................................................................ 6–74 ScheduleInfo ....................................................................................... 6–75
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–2
Total Pages in this Section: 164
Table of Contents: Procedure List
6–3
Stats ..................................................................................................... 6–76 TL ........................................................................................................ 6–77 TLData ................................................................................................ 6–78 INTRODUCTION TO REPORTS (RPT) ..................................................... 6–80 Features .............................................................................................. 6–80 What Type of Reports are Generated .................................................. 6–80 GENERATING REPORTS ............................................................................ 6–82 CREATING A NEW REPORT ................................................................................. 6–82 CONFIGURING A QUERY REPORT ....................................................................... 6–82 Selecting Devices ................................................................................ 6–83 Using the Object Filter ....................................................................... 6–84 CUSTOMIZING THE REPORT FORMAT AND LAYOUT ........................................... 6–86 Working with Report Columns ............................................................ 6–86 Table of Common Object Properties ................................................... 6–87 Input Objects (AI, BI, MI, PI) ............................................................. 6–87 Output Objects (AO, BO) .................................................................... 6–88 Variable Objects (AV, BV, MV) .......................................................... 6–88 Totalizer Objects (AT, BT) .................................................................. 6–89 Other Objects (CO, OS, DEV, TL, EV) ............................................... 6–89 Adding a New Column ........................................................................ 6–90 Editing a Column ................................................................................ 6–91 Configuring Property, Alignment and Format Cells........................... 6–91 CREATING A TENANT BILLING REPORT ............................................................. 6–92 Configuring the Billing Time Period and Invoice Number ................. 6–93 Adding Trend Logs .............................................................................. 6–94 Editing Trend Logs.............................................................................. 6–94 Removing Trend Logs ......................................................................... 6–95 Creating Reports with Temporary Cost Adjustments .......................... 6–95 Changing Tenant Billing (transaction) Layout ................................... 6–96 Configuring the Calculation Settings .................................................. 6–96 Adding Company and Customer Billing Information.......................... 6–96 CREATING AN ACCESS CONFIGURATION REPORT .............................................. 6–97 Selecting Access Configuration........................................................... 6–97 CONFIGURING LAYOUT/DESTINATION ............................................................... 6–98 Customizing Reports ........................................................................... 6–98 Assigning a Triggered By Object ........................................................ 6–99 SELECTING REPORT DESTINATIONS ................................................................. 6–100 Adding a Printer Destination ............................................................ 6–100 Adding a File Destination ................................................................. 6–101 Adding an Email Destination ............................................................ 6–102 Editing and Removing Report Destinations ...................................... 6–103 TROUBLESHOOTING REPORTS ............................................................ 6–104 FREQUENTLY ASKED QUESTIONS .................................................................... 6–104 Content Missing from Access Configuration Reports ....................... 6–104 Query Reports Take too Long to Generate ....................................... 6–104 HISTORIAN SETTINGS (HS) OBJECT [COPY] .................................... 6–105 HEADER ........................................................................................................... 6–105 Object Mode ...................................................................................... 6–105 STATS............................................................................................................... 6–107 Historian Uptime .............................................................................. 6–107 Historical Trend Log Count .............................................................. 6–107 Processing Time ................................................................................ 6–107
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–3
6–4
Trending, Archiving & Reporting Configuring DSN for Microsoft SQL Server .................................... 6–108 Configuring DSN for MySQL ........................................................... 6–109 TROUBLESHOOTING ......................................................................................... 6–110 Troubleshooting Tab ........................................................................ 6–110 Missed Samples: Intermittent High Data Rate Problems ................. 6–115 SETUP .............................................................................................................. 6–116 Log File Path .................................................................................... 6–116 Auto Logon ....................................................................................... 6–117 Maximum Poll Interval ..................................................................... 6–117 ODBC Info ........................................................................................ 6–117 HISTORICAL TREND LOG (ARCHIVED TL) OBJECT [COPY] ....... 6–118 HEADER ........................................................................................................... 6–118 Samples............................................................................................. 6–119 Update Button................................................................................... 6–119 GRAPH ............................................................................................................. 6–119 SETUP .............................................................................................................. 6–120 Name................................................................................................. 6–122 HVAC, Access, and Lighting Checkboxes ........................................ 6–122 Monitored Object ............................................................................. 6–122 Log Type ........................................................................................... 6–122 Log Interval ...................................................................................... 6–123 Max Samples..................................................................................... 6–123 Total Samples ................................................................................... 6–123 Disable When Full ............................................................................ 6–123 Start Trend At ................................................................................... 6–123 Stop Trend At .................................................................................... 6–123 DATA ............................................................................................................... 6–124 DESCRIPTION ................................................................................................... 6–125 TREND LOG – BACNET (TL) OBJECT [COPY] ................................... 6–126 HEADER ........................................................................................................... 6–127 Object Mode and Object Value ........................................................ 6–127 Started Trend At ............................................................................... 6–127 Stop Trend At .................................................................................... 6–127 Samples............................................................................................. 6–128 GRAPH ............................................................................................................. 6–128 SETUP .............................................................................................................. 6–129 Name................................................................................................. 6–129 HVAC, Access, and Lighting Checkboxes ........................................ 6–129 Monitored Object ............................................................................. 6–130 Log Type ........................................................................................... 6–131 Log Interval ...................................................................................... 6–132 Daily Checkbox ................................................................................ 6–132 Max Samples..................................................................................... 6–133 Total Samples ................................................................................... 6–133 Disable When Full ............................................................................ 6–133 Start Trend At ................................................................................... 6–133 Stop Trend At .................................................................................... 6–134 Archived (not editable greyed out in V3.40) ..................................... 6–134 Archival Buffer Notification Setup ................................................... 6–135 DATA ............................................................................................................... 6–136 Reset Samples Button ....................................................................... 6–137 DESCRIPTION ................................................................................................... 6–138 MULTI-TREND (MT) OBJECT [COPY] .................................................. 6–139
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–4
Total Pages in this Section: 164
Table of Contents: Procedure List
6–5
MULTI-TREND COMPONENTS ........................................................................... 6–139 Graph Area ....................................................................................... 6–140 Dataview ........................................................................................... 6–140 Slider Bar .......................................................................................... 6–141 Axes ................................................................................................... 6–142 TOOLBAR COMPONENTS .................................................................................. 6–142 TL Setup ............................................................................................ 6–142 Axis.................................................................................................... 6–143 Settings .............................................................................................. 6–145 Auto (Entire History) ........................................................................ 6–146 Setstart (History from Start Time)..................................................... 6–146 Range (Moving Frame) ..................................................................... 6–147 Pause ................................................................................................. 6–147 Back and Fwd ................................................................................... 6–147 Zoom in and Zoom out ...................................................................... 6–147 Print .................................................................................................. 6–147 Save ................................................................................................... 6–148 REPORTS (RPT) OBJECT [COPY]........................................................... 6–149 REPORT SETUP ................................................................................................. 6–149 Report Type Menu ............................................................................. 6–150 QUERY SETUP .................................................................................................. 6–151 Devices .............................................................................................. 6–151 Object Filter ...................................................................................... 6–152 Report Format ................................................................................... 6–153 TENANT BILLING SETUP................................................................................... 6–155 Period................................................................................................ 6–155 Invoice # ............................................................................................ 6–156 Trend Logs ........................................................................................ 6–156 Up and Down Arrows ....................................................................... 6–156 Add Button ........................................................................................ 6–157 Edit Button ........................................................................................ 6–157 Remove Button .................................................................................. 6–157 Calculation Settings Field ................................................................. 6–158 Company Info and Billing Info .......................................................... 6–158 ACCESS CONFIGURATION SETUP ...................................................................... 6–158 Devices .............................................................................................. 6–160 Object Filter ...................................................................................... 6–161 LAYOUT/DESTINATION .................................................................................... 6–162 Name ................................................................................................. 6–162 Title ................................................................................................... 6–162 Notes ................................................................................................. 6–162 Footnote ............................................................................................ 6–163 Triggered By ..................................................................................... 6–163 DESTINATIONS ................................................................................................. 6–163 Add .................................................................................................... 6–163 Edit .................................................................................................... 6–164 Remove .............................................................................................. 6–164 DESCRIPTION ................................................................................................... 6–164
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–5
6–6
Trending, Archiving & Reporting
Table of Contents: Procedure List INTRODUCTION ............................................................................................ 6–9 INTRODUCTION TO HISTORIAN ............................................................ 6–11 To select a Trend for archiving in V3.40: ............................. 6–15 INSTALLING HISTORIAN ......................................................................... 6–18 To install Historian from the ORCA Suite CD: .................... 6–19 To install Historian from the desktop: .................................. 6–19 To stop or restart Historian Service: ..................................... 6–20 To change Historian Startup Type: ....................................... 6–22 HISTORIAN SETTINGS (HS)...................................................................... 6–24 To open the Historian Settings object: .................................. 6–24 To specify the database name in the DSN for Microsoft SQL server: ..................................................................... 6–29 To change the DBMS: .......................................................... 6–31 To set up the DSN: ............................................................... 6–32 To set the UserID and Password for Historian with MySQL: .......................................................................... 6–33 To view Historian’s Status from a remote OWS: ................. 6–36 To view the Historian Status dialog on the Historian PC: .... 6–36 DOES HISTORIAN ARCHIVE EVENTS IN EVLS? ................................ 6–38 TREND LOG (TL) ......................................................................................... 6–42 To configure a Trend Log object: ......................................... 6–43 To configure a Trend Log for archiving from the Navigator window: .......................................................... 6–43 To change the Log Type in a Trend Log: ............................. 6–44 To clear the databuffer of a TL using the Reset Samples button: ............................................................................. 6–45 To clear the databuffer of multiple TL’s using the Reset command: ........................................................................ 6–45 To set up the TL to stop when full: ....................................... 6–45 To set a specific start or stop time for a TL: ......................... 6–45 To change the Max Samples field in a Trend Log: ............... 6–46 MULTI-TREND (MT) ................................................................................... 6–47 To create a Multi-Trend object: ............................................ 6–48 To add a Trend Log using the Line Properties Dialog: ......... 6–49 To view all available TL data in a Multi Trend: ................... 6–49 To define a specific line color for each Trend Log: .............. 6–50 To change the monitoring of an analog value to the Y2 Axis: ................................................................................ 6–50 To change the interval at which new TL data samples are retrieved by an MT:......................................................... 6–50 To change the title for the Y1 or Y2 axis:............................. 6–51 MAINTAINING ARCHIVE TREND LOGS ............................................... 6–52 To enable or disable an Archive Trend Log: ........................ 6–52
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–6
Total Pages in this Section: 164
Table of Contents: Procedure List
6–7
To update the data samples from the source TL in the Archive TL: ..................................................................... 6–52 To change the name of an Archive Trend Log: ..................... 6–53 PERFORMING BASIC TROUBLESHOOTING USING HS .................... 6–54 To reduce the occurrence of missed samples in Historian: ... 6–60 TROUBLESHOOTING HISTORIAN DEVICE.......................................... 6–62 To view Historian’s Connection to Delta Server on local Historian PC: ................................................................... 6–62 To view the Historian Status on a remote server from a local PC: .......................................................................... 6–63 To check if the source TL is Disabled or In Fault in Details view: .................................................................... 6–63 INTRODUCTION TO REPORTS (RPT) ..................................................... 6–80 GENERATING REPORTS ............................................................................ 6–82 To create a new Report:......................................................... 6–82 To configure a Query Report:................................................ 6–82 To apply object filter criteria to all devices (V2 and BACnet):.......................................................................... 6–83 To apply object filter criteria within an area: ........................ 6–83 To apply object filter criteria to a system or a subnet device: ............................................................................. 6–84 To apply object filter criteria to a Specific Device: ............... 6–84 To apply object filter criteria to a range of BACnet Devices: ........................................................................... 6–84 To apply object filter criteria to V2 devices: ......................... 6–84 In the Report format section: ................................................. 6–86 To add a new column: ........................................................... 6–90 To edit a column:................................................................... 6–91 To edit a column’s property settings: .................................... 6–91 To configure a column’s alignment:...................................... 6–91 Changing the visible decimal place for numeric values: ....... 6–91 Changing the settings to display a binary state as text. ......... 6–92 To create a new Tenant Billing report: .................................. 6–93 To configure a Tenant Billing report time period:................. 6–93 To configure the invoice number: ......................................... 6–94 To add a trend log: ................................................................ 6–94 To edit a trend log entry: ....................................................... 6–95 To remove a Trend Log entry:............................................... 6–95 To create a temporary cost adjustment: ................................. 6–95 To change the Tenant Billing transaction layout: .................. 6–96 To configure the minimum charge per transaction: ............... 6–96 To set the roundup to the nearest minute:.............................. 6–96 To set the Tax percentage:..................................................... 6–96 To add Company and Billing information:............................ 6–97 To select an Access Configuration report: ............................ 6–97 To add information to a report: ............................................. 6–98 To assign a Triggered By object:........................................... 6–99 To add a Printer destination: ............................................... 6–100 To add a File destination using the Filename field: ............. 6–101 To add a File destination using the Save As… button: ....... 6–101 To add an Email destination: ............................................... 6–102 To edit report destinations: .................................................. 6–103
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–7
6–8
Trending, Archiving & Reporting To remove report destinations: ........................................... 6–103 TROUBLESHOOTING REPORTS ........................................................... 6–104 HISTORIAN SETTINGS (HS) OBJECT [COPY] .................................... 6–105 To specify the database name in the DSN for Microsoft SQL server: ................................................................... 6–108 HISTORICAL TREND LOG (ARCHIVED TL) OBJECT [COPY] ....... 6–118 TREND LOG – BACNET (TL) OBJECT [COPY] ................................... 6–126 To change the monitored object of a TL that is being archived: ........................................................................ 6–130 To select a Trend for archiving in V3.40: ........................... 6–135 MULTI-TREND (MT) OBJECT [COPY] .................................................. 6–139 REPORTS (RPT) OBJECT [COPY] .......................................................... 6–149
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–8
Total Pages in this Section: 164
Table of Contents: Procedure List
6–9
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 MultiTrend (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. The rest of this Chapter covers the following: •
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.
Note: Chapter 10 of the ORCAview Technical Reference Manual provides
information on the TL, MT, HS and the RPT objects, including a detailed description of all of their tabs and fields. This chapter includes copies of these objects at the end. The intention is to include all relevant information in one document so that it is more convenient to use. For installation information, see the Configuring Historian section starting on page 6–24 and also the Installing Historian section starting on page 6–18.
Intended Audience The intended audience for this section of the ORCAview Technical Reference Manual is as follows:
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–9
6–10
Trending, Archiving & Reporting •
Facility Managers
•
Application Engineers
•
Service Personnel
•
Supervisors
•
Security Personnel
•
Operations Staff
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–10
Total Pages in this Section: 164
Table of Contents: Procedure List
6–11
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). An Archive Trend Log (Archive TL) is an archival backup of a regular BACnet Trend Log with a theoretically unlimited maximum number of samples. The Historian Device updates archived TLs, at calculated intervals, by gathering data from the source TL. We use Archive Trend Log to distinguish between a regular TL and one that exists on Historian. The preferred term is Archive Trend Log rather than Historical Trend Log (HTL). 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. The Historian Device can be used to do any of the following: •
Analyze data over extended periods of time, years if desired.
•
Generate reports using standard reporting tools such as Microsoft Excel®, or Crystal Reports®.
•
Keep extended records of system values and user / event logs.
•
Investigate equipment failure.
•
Tune control loops.
•
Review information from any Operator Workstation (OWS).
•
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.
Features
A detailed description of ODBC is included in the section entitled, What is Historian’s ODBC database? starting on page 6–17.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–11
6–12
Trending, Archiving & Reporting
System Requirements To use Historian, ORCAview must be installed on the system. To run Historian software, the minimum PC requirements are as follows: Operating System
Windows XP / Windows 2003 Server / Vista / Windows 7
Processor
Intel Pentium 4 - 2 GHz
RAM
1 GB
Disk drives
CD-ROM drive
Hard disk space
250 GB of free space (Historian requires significantly more space than ORCAview alone.)
Other recommendations
Video Settings running at 1024 x 768 with 16 bit color
Delta Controls recommends the following minimum system configuration to make the most effective use of our Historian software. Operating System
Windows Vista / Windows 7
Processor
Intel Core 2 Duo - 2.6 GHz
RAM
4 GB
Disk drives
CD-ROM drive
Hard disk space
500 GB of free space (Historian requires significantly more space than ORCAview alone.)
Other recommendations
Video Settings running at 1280 x 1024 resolution with 32-bit color
Historian Database Growth and Management Historian's database size and rate of growth are dependent on the configuration and nature of a given site. The size and rate of growth are also dependent on the number of TLs archived, how fast the data is sampled, the amount of event/alarm entries logged, whether events/alarms are coming from HVAC/Lighting and/or Access controls, and on the type of DBMS that Historian is using. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–12
Total Pages in this Section: 164
Multiple Historians Supported in Version 3.40
6–13
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 Level
Trend Log Objects (1 data sample per TL every 10 min. on avg.)
Event Log
Event Log
DB Size
DB Size
DB Size
- HVAC / Lighting
- Access Control
(1 month)
(6 months)
(entries per day on avg.)
(in MB)
(in MB)
(12 months)
(entries per day on avg.)
(in MB)
Small
50
75
150
≈ 23.92
≈ 138.7
≈ 280.3
Medium
250
300
350
≈ 112.6
≈ 670.3
≈ 1358.2
Server
1000
500
1000
≈ 434.3
≈ 2597.9
≈ 5266.5
Multiple Historians Supported in Version 3.40 With V3.40, multiple Historians are supported: •
The intension is to provide additional trending capacity on large sites.
•
Each historian must refer to its own SQL database. You cannot have multiple historians referencing the same SQL database.
•
It is technically possible to archive a trend to multiple historians but this is not the intent, and is not supported in V3.40.
How Historian Works This section explains the following: •
How Historian connects to a BACnet network.
•
How Archive TLs and source TLs differ.
•
How Historian gathers data for archiving.
•
How the ODBC database functions.
How Does Historian Connect to the Network? Historian connects to a network of BACnet controllers, in the same way as ORCAview, using the Delta Server. Historian can connect to a network using either a UDP/IP or an Ethernet connection. Historian appears as a controller in the network tree of the Navigator window, and is referred to as the Historian Device. Historian is a Windows service, a program that runs as a background process. Historian is set by default to run automatically at system startup. This means that in the event of a power failure, Historian can start automatically without requiring any user input or logon when the power returns. Historian can run simultaneously on the same PC as ORCAview and ORCAweb. If this is the case, only one instance of the Delta Server is started. This means that these three programs share the same connection to the network.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–13
6–14
Trending, Archiving & Reporting
What is an Archive TL and How is it Created? An Archive TL is a special version of a standard BACnet TL that displays archived data stored in Historian's database for a single source TL which is located on a controller. Historian gathers all the data that is accumulated in source TLs marked for archiving, and then stores the data in an ODBC database.` 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.
Selecting TL's to Archive in Version 3.40 V3.40 now supports multiple Historians on one site and as a result the Archived checkbox on the Setup tab of the Trend Log is not editable and is grayed out. Previously in V3.33, selecting this checkbox and pressing Apply or OK provided one of the methods to mark a trend for archiving. The active V3.33 Historian would then add this trend to its database as shown in the following Version 3.33 figure.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–14
Total Pages in this Section: 164
How Historian Works
6–15
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.
To select a Trend for archiving in V3.40:
1
Right click on a selected trend or trends in a device's object list in the right pane of Navigator.
2
Select Command on the menu.
3
From the Command submenu, click 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–15
6–16
Trending, Archiving & Reporting
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.
How are Archive TL's Named? An Archive TLs name is based on the source TL name. If a source TL (on device 100) with the name AHU1 SAT TL is marked for archiving, then Historian names the associated Archive TL 100_AHU1 SAT TL Archive. The device number plus an underscore is added to the beginning of the source TL name and Archive is appended to the end of the name. You can rename any source TL or Archived TL and Historian will continue to function normally.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–16
Total Pages in this Section: 164
How Historian Works
6–17
How Does Historian Gather Data for Archiving Historian determines how to gather data from source TLs based on their configuration. The three types of configurations are: •
Polling TLs Supported
•
Change of Value (COV) TLs (with Buffer Ready Notification) Supported
•
Change of Value (COV) TLs (without Buffer Ready Notification) Not Supported
Historian uses a scheduling algorithm to determine data gathering intervals for both Polling TLs, and COV TLs. Historian's poll intervals are calculated to ensure that no data points are "missed" from any Polling or COV TL’s. This allows the Historian Device to maintain a comprehensive archive of data. 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. If Historian receives a Buffer Ready Notification from any COV TL that is archived, it gathers and archives the new samples, and then reschedules the next polling of the TL. In the HS object, a maximum polling interval can be specified (default 24 hours), limiting the amount of time a TL can go without being polled for data. If Historian's calculated poll interval is greater than the maximum poll interval, the next poll will be scheduled according to the maximum poll interval. If Historian has not received a notification for a period of time greater than the maximum poll interval, for a COV TL (with Buffer Ready Notification), Historian will poll the TL and collect its samples.
What is Historian’s ODBC Database? ODBC (Open Database Connectivity) is a widely accepted Application Programming Interface (API) for database access. ODBC is an industry standard for communication that allows user programs to access data from a variety of Database Management Systems (DBMS) through a single interface. ODBC accepts Structured Query Language (SQL) from user programs, and then translates the information into a form that can be read by the target database. 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. Once a TL is archived, Historian creates a connection to an ODBC database, and then generates entries for that TL. Historical data from the source TL is then stored in these tables.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–17
6–18
Trending, Archiving & Reporting
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. Refer to Chapter 01 -- Introduction of the ORCAview Technical Reference Manual for more information on using the ORCA 3.40 Suite Installer.
The releases build will be later than 3051.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–18
Total Pages in this Section: 164
Installation
6–19
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.
To install Historian from the ORCA Suite CD:
•
Insert the CD-ROM. If the autorun brings up the interface, select the installer and follow the instructions to complete the installation process
.OR: 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.
To install Historian from the desktop:
1
Click on the ORCA Suite folder that you downloaded.
2
Use the My Computer icon or the Explorer view to find the ORCA Suite Setup.exe file.
3
Double-click the ORCA Suite Setup.exe file to start the Suite Installer.
4
Follow the instructions from the Welcome screen to complete the installation process.
Because Historian requires access to a large database, a Database Management System (DBMS) is included with Historian. The default DBMS included with 3.40 is Microsoft SQL Server 2005 Express which the installer prompts you to let it install automatically. If Microsoft SQL Server 2005 Express or SQL Server is already on the system, you may not need to install a DBMS.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–19
6–20
Trending, Archiving & Reporting 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.
Stop or Restart Historian Service By default, the Historian service is configured to run automatically on system startup. 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. Since Historian is now a Windows service rather than an application, it is no longer possible to start using the previous Start | Programs | Delta Controls | 3.33 | Historian. To stop or restart Historian Service:
1.
Click on the Start menu, select Settings and then click on Control Panel.
2.
Double click on Administrative Tools.
3.
Select Services and double click on the icon.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–20
Total Pages in this Section: 164
Stop or Restart Historian Service
Total Pages in this Section: 164
6–21
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–21
6–22
Trending, Archiving & Reporting
Changing Historian Startup Behavior By default, the Historian service is configured to run automatically on system startup. It is highly recommended to use the Automatic Startup type. For troubleshooting purposes, it is possible to configure Historian so that it does not automatically start when the Historian PC is powered up. For normal operation, Automatic Startup is the best startup behavior to use. To change Historian Startup Type:
1
From the Windows Services dialog, select Delta Historian, then right click and select Properties.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–22
Total Pages in this Section: 164
Changing Historian Startup Behavior
Total Pages in this Section: 164
2
Select the desired Startup Type.
3
Click OK.
6–23
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–23
6–24
Trending, Archiving & Reporting
HISTORIAN SETTINGS (HS) The Historian Settings object (HS) provides access to the setup options and status information for the Historian Device. The HS object is automatically created the first time Historian is started, and is accessible from any Delta Operator Workstation (OWS) on the network. This section covers installing Historian, securing the database, logging in and viewing Historian’s status. For reference information on the fields of the HS object, see the copies of relevant object at the end of this document or Chapter 10 Software Object Reference of the ORCAview Technical Reference manual.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–24
Total Pages in this Section: 164
Configuring Historian
6–25
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–25
6–26
Trending, Archiving & Reporting 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.
A problem with Insufficient Samples may be due to the configuration of the source Trend Log or changes in the characteristics of the monitored signal. The typical solution involves 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–26
Total Pages in this Section: 164
Configuring Historian
6–27
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. Note: Before increasing the Max Samples, it is recommended to do a forced
update to ensure that all the current data in the buffer is archived by Historian. To update, press the Update button in the header of an Archive TL. If the Max Samples (buffer size) is increased beyond the available memory on the controller, the entire buffer is purged. A forced update avoids this possible data loss.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–27
6–28
Trending, Archiving & Reporting
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.
Configuring DSN for Microsoft SQL Server In order for the Statistics and Troubleshooting information to show in the HS object, you must specify the database name in the DSN. It is assumed that the HS dialog specifies a database name and that Historian has run and created this database. The HS dialog needs to reflect all the changes done with the ODBC data source.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–28
Total Pages in this Section: 164
Configuring Historian
6–29
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:
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–29
6–30
Trending, Archiving & Reporting
14 Click OK three times to close all dialogs.
Configuring DSN for MySQL To configure the DSN for MySQL, you need to download and install two tools. •
MySQL Connector
•
MySQL Server
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.
Changing the Database Management System Historian can be installed with a default DBMS (MS SQL Server 2005 Express), and its settings are displayed in the ODBC Info section of the Historian Settings dialog. When using Microsoft SQL Server 2005 Express, SQL Server should be selected from the Driver menu. For all versions of Microsoft SQL Server, set the driver as SQL Server. 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. Historian creates the HistorianDB database automatically.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–30
Total Pages in this Section: 164
Changing the Database Management System
6–31
To change the DBMS:
1.
Stop the Historian Service
2.
From the Setup tab of the HS object, select the appropriate driver for the DBMS being used. For example, SQL Server, or My SQL.
3.
If the default DB Name is not being used, type a new database name in the DB Name box.
4.
In the DSN box, type the name of the DSN that Historian uses to connect to the database. Open the Data Sources (ODBC) dialog. 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 site provides vital configuration information. See http://support.microsoft.com/kb/942976
5.
In the UserID box, type the valid user name.
6.
In the Password field, type the valid password.
7.
Click Apply or OK.
8.
You must properly shut down ORCAview / Delta Siserver for your changes to be saved. When Historian is started, it uses your new HS settings.
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. Historian supports selected MySQL/ ODBC Connector versions. Refer to release information for a list of supported versions.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–31
6–32
Trending, Archiving & Reporting
Setting the MySQL DSN
In order for the Statistics and Troubleshooting information in to show in the HS object you must specify the database name in the DSN.
To set up the DSN:
1.
Open the Data Sources (ODBC) dialog. 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 site provides vital configuration information. See http://support.microsoft.com/kb/942976
2.
In the ODBC Data Source Administrator dialog, select the System DSN tab, and then click Add.
3.
In the Create New Data Source dialog, select the MySQL or other supported ODBC Driver and then click Finish.
4.
Fill in the following fields in the open dialog with values that suit your situation, and then click OK. For example, these values might be entered: Data Source Name: HistDSN_MySQL Server: localhost User: root Password: password (use the password assigned to the root user) Database: HistorianDB 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.
•
•
In the previous information, HistDSN_MySQL is just an example of a possible Data Source Name
5.
Add Connection Pooling for the ODBC connection: (Historian needs connection pooling in order to work.)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–32
Total Pages in this Section: 164
Changing the Database Management System a. b. c. 6.
6–33
From ODBC Data Source Administrator, select the Connection Pooling tab. Open the MySQL ODBC x.x Driver Select the driver, and set Pool Connections to 60 seconds.
Click OK twice.
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. Connection pooling aims to enhance performance of executing database commands by using less connection resources. When a connection is kept alive and placed in the connection pool, an ODBC application can reuse the same driver and the connection without performing the complete creation and connection process again. If all the connections in the pool are being used, new connections are created and made available through the pool.
ODBC 3.0 or later supports connection pooling. When using the connector/ODBC x.x with MySQL Database, you must have Connection Pooling enabled. To enable connection pooling: 1.
Open the Data Sources (ODBC) dialog. 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 site provides vital configuration information. See http://support.microsoft.com/kb/942976
2.
On the Connection Pooling Tab find and double click on MySQL ODBC x.x Driver.
3.
Enable “Pool Connections to this driver”
To set the UserID and Password for Historian with MySQL:
1.
Total Pages in this Section: 164
If Historian is running, stop the Historian service using the Windows Control Panel| Administrative Tools| Services. Start ORCAview, and then open the OWS.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–33
6–34
Trending, Archiving & Reporting 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.
4.
In the ODBC Info fields, change the Driver to MySQL.
5.
Click Apply or OK.
6.
Exit the OWS in order to save the changes.
7.
Restart the Historian service.
8.
When you start Historian, it will create a new database with the HistorianDB name. You need to configure the DSN on the Setup tab of the HS object so that it points to the new database. The HS Stats and Troubleshooting tabs will work.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–34
Total Pages in this Section: 164
Changing the Database Management System
6–35
Securing Historian’s Database When you install the Microsoft SQL Server 2005 Express distributed with Historian, it automatically creates a system administrator account, with the username ‘sa’ and your chosen strong password. 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. Historian uses the UserID sa with MS SQL Server Express as it is created by default and avoids any complexity involved in creating new SQL users. This approach makes it easier to get Historian installed and running. Getting Historian to use root and sa is easier for less advanced users. A database administrator would typically create new users that Historian could use. Note: Do not forget the new password. If you cannot provide the correct
password, you must re-install either SQL Server or MySQL.
Changing Password for MS SQL Server 2005 Express/ SQL Server The internet offers resources and free tools that make changing the password easier for SQL Server or MS SQL Server 2005 Express. 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-4BD14E3D-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
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–35
6–36
Trending, Archiving & Reporting
Viewing Historian’s Status The Historian’s current mode of operation is displayed locally from the system tray or remotely using the HS object status and in Navigator when viewing the Historian device’s HS object. To view Historian’s Status from a remote OWS:
•
Use ORCAview to open Historian’s HS object. The header shows Historian’s current Status.
To view the Historian Status dialog on the Historian PC:
The Historian Status dialog contains information on the connection to the Delta Server and Historian’s current mode of operation. •
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.
Connection to Delta Server
The Connection to Delta Server field displays either: Connected Historian is connected and logged onto 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. When Historian loses its connection to the Delta Server, it periodically attempts to reconnect to resume normal operations.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–36
Total Pages in this Section: 164
Changing the Database Management System
6–37
Historian’s Status Modes Historian Status information is available from the Historian Status dialog on a local PC or from the header of the HS object. There are five different Historian Status modes, and they 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 Trend Logs that are being archived. Once the archiving is complete Historian goes into sleeping mode. Sleeping Historian is “waiting” until archiving needs to be performed, at which point it transitions into scheduling mode. Scheduling Historian is “calculating” which TLs it will poll during its next archiving phase. Stopped Historian is connected to the network, but is not running. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–37
6–38
Trending, Archiving & Reporting
DOES HISTORIAN ARCHIVE EVENTS IN EVLS? By default Historian contains three EVLs: •
EVL1 "Alarm Log" logs EVC’s 1-6.
•
EVL2 "Access Control Event Log" logs EVC 7.
•
EVL3 "Access Control Alarm Log" logs EVC 8.
Event Logs (EVLs) can also be created on the Historian Device. Once an EVL is created, all events recorded by that EVL are stored directly into the Historian’s database. The only setup required is to create the EVL on the Historian Device. 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. If Historian is using a remote database and the connection to the database is interrupted, Historian goes into fault but it still logs events / alarms in a local database. These events / alarms can be merged into the SQL database at a later time. If Historian goes offline, then nothing is logged.
Setting up Confirmed Event and Alarm Transmissions to Historian This section outlines the necessary steps to set up confirmed Access Control event and alarm transmissions to Historian. This setup is required to record all events and alarms in the event of a network miscommunication or fault. OWS 3.30 or higher software and 3.30 or higher firmware is required for confirmed events and alarms function with 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, The following sequence of operation is used: 1
Locate your Historian
2
Choose a controller
3
Setup Access Control Event (EVC7)
4
Setup Access Control Alarm (EVC8)
5
Save Database to Flash and/or File.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–38
Total Pages in this Section: 164
Setting up Confirmed Event and Alarm Transmissions to Historian
6–39
1) Locate your Historian Confirm that your historian is actually online and shows up in Navigator. 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.
3) Setup Access Control Event (EVC7) Open the Access Control Event (EVC7) object and click on the Destination List tab. You will see something like the following figure:
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
Double click and check the following checkboxes:
Total Pages in this Section: 164
•
Retry
•
Confirm Transmission
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–39
6–40
Trending, Archiving & Reporting You should now see something like the following figure:
•
Click OK or Apply to save your changes.
4) Setup Access Control Alarm (EVC8) Open the Access Control Alarm (EVC8) object and click on the Destination List tab. You will see something like the following figure:
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–40
Total Pages in this Section: 164
Setting up Confirmed Event and Alarm Transmissions to Historian
6–41
Double click and check the following checkboxes: •
Retry
•
Confirm Transmission
You should now see something like the following figure:
Click OK or Apply to save your changes.
5) Save Database to Flash and/or File After each controller is set up for confirmed transmission, the database should be saved to file (which saves it to flash as well). At a minimum the database should be saved to flash. To configure non-access EVC’s, you would repeat the confirmed transmission process shown here but for other EVC’s besides EVC7 and EVC8,
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–41
6–42
Trending, Archiving & Reporting
TREND LOG (TL) The Trend Log (TL) object stores data for one monitored object, and can be set to collect data in two ways: •
Change of Value (COV)
•
Polled
Change of Value TLs use the monitored object's COV minimum increment to determine when to take a new sample. When the monitored object's value changes by the COV minimum increment or more, 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 in the monitored object’s dialog. 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 Trend Logs When a Historian Device is on the network, users can create Archives for Trend Logs. An Archive TL is an archival backup of a regular BACnet Trend Log (source TL) with a theoretically unlimited maximum number of samples. The preferred term is Archive Trend Log rather than Historical Trend Log. The Historian Device updates Archive TLs at calculated intervals by gathering data from the source TL into an ODBC database. The information from the database can be viewed in the associated Archive TL. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–42
Total Pages in this Section: 164
Archive Trend Logs
6–43
Configuring a Trend Log The Trend Log (TL) object stores the data for a single object over a period of time. This allows the user to tune and verify system operations, and correct short-term or long-term operation issues.
Creating a Trend Log Object To configure a Trend Log object:
1.
In the Navigator window, on the left pane, right-click the Controller and select New.
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:
5.
•
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.
Click Apply or OK.
Archiving Trend Logs To configure a Trend Log for archiving from the Navigator window:
•
Total Pages in this Section: 164
In Navigator, right-click the Trend Log, point to Command, and then click Add to Historian. (To add more than one Trend log, hold the SHIFT key down and then click to highlight the desired Trend Logs and then click Command | Add to Historian)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–43
6–44
Trending, Archiving & Reporting
Changing the Log Type in a Trend Log By changing the Log Type in a TL, users can specify how the TL collects data. There are two types of data collection methods for TLs, Polling or Change Of Value (COV). 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. To change the Log Type in a Trend Log:
1.
In the Navigator window, double-click to open the TL, and then click the Setup tab.
2.
From the Log Type drop-down menu, select Polling or Change Of Value.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–44
Total Pages in this Section: 164
Archive Trend Logs
3.
If the Log Type is Polling, select a Log Interval.
4.
Click Apply or OK.
6–45
Clearing the Databuffer of a Trend Log After commissioning a system, or when a new database has been loaded into a controller, a user may want to purge the TL contents of the data that is no longer meaningful. The Reset command in Navigator provides a quick way to clear the databuffer of multiple selected TL’s. 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.
To clear the databuffer of a TL using the Reset Samples button:
1.
Double-click to open the Trend Log.
2.
Click the Data tab.
3.
On the Data tab, click Reset Samples
4.
Click Apply or OK.
.
To clear the databuffer of multiple TL’s using the Reset command:
1
In the Navigator right pane, select one or more Trend Logs.
2
Right click and select Command and then click Reset
Setting up a Trend Log to Stop When Full To prevent any data samples from being overwritten, a TL can be configured to stop gathering data samples after the buffer is full. To set up the TL to stop when full:
1.
Double-click to open the Trend Log.
2.
Click the Setup tab.
3.
Select the Disable When Full checkbox.
4.
Click Apply or OK.
Setting Start or Stop Time for a Trend Log To collect data during specific times, configure the TL from the Setup tab. To set a specific start or stop time for a TL:
Total Pages in this Section: 164
1.
Double-click to open the Trend Log.
2.
Click the Setup tab.
3.
In the Start Trend At field, enter the start time.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–45
6–46
Trending, Archiving & Reporting 4.
In the Stop Trend At field, enter the stop time.
5.
Click Apply or OK.
Changing Maximum Samples in a Trend Log To save space in the database of a device, a TL can be configured to hold fewer samples. When the number of samples is decreased, the oldest data in the TL is discarded. Alternately, a TL may also need to be configured to hold more providing a larger history of the data. 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. To change the Max Samples field in a Trend Log:
1.
Double-click to open the Trend Log.
2.
Click the Setup tab.
3.
In the Max. Samples field, enter the new buffer size.
4.
Click Apply or OK.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–46
Total Pages in this Section: 164
Archive Trend Logs
6–47
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–47
6–48
Trending, Archiving & Reporting
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.
Creating a Multi-Trend Object To create a Multi-Trend object:
1.
In the Navigator window, on the left pane, right-click the Controller and select New.
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 MultiTrend dialog window. The Multi-Trend will start graphing the Trend Logs automatically.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–48
Total Pages in this Section: 164
Archive Trend Logs
6–49
Adding Trend Logs Using the Line Properties Dialog To add a Trend Log using the Line Properties Dialog:
1.
To open the Line Properties dialog, click the TL button on the Multi-Trend toolbar.
2.
Select one of the eight Trend Log tabs.
3.
In the Trend box, do one of the following: •
Enter a Trend Log name.
•
Enter an object reference.
4.
For Analog Trend logs, select axis Y1 or Y2 to plot the data.
5.
Click Apply. Repeat these steps to add further Trend Logs.
6.
When all the Trend Logs are defined for this Multi-Trend, click OK.
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 view all available TL data in a Multi Trend:
Total Pages in this Section: 164
1.
On the Multi-Trend toolbar, click the Auto button. This will display all available samples for each of the Trend Logs.
2.
To view a specific area, click the Zoom In button, and then use the Back and Fwd buttons to move left or right.
3.
To return to the full view, click the Auto button again.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–49
6–50
Trending, Archiving & Reporting
Changing the Multi-Trend Display Appearance This section describes how to change the line color, modify the Y1 and Y2 axis and how to change the interval at which new TL samples are retrieved by the MT object.
Changing the Line Color for a Trend Log To customize the appearance of the MT object, users can assign specific colors to each of the eight TLs added to the MT object. To define a specific line color for each Trend Log:
1.
On the Multi-Trend toolbar, click the TL Setup button.
2.
From the Line Properties Dialog, click the drop-down menu in the Graph Properties field.
3.
Select a color for the TL.
4.
To save the changes, click Apply or OK.
Changing the Monitored Axis of an Analog Value By default, using the drag-and-drop feature puts all TLs monitoring an analog value on the Y1 axis, and all TLs monitoring a binary object, on the Binary(X) Axis. An analog TL can also be graphed on the Y2 axis. To change the monitoring of an analog value to the Y2 Axis:
5.
On the Multi-Trend toolbar, click the TL Setup button.
6.
From the Line Properties Dialog, in the Axis Assignment Field, click Y2.
7.
To save the changes, click Apply or OK.
Changing the Sampling Interval for a Multi-Trend By default the sampling interval value is set to 10 seconds. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–50
Total Pages in this Section: 164
Changing the Multi-Trend Display Appearance
6–51
Changing the Y1 or Y2 Axis Titles To change the title for the Y1 or Y2 axis:
Total Pages in this Section: 164
1.
On the Multi-Trend toolbar, click the Axis button.
2.
In the Line Properties dialog, select the Y1 or Y2 tab.
3.
In the Axis Title field, type in the new axis title.
4.
To save the changes, click Apply or OK.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–51
6–52
Trending, Archiving & Reporting
MAINTAINING ARCHIVE TREND LOGS Users are able to alter the way Historian gathers information by making changes in the Setup tab of the source TL that is being archived. The following section gives examples of typical changes that can be made to maintain the Archive TLs.
Enabling or Disabling an Archive Trend Log If a user does not want Historian to archive samples from a source TL, the Archive TL can be disabled. By opening the Archive TL, users are able to control whether or not samples are sent to the database by enabling or disabling an Archive TL. 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 enable or disable an Archive Trend Log:
•
In the TL header, click the Hand icon.
Updating Database Samples The Update button allows users to instruct the Historian Device to immediately archive any new samples in the source TL to the Archive TL. 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.
3.
To start the update, click Apply or OK.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–52
Total Pages in this Section: 164
Changing the Multi-Trend Display Appearance
6–53
Changing the Name of an Archive TL When a TL is archived, the default name of the Archive TL will contain the name or number of the controller, followed by the name of the source TL. For example: if the name of a source TL on Controller 300 is, AHU1 HTG VLV TL, the default name of the Archive TL would be, 300_ AHU1 HTG VLV TL Archive. The name of an Archive TL can be changed accordingly. To change the name of an Archive Trend Log:
1.
Open the Archive TL to the Setup tab.
2.
Double-click the Name field, and then enter a different name.
3.
Click Apply or OK.
Deleting Archive TLs To prevent accidental loss of large quantities of data, Archive TLs cannot be deleted from the Navigator window. Archive TLs cannot be removed without using database management tools.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–53
6–54
Trending, Archiving & Reporting
PERFORMING BASIC TROUBLESHOOTING USING HS 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. 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. It is preferred design practice to configure a system with Historian so that it provides a reasonable margin for periodic increased data collection. If you have many Polling TL’s collecting data at high rates and many COV TL’s set to collect a sample for a small change in signal, then you will probably have issues with missed samples. With some configurations, Historian may be able to handle normal operations fine but may be unable to handle situations when the load on Historian is higher.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–54
Total Pages in this Section: 164
Troubleshooting Tab
6–55
A problem with Insufficient Samples may be due to the configuration of the source Trend Log or changes in the characteristics of the monitored signal. The typical solution involves 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. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–55
6–56
Trending, Archiving & Reporting
High Usage Trend Logs Dataview 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. 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 configuration of a Polling TL (increase Log Interval on Setup tab) or COV TL (increase COV Minimum Interval on Setup tab of monitored object) can be changed so that fewer samples are collected. You might also consider changing a Polling TL to a COV TL to avoid collecting large amounts of data with little variation in it. Note: Before increasing the Max Samples, it is recommended to do a forced
update to ensure that all the current data in the buffer is archived by Historian. To update, press the Update button in the header of an Archive TL. If the Max Samples (buffer size) is increased beyond the available memory on the controller, the entire buffer is purged. A forced update avoids this possible data loss.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–56
Total Pages in this Section: 164
High Usage Trend Logs Dataview
6–57
The following table explains the information included with a High Usage Trend Log list item. Each TL entry is followed by two numbers. Controller_number.TLinstance – First # (PollInterval), Second # (PeakRate)
For example, a good list item might be:
8000.TL1 - 3240, 1 Historian will be able to keep up with this trend. First #: (PollInterval) 3240 (Seconds between TL Archives)
The number of seconds Historian waits between successive Trend Log data collection operations. This is the PollInterval from the ScheduleInfo table in the database. Historian cannot archive a single Trend Log more than once every 120 seconds. This deliberate constraint prevents a single poorly configured Trend Log from dominating Historian’s resources. If this number is 120 seconds the Trend Log requires configuration. Practically, the further this number is from 120 the better and the actually lowest acceptable value will depend on the characteristics of your Historian site. The preferred range is from 1000 to 5000 seconds or greater. Numbers above 500 are generally acceptable.
Second #: (PeakRate) 1
The number of samples per minute that the TL accumulates. The acceptable range is from 6 to 0.125 minutes. Numbers below 1 are generally preferred.
(Samples per minute)
The following table provides general guidelines for interpreting the information included with a possible High Usage Trend Logs list item. Variable
Better is
Better
Good
Acceptable
Problems (Avoid)
Missed Samples (Avoid)
First #: (PollInterval )
Higher
86400
> 8100
> 3240
300
120
Lower
0.125
< 0.4
6
60
(Seconds between TL Archives)
Second #: (PeakRate)
(Samples per minute)
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–57
6–58
Trending, Archiving & Reporting The following table provides some examples of possible High Usage Trend Logs List Items with interpretation of the example. High Usage Trend Logs List Examples
Interpretation
8000.TL1 - 120, 60
AVOID as Missed Samples: Historian will Definitely NOT be able to keep up with this trend.
8000.TL18000.TL1 - 300, 6
AVOID as Problems: Historian may NOT be able to keep up with this trend. (Check for missed samples with HistLog.txt and view HS Troubleshooting and Stats tabs.)
8000.TL1 - 3240, 1
Acceptable: Historian may be able keep up with this trend. (Check for missed samples with HistLog.txt and view HS Troubleshooting and Stats tabs.)
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 Dataview 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. Note: Before increasing the Max Samples, it is recommended to do a forced
update to ensure that all the current data in the buffer is archived by Historian. To update, press the Update button in the header of an Archive TL. If the Max Samples (buffer size) is increased beyond the available memory on the controller, the entire buffer is purged. A forced update avoids this possible data loss. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–58
Total Pages in this Section: 164
Missed Samples: Intermittent High Data Rate Problems
6–59
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.
Missed Samples: Intermittent High Data Rate Problems Sometimes, Historian may miss samples but only for short time periods during a day. Historian may collect samples without data loss most of the day but experience some short intermittent periods where the data rate is much higher than normal causing Historian to miss samples. These trends with intermittent high sampling rates may appear on the Insufficient Samples list but only for a short time. For example, a site may have some motion detectors and Historian may not be able to keep up with these for some high traffic periods during a day. Historian has no problems with these TLs during the rest of the day. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–59
6–60
Trending, Archiving & Reporting
Improving Historian Performance This section describes ways to investigate and improve the performance of Historian by analyzing available site data. The HistLog.txt file provides information about the communications and performance of Historian. The Historian Settings (HS) object has Troubleshooting and Stats tabs that also provide useful information for troubleshooting. 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.
Avoiding Missed Samples It is possible to use available Historian performance information to make manual adjustments that avoid missed samples. The HistLog information can be used in combination with the information available on the Troubleshooting and Stats tabs of the HS object to improve the operation of a Historian site. The following procedure provides strategies to troubleshoot a site where missed samples may be an issue. To reduce the occurrence of missed samples in Historian:
3
Open the HistLog: “C:\Documents and Settings\Public\Delta Controls\3.40\Logs\HistLog.txt” or “C:\Users\Public\Delta Controls\3.40\Logs\HistLog.txt”
4
Inspect the entries and watch especially for the following error:
HistLog Entry (5 missed samples for HTL24) 08:15:37.22, 05-Jun-2009, Status = ERROR, 5 Missed Entries: HTL24
5
Open the HS object and look at the Troubleshooting tab. Compare it with the missed sample entries in the HistLog.
6
Based on this investigation, you can consider the following actions to reduce or eliminate missed samples. a. On the Setup tab of a source TL, increase the Max Samples field to provide more buffer space. Check the remaining memory in the controller on the DEV object to confirm you have enough free space to make a trend larger. b. For a COV Trend, increase the monitored object’s “COV Minimum Increment” so you get less samples per change. c. On the Setup tab of a source TL, change a COV Log Type that collects large amounts of data to a reasonable Polling Log Type at a reasonable Log Interval.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–60
Total Pages in this Section: 164
Improving Historian Performance
6–61
Investigate Communication Issues Using HistLog File The HistLog file records the time that a controller goes offline in Navigator. This information may help to solve some network communication problems. When Historian has communications problems, Trends Logs are not scheduled. For example, the HistLog might have these three entries: HistLog Entry with HistLog Explanation 18:10:07.67, 30-May-2009, Status = COMM TIMEOUT, Device 8500 is offline. All trends will be scheduled out 18:11:44.68, 30-May-2009, Status = RESUME, Device 8500 is back online. All trends will be scheduled normally 09:03:13.67, 08-Jul-2009, Status = COMM TIMEOUT, Device 700 is offline. All trends will be scheduled out
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. HistLog Entry with HistLog Explanation 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
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–61
6–62
Trending, Archiving & Reporting
TROUBLESHOOTING HISTORIAN DEVICE The following section provides some examples of issues that may arise when using the Historian device, and how to deal with these issues to maintain the Historical database.
Determining Historian’s Connection Status Before you log on to Historian, the Connection to Delta Server field displays Not Connected, and the Historian Status field displays Stopped. There are five different Historian Status modes, and they 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 Trend Logs that are being archived. Once the archiving is complete Historian goes into sleeping mode. Sleeping Historian is waiting until archiving needs to be performed, at which point it transitions into a Scheduling mode. Scheduling Historian is calculating which TLs it will poll during its next archiving phase. Stopped Historian is connected to the network, but is not running. 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. To view Historian’s Connection to Delta Server on local Historian PC:
1.
On the Windows system tray, right-click the Historian icon, and then click Status.
2.
The Historian Status dialog will show the Connection to Delta Server, and the Historian Status.
3.
The Connection to Delta Server field, will display either: •
Connected: Historian is connected and logged onto the Delta Server.
- or •
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–62
Total Pages in this Section: 164
Frequently Asked Questions
6–63
When Historian loses its connection to the Delta Server, it periodically attempts to reconnect to resume normal operations.
4.
If the Connection to Delta Server field shows Not Connected, restart Historian to establish server connection.
The Historian Status dialog also contains information on the connection to the Delta Server and Historian’s current mode of operation. To view the Historian Status on a remote server from a local PC:
•
Open Historian’s HS object. The header shows the current Status.
Frequently Asked Questions The following are some common issues that may arise when using the Historian Device.
Why Are No Samples Collected When Updating an Archive TL? If samples are not being collected, determine if the source TL, or Archive TL have been Disabled or are in Fault. To check if the source TL is Disabled or In Fault in Details view:
Total Pages in this Section: 164
1.
In the right-pane of the Navigator window, right-click in white space.
2.
From the submenu, click Details.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–63
6–64
Trending, Archiving & Reporting
3.
The Value column will display the status of the Archive TL.
What Does it Mean When an Archive TL Shows “Fault”? When an Archive TL is in Fault, an error has occurred during the last trend of that Archive TL. When you have Archived TL’s in a fault state, you can: •
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. SELECT * FROM TLData WHERE LastFailureReason IS NOT NULL
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–64
Total Pages in this Section: 164
Frequently Asked Questions
6–65
The table below contains an explanation of error codes in the Last Failure Reason column. Error Code
Basic Descriptio n
Detailed Description
Suggestions
-25
Remote device failure
The remote device is not available on the network.
Check to ensure the remote device is functioning.
-27
Remote device timeout
The remote device did not respond in the desired time – it may not be available on the network.
Check to ensure the remote device is functioning.
-84
Invalid packet
This error might result from bad wiring.
Investigate your networking issues and look for something that might be corrupting packets like bad wiring or a non functional Hub/Switch.
-127
Source TL deleted
The source TL has been deleted on the controller and the Archive TL cannot collect any more data.
Look at the controller TL and confirm it is present. If not, recreate it and it will automatically make a new Archived TL and detach your old one. Make sure you are not losing data here. 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.
-165
Database timeout
Timeout while waiting for a database read/write lock.
Ensure that Historian is connected, and is not in fault.
-166
Error unknown
Check with specific OS for more information.
Attempt to query your Historian and make sure it is working. Call support.
-190
Error aborted
Service/ function was aborted.
Attempt to query your Historian and make sure it is working. Call support.
-380
Network service not supported
The remote device does not support the services needed to perform the archiving of the TL.
Create the source TL on a device that supports the BACnet Read-Range service (e.g., Delta Controls DCU, or DSC device).
What Does it Mean When the Archive TL is “Detached”? If the monitored object of a source TL is changed, then the old monitored object’s Archive TL is detached, and a new Archive TL is created. Detached TLs are set to "Disabled" and do not collect new data, but they do maintain all the data they have accumulated.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–65
6–66
Trending, Archiving & Reporting Archive TLs are detached to: 1.
Ensure that the data in each archive pertains to one monitored object only (done when the monitored object of a TL is changed).
2.
Maintain a complete record of all TLs that have been archived over time (done when the source TL is deleted).
3.
Ensure that the data in each archive pertains to the same controller (done when the address of a controller has changed).
What Might be the Cause When an Archive TL is Disabled? The following are possible reasons that the Archive TL is in “Disabled” mode: Archive TLs might be disabled when:
Suggestions
The source TLs Archived checkbox has been cleared.
Select the Archived checkbox in the source TL to re-enable trending.
The source TL has had its monitored object changed and the Archive TL has become detached.
A new Archive TL has already been created for the new monitored object.
What Happens When Running Historian and ORCAview on the Same PC? If you have Historian and ORCAview installed on the same PC, something of note may happen. In some cases, Source TLs are erased. If you have ORCAview running while Historian is not running, you can create TLs on that machine. These TLs function as expected until Historian is run on that machine. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–66
Total Pages in this Section: 164
Using Historian’s Database Tables
6–67
Using Historian’s Database Tables Historian’s database contains many tables, and the data within these tables can be queried to provide useful reports on the system. 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. Column Name
Type
Information
ACEInstance
Number
Event number – auto incrementing
EventTime
Datetime
Event time
EventTypeNumber
Number
Event type – text for the type is found in the ENUM_BAC_AC_EventType table
EventObjectID
Text
Event object identifier
EventObjectName
Text
Event object name
EventObjectDevice
Number
Event object device number
EventObjectType
Text
Event object type
EventObjectInstance
Number
Event object instance
CardUserInstance
Number
Card user instance
CardUserName
Text
Card user name
CardUserNumber
Number
User number of card
SiteCode
Number
Site code of card
EventArg
Number
The value of this field depends on the event type: ValidAccess: 0 = entry, 1 = exit Database Load: 0 = load from file, 1 = load from flash Database Save: 0 = save to file, 1 = save to flash Device Offline/Online: Linknet address of device (0 for ASM logging the event) Elevator Hatch Opened/Closed: floor number
FloorName
Total Pages in this Section: 164
Text
Floor name
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–67
6–68
Trending, Archiving & Reporting
DevOff The DevOff table stores information on devices (controllers) that .are offline. Column Name
Type
Information
Device
Number
The device that had archived trends is now offline.
Tnext
Datetime
The approximate next time Historian will poll for the offline controller.
Tries
Number
The number of unsuccessful attempts.
Enum_BAC_AC_Event The Enum_BAC_AC_Event table contains the mappings for Access Control event type (numbers to text values). Column Name
Type
Information
ID
Number
Event type number
Value
Text
Event type text
EVL The EVL table stores information about the Event Log objects in Historian’s database. Column Name
Type
Information
EVLInstance
Number
Object instance
Name
Text
Name
Flags
Number
Object Flags
Description
Text
Description
RecordCount
Number
Number of records currently in the EVL
TotalRecordCount
Number
Total number of records ever recorded in the EVL
Value
Number
Is the EVL logging data: 0 = no, 1 or NULL = yes
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–68
Total Pages in this Section: 164
Using Historian’s Database Tables
6–69
EVLData The EVLData table the information on Events that Historian logs. Each table contains one row per Event. Column Name
Type
Information
RecordNumber
Number
Record number within the EVL
EVLInstance
Number
EVL instance for this data
EventRefSiteNo
Number
EventRefDeviceNo
Number
EventRefObjectType
Text
Object reference for this event. The name of the event object is found in the RefNames table by matching the SiteNo, DeviceNo, ObjectType and Instance.
EventRefInstance
Number
EventRefProperty
Number
EventRefArrayIndex
Number
Category
Number
Event category of this entry
Notes
Text
Debug information.
MonitoredRefSiteNo
Number
MonitoredRefDeviceNo
Number
MonitoredRefObjectType
Text
MonitoredRefInstance
Number
Monitored object reference for this event. The name of the monitored object is found in the RefNames table by matching the SiteNo, DeviceNo, ObjectType and Instance.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–69
6–70
Trending, Archiving & Reporting
Column Name
Type
Information
InfoEventParametersType
Number
Type of event parameters included: 0 = COB, 1 = COS, 2 = COV, 3 = CommandFailure, 4 = FloatingLimit, 5 = OutOfRange, 6 = Complex, 7 = BufferReady, 8 = Version2
InfoEventParametersCOBValue
Text
Bitstring value
InfoEventParametersCOBFlags
Number
Debug information.
InfoEventParametersCOSValueEnumid
Number
Debug information.
InfoEventParametersCOSValueValue
Number
Change of State value
InfoEventParametersCOSFlags
Number
Debug information.
InfoEventParametersCOVValueType
Number
Type of COV value present: 0 = bitlist, 1 = numeric
InfoEventParametersCOVValueBitList
Text
Bitlist value present if, InfoEventParametersCOVValueType = 0
InfoEventParametersCOVValueNumerical
Number
COV numeric value, present if, InfoEventParametersCOVValueType = 1
InfoEventParametersCOVFlags
Number
Debug information.
InfoEventParametersCommandFailureValueEnumid
Number
Debug information.
InfoEventParametersCommandFailureValueValue
Number
Command failure value
InfoEventParametersCommandFailureFlags
Number
Debug information.
InfoEventParametersCommandFailureFeedbackEnumi d
Number
Debug information.
InfoEventParametersCommandFailureFeedbackValue
Number
Command failure feedback value
InfoEventParametersFloatingLimitValue
Number
Floating limit value
InfoEventParametersFloatingLimit
Number
Debug information.
InfoEventParametersFloatingLimitSetpoint
Number
Floating limit set point
InfoEventParametersFloatingLimitErrorLimit
Number
Floating limit error limit
InfoEventParametersOutOfRangeValue
Number
Out of range value
InfoEventParametersOutOfFlags
Number
Debug information.
InfoEventParametersOutOfRangeDeadband
Number
Out of range deadband
InfoEventParametersOutOfRangeExceededLimit
Number
Out of range exceeded limit
InfoEventParametersComplex
Text
Complex event information
InfoEventParametersBufferReadyDeviceRefDeviceNo
Number
InfoEventParametersBufferReadyDeviceRefObjectType
Text
Device reference for device issuing buffer ready event
InfoEventParametersBufferReadyDeviceRefInstance
Number
InfoEventParametersBufferReadyObjectRefObjectType
Text
InfoEventParametersBufferReadyObjectRefInstance
Number
InfoEventParametersBufferReadyPreviousNotifyTime
Datetime
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–70
Object on the device issuing the buffer ready event
Time of last buffer ready event
Total Pages in this Section: 164
Using Historian’s Database Tables
6–71
Column Name
Type
Information
InfoEventParametersBufferReadyCurrentNotifyTime
Datetime
Time of current buffer ready event
InfoEventParametersVersion2MonitoredFlags
Number
Flags on the V2 monitored object
InfoEventParametersVersion2MonitoredMap
Number
Map value on the V2 monitored object
InfoEventParametersVersion2MonitoredValue
Number
Value on the V2 monitored object
InfoEventParametersVersion2MonitoredUnits
Number
Units on the V2 monitored object
InfoEventParametersVersion2ReferenceValue
Number
V2 alarm reference value
InfoEventParametersVersion2HighLimit
Number
V2 high limit value
InfoEventParametersVersion2LowLimit
Number
V2 low limit value
InfoEventParametersVersion2Difference
Number
V2 value difference
InfoEventParametersVersion2AlarmFlag
Number
V2 alarm flag
InfoEventParametersVersion2AlarmType
Number
V2 alarm type
InfoAckTimestampType
Number
Ack Timestamp type: 0 = Time, 1 = Sequence Number, 2 = DateTime
InfoAckTimestampTime
Datetime
Ack time – present if InfoAckTimestampType = 0
InfoAckTimestampSequenceNumber
Number
Ack sequence number - present if InfoAckTimestampType = 1
InfoAckTimestampDateTime
Datetime
Ack date/time - present if InfoAckTimestampType = 2
InfoAckText
Text
Ack text
InfoAckToState
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
InfoAckDeviceRefDeviceNo
Number
InfoAckDeviceRefObjectType
Text
Device reference of the acknowledging device
InfoAckDeviceRefInstance
Number
InfoAckProcessId
Number
Ack process Id
InfoAckEventType
Number
Type of event being acknowledged: 0 = COB, 1 = COS, 2 = COV, 3 = CommandFailure, 4 = FloatingLimit, 5 = OutOfRange, 6 = Complex, 7 = BufferReady, 8 = Version2
InfoErrorTime
Datetime
Error time
InfoErrorError
Number
Error number
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–71
6–72
Trending, Archiving & Reporting
EVLFilters Table The EVLFilters table contains a list of filters used by EVL objects in Historian. Column Name
Type
Information
RecordNumber
Number
Record number within the EVL
EVLInstance
Number
EVL instance for this data
UBNEventNotificationFilterT ype
Number
Filter type: 0 = event category, 1 = event reference
Category
Number
Event category – present if UBNEventNotificationFilterType = 0
EventRefSiteNo
Number
EventRefDeviceNo
Number
Event reference – present if UBNEventNotificationFilterType = 1
EventRefObjectType
Text
EventRefInstance
Number
EventRefProperty
Number
EventRefArrayIndex
Number
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–72
Total Pages in this Section: 164
Using Historian’s Database Tables
6–73
Historian The Historian table lists information about the Historian Settings object. Column Name
Type
Information
HSInstance
Number
HS object instance
Name
Text
HS object name
UserName
Text
The name that the Historian Device uses when it logs onto the Delta Server.
Password
Text
The password that the Historian Device uses when it logs onto the Delta Server.
LogFile
Text
Name, and path of Historian’s Error Log file.
LogFileMaxSize
Number
Maximum size in MB for the Historian’s Error Log file. Default is 1 MB.
AllowRemoteArchiving
Number
Debug information.
Operation
Number
Debug information.
OperationProgress
Number
Debug information.
MaxPollInterval
Number
Upper limit on the poll interval that Historian’s scheduler will calculate for a TL.
FullPollDuration
Number
Sum of all poll durations in the ScheduleInfo table
ExpectedPollDuration
Number
Time expected for current poll operation
LastPollDuration
Number
Time taken for last poll operation
LastPollStart
Datetime
Time the last poll was started
NextPollStart
Datetime
Time next poll is scheduled to start
PathToMonitor
text
Path of drive to monitor.
LowDiskNotify
Number
Free space is available on the drive specified by the path to monitor.
HistorianDebug The HistorianDebug table stores information on devices (controllers) that .are offline. Column Name
Type
Information
Timestamp
Datetime
Used only for debug and in-house testing. This table will always be empty.
Entry
Text
Used only for debug and in-house testing. This table will always be empty.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–73
6–74
Trending, Archiving & Reporting
ObjectMap The ObjectMap table provides the mapping from the archived objects in Historian to the source objects within the devices. Column Name
Type
Information
LocalObjectObjectType
Text
Object type and instance in Historian
LocalObjectInstance
Number
ArchivedObjectSiteNo
Number
ArchivedObjectDeviceNo
Number
ArchivedObjectObjectType
Text
ArchivedObjectInstance
Number
ArchivedObjectProperty
Number
ArchivedObjectArrayIndex
Number
Reference for the archived object on the remote device
Ops The Ops table stores information on how long Historian was in each of five states. This information is used to calculate statistics. Column Name
Type
Information
Timestamp
Datetime
Last update time of this current table.
Initializing
Number
Scheduling
Number
Archiving
Number
The total number of seconds Historian has spent in this current state. This is use to calculate statistics in the Stats table.
Sleeping
Number
Fault
Number
Refnames The Refnames tables contain the mappings from the object references to their object names. Column Name
Type
Information
SiteNo
Number
Object reference
DeviceNo
Number
ObjectType
Text
Instance
Number
Name
Text
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–74
Object name
Total Pages in this Section: 164
Using Historian’s Database Tables
6–75
ScheduleInfo The ScheduleInfo table provides scheduling information for TLs archived by Historian. There is one row for each archived TL. Column Name
Type
Information
LocalObjectObjectType
Text
Object type and instance within Historian
LocalObjectInstance
Number
ObjectStatus
Number
Current status of the archived object: 1 = needs setup, 2 = fault, 3 = enabled, 4 = disabled
NextPollAt
Datetime
Next time the object is scheduled to be polled
PollInterval
Number
How often this object is polled
MaxPollInterval
Number
Amount of time without polling that can elapse without Historian missing samples
AutoAdjustPollInter val
Number
N/A For future use
LargestRecordNumber
Number
Last record retrieved from the remote object
PeakRate
Number
Fastest rate samples were recorded in this object. The rate used to calculate next sample time. The units for it are the number of samples per min.
MaxPeakRate
Number Real
Historically the highest/maximum PeakRate that has ever been recorded. The units for it are the number of samples per min. This is an important field since you may has a COV trend that does not change very often but suddenly changes faster than Historian can keep up with. The units for it are the number of samples per min.
PartialRate
Number Real
The most current rate of the trend on the last archive. The units for it are the number of samples per min.
PollDuration
Number
Amount of time taken to poll the data from the remote object
ConnectionId
Number
N/A For future use
LastSuccessAttempt
Datetime
Time of the last successful poll attempt
TotalSuccessAttempts
Number
Number of successful poll attempts
LastFailedAttempt
Datetime
Time of the last failed poll attempt
TotalFailedAttempts
Number
Number of failed poll attempts
LastFailureReason
Number
Reason for the last failure: -25 = remote device communication failure, -27 = remote device communication timeout, -84 = invalid packet, -165 = Time out when waiting for a R/W lock, -166 = Unknown check with the specific OS for more info, -190 = Service/Function was aborted (see also ERR_ABORTED_REMOTELY) -380 = remote device does not support network services required for archiving,
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–75
6–76
Trending, Archiving & Reporting
ForcedUpdatePending
Number
Displays whether the object needs to be updated immediately. (0 = no, 1 = yes)
Stats The Stats table provides the names and data values for fields on the Stats tab of the HS dialog. Column Name
Type
Information
Property
Text
Imported data fields that are used to populate the HS Dialog.
Value
Text
The Value of those important fields.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–76
Total Pages in this Section: 164
Using Historian’s Database Tables
6–77
TL The TL table lists information about the TL objects within Historian. Column Name
Type
Information
TLInstance
Number
Instance of the TL object in Historian
Name
Text
TL name
Description
Text
TL description
Flags
Number
Debug information.
Value
Number
Debug information.
LogEnable
Number
Is the TL enabled: 0 = no, 1 = yes
StartTime
Datetime
Debug information.
StopTime
Datetime
Debug information.
MonObjSiteNo
Number
Monitored object of the archived TL
MonObjDeviceNo
Number
MonObjObjectType
Text
MonObjInstance
Number
MonObjProperty
Number
MonObjArrayIndex
Number
MonObjObjectName
Text
MonObjPropertyName
Text
LogInterval
Number
Polling interval (in hundredths of a second) for the archived TL. Value is zero for COV trends
LogTimer
Number
Debug information.
StopWhenFull
Number
Debug information.
RecordCount
Number
Number of records currently in the TL
TotalRecordCount
Number
Total number of records ever recorded in the TL
NotificationThresho ld
Number
Debug information.
RecordsSinceNotific ation
Number
Debug information.
LastNotifyRecord
Number
Debug information.
NotificationClass
Number
Debug information.
AckedTransitions
Number
Debug information.
EventTimeStamps1
Datetime
Debug information.
EventTimeStamps2
Datetime
Debug information.
EventTimeStamps3
Datetime
Debug information.
HALFlags
Number
Debug information.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–77
6–78
Trending, Archiving & Reporting
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. Column Name
Type
Information
RecordNumber
Number
Sample record number.
TLInstance
Number
TL instance for this data
Timestamp
Datetime
Timestamp for the data
Hundredths
Number
Hundredths part of the timestamp
Type
Number
Type of data in this entry: 0 = Value entry 1 = Error entry 2 = Time change entry 3 = Event entry
Data
Text
This field logs data. Actual data for an entry is as follows: 259::261 for missed data. This means if TL record count > HTL record count, then samples were missed. 259::42 for invalid array index. This means if TL record count < HTL record count then we have logged more data than is known. It is possible that the controller loaded its old database.
Flags
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–78
Number
Flags for the data
Total Pages in this Section: 164
Using Historian’s Database Tables
Error Code
Basic Description
Detailed Description
Suggestions
-25
Remote device failure
The remote device is not available on the network.
Check to ensure the remote device is functioning.
-27
Remote device timeout
The remote device did not respond in the desired time – it may not be available on the network.
Check to ensure the remote device is functioning.
-84
Invalid packet
This error might result from bad wiring.
Debug information.
-127
Source TL deleted
The source TL has been deleted on the controller and the Archive TL cannot collect any more data.
Debug information.
-165
Database timeout
Timeout while waiting for a database read/write lock.
Ensure that Historian is connected, and is not in fault.
-166
Error unknown
Check with specific OS for more information.
Debug information.
-190
Error aborted
Service/ function was aborted.
Debug information.
Network service not supported
The remote device does not support the services needed to perform the archiving of the TL.
Create the source TL on a device that supports the BACnet Read-Range service (e.g., Delta Controls DCU, or DSC device).
-380
Total Pages in this Section: 164
6–79
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–79
6–80
Trending, Archiving & Reporting
INTRODUCTION TO REPORTS (RPT) A feature of ORCAview is the ability to generate commonly used technical reports of the system. Report objects (RPT’s) are created through the local Operator Workstation (OWS) in the same way as standard ORCAview objects. The purpose of this section is to provide information on how to create, configure, and use the RPT object. For a detailed description of the fields and tabs in the RPT object, refer to Chapter 10: Software Objects.
Features The Reports feature: •
Contains Query, Access Configuration and Tenant Billing Reports.
•
Creates customizable Query Reports with real-time filtering.
•
Supports multiple destinations, such as Printer, File and Email.
•
Supports multiple formats, such as pdf, txt, doc, xls, html and rpt.
•
Creates reports on command, or generates them automatically using a preset schedule or triggered event.
What Type of Reports are Generated Users can create three types of standard reports: Query Reports, Tenant Billing Reports, Access Configuration Reports, Access Reports, Controller Configuration, and Controller Reports. Query Generates a report listing the objects, based on user-defined criteria. For example: Entering object filter criteria:
Generates a report listing:
AI.commissioned=false
All the AI objects currently decommissioned.
AI>35
All the AI objects with a value greater than 35.
Tenant Billing Generates automatic billing to the tenant clients on a schedule determined by the building owner. These reports are usually sent to tenants on a monthly basis, charging for the energy or resources consumed during a specific period. Access Configuration Generates reports which summarize information from Access Control objects within the system.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–80
Total Pages in this Section: 164
Using Historian’s Database Tables
6–81
Access Reports Generates reports based on the information from AEL (Access Event Log) object. List all card users who are in the building at specified time. It is designed for building managers to know who is in and who is out and at what time. Controller Configuration Extract two report styles from former Access Configuration report list: •
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–81
6–82
Trending, Archiving & Reporting
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.
Creating a New Report Creating a new RPT is done in the same way as creating any new object in ORCAview. When a new RPT object is created, the default report type is a Query Report. To create a new Report:
1.
In the left pane of the Navigator window, right click the Reports folder.
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.
Configuring a Query Report This section covers information on how to select devices, filter for specific properties and format a Query Report. To configure a Query Report:
1.
From the left-pane of the Navigator window, right-click the Reports folder to create a new report.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–82
Total Pages in this Section: 164
Configuring a Query Report 1.
6–83
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. To apply object filter criteria to all devices (V2 and BACnet):
1.
In the Devices field, select All Devices.
2.
Click Apply to save the changes.
To apply object filter criteria within an area:
1.
In the Devices field, select Area.
2.
From the Area drop-down menu, select the appropriate area device.
3.
Click Apply to save the changes.
Note: The area drop-down menu is disabled if there are no area devices on the
network.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–83
6–84
Trending, Archiving & Reporting
To apply object filter criteria to a system or a subnet device:
1.
In the Devices field, select Area.
2.
From the Area drop-down menu, select the appropriate area device.
3.
From the System drop-down menu, select the appropriate system device.
4.
From the Subnet drop-down menu, select either: •
All Devices
- or • 5.
An individual Subnet device.
Click Apply to save the changes.
To apply object filter criteria to a Specific Device:
1.
In the Devices field, select Specific.
2.
In the available field, enter the address of the individual BACnet device.
3.
Click Apply to save the changes.
To apply object filter criteria to a range of BACnet Devices:
1.
In the Devices field, select Specific.
1.
In the available field, enter the range of BACnet devices. (For example, 10000 - 20000).
2.
Click Apply to save the changes.
Note: A single device address can also be combined with a range of addresses,
e.g., 10000, 20000 - 30000, 40000.
To apply object filter criteria to V2 devices:
1.
In the Devices field, select Specific.
2.
In the available field, enter the address or range of addresses.
3.
Select the Version 2 checkbox.
4.
Click Apply to save the changes.
Using the Object Filter The Object Filter box is used to enter specific search criteria. It uses the same syntax as the Navigator Filter Bar in ORCAview. The Object Filter box allows users to specify which objects are displayed in the report. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–84
Total Pages in this Section: 164
Configuring a Query Report
6–85
Object Filter Examples To filter by object name:
Returns all objects:
AHU
with names containing AHU
Temp*
starting with the name Temp
*valve
ending with the name valve
To filter by object type:
Returns all:
ai
AI’s
bi
BI’s
To filter by object type and instance:
Returns:
av1, av2
AV’s 1 and 2
av(1,3,5)
AV’s 1, 3, and 5
av(1-7)
AV’s 1 through 7
To filter by property value:
Returns all:
ai.Calibration > 0
AI’s with a Calibration > 0
av > 70 (or av.Value>70)
AV’s with a Value > 70
Temp > 23
Objects with names containing Temp and Value > 23
To filter by object type and common property:
Returns:
(ai(1-7), av, ao).ManualOverride = TRUE
AI’s 1 to 7, all AV’s, and all AO’s that are in manual mode
To filter by multiple property values:
Returns:
ai.(Value > 23 or Value < 10)
AI’s with Value < 10 or > 23
(ai, ao).(ManualOverride = TRUE and Value > 50)
AI’s and AO’s that are in manual mode and have a Value > 50
To use multiple filters:
Returns:
ai > 6, bv = "Fan On"
AI’s with a Value > 6, and BV’s with Value = "Fan On"
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–85
6–86
Trending, Archiving & Reporting
Customizing the Report Format and Layout The Report Format section is used to configure how each column of information is displayed in the final report. Once configured, the applied changes can be viewed by clicking Preview which is on the lower-left corner of the RPT dialog.
Working with Report Columns The following table provides basic information on making changes and working with the format of your reports. In the Report format section: To:
Do this:
Resize the column width
Click the column header at either end, and then drag the cursor to shorten or lengthen the column.
Change the layout order of a column
Click the column header, and then drag the cursor to the desired location.
Sort the column contents
Click to column header to sort in ascending, or descending order. Click the column again to reverse direction.
Remove a column
Right-click the column header, and then click Remove Column.
Group objects by device
Select the Group By Device checkbox, and then click Apply.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–86
Total Pages in this Section: 164
Configuring a Query Report
6–87
Table of Common Object Properties The following tables list the object types and the properties that can be used when editing or adding columns to a report. These tables provide the most common properties. The properties are grouped in the following tables: •
Input Objects (AI, BI, MI, PI)
•
Output Objects (AO, BO)
•
Variable Objects (AV, BV, MV)
•
Totalizer Objects (AT, BT)
•
Other Objects (CO, OS, DEV, TL, EV)
Input Objects (AI, BI, MI, PI) AI Object
BI Object
MI Object
PI Object
Name Description Value StatusFlags Units CommissionFlag Reliability OutOfService DeviceTypeRef DeviceType MinValue MaxValue COVIncrement ADFilter ADValue Calibration ManualOverride HALFlags ExternalControl
Name Description Value StatusFlags CommissionFlag Reliability OutOfService DeviceTypeRef DeviceType Polarity InactiveText ActiveText ChangeOfStateTime ChgOfStateCount ManualOverride HALFlags
Name Description Value StatusFlags CommissionFlag Reliability OutOfService NumberOfStates DeviceTypeRef DeviceType Polarity StateText[] ChangeOfStateCount ADValue ManualOverride HALFlags
Name Description StatusFlags CommissionFlag Reliability OutOfService PulseUnits PulseDuration PulseRate DemandPulseRate DemandNumberOfSamples SampleInterval SamplePulses TotalPulses LastReset PeakPulseRate PeakPulseRateTime PeakDemandPulseRate PeakDemandPulseRateTime ConversionUnits ConversionFactor ConvertedPulseRate ConvertedDemandPulseRate ConvertedTotalPulses COVIncrement ManualOverride HALFlags
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–87
6–88
Trending, Archiving & Reporting
Output Objects (AO, BO) AO Object
BO Object
Name Description Value StatusFlags Units CommissionFlag Reliability DeviceTypeRef DeviceType CurrentPriority DefaultValue COVIncrement Polarity DAValue OutputVolt ModuleType HandsOffAuto FBackValue ManualOverride HALFlags CriticalControl
Name Description Value StatusFlags CommissionFlag Reliability DeviceTypeRef DeviceType Polarity InactiveText ActiveText ChangeOfStateTime ChangeOfStateCount MinimumOffTime MinimumOnTime CurrentPriority DefaultValue DAValue OutputVolt ModuleType HandsOffAuto StartDelayTime FBackValue ManualOverride HALFlags FlickWarnEnable FlickWarnTime FlickWarnTimer FlickWarnActive FlickWarnPAEnable CriticalControl
Variable Objects (AV, BV, MV) AV Object
BV Object
MV Object
Name Description Value StatusFlags Units Reliability OutOfService COVIncrement ManualOverride HALFlags LastWriter
Name Description Value StatusFlags Reliability OutOfService ActiveText InactiveText ManualOverride HALFlags LastWriter DeviceTypeRef
Name Description Value StatusFlags Reliability OutOfService NumberOfStates StateText[] ManualOverride HALFlags LastWriter DeviceTypeRef
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–88
Total Pages in this Section: 164
Configuring a Query Report
6–89
Totalizer Objects (AT, BT) AT Object
BT Object
Name Description Value Units StatusFlags OutOfService COVIncrement StartTime ConversionUnits ConversionRate ManualOverride InputRef
Name Description Value StatusFlags OutOfService StartTime ActiveStateChanges COVIncrement ManualOverride HALFlags InputRef RunSeconds
Other Objects (CO, OS, DEV, TL, EV) CO Object
OS Object
DEV Object
Name Description Value StatusFlags OutOfService Algorithm Polarity OutputRef InputRef InputValue InputUnits SetpointRef SetpointRefEnable SetpointValue ProportionalValue IntegralValue DerivativeValue DerivativeUnits Bias DerivativeSampleTime Deadband ResetBand
Name Description Value StatusFlags OutOfService StartType StartTime TargetAirTemperature TargetAirTemperatureValue IndoorAirTemperature DeadBand ScheduleReference NextScheduleStart MaxStartTime MaxStartTimeValue OutdoorAirTemperature OutdoorAirTempInfluence UnoccupiedInfluence ManualOverride HALFlags
Name Description Value StatusFlags Vendor VendorId ModelName FirmwareVersion HardwareRevision ApplicationSWVersion Location ProtocolVersion ProtocolRevision MaxAPDULength MaxMaster MaxInfoFrames SegmentationSupported APDUSegmentTimeout APDUTimeout APDURetries Time Date TimeZoneEnable UtcOffset DaylightSavingsStatus DaylightSavingsEnable DaylightSavingsStandard DaylightSavingsOffset DaylightSavingsTransition DaylightSavingStartDay DaylightSavingEndDay TimeSyncInterval
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–89
6–90
Trending, Archiving & Reporting
CO Object
OS Object
DEV Object Latitude Longitude SiteElevation SiteElevationUnits LastResetTime ResetCount StaticRamTotal DynamicRamTotal StaticRamFree DynamicRamFree FlashType SecurityEnable LinknetEnable
TL Object
EV Object
Name Description Value StatusFlags OutOfService StartTime StopTime LogInterval LogEnable IsHistorical ManualOverride HALFlags InputRef BufferSize
Name Description Value StatusFlags OutOfService Algorithm InputRef EventEnable AckedTransitions NotificationClass EnableAutoText ManualOverride HALFlags EnableRef EventClassRef
Adding a New Column To add a new column:
1.
Right-click the column header and click Add Column.
2.
In the Add Column dialog, enter an object property, or select one from the drop-down menu.
3.
Enter a column name.
4.
Click OK to add the new column.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–90
Total Pages in this Section: 164
Configuring a Query Report
6–91
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.
Configuring Property, Alignment and Format Cells To edit a column’s property settings:
1.
Put the cursor in the desired column, and click the Property cell.
2.
From the drop-down menu select an object property, or enter an object property into the Property cell.
3.
Click Apply to save the changes.
To configure a column’s alignment:
•
Put the cursor in the desired column, click the Alignment cell to select left, centered, or right. Left Aligned
Centered
Right Aligned
Changing the visible decimal place for numeric values:
1.
Total Pages in this Section: 164
Put the cursor in the desired column and click the Format cell.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–91
6–92
Trending, Archiving & Reporting 2.
Select an option (e.g., #.## displays 2 decimal places), and then click Apply to save the changes.
Changing the settings to display a binary state as text.
1.
Put the cursor in the value column and click the Format cell.
2.
Select the Text option, and then click Apply to save the changes.
Creating a Tenant Billing Report This section covers the following information: •
Creating Tenant Billing reports.
•
Configuring the billing time period.
•
Adding Version 2 and BACnet TLs.
•
Editing and removing TLs.
•
Creating temporary cost adjustments.
•
Changing the Tenant Billing transaction layout.
•
Configuring the calculation settings.
•
Adding company and customer information.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–92
Total Pages in this Section: 164
Creating a Tenant Billing Report
6–93
To create a new Tenant Billing report:
1.
From the right-pane of the Navigator window, right-click the Reports folder and click New.
2.
From the Report Type drop-down menu, select Tenant Billing. The new report displays as shown in the following figure.
Configuring the Billing Time Period and Invoice Number The Period drop-down menu is used to define the range of data used to calculate the billing time period. The billing options available are Previous Month, Current Month, or any of the 12 calendar months (January through December). 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. To configure a Tenant Billing report time period:
1.
From the Setup tab, click the Period drop-down menu.
2.
Do one of the following:
3.
Total Pages in this Section: 164
•
Select Previous Month.
•
Select Current Month.
•
Select a specific month (January – December). When a calendar month is selected the Year box is enabled.
Click Apply to save the changes.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–93
6–94
Trending, Archiving & Reporting 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.
To configure the invoice number:
•
In the Invoice # field, enter the number for your report.
Note: Users can choose a new invoice number, and then the report numbers
increase automatically from that point forward.
Adding Trend Logs The procedure for adding BACnet or V2 TLs is basically the same. TLs used for Tenant Billing reports should be trending Binary / Digital values, which reflect the override state or the occupancy of the tenant. To add a trend log:
1.
From the Setup tab, click Add.
2.
From the Add Trend Log dialog, click the drop-down menu and select the appropriate device.
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.
Editing Trend Logs The Edit and Remove buttons allow users to make temporary or permanent adjustments to a Tenant Billing report.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–94
Total Pages in this Section: 164
Creating a Tenant Billing Report
6–95
To edit a trend log entry:
1.
2.
To edit a TL entry do one of the following: •
Double-click a TL from the list.
•
Select a TL and then click Edit.
In the Edit Trend Log dialog, do the following if required: •
Enter text changes in the Description field.
•
Enter a dollar value in the Rate($\hr) field.
•
Enter a dollar value into the Temporary Adjustment field.
3.
Click OK.
4.
Click Apply to save the changes.
Removing Trend Logs Removing a TL entry from the Trend Log dataview also removes it from the Tenant Billing report. To remove a Trend Log entry:
1.
In the Trend Log dataview, select the TL entry.
2.
Click Remove.
3.
Click Apply to save the changes.
Creating Reports with Temporary Cost Adjustments This procedure is used to make temporary adjustments to the overall cost for a specific TL. This value is only temporary. It is not saved when the RPT dialog is closed. To create a temporary cost adjustment:
Total Pages in this Section: 164
1.
In the Period field, select a timeframe from the drop-down menu.
2.
In the Trend Log dataview, select the TL to be adjusted, and click Edit.
3.
In the Edit Trend Log dialog, enter a value change into the Temporary Adjustments field. Note: This field accepts both positive and negative values.
4.
Click OK. Note: The value entered is removed as soon as the RPT object is closed.
5.
Print or export the report.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–95
6–96
Trending, Archiving & Reporting
Changing Tenant Billing (transaction) Layout Depending on the TL used in a Tenant Billing report the transaction could run for pages or for just a couple of lines. Using the up and down buttons allows users to move shorter transactions to the front of the report, longer to the end, or vice versa. To change the Tenant Billing transaction layout:
1.
From the Trend Logs dataview, select the TL.
2.
Click the up or down buttons to re-order the TL.
3.
Click Apply to save the changes.
Configuring the Calculation Settings The Calculation Settings field provides users with options to calculate and customize how a tenant is billed for services or energy consumed. The following procedures describe how to: •
Set a minimum charge per transaction.
•
Set a roundup to nearest minute.
•
Set the tax percentage.
To configure the minimum charge per transaction:
1.
Click the Minimum charge drop-down menu, and select one of the options. - or Click the Minimum charge field, and enter a custom value (e.g., 45 min.)
2.
Click Apply to save the changes.
To set the roundup to the nearest minute:
1.
Click the drop-down menu, select one of the options. - or Click the Roundup to the nearest field, and enter a custom value (e.g., 35 min.)
2.
Click Apply to save the changes.
To set the Tax percentage:
1.
In the Tax field, enter the appropriate tax percentage.
2.
Click Apply to save the changes.
Adding Company and Customer Billing Information The Company Info and Billing Info sections are included to allow users to customize the names and addresses for the reports generated.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–96
Total Pages in this Section: 164
Creating an Access Configuration Report
6–97
To add Company and Billing information:
1.
Click the Company or Billing fields, and then enter the appropriate information.
2.
Click Apply to save the changes.
3.
To view the information as it will appear in the report, click Preview.
Creating an Access Configuration Report Access Configuration Reports show how objects are configured. To see the configuration, a report is generated for either a specific object or a group of objects. The following procedures cover selecting and configuring, and then entering object filter criteria for the report.
Selecting Access Configuration To select an Access Configuration report:
Total Pages in this Section: 164
1.
From the left-pane of the Navigator window, right-click the Reports folder, and then click New.
2.
From the Report Type drop-down menu, select Access Configuration.
3.
From the second drop-down menu, select a report.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–97
6–98
Trending, Archiving & Reporting 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. To add information to a report:
1.
Click the Layout/Destination tab.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–98
Total Pages in this Section: 164
Configuring Layout/Destination
6–99
2.
In the Title field, enter the report title. Note: Only the first 63 characters are displayed. The Title field is not displayed in Tenant Billing Reports.
3.
In the Notes field enter any required text. Note: Only the first 254 characters are displayed. For Query reports if information is not added to the Notes section, the Object Filter text appears by default.
4.
In the Footnote section add any text that should appear at the end of the report. Note: Only the first 254 characters are displayed.
Assigning a Triggered By Object Reports can be generated automatically by assigning a Triggered By object. Reports are only generated when the assigned Triggered By object transitions from a FALSE, to a TRUE state. Objects can be assigned in the following ways: •
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.
To assign a Triggered By object:
Total Pages in this Section: 164
1.
Click the Layout/Destination tab.
2.
In the Triggered By field, enter a descriptor or object reference.
3.
Click Apply to save the changes.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–99
6–100
Trending, Archiving & Reporting
Selecting Report Destinations The Destinations section of the Layout/Destination tab is used to select where, and how, a report is sent. The three choices are Printer, File and Email. The Add, Edit and Remove buttons are used to select and modify, or to remove the destinations.
Adding a Printer Destination To add a Printer destination:
1.
From the Destinations section of the Layout/Destination tab, click Add.
2.
In the Destinations dialog, from the Type menu, select Printer.
3.
From the Printer drop-down menu, select the printer.
4.
Click OK, and the Destinations field displays the selected Printer.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–100
Total Pages in this Section: 164
Configuring Layout/Destination
5.
6–101
Click Apply or OK.
Adding a File Destination The RPT File destination supports eight different formats that are displayed in the drop-down menu when File is selected. To add a File destination using the Filename field:
1.
From the Destinations section of the Layout/Destination tab, click Add.
2.
In the Destinations dialog, from the Type menu, select File.
3.
In the Filename field, enter a file name and file extension (e.g., Building 1 – Monthly.pdf). Note: This saves the file to the default location as shown in the following figure.
4.
Click OK.
To add a File destination using the Save As… button:
Total Pages in this Section: 164
1.
In the Destinations dialog, click Save As….
2.
From the Save As dialog, click the Save in drop-down menu, and select a location to save the file.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–101
6–102
Trending, Archiving & Reporting 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.
To:
Use
For Example:
Add a date
%d%
Report%d%.pdf = Report20_Jun_2003.pdf
Add the Time
%t%
%d%_Report_%t%.pdf = 20_Jun_2003_Report_11_15_43.pdf
Add an Invoice Number (Tenant Billing only)
%i%
HVAC_Overide_Bill_%i%.pdf = HVAC_Overide_Bill_214.pdf
Adding an Email Destination When Email is selected as the destination, the dialog displays the address fields and provides a Format field so that users can select an appropriate format for sending the report. To add an Email destination:
1.
From the Destinations section of the Layout/Destination tab, click Add.
2.
From the Type menu, select Email.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–102
Total Pages in this Section: 164
Configuring Layout/Destination
6–103
Editing and Removing Report Destinations Once destinations are selected, users can Edit the destination settings, or Remove them if necessary. To edit report destinations:
1.
In the Destinations section of the Layout/Destination tab, select the entry to be changed.
2.
Click Edit.
3.
In the Destinations dialog, make any required changes.
4.
Click the OK.
5.
Click Apply to save the changes.
To remove report destinations:
Total Pages in this Section: 164
1.
In the Destinations section of the Layout/Destination tab, select the entry to be removed.
2.
Click Remove.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–103
6–104
Trending, Archiving & Reporting
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.
Frequently Asked Questions The following are some common issues with Reports.
Content Missing from Access Configuration Reports Access reports in the csv and tsv file formats may have content missing, and what is missing can vary between reports. To ensure that all content is saved, follow this procedure. 1.
Send or save the MS Access file in an Excel (xls) format.
2.
Using MS Excel re-open the file.
3.
Save the report as a .csv or .tsv file.
Query Reports Take too Long to Generate The time required to generate reports depends on a number factors: the filter criteria, the number of devices involved and the network connection. If a report takes a long time to generate, try the following: •
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–104
Total Pages in this Section: 164
Header
6–105
HISTORIAN SETTINGS (HS) OBJECT [COPY] This object reference information is a copy of the Ch. 10: Software Object Reference content for HS. The intention is to include all the relevant Historian information in this chapter. 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. The Historian Settings object contains the following information: •
Statistical information about the operation and status of Historian.
•
Troubleshooting information on busy archived TLs and TLs in danger of missing samples.
•
Setup information such as auto logon, ODBC connection, TL polling, and error logging.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–105
6–106
Trending, Archiving & Reporting Scheduling Historian is “calculating” which TLs it will poll during its next archiving phase. Stopped Historian is connected to the network, but is not running. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–106
Total Pages in this Section: 164
Stats
6–107
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.
Historical Trend Log Count Displays the total number of Trend Logs that Historian is archiving.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–107
6–108
Trending, Archiving & Reporting
Configuring DSN for Microsoft SQL Server In order for the Statistics and Troubleshooting information to show in the HS object, you must specify the database name in the DSN. It is assumed that the HS dialog specifies a database name and that Historian has run and created this database. The HS dialog needs to reflect all the changes done with the ODBC data source. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–108
Total Pages in this Section: 164
Stats
6–109
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:
14 Click OK three times to close all dialogs.
Configuring DSN for MySQL To configure the DSN for MySQL, you need to download and install two tools: •
MySQL Connector
•
MySQL Server
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. Refer to Chapter 6 – Trending, Archiving & Reporting for more information on the setup of MySQL.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–109
6–110
Trending, Archiving & Reporting
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. It is preferred design practice to configure a system with Historian so that it provides a reasonable margin for periodic increased data collection. If you have many Polling TL’s collecting data at high rates and many COV TL’s set to collect a sample for a small change in signal, then you will probably have issues with missed samples. With some configurations, Historian may be able to handle normal operations fine but may be unable to handle situations when the load on Historian is higher.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–110
Total Pages in this Section: 164
Troubleshooting
6–111
A problem with Insufficient Samples may be due to the configuration of the source Trend Log or changes in the characteristics of the monitored signal. The typical solution involves 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. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–111
6–112
Trending, Archiving & Reporting 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 configuration of a Polling TL (increase Log Interval on Setup tab) or COV TL (increase COV Minimum Interval on Setup tab of monitored object) can be changed so that fewer samples are collected. You might also consider changing a Polling TL to a COV TL to avoid collecting large amounts of data with little variation in it. Note: Before increasing the Max Samples, it is recommended to do a forced
update to ensure that all the current data in the buffer is archived by Historian. To update, press the Update button in the header of an Archive TL. If the Max Samples (buffer size) is increased beyond the available memory on the controller, the entire buffer is purged. A forced update avoids this possible data loss.
The following table explains the information included with a High Usage Trend Log list item. Each TL entry is followed by two numbers.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–112
Total Pages in this Section: 164
Troubleshooting
6–113
Controller_number.TLinstance – First # (PollInterval), Second # (PeakRate)
For example, a good list item might be:
8000.TL1 - 3240, 1 Historian will be able to keep up with this trend.
First #: (PollInterval)
The number of seconds Historian waits between successive Trend Log data collection operations. This is the PollInterval from the ScheduleInfo table in the database.
3240 (Seconds between TL Archives)
Historian cannot archive a single Trend Log more than once every 120 seconds. This deliberate constraint prevents a single poorly configured Trend Log from dominating Historian’s resources. If this number is 120 seconds the Trend Log requires configuration. Practically, the further this number is from 120 the better and the actually lowest acceptable value will depend on the characteristics of your Historian site. The preferred range is from 1000 to 5000 seconds or greater. Numbers above 500 are generally acceptable.
Second #: (PeakRate)
The number of samples per minute that the TL accumulates.
1
The preferred range is from 6 to 0.125 samples per minutes or less. Numbers below 1 are generally acceptable.
(Number of Samples per minute)
The following table provides general guidelines for interpreting the information included with a possible High Usage Trend Logs list item. Variable
First #: (PollInterval)
Better is
Better
Good
Acceptable
Problems (Avoid)
Missed Samples (Avoid)
Higher
86400
> 8100
> 3240
300
120
Lower
0.125
< 0.4
6
60
(Seconds between TL Archives)
Second #: (PeakRate) (Number of Samples per minute)
The following table provides some examples of possible High Usage Trend Logs List Items with interpretation of the example.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–113
6–114
Trending, Archiving & Reporting
High Usage Trend Logs List Examples
Interpretation
8000.TL1 - 120, 60
AVOID as Missed Samples: Historian will Definitely NOT be able to keep up with this trend.
8000.TL18000.TL1 - 300, 6
AVOID as Problems: Historian may NOT be able to keep up with this trend.
8000.TL1 - 3240, 1
Acceptable: Historian may be able keep up with this trend.
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. Note: Before increasing the Max Samples, it is recommended to do a forced
update to ensure that all the current data in the buffer is archived by Historian. To update, press the Update button in the header of an Archive TL. If the Max Samples (buffer size) is increased beyond the available memory on the controller, the entire buffer is purged. A forced update avoids this possible data loss.
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–114
Total Pages in this Section: 164
Troubleshooting
6–115
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.
Missed Samples: Intermittent High Data Rate Problems Sometimes, Historian may miss samples but only for short time periods during a day. Historian may collect samples without data loss most of the day but experience some short intermittent periods where the data rate is much higher than normal causing Historian to miss samples. These trends with intermittent high sampling rates, may appear on the Insufficient Samples list but only for a short time. For example, a site may have some motion detectors and Historian may not be able to keep up with these for some high traffic periods during a day. Historian has no problems with these TLs during the rest of the day. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–115
6–116
Trending, Archiving & Reporting
Setup The Setup tab contains the setup items for Historian’s auto logon, ODBC connection, TL polling and error logging.
Log File Path This read-only field specifies the name, and path of Historian’s Error Log file which tracks Historian’s functionality. When something of significance happens such as Historian starting up, logging-on, logging-off, or stopping, Historian records the occurrence in the HistLog.txt file. The information in this file is useful for tracking Historian operation or troubleshooting problems.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–116
Total Pages in this Section: 164
Setup
6–117
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.
Maximum Poll Interval This field provides an upper limit on the poll interval that Historian’s scheduler will calculate for a TL.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–117
6–118
Trending, Archiving & Reporting
HISTORICAL TREND LOG (ARCHIVED TL) OBJECT [COPY] This object reference information is a copy of the Ch. 10: Software Object Reference content for HTL. The intention is to include all the relevant Historian information in this chapter. An Archive Trend Log (Archive TL) is an archival backup of a regular BACnet Trend Log (TL) with a theoretically unlimited maximum number of samples. The Historian device updates historical Trend Logs at calculated intervals by gathering data from the source TL that it is archiving. The preferred term is Archive Trend Log rather than Historical Trend Log. 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. Archived TL’s display collected information in two different formats: •
A line graph that plots value and time.
•
A text display of collected data.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–118
Total Pages in this Section: 164
Graph
6–119
There are two modes of operation for the Historical TL object: •
Trending: Historian is archiving new data samples.
•
Disabled: Historian is not archiving new data samples, although existing archived data samples may still exist.
The header also displays icons to indicate the status of a TL: This icon indicates that the TL is being archived by Historian, and it appears on any TL’s that are being archived by the Historian Device. The Fault Notification icon indicates that the archived TL is in fault. The Alarm Notification icon indicates that an external alarm has been triggered.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–119
6–120
Trending, Archiving & Reporting
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–120
Total Pages in this Section: 164
Setup
Total Pages in this Section: 164
6–121
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–121
6–122
Trending, Archiving & Reporting
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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
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:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–122
Total Pages in this Section: 164
Setup
6–123
If the Log Type is:
Historian will:
Polling
Periodically collect new data samples based on the TL’s Log Interval.
Change of Value (with Buffer Notification)
Collect new data samples when it receives an Archival Buffer Notification from the TL. As a backup, Historian will collect new data samples at intervals in case notifications are not received.
Change of Value (without Buffer Notification)
Collect new data samples at intervals based on the rate at which the source TL had previously collected samples.
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.
Disable When Full The read-only Disable When Full field is always cleared in an archived TL.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–123
6–124
Trending, Archiving & Reporting
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–124
Total Pages in this Section: 164
Description
6–125
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–125
6–126
Trending, Archiving & Reporting
TREND LOG – BACNET (TL) OBJECT [COPY] This object reference information is a copy of the Ch. 10: Software Object Reference content for TL. The intention is to include all the relevant Historian information in this chapter. 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. TLs will display the collected information in two ways: •
Graphically, with a line graph that has the last 200 values plotted against time.
•
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 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: If a TL is created on a network that includes Historian, users can trend more than the default maximum of 6000 samples. By selecting a TL(s), right clicking and clicking Command|Add to Historian , a user commands Historian to continuously archive the TL’s data into an ODBC database. The information from the database can be viewed in the corresponding historical TL that is created when a TL is archived.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–126
Total Pages in this Section: 164
Header
6–127
Header
Object Mode and Object Value There are 2 modes of operation for the Trend Log object: •
Enabled
•
Disabled
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. The header also displays icons to indicate the status of a TL: This icon indicates that the TL is being archived by the Historian Device. This icon appears on any TL’s that are being archived by Historian. The Fault Notification icon indicates that the archived TL is in fault. The Alarm Notification icon indicates that an external alarm has been triggered.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–127
6–128
Trending, Archiving & Reporting
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 Xaxis. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–128
Total Pages in this Section: 164
Setup
6–129
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. Historian Note: If a TL is being archived by Historian, changing the TL name will not automatically change the name of the Archive TL.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–129
6–130
Trending, Archiving & Reporting 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. The Monitored Object can be entered in many ways: •
By the descriptor name. For example, AHU1 Supply Air Temperature.
•
By the object reference number. For example, 9100.AI1 or 9100.AI1.Commissioned.
•
Drag-and-drop an object from Navigator. (This will always trend the present value property.)
Historian Note: Changing the Monitored Object — If a Trend Log is being archived by Historian, the monitored object becomes a read-only field.
To change the monitored object of a TL that is being archived:
1.
From the Setup tab of the source TL, clear the Archived checkbox.
2.
Click Apply or OK. This will re-enable the monitored object text box.
3.
In the Monitored Object field, type the name of the new monitored object.
4.
Select the Archived checkbox.
5.
Click Apply or OK.
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–130
Total Pages in this Section: 164
Setup
6–131
“Disabled” and do not collect new data, but they do keep all the data they have accumulated. Archive TLs are detached to: 1
Ensure that the data in each archive pertains to one monitored object only (done when the monitored object of a TL is changed).
2
Maintain a complete record of all TLs that have been archived over time (done when the source TL is deleted).
3
Ensure that the data in each archive pertains to the same controller (done when the address of a controller has changed).
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. If the Log Type is:
Historian will:
Polling
Periodically collect new data samples based on the TL’s time interval.
Change of Value (with Buffer Notification)
Wait for notifications from the TL that its buffer contains samples to be archived and will periodically collect data samples as a back up in case notifications are not received.
Change of Value (without Buffer Notification)
Periodically collect new data samples based on the rate at which the source TL had previously collected samples.
The following figure shows a Change of Value (COV)
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–131
6–132
Trending, Archiving & Reporting
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–132
Total Pages in this Section: 164
Setup
6–133
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.
Disable When Full When this checkbox is cleared, the TL will continue to collect samples, and will discard the oldest samples. When this checkbox is selected, the TL will stop collecting data once it has reached the Max Samples limit. When the data buffer is full, the TL object goes into Disabled mode to prevent any loss of data.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–133
6–134
Trending, Archiving & Reporting 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.
Archived (not editable greyed out in V3.40) V3.40 now supports multiple Historians on one site and as a result this Archived checkbox is not editable and is greyed out. Previously in V3.33, selecting this checkbox and pressing Apply or OK provided one of the methods to mark a trend(s) for archiving. The active V3.33 Historian would then add this trend(s) to its database. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–134
Total Pages in this Section: 164
Setup
6–135
To select a Trend for archiving in V3.40:
1
Right click on a selected trend or trends in a device's object list in the right pane of Navigator.
2
Click on Command on the menu.
3
From the Command submenu, select 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.
Archival Buffer Notification Setup Reporting When the Reporting checkbox is selected, Buffer Ready Notification is enabled, and three more fields become visible in the Setup area. These include Event Class, Threshold, and Records Since Last Notification.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–135
6–136
Trending, Archiving & Reporting
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. Note: If a COV Trend Log is marked for archiving, Historian automatically
configures the above-mentioned fields.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–136
Total Pages in this Section: 164
Data
6–137
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.
Reset Samples Button The Reset Samples button is used to clear all of the samples in the Trend Log. When you click the Reset Samples button and click Apply or OK, all samples are cleared from the TL. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–137
6–138
Trending, Archiving & Reporting
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–138
Total Pages in this Section: 164
Multi-Trend Components
6–139
MULTI-TREND (MT) OBJECT [COPY] This object reference information is a copy of the Ch. 10: Software Object Reference content for MT. The intention is to include all the relevant object information in this chapter.
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. Historian Note: By creating a Multi-Trend containing TL’s and their associated Archive TL’s, users are able to view both the controller data and the historical data simultaneously.
Multi-Trend Components This section explains how the Multi-Trend object presents information. A MultiTrend object has these main components:
Total Pages in this Section: 164
•
Graph Area
•
Dataview
•
Slider Bar
•
Axes
•
Graph Legend (Colored Squares)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–139
6–140
Trending, Archiving & Reporting •
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–140
Total Pages in this Section: 164
Multi-Trend Components
6–141
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
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–141
6–142
Trending, Archiving & Reporting
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–142
Total Pages in this Section: 164
Toolbar Components
6–143
The Line Properties dialog contains the following: 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
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–143
6–144
Trending, Archiving & Reporting 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. Y1-Axis and Y2-Axis Tabs 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–144
Total Pages in this Section: 164
Toolbar Components
6–145
Scale & Grid Interval Selecting this checkbox sets the grid interval for the Yaxis 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.
Multi-Trend Name This is the descriptor name given to the MT. Show Graph Symbols When this checkbox is selected, the MT displays symbols on the graph lines for each data sample. 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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–145
6–146
Trending, Archiving & Reporting 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. Description The description field 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.
Auto (Entire History)
Start Time
This button causes the X-axis (time axis) to auto-scale itself so that all of the available data can be seen. In the Axis dialog, the Start Time and Time Span are set to automatic.
Time Span (X axis)
AUTO: Show Entire Data
Setstart (History from Start Time)
Start Time
This button causes a user defined X-axis Start Time to be used. The X-axis Time Span would still be set to Automatic. An alternate method for achieving this viewing mode is to specify the Start Time in the Axis Properties Dialog.
Time Span (X axis)
SETSTART: Show Data from Specified Start Time
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–146
Total Pages in this Section: 164
Toolbar Components
6–147
Range (Moving Frame) This button causes the viewing mode to switch to "Moving Frame" mode. In this mode, the start time is set automatically, but the time span is set by the user in the Axis dialog. The result is that a fixed time window will keep up with the new Trend Log data as it comes into the Multi-Trend.
Time Span (X axis)
RANGE: Show Specified Time Frame
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.
Back and Fwd These two buttons move the view to the left and right, respectively. Each click of the buttons will move one-half of a screen. The Back/Forward buttons can be enabled by clicking either the Range or the Pause button.
Zoom in and Zoom out These two buttons change the viewed time span by one-half and double, respectively. Zoom in will show less data, but it improves the resolution. Zoom out shows more data, but it becomes more difficult to see the detail. For example, if the viewed time span is 8 hours and Zoom in is clicked, then the new time span will be 4 hours. Clicking Zoom out will return the dialog to the original 8 hours. These buttons can be clicked as many times as necessary.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–147
6–148
Trending, Archiving & Reporting
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–148
Total Pages in this Section: 164
Report Setup
6–149
REPORTS (RPT) OBJECT [COPY] This object reference information is a copy of the Ch. 10: Software Object Reference content for RPT. The intention is to include all the relevant object information in this chapter.
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. Users can create reports on command or generate them automatically by using a preset schedule or a triggered event. With this built-in RPT feature, six types of standard reports are created: Query, Tenant Billing, Access Configuration, Access, Controller Configuration, and Controller reports. RPTs can be viewed from the Reports folder in the Navigator Window. The purpose of this section of the Technical Reference Manual is to provide details on the RPT object and all the tabs and fields it contains. For information on how to use the RPT object, refer to Chapter 6: Trending, Archiving and Reporting.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–149
6–150
Trending, Archiving & Reporting
Report Type Menu The Report Type drop-down menu provides the following options: Query Generates a report listing the objects, based on user-defined criteria. For example: Entering object filter criteria:
Generates a report listing:
AI.commissioned=false
All the AI objects currently decommissioned.
AI>35
All the AI objects with a value greater than 35.
Tenant Billing Generates an automatic bill to the tenant clients on a schedule determined by the building owner. These reports are usually sent to tenants, on a monthly basis, charging for the energy or resources consumed during a specific billing period. Access Configuration Generates reports which summarize information from Access Control objects within the system. Access Reports Generates reports based on the information from CEL (Compact Event Log) object. List all card users who are in the building at specified time. It is designed for building managers to know who is in and who is out and at what time. Controller Configuration Extract two report styles from former Access Configuration report list:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–150
Total Pages in this Section: 164
Query Setup •
Calendar Configuration
•
Schedule Configuration
6–151
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–151
6–152
Trending, Archiving & Reporting 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
Version 2 Selecting the Version 2 checkbox, allows for address(es) which are applied to the Delta Controls V2 device network.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–152
Total Pages in this Section: 164
Query Setup
6–153
Object Filter Examples To filter by object name:
Returns all objects:
AHU
with names containing AHU
Temp*
starting with the name Temp
*valve
ending with the name valve
To filter by object type:
Returns all:
ai
ai’s
bi
bi’s
To filter by object type and instance:
Returns:
av1, av2
av1 and av2
av(1,3,5)
av1, av3, and av5
av(1-7)
av’s 1 through 7
To filter by property value:
Returns all:
ai.Calibration > 0
ai’s with a Calibration > 0
av > 70 (or av.Value>70)
av’s with a Value > 70
Temp > 23
objects with names containing Temp and Value > 23
To filter by object type and common property:
Returns:
(ai(1-7), av, ao).ManualOverride = TRUE
ai1 - ai7, all av’s, and all ao’s that are in manual mode
To filter by multiple property values:
Returns:
ai.(Value > 23 or Value < 10)
ai’s with Value < 10 or > 23
(ai, ao).(ManualOverride = TRUE and Value > 50)
ai’s and ao’s that are in manual mode and have a Value > 50
To filter by multiple values:
Returns:
ai > 6, bv = "Fan On"
ai’s with a Value > 6, and bv’s with Value = "Fan On"
Report Format The Report Format section is used to configure how each column of the report information is displayed.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–153
6–154
Trending, Archiving & Reporting 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. Left Aligned
Centered
Right Aligned
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. Group By Device The Group By Device checkbox groups objects by device. The sorting is defined by the column header and applied to each device group. When the checkbox is cleared, the objects are displayed in one long list. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–154
Total Pages in this Section: 164
Tenant Billing Setup
6–155
•
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.
Tenant Billing Setup The following section describes all the fields and dialogs in the Setup tab when Tenant Billing Reports are selected from the Report Type drop-down menu.
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–155
6–156
Trending, Archiving & Reporting
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: Description Displays the name of the monitored object. Trend Log Displays the object name and the TL reference. 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.
Up and Down Arrows The Up and Down arrows are used to arrange the order of the TL entries in the dataview. This, in turn, arranges the order of the Transaction Details section of the report. The Transaction details are viewed by clicking the Preview button on the lower left corner of the Setup dialog.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–156
Total Pages in this Section: 164
Tenant Billing Setup
6–157
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.
Device The Device drop-down menu displays only V2 or V3 devices, panels, and workstations with TLs. The devices are separated by group (V2 or V3) and are sorted by DNA addresses. 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). Description Displays the name of the monitored object. It is used to change the text to better describe the transaction information which appears in the Tenant Billing Report. Rate ($/hr.) This field is used to set the hourly rate for the TL. Temporary Adjustment This field is used to make temporary adjustments to the overall cost for a specific transaction. This value is only temporary, it is not saved when the RPT dialog is closed. This field accepts both positive and negative values.
Remove Button The Remove button deletes any highlighted entry from the Trend Log dataview.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–157
6–158
Trending, Archiving & Reporting
Calculation Settings Field These fields are used to calculate how a tenant is billed by the company. The Calculation Settings field provides users with options for the following: 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: •
If the Minimum Charge interval is 120 minutes, and the TL shows ON:07:30AM and OFF:08:45AM, the minimum time a customer is charged is 120 minutes.
Roundup to nearest The Roundup to nearest drop-down menu sets the roundup amount for any specific transaction. The drop-down menu has options of 0, 5, 10, 15, 30, or 60 minutes, or enter a value of 0 - 6000. These amounts also appear in the Tenant Billing Report. For example: •
If the roundup interval is 60 minutes, and the TL shows ON:07:30AM and OFF:08:45AM, the minimum time a customer is charged is 120 minutes.
Tax The tax field is used to enter the applicable tax percentage that needs to be calculated on the tenant bill. This field only accepts positive numbers.
Company Info and Billing Info These two sections are used to enter the appropriate company name and address, the customer’s name and address, as well as any other necessary billing information.
Access Configuration Setup The following section describes all the fields and dialogs in the Setup tab when Access Configuration Reports are selected from the Report Type drop-down menu.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–158
Total Pages in this Section: 164
Access Configuration Setup
6–159
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.
When Access Configuration is selected, a second drop-down menu displays the report templates for specific Access Control objects. The following list provides a brief description of each of the templates.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–159
6–160
Trending, Archiving & Reporting
Report Type
Object Reference
Access Configuration Setup Access Group Configuration
AG
Access Setup Configuration
AS
Card Reader Configuration
CR
Card User Summary by Instance
CU
Card User Summary by Name
CU
Card User Configuration
CU
Card User Configuration Extended
CU
Card User Summary
CU
Card Users By Access Group
CU
Door Controller Configuration
DC
Door Controller Status
DC
Door Group Configuration
DG
Access Reports Setup Event Log Summary
CEL
Event Log Summary by Controller
CEL
User Event Summary
CEL
User Event Summary by Controller
CEL
Who is in
CEL
Controller Configuration Setup Calendar Configuration
CAL
Schedule Configuration
SCH
Controller Reports Setup Commissioning Sheets
IP, OP
Points List
IP, OP
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–160
Total Pages in this Section: 164
Access Configuration Setup
6–161
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
Version 2 Selecting the Version 2 checkbox, allows for address(es) which are applied to the Delta Controls V2 device network.
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).
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–161
6–162
Trending, Archiving & Reporting
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–162
Total Pages in this Section: 164
Destinations
6–163
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.
Total Pages in this Section: 164
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–163
6–164
Trending, Archiving & Reporting 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.
To:
Use
For Example:
Add a date
%d%
Report%d%.pdf = Report20_Jun_2003.pdf
Add the Time
%t%
%d%_Report_%t%.pdf = 20_Jun_2003_Report_11_15_43.pdf
Add an Invoice Number (Tenant Billing)
%i%
HVAC_Overide_Bill_%i%.pdf = HVAC_Overide_Bill_214.pdf
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 6–164
Total Pages in this Section: 164
Chapter 7 – SYSTEM SECURITY 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
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–1
7–2
System Security Disable Illustrator .............................................................................. 7–42 Disable Alarm Pop-up ........................................................................ 7–42 Hide Server Messages ........................................................................ 7–43 Process ID .......................................................................................... 7–43 Default User Graphic (eTCH only) .................................................... 7–43 Welcome Screen (eTCH only)............................................................. 7–44 Auto-Logoff - Period (eTCH nly)........................................................ 7–44 Login Required Checkbox (eTCH only) ............................................. 7–45 Refresh Rate for Objects ..................................................................... 7–45 Language ............................................................................................ 7–45 Starting Screen ................................................................................... 7–45 Starting Screen (eTCH only) .............................................................. 7–46 Full Name ........................................................................................... 7–46 E-mail Address ................................................................................... 7–46 Phone Number .................................................................................... 7–46 Fax Number ........................................................................................ 7–46 Pager Number .................................................................................... 7–46 Cellular Number ................................................................................. 7–46 LOGIN ................................................................................................................ 7–47 Last Login Area .................................................................................. 7–47 Login Failure Area ............................................................................. 7–48 Login Lockout ..................................................................................... 7–48 Auto-Logoff......................................................................................... 7–49 Auto-Logoff - Period (eTCH only)...................................................... 7–49 OBJECT OVERRIDES ........................................................................................... 7–50 Security Group ................................................................................... 7–51 Object Access Exceptions ................................................................... 7–51 SECURITY USER GROUP (SUG) [COPY] ................................................ 7–53 DESCRIPTION TAB ............................................................................................. 7–53 Description Field ................................................................................ 7–54 Name................................................................................................... 7–54 OBJECT SECURITY TAB ..................................................................................... 7–54 Restricted Devices (Highest Precedence) ........................................... 7–55 Object Application Restrictions (Second Highest Precedence) .......... 7–55 HVAC, Access, and Lighting Checkboxes .......................................... 7–55 Object Access Permissions (Lowest Precedence) ............................... 7–56 USING DEFAULT SUG OBJECTS ........................................................................ 7–57 OBJECT RESTRICTION SETTINGS (ORS) [COPY] [NEW 3.40] ......... 7–58 THEORY OF OPERATION..................................................................................... 7–59 NAVIGATOR OBJECT SECURITY LOCK/UNLOCK MECHANISM ........................... 7–61 Temporary Login ................................................................................ 7–62 DESCRIPTION ..................................................................................................... 7–63 SETUP ................................................................................................................ 7–64 Name................................................................................................... 7–64 Lock/Unlock SUA ............................................................................... 7–65 SITE SETTINGS (SS) [COPY] ..................................................................... 7–71 SETTING SITE SECURITY: GENERAL TAB ........................................................... 7–71 ADVANCED ........................................................................................................ 7–72 V2 Master Panel ................................................................................. 7–72 V2 Security Panel ............................................................................... 7–72 BACnet Master Panel ......................................................................... 7–73 BACnet Security Panel ....................................................................... 7–73 User Logging ...................................................................................... 7–73
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–2
Total Pages in this Section: 74
Security for BACnet Network
7–3
User Log File ...................................................................................... 7–73 SETTING SITE: APPLICATION PROTOCOL TAB .................................................... 7–74
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–3
7–4
System Security
OVERVIEW ORCAview provides many new security features. Network Security Network security is optional in the BACnet specification. Other types of security such as user access control are not included in the BACnet specification, but may be added as a proprietary extension to BACnet. ORCAview has security features for networks of BACnet controllers that use remote PTP or UDP/IP connections. User access security for BACnet is handled entirely at the OWS. 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. Delta Version 2 Security When ORCAview is used with Version 2 hardware, a user is validated against a User Access (UA) object in a specified Version 2 controller on the network. See Appendix D: Using ORCAview with Version 2 Sites for more details.
Security for BACnet Network The purpose of user access security is to limit what a specific user can do while logged into the system, and to keep others out of the system completely. With ORCAview, there are two different approaches that can be used for BACnet security. When a Security Panel is not designated, the BACnet Network security is effectively disabled. Security Panel Not Specified By default, ORCAview designates the BACnet Security Panel to 0 and the Version 2 Security Panel to 1. The Version 2 protocol is disabled by default and can be enabled in the Site Settings object. . When the BACnet Security Panel in the Site Settings object is set to 0, a Security Panel is not designated. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–4
Total Pages in this Section: 74
Logging into a Site with ORCAview
7–5
Security Panel Specified This method designates a specific BACnet controller as the Security Panel. When a user wants to log on to the OWS, the username and password entered in the login screen are compared to the System User Access (SUA) object in the specified BACnet Security Panel. The SUA and SUG objects that exist on the BACnet Security Panel, not the OWS, will determine the permissions for this user. 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.
Logging into a Site with ORCAview When a user tries to log in to the OWS, they must provide a valid Username and Password. The following figure shows the Logon dialog:
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–5
7–6
System Security 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.
Login Flow Chart The following flowchart shows how the security works at login: User enters User Name and Password at login dialog
ORCAview confirms the username and password in the SUA on the workstation
Did ORCAview pass the security check?
Yes
ORCAview confirms the username and password in the SUA on the V3 security panel.
No
Unable to login to ORCAview
Did the V3 security panel pass the security check?
Yes
No
ORCAview confirms the username and password in the UA on the V2 security panel.
Navigator will not display any V3 devices
No
Did the V2 security panel pass the security Check?
Navigator will not display any V2 devices
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–6
Yes
Navigator will display all V2 devices
Total Pages in this Section: 74
Logging into a Site with ORCAview
7–7
An explanation of the previous diagram follows. 1 At the Logon dialog the user enters their username and password. 2
When the OK button is clicked ORCAview will verify 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 V3 security controller. However, if ORCAview fails the security check against itself, login will be denied. ORCAview prompts for another username and password.
4
Next ORCAview will verify the username and password against the SUA objects in the V3 security controller.
5
If the V3 security check fails then no V3 controllers will be displayed in Navigator. If the security check passes then all V3 controllers will be displayed. Regardless of the outcome ORCAview will move on to verify the V2 security check.
6
Next ORCAview will verify the username and password against the UA object in the V2 security panel. If the check fails no V2 controllers will be displayed in Navigator. If the check passes then Navigator will display all V2 panels.
Username and Password Characteristics The username and password have the following characteristics: •
The username and password are not case sensitive.
•
The username and password can only be made up with characters acceptable in Version 2. Do not use characters such as ( \ /:*?"< >| ) when typing the username or password. Both the username and password are forced to be uppercase. The username can have a minimum length of 1 characters and a maximum length of 16 characters. The passsword can have a minimum length of 4 characters and a maximum length of 14 characters. This is to ensure that the BACnet SUA object is compatible with the User Access (UA) object in Version 2 controllers.
When BACnet network security is checked, ORCAview verifies that the user who logged in also has a valid SUA object in the specified BACnet Security Panel. As mentioned before, if the specified Security Panel is 0, then no check is made with a site controller. Otherwise, the user is granted access to the BACnet network if the SUA in the Security Panel has a matching username and password, and the SUA in the Security Panel is currently in a Logged Off state. The user is logged into the BACnet network, and is given permissions as determined by the SUA and SUG objects in the BACnet Security Panel. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–7
7–8
System Security 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.
BACnet Object Security Object Security gives OWS administrator control over multiple users. Object Security is especially useful on larger controller networks. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–8
Total Pages in this Section: 74
BACnet Object Security
7–9
CREATING NEW USERS When it is necessary to add a new user to the system, the following procedure can be used. You can also copy and paste an existing SUA that has similar permissions and then modify its Name, Password and other settings. To create a new user SUA
1
In the ORCAview Dashboard, choose File, select-New-and click User.
2
Enter the new settings into the new SUA, and click Apply or OK. The system then creates the user in both ORCAview and the specified Security Panels (both BACnet and Version 2).
This approach ensures that everything matches in the OWS, BACnet Security Panel, and the Version 2 Security Panel. You can also use right click to create a new SUA on ORCAview that is automatically created in the Security Panels. You right click the SUA object in the right pane of Navigator. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–9
7–10
System Security
Creating a New Security User Group (SUG) To create a new Security User Group (SUG) 1
Click on the OWS workstation panel in Navigator.
2
Right Click on any white space on the right hand pane of Navigator and select “New”.
3
Fill in all the appropriate fields as depicted in the example picture below.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–10
Total Pages in this Section: 74
Every SUA References a SUG
7–11
Every SUA References a SUG Every SUA object must reference a local SUG. On the Object Overrides tab of the SUA, an SUG must be selected in the Security Group dropdown. If there is no BACnet Security Panel specified then the SUA will reference the SUGs on the local OWS. If a Security Panel is specified then the SUA must reference the SUG on the BACnet Security Panel as well as the local OWS. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–11
7–12
System Security
SUG and SUA Concepts SUA and SUG object Relationship SUA objects are created for each user who will be operating, programming or administrating equipment and/or software on the BACnet Network.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–12
Total Pages in this Section: 74
SUG and SUA Concepts
7–13
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
Total Pages in this Section: 74
SUA
SUG
This is the Administrator SUA that is linked to the SUG.
This SUG object defines access rights to the Administrator SUA.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–13
7–14
System Security
Programmer / Operator SUA
SUG
These six SUAs are individually linked to the SUG. These could be groups of Programmers or Operator SUAs.
This SUG object defines access rights to SUAs as a group.
When an SUA is linked to a specific SUG, it will inherit all permissions/restrictions that were configured in the SUG. To link an SUA to an SUG
1
In the SUA object, click on the Object Overrides Tab
2
Click on the Security Group field dropdown and select an SUG object.
3
When an SUG is selected, then click Apply or OK save the changes.
4
.Log out and then back into ORCAview for the changes to take effect.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–14
Total Pages in this Section: 74
SUG and SUA Concepts
7–15
Using the Eight Default SUG Objects Eight pre-configured SUG objects are created on the local OWS by default during an ORCAview 3.40new installation. These default SUG objects allow the administrator to efficiently assign groups of SUA users appropriate permission levels. The default SUG objects are there as a template for the administrator to setup proper permissions for groups of users. Any of the 8 SUG objects can be modified to suit the application and they can be copied and pasted to other controllers (i.e. the BACnet Security Panel).
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–15
7–16
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–16
Total Pages in this Section: 74
Restricted Devices
7–17
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.
Device restrictions are located in this column. Single device restrictions are entered like this: DEV80000 for V3 1.CP1 for V2 Restricting a range of devices is entered like this: DEV701-DEV799 for V3 1.CP1-10.CP1 for V2
Object Application Restrictions Object Application Restrictions allow an administrator to set up user access to objects based on which application area they belong to. The 3 different application areas are: Application
Icon
HVAC (Red) Access (Blue) Lighting (Green)
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–17
7–18
System Security
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. By default, all three Object Application Restriction checkboxes are unchecked in the SUG object. This means that any user linked to the default SUG object can see all BACnet objects. The same condition would be true if the three checkboxes were all checked. Any user linked to this SUG could still see all BACnet objects.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–18
Total Pages in this Section: 74
Restricted Devices
7–19
Configuring Object Application Restrictions Each BACnet object has 3 checkboxes along the bottom. The first checkbox is for HVAC, the second for Access, and the third is for Lighting. The engineer must determine if the functionality of each object falls under one or more of these application areas. Depending on the object type and the controller that it is located on, the object may be given a default Application Restriction when the object is created. For example, if Analog Variable 1 (7945.AV1) is determined to be an HVAC object, then a checkmark is placed into the corresponding checkbox. When HVAC is checked, the corresponding Red icon is displayed at the top of the object. When the HVAC checkbox is checked in the Analog Variable (AV) object, this object becomes part of the HVAC application area.
To configure an HVAC application area:
1
Place a checkmark in the HVAC checkbox within the SUG object.
A checkmark is placed in the HVAC checkbox. To apply these restrictions to a user, their SUA object must be linked to this SUG object.
2
Total Pages in this Section: 74
Log off from ORCAview and then log back in to get any changes to take effect. The user can only see and access the objects that have their HVAC checkmark checked. All other BACnet objects that have only Access or Lighting checked are restricted from view and accessibility because HVAC is the only application area that was enabled in the SUG object.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–19
7–20
System Security
Object Access Permissions Object Access Permissions grant access to a specific object. The Access Level of an object determines the permissions a user has for a particular object type. Each object in the Delta Controls BACnet System has Access Level settings . Object Permissions are located in this column See the Entering Object Permissions section, for more information on how to specify object permissions .
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.
Entering Object Permissions Object Permissions can be entered in using absolute permissions, wildcard permissions, or a combination of both. Any Version 3 object can be restricted. 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. A wildcard permission is an entry which includes the * symbol. The * symbol means anything. To enter in object permissions, use the format explained in the table below. Entry
Controller
Object
Instance
Permission
100.AV1
100
AV
1
Analog Variable 1 on Controller 100
Wildcard entries can be substituted for any of the 3 values above. The table below describes the different acceptable entries.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–20
Total Pages in this Section: 74
Restricted Devices
7–21
Entry
Controller
Object
Instance
Permission
100.AV1
100
AV
1
Analog Variable 1 on Controller 100
100.AV*
100
AV
*
Any Analog Variable on Controller 100
100.*
100
*
*
Any object on Controller 100
*.AV*
*
AV
*
Any Analog Variable with any Instance on any Controller
*.*
*
*
*
Any object on any Controller. This defaults to *.*
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.
Total Pages in this Section: 74
Entry
Controller
Object
Instance
Permission
AV
Blank
AV
Blank
Any Analog Variable with any instance on any Controller
100.AV
100
AV
Blank
Any Analog Variable on Controller 100
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–21
7–22
System Security
Object Access Exceptions Object Access Exceptions can be added under the Object Overrides tab in the SUA object. The purpose of Object Access Exceptions is to allow for specific restrictions to be set for that user. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–22
Total Pages in this Section: 74
Restricted Devices
7–23
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. Manual operator overrides are not possible at this level. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–23
7–24
System Security If the user attempts to command an object through an option, which cannot be visually disabled (grayed out), then an error dialog is displayed and the command operation is cancelled. Manual operator overrides are not possible at this level. 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. An error dialog is displayed if a user without Edit/Modify access attempts to make changes to an object, and the operation will be cancelled. 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. An error dialog is displayed if a user without Create/Copy access tries to create a new object and the operation will be cancelled. For an operator to load or save a complete controller database, the Create/Copy permissions must be enabled for the controller’s Device (DEV) object. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–24
Total Pages in this Section: 74
Object Security in Navigator Using ORS Object
7–25
Object Security in Navigator Using ORS Object With OWS 3.40, the Object Security features are included in ORCAview. These features use the Object Restriction Settings object in combination with the Object Security field on the Setup tab of an SUA object to specify the degree of access to objects by a user on a DAC controller.
Object Security (Lock, Unlock and Temporary Login Commands) With a controller selected in the left pane of Navigator, right click to open the command menu. Selecting the Object Security option provides the Unlock, Lock, and Temporary Login command options. 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. In order to enable object security, the controller must have an ORS created.
When you click on one of the Object Security commands, the following ORS Login dialog appears:
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–25
7–26
System Security 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.
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 Temporary 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–26
Total Pages in this Section: 74
Network Security
7–27
Network Security ORCAview has security features for networks of BACnet controllers that use remote PTP or UDP/IP connections.
PTP Remote Modem Connections with SUA Password A Remote OWS Connection to a V3 controller or Direct Connect to 3rd Party controller may require a SUA Password. Remote Panel Settings The Remote Panel Settings object in ORCAview is used to hold the phone number to dial and login information for the site. The Main tab holds the Phone Number that was entered on the Logon screen, the Password required for connecting to 3rd party Security controllers and the SUA object required for Username and password Verification with the Delta Controls Controller that is connected to the modem.
SUA Username/Password If the controller that the OWS is connecting to requires a remote OWS password check, it will verify that the Username/Password parameters of the SUA selected from this field match those of the of the SUA object contained in the controller's database. If the Remote OWS SUA object matches that of the controller, the connection will be allowed. If it does not match, the connection will be dropped and the OWS will not be able to communicate with the network.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–27
7–28
System Security
The SUA object also needs to be associated with a SUG in the Security Group field on the Object Overrides tab.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–28
Total Pages in this Section: 74
Network Security
7–29
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–29
7–30
System Security
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.
UDP/IP Remote Connections with SUA Password The ORCAview PC can be connected to a TCP/IP WAN in order to view a remote site that is also connected to the WAN. In order to successfully connect ORCAview to the DCU, a number of parameters need to be configured in the DCU. First, connect ORCAview to the DCU locally by serial or Ethernet so that these objects can be setup properly. The objects in the DCU that need to be adjusted are the BACnet Protocol Settings (BCP) and the UDP/IP Network Settings (UNS). The DCU needs to be reset after changes are made to these objects. BACnet Protocol Settings (BCP) in the DCU The UDP/IP Network Settings interface is enabled and the Device Type selected is BBMD Device. By default, the UDP/IP interface is disabled because additional setup parameters are required in the UNS object in order for it to function. Also, the default Device Type is Regular device.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–30
Total Pages in this Section: 74
Network Security
7–31
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. UDP/IP Network Settings in the Controller This object is where the IP network parameters for the controller are stored. The IP parameters shown in the following dialog are for example only. These parameters are different from one site to another, and cannot simply be "made up". Normally, the on-site network administrator will provide these parameters.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–31
7–32
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–32
Total Pages in this Section: 74
Network Security
7–33
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: BACnet Protocol Settings in ORCAview with UDP/IP The only network interface enabled in the BCP on the ORCAview is the UDP/IP Network Settings. The Tunnel checkbox for the UDP/IP interface is also checked to allow this OWS to see Version 2 controllers on-site. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–33
7–34
System Security
SYSTEM USER ACCESS (SUA) [COPY] The System User Access (SUA) is used to determine Network Security, Local Machine Security, and Object Security. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–34
Total Pages in this Section: 74
Common Header
7–35
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. The five states for the SUA are: •
Logged In
•
Logged Out
•
Disabled
•
Security Locked
•
Inactive
Logged In The Logged In SUA status indicates that a user has passed all system security checks. If the SUA is in this state nobody can log into the system using this SUA. 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: •
The Login Lockout Period expires.
- Or •
The Login Lockout is unchecked (False) manually by a user logged in with another valid SUA with appropriate permissions.
- Or •
Total Pages in this Section: 74
The SUA object is reset.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–35
7–36
System Security 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. This field is read-only and not editable by the user.
Last Logged Off at This field shows the last time and date that the SUA Status was set to Logged Off. In the PC, it shows the last time someone logged off 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 Off state. In this case, the time is taken from the controller. This field is read-only and not editable by the user.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–36
Total Pages in this Section: 74
Description
7–37
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–37
7–38
System Security
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. The Name has the following restrictions: •
Maximum 16 characters
•
Forced to be Uppercase
•
Only Version 2 acceptable characters are accepted. Do not use characters such as ( \ /:*?"< >| ). Also, spaces are not allowed. An SUA object name can have an underscore character _ in a name but it cannot be at the start of the name.
•
Minimum 1 character
These restrictions are in place to keep the SUA compatible with the Version 2 User Access object (UA).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–38
Total Pages in this Section: 74
Setup
7–39
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 ‘*’. The Password has the following restrictions: •
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).
Security - Password Auto Expire This field is used to enable the Password Start Date and Password Expiry Date. When checked (On) the object will execute the Password Auto Expire routine. 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).
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–39
7–40
System Security
Security - Password Start Date (Time also) This field allows the user to specify when the SUA can start to be used when the Password Auto Expire is on. The default value for Password Start Date will be the date and time that the user was created. If the Password Start Date has not occurred yet, then the Status of the SUA object will be set to Inactive. You can adjust the start time with the spin box, and the start date with the drop down calendar.
Security - Password Expiry Date (Time also) The Password Expiry Date sets the date when the SUA expires. Once the SUA has expired, the SUA Status is set to Inactive. The default value for the Password Expiry Date will be the date and time that the user was created. You can adjust the expiry time with the spin box, and the expiry date with the drop down calendar.
Menu Reference (Not eTCH) 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.
Object Security Provides a way to select an optional Object Security Restrictions (ORS) object from a list.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–40
Total Pages in this Section: 74
User Data
7–41
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–41
7–42
System Security
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. If a Security Panel is specified, the Disable Navigator checkbox must be checked in the SUA object on the local OWS for this feature to work.
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.
Disable Alarm Pop-up This field is used to enable or disable alarm pop-ups for the user. The default is unchecked which allows Alarm Pop-ups. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–42
Total Pages in this Section: 74
User Data
7–43
Hide Server Messages This field is used to enable or disable server messages for the user. The default is unchecked which allows server messages. 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.
Default User Graphic (eTCH only) The Default User Graphic field defines the first graphic file that displays on the eTCH (HMI) interface after a user logs in. It is only editable in SUA1 by an Administrator. 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).
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–43
7–44
System Security
These 4 fields are specific to the HMI
Welcome Screen (eTCH only) The Welcome Screen field defines the graphic that displays on the touch screen after the enteliTOUCH (eTCH formerly called HMI) device starts up or is reset. It is only editable in SUA1 by an Administrator. 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).
Auto-Logoff - Period (eTCH nly) The Auto-Log off period is the amount of time before a user is automatically logged out if there are no touches on the screen. You can disable this feature by setting the period to 0. In order for any changes in this field to take effect, you must save the changes. The default Auto-Logoff period is 10 minutes.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–44
Total Pages in this Section: 74
User Data
7–45
Login Required Checkbox (eTCH only) The Login Required checkbox specifies whether a user needs to log in and its status affects the Default User Graphic and Welcome Screen fields. It is only editable in SUA1 by an Administrator. If this field is checked (enabled), a user must log in to gain full Read/Write access to graphics. All graphics are Read Only if a user is not logged in. If this field is unchecked (disabled), eTCH access is granted to all users. This means that all users have full Read/Write control of graphics. A user still must have Login access as an Administrator (SUA1) to access the Configuration pages.
Refresh Rate for Objects This field is used to tell ORCAview how often to update a graphic and/or dialog for the User. The default value is 5 seconds. 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. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–45
7–46
System Security
Starting Screen (eTCH only) The Starting Screen field defines the Start Graphic to be displayed on the touch screen after a user logs in. 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 the field is empty, then eTCH will use the Default User Graphic after a user logs in.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–46
Total Pages in this Section: 74
Login
7–47
Login This tab contains information and setup for logins and logouts.
Last Login Area Date This field shows the last time and date the SUA Status was Logged In. In the PC it will show the last time someone logged into the workstation, taken from the PC clock. The SUA Status in the controller will show the last time that SUA Status in the controller was in the Logged in state. In this case the time is taken from the controller. This field is read-only and not editable by the user. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–47
7–48
System Security 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.
Login Failure Area Date This field displays the last time and date that this SUA failed a login check. In the OWS this field will show the last time and date the security check to get into the ORCAview failed. The SUA in the controller will show the last time and date the security check to the BACnet Security Panel failed. 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. This field is read-only and cannot be adjusted by the user. 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. The default value for Maximum Failures when an SUA is created is 3.
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. The Lockout defaults to unchecked (Unlocked) when an SUA is created. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–48
Total Pages in this Section: 74
Login
7–49
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. The default value for the Period is 1440 minutes (1 day).
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.
Auto-Logoff - Period (eTCH only) Period (eTCH Only) The Auto-Log off period is the amount of time before a user is automatically logged out if there are no touches on the screen. You can disable this feature by setting the period to 0. In order for any changes in this field to take effect, you must save the changes. The default Auto-Logoff period is 10 minutes.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–49
7–50
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–50
Total Pages in this Section: 74
Object Overrides
7–51
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.
Object Access Exceptions The Object Access Exceptions section has two fields allowing input for a specific object and its corresponding access level. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–51
7–52
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–52
Total Pages in this Section: 74
Description Tab
7–53
SECURITY USER GROUP (SUG) [COPY] This object reference information is a copy of the Ch. 10.Software Object Reference content. The intention is to include all the relevant security information in this chapter. 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
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–53
7–54
System Security
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.
Object Security Tab This tab contains all the fields necessary to set up object security.
The order of precedence for the fields on the Object Security tab from highest to lowest are: •
Restricted Devices (Highest Precedence)
•
Object Application Restrictions (Second Highest Precedence)
•
Object Access Permissions (Lowest Precedence)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–54
Total Pages in this Section: 74
Object Security Tab
7–55
Restricted Devices (Highest Precedence) The Restricted Devices field enables controllers to be restricted either by single device or a range of devices. Device Restrictions have the highest level of precedence. Any BACnet or V2 device can be restricted in the SUG object. A user who is restricted from a device cannot see or access the device in ORCAview. 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 (Second Highest Precedence) Object Application Restrictions allow objects to be hidden from the user based on their application area (HVAC, Lighting or Access). A user, who is restricted from a specific category of objects, cannot see or access objects of that category. 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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–55
7–56
System Security 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 (Lowest Precedence) Object Access Permissions have two input fields. The Objects field is used to enter in the object instance. The Access Level is used to set the Access Level Restriction for that specific object. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–56
Total Pages in this Section: 74
Using Default SUG Objects
7–57
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.
Using Default SUG Objects Eight pre-configured SUG objects are created on the local OWS by default during an ORCAview 3.30 or later new installation. These default SUG objects allow the administrator to efficiently assign groups of SUA users appropriate access levels. The default SUG objects are there as a template for the administrator to setup proper permissions for groups of users. Any of the 8 SUG objects can be modified to suit the application and they can be copied and pasted to other controllers (i.e. the Security Panel). 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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–57
7–58
System Security
OBJECT RESTRICTION SETTINGS (ORS) [COPY] [NEW 3.40] The Object Restriction Settings (ORS) object provides controller-based security that restricts access to individual database objects. Objects can be made public (visible) or private (hidden). Object Security provides an authorization mechanism but does not include requestor authentication. The approach is similar to the proposed BACnet Network Access Control Object and is designed to fit within the existing Delta security schemes and objects. 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 Login
The controller temporarily enters the login state where access is 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–58
Total Pages in this Section: 74
Theory of Operation
7–59
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.
Total Pages in this Section: 74
3
The first phase checks if Object Security is enabled by checking for Locked or Unlocked status.
4
If Object Security is enabled, the controller then determines which ORS object to use.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–59
7–60
System Security 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–60
Total Pages in this Section: 74
Navigator Object Security Lock/Unlock Mechanism
7–61
Navigator Object Security Lock/Unlock Mechanism With a controller selected in the left pane of Navigator, right click to open the command menu. Selecting the Object Security option provides the Unlock, Lock, and Temporary Login command options. 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. See the Object Security in Navigator Using ORS Object section starting on page 7–25 of this chapter.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–61
7–62
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–62
Total Pages in this Section: 74
Description
7–63
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–63
7–64
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–64
Total Pages in this Section: 74
Setup
7–65
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.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–65
7–66
System Security
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.
Dataview: Objects Column The Objects column of the dataview accepts individual objects or ranges of an object type. A minus sign (–) is used to indicate a range of objects and an asterisk (*) is used as a wildcard symbol. The whitespace around the minus sign in a rule entry is optional, and the interpreted information is always displayed in short form format. The Objects Column accepts an entry that contains the StartID, EndID, PropertyID, and ArrayIndex parts of the Object Security List.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–66
Total Pages in this Section: 74
Setup
7–67
Examples are shown in the following table: Object Column Entry
Explanation
Example
StartId
This is the BACnet ID of the first instance of the object type to which the Access rule applies. The BACnet ID contains both the instance number and the object type.
AV1
EndId
This is the BACnet ID of the last instance of the object type to which the Access rule applies. The object type in the ID is ignored, but should be the same object type as StartId.
AV5
PropertyID
This is the BACnet property ID of the property that the access rule applies to. Internally, the DAC stores this in its internal property ID, but externally, this is transmitted as in BACnet space.
.Description
If PropertyID is NULL_PROPERTY (0xfffe) or 0, then the access rule will apply to all properties for the specified objects, by StartId and EndId. This field provides the means to uniquely identify the property to be modified. ArrayIndex
This is the array index of the element that the Access rule applies to. If the property is not an array, this is ignored. If the property is an array and the array index is set to FULL_ARRAY (-1) then the Access rules applies to all elements of the array.
.StateText[1]
This field indicates the array index of the element of the referenced property to be modified.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–67
7–68
System Security The interpreted information is displayed in a cell in the Objects column. The following table shows how an object column entry is interpreted and parsed for display in short format. Object Column Entry
Meaning
Displayed
AV1
AV instance 1, default property (Value in this case)
AV1.*
AV1.Value
AV1, Value property
AV1
AV1.*
AV1, any property
AV1.*
AV1–5
AV instance 1-5, default property
AV1-5.*
AV1–AV5
AV instance 1-5, default property
AV1-5.*
AV1–5.Value
Value of AV instance 1-5
AV1-5
AV1.Value – AV5.Value
Value of AV instance 1-5
AV1-5
AV*.Description
Any AV's Description
AV*.Description
*.*
Any object, any property
*.*
MV*.StateText[1]
An array index may be specified with the property if the property is an array or list.
MV*.StateText[1]
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–68
Comment
(The dialog auto corrects to AV1.*)
If no array index is given, the reference applies to the entire array or list.
Total Pages in this Section: 74
Setup
7–69
Dataview: Object Permissions Column This field defines the permission levels for an entry. To edit the permissions, double click on a selected entry and use the Edit submenu that displays.
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.
Total Pages in this Section: 74
Access Level
Function
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–69
7–70
System Security 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.
Example: Using Rules to Get Intended Function The Objects column can have scope with wildcards etc. and the Permissions column can allow everything or assign just Visible which is more restrictive (less Permissions). 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: Objects
Permissions Checked
AO1.*
Read, Write, Create, Delete, Visible
AV2-4194303.*
Read, Write, Create, Delete, Visible
*.*
Read/Visible
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–70
Total Pages in this Section: 74
Setting Site Security: General Tab
7–71
SITE SETTINGS (SS) [COPY] This object reference information is a copy of the Ch. 10.Software Object Reference content. The intention is to include all the relevant security information in this chapter. 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.
Setting Site Security: General Tab The general tab contains the HVAC, Access, and Lighting checkboxes.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–71
7–72
System Security
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–72
Total Pages in this Section: 74
Advanced
7–73
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.
BACnet Master Panel If a BACnet Master Panel is specified, then ORCAview automatically loads the system objects from it on login.
BACnet Security Panel The specified 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 SUA object which matches an SUA object on the workstation. 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. There are 4 different options for user logging: •
None - does not record any activities.
•
Low - records login and logoff activities.
•
Medium - records login and logoff, save and load database and object delete.
•
High - records login and logoff, save and load database, object delete, object edit, object create, set Panel Time, Acknowledge alarm, alarm list remove, connect remote device and disconnect remote device. Also, High records Command actions, Manual, Auto, Reset, On, Off and Value#.
User Log File The name of the text file that the User Logging will be writing to.
Total Pages in this Section: 74
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–73
7–74
System Security
Setting Site: Application Protocol Tab The Application Protocol tab of the Site Settings (SS) object determines the protocols that are available on the site. Consider inserting: To enable a protocol you must check its box.If a protocol is not enabled (checked), then the security checks are not done for that protocol. If a specific protocol is not enabled, controllers using that protocol on this network do not display in Navigator. Unwanted V2 Security Failure Notification Every Logon Sometimes the Delta Version 2 protocol may be enabled on a site that contains only Version 3 devices. ORCAview fails a Version 2 user security check every time you log into the site. A notification displays when the Version security check fails. The solution is to disable the Delta Version 2 protocol on the Site settings (SS) object.
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. .
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 7–74
Total Pages in this Section: 74
CONNECTING PRODUCTS OF DELTA CONTROLS TO AN EXISTING NETWORK When proposing to connect products of Delta Controls to an existing network, both technical and non-technical considerations are involved. It is important to establish and maintain a good working relationship between the IT staff of the facility owner and the personnel of the Delta Controls partner.
Audience and Purpose Audience The main audiences of this section are the IT staff of the facility owner and the personnel of the Delta Controls partner. Purpose The main purpose of this section is to explain how to connect products of Delta Controls Inc. to an existing facility network. In addition to technical issues, the document tries to anticipate the security concerns and perceptions of the facility’s IT staff. The document is subdivided as follows: •
Advantages to using an existing network
•
Disadvantages to using an existing network
•
Network terms
•
Specific security concerns
•
Requirements from the facility owner’s IT staff
Advantages to Using an Existing Network With the 3.22 and later controller operating systems (firmware) for the controller and ORCAview software, it is possible to use an existing network for controller to controller and controller to workstation communications. A controller is a stand-alone device that performs building control and communicates over networks. ORCAview is a PC software application that combines a graphical interface with powerful facility management and control capabilities. The possible advantages of using an existing network are numerous and include:
Total Pages in this Section: 5
•
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.
ORCAview 3.40 Technical Reference Manual Rev. 1.80 Original Page 1
2
Disadvantages to Using an Existing Network The possible disadvantages of using an existing network include: •
Perceptions of network security weaknesses.
•
Concerns about introducing an unknown factor to the network that is outside of the direct control of IT staff.
•
Since the owner’s network is beyond the direct control of the Delta Controls Partner, a great deal of cooperation with the facility IT staff is required in order to obtain success.
•
Concerns that the products of Delta Controls will impair network performance and reliability.
The following section discusses these concerns after introducing some basic network terms.
Basic Network Terms This section covers some basic network terms with the goal of establishing a common basis for discussion. Intranet (WANs) When an Ethernet network is installed inside a single building to connect together workstations, it is referred to as a LAN (Local Area Network). However, the need to connect together more and more workstations, servers and other network equipment has led to the joining of multiple LANs. These are referred to as WANs (Wide Area Networks) or an Intranet. WANs can join two buildings on the same property or span the entire globe. From the point of view of installing products of Delta Controls , the size of the WAN doesn’t really matter. 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. Workstations or other network devices that communicate on a UDP/IP network need to have three parameters set. These parameters are; IP Address, Subnet Mask, and Gateway Address. IP address An IP address is simply an address that is unique in the network. IP addresses are written as xxx.xxx.xxx.xxx where each group of xxx can be any number between 1 and 254. An example of an IP address is 192.168.1.10. When a device communicates on an Intranet, its IP address must be unique in the Intranet. When communicating on the Internet, the IP address must be unique in the world.
ORCAview 3.40 Technical Reference Manual Rev. 1.80 Original Page 2
Total Pages in this Section: 5
Basic Network Terms
3
Subnet Mask A Subnet Mask is written similarly to an IP address and allows a network device to determine which other devices are on the same LAN with it. A very common Subnet Mask is 255.255.255.0. Gateway Address A Gateway Address is also an IP address and gives the address of the Gateway (or Router) which connects the LANs together. If the device that we wish to communicate with is on a different LAN, then the communication must be directed to the Gateway rather than directly to the device. 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. Firewall Workstation users on an Intranet can communicate with others on the Internet if a connection between the Intranet and Internet is made. A special type of Router called a Firewall typically provides a way to connect an Intranet with the Internet. Firewalls do the same basic job as a Router, but also add security features to the connection. Typically, a router includes firewall features. A Firewall prevents users on the Internet from accessing workstations and information on the private Intranet. Obviously, allowing all the users of the Internet complete, unfettered access to your Intranet is not a very secure arrangement! 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. Firewall Security Concerns In order for the products of Delta Controls to be seen from the Internet, the Firewall needs to be specifically programmed. The IT staff will have to open up communication through the Firewall to a controller’s IP address on UDP Port 47808. Although technically this is not a problem, many IT people are nervous at the idea of a hole in their Firewall. This is understandable since the IT staff are responsible for the integrity and security of their Intranet. In actual sites, these security concerns may result in the owner’s facility operators not being able to view the building mechanical systems off-site over the Internet, even though the products of Delta Controls are capable of Internet access.
Total Pages in this Section: 5
ORCAview 3.40 Technical Reference Manual Rev. 1.80 Original Page 3
4
Specific Network Security Concerns When installing products of Delta Controls on an existing network, typically the greatest concern is that these products will compromise security. This only becomes a real concern when off-site access to the control system is required. Some sites still use a modem connected to a single controller to gain access to the on-site control system. Most sites are integrated through the internet and not via dialup. Modem Connection to a Single Controller The concern is that someone, off-site, could dial into the control system using the modem connection, and then gain access to the owner’s private network. This is not possible when using the BACnet products of Delta Controls or other companies. BACnet is a standardized network protocol, developed by an American Society of Heating, Refrigerating and Air-Conditioning Engineers (ASHRAE) industry committee that allows building control products to communicate with each other. Although the BACnet standard is an open standard, communication is limited to between one BACnet device and another. When someone connects to the control system remotely, they will only be able to communicate to other BACnet devices on the network. The BACnet standard only allows communication between BACnet devices by standardized, strict packets which do not allow for arbitrary information on the facility owner’s network to be viewed or changed. More information on the BACnet standard can be obtained from the BACnet web-site: http://www.bacnet.org Excess BACnet Network Traffic It is possible that someone could generate a lot of legitimate BACnet network traffic in a deliberate attempt to saturate the owner’s network and make it unusable. Also, typical BACnet packets are less than 100 bytes in size. 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.
ORCAview 3.40 Technical Reference Manual Rev. 1.80 Original Page 4
Total Pages in this Section: 5
Requirements from the Owner’s IT Staff
5
Requirements from the Owner’s IT Staff In order to realize the benefits of using the existing network, cooperation between the Delta Controls Partner and the facility owner’s IT staff is essential. Clearly, it will be the IT staff who provide the network connections and any required parameters for communicating on the network. The requirements of the facility owner’s IT staff can be summarized as follows: •
Each Ethernet controller will require a 10BaseT connection to communicate to the network.
•
One controller per Ethernet segment needs an appointed static IP Address (not DHCP – dynamic IP addressing), a Subnet Mask and a Gateway Address for that segment. The BACnet design allows other Delta Controls controllers to communicate through this single controller to reach other controllers in other buildings.
•
The UDP (user datagram) packets on port 47808 must be permitted to pass through any IP Routers. Port 47808 (0xBAC0) is the port number assigned to BACnet communication.
•
In order to communicate to the on-site controllers using the Internet, the Firewall must allow communication to the IP Addressed controller on UDP port 47808. Sites using Network Address Translation (NAT) are acceptable as of 3.21 controller firmware. NAT uses private, reserved, IP addresses inside the Intranet, which are translated to unique IP addresses on the Internet.
•
The ORCAview software which is used to access the control system can be installed on existing workstations as long as they meet the following requirements: a. Operating system is Windows XP SP2, or later. ORCAview supports Windows XP 32 Pro SP2; 2003 Server; Vista 32/64 (Business, and Ultimate); 2008 Server; Windows 7 32/64 (Pro, Business and Ultimate). b. An Ethernet card is installed in the PC which has TCP/IP protocol setup for the card. We can utilize either static or dynamic (DHCP) IP addresses at the workstation. c. The preferred PC is a current one with a minimum of an Intel Core 2 Duo @ 2.6 GHz (or equivalent AMD) with 4GB of RAM and a display resolution of 1280 x 1024 and 32 bit Color .
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.
Total Pages in this Section: 5
ORCAview 3.40 Technical Reference Manual Rev. 1.80 Original Page 5
Chapter 8 – MODEMS AND PRINTERS 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
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–1
8–2
Modems and Printers
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. The Delta modem manufactured by BOCA is no longer available and configuration information for this modem has been removed from this chapter. To find configuration instructions for this modem please refer to previous version(s) documentation or go to Delta Controls Customer Solutions online support site.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–2
Total Pages in this Chapter: 32
Introduction
8–3
Your USR modem will probably have a Read Me First document, and a printed manual and extensive documentation (including troubleshooting) on the USR CDROM. The USR website http://www.usr.com/support contains documents that include troubleshooting information.
Other Modem Information in Technical Reference Manual Additional modem application information can be found in the following chapters of the Technical Reference manual: Modem Information: Chapter 5 Event Management System: (~ page 5-98) •
Sending Alarm Notifications over Modem Connections Sending Alarm Notifications to ORCAview via a Modem ORCAview Auto-Answer for Alarms (Wait for Call or Login and Disconnect)
•
DSC Remote Printing
•
Sending Alarm Notifications to a Numeric Pager via Modem
•
Routing Alarm Notifications To An Alphanumeric Pager
•
Routing Alarm Notifications To Email
•
Serial (RS-232) Port Settings (SNS)
Chapter 10 Software Objects Reference •
Modem Settings (MDS)
•
Remote Panel Settings (RPS)
•
BACnet Protocol Settings (BCP)
•
Network Protocol Settings (NET)
•
Event Router (EVR)
Appendix B Preferences and Setup •
Remote Panel Settings (RPS)
•
Modem Settings (MDS)
•
Printer Settings (PRS)
• Site Settings (SS) Chapter 2 Getting Started •
Logon Dialog: Advanced Button Connections
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.
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–3
8–4
Modems and Printers
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.
Modem with a V3 DSC Controller for Dial-in To configure a USR modem for use with a V3 controller:
1.
Connect the modem to the serial port of the DSC. (Cables can be purchased from Delta Controls or you can make your own cable using the pinout descriptions found in the Modem Cable Connections section starting on page 8–22 at the end of this chapter.)
2.
If the USR modem has dip switches, then before the modem is turned on, set the DIP Switches to match the following Table:
Table 8-4: Modem DIP Switch Configuration for V3 Modem DIP Switch Configuration
Device
DIP 1
DIP 2
DIP 3
DIP 4
DIP 5
DIP 6
DIP 7
DIP 8
V3 controller / ORCAview
UP
UP
DOW N
UP
UP
UP
UP
DOW N
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–4
Total Pages in this Chapter: 32
Modem with a V3 DSC Controller for Dial-in
8–5
To configure a V3 DSC for use with a Modem:
For dial-in to a DSC controller, the NET1 object must be configured. The system now auto detects the presence of a modem.
Total Pages in this Chapter: 32
1.
On the Setup tab of NET1, select PTP, click on the Setup tab below the dataview.
2.
Set the Baud Rate. The default Baud Rate is 9600 Baud.
3.
Select your modem from the Modem Type drop down list or choose Custom to enter a user defined Modem initialization string. In most cases you will be selecting US Robotics as the modem type.
4.
Reset the controller to program the modem for use with the controller.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–5
8–6
Modems and Printers
Modem with a V3 DCU Controller for Dial-In To configure a USR modem for use with a V3 controller:
1.
Connect the modem to the DCU. (This can be done using a pre-made cable from Delta part or by making your own cable using the pinout descriptions found in the Cabling for a Modem Serial Cable starting on page 8–22 at the back of this chapter.)
2.
If the USR modem has dip switches, then before the modem is turned on, set the DIP Switches to match the following Table:
Table 8-4: Modem DIP Switch Configuration for V3 Modem DIP Switch Configuration
Device
DIP 1
DIP 2
DIP 3
DIP 4
DIP 5
DIP 6
DIP 7
DIP 8
V3 controller / ORCAview
UP
UP
DOW N
UP
UP
UP
UP
DOW N
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–6
Total Pages in this Chapter: 32
Modem with a V3 DCU Controller for Dial-In
8–7
To configure a V3 DCU for use with a Modem:
You need to configure the following objects: a. BACnet Protocol Settings (BCP) b. Modem Settings (MDS) c. Serial Port Settings (SNS) objects.
a) BACnet Protocol Settings (BCP) Object
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. b) Modem Settings (MDS) Object 1.
Total Pages in this Chapter: 32
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–7
8–8
Modems and Printers
c) Serial Port Settings (SNS) Object 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–8
Total Pages in this Chapter: 32
Modem with a V3 DCU Controller for Dial-In
8–9
ORCAview Settings for V3 Remote Panel Dial-Up The OWS can be setup entirely at the time of dial-up, so this procedure will be described next. 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.
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–9
8–10
Modems and Printers
Dial Out an Alarm Notification to a Pager See the Sending Alarm Notifications to a Numeric Pager via Modem section near the end of the Chapter 5 – Event Management System in the ORCAview Technical Reference manual.
DCU/DSC Dial-Out to an OWS In ORCAview V3.30, the DCU, DSC-1616, DSC-1212, DSC-1280, DSC-T305/T0, and ASM-24 support serial communication. 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. To dial out from a DSC controller:
Configure NET1 1.
Perform the steps in the Modem with a V3 DSC Controller for Dial-in on page 8–4.
2.
Configure the RPS object as described in following sections.
To dial out from a DCU controller:
Configure BCP1, MDS1, SNS2 1.
Perform the steps in the Modem with a V3 DCU Controller for Dial-in on page 8–6.
2.
Configure the RPS object as described in following sections.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–10
Total Pages in this Chapter: 32
DCU/DSC Dial-Out to an OWS
8–11
Configure RPS
Total Pages in this Chapter: 32
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–11
8–12
Modems and Printers
ADDITIONAL MODEM INFORMATION This section contains additional information on USR Modem Configuration Requirements for Delta V2 Panels and a USR Modem Configuration AT Command Reference.
USR Modem Configuration Requirements for Delta V2 Panels This section contains information from Information Update 612 Modem Configuration Requirements for Delta Panels Rev 1.4 dated 8/Oct/97.
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. Delta supports US Robotics modem with or without DIP switches. The procedure will refer to NVRAM, this acronym stands for Non-Volatile Random Access Memory.
Configuration To configure a USR modem for use with a V2 panel:
1.
Connect the modem to the PC’s communications port with a serial cable.
2.
If the USR modem has dip switches, then before the modem is turned on, set the DIP Switches to match the following Table:
Table 8-6: Modem DIP Switch Configuration for V2 Modem DIP Switch Configuration
Device
DIP 1
DIP 2
DIP 3
DIP 4
DIP 5
DIP 6
DIP 7
DIP 8
V2 DCU
UP
UP
UP
DOWN
UP
UP
UP
DOWN
In most cases the direction of the DIP switches is down for ON and up for OFF. See Table 8-7 for switch function.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–12
Total Pages in this Chapter: 32
USR Modem Configuration Requirements for Delta V2 Panels 3.
8–13
Using a terminal program (i.e. IGRAPH/W or ITERM) enter the Command AT.
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. 4.
OK should be displayed. This response ensures that proper connection to the modem is present.
5.
If the OK result was not obtained check to make sure that:
6.
•
You are using the correct communications port.
•
The terminal program and modem are set up correctly as described in their manuals.
Enter the command ATI4 to display the current modem settings.
7.
The fastest way to program the necessary settings is to enter: AT&F which restores factory defaults, then: ATE0Q1&B0&H0&I0&K0S0=1&W0&W1. This will properly configure the modem, and save the settings to NVRAM.
8.
The modem is now ready for operation with the V2 panel.
9.
If you are using a DAC 25x, &M0 must be used in the above string.
Sample Screen Capture of US Robotics Panel Modem Settings Using GRAPH/W(ATI4) for V2.
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.
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–13
8–14
Modems and Printers
USR Modem Configuration AT Command Reference The following section lists the specific AT command settings for using US Robotics modems with Delta panels. It also explains how to use a terminal program to view the current modem AT configuration. To view modem settings using a terminal program: 1.
Connect your PC to the modem using a db9 to db25 pin cable.
2.
Using a terminal program (i.e. IGRAPH/W or ITERM) enter the Command AT.
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. 3.
OK should be displayed. This response confirms that proper connection to the modem is present.
4.
If the OK result is not obtained, check that:
5.
•
You are using the correct communications port.
•
The terminal program and modem are set up correctly as described in their manuals.
Enter the command ATI4 to display the current modem settings. Compare these settings against the settings listed in Table 8-5 Modem Settings.
Table 8-5: Modem Settings
Command
Setting
Value
Notes
B
US/ITU-T answer sequence
1
Telephone systems outside of North America may use the ITU-T standard in which case the command should be set to 0.
E
Local echo
1
Local echo (display keystrokes) is used only when off line
Q
Result Codes
0
Show Results.
&A
Additional Result Code Subsets
1
&B
Serial port rate
1
&C
Carrier detect override
1
&D
Data terminal ready
2
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–14
Serial rate is fixed.
Total Pages in this Chapter: 32
USR Modem Configuration AT Command Reference
8–15
Command
Setting
Value
Notes
&G
Guard Tone
0
In some countries outside of North America Guard tones may be needed and this setting will be 1 for 550 Hz and 2 for 1800 Hz.
&H
Transmit Data flow control
0
Flow control disabled.
&I
Receive Data flow control
0
Flow control disabled.
&K
Data Compression
0
No compression
&M
Error control
4
Normal/ ARQ
&N
Forced connect speed
0
No forced speed.
&P
Pulse Make/Break ratio
0
In some countries outside of North America the pulse dialing timing is different and this must be set to 1. Only necessary if using pulse dialing.
&R
Receive data Hardware flow control
1
&S
Data set ready override
0
&T
Begins test modes
5
&Y
Brake handling
1
S0
Auto answer mode
1
For no auto answer enter 0. Otherwise S0 equals the number of rings before the modem answers.
S19
Inactivity Timer
0
Setting S19=0 will disable the timer. Setting S19 to any other value will set the duration in minutes for the inactivity timer. It activates when there is no data activity on the phone line. At time-out the modem hangs up
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–15
8–16
Modems and Printers Sample Screen Capture of US Robotics Panel Modem Settings Using IGRAPH/W(ATI4) for V3.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–16
Total Pages in this Chapter: 32
How to Make a Serial Cable
8–17
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.
How to Make a Serial Cable Serial cables may be used to connect a controller to your PC or modem. 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.
To make a serial or modem cable:
1.
Decide which wires in the cable to be used for each line such as Transmit(TX), Receive(RX), or Signal Ground(GND) etc.
2.
Wire the cable as shown in the diagram for the particular product.
3.
Connect the other end of the serial cable to the D connector. Slide the connector shell onto the cable. Solder the conductors onto the connectors, as shown in the specific wiring diagram.
4.
Test the cable and then assemble the D connector shell.
Direct Serial Cable Connections The following serial cable products are available from Delta Controls: Product Number
Total Pages in this Chapter: 32
Description
CBL930-2
FEMALE DB9 connector, 3 pin direct to panel connector, DSC/DCU/DSM, 10 ft. (3m)
CBL930-4
FEMALE DB9 connector, AMP connector, direct to Room Controller, 10 ft. (3m)
CBL931-1
MALE DB25 connector, 5 pin connector, DSC modem cable, 10 ft. (3m)
CBL931-2
MALE DB25 connector, 7 pin, DCU/DSM modem cable, 10 ft. (3m)
CBL931-3
MALE DB25 connector, AMP connector, Room Controller modem cable, 10 ft. (3m)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–17
8–18
Modems and Printers
Direct: Delta System Controllers and Intelli-Sys Products This section gives the Pin configurations for a Delta System Controller (DSC).and the older Intelli-Sys product line:
Pin Label on Controller
Description
TX
Transmit
2
GND
Signal Ground
5
RX
Receive
3
DTR
Data terminal ready
DCD
Carrier Detect.
Direct DB9 PC to Panel
Not Required (N/R) N/R
The maximum cable length is 50 ft (15 m) at 9600 Baud.
2 1 2
2
5
1
(3)
8
3 4 9
DCD
SERVICE PORT
2
5
DTR
1
RX
(5)
7
GND
(2)
6
TX
4
NET2 +
3
24~ POWER GND
1
The following figure shows a direct connection from a DSC controller to a female DB9 connector from a solder side view.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–18
Total Pages in this Chapter: 32
Direct Serial Cable Connections
8–19
Direct: DCU-050, DSM-050, DSC-1616EX Products
DTR
CTS
DCD
RTS
RX
GND
TX
2
3
4
5
6
7
2
3
4
5
6
7
Pin Label on Controller
Description
(1) DTR*
Data terminal ready
(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
*
Total Pages in this Chapter: 32
1
1
This section gives the pin configuration information for direct serial connection to a DCU controller.
Direct DB9 PC to Panel 4 Not Required (N/R)
Only required for modem cables
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–19
8–20
Modems and Printers The following figure shows a Direct connection from COM1 on a DCU controller to a female DB9 connector. Female DB9 Connector (solder side view) 1
CPU
SCAN
TX
USER
24 VAC
6 2 7 3 8 4 9
POWER
5
COM1
(5) (3)
1
2
3
4
5
6
7
TX GND RX RTS DCD CTS DTR
Component Side of DCU
(2)
COM2
1
2
3
4
5
6
7
TX GND RX RTS DCD CTS DTR
Only connect a modem to COM2 of a DCU
2
1
B A
LONWORKS
1
- +
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–20
2
RS485
Total Pages in this Chapter: 32
Direct Serial Cable Connections
8–21
Direct: Application Controllers (DAC25x, DSC-T305/ TO) This section gives the Pin configurations for a direct PC 9-Pin RS-232 connector for a Room Controller. Room Controller is used as a generic name for these types of device: DAC-25x (Version 2 firmware), DSC-T305 & DSC-T0 (Version 3 firmware)
Pin Label on Controller
Description
Direct DB9 PC to Panel
GND
Signal Ground
5
DCD
Carrier Detect.
Not Required (N/R)
RX
Receive
2
TX
Transmit
3
DTR
Data terminal ready
4 5
1
2
3
4
2
3
5
1 9
(3)
7 8
DTR
(2)
6
GND DCD RX D TXD
N/R
(5)
Female DB9 Connector PC end of cable
Maximum cable length 50 ft (15 m) at 9600 Baud
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–21
8–22
Modems and Printers 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) 1
(2)
6 2
(5)
7 3 8 4
(3)
9 5
DTR
TXD RXD DCD GND GND
IP1
Female DB9 Connector (solder side view) OP5 COM
IP4
GND
IP3
GND
IP2
GND
OP4 COM OP3 GND OP2 GND OP1 GND
GND
~24
(-)
(+)
GND
~24
(-)
(+)
Modem Cable Connections This section describes the connections required for modem communications with the products of Delta Controls.
Modems: Delta System Controllers and Intelli-Sys Products
DCD
DTR
RX
GND
TX
1
2
3
4
5
1
2
3
4
5
This section gives Modem Port and pin configurations for a Delta System Controller (DSC) and the Intelli-Sys product line. The maximum cable length is 50 ft (15 m) at 9600 Baud. The following diagram does not apply to the DSC-T305 or DSC-T0 as the pin numbers on the boards differ. The diagram shows a DSC board with 5 wires to a DB25 connector.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–22
Total Pages in this Chapter: 32
Modem Cable Connections
Pin Label on Controller
Description
TX
Transmit
2
GND
Signal Ground
7
RX
Receive
3
DTR
Data terminal ready
20
DCD
Carrier Detect.
8
8–23
DB25 Modem Connection
2 1 2 5 4
9 10 11 12 13
3
8
2
7
SERVICE PORT
6
Total Pages in this Chapter: 32
(8)
5
DCD
(20)
4
DTR
(3)
3
RX
(7)
2
GND
(2)
1
TX
14 15 16 17 18 19 20 21 22 23 24 25
NET2 +
1
24~ POWER GND
1
The following figure shows a modem connection to a female DB25 connector from a solder side view.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–23
8–24
Modems and Printers
Modems: DCU-050, DSM-050, DSC-1616EX Products This section gives the pin configuration information for serial modem connection to a DCU controller. DCU Modem cable available from Delta Controls
CTS
DCD
RTS
RX
GND
TX
1
2
3
4
5
6
7
3
4
5
6
7
MALE DB25 connector, Wieland connector, 10 ft (3 m)
2
CBL931-2
DTR
Description
1
Product Number
Pin Label on Controller
Description
(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
*
Direct DB25 PC to Panel
Only required for modem cables
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–24
Total Pages in this Chapter: 32
Modem Cable Connections
8–25
The following figure shows a DCU controller with a modem connection from COM2 to a female DB25 connector..
CPU POWER
COM1
1
2
3
4
5
6
7
TX GND RX RTS DCD CTS DTR
COM2 7 6 5 4 3 2 2
9 10 11 12 13
1
8
2
7
B A
LONWORKS
1
6
- +
Total Pages in this Chapter: 32
5
RS485
4
(20)
3
(8) (5)
2
(7) (3) (4)
14 15 16 17 18 19 20 21 22 23 24 25
TX GND RX RTS DCD CTS DTR
Only connect a modem to COM2 of a DCU
(2) 1
Component Side of DCU
1
SCAN
TX
USER
24 VAC
Female DB25 Connector (solder side view)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–25
8–26
Modems and Printers
Modems: Application Controllers (DAC-25x, DSC-T305/ TO) This section gives Pin configuration information for how to connect to Modem 25-Pin RS-232 connector for a Room Controller. The term, Room Controller, is used as a generic name for these types of device: DAC-25x (Version 2 firmware), DSC-T305 & DSC-T0 (Version 3 firmware) The RS232 port of the Room Controller uses a MTA-156 5 Pin Connector.
5
4
3
2
1
Pin Label on Controller
Description
(1) DTR*
Data terminal ready
20
(2) TX
Transmit
2
(3) RX
Receive
3
(4) DCD*
Carrier Detect.
8
(5) GND
Signal Ground
7
*
DB25 Modem Connection
Only required for modem cables
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–26
Total Pages in this Chapter: 32
Modem Cable Connections
8–27
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)
IP2
GND
9 10 11 12 13
GND
8
IP3
7
GND
6
IP4
5
OP5 COM
4
(8) (20)
3
IP1
2
(7) DTR TXD RXD DCD GND GND
1
(3)
14 15 16 17 18 19 20 21 22 23 24 25
(2)
Female DB25 Connector (solder side view) OP4 COM OP3 GND OP2 GND OP1 GND
GND
Total Pages in this Chapter: 32
~24
(-)
(+)
GND
~24
(-)
(+)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–27
8–28
Modems and Printers
INSTALLING AND CONFIGURING PRINTERS This section describes how to install and configure a printer for use with: •
ORCAview
•
DCU from a parallel port
Installing a Dot Matrix Printer Driver for ORCAview This section describes the installation and configuration of a dot matrix printer for use with ORCAview. 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. 1.
Double click on My Computer, double click on Control Panel and then double click on Printers in Windows XP or Devices and Printers in Windows Vista or later.
2.
Double click on the Add Printer Icon to create the new Generic / Text Only Printer. The Add Printer Wizard starts.
3.
Click Next to continue.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–28
Total Pages in this Chapter: 32
Installing a Dot Matrix Printer Driver for ORCAview
Total Pages in this Chapter: 32
8–29
4.
Select Local Printer. Click Next to continue.
5.
Under Manufacturers select “Generic” and under Printers select “Generic / Text Only”. Click Next to continue.
6.
Select “LPT1”. Click Next to continue.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–29
8–30
Modems and Printers 7.
Click Next to continue.
8.
Click finish to complete the installation and to print a test page. After the printer is installed, it must be properly configured.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–30
Total Pages in this Chapter: 32
Installing a Dot Matrix Printer Driver for ORCAview 9.
8–31
Right click on the Generic / Text Only Icon in the printer window. Select properties. The following window displays.
10. Switch to the Paper Tab.
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.
Total Pages in this Chapter: 32
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–31
8–32
Modems and Printers
Printer Configuration for a V3 DCU A DCU controller is capable of printing alarm notifications to a parallel printer attached to a DXC053 PC/104 card. The DXC053 expansion card provides the DCU with an LPT port. The DCU cannot use the Windows 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 8–32
Total Pages in this Chapter: 32
Chapter 9 – CONTROLLER NETWORKS 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
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–1
9–2
Controller Networks 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–2
Total Pages in this Section: 160
CONTENTS - CONTROLLER NETWORKS IN ORCAview
9–3
ADVANCED ...................................................................................................... 9–146 STATS............................................................................................................... 9–148 ETHERNET NETWORK SETTINGS (ENS) ............................................ 9–149 GENERAL ......................................................................................................... 9–149 INTELLINET NETWORK SETTINGS (INS) ........................................... 9–150 GENERAL ......................................................................................................... 9–150 TUNNELING NETWORK SETTINGS (TNS) .......................................... 9–151 GENERAL ......................................................................................................... 9–151 UDP/IP NETWORK SETTINGS (UNS) ..................................................... 9–152 GENERAL ......................................................................................................... 9–152 SETUP............................................................................................................... 9–153 DESCRIPTION ................................................................................................... 9–154 SERIAL (RS-232) PORT SETTINGS (SNS) .............................................. 9–155 GENERAL ......................................................................................................... 9–155 SETUP............................................................................................................... 9–156 DESCRIPTION ................................................................................................... 9–157 SLAVE DEVICE LIST (SDL)...................................................................... 9–158 MS/TP SLAVES ................................................................................................ 9–159
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–3
9–4
Controller Networks
CONTROLLER NETWORKS IN ORCAVIEW This chapter covers the following: •
Networking Introduction and Definitions in ORCAview on page 9–4 Describes networking options, routing, protocol, tunneling, routing capability and default settings.
•
Ethernet and TCP/IP on page 9–9.
•
Data Exchange on page 9–26. Describes how to exchange object values from one controller to another.
•
Objects Used in Networking on page 9–54. Describes tabs and fields of software objects used in networking. The BCP and NET1 objects are also included in Chapter 10 - Software Objects Reference.
Networking Information in Other Chapters The following chapters contain additional network information: •
Appendix C - Derived Network Addressing (DNA)
•
Appendix D - Using ORCAview with Version 2 Sites
•
Chapter 10 - Software Objects Reference
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.
CONTENTS - CONTROLLER NETWORKS IN ORCAview OVERVIEW........................................................................................................... 9–4 INTRODUCTION AND DEFINITIONS ....................................................................... 9–5 Networking Options .............................................................................. 9–5 Routing ................................................................................................. 9–5 Protocol ................................................................................................ 9–5 Tunneling .............................................................................................. 9–7 Routing Capability ............................................................................... 9–7 Default Settings .................................................................................... 9–7
Overview This overview section covers the following: •
Introduction and Definitions. Describes new networking options, routing, protocol, tunneling, routing capability, and default settings.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–4
Total Pages in this Section: 160
Introduction and Definitions
9–5
Introduction and Definitions This section covers basic information, definitions and concepts.
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. Version 3 has the following methods of communication: •
Ethernet (using either 10BaseT or 10Base2) DCU has both, DSC only 10BaseT
•
Serial Point-to-Point (PTP) (both direct connect and modem)
•
MS/TP RS-485 for connecting to DACs, V2 Micros or Zones
•
UDP/IP (part of the Internet TCP/IP protocol)
•
Proprietary LinkNet for sensor and I/O devices
•
IntelliNet (using RG59U cable, only in Version 2 DCU)
As a result of the number of network types and the availability of both the BACnet protocol and the Version 2 protocol, numerous sample network layouts are explained at the end of this section.
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 retransmitting 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. When a route value is removed or changed, V3 and V2 DCUs must be restarted in order to remove the old entry in routing table.
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.). Supported protocols include BACnet, Delta Version 2, MicroNet and UDP/IP. Some of the network types that are supported are capable of supporting multiple protocols at the same time. Ethernet is an example of this in that it can simultaneously support BACnet and Delta Version 2.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–5
9–6
Controller Networks
Network interfaces and Protocols supported by the Delta controllers
Simultaneous Protocol Support?
BACnet
Version 2
Ethernet
Yes
Yes
Yes
IntelliNet
Yes
Yes
Yes
Serial RS-232
No
Yes
No
UDP/IP
No
Yes
No
RS-485 (MicroNet)
No
No
Yes
MS/TP (RS-485)
No
Yes
No
Network interfaces and Protocols supported by the OWS
Simultaneous Protocol Support?
BACnet
Version 2
MicroNet
Ethernet
Yes
Yes
Yes
No
IntelliNet
Yes
Yes
Yes
No
Serial RS-232
No
Yes
Yes
Yes
UDP/IP
No
Yes
No
No
MicroNet (RS-485)
No
No
No
Yes
MS/TP (RS-485)
No
Yes
No
No
Network interfaces and Protocols supported by the DSC/DAC
Simultaneous Protocol Support?
BACnet
Version 2
Ethernet
Yes
Yes
Yes
IntelliNet
Yes
Yes
Yes
Serial RS-232
No
Yes
No
UDP/IP
No
Yes
No
MicroNet (RS-485)
No
No
Yes
MS/TP (RS-485)
No
Yes
No
LinkNet
No*
No
No
* The Service Access Port also operates simultaneously over the LinkNet protocol. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–6
Total Pages in this Section: 160
Introduction and Definitions
9–7
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. Tunneling works as follows: 1
A Version 3 DCU receives a Version 2 packet on its IntelliNet interface.
2
The Version 2 packet is routed from the Version 2 IntelliNet interface to the Version 2 Tunneling Interface.
3
The Version 2 packet is converted into a BACnet packet.
4
The new BACnet packet is then sent out to all BACnet interfaces which have the Tunnel checkbox selected in the BCP object. By default, these are the Serial interfaces and the UDP/IP interface.
5
A serially connected OWS now receives this BACnet packet.
6
The BACnet packet is routed to the Version 2 Tunneling interface and unpacked back into the original Version 2 packet.
7
The OWS receives the Version 2 packet as it should.
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. From Network Type
To Network Type
Protocols Supported
Ethernet
UDP/IP
BACnet, Tunneled V2
Serial PTP RS-232 (BACnet)
Ethernet
BACnet, Tunneled V2
IntelliNet
UDP/IP
BACnet, Tunneled V2
MS/TP (RS-485)
Ethernet
BACnet, Tunneled V2
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–7
9–8
Controller Networks
Network Interface
Enabled by Default
Supported Capability
RS-485 NET1
Yes
BACnet MS/TP connection to peer MS/TP devices or to third party MS/TP devices. Default baud rate is 76800, but can be adjusted down to 38400, 19200, or 9600. Automatic routing to other networks.
RS-485 NET2
Yes, when present
BACnet MS/TP connection to peer MS/TP devices or to third party MS/TP devices. Default baud rate is 76800, but can be adjusted down to 38400, 19200, or 9600. Automatic routing to other networks.
PC/104 Ethernet
Any Ethernet connection
DXC052-4/5
Yes, when PC/104 card present for DCU
Serial RS-232
Yes
BACnet PTP connection to an OWS or third party BACnet PTP device
Automatic routing to other non-Ethernet networks
Will automatically detect the presence of a modem if an external modem is connected to the serial port. Depending on dialup support required, modem settings may require configuration in the NET, RPS, or EVR objects Default baud rate is 38400, but can be adjusted down to 19200 or 9600 Automatic routing to other networks UDP/IP WAN connection
No
Disabled by default as additional setup is required Gives ability to communicate to other BACnet equipment over IP networks Requires Ethernet interface to be present. Automatic routing to other non-UDP/IP networks BBMD object must be configured
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–8
Total Pages in this Section: 160
CONTENTS - ETHERNET AND TCP/IP
9–9
ETHERNET AND TCP/IP CONTENTS - ETHERNET AND TCP/IP Caution.................................................................................................. 9–9 ETHERNET OVERVIEW ....................................................................................... 9–10 Basics .................................................................................................. 9–10 DCU / DSC CONTROLLERS AND ETHERNET ...................................................... 9–11 IP Addresses........................................................................................ 9–11 Subnet Masks ...................................................................................... 9–12 IP Routers ........................................................................................... 9–13 Terminology ........................................................................................ 9–14 ADVANCED BACNET/IP NETWORK CONFIGURATIONS (SECONDARY UDP/IP ADAPTER) .......................................................................................................... 9–15 BBMD and Foreign Device................................................................. 9–15 BBMD AND BBMD ........................................................................................... 9–15 Combined Networks ............................................................................ 9–15 Isolated Networks ................................................................................ 9–15 BBMD and Regular IP Device ............................................................ 9–16 Typical Applications ........................................................................... 9–16 BACNET/IP NETWORKS USING NAT ................................................................. 9–18 Single BACnet/IP BBMD with Ethernet Controllers .......................... 9–18 Multiple BACnet/IP Devices behind a NAT ........................................ 9–19 Connecting the OWS ........................................................................... 9–20 Controller Setup .................................................................................. 9–21
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. It is very important that Data Exchange be implemented properly between V3 BACnet devices as all controllers are now peer-to-peer. This means that data exchange created by subnet controllers must also be factored into the overall network traffic. This is particularly crucial for larger networks. Refer to the following Knowledgebase Article (KBA) on the proper implementation of Data Exchange: Data Exchange Rules - QA1090 FYI: Data Exchange between BACnet controllers.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–9
9–10
Controller Networks
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. These standards specify a data frame, packet type, communications rate of 10 Megabits per second (Mbs), cable types, maximum transmission distances, and the way that other communication devices could be used throughout an Ethernet network. 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.
Cable Type
Length per segment
Maximum Segment s
Devices/ Segment
Maximum Repeater s
Connecto r Type
Cabling Type
Total combined segment length
Thin net (10Base2 )
185m (600 ft)
5
30
4
BNC
RG58U Coaxial
925m (3000 feet)
UTP (10BaseT )
100m (330 ft)
Determine d by hub
N/A
N/A
RJ45
Category 5 UTP
N/A
Communication Devices There are various Ethernet devices used in installations to provide flexibility and to solve many network problems. Device Type
Description
Protocol Support
Repeater
A simple device that receives, amplifies and then re-transmits the input signals. The network does not "see" the inclusion of this device. It is used mainly with Thin net where cable segment length exceeds the maximum segment length limitation.
Delta 802.2 and UDP/IP
Bridge
An "intelligent" device that receives transmitted data from one Ethernet interface and passes it along to another Ethernet interface which is connected to a different network. Usually able to handle most protocol types.
Delta 802.2 and UDP/IP
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–10
Total Pages in this Section: 160
DCU / DSC Controllers and Ethernet
IP Router
A device that connects two or more networks which are using the same 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.
9–11
UDP/IP
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 star-topology. It contains multiple ports to allow many cable runs from each individual device to the hub. Networks using Thin net (10Base2) do not require hubs.
Delta 802.2 and UDP/IP
Gateway
A device which forms a logical connection between networks which are using different protocols. Like a Bridge, Gateways are usually a rather complex device.
UDP/IP
Transceive r
A device used to translate one type of physical network to another. For example, a transceiver can be used to connect a Thin net (BNC connector) to a Fiber Optic (10BaseF) or UTP (10BaseT) medium.
Delta 802.2 and UDP/IP
DCU / DSC Controllers and Ethernet A DCU controller, manufactured by Delta Controls, has connectors to support both Thin net and UTP. The protocol is selected by the software objects BACnet Protocol Settings (BCP) and Version 2 Protocol Settings (V2P). While only one physical connector can be used at a time, both supported protocols (802.2 and UDP/IP) can be used simultaneously. 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. UTP 10BaseT is used in conjunction with the following hardware: •
Category 5 UTP cable with RJ45 ends
•
10BaseT Hubs
Each DCU is connected by category 5 UTP cable to a hub which patches all of the individual links together. No terminating resistors are necessary as in Thin net.
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:
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–11
9–12
Controller Networks 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: 192.168.1.10 is on the same network as 192.168.1.23 This means that these two devices can communicate without the need for an IP Router. However: 192.168.1.10 is NOT on the same network as 11.123.200.4 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: Address Class
Subnet Mask
Maximum Devices
Maximum Networks
Class A
255.0.0.0
16,777,214
254
Class B
255.255.0.0
65,534
65,534
Class C
255.255.255.0
254
16,777,214
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–12
Total Pages in this Section: 160
DCU / DSC Controllers and Ethernet
9–13
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. Simplistically, a 0 in a subnet mask means that devices whose IP addresses are different in only that field are on the same network, and can communicate without the need of an IP Router. 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. A subnet broadcast is a transmission made by one device to all other devices in the local subnet. 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. 2. The local device sends the packet to the IP Router instead. 3. The IP Router receives the packet and then re-sends it to the remote network. 4. The device on the remote network receives the packet. IP Routers are commonly used in Wide Area Networks (WANs) to join the individual networks (LANs) at each site to each other.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–13
9–14
Controller Networks
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 Devices
Repeaters, bridges, routers, and gateways that assist communication on a 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
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.
DCU controller that acts as a router must have an address lower than 32767 if there are V2 devices on the network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–14
Total Pages in this Section: 160
Advanced BACnet/IP Network Configurations (Secondary UDP/IP Adapter)
9–15
Advanced BACnet/IP Network Configurations (Secondary UDP/IP Adapter) The DSM-RTR has a secondary UDP/IP adapter, allowing it to communicate on two separate BACnet/IP networks. It can be configured to route network traffic between the networks, or it can limit traffic flowing between them (in conjunction with IP packet filtering). Typical configurations of the two UDP/IP adapters are: •
BBMD and foreign device
•
BBMD and BBMD
•
BBMD and Regular IP device
BBMD and Foreign Device Using the DSM-RTR as both a BBMD and foreign device is very useful in Centralized Site Management Systems (CSMS). CSMS applications usually require bi-directional contact initiation. This means that not only does the remote site need to contact the central site, but the central site also needs to initiate direct contact with the remote site. The need for either side to initiate the connection differentiates CSMS from a traditional BACnet/IP network, where the central site is always only a server and the remote sites are only clients. Since a BBMD connection does not handle dynamic IP addresses (DHCP), and a foreign device can only be a client, a complete CSMS solution requires the DSMRTR be both a BBMD and foreign device. The foreign connection is used to connect the remote site with the central site, and the BBMD connection is used for the central site to initiate a direct connection with the remote site (by a service technician).
BBMD and BBMD Using the DSM-RTR as a BBMD on two separate BACnet/IP networks can be used to isolate or combine the networks.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–15
9–16
Controller Networks In order to utilize this application, IP packet filtering must be enabled on the DSM-RTR to disable routing between the two UDP/IP adapters. For example, UDP/IP adapter 1 connects the site to a Master BBMD, and UDP/IP adapter 2 is used for service technicians to log in. By enabling IP packet filtering between the two UDP/IP adapters, the service technician would only load descriptors from the local site, which would be faster than loading descriptors from all remote sites. 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.
BBMD and Regular IP Device A typical application of using the DSM-RTR as both a BBMD and Regular IP device is to route between two networks of BACnet/IP devices on the WAN and LAN sides of a NAT device (assuming there is only a single segment of BACnet/IP devices on the LAN side). For more information, refer to BACnet/IP Networks Using NAT (Single IP Segment Behind NAT).
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 UDP/IP-2: Disabled
(Device Type = BBMD)
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–16
Total Pages in this Section: 160
BBMD and BBMD
9–17
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 Remote Foreign Device Description
The remote foreign device connects an entire BACnet site to the BACnet/IP network by communicating directly with the Master BBMD (it registers with the Master BBMD). 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. Settings NET Object: Ethernet: Enabled UDP/IP-1: Enabled (Device Type = Foreign; to connect to Master BBMD) (Device Type = BBMD; to allow service technicians to log in)
UDP/IP-2: Enabled
BMD Object (IP Filtering Options): Disable communication between UDP/IP-1 and UDP/IP-2 Disable IP Regular support on UDP/IP-2
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–17
9–18
Controller Networks
BACnet/IP Networks Using NAT This section describes how to setup a network of BACnet/IP devices when using Network Address Translation (NAT), such that BACnet/IP devices behind a NAT device will be able to communicate with BACnet/IP devices external to the NAT device. It contains a few general network layout examples. These examples are meant to be a starting point to derive more complex network layouts. Note: It is possible for BACnet/IP controllers to be on the same network segment
as other IP devices (i.e. computers), as long as they have separate IP Addresses.
Network Address Translation (NAT) allows a single device (such as an IP router, firewall, proxy, or computer) to act as an agent between the Internet (or "public network") and a local (or "private") network. This means that only a single, unique IP address is required to represent an entire network of IP devices (i.e. computers and controllers). 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.
Single BACnet/IP BBMD with Ethernet Controllers 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 one BACnet/IP BBMD device and multiple Ethernet only controllers. 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
B/IP Device (UDP port 47808)
Routing UDP port 47808 to BBMD Device
BBMD Device (UDP port 47808)
Routing UDP/IP and Ethernet
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–18
Ethernet Device
Ethernet Device
Ethernet Device
Ethernet only
Total Pages in this Section: 160
BACnet/IP Networks Using NAT
9–19
Multiple BACnet/IP Devices behind a NAT When using Network Address Translation with BACnet/IP networks, it is important to note that only one BACnet/IP device, on the local network, can have data forwarded to it from the Network Address Translation device, for a specific UDP port number. In order to communicate with all BACnet/IP controllers on the local network side of the NAT device from an external network, this BACnet/IP device must have a separate UDP port number than all other BACnet/IP devices on the local network. 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 DSMRTR 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 NAT
Ethernet/IP "local" network
Routing UDP port 47808 to DSM-RTR B/IP Device (UDP port 47808)
DSM-RTR Regular IP Device UDP/IP-1 BBMD (port 47808) (UDP port 47809) UDP/IP-2 Regular IP (port 47809)
Routing UDP/IP and Ethernet
Regular IP Device (UDP port 47809)
UDP/IP only
Ethernet Device
Ethernet only
Multiple IP Segments Behind NAT
This example illustrates a setup where there are multiple network segments of BACnet/IP controllers behind a NAT device with a mix of BACnet/IP and Ethernet only controllers on the network segments.
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 DSMRTR 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–19
9–20
Controller Networks 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 NAT Routing UDP/IP and Ethernet
B/IP Device (UDP port 47808)
Ethernet/IP network
IP Router
UDP/IP only
DSM-RTR Regular IP Device UDP/IP-1 BBMD (port 47808) (UDP port 47809) UDP/IP-2 BBMD (port 47809)
Routing UDP port 47808 to DSM-RTR
Routing UDP/IP and Ethernet
UDP/IP only
Ethernet only
BBMD Device 2 (UDP port 47809)
Regular IP Device (UDP port 47809)
Ethernet Device
Ethernet only
Ethernet Device
Ethernet/IP network
IP Router Routing UDP/IP and Ethernet
UDP/IP only
Ethernet only
BBMD Device 3 (UDP port 47809)
Regular IP Device (UDP port 47809)
Ethernet Device
Ethernet/IP network
IP Router Routing UDP/IP and Ethernet
UDP/IP only
Ethernet only
BBMD Device 4 (UDP port 47809)
Regular IP Device (UDP port 47809)
Ethernet Device
For this setup, the List of BBMDs (BMD) objects need to be setup in the DSMRTR 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: 1.
In the DSM-RTR, enter the IP addresses of the other BBMD devices behind the routers into its BMD2 object. In this case, BBMD Device 2, 3, and 4.
2.
In BBMD Device 2, 3, and 4, enter the IP address of just the DSM-RTR into their BMD1 object.
Connecting the OWS Multiple OWS’s can log in on the local network side of the NAT via Ethernet or UDP/IP (via Local network). It may be possible to have multiple OWS's on the local network side of the NAT log into remote networks via UDP/IP, but this depends on whether the NAT device is able to assign separate external port numbers for each OWS. This means that the NAT device would need to know how to forward the BACnet replies back to each OWS. This could cause problems if you have a BBMD controller on the local network with port forwarding set up to forward to that BBMD and the NAT is unable to assign separate external port numbers to each OWS. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–20
Total Pages in this Section: 160
BACnet/IP Networks Using NAT
9–21
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.
Total Pages in this Section: 160
•
To enable a controller to route data between Ethernet and UDP/IP, you must enable both ports in the NET or BCP object (depending on whether it is a DSC/DSM-RTR or DCU). This is indicated in the previous network diagrams with “Routing UDP/IP and Ethernet” next to any controllers that this is applicable for.
•
In the BBMD device on the local network side that is communicating to an external network, the ‘Proxy (NAT) Address’ field in the NET or BCP object must contain the external IP Address of the NAT device.
•
The UDP port number is specified in the NET or BCP object of the controller.
•
In order for an external BACnet/IP Device to communicate with a BBMD Device behind a NAT device, it needs to know the IP Address of the NAT's external address and not the IP address of the BBMD Device behind the NAT.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–21
9–22
Controller Networks
CONNECTING BACNET SYSTEMS Contents - Connecting BACnet Systems OVERVIEW......................................................................................................... 9–22 INSTRUCTIONS THAT PERTAIN TO ALL BACNET NETWORK TYPES .................... 9–22 BACnet Devices with ISO 802-3 Ethernet .......................................... 9–23 BACnet Devices with Serial EIA-232 PTP ......................................... 9–23 BACnet Devices with EIA-485 MS/TP ................................................ 9–24 BACnet Devices with ARCNET .......................................................... 9–25 BACnet Devices with BACnet/IP ........................................................ 9–25
Overview This document explains how to connect different vendors' BACnet systems at the network level in order to obtain interoperability. The section is broken into two parts: •
Instructions that apply whenever BACnet systems are joined
•
Instructions which pertain to a particular network type
Instructions that Pertain to all BACnet Network Types Although BACnet is largely plug-and-play, there are initial steps that must be taken prior to connecting BACnet devices to each other. Before proceeding with the actual connection, read the Protocol Implementation Conformance Specification document (PICS) for each BACnet device. The PICS documents give essential information when trying to connect to that device. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–22
Total Pages in this Section: 160
Instructions that Pertain to all BACnet Network Types
9–23
The third consideration is BACnet Network Numbers. In BACnet, each physical network segment is given its own, unique, network number. The range of BACnet network numbers is 1 to 65534. Each device connected to a particular network (for example a single MS/TP network) should reference that network with the same Network Number. However, it is not essential that all BACnet devices know this Network Number. Only BACnet Routers, which send traffic from one network type to another (for example Ethernet to Serial) truly need to know the Network Numbers. Other devices on the network that are not routing can be set a Network Number of 0. 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.
BACnet Devices with ISO 802-3 Ethernet Ethernet is perhaps the easiest method of connecting BACnet devices. The reason for this is that there are no optional or settable components to Ethernet. The largest problem that could come up is connecting a device that uses a 10BaseT connector (UTP RJ45) to a device which uses a 10Base2 connector (Coaxial BNC). 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.
BACnet Devices with Serial EIA-232 PTP Serial links provide a slow, cheap method of connecting two devices. The key constraint is that only two BACnet devices can be connected by a single serial link. When connecting serial devices, two main issues have to be considered. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–23
9–24
Controller Networks 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 Parameter
Explanation
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.
BACnet Devices with EIA-485 MS/TP BACnet MS/TP is the BACnet method for communicating over EIA-485 networks. This network uses a simple wire pair, and is connected to all controllers in the network. The only thing to observe about the physical connection is that proper polarity is observed. 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. One other consideration on MS/TP networks are MAC Addresses. A MAC Address is a unique number given to each device on the MS/TP network. The MAC Address is independent of the Device's Number. The range of MAC Addresses is 0 to 127 for Master Nodes and 0 to 254 for Slave Nodes. Master Nodes are devices on the network that are capable of initiating communication with another controller, whereas Slave Nodes cannot initiate communication; they only respond when requested to. The important point to realize is that each device on a particular MS/TP network must have its own, unique MAC Address in order to communicate on the MS/TP network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–24
Total Pages in this Section: 160
Instructions that Pertain to all BACnet Network Types
9–25
BACnet Devices with ARCNET ARCNET is a network type that is similar to Ethernet. However, like Ethernet, a number of different architectures are possible when using ARCNET. Furthermore, some ARCNET implementations do not use standardized connectors, which can cause problems when trying to connect different devices. ARCNET is an older network type that is being rapidly replaced by Ethernet. At one time ARCNET had a substantial cost advantage over Ethernet, but this is no longer the case. At this time it appears that only vendors which have historically supported ARCNET are continuing to use ARCNET with their BACnet products.
BACnet Devices with BACnet/IP BACnet/IP is the name given to TCP/IP protocol over Ethernet. Essentially an Ethernet network is used to convey TCP/IP traffic, which contains BACnet information. TCP/IP is the protocol that is used on the Internet and on Wide-AreaNetworks (WAN). 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 offsite OWS to look at a remote building's network, which is the reason for using TCP/IP in the first place! To address this deficiency, the BACnet committee defined a new standard, referred to as Annex J. Annex J allows much more flexible configurations and will likely replace all existing Annex H setups. Regardless of which standard is used, BACnet/IP is designed to allow communications between devices that are in different buildings using existing Wide-Area-Networks. It would be impossible to go into all of the specifics of setting up a device to communicate using BACnet/IP here, but all BACnet/IP devices share some common properties, which are given in the following table:
Total Pages in this Section: 160
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 Address
A gateway is a device for linking one TCP/IP network to another TCP/IP network. Gateway Address is the IP Address of the Gateway.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–25
9–26
Controller Networks
DATA EXCHANGE Contents - Data Exchange DATA EXCHANGE OVERVIEW ............................................................................ 9–26 READING VALUES ............................................................................................. 9–27 Reading Values From a Remote V3 Controller .................................. 9–27 Reading Values From a Remote Version 2 Controller ....................... 9–29 Reading Values From A Remote Third Party BACnet Controller ...... 9–31 WRITING VALUES .............................................................................................. 9–32 Writing Values to a Remote BACnet Controller ................................. 9–32 Writing Values to a Remote Version 2 Controller .............................. 9–34 Writing Values to a Remote Third Party BACnet Controller ............. 9–35 OTHER CONSIDERATIONS .................................................................................. 9–36 OWS Capabilities ............................................................................... 9–36 Adjusting the Timing of a Data Exchange .......................................... 9–36
Data Exchange Overview This section describes how to exchange object values from one controller to another. In Version 2, this process was handled automatically. In Version 3, the process is automatic also, but numerous configuration changes can be made. 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. This section describes the following aspects of data exchange: •
Reading Values from a remote V3 controller, Version 2 Controller, or third Party BACnet Controller.
•
Writing Values to a remote V3 controller, Version 2 Controller, or third Party BACnet Controller.
•
Other Considerations include the capability of the OWS, Adjusting the Timing of a Data Exchange, and Data Exchange using BACnet Half-Routers between Controllers.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–26
Total Pages in this Section: 160
Reading Values
9–27
Reading Values Reading Values From a Remote V3 Controller As in Version 2, reading values from a remote controller only requires a link to be made in a GCL+ program. The following program segment shows how this is accomplished:
In this case, an outdoor temperature sensor is connected to an AI on controller 4. Controller 89 would like to know the value of the sensor on controller 4. The program statement in the previous figure sets the value of 'Local OAT value' (which is an AV in controller 89) equal to the value of the sensor on controller 4. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–27
9–28
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–28
Total Pages in this Section: 160
Reading Values
9–29
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.
Reading Values From a Remote Version 2 Controller As in Version 2, reading values from a remote Version 2 controller only requires a link to be made in a GCL program. The following program segment shows how this is accomplished:
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.
In this case, an outdoor temperature sensor is connected to an IP point on controller 2. In this example, controller 2 is a version 2.92 DCU. Controller 89 would like to know the value of the sensor on controller 2. The program statement in the previous figure, sets the value of 'Local OAT value' (which is an AV in controller 89) equal to the value of the sensor on controller 2. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–29
9–30
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–30
Total Pages in this Section: 160
Reading Values
9–31
When exchanging values from a Version 2 controller to a BACnet DCU, only one method (Optimized Broadcast) can be used.
Reading Values From A Remote Third Party BACnet Controller The BACnet standard defines a number of core objects and the values from these core objects can be read from third party controllers. The most likely objects that would be read in this manner are: AI, AO, BI, BO, AV and BV. An obvious example of the usefulness of this capability is to read a BACnet chiller's operating status. Previously, the controls industry had to be content with only knowing a few of a chiller's operating parameters, such as Amps, leaving chilled water temperature, and returning condenser water temperature. This was normally provided by hard-wired input points on the control system. In a BACnet system, many more (if not all) of the chiller's operating parameters can be known in the building control system. Reading a third party's object values is very similar to reading from a remote Delta controller. GCL program links are set up in the same fashion described in the Reading Values From A Remote V3 Controller section starting on page 9–27. The Delta controller will create a DER object, which refers to the remote object value, just as it did before. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–31
9–32
Controller Networks
Writing Values Writing Values to a Remote BACnet Controller As in Version 2, it is possible to write to a remote value. However, unlike Version 2, remote outputs can now be written to. This means that an output on a controller could be controlled directly by another controller in the network. This is normally a bad practice, as the output now relies totally on the network communication. This is why it was prevented in Version 2. BACnet, however, requires that outputs can be written to by remote controllers. Writing values to remote controllers is not normally required, because the remote controller could instead read the value. Reading is the preferred method.
Caution: It is possible to do a remote write from a PG to a variable even when it is in Manual mode. During a remote write, the status of the object is not checked. This behavior affects AV, BV, and MV objects on OWS, DCU, DAC and BACstat products. Avoid doing a remote write to a variable as it is poor programming practice and makes code difficult to troubleshoot. The remote write capability is intended only for third party devices. All programming should be local to the outputs that are being controlled. 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'. The following program segment shows how to setup a write:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–32
Total Pages in this Section: 160
Writing Values
9–33
In the previous figure, a controller in controller 89 (AHU 1 MAD controller) is trying to control an Analog Output (AO) on controller 4 (AHU 1 Mixed Air Dampers). Notice that the GCL statement which causes the data exchange to happen is enclosed in a 'DoEvery' loop. This is very important, because, like Version 2, a write will take place immediately. 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 controller. 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:
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–33
9–34
Controller Networks
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.
Writing Values to a Remote Version 2 Controller Some V2 controller types can be written from a V3 controller. The ones that can be written to are V2 DCUs, V2 Micro's (actually use ZC to transfer data), V2 DACs, and PLUS controllers, The 2.92 Build 27 controller operating system (firmware) includes support for Turbo, Mini Turbo and Intelli-Con also. The result of this is that V2 values can be communicated to V3 DCUs, and V3 DCUs can communicate back to the V2 controller. 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:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–34
Total Pages in this Section: 160
Writing Values
9–35
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 Values to a Remote Third Party BACnet Controller This is one of the new capabilities that a BACnet system provides. Other vendor's BACnet product has many of the same objects as the Delta BACnet controllers. The most likely objects that would be written in this manner are: AV, BV, AO, and BO. An obvious example of the usefulness of this capability is to write a new chilled water setpoint to a BACnet chiller. Previously, the controls industry had to be content with hard-wired output points to control a chiller. In a BACnet system, many more of the chiller's settings can be set by the building control system. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–35
9–36
Controller Networks
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.
Adjusting the Timing of a Data Exchange The timing of a data exchange is how much time will elapse from one exchange of a value to the next. There are different methods by which this time is determined, which depend on the method of Data Exchange used. Broadcast or Optimized Broadcast Broadcast or Optimized Broadcast Data Exchanges based on Broadcast or Optimized Broadcast (the default) 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. Ask yourself the question: Which controller has the data that I want to receive? For example, if controller 89 wishes to receive an object's value in controller 4, then the DES object to adjust is the one in controller 4. The following is an example of the DES object:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–36
Total Pages in this Section: 160
Other Considerations
9–37
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:
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–37
9–38
Controller Networks 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. Change of Value Data Exchanges based on the Change of Value (COV) exchange type are not timed like the others. They, instead, operate based on the value that is being exchanged. This could be useful for something like a room temperature, which is likely changing very slowly. Using COV, the room temperature could be transferred from one controller to another when it changes by more than 1 degree, for example. The amount that the value has to change by is set in the object itself. The following is an example using the Analog Variable (AV) object.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–38
Total Pages in this Section: 160
Table of Contents
9–39
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-IsAll' 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
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–39
9–40
Controller Networks
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. IP packet filtering allows BBMD devices 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: 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 filtering options are: •
Block Ethernet broadcasts from Delta devices on page 9–42
•
Disable routing between UDP/IP adapters on page 9–43
•
Disable IP Regular support on page 9–44
•
Disable routing global broadcasts on page 9–45
•
Disable Foreign-to-Foreign communication on page 9–46
•
Disable routing between Ethernet and UDP/IP on page 9–46
•
Disable routing DE broadcasts to UDP/IP on page 9–47
•
Block routed packets from Ethernet on page 9–47
•
Ignore I-Am-Router from Ethernet on page 9–49
•
Disable routing global broadcast Who-Is-All on page 9–50
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–40
Total Pages in this Section: 160
Enabling IP Packet Filtering
9–41
Enabling IP Packet Filtering IP packet filtering is enabled in the BMD object of the device you want to filter BACnet network traffic. To enable IP packet filtering:
1
Using Navigator, open the BMD1 object
2
Select the IP Filter tab
3
Enable the desired filters (checkboxes)
When using IP Filters, consider the following: •
Total Pages in this Section: 160
These filters are disabled by default, and should only be enabled once you are familiar with their operation and you have determined what type of traffic to filter.
•
All of these filters can be enabled or disabled without resetting the device.
•
These filter options are only available in the BMD1 object (not BMD2).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–41
9–42
Controller Networks
Block Ethernet Broadcasts from Delta Devices This filter blocks global broadcast packets, 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. 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 applies to both UDP/IP adapters on the DSM-RTR. Major sources of global broadcast packets include: •
Data Exchange Broadcast or Optimized Broadcast data exchange with a destination of BROADCAST in the DES object.
•
OWS An Operator Workstation (OWS) is a major source of global broadcast network traffic (particularly when finding new devices).
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 subnetwork 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–42
Total Pages in this Section: 160
Disable Routing Between UDP/IP Adapters
9–43
Disable Routing Between UDP/IP Adapters This filter blocks all packets from being routed between one UDP/IP adapter to the other. 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 Network
BACnet/IP Network
DSM-RTR
BACnet/IP Device MASTER BBMD
Total Pages in this Section: 160
Disable Routing Between UDP/IP Adapters Filter Enabled
BACnet/IP Device SERVICE TECH OWS
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–43
9–44
Controller Networks
Disable IP Regular Support In many installations, the BBMD is the only BACnet/IP device on a particular network segment, with all other devices on Ethernet. As a result, this filter will restrict the BBMD from re-broadcasting packets over the local IP segment. In addition, with this filter enabled, the BBMD will ignore BACnet/IP packets from other devices on the local IP segment. 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 subnetwork). Remote BACnet/IP Device
Internet
Ethernet Network
BACnet/IP Network
DSM-RTR
Ethernet Device
Disable IP Regular Support Filter Enabled Local BACnet/IP Device
LOCAL NETWORK SEGMENT
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–44
Total Pages in this Section: 160
Disable Routing Global Broadcasts
9–45
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). 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). Major sources of global broadcast packets include: •
Data Exchange Broadcast or Optimized Broadcast data exchange with a destination of BROADCAST in the DES object.
•
OWS An Operator Workstation (OWS) is a major source of global broadcast network traffic (particularly when finding new devices).
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 Ethernet Network
Ethernet Device
Total Pages in this Section: 160
DSM-RTR
MS/TP Devices
BACnet/IP Network(s)
BACnet/IP Device
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–45
9–46
Controller Networks
Disable Foreign to Foreign Communication This filter restricts the BBMD from sending packets from one foreign device to another foreign 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).
Foreign Device
Internet
REMOTE SITE
Foreign Device
REMOTE SITE
DSM-RTR
Disable Foreign to Foreign Communication Filter Enabled
MASTER BBMD
Disable Routing Between Ethernet and UDP/IP This filter blocks all packets from being routed between Ethernet and UDP/IP. 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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–46
Total Pages in this Section: 160
Disable Routing DE Broadcasts to UDP/IP
9–47
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 subnetwork).
LOCAL SITE
BACnet/IP Network
Ethernet Network
DSM-RTR
Disable Routing Between Ethernet and UDP/IP SERVICE TECH Filter Enabled OWS Ethernet Device
BACnet/IP Device
REMOTE SITE
Disable Routing DE Broadcasts to UDP/IP Some Data Exchange (DE) packets are sent out as global broadcast packets. These packets are transmitted to the entire BACnet network. Data Exchange packets are transmitted at periodic rate, e.g. every 30 seconds. Generally DE packets only need to reach local devices, eg devices within the same building/site. In most cases there is no need for DE packets to reach every devices on every network. Consider these cases: 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. This filter blocks the following: •
Total Pages in this Section: 160
Remotely generated global broadcast OBCast (Optimized Broadcast) packets to the BACnet IP network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–47
9–48
Controller Networks •
Remotely generated global broadcast COV Notifications to the BACnet IP network
•
Locally generated local and global broadcast OBCast (Optimized Broadcast) packets to the BACnet IP network
•
Locally generated local and global broadcast COV Notifications to the BACnet IP network
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).
Block Routed Packets from Ethernet This filter blocks routed packets received on the Ethernet network from being routed to the IP network(s). In other words, if the device receives a packet on the Ethernet network, and if the packet did not originate on the local Ethernet network (i.e. from an MS/TP sub-network), it is blocked. 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. This filter applies to both UDP/IP adapters. 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 subnetwork).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–48
Total Pages in this Section: 160
Ignore I-Am-Router from Ethernet
BACnet/IP Network
Internet
9–49
BACnet/IP Network(s)
Ethernet Network
Master BBMD (DSM-RTR)
Remote BACnet/IP Device
Master BBMD MS/TP Devices
Block Routed Packets from Ethernet Filter Enabled
LOCAL NETWORK
REMOTE BBMD
Ignore I-Am-Router from Ethernet With this filter enabled, the device will ignore I-Am-Router packets received on the Ethernet segment. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–49
9–50
Controller Networks The following diagram illustrates the above example application (multiple Master BBMD’s on the same Ethernet segment).
Disable Routing Global Broadcast Who-Is-All This filter blocks global Who-Is All broadcast packets from being routed. Transmitting a global broadcast Who-Is-All message provides a mechanism for a BACnet device to discover all devices on the BACnet network. Every device receiving the Who-Is-All responds with an I-Am; and the issuing device can collect the I-Am responses. This mechanism works well on small networks, with a handful of devices; however, on large networks the number of I-Am responses can easily overwhelm intermediate routers. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–50
Total Pages in this Section: 160
Typical IP Packet Filtering Settings
9–51
Typical IP Packet Filtering Settings This section lists IP packet filtering settings for typical BACnet/IP Router applications. It is only intended as a guide, as specific applications vary.
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). A Master BBMD typically communicates on only one BACnet/IP network. Therefore, UDP/IP-1 is enabled and UDP/IP-2 is disabled. Master BBMD 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 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–51
9–52
Controller Networks
Remote BBMD 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
Remote Foreign Device The remote foreign device connects an entire BACnet site to the BACnet/IP network by communicating directly with the Master BBMD (it registers with the Master BBMD). 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. Remote Foreign Device 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–52
Total Pages in this Section: 160
Typical IP Packet Filtering Settings
9–53
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
Ethernet/IP
Total Pages in this Section: 160
Internet
Ethernet/IP
Remote BBMD Device
Remote Foreign Device
REMOTE SITE
REMOTE SITE
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–53
9–54
Controller Networks
OBJECTS USED IN NETWORKING This section contains reference information on objects used in networking. See Chapter 10 - Software Reference for information on other objects. Also Appendix B - Preferences and Setup contains information on objects that set options and defaults for different components of ORCAview. 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.
Contents - Objects Used in Networking 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 Name (Channel) ................................................................................. 9–68 Broadcast Interval .............................................................................. 9–69 Max COV per Interval ........................................................................ 9–69 Exchange Type ................................................................................... 9–69 TRANSMIT ENTRIES ........................................................................................... 9–70 Dataview............................................................................................. 9–71 Next Broadcast in ............................................................................... 9–72 RECEIVE ENTRIES .............................................................................................. 9–73 Last Received ...................................................................................... 9–73 Receive Dataview ............................................................................... 9–73 DESTINATIONS TAB ........................................................................................... 9–75 Broadcast Destinations Column ......................................................... 9–75 STATUS .............................................................................................................. 9–76 Next Broadcast in ............................................................................... 9–76 COVs Remaining ................................................................................ 9–76 Time Since Last Update ...................................................................... 9–76 Received From Dataview ................................................................... 9–77 DATA EXCHANGE LOCAL (DEL) ............................................................ 9–78 HEADER (DEL) ................................................................................................. 9–78 Exchange Value .................................................................................. 9–78 Exchange Flags .................................................................................. 9–78 Local Flags ......................................................................................... 9–79 FIELDS (DEL) .................................................................................................... 9–79 Name................................................................................................... 9–79 Local Object ....................................................................................... 9–79 Exchange Type ................................................................................... 9–80 Manual Subscription .......................................................................... 9–80 Dataview............................................................................................. 9–80
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–54
Total Pages in this Section: 160
Contents - Objects Used in Networking
9–55
DATA EXCHANGE REMOTE (DER) ......................................................... 9–81 HEADER (DER) .................................................................................................. 9–81 Exchange Value .................................................................................. 9–81 Exchange Flags ................................................................................... 9–82 Remote Flags ...................................................................................... 9–82 FIELDS (DER) .................................................................................................... 9–82 Name ................................................................................................... 9–82 Remote Object ..................................................................................... 9–83 Exchange Type .................................................................................... 9–83 Number of Subscribers ........................................................................ 9–84 DATA EXCHANGE SETTINGS (DES) ....................................................... 9–85 SETUP................................................................................................................. 9–86 Default Exchange Type ....................................................................... 9–86 BROADCASTING ................................................................................................. 9–87 Broadcast Interval............................................................................... 9–88 Next Broadcast In................................................................................ 9–88 Last Broadcast Duration ..................................................................... 9–88 Broadcast Destinations Dataview ....................................................... 9–88 Reducing Broadcast Traffic ................................................................ 9–89 POLL .................................................................................................................. 9–89 Interval ................................................................................................ 9–90 Next Poll In ......................................................................................... 9–90 Last Poll Duration .............................................................................. 9–90 SUBSCRIPTION .................................................................................................... 9–90 Interval ................................................................................................ 9–90 Next Subscription in ............................................................................ 9–91 Last Subscription Duration ................................................................. 9–91 DESCRIPTION ..................................................................................................... 9–91 BACNET PROTOCOL SETTINGS (BCP) [COPY] ................................... 9–92 DESCRIPTION ..................................................................................................... 9–92 SETUP................................................................................................................. 9–93 Column Headings on Setup Tab .......................................................... 9–93 Ethernet Network Specific Settings ..................................................... 9–94 Intelli-Net Network Specific Settings................................................... 9–94 Serial (RS-232) Port Specific Settings ................................................ 9–95 MS/TP Network Specific Settings ........................................................ 9–96 UDP/IP Network Specific Settings ...................................................... 9–97 ADVANCED ........................................................................................................ 9–99 Local Network Number ....................................................................... 9–99 PROTOCOL ....................................................................................................... 9–100 Version .............................................................................................. 9–100 Revision ............................................................................................. 9–100 Max. APDU Size ............................................................................... 9–100 Retry Time ......................................................................................... 9–101 Retries ............................................................................................... 9–101 Segment Timeouts ............................................................................. 9–101 STATS............................................................................................................... 9–101 MS/TP SLAVES ................................................................................................ 9–102 Device Number.................................................................................. 9–102 Max APDU Size ................................................................................ 9–102 Segmentation ..................................................................................... 9–102 Vendor ID.......................................................................................... 9–103 MAC Address .................................................................................... 9–103
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–55
9–56
Controller Networks NETWORK PROTOCOL SETTINGS (NET) [COPY] ............................ 9–105 HEADER ........................................................................................................... 9–105 DESCRIPTION ................................................................................................... 9–105 SETUP .............................................................................................................. 9–106 Setup Dataview Headings................................................................. 9–107 Setup Tab: Setup MS/TP ................................................................... 9–108 Setup Tab: Statistics MS/TP (same fields for PTP, Ethernet, and UDP/IP) ........................................................................................... 9–110 Application Stats............................................................................... 9–111 Setup Tab: Setup PTP (Point to Point) ............................................. 9–111 Setup Tab: Statistics PTP (Same as MS/TP Statistics) ..................... 9–113 Network Stats .................................................................................... 9–113 Application Stats............................................................................... 9–113 Setup Tab: Setup Ethernet (Ethernet DSC1280E/1212E/1616E) ..... 9–114 Setup Tab: Statistics Ethernet (Ethernet DSC1280E/1212E/1616E) 9–115 Network Stats .................................................................................... 9–115 Application Stats............................................................................... 9–115 Setup Tab: UDP/IP Network Specific Settings ................................. 9–115 Setup Tab: General UDP/IP............................................................. 9–116 Setup Tab: Statistics UDP/IP ........................................................... 9–120 Network Stats .................................................................................... 9–120 Application Stats............................................................................... 9–120 Setup Tab: BBMD List UDP/IP........................................................ 9–121 ADVANCED ...................................................................................................... 9–122 Maximums ........................................................................................ 9–122 BACnet APDU .................................................................................. 9–122 BACnet Properties ............................................................................ 9–123 MS/TP SLAVES ............................................................................................... 9–124 Device Number ................................................................................. 9–124 Max APDU Size ................................................................................ 9–124 Segmentation .................................................................................... 9–125 Vendor ID ......................................................................................... 9–125 MAC Address .................................................................................... 9–126 INTERNET PROTOCOL SETTINGS (IPS) [NEW 3.40] [COPY] ......... 9–127 DESCRIPTION ................................................................................................... 9–128 IP..................................................................................................................... 9–129 Use DHCP Checkbox ....................................................................... 9–130 IP Address ........................................................................................ 9–130 Subnet Mask ..................................................................................... 9–131 Gateway Address .............................................................................. 9–131 User-Defined DNS ............................................................................ 9–132 DHCP: Section ................................................................................. 9–132 DHCP:Server IP Address ................................................................. 9–132 DHCP: Lease Length ....................................................................... 9–132 DHCP: Time Remaining................................................................... 9–132 DHCP: Release button ..................................................................... 9–133 DHCP: Renew button ....................................................................... 9–133 EMAIL.............................................................................................................. 9–133 Panel’s E-Mail Account ................................................................... 9–134 SMTP Server..................................................................................... 9–134 Username and Password fields ........................................................ 9–134 TCP Port .......................................................................................... 9–134 Timeout ............................................................................................. 9–135 SNTP .............................................................................................................. 9–135
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–56
Total Pages in this Section: 160
Contents - Objects Used in Networking
9–57
Enable SNTP Checkbox .................................................................... 9–135 Server Address .................................................................................. 9–136 Poll Interval ...................................................................................... 9–136 Last Updated in UTC ........................................................................ 9–136 Universal Time Co-ordinated: UTC Enable ..................................... 9–136 Universal Time Co-ordinated: UTC Offset ....................................... 9–136 Daylight Savings: Enable.................................................................. 9–136 Daylight Savings: Status ................................................................... 9–137 Daylight Savings: Standard .............................................................. 9–137 Daylight Savings: Type (Other Only)................................................ 9–138 Daylight Savings: Transition Time ................................................... 9–138 Daylight Savings: Time Adjustment .................................................. 9–138 Daylight Savings: Start DST on ........................................................ 9–138 Daylight Savings: End DST on ......................................................... 9–139 Daylight Savings: On and After ........................................................ 9–139 ROUTING TABLE AND DEVICE TABLE (DRT) ................................... 9–140 DEVICES ........................................................................................................... 9–140 Device Number.................................................................................. 9–140 MAC Address .................................................................................... 9–141 Network Number ............................................................................... 9–141 ROUTING .......................................................................................................... 9–141 Network Number ............................................................................... 9–142 MAC Address .................................................................................... 9–142 Port ................................................................................................... 9–142 DESCRIPTION ................................................................................................... 9–142 VERSION 2 PROTOCOL SETTINGS (V2P) ............................................ 9–143 SETUP............................................................................................................... 9–143 Ethernet Network Specific Settings ................................................... 9–144 Tunneling Network Specific Settings ................................................. 9–144 Serial (RS-232) Port Specific Settings .............................................. 9–144 ADVANCED ...................................................................................................... 9–146 Maximum Panels ............................................................................... 9–146 Timeout Factor & Timeout Base ....................................................... 9–147 Username & Password ..................................................................... 9–147 Incoming Idle Timeout ...................................................................... 9–147 STATS............................................................................................................... 9–148 ETHERNET NETWORK SETTINGS (ENS) ............................................ 9–149 GENERAL ......................................................................................................... 9–149 Registry Path ..................................................................................... 9–149 Device Description ............................................................................ 9–149 Ethernet Address ............................................................................... 9–149 INTELLINET NETWORK SETTINGS (INS) ........................................... 9–150 GENERAL ......................................................................................................... 9–150 Registry Path ..................................................................................... 9–150 Device Description ............................................................................ 9–150 TUNNELING NETWORK SETTINGS (TNS) .......................................... 9–151 GENERAL ......................................................................................................... 9–151 Registry Path ..................................................................................... 9–151 Device Description ............................................................................ 9–151 UDP/IP NETWORK SETTINGS (UNS) ..................................................... 9–152
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–57
9–58
Controller Networks GENERAL ......................................................................................................... 9–152 Registry Path .................................................................................... 9–152 Device Description ........................................................................... 9–152 SETUP .............................................................................................................. 9–153 IP Address ........................................................................................ 9–153 Subnet Mask ..................................................................................... 9–153 Gateway Address .............................................................................. 9–154 DESCRIPTION ................................................................................................... 9–154 SERIAL (RS-232) PORT SETTINGS (SNS).............................................. 9–155 GENERAL ......................................................................................................... 9–155 Registry Path .................................................................................... 9–155 Device Description ........................................................................... 9–155 SETUP .............................................................................................................. 9–156 COM Port ......................................................................................... 9–156 Modem Reference ............................................................................. 9–156 Total Retries ..................................................................................... 9–156 Answer Timeout ................................................................................ 9–157 Redial Delay ..................................................................................... 9–157 DESCRIPTION ................................................................................................... 9–157 SLAVE DEVICE LIST (SDL) ..................................................................... 9–158 MS/TP SLAVES ............................................................................................... 9–159 Device Number ................................................................................. 9–159 Max APDU Size ................................................................................ 9–159 Segmentation .................................................................................... 9–159 Vendor ID ......................................................................................... 9–159 MAC Address .................................................................................... 9–160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–58
Total Pages in this Section: 160
Addressing
9–59
BACNET BROADCAST MANAGEMENT DEVICE LIST (BMD) The BACnet Broadcast Management Device List (BBMD) object is automatically created in the default database. It stores the IP Addresses of other BBMD Devices. .If UDP/IP is not being used then this object has no purpose. 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
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–59
9–60
Controller Networks 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. See also the BACnet Protocol Settings (BCP) object information.
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-IsAll' filters.
All these filtering options are available on the DSM-RTR.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–60
Total Pages in this Section: 160
IP Filter
9–61
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. For detailed information, refer to the IP Packet Filtering section in Chapter 9 Controller Networks of the ORCAview Technical Reference manual. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–61
9–62
Controller Networks The filtering options are briefly described in the following table. IP Filter
Function:
Block Ethernet broadcasts from Delta devices
This filter blocks global broadcast packets, 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 and UDP/IP-2
This filter blocks all packets from being routed between one UDP/IP adapter to the other.
Disable IP Regular support
This filter restricts the device from rebroadcasting 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 communication
This filter restricts the device from sending 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 and UDP/IP
This filter blocks all packets from being routed between Ethernet and UDP/IP. This filter can be specifically enabled on either UDP/IP port (or both).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–62
Total Pages in this Section: 160
IP Filter
Disable routing DE broadcasts to UDP/IP
9–63
When this checbox is enabled (checked), the RTR stops routing: 1) remotely generated global broadcast OBCast (Optimized Broadcast) packets to the BACnet IP network 2) remotely generated global broadcast COV Notifications to the BACnet IP network 3) locally generated local and global broadcast OBCast (Optimized Broadcast) packets to the BACnet IP network 4) locally generated local and global broadcast COV Notifications to the BACnet IP network 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).
Block routed packets from Ethernet
This filter blocks routed packets received on the Ethernet network from being routed to the IP network(s). In other words, if the device receives a packet on the Ethernet network, and if the packet did not originate on the local Ethernet network (i.e. from an MS/TP sub-network), it is blocked.
Ignore I-Am-Router from Ethernet
With this filter enabled, the device will ignore I-Am-Router packets received on the Ethernet segment.
Disable routing global broadcast Who-Is-All
With this filter enabled, the controller will stop routing global broadcasts of Who-IsAll packets. Call CS before enabling this checkbox. This filter blocks global Who-Is All broadcast packets from being routed.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–63
9–64
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–64
Total Pages in this Section: 160
Description
9–65
BULK DATA EXCHANGE (BDE) [NEW 3.40] [COPY] The Bulk Data Exchange (BDE) object provides a powerful and simple means to exchange data in an efficient and flexible manner. The READ / WRITE functions in GCL+ work in conjunction with the Bulk Data Exchange (BDE) object. The object allows efficient data exchange between multiple controllers. 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 system still handles creation of DEL/DER pairs to handle references in programs (PG). The exchanged item values are directly GCL accessible with the new READ and WRITE functions in GCL+. Intermediate local variables (AV’s & BV’s) are no longer required for many tasks. Since the values are available in an object, the powerful GCL+ FORALL command is also available. For more information, refer to the FORALL entry in the GCL+ Language Reference section of Chapter 11 – General Control Language (GCL+). The following section in this topic contains a GCL+ code example that uses FORALL and READ to access BDE data. 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. The supported BDE configurations are: •
One BDE transmitting to several BDEs on the same channel.
•
One BDE transmitting to one BDE on the same channel.
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 Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–65
9–66
Controller Networks
Example: Accessing BDE Data Using FORALL and READ The following example uses FORALL and READ to determine the average, minimum and maximum of specified received data in multiple BDE objects on the Receiving controller. The example code reads the value of data with “IAT” name tag for all BDE objects on the Receiving controller in order to do the calculation. //This example finds the average, maximum, and minimum //Indoor Air Temperatures(IAT) //being received by a system controller Variable Variable Variable Variable Variable Variable Variable Variable
total As Real minval As Real maxval As Real value As Real i As Integer Average As Real Minimum As Real Maximum As Real
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–66
Total Pages in this Section: 160
Description
9–67
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–67
9–68
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–68
Total Pages in this Section: 160
Setup
9–69
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.
Max COV per Interval The Max COV per Interval field specifies the number of COV updates that the BDE object can send before it must wait the Broadcast Interval period to transmit again. The range of this field is 2 to 200. The default value of this field is 10.
Exchange Type The Exchange Type dropdown field in the Bulk Data Exchange object contains the following options: Broadcast and Broadcast & COV. Column Heading
Function - Transmit Entries
Broadcast
•
Broadcast & COV
When Broadcast & COV is selected, the BDE objects update when the COV Increments in the objects referenced by the Transmit Entries are reached.
When Broadcast is selected, the BDE objects update according to the value set in the Broadcast Interval field.
The Broadcast/COV Transmitter sends the number of COV updates specified in the Max COV per Interval field before it stops sending updates for 1 broadcast interval.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–69
9–70
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–70
Total Pages in this Section: 160
Transmit Entries
9–71
Dataview The Transmit Entries dataview contains the editable Tag and Object fields and also the read only Last Value Sent field.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–71
9–72
Controller Networks
Next Broadcast in Counts down the time in seconds to the next scheduled broadcast. Column Heading
Function - Transmit Entries
Tag
The Tag field in the Transmitter data view is limited to 1 to 67 printable characters and must be unique within the Transmitter data view. When an entry is added to the transmitter list of a BDE object, its Tag and Value will dynamically update in the corresponding BDE objects on the network. The Tag assigned to a particular data entry is available to a GCL+ program. For example, a possible Name is OAT. A GCL+ program could then access this BDE data entry using the READ function that refers to the Tag defined in a BDE entry. av1 = READ( "BDE:GlobalVariables.OAT" ) //GlobalVariables is the name of the BDE object //OAT is the tag of the entry in the BDE object
• NOTE: 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. Object
The Object field in the transmitter data view may be any local database object (existing or not existing). When a reference is entered with an arbitrary Tag AND if the object reference exists, the Value field and Flags field are updated.
Last Value Sent
This value is the last value that was transmitted to the receiving controller.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–72
Total Pages in this Section: 160
Receive Entries
9–73
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–73
9–74
Controller Networks
Column Heading
Function - Receive Entries
Tag
This Tag is assigned to this particular data entry. A possible Tag is OAT. A GCL+ program could then access this BDE data entry using the READ function that refers to the Tag defined in a BDE entry. av1 = READ( "BDE:GlobalVariables.OAT" ) //GlobalVariables is the name of the BDE object //OAT is the name of the entry in the BDE object
• NOTE: The Name of the BDE objects 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, This makes the BDEs function independent of instance numbers. Last Value Received
This value is the last value that was received from the transmitting controller.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–74
Total Pages in this Section: 160
Destinations Tab
9–75
Destinations Tab The Destinations tab contains a Broadcast Destinations edit box. The Broadcast Destinations field accepts network numbers and device addresses.
Broadcast Destinations Column The Broadcast Destinations field in the Destinations dataview only accepts Device IDs and network numbers. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–75
9–76
Controller Networks
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.
Time Since Last Update The Time Since Last Update field displays the number of seconds since the controller last received a BDE update. This field increments until the controller receives data.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–76
Total Pages in this Section: 160
Status
9–77
Received From Dataview The Received From list displays the Device Name and Device ID of controllers transmitting on the same channel, along with the last time a transmission was received. In supported BDE operation, only one Device should be in the Received From Dataview (only one transmitter is supported for each channel).
Total Pages in this Section: 160
Heading
Function
Device
This column contains a list of entries for sending devices.
Time Received
This column contains the time that a data transmission was received from the particular device.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–77
9–78
Controller Networks
DATA EXCHANGE LOCAL (DEL) This object is automatically created when one controller is requested to transfer an object's value to another controller. This is similar in function to the Highway Output (HO) point that existed in Version 2 controllers. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–78
Total Pages in this Section: 160
Fields (DEL)
9–79
The Exchange Flag conditions are: •
Dirty - The value in the controller has changed since the last time it was sent to the receiving controller.
•
Subscribed - The value has been successfully subscribed to by the receiving controller.
•
New Entry - This data exchange is new, and thus needs to be sent out immediately.
•
Network Fault - This is displayed if an error occurred the last time the value was sent.
•
Manual Subscription - This indicates that this value has been manually subscribed by another non-Delta device.
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#____ e.g. DER123__3600_AV1_85 DEL#___ 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–79
9–80
Controller Networks
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 nonDelta 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 resend 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–80
Total Pages in this Section: 160
Header (DER)
9–81
DATA EXCHANGE REMOTE (DER) This object is automatically created when this controller requests another controller to transfer an object's value. This is similar in function to the Highway Request (HR) point that existed in Version 2 controllers. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–81
9–82
Controller Networks
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#_____
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–82
Total Pages in this Section: 160
Fields (DER)
9–83
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 names take the following form: DEL#___
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–83
9–84
Controller Networks •
Broadcast - The value will be transmitted from the remote controller periodically. The time between successive transmissions is set in the DES object in the remote controller, in the Broadcasting Tab.
•
Optimized Broadcast - This is identical in function to Broadcast, but the exchange is done more efficiently, which requires less network traffic. This is Delta proprietary.
•
Change of Value - The value will be transmitted from the remote controller whenever it changes in value. This has the advantage of only sending data when necessary, and data being transmitted as quickly as possible from the remote controller when its value changes. However, for frequently changing analog values, this may lead to the data being sent more often than is really required. An example of this would be an outdoor temperature input. COV - Confirmed - A Confirmed Change of Value data exchange will resend the data to the remote panel until it receives a sucessful response from the remote controller. COV - Unconfirmed - An Unconfirmed Change of Value data exchange will send the data to the remote panel once and does not require a confirmation from the remote controller.
•
Default - This 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. DER objects which have their Exchange Type set to Default will use the DES Default Exchange Type.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–84
Total Pages in this Section: 160
Fields (DER)
9–85
DATA EXCHANGE SETTINGS (DES) This object is automatically created in the default database. It is used to set the behavior of data exchanges for a controller. Each controller in the system will have one of these objects. The settings in the DES object are applied to data exchanges that are conducted by the DER and DEL objects.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–85
9–86
Controller Networks
Setup The Setup tab has one field:
Default Exchange Type This drop down menu contains the different methods by which object values can be communicated between controllers. The available options are: Broadcast, Optimized Broadcast, Poll, Unconfirmed COV, and Confirmed COV. These methods are described in the DER object. DER objects which have their Exchange Type set to Default will use the DES Default Exchange Type.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–86
Total Pages in this Section: 160
Broadcasting
9–87
Broadcasting
The following figure is from a DCU controller.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–87
9–88
Controller Networks
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.
Last Broadcast Duration This field displays the time in seconds that it took to send all the broadcasts on the last Broadcast Interval.
Broadcast Destinations Dataview This dataview can contain one or more entries. Each entry specifies a separate network or device to send Broadcast or Optimized Broadcast Data Exchange to. By default, the only entry is BROADCAST for a DCU, which refers to all networks which are reachable. For DAC/DSC products, the default entry is NET0 which confines Broadcast or Optimized Broadcast Data Exchange traffic to only the local networks that the controller is physically connected to. Although the default value is usually sufficient, there are times when data sent from this controller should be directed to a specific network or controller. The following dataview shows some example entries:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–88
Total Pages in this Section: 160
Poll
9–89
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.
Reducing Broadcast Traffic With DAC/DSC products, if you use Broadcast or Optimized Broadcast Data Exchange from a remote network, then the preferred approach is to add an entry to the Broadcast Destination dataview list that includes the controller that is requesting the data. More specific Broadcast Destination entries are preferred as network traffic is reduced. For example, you might add an entry that directs to the specific network or even to the specific controller. Unless you have a definite reason, avoid using Broadcast as an entry as it may generate excess network traffic.
Poll
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–89
9–90
Controller Networks
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.
Last Poll Duration This field displays the time in seconds that it took the last poll to complete.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–90
Total Pages in this Section: 160
Description
9–91
Next Subscription in This field displays the amount of time until the next Subscription Interval expiry occurs.
Last Subscription Duration This field displays the time in seconds that it took to send all the Subscriptions on the last Subscription Interval.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–91
9–92
Controller Networks
BACNET PROTOCOL SETTINGS (BCP) [COPY] This object is automatically created in the default database of a DCU. It is used to set the many configuration options that BACnet allows, as well as configuring which Network interfaces will communicate via the BACnet protocol. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–92
Total Pages in this Section: 160
Setup
9–93
Setup
Column Headings on Setup Tab The Setup tab has a dataview with the following columns.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–93
9–94
Controller Networks NetworkNum Column The NetworkNum column sets the BACnet network number for this interface. Different physical (or logical) BACnet network segments should have different BACnet network numbers. Each interface in the Dataview is given a different network number. The default network numbers are determined automatically where the ultimate number given is of the form of PAASS where P is the port (or type of network), AA is the Area of this site and SS is the System number given to the network. The Port numbers are assigned as shown in the following table: Network Interface Port Number Ethernet 1 MS/TP 2 IntelliNet 3 UDP/IP 4 When the NetworkNum for two different interfaces are set to different numbers, routing will occur between these interfaces. Without routing, controllers that are on different network segments such as Ethernet and IntelliNet would not be able to communicate. Serial RS-232 networks are automatically given their own unique network number which is 65535-(Controller Address MOD 5536). For example with a controller address of 12701: 12701 MOD 5336 = 1629 65535-1629 = 63906 (network number) 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.
Ethernet Network Specific Settings There are no additional settings for Ethernet.
Intelli-Net Network Specific Settings There are no additional settings for IntelliNet.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–94
Total Pages in this Section: 160
Setup
9–95
Serial (RS-232) Port Specific Settings When PTP (RS-232) Port Settings is selected, the following options display below the Dataview.
Baud Rate This is the communication speed between Point-to-Point (serial) devices. Typically this would be the speed between the controller 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. 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. Usage Type The available options are Incoming/Outgoing, Incoming, and Outgoing. The Incoming/Outgoing option allows the PC to accepts calls from controllers and also to dial out to controllers. Incoming allows the PC only to accept calls from controllers but NOT to dial out to controllers. Outgoing allows the PC only to dial out to controllers but NOT to accept calls from controllers. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–95
9–96
Controller Networks Dial Upon Login When this checkbox is checked, then the OWS dials out to a controller upon login. Remote OWS Connections Require SUA Password Check This is a BACnet Networking Security feature. If this option is enabled, the SUA of the remote OWS that is dialing in will be compared with the controller’s SUA object. If the SUA settings do not match, the connection will be dropped and the remote OWS will not be able to communicate with the network. SUA for Direct Connect to 3rd Party Specifies the Password to check when dialing into third party network.
MS/TP Network Specific Settings When MS/TP (RS-485) Port Settings is selected, the following options display below the Dataview.
Baud Rate This is the communication speed between MS/TP (EIA-485) devices on this port. The following speeds are available: 9600, 19200 38400 and 76800; with 76800 being the default. All devices on an EIA-485 subnet must use the same speed. Currently a PC cannot communicate at a baud rate of 76800, and this setting is used for controller to controller communication. Delta Controls manufactures a wired RS 485 converter (CON-768) that allows a PC to communicate at 76800 over a serial COM port. Delta also manufactures a newer wireless RS-485 converter (CON-768BT) that allows a PC to communicate at 76800 over a virtual Bluetooth COM port. Refer to the CON-768BT Installation Guide for detailed information on specifications, installation and configuration of the device. Chapter 3 – Navigator of the ORCAview Technical Reference manual explains how to connect through ORCAview using a CON-768BT and how to use the Reconnect Bluetooth command. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–96
Total Pages in this Section: 160
Setup
9–97
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.
UDP/IP Network Specific Settings When UDP/IP Network Settings is selected, the following options display below the Dataview.
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.
Total Pages in this Section: 160
•
Regular Devices can communicate with other controllers in the same subnetwork, 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 subnetwork which has no BBMD. These controllers can communicate with the larger network by registering with a remote BBMD device on another subnetwork. 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–97
9–98
Controller Networks 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. Proxy Address This address is entered when a controller is behind a proxy server that provides Network Address Translation (NAT). The address is the outside world address of the proxy. Otherwise leave the address as 0.0.0.0 which is the default address. 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. Remote OWS Connections Require SUA Password Check This is a BACnet Networking Security feature. If this option is enabled, Remote Operator Workstations logging into a BBMD device will have their SUA objects verified against the SUA objects in the controller. If the Username/Passwords do not match, the connection will be dropped and the Remote OWS will not be able to communicate with 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–98
Total Pages in this Section: 160
Advanced
9–99
Advanced
Local Network Number This value refers to which BACnet network this controller is locally connected to. The range of this number is 0 to 65534. Essentially, all other controllers which have the same Local Network Number can be considered to be on the same 'logical' network. The OWS defaults to a value of 0, which means that it is part of its local network, but is incapable of routing to another network. This value is Read Only.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–99
9–100
Controller Networks
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.
Max. APDU Size This field, which defaults to 480 bytes, specifies the largest size of an Application Protocol Data Unit 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–100
Total Pages in this Section: 160
Stats
9–101
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 retransmissions 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–101
9–102
Controller Networks
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.
Max APDU Size This field specifies the largest size of an Application Protocol Data Unit this controller can receive. The range of the value is 50 to 480 bytes. This value is dependent on the implementation of the slave device. Refer to the slave device’s documentation to determine what value to use.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–102
Total Pages in this Section: 160
MS/TP Slaves
9–103
Segmented The device is able to send and receive segmented messages. Segmented Send The device is able to send segmented messages. Segmented Receive The device is able to receive segmented messages. No Segmentation The device can neither send nor receive segmented messages.
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, ...).
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–103
9–104
Controller Networks 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: •
MS/TP (1 byte): a decimal number in the range 0-254 (e.g., NET50,71);
•
Ethernet (6 bytes): 12 hexadecimal digits (e.g., NET50,357A8042FF00);
•
IP address in 3.33: (6 bytes, formatted as xxxx:ddd.ddd.ddd.ddd) 4 hexadecimal digits, representing the port, followed by a colon (:) followed by 4 decimal values in the range 0-255 separated by periods (.) (e.g., NET50,BAC3:128.67.255.0); (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
•
2-byte LonTalk: 2 decimal numbers in the range 0-255 separated by a comma (e.g., NET50,128,91);
•
7-byte LonTalk and all other formats: An even number of hexadecimal digits (e.g., NET50,68D51A28E443F3).
If an odd number of digits is entered for a hexadecimal value, then the last digit will be ignored. Note: A MAC address that is entered in the IP or Ethernet formats will be
formatted in the IP format if the first 3 hexadecimal digits are BAC; otherwise, it will be formatted in the Ethernet format. (E.g., if NET50,BAC38042FF00 is entered, it will be formatted as NET50,BAC3:128.67.255.0; and if NET50,357A:128.67.255.0 is entered, it will be formatted as NET50,357A8042FF00.).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–104
Total Pages in this Section: 160
Header
9–105
NETWORK PROTOCOL SETTINGS (NET) [COPY] The Network Protocol Settings (NET1) object is automatically created in the default database of a DAC. The object cannot be copied and pasted, saved and loaded, or deleted. It is used to set the DAC configuration options that BACnet allows as well as configuring which Network interfaces will communicate via the BACnet protocol. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–105
9–106
Controller Networks
Setup The Setup tab specifies which communication interfaces are active and sets their parameters.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–106
Total Pages in this Section: 160
Setup
9–107
Setup Dataview Headings The Dataview has the following headings:
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. Possible states include: •
Active Status: Port is enabled and running normally. The Status Reference field will contain a reference to the Network Protocol Settings (NET1) Object.
•
In Use by: Port is being used by something else such as Linknet. The Status Reference column will display LNK* if Linknet is in use.
•
Driver Disabled: This displays when the Enabled checkbox is unchecked.
•
Gateway Disabled Status: Port is in use by a gateway and is not running BACnet, even if it is flagged as Enabled. The Status Reference will contain a reference to the Gateway Object GW1.
Status Reference Column The Status Reference column displays the object that is using the port. The object is either a Network Protocol Settings (NET1) Object, a Gateway (GW) Object or a LNK*.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–107
9–108
Controller Networks
Setup Tab: Setup MS/TP The fields for Setup below the Dataview change depending on the protocol of the port that is selected in the dataview.
Baud Rate This is the communication speed between MS/TP (EIA-485) devices on this port. The following speeds are available: 9600, 19200, 38400 and 76800, with 76800 being the default. All devices on an EIA-485 subnet must use the same speed. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–108
Total Pages in this Section: 160
Setup
9–109
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 addressing is enabled, then the network 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. See the Network Numbers section in Appendix C Derived Network Addressing (DNA) for more information. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–109
9–110
Controller Networks
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. Send Failures Counts the number of transmit errors. Protocol Errors Counts the number of MS/TP protocol errors. Total Received Counts the total number of packets received including tokens for MS/TP. Invalid Received Counts the number of receive errors. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–110
Total Pages in this Section: 160
Setup
9–111
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.
Setup Tab: Setup PTP (Point to Point)
The fields for Setup below the Dataview change depending on the protocol on the port that is selected in the dataview. Baud Rate This is the communication speed between Point-to-Point (serial) devices. Typically this would be the speed between the controller and the operator workstation or a modem. The following speeds are available: 9600, 19200, and 38400 with 9600 being the default. Both ends of a Point-to-Point connection must use the same speed. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–111
9–112
Controller Networks 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 Type
Modem Init String
U.S. Robotics
AT&F1&R1&Y0&W0
Zoom
AT&F&K0&Y0&W0
Boca
AT&F0&K0&Y0&W0
Custom is displayed in the Modem Type drop-down if you manually change the Modem Init String. This field is available only if the current connection is Modem. 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. Remote Connections Require SUA Password Check This is a Networking Security feature. If this option is enabled, the SUA of the remote OWS that is dialing in will be compared with the controller’s SUA object. If the Username and Password do not match, the connection will be dropped and the remote OWS will not be able to communicate with the network. This field is available only if the current connection is Modem. SUA for Direct Connect to 3rd Party Specifies the Password to check when dialing into third party network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–112
Total Pages in this Section: 160
Setup
9–113
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.
Setup Tab: Statistics PTP (Same as MS/TP Statistics)
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–113
9–114
Controller Networks
Setup Tab: Setup Ethernet (Ethernet DSC1280E/1212E/1616E)
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 addressing is enabled, then the network 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. See the Network Numbers section in Appendix C Derived Network Addressing (DNA) for more information. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–114
Total Pages in this Section: 160
Setup
9–115
Ethernet Address This field contains the physical Ethernet MAC address. The MAC address is not the device number. It is the physical Ethernet address.
Setup Tab: Statistics Ethernet (Ethernet DSC1280E/1212E/1616E)
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.
Setup Tab: UDP/IP Network Specific Settings When UDP/IP is selected, the following options display below the Dataview.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–115
9–116
Controller Networks 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.
Setup Tab: General UDP/IP 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 subnetwork, 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 subnetwork which has no BBMD. These controllers can communicate with the larger network by registering with a remote BBMD device on another subnetwork. 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–116
Total Pages in this Section: 160
Setup
9–117
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. Proxy (NAT) Address This address is entered when a controller is behind a proxy server that provides Network Address Translation (NAT). The address is the outside world address of the proxy. Otherwise leave the address as 0.0.0.0 which is the default address. This field is only available when a BBMD Device is selected as the Device Type and the IP Address field has a private IP address. 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. 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. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–117
9–118
Controller Networks 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–118
Total Pages in this Section: 160
Setup
9–119
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. See the Network Numbers section in Appendix C Derived Network Addressing (DNA) for more information. 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.
Remote Connections Require SUA Password Check This is an IP Networking Security feature. If this option is enabled, foreign devices logging into the BBMD device will have their SUA objects verified against the SUA objects in the controller. If the Username/Passwords do not match, the connection will be dropped and the foreign device will be unable to communicate with the network 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–119
9–120
Controller Networks
Setup Tab: Statistics UDP/IP
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–120
Total Pages in this Section: 160
Setup
9–121
Setup Tab: BBMD List UDP/IP The Setup tab: BBMD List provides an easy way to enter an IP Address. You just double click on a blank entry in the field and then enter the address.
Remote BBMD Addresses If a controller (DCU or DSC) is a BBMD device, it needs to know about other BBMD devices on remote IP networks in order to communicate with the devices within the remote networks. BBMD devices store the list of known remote BBMD devices in the BMD object which is set up by the user. The list entry displays the IP address of the remote BBMD controllers. The BBMD list field in the NET1 object displays the referenced BBMD devices from the BMD object. You can change the list in either the NET1 or BMD objects, and the system updates the list in the other object. The user can copy/paste the BMD object to other controllers.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–121
9–122
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–122
Total Pages in this Section: 160
Advanced
9–123
APDU Retry Timeout 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. 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 Timeout This field, which is very similar to the Retry Timeout, specifies the time between re-transmissions of a single segment of a multisegment 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–123
9–124
Controller Networks
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.
Max APDU Size This field specifies the largest size of an Application Protocol Data Unit this slave device can receive. The range of the value is 50 to 480 bytes. This value is dependent on the implementation of the slave device. Refer to the slave device’s documentation to determine what value to use.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–124
Total Pages in this Section: 160
MS/TP Slaves
9–125
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.
Segmented The device is able to send and receive segmented messages. Segmented Send The device is able to send segmented messages. Segmented Receive The device is able to receive segmented messages. No Segmentation The device can neither send nor receive segmented messages.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–125
9–126
Controller Networks
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: •
MS/TP (1 byte): a decimal number in the range 0-254 (e.g., NET50,71);
•
Ethernet (6 bytes): 12 hexadecimal digits (e.g., NET50,357A8042FF00);
•
IP (6 bytes): 4 hexadecimal digits, representing the port, followed by a colon (:) followed by 4 decimal values in the range 0-255 separated by periods (.) (e.g., NET50,BAC3:128.67.255.0);
•
2-byte LonTalk: 2 decimal numbers in the range 0-255 separated by a comma (e.g., NET50,128,91);
•
7-byte LonTalk and all other formats: An even number of hexadecimal digits (e.g., NET50,68D51A28E443F3).
If an odd number of digits is entered for a hexadecimal value, then the last digit will be ignored. Note: A MAC address that is entered in the IP or Ethernet formats will be formatted in the IP format if the first 3 hexadecimal digits are BAC; otherwise, it will be formatted in the Ethernet format. (E.g., if NET50,BAC38042FF00 is entered, it will be formatted as NET50,BAC3:128.67.255.0; and if NET50,357A:128.67.255.0 is entered, it will be formatted as NET50,357A8042FF00.).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–126
Total Pages in this Section: 160
MS/TP Slaves
9–127
INTERNET PROTOCOL SETTINGS (IPS) [NEW 3.40] [COPY] The Internet Protocol Settings (IPS) provides a single convenient object dedicated to the setup of the Internet Protocols on supported devices. The IPS dialog is designed so that all the settings required for a supported protocol are displayed together in a group. IPS object is in the default database only for Ethernet supported controllers. Supported devices include all Ethernet controllers except DCU, enteliTOUCH and DAC-EC (Compact-Ethernet DAC) controllers. Currently, the Ethernet supported controllers implements BACnet/IP, SMTP (email), SNTP (network time) and HTTP (alarms). Each of these Internet Protocols requires some configuration settings, and these settings have become scattered across various database objects such as NET and DEV. The look and feel of the current Ethernet supported controllers, DEV and NET dialogs are retained, but the IP fields of these dialogs now link to the IPS object's properties.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–127
9–128
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–128
Total Pages in this Section: 160
IP
9–129
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. DHCP reduces the work necessary to administer a large IP network by automatically entering an IP Address, a subnet mask, and default gateway information into a controller.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–129
9–130
Controller Networks
Use DHCP Checkbox If the Use DHCP checkbox is checked, the IP Address, Subnet Mask, and Gateway Address fields become unavailable because they are acquired automatically using DHCP. 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. An IP address is a four-part address that is used to identify a particular computer, controller, 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, such as: 192.168.1.10 Normally, the site network administrator provides the IP Address. It is important to note that these addresses cannot simply be made up. 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. For more information, see the Network Settings object (NET).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–130
Total Pages in this Section: 160
IP
9–131
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: 192.168.1.10 is on the same network as 192.168.1.23 This means that these two devices can communicate without the need for a gateway. However: 192.168.1.10 is NOT on the same network as 11.123.200.4 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–131
9–132
Controller Networks 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.
DHCP: Lease Length 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.
DHCP: Time Remaining This field provides the amount of time remaining for the lease of the IP address provided by the DHCP server.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–132
Total Pages in this Section: 160
Email
9–133
DHCP: Release button The DHCP Release button provides a simple way to immediately release a lease for a DHCP client. It greatly reduces the amount of time needed for DHCP IP configuration tasks.
DHCP: Renew button The DHCP Renew button provides a simple way to force a DHCP renewal of a lease for a DHCP client. It greatly reduces the amount of time needed for DHCP IP configuration tasks.
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. Email is supported on all Ethernet controllers except DCU and DAC-EC (Compact-Ethernet DAC) controllers
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–133
9–134
Controller Networks
Panel’s E-Mail Account The fields contains the text that you want to appear in the From field of the emails. A descriptive name should be entered into this field so that it is easy to identify where the email came from. For example:
[email protected] 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.
Username and Password fields The Username and Password fields are for SMTP Server Authentication. This is when the Email Server requires the client (in this case the controller) to authenticate (with a Username and Password) before it will accept an email submission. Contact your network administrator to find out if your Email Server requires authentication. Leaving the Username and Password fields empty disables authentication.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–134
Total Pages in this Section: 160
SNTP
9–135
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. Supported controllers include the DSM-RTR and enteliBUS controllers. Simple Network Time Synchronization Protocol (SNTP) is a simplified UDP protocol that supports client time synchronization. It provides a way to synchronize the clocks of computer systems using packets over a network. To set the controller time correctly using SNTP, UTC (Universal Time Co-ordinated) and DST (Daylight Savings) setting must be configured properly. UTC and DST fields on SNTP tabs are linked to the same fields on Time Info tab of Device (DEV) object.
Enable SNTP Checkbox This checkbox enables the Simple Network Time Synchronization Protocol (SNTP) which is a subset of the Network Time Protocol (NTP).
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–135
9–136
Controller Networks
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.
Last Updated in UTC This field displays the UTC time when the client was last synchronized with the central time server using SNTP.
Universal Time Co-ordinated: UTC Enable This checkbox tells the controller that the UTC Offset property is in effect, and should be used in all relevant calculations. See UTC Offset for more information. The UTC setting is important since controller time will rely on this setting when time is received from the server. UTC is disabled by default.
Universal Time Co-ordinated: UTC Offset This field indicates the offset in minutes (-780 to 780) between local standard time and Universal Time Coordinated (formerly Greenwich Mean Time). To use the UTC feature on a controller, you must check UTC Enable and enter the UTC Offset for the location of the Device.
Daylight Savings: Enable Enable checkbox is used for enabling Daylight Savings Time (DST) feature. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–136
Total Pages in this Section: 160
SNTP
9–137
Daylight Savings: 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.
Daylight Savings: Standard This field will allow the operator to choose: •
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.
The following is a description of the DST Standards:
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
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–137
9–138
Controller Networks
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.
Daylight Savings: Type (Other Only) This property provides a combo-box that allows the user to enter the DST start/end dates with either a Week & Day or Specific Date type entry. The only time that this combo-box can be modified is if OTHER is selected as the DST Standard.
Daylight Savings: Transition Time This time shows 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.
Daylight Savings: Time Adjustment This property indicates the number of Offset minutes that the DST event adds/subtracts 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.
Daylight Savings: 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–138
Total Pages in this Section: 160
SNTP
9–139
Daylight Savings: 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.
Daylight Savings: 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 appear. If the operator enters a date in this box then the earliest the DST would be enabled/disabled is the date of the selected month. 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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–139
9–140
Controller Networks
ROUTING TABLE AND DEVICE TABLE (DRT) The Routing Table and Device Table (DRT) object shows dynamic data structures. The Devices tab shows a list of devices that the controller is currently communicating with. The Routing tab lists addresses that allow packets to be routed from one network to another. The routing and device tables can greatly aid troubleshooting. For example, it can help to track data exchanges with remote devices and also communication with BBMDs.
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). The dataview has three heading labels:
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–140
Total Pages in this Section: 160
Routing
9–141
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:
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–141
9–142
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–142
Total Pages in this Section: 160
Setup
9–143
VERSION 2 PROTOCOL SETTINGS (V2P) This object is automatically created in the default database. It is used to configure network options that pertain to the Delta proprietary Version 2 protocol. This object is not used on a DAC/DSC.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–143
9–144
Controller Networks 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.
Ethernet Network Specific Settings There are no additional settings for Ethernet.
Tunneling Network Specific Settings The Tunneling Network requires some explanation. Tunneling is a process by which native Delta Version 2 network traffic can be manipulated to look like BACnet protocol traffic. This allows Version 2 network traffic to be sent over network links that only support BACnet traffic. An example of this situation would be where the operator workstation is connected to the DCUs by a WAN that only supports IP (Internet Protocol) traffic. BACnet traffic can successfully travel over this type of link, but Version 2 traffic cannot. In this case, Tunneling would allow the off-site operator workstation to see Version 2 panels at the site which are connected to the v3.20 DCUs. By default, the setup of Tunneling is automatic, and should not need to be changed in normal circumstances.
Serial (RS-232) Port Specific Settings These settings only display in OWS. Normally, these settings are set automatically during login and you do not need to adjust them.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–144
Total Pages in this Section: 160
Setup
9–145
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–145
9–146
Controller Networks Outgoing User Name & Outgoing Password
These settings really only apply if this object exists in an operator workstation. They specify a Username and Password that remote Version 2 controllers can contact this operator workstation with. Outgoing Idle Time
When the OWS dials up to a remote V2 controller, the OWS will hang up after this set time since the last communications. The default value is 600 seconds.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–146
Total Pages in this Section: 160
Advanced
9–147
Timeout Factor & Timeout Base These two values, which default to 10% and 1 second respectively, determine how much 'grace' a Version 2 controller has in responding to a request. After this time, communication with this Version 2 controller will be deemed unreliable. In Igraph, this would have displayed the 'Remote controller not responding' message. Essentially, with the default values, 10% and 1 second would be added to the expected response time.
Username & Password These settings really only apply if this object exists in an operator workstation. They specify a Username and Password that remote Version 2 controllers can contact this operator workstation with.
Incoming Idle Timeout If a V2 controller dials up the OWS and does not hang up, then OWS will hang up after a set time after the last communications. The default value is 600 seconds.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–147
9–148
Controller Networks
Stats
Read only values used for Delta Controls Troubleshooting.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–148
Total Pages in this Section: 160
General
9–149
ETHERNET NETWORK SETTINGS (ENS) This object is merely a 'place holder' for Ethernet interfaces which are present. When an Ethernet interface is present on a DCU, ENS1 will automatically be created. An OWS can have one or two Ethernet interfaces, which will be called ENS1 and ENS2.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–149
9–150
Controller Networks
INTELLINET NETWORK SETTINGS (INS) This object is merely a 'place holder' for IntelliNet interfaces which are present. When an IntelliNet interface is present on a DCU, INS1 will automatically be created. An OWS with an IntelliNet card present will also have an INS1 object automatically created. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–150
Total Pages in this Section: 160
General
9–151
TUNNELING NETWORK SETTINGS (TNS) This object is a system 'place holder' for the Tunneling Interface. All DCUs have one Tunneling Network Interface, but an OWS will have one only if it was selected at the time of installation (which is the default).
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. For an explanation of Tunneling and its application, see Version 2 Protocol Settings (V2P) starting on page 9–143.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–151
9–152
Controller Networks
UDP/IP NETWORK SETTINGS (UNS) Although this object is present in both the OWS and DCU, only the DCU object has any functionality. The settings for the OWS are set though the Windows Control-Panel. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–152
Total Pages in this Section: 160
Setup
9–153
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–153
9–154
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–154
Total Pages in this Section: 160
General
9–155
SERIAL (RS-232) PORT SETTINGS (SNS) The Serial Port Settings (SNS) object defines the Communications (COM) port that the serial interface will use on a controller or an operator workstation.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–155
9–156
Controller Networks
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–156
Total Pages in this Section: 160
Description
9–157
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–157
9–158
Controller Networks
SLAVE DEVICE LIST (SDL) The Slave Device List (SDL) object provides the information required for Delta products to communicate with MS/TP slave devices. The contents of the Slave Device List object should be copied to each Delta device that needs to know about the slaves. The contents of the Slave Device List are shown on the MS/TP Slaves tab in the Network Protocol Settings (NET) or BACnet Protocol Settings (BCP) object for the device. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–158
Total Pages in this Section: 160
MS/TP Slaves
9–159
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.
Max APDU Size This field specifies the largest size of an Application Protocol Data Unit this controller can receive. The range of the value is 50 to 480 bytes. This value is dependent on the implementation of the slave device. Refer to the slave device’s documentation to determine what value to use.
Segmentation Refer to the slave device’s documentation to determine what level of segmentation the device supports, if any.
Segmented The device is able to send and receive segmented messages. Segmented Send The device is able to send segmented messages. Segmented Receive The device is able to receive segmented messages. No Segmentation The device can neither send nor receive segmented messages.
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.
Total Pages in this Section: 160
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–159
9–160
Controller Networks
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: •
MS/TP (1 byte): a decimal number in the range 0-254 (e.g., NET50,71);
•
Ethernet (6 bytes): 12 hexadecimal digits (e.g., NET50,357A8042FF00);
•
IP address in 3.33: (6 bytes, formatted as xxxx:ddd.ddd.ddd.ddd) 4 hexadecimal digits, representing the port, followed by a colon (:) followed by 4 decimal values in the range 0-255 separated by periods (.) (e.g., NET50,BAC3:128.67.255.0); (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
•
2-byte LonTalk: 2 decimal numbers in the range 0-255 separated by a comma (e.g., NET50,128,91);
•
7-byte LonTalk and all other formats: An even number of hexadecimal digits (e.g., NET50,68D51A28E443F3).
If an odd number of digits is entered for a hexadecimal value, then the last digit will be ignored. Note: A MAC address that is entered in the IP or Ethernet formats will be
formatted in the IP format if the first 3 hexadecimal digits are BAC; otherwise, it will be formatted in the Ethernet format. (E.g., if NET50,BAC38042FF00 is entered, it will be formatted as NET50,BAC3:128.67.255.0; and if NET50,357A:128.67.255.0 is entered, it will be formatted as NET50,357A8042FF00.).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 9–160
Total Pages in this Section: 160
Chapter 10 – SOFTWARE OBJECTS REFERENCE VERSION 3.40 BACNET Chapter 10: Contents (Condensed) OBJECT INFORMATION IN OTHER CHAPTERS ............................... 10–14 OVERVIEW .................................................................................................. 10–15 ACCESS CONTROL ALARM LOG (EVL) .............................................. 10–17 ACCESS CONTROL SETUP (AS) ............................................................. 10–25 ACCESS GROUP (AG) ................................................................................ 10–29 ANALOG INPUT (AI) .................................................................................. 10–38 ANALOG INPUT CONFIGURATION (AIC) ........................................... 10–52 ANALOG OUTPUT (AO) ............................................................................ 10–57 ANALOG OUTPUT CONFIGURATION (AOC) ...................................... 10–73 ANALOG TOTALIZER (AT)...................................................................... 10–78 ANALOG VARIABLE (AV) ........................................................................ 10–83 BACNET PROTOCOL SETTINGS (BCP) ................................................ 10–89 BINARY DEVICE CONFIGURATION (BDC) ....................................... 10–102 BINARY INPUT (BI) .................................................................................. 10–105 BINARY OUTPUT (BO) ............................................................................ 10–114 BINARY TOTALIZER (BT) ..................................................................... 10–134 BINARY VARIABLE (BV) ........................................................................ 10–139 BACNET BROADCAST MANAGEMENT DEVICE LIST (BMD) ...... 10–144 BULK DATA EXCHANGE (BDE) [NEW 3.40] ...................................... 10–150 CALENDAR (CAL) .................................................................................... 10–161 USING CALENDARS WITH SCHEDULES ........................................... 10–168 CARD USER (CU) ...................................................................................... 10–178
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–1
10–2
Software Objects Reference Version 3.40 BACnet CARD READER (CR)................................................................................ 10–188 COMPACT EVENT LOG (CEL) ............................................................. 10–196 COMMUNICATIONS PORT (COM) ...................................................... 10–202 CONTROL LOOP OBJECT (CO) ........................................................... 10–204 DATABASE INFORMATION (DBI) ....................................................... 10–218 DEVICE (DEV) ........................................................................................... 10–225 DOOR CONTROLLER (DC).................................................................... 10–254 DOOR GROUP (DG) ................................................................................. 10–284 ELEVATOR CONTROLLER (EC) ......................................................... 10–289 EVENT ........................................................................................................ 10–307 EVENT CLASS ........................................................................................... 10–341 EVENT FILTER ......................................................................................... 10–358 EVENT LOG (EVL) ................................................................................... 10–362 EVENT ROUTER (EVR) .......................................................................... 10–375 EVENT AND ALARM SETTINGS (EVS) ............................................... 10–390 FILE (FIL)................................................................................................... 10–399 GATEWAY (GW) ...................................................................................... 10–403 GATEWAY TRANSLATION (GWT) ...................................................... 10–415 HISTORIAN SETTINGS (HS).................................................................. 10–422 HISTORICAL TREND LOG (ARCHIVED TL)..................................... 10–434 INTERNET PROTOCOL SETTINGS (IPS) [NEW 3.40] ...................... 10–441 I/O MAPPING OBJECT (IOM) [NEW 3.40] .......................................... 10–453 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 LCD AND KEYPAD ACCESS (LCD) ...................................................... 10–481 LIGHTING GROUP (LG) V3.40 DELTA PROPRIETARY ................. 10–499 LIGHTING GROUP (V3 BACNET) 3.33R1 DIALOG .......................... 10–516 LIGHTING GROUP (LG) V3 BACNET 3.33 R2 DIALOG................... 10–529
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–2
Total Pages in this Section: 812
Object Information in Other Chapters Chapter 10: Contents (Condensed)
10–3
LINKNET (LNK) ........................................................................................ 10–544 LOAD SHED (LS) OBJECT ...................................................................... 10–550 MENU (MN) V3 .......................................................................................... 10–557 MICRONET PROTOCOL SETTINGS (MNP) ....................................... 10–562 MODEM SETTINGS (MDS) ..................................................................... 10–567 MULTI-STATE INPUT (MI)..................................................................... 10–570 MULTI-STATE INPUT CONFIGURATION (MIC) .............................. 10–580 MULTI-STATE VARIABLE (MV)........................................................... 10–584 MULTI-TREND (MT) ................................................................................ 10–588 NETWORK PROTOCOL SETTINGS (NET) ......................................... 10–598 OBJECT REPLICATION (RPL) .............................................................. 10–618 OBJECT RESTRICTION SETTINGS (ORS) [NEW 3.40] .................... 10–626 OPTIMUM START (OS) ........................................................................... 10–639 PRIORITY NAMES (PAN) ........................................................................ 10–650 PROGRAM (PG)......................................................................................... 10–652 PULSE INPUT (PI) ..................................................................................... 10–655 REGIONAL SETTINGS (RS).................................................................... 10–664 REMOTE PANEL SETTINGS (RPS) ....................................................... 10–668 REPORTS (RPT) ........................................................................................ 10–672 ROUTING TABLE AND DEVICE TABLE (DRT) ................................. 10–688 SCHEDULE 3.40 BACNET (SCH)............................................................ 10–691 SLAVE DEVICE LIST (SDL).................................................................... 10–713 STRUCTURED VIEW (SV) [NEW 3.40].................................................. 10–717 SYSTEM DISPLAY (SD) V3 ..................................................................... 10–721 SYSTEM USER ACCESS (SUA)............................................................... 10–724 SECURITY USER GROUP (SUG) ........................................................... 10–741 TREND LOG – BACNET (TL).................................................................. 10–746 VIEW GROUPS (VGS) .............................................................................. 10–758
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–3
10–4
Software Objects Reference Version 3.40 BACnet ZIGBEE WIRELESS DEVICE (WSD) [NEW 3.40] ............................... 10–774 ZIGBEE WIRELESS DEVICE LIST (WDL) [NEW 3.40]..................... 10–782 ZIGBEE WIRELESS SETTINGS (ZBS) [NEW 3.40] ............................ 10–787 GLOSSARY ENTELIMESH..................................................................... 10–794 ZONE CONTROLLER FORMAT (ZF) .................................................. 10–796 ZONE CONTROLLER (ZC) .................................................................... 10–800
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–4
Total Pages in this Section: 812
Object Information in Other Chapters Chapter 10: Contents (Detailed)
10–5
Chapter 10: Contents (Detailed) CHAPTER 10: CONTENTS (CONDENSED) ............................................................. 10–1 CHAPTER 10: CONTENTS (DETAILED) ................................................................ 10–5 OBJECT INFORMATION IN OTHER CHAPTERS ............................... 10–14 OVERVIEW .................................................................................................. 10–15 SYSTEM OBJECTS ............................................................................................. 10–16 ACCESS CONTROL ALARM LOG (EVL) .............................................. 10–17 OVERVIEW ....................................................................................................... 10–17 EVENT LOG ...................................................................................................... 10–18 SETUP............................................................................................................... 10–19 ALARM FILTERING ........................................................................................... 10–21 DESCRIPTION ................................................................................................... 10–24 ACCESS CONTROL SETUP (AS) ............................................................. 10–25 ACCESS GROUP (AG) ................................................................................ 10–29 ELEVATOR SETUP ............................................................................................ 10–33 ANALOG INPUT (AI) .................................................................................. 10–38 HEADER ........................................................................................................... 10–38 DESCRIPTION ................................................................................................... 10–41 SETUP............................................................................................................... 10–42 SENSOR ............................................................................................................ 10–45 ALARMING (INTRINSIC).................................................................................... 10–49 ALARM TEXT (INTRINSIC) ................................................................................ 10–50 NAVIGATOR STATUS VALUES .......................................................................... 10–50 GCL+ PROPERTIES........................................................................................... 10–51 ANALOG INPUT CONFIGURATION (AIC) ........................................... 10–52 DESCRIPTION ................................................................................................... 10–52 SETUP............................................................................................................... 10–53 SCALE RANGE .................................................................................................. 10–55 GCL+ PROPERTIES........................................................................................... 10–56 ANALOG OUTPUT (AO) ............................................................................ 10–57 HEADER ........................................................................................................... 10–57 DESCRIPTION ................................................................................................... 10–61 SETUP............................................................................................................... 10–62 DEVICE ............................................................................................................ 10–64 PRIORITY ARRAY ............................................................................................. 10–68 ALARMING (INTRINSIC).................................................................................... 10–69 ALARM TEXT (INTRINSIC) ................................................................................ 10–70 NAVIGATOR STATUS VALUES .......................................................................... 10–70 CREATING AN AO OBJECT ON A ROOM CONTROLLER...................................... 10–71 GCL+ PROPERTIES........................................................................................... 10–71 DAC: OUTPUT STARTUP DELAY ...................................................................... 10–71 ANALOG OUTPUT CONFIGURATION (AOC) ...................................... 10–73 DESCRIPTION ................................................................................................... 10–73 SETUP............................................................................................................... 10–74
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–5
10–6
Software Objects Reference Version 3.40 BACnet SCALE RANGE ................................................................................................. 10–76 GCL+ PROPERTIES .......................................................................................... 10–77 ANALOG TOTALIZER (AT) ..................................................................... 10–78 HEADER ........................................................................................................... 10–78 DESCRIPTION ................................................................................................... 10–79 SETUP .............................................................................................................. 10–79 NAVIGATOR STATUS VALUES.......................................................................... 10–82 GCL+ PROPERTIES .......................................................................................... 10–82 ANALOG VARIABLE (AV) ....................................................................... 10–83 HEADER ........................................................................................................... 10–83 DESCRIPTION ................................................................................................... 10–84 SETUP .............................................................................................................. 10–85 COMM. RESET ENABLE CHECKBOX ................................................................. 10–85 REVERSE ACTION CHECKBOXES...................................................................... 10–86 GCL+ PROPERTIES .......................................................................................... 10–88 BACNET PROTOCOL SETTINGS (BCP) ............................................... 10–89 DESCRIPTION ................................................................................................... 10–89 SETUP .............................................................................................................. 10–90 ADVANCED ...................................................................................................... 10–96 PROTOCOL ....................................................................................................... 10–97 STATS .............................................................................................................. 10–98 MS/TP SLAVES ............................................................................................... 10–99 BINARY DEVICE CONFIGURATION (BDC) ...................................... 10–102 DESCRIPTION ................................................................................................. 10–102 SETUP ............................................................................................................ 10–103 GCL+ PROPERTIES ........................................................................................ 10–104 BINARY INPUT (BI) ................................................................................. 10–105 HEADER ......................................................................................................... 10–105 DESCRIPTION ................................................................................................. 10–108 SETUP ............................................................................................................ 10–109 DEVICE .......................................................................................................... 10–110 ALARMING (INTRINSIC) ................................................................................. 10–112 ALARM TEXT (INTRINSIC) ............................................................................. 10–113 NAVIGATOR STATUS VALUES........................................................................ 10–113 GCL+ PROPERTIES ........................................................................................ 10–113 BINARY OUTPUT (BO)............................................................................ 10–114 HEADER ......................................................................................................... 10–114 DESCRIPTION ................................................................................................. 10–118 SETUP ............................................................................................................ 10–119 DEVICE .......................................................................................................... 10–122 PRIORITY ARRAY........................................................................................... 10–126 LIGHTING ...................................................................................................... 10–127 ALARMING (INTRINSIC) ................................................................................. 10–129 ALARM TEXT (INTRINSIC) ............................................................................. 10–130 NAVIGATOR STATUS VALUES........................................................................ 10–130 GCL+ PROPERTIES ........................................................................................ 10–131 DAC: OUTPUT STARTUP DELAY ................................................................... 10–131 BINARY TOTALIZER (BT) ..................................................................... 10–134 HEADER ......................................................................................................... 10–134
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–6
Total Pages in this Section: 812
Object Information in Other Chapters Chapter 10: Contents (Detailed)
10–7
DESCRIPTION ................................................................................................. 10–135 SETUP............................................................................................................. 10–136 NAVIGATOR STATUS VALUES ........................................................................ 10–138 GCL+ PROPERTIES......................................................................................... 10–138 BINARY VARIABLE (BV) ........................................................................ 10–139 HEADER ......................................................................................................... 10–139 DESCRIPTION ................................................................................................. 10–140 SETUP............................................................................................................. 10–141 DEVICE .......................................................................................................... 10–142 NAVIGATOR STATUS VALUES ........................................................................ 10–143 GCL+ PROPERTIES......................................................................................... 10–143 BACNET BROADCAST MANAGEMENT DEVICE LIST (BMD) ...... 10–144 ADDRESSING .................................................................................................. 10–145 IP FILTER ....................................................................................................... 10–146 DESCRIPTION ................................................................................................. 10–149 BULK DATA EXCHANGE (BDE) [NEW 3.40] ...................................... 10–150 TRANSMIT ENTRIES ........................................................................................ 10–155 CALENDAR (CAL) .................................................................................... 10–161 HEADER ......................................................................................................... 10–161 CALENDAR ..................................................................................................... 10–162 CONFIGURE A CALENDAR ENTRY: SUB-MENU ............................................... 10–164 DESCRIPTION ................................................................................................. 10–166 GCL+ PROPERTIES......................................................................................... 10–167 USING CALENDARS WITH SCHEDULES ........................................... 10–168 WHAT IS A CALENDAR ................................................................................... 10–168 VIEW A CALENDAR ........................................................................................ 10–168 CONFIGURE A CALENDAR .............................................................................. 10–170 ENTER SINGLE DATE...................................................................................... 10–170 ENTER DATE RANGE ...................................................................................... 10–171 ENTER RECURRING DATE .............................................................................. 10–173 WHAT IS A SCHEDULE? .................................................................................. 10–176 CARD USER (CU) ...................................................................................... 10–178 CARD READER (CR) ................................................................................ 10–188 COMPACT EVENT LOG (CEL) .............................................................. 10–196 COMMUNICATIONS PORT (COM) ...................................................... 10–202 HEADER ......................................................................................................... 10–202 DESCRIPTION ................................................................................................. 10–202 SETUP............................................................................................................. 10–203 CONTROL LOOP OBJECT (CO) ............................................................ 10–204 HEADER ......................................................................................................... 10–204 DESCRIPTION ................................................................................................. 10–206 SETUP............................................................................................................. 10–207 TUNING .......................................................................................................... 10–209 GCL+ PROPERTIES......................................................................................... 10–212 LOOP TUNING USING A TREND LOG............................................................... 10–212
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–7
10–8
Software Objects Reference Version 3.40 BACnet DATABASE INFORMATION (DBI) ....................................................... 10–218 OVERVIEW..................................................................................................... 10–218 DESCRIPTION ................................................................................................. 10–219 DATABASE..................................................................................................... 10–220 PRODUCT ....................................................................................................... 10–222 OBJECTS ........................................................................................................ 10–224 DEVICE (DEV) ........................................................................................... 10–225 HEADER ......................................................................................................... 10–225 DESCRIPTION ................................................................................................. 10–227 CONFIGURATION ........................................................................................... 10–229 TIME INFO ..................................................................................................... 10–235 USING TIME SYNC ......................................................................................... 10–240 TIME SYNC TAB............................................................................................. 10–244 PRODUCT ....................................................................................................... 10–246 PROTOCOL ..................................................................................................... 10–248 INTERNET ...................................................................................................... 10–250 NAVIGATOR STATUS VALUES........................................................................ 10–253 GCL+ PROPERTIES ........................................................................................ 10–253 DOOR CONTROLLER (DC).................................................................... 10–254 OVERVIEW..................................................................................................... 10–254 HEADER ......................................................................................................... 10–254 DOOR GROUP (DG) ................................................................................. 10–284 ELEVATOR CONTROLLER (EC) ......................................................... 10–289 EVENT ........................................................................................................ 10–307 EVENT HEADER ............................................................................................. 10–307 GENERAL ....................................................................................................... 10–309 SETUP ............................................................................................................ 10–310 MESSAGES ..................................................................................................... 10–313 EVENT CLASS TAB ON EVENT OBJECT .......................................................... 10–318 DESCRIPTION ................................................................................................. 10–321 ALARM TYPES FOR EVENT ............................................................................ 10–321 EVENT CLASS ........................................................................................... 10–341 DEFAULT DATABASE EVENT CLASSES .......................................................... 10–342 TABS ON EVENT CLASS OBJECT .................................................................... 10–351 EVENT FILTER ......................................................................................... 10–358 MAIN ............................................................................................................. 10–358 EVENT LOG (EVL) ................................................................................... 10–362 LOG TAB ....................................................................................................... 10–363 SETUP ............................................................................................................ 10–369 ALARM FILTERING (UPDATED 3.40) .............................................................. 10–371 DESCRIPTION ................................................................................................. 10–374 EVENT ROUTER (EVR) .......................................................................... 10–375 ALARM FILTERING (UPDATED 3.40) .............................................................. 10–376 SETUP ............................................................................................................ 10–379 DESTINATIONS / ALARM ESCALATION TAB ................................................... 10–385 DESCRIPTION ................................................................................................. 10–389
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–8
Total Pages in this Section: 812
Object Information in Other Chapters Chapter 10: Contents (Detailed)
10–9
EVENT AND ALARM SETTINGS (EVS) ............................................... 10–390 SETUP............................................................................................................. 10–390 STATS............................................................................................................. 10–393 ACTIVE ALARM LISTS .................................................................................... 10–395 FILE (FIL) ................................................................................................... 10–399 DESCRIPTION ................................................................................................. 10–399 SETUP............................................................................................................. 10–400 ADVANCED .................................................................................................... 10–401 GATEWAY (GW) ....................................................................................... 10–403 MODBUS GATEWAY ....................................................................................... 10–403 HEADER (MODBUS) ....................................................................................... 10–403 SETUP (MODBUS) ........................................................................................... 10–404 STATISTICS (MODBUS) ................................................................................... 10–406 PROGRAMMING (MODBUS) ............................................................................ 10–407 DESCRIPTION (MODBUS) ................................................................................ 10–408 DELTA WIRELESS GATEWAY ......................................................................... 10–408 SETUP (DELTA WIRELESS GATEWAY) ............................................................ 10–409 STATISTICS (DELTA WIRELESS GATEWAY) .................................................... 10–411 PROGRAMMING (DELTA WIRELESS GATEWAY) ............................................. 10–412 DESCRIPTION (DELTA WIRELESS GATEWAY)................................................. 10–414 GATEWAY TRANSLATION (GWT) ...................................................... 10–415 SETUP (HEADER)............................................................................................ 10–415 SETUP (DATAVIEW) ....................................................................................... 10–416 SETUP (FIELDS) .............................................................................................. 10–419 DESCRIPTION ................................................................................................. 10–421 HISTORIAN SETTINGS (HS) .................................................................. 10–422 HEADER ......................................................................................................... 10–422 STATS............................................................................................................. 10–423 TROUBLESHOOTING ....................................................................................... 10–426 SETUP............................................................................................................. 10–432 HISTORICAL TREND LOG (ARCHIVED TL) ..................................... 10–434 HEADER ......................................................................................................... 10–434 GRAPH ........................................................................................................... 10–435 SETUP............................................................................................................. 10–436 DATA ............................................................................................................. 10–439 DESCRIPTION ................................................................................................. 10–440 INTERNET PROTOCOL SETTINGS (IPS) [NEW 3.40]....................... 10–441 I/O MAPPING OBJECT (IOM) [NEW 3.40] ........................................... 10–453 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 LCD AND KEYPAD ACCESS (LCD) ...................................................... 10–481 HEADER ......................................................................................................... 10–481 VIEW .............................................................................................................. 10–482 SETUP............................................................................................................. 10–487 ADVANCED .................................................................................................... 10–490
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–9
10–10
Software Objects Reference Version 3.40 BACnet DESCRIPTION ................................................................................................. 10–495 GCL+ PROPERTIES ........................................................................................ 10–496 LIGHTING GROUP (LG) V3.40 DELTA PROPRIETARY ................. 10–499 HEADER ......................................................................................................... 10–499 DESCRIPTION (3.40 LG DIALOG) ................................................................... 10–502 SETUP (3.40 LG DIALOG) .............................................................................. 10–503 OUTPUTS (3.40 LG DIALOG) ......................................................................... 10–505 GROUP SWITCHES (3.40 LG DIALOG) ............................................................ 10–507 ALGORITHM (3.40 LG DIALOG) .................................................................... 10–509 LIGHTING GROUP (V3 BACNET) 3.33R1 DIALOG .......................... 10–516 HEADER ......................................................................................................... 10–517 DESCRIPTION (3.33R1 LG DIALOG) .............................................................. 10–519 SETUP (3.33R1 LG DIALOG) ......................................................................... 10–520 I/O DEFINITION (3.33R1 LG DIALOG) ........................................................... 10–522 CONFIGURATION (3.33R1 LG DIALOG) ......................................................... 10–524 LIGHTING GROUP (LG) V3 BACNET 3.33 R2 DIALOG................... 10–529 HEADER ......................................................................................................... 10–529 DESCRIPTION (3.33R2 LG DIALOG) .............................................................. 10–532 SETUP (3.33R2 LG DIALOG) ......................................................................... 10–533 OUTPUT (3.33R2 LG DIALOG) ...................................................................... 10–535 GROUP SWITCHES (3.33R2 LG DIALOG) ....................................................... 10–537 ALGORITHM (3.33R2 LG DIALOG) ................................................................ 10–538 LINKNET (LNK)........................................................................................ 10–544 HEADER ......................................................................................................... 10–544 DESCRIPTION ................................................................................................. 10–544 SETUP ............................................................................................................ 10–545 PRODUCT ....................................................................................................... 10–547 LOAD SHED (LS) OBJECT ..................................................................... 10–550 HEADER ......................................................................................................... 10–551 DESCRIPTION ................................................................................................. 10–553 SETUP ............................................................................................................ 10–553 HVAC, ACCESS, AND LIGHTING CHECKBOXES ............................................. 10–556 MENU (MN) V3 .......................................................................................... 10–557 HEADER ......................................................................................................... 10–557 DESCRIPTION ................................................................................................. 10–558 SETUP ............................................................................................................ 10–559 DATAVIEW .................................................................................................... 10–560 ENTERING NEW FUNCTIONS .......................................................................... 10–561 MICRONET PROTOCOL SETTINGS (MNP)....................................... 10–562 COMMON HEADER ......................................................................................... 10–562 STATUS .......................................................................................................... 10–562 ADDRESSING ................................................................................................. 10–563 SETUP ............................................................................................................ 10–565 ADVANCED .................................................................................................... 10–565 DESCRIPTION ................................................................................................. 10–566 MODEM SETTINGS (MDS) ..................................................................... 10–567 DESCRIPTION ................................................................................................. 10–567 SETUP ............................................................................................................ 10–568
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–10
Total Pages in this Section: 812
Object Information in Other Chapters Chapter 10: Contents (Detailed)
10–11
MULTI-STATE INPUT (MI)..................................................................... 10–570 HEADER ......................................................................................................... 10–570 DESCRIPTION ................................................................................................. 10–572 SETUP............................................................................................................. 10–573 SENSOR TAB .................................................................................................. 10–574 STATS............................................................................................................. 10–577 ALARMING (INTRINSIC).................................................................................. 10–578 ALARM TEXT (INTRINSIC) .............................................................................. 10–579 MULTI-STATE INPUT CONFIGURATION (MIC) .............................. 10–580 DESCRIPTION ................................................................................................. 10–580 SETUP............................................................................................................. 10–581 EXAMPLES OF USING AN MIC WITH AN MI AND AN MV ............................... 10–582 MULTI-STATE VARIABLE (MV)........................................................... 10–584 HEADER ......................................................................................................... 10–584 DESCRIPTION ................................................................................................. 10–585 SETUP............................................................................................................. 10–586 GCL+ PROPERTIES......................................................................................... 10–587 MULTI-TREND (MT) ................................................................................ 10–588 MULTI-TREND COMPONENTS ......................................................................... 10–588 TOOLBAR COMPONENTS ................................................................................ 10–591 NETWORK PROTOCOL SETTINGS (NET) ......................................... 10–598 HEADER ......................................................................................................... 10–598 DESCRIPTION ................................................................................................. 10–598 SETUP............................................................................................................. 10–599 ADVANCED .................................................................................................... 10–614 MS/TP SLAVES .............................................................................................. 10–615 OBJECT REPLICATION (RPL) .............................................................. 10–618 OBJECT RESTRICTION SETTINGS (ORS) [NEW 3.40] .................... 10–626 THEORY OF OPERATION ................................................................................. 10–627 NAVIGATOR OBJECT SECURITY LOCK/UNLOCK MECHANISM ........................ 10–629 DESCRIPTION ................................................................................................. 10–631 SETUP............................................................................................................. 10–632 OBJECT EXCEPTIONS ...................................................................................... 10–634 OPTIMUM START (OS) ........................................................................... 10–639 COMMON HEADER ......................................................................................... 10–639 DESCRIPTION ................................................................................................. 10–641 SETUP............................................................................................................. 10–641 HISTORY ........................................................................................................ 10–646 OPTIMUM START CALCULATION .................................................................... 10–648 PRIORITY NAMES (PAN) ........................................................................ 10–650 OBJECT DESCRIPTION .................................................................................... 10–650 EXAMPLE ....................................................................................................... 10–651 PROGRAM (PG)......................................................................................... 10–652 NAME ............................................................................................................. 10–653 PRIORITY........................................................................................................ 10–653
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–11
10–12
Software Objects Reference Version 3.40 BACnet PULSE INPUT (PI) .................................................................................... 10–655 HEADER ......................................................................................................... 10–655 DESCRIPTION (NOT AVAILABLE ON DFM-400P) ............................................ 10–656 SETUP ............................................................................................................ 10–658 ADVANCED .................................................................................................... 10–660 DATA ............................................................................................................. 10–662 NAVIGATOR STATUS VALUES........................................................................ 10–663 GCL+ PROPERTIES ........................................................................................ 10–663 REGIONAL SETTINGS (RS) ................................................................... 10–664 DESCRIPTION ................................................................................................. 10–664 CITY .............................................................................................................. 10–665 REMOTE PANEL SETTINGS (RPS) ...................................................... 10–668 MAIN ............................................................................................................. 10–668 SETUP ............................................................................................................ 10–670 REPORTS (RPT) ........................................................................................ 10–672 REPORT SETUP .............................................................................................. 10–672 QUERY SETUP ................................................................................................ 10–674 TENANT BILLING SETUP ................................................................................ 10–678 ACCESS CONFIGURATION SETUP ................................................................... 10–681 LAYOUT/DESTINATION .................................................................................. 10–685 DESTINATIONS............................................................................................... 10–686 DESCRIPTION ................................................................................................. 10–687 ROUTING TABLE AND DEVICE TABLE (DRT) ................................ 10–688 DEVICES ........................................................................................................ 10–688 ROUTING ....................................................................................................... 10–689 DESCRIPTION ................................................................................................. 10–690 SCHEDULE 3.40 BACNET (SCH) ........................................................... 10–691 HEADER ......................................................................................................... 10–692 MAIN ............................................................................................................. 10–695 WEEKLY / EXCEPTION SCHEDULES................................................................ 10–700 SETUP ............................................................................................................ 10–708 DETAILS ........................................................................................................ 10–711 DESCRIPTION ................................................................................................. 10–712 SLAVE DEVICE LIST (SDL) ................................................................... 10–713 MS/TP SLAVES ............................................................................................. 10–714 STRUCTURED VIEW (SV) [NEW 3.40] ................................................. 10–717 DESCRIPTION ................................................................................................. 10–717 SETUP ............................................................................................................ 10–718 SUBORDINATES ............................................................................................. 10–720 SYSTEM DISPLAY (SD) V3 ..................................................................... 10–721 HEADER ......................................................................................................... 10–721 DESCRIPTION ................................................................................................. 10–721 OBJECT LIST DATAVIEW ............................................................................... 10–722 SYSTEM USER ACCESS (SUA) .............................................................. 10–724 COMMON HEADER ......................................................................................... 10–725 DESCRIPTION ................................................................................................. 10–727
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–12
Total Pages in this Section: 812
Object Information in Other Chapters Chapter 10: Contents (Detailed)
10–13
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 ZIGBEE WIRELESS DEVICE LIST (WDL) [NEW 3.40] ..................... 10–782 ZIGBEE WIRELESS SETTINGS (ZBS) [NEW 3.40] ............................. 10–787 GLOSSARY ENTELIMESH ..................................................................... 10–794 ZONE CONTROLLER FORMAT (ZF) ................................................... 10–796 INPUTS / OUTPUTS .......................................................................................... 10–796 SETPOINTS ..................................................................................................... 10–798 DESCRIPTION ................................................................................................. 10–799 ZONE CONTROLLER (ZC) ..................................................................... 10–800 HEADER ......................................................................................................... 10–800 I / O VALUE .................................................................................................... 10–802 SETPOINTS ..................................................................................................... 10–804 I / O SETUP ..................................................................................................... 10–805 OPERATION .................................................................................................... 10–808 DESCRIPTION ................................................................................................. 10–811
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–13
10–14
Software Objects Reference Version 3.40 BACnet
OBJECT INFORMATION IN OTHER CHAPTERS Chapter 9 – Controller Networks and Appendix B – Preferences and Setup contains object information that is not covered in this chapter: •
Chapter 9 – Controller Networks The Controller Objects Software Reference section describes the following objects used in networking. Data Exchange Local (DEL) Data Exchange Remote (DER) Data Exchange Settings (DES BACnet Protocol Settings (BCP) [Included in both Chapters 9 & 10] Network Protocol Settings (NET1) [Included in both Chapters 9 & 10] Version 2 Protocol Settings (V2P) Ethernet Network Settings (ENS) IntelliNet Network Settings (INS) Routing Table and Device Table (DRT) Tunneling Network Settings (TNS) UDP/IP Network Settings (UNS) Serial (RS-232) Port Settings (SNS)
•
Appendix B – Preferences and Setup This chapter describes display options and how to configure the following objects that determine the function of ORCAview. ORCAview Settings (CMS) Navigator Settings (NVS) / Device Graphic List (DGL) Drawing Settings (DWS) GCL Settings (GCS) Server Startup Information (SSS) Device (DEV) Remote Panel Settings (RPS) Modem Settings (MDS) Printer Settings (PRS) Site Settings (SS) System User Access (SUA) System User Group (SUG) Event Filter (EVF)
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–14
Total Pages in this Section: 812
Overview Chapter 10: Contents (Detailed)
10–15
OVERVIEW This chapter provides reference information about the Delta Controls objects. Alphabetical The objects chapter presents the objects in alphabetical order. Within each object section, the inputs and outputs are grouped by the tab on which they appear. 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. Points or Objects In previous versions of Delta Controls software, objects were referred to as points. In this version, the word “points” is still used to refer to input and output wire connections to the controller circuit board or to the HVAC machinery. 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 Delta Controls defined system objects in V2 as objects which had to be
copied throughout the system, and had to exist both in the controller and in the OWS (i.e. Scale Ranges). In ORCAview, system objects are simply those objects which we determined 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. These objects do not need to be the copied throughout the system. For example in V2, a Scale Range had to exist in the OWS and in the controllers which referenced it, with the same Object number. Now, the Scale Range Objects (AIC, AOC, BDC) need not exist in the OWS, but only in the controller which is referencing them. This also means that the same scale ranges (AIC, AOC, BDC) can have different numbers on different controllers.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–15
10–16
Software Objects Reference Version 3.40 BACnet
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: Acronym
System Objects:
AIC
Analog Input Configuration
AOC
Analog Output Configuration
BCP
BACnet Protocol Settings
NET
BACnet Settings
BDC
Binary Device Configuration
COM
Communications Port
DES
Data Exchange Settings
DGL
Device Graphic List
ENS
Ethernet Network Settings
EVS
Event and Alarm Settings
EVC
Event Class
EVF
Event Filter
EVR
Event Router
FIL
File
HS
Historian Settings
BMD
List of BBMDs
MNP
MicroNet Protocol Settings
MDS
Modem Settings
MIC
Multistate Input Configuration
PRS
Printer Settings
PAN
Priority Array Names
RPT
Reporting
RPS
Remote Panel Settings
RPL
Replication
SDL
Slave Device List
SNS
Serial Port Settings
SS
Site Settings
SUA
System User Access
SUG
System User Group
TNS
Tunneling Network Settings and Statistics
UNS
UDP/IP Network Settings and Statistics
V2P ZF
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–16
Version 2 Protocol Settings Zone Controller Format
Total Pages in this Section: 812
Access Control Alarm Log (EVL) Overview
10–17
ACCESS CONTROL ALARM LOG (EVL) 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–17
10–18
Software Objects Reference Version 3.40 BACnet
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. Message The message for that transition.
Details on Highlighted Events 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. The following is a list of all the details available. Time The time that the alarm occurred.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–18
Total Pages in this Section: 812
Access Control Alarm Log (EVL) Setup
10–19
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: No Fault Detected This is the normal state. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–19
10–20
Software Objects Reference Version 3.40 BACnet Not Available This is Delta’s proprietary reliability code, which indicates that the output does not physically exist in the Door Controller object.
Maximum Log Entries This spin box is used to select the number of alarms you want stored in the Log tab. Maximum Log Entries defaults to 25, and can specify as many as 100 alarms to be stored. 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.
Archival Buffer Notification Setup: Reporting Checkbox If the Reporting checkbox is checked, three other fields become visible in the Archival Buffer Notification Setup area.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–20
Total Pages in this Section: 812
Access Control Alarm Log (EVL) Alarm Filtering
10–21
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–21
10–22
Software Objects Reference Version 3.40 BACnet
Classes and/or Events to Log The Alarm Filtering tab of the Event Log object works in conjunction with the EVC and EV objects in the system.
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. Classes and/or Events to Log 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. The Class / Event column accepts entries in the following forms:
•
EVC1 – All alarms of Event Class #1
•
EVC* - All alarms of all Event Classes are routed
•
100.EV1 – Alarm 1 on device 100 is routed
•
100.EV* - Any alarm from device 100 is routed.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–22
Total Pages in this Section: 812
Access Control Alarm Log (EVL) Alarm Filtering
10–23
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–23
10–24
Software Objects Reference Version 3.40 BACnet 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 This field specifies which Events to log based on Event Flags.
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 field may contain a character string of up to 2000 characters in length. The character string is limited to printable characters. The Description field includes relevant facts pertaining to the events being logging.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–24
Total Pages in this Section: 812
Access Control Setup (AS) Description
10–25
ACCESS CONTROL SETUP (AS) 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
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–25
10–26
Software Objects Reference Version 3.40 BACnet
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.
Degraded Mode Pulse Time Degraded Mode Pulse Time is the length of time the ADM pulses a door unlocked while it is operating in degraded mode. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–26
Total Pages in this Section: 812
Access Control Setup (AS) Description
10–27
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.
Update All Door Module Configurations When the Update button is pressed, the ASM sends updated LINKnet settings to all ADMs on its subnet. Resetting the ASM controller is the same as pressing this button, however pressing this button is not considered as a reset. The Update button is for trouble shooting purposes only. Technically the button is never needed because LINKnet changes are automatically sent to the ADM whenever they are made.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–27
10–28
Software Objects Reference Version 3.40 BACnet
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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)
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–28
Total Pages in this Section: 812
Access Group (AG) Description
10–29
ACCESS GROUP (AG) 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–29
10–30
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–30
Total Pages in this Section: 812
Access Group (AG) Description
10–31
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.
Sample Uses of the AG object Access 24/7 This example shows how access rights are configured to allow card users to be granted access to the doors at any time of day.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–31
10–32
Software Objects Reference Version 3.40 BACnet IT personnel need access to Research and Development doors during normal office hours. The office hours are set within the Work Hours schedule, for example 8:00am – 5:00pm, Monday to Friday. The Calendar (CAL) object can be linked to the Schedule (SCH) object when dealing with holidays, overrides, etc. See the section on Calendar and Schedule objects.
HVAC, Access and Lighting These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–32
Total Pages in this Section: 812
Access Group (AG) Elevator Setup
10–33
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:
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–33
10–34
Software Objects Reference Version 3.40 BACnet •
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 8100
> 3240
300
120
Lower
0.125
< 0.4
6
60
(Seconds between TL Archives)
Second #: (PeakRate) (Number of Samples per minute)
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–429
10–430
Software Objects Reference Version 3.40 BACnet The following table provides some examples of possible High Usage Trend Logs List Items with interpretation of the example. High Usage Trend Logs List Examples
Interpretation
8000.TL1 - 120, 60
AVOID as Missed Samples: Historian will Definitely NOT be able to keep up with this trend.
8000.TL18000.TL1 - 300, 6
AVOID as Problems: Historian may NOT be able to keep up with this trend.
8000.TL1 - 3240, 1
Acceptable: Historian may be able keep up with this trend.
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. Note: Before increasing the Max Samples, it is recommended to do a forced
update to ensure that all the current data in the buffer is archived by Historian. To update, press the Update button in the header of an Archive TL. If the Max Samples (buffer size) is increased beyond the available memory on the controller, the entire buffer is purged. A forced update avoids this possible data loss. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–430
Total Pages in this Section: 812
Historian Settings (HS) Troubleshooting
10–431
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.
Missed Samples: Intermittent High Data Rate Problems Sometimes, Historian may miss samples but only for short time periods during a day. Historian may collect samples without data loss most of the day but experience some short intermittent periods where the data rate is much higher than normal causing Historian to miss samples. These trends with intermittent high sampling rates may appear on the Insufficient Samples list but only for a short time. For example, a site may have some motion detectors and Historian may not be able to keep up with these for some high traffic periods during a day. Historian has no problems with these TLs during the rest of the day. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–431
10–432
Software Objects Reference Version 3.40 BACnet
Setup The Setup tab contains the setup items for Historian’s auto logon, ODBC connection, TL polling and error logging.
Log File Path This read-only field specifies the name, and path of Historian’s Error Log file which tracks Historian’s functionality. When something of significance happens such as Historian starting up, logging-on, logging-off, or stopping, Historian records the occurrence in the HistLog.txt file. The information in this file is useful for tracking Historian operation or troubleshooting problems.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–432
Total Pages in this Section: 812
Historian Settings (HS) Setup
10–433
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.
Maximum Poll Interval This field provides an upper limit on the poll interval that Historian’s scheduler will calculate for a TL.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–433
10–434
Software Objects Reference Version 3.40 BACnet
HISTORICAL TREND LOG (ARCHIVED TL) An Archive Trend Log (Archive TL) is an archival backup of a regular BACnet Trend Log (TL) with a theoretically unlimited maximum number of samples. The Historian device updates historical Trend Logs at calculated intervals by gathering data from the source TL that it is archiving. The preferred term is Archive Trend Log rather than Historical Trend Log. 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. Archived TL’s display collected information in two different formats: •
A line graph that plots value and time.
•
A text display of collected data.
Historian 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. There are two modes of operation for the Historical TL object: •
Trending: Historian is archiving new data samples.
•
Disabled: Historian is not archiving new data samples, although existing archived data samples may still exist.
The header also displays icons to indicate the status of a TL:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–434
Total Pages in this Section: 812
Historical Trend Log (Archived TL) Graph
10–435
This icon indicates that the TL is being archived by Historian, and it appears on any TL’s that are being archived by the Historian Device. The Fault Notification icon indicates that the archived TL is in fault. The Alarm Notification icon indicates that an external alarm has been triggered.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–435
10–436
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–436
Total Pages in this Section: 812
Historical Trend Log (Archived TL) Setup
10–437
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
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:
Total Pages in this Section: 812
If the Log Type is:
Historian will:
Polling
Periodically collect new data samples based on the TL’s Log Interval.
Change of Value (with Buffer Notification)
Collect new data samples when it receives an Archival Buffer Notification from the TL. As a backup, Historian will collect new data samples at intervals in case notifications are not received.
Change of Value (without Buffer Notification)
Collect new data samples at intervals based on the rate at which the source TL had previously collected samples.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–437
10–438
Software Objects Reference Version 3.40 BACnet
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.
Disable When Full The read-only Disable When Full field is always cleared in a archived TL.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–438
Total Pages in this Section: 812
Historical Trend Log (Archived TL) Data
10–439
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:
Total Pages in this Section: 812
•
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–439
10–440
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–440
Total Pages in this Section: 812
Internet Protocol Settings (IPS) [New 3.40] Description
10–441
INTERNET PROTOCOL SETTINGS (IPS) [NEW 3.40] The Internet Protocol Settings (IPS) provides a single convenient object dedicated to the setup of the Internet Protocols on supported devices. The IPS dialog is designed so that all the settings required for a supported protocol are displayed together in a group. IPS object is in the default database only for Ethernet supported controllers. Supported devices include all Ethernet controllers except DCU, enteliTOUCH and DAC-EC (Compact-Ethernet DAC) controllers. Currently, the Ethernet supported controllers implements BACnet/IP, SMTP (email), SNTP (network time) and HTTP (alarms). Each of these Internet Protocols requires some configuration settings, and these settings have become scattered across various database objects such as NET and DEV. The look and feel of the current Ethernet supported controllers, DEV and NET dialogs are retained, but the IP fields of these dialogs now link to the IPS object's properties.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–441
10–442
Software Objects Reference Version 3.40 BACnet
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. DHCP reduces the work necessary to administer a large IP network by automatically entering an IP Address, a subnet mask, and default gateway information into a controller.
Use DHCP Checkbox If the Use DHCP checkbox is checked, the IP Address, Subnet Mask, and Gateway Address fields become unavailable because they are acquired automatically using DHCP.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–442
Total Pages in this Section: 812
Internet Protocol Settings (IPS) [New 3.40] Description
10–443
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. An IP address is a four-part address that is used to identify a particular computer, controller, 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, such as: 192.168.1.10 Normally, the site network administrator provides the IP Address. It is important to note that these addresses cannot simply be made up. 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. For more information, see the Network Settings object (NET).
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:
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–443
10–444
Software Objects Reference Version 3.40 BACnet 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: 192.168.1.10 is on the same network as 192.168.1.23 This means that these two devices can communicate without the need for a gateway. However: 192.168.1.10 is NOT on the same network as 11.123.200.4 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–444
Total Pages in this Section: 812
Internet Protocol Settings (IPS) [New 3.40] Description
10–445
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.
DHCP: Lease Length 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.
DHCP: Time Remaining This field provides the amount of time remaining for the lease of the IP address provided by the DHCP server.
DHCP: Release button The DHCP Release button provides a simple way to immediately release a lease for a DHCP client. It greatly reduces the amount of time needed for DHCP IP configuration tasks.
DHCP: Renew button The DHCP Renew button provides a simple way to force a DHCP renewal of a lease for a DHCP client. It greatly reduces the amount of time needed for DHCP IP configuration tasks.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–445
10–446
Software Objects Reference Version 3.40 BACnet
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. Email is supported on all Ethernet controllers except DCU and DAC-EC (Compact-Ethernet DAC) controllers
Panel’s E-Mail Account The fields contains the text that you want to appear in the From field of the emails. A descriptive name should be entered into this field so that it is easy to identify where the email came from. For example:
[email protected] 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–446
Total Pages in this Section: 812
Internet Protocol Settings (IPS) [New 3.40] Description
10–447
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.
Username and Password fields The Username and Password fields are for SMTP Server Authentication. This is when the Email Server requires the client (in this case the controller) to authenticate (with a Username and Password) before it will accept an email submission. Contact your network administrator to find out if your Email Server requires authentication. Leaving the Username and Password fields empty disables authentication.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–447
10–448
Software Objects Reference Version 3.40 BACnet
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. Supported controllers include the DSM-RTR and enteliBUS controllers. Simple Network Time Synchronization Protocol (SNTP) is a simplified UDP protocol that supports client time synchronization. It provides a way to synchronize the clocks of computer systems using packets over a network. To set the controller time correctly using SNTP, UTC (Universal Time Co-ordinated) and DST (Daylight Savings) setting must be configured properly. UTC and DST fields on SNTP tabs are linked to the same fields on Time Info tab of Device (DEV) object.
Enable SNTP Checkbox This checkbox enables the Simple Network Time Synchronization Protocol (SNTP) which is a subset of the Network Time Protocol (NTP).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–448
Total Pages in this Section: 812
Internet Protocol Settings (IPS) [New 3.40] Description
10–449
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.
Last Updated in UTC This field displays the UTC time when the client was last synchronized with the central time server using SNTP.
Universal Time Co-ordinated: UTC Enable This checkbox tells the controller that the UTC Offset property is in effect, and should be used in all relevant calculations. See UTC Offset for more information. The UTC setting is important since controller time will rely on this setting when time is received from the server. UTC is disabled by default.
Universal Time Co-ordinated: UTC Offset This field indicates the offset in minutes (-780 to 780) between local standard time and Universal Time Coordinated (formerly Greenwich Mean Time). To use the UTC feature on a controller, you must check UTC Enable and enter the UTC Offset for the location of the Device.
Daylight Savings: Enable Enable checkbox is used for enabling Daylight Savings Time (DST) feature. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–449
10–450
Software Objects Reference Version 3.40 BACnet
Daylight Savings: 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.
Daylight Savings: Standard This field will allow the operator to choose: •
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.
The following is a description of the DST Standards:
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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–450
Total Pages in this Section: 812
Internet Protocol Settings (IPS) [New 3.40] Description
10–451
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.
Daylight Savings: Type (Other Only) This property provides a combo-box that allows the user to enter the DST start/end dates with either a Week & Day or Specific Date type entry. The only time that this combo-box can be modified is if OTHER is selected as the DST Standard.
Daylight Savings: Transition Time This time shows 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.
Daylight Savings: Time Adjustment This property indicates the number of Offset minutes that the DST event adds/subtracts 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.
Daylight Savings: 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–451
10–452
Software Objects Reference Version 3.40 BACnet
Daylight Savings: 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.
Daylight Savings: 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 appear. If the operator enters a date in this box then the earliest the DST would be enabled/disabled is the date of the selected month. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–452
Total Pages in this Section: 812
I/O Mapping Object (IOM) [New 3.40] Description
10–453
I/O MAPPING OBJECT (IOM) [NEW 3.40] The IO Mapping (IOM) object is a new proprietary Delta object that lists detected enteliBUS modules and their status. It is intended to help troubleshooting and diagnostics. An IOM object is included in the default controller database and the object cannot be created or deleted. 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 Control System is made up of multiple modular components that you select to meet the needs of a wide range of HVAC and Access control applications. The enteliBUS Controller (eBCON) is the automation engine of the fully programmable native BACnet® enteliBUS controller system. It supports multiple communications methods including, as standard, BACnet IP, BACnet over Ethernet and BACnet MS/TP. 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).
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–453
10–454
Software Objects Reference Version 3.40 BACnet
Setup
Name A read-only field that displays the default name of the object.
Port Settings (Dataview) The Port Settings section shows the available communication protocols (e.g. eBUS, LINKnet) and whether the adapter is enabled.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–454
Total Pages in this Section: 812
I/O Mapping Object (IOM) [New 3.40] Description Port
10–455
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
Enabled
Displays the protocols defined for each physical port. Currently, eBUS and LINKnet are available. 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 List (Dataview) The Device List section provides a list of modules and information about the status, model, firmware version and hardware version for each entry. Note that this field is for eBUS only. LINKnet devices will NOT be displayed in the Dataview.
Device
Total Pages in this Section: 812
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–455
10–456
Software Objects Reference Version 3.40 BACnet
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.
When eBM point module is disconnected, AI/BI/MI/AO/BO object of these eBMs has a reliability value of eBM Offline, and Fault Status will be displayed in Navigator for these objects. Sometimes, when an eBM is disconnected and reconnected, it may take longer than expected to come back online. The I/O objects of these eBMs have a reliability value of Configuration Error and these objects display Fault Status in Navigator. Model FW Version HW Version
Provides the model of the module. For example. eBX or eBM-404-H. Provides the version of the firmware in the module. Provides the hardware version of the eBM.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–456
Total Pages in this Section: 812
I/O Mapping Object (IOM) [New 3.40] Description
10–457
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.
Interpreting an enteliBUS Object Reference The object reference for an object is formed using a scheme that specifies the physical location of the IO point for an input or output object. An enteliBUS object reference is defined as follows: xxx.yy / pp / dd / m / yy where:
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–457
10–458
Software Objects Reference Version 3.40 BACnet
Reference
Description
Notes
eBUS Range
LINKnet Range
xxx
device number
BACnet devices can be numbered up to 4,194,312
yy
object type
AI, BI, MI, BO, AO
pp
Port number
eBUS port = 0, LINKnet port = 2
0
2
dd
Backplane or LINKnet number
01 - 08
01 - 12
m
module position on backplane
1-8
n/a
yy
physical IO terminal on the module
01 - 04
01-16 (depends on Device)
The enteliBUS IO can use the eBUS and/or the LINKnet communication protocols.
Example: eBUS IO Point: This example shows how an object reference is formed for an input using the eBUS protocol. 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. Reference
Value
Description
xxx
100
yy
AI
object type
pp
00
Port number (eBUS)
dd
02
Backplane number
m
2
module slot on backplane
yy
01
physical IO terminal on the module
device number
The Input object reference then becomes: 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–458
Total Pages in this Section: 812
I/O Mapping Object (IOM) [New 3.40] Description
10–459
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–459
10–460
Software Objects Reference Version 3.40 BACnet
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 Label
Description
Port Device
Type of IO bus. e.g, LINKnet, eBUS Backplane
PM
Point Module
Output
Physical point location on the module
Example: LINKnet IO Point: This example shows how an object reference is formed for an input using the LINKnet protocol.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–460
Total Pages in this Section: 812
I/O Mapping Object (IOM) [New 3.40] Description
10–461
A DNS-24L BACstat is connected to eBCON device number 100 and is given a LINKnet address of 1 Reference
Value
Description
xxx
100
device number
yy
AI
object type
pp
02
dd
01
m
0
yy
01
Port number (LINKnet) LINKnet device number module, not applicable to LINKnet physical IO terminal on the module
The Input object reference then becomes: 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–461
10–462
Software Objects Reference Version 3.40 BACnet
INTRINSIC ALARMING (AI, AO, BI, BO, MI) [NEW 3.40] Intrinsic Alarming is available in the AO, AI, BO, BI and MI objects. The Alarming tab starting on page 10–464 and the Alarm Text tab starting on page 10– 476 are included on these object dialogs. These tabs provide a simple way to include basic alarm and event features within an object. The object number of an input or output object must correspond to a physical input / output point on the controller as otherwise it can only trigger a fault alarm. Intrinsic alarming is only supported on eBUS and all DAC/DSC controllers excluding DSC8 and DAC4. The following table shows the type of alarm function for each of the objects that support intrinsic alarming. Object with Intrinsic Alarming and Alarm Text tabs
Alarm Type
Analog Input (AI)
Out of Range
Analog Output (AO)
Out of Range
Binary Input (BI)
Change of State
Binary Output (BO)
Command Failure
MultiState Input (MI)
Change of State
It is not necessary to create and configure an Event (EV) object to monitor one of these five objects on a supported controller. This approach saves database space on a controller and provides a quicker way to get common alarm function. The Intrinsic Alarming feature works in conjunction with EVCs, Navigator, notifications and the Active Alarms Folder. Intrinsic Alarming functions for local or remote situations. The alarming works not only with local I/O but also with remote I/O such as the ones on LINKnet devices. For Intrinsic alarming to function, the input or output must be Commissioned on the Sensor / Device tab of the object dialog. These objects support the following BACnet optional intrinsic alarming properties: TimeDelay, NotificationClass, HighLimit, LowLimit, Deadband, LimitEnable, AckedTransitions, NotifyType, EventTime, and EventEnable. The Enable checkbox on the Alarming tab must be selected in order to configure intrinsic alarming. The Alarm State field changes color depending on the alarm state. The field is red if Alarm State is abnormal.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–462
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–463
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–463
10–464
Software Objects Reference Version 3.40 BACnet
Alarming Tab Fields The following table provides a list of the fields on the Alarming tab for the AI/ AO, BU, BO, MI objects. Most of the fields are common to all object. Each field name includes a link to the content for that field. Alarming Tab fields for AI, AO, BI, BO, MI All Objects AI / AO Only BI Only Enable checkbox Alarm State Delay
Notify Type
MI Only
Feedback Value
Time Delay Event Class
BO Only
Alarm Value High Limit Low Limit Deadband High Limit Enable Checkbox Low Limit Enable Checkbox
Event Enable
Alarm Fault Values Dataview
Acked Transitions Alarm Fault Return to Normal
Intrinsic Alarming (Common to All) This section focuses on the fields that are common to the Alarming tab for AI, AO, BI, BO and MI objects. Links are provided to content that explains fields that occur only on a specific object.
Enable checkbox (Common to all) When the Enable checkbox is checked, the fields on the Alarming tab become available and each field will have its default property value. Note that alarming feature will not be fully enabled until object is commissioned. To commission object, enable “Commissioned” checkbox on either Sensor or Device tab on the dialog.
Alarm State (Common to all) Shows whether this object has an active alarm state associated with it.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–464
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–465
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.
Delay (Common to all) Displays the current timer countdown of the value specified in the Time Delay field. The alarm input must persist in satisfying the conditions to alarm for the entire Time Delay for the actual transition to occur. If the alarm input returns to a normal condition before the timer counts down, the Event does not transition.
Feedback Value (BO only) See Feedback
Value (BO only) topic starting on page 10–473.
Time Delay (Common to all) Defines the amount of time that the event / alarm waits before it transitions when the object has changed to an alarm state. If the alarm input returns to a normal condition before the timer counts down, the event does not transition. 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:
Total Pages in this Section: 812
From-State
To-State
Delay Applied
Normal
Alarm
Yes
Alarm
Normal
No
Normal
Fault
Yes
Fault
Normal
No
Alarm
Fault
Yes
Fault
Alarm
Yes
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–465
10–466
Software Objects Reference Version 3.40 BACnet
Alarm Value (BI only) See Alarm
Value (BI only) topic starting on page 10–472.
Event Class (Common to all) The Event Class field allows a user to specify Event Class. The Event Class is mainly used to specify the devices that the event notifications are to be sent to. By default, the Event Class field is set to Notification (EVC5) which causes notifications to be broadcasted to all devices on the network. 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. Event Class
Explanation
Maintenance
A maintenance alarm alerts personnel when a piece of mechanical equipment requires service or periodic maintenance. For example, a change of state event monitors the status of an air filter in a air handler unit. The change of state Maintenance Alarm monitors the filter switch that alerts maintenance to replace the dirty filters. The alarm becomes off normal when the filter is dirty.
Network
A Network Alarm monitors the activity on a BACnet network and notifies the operator of problems. For example, a Event could detect if a controller stops communicating.
Security
A Security Alarm notifies the operator of security problems. For example, a change of state security alarm can monitor a set of contacts on a closed door or window. Also a change of state security alarm can monitor a motion detector input.
Critical
A critical alarm indicates a situation that requires immediate attention from the operator. For example, if the supply fan motor failed, the Air Heating Unit would not function properly. -ORA change of state critical alarm monitors the status of a fan motor. The operator is notified when the return fan motor fails.
Notification
A Notification Alarm indicates non-critical events and provides alarm information. A typical Notification alarm might be the Supply Air Temperature that may tend to go outside the specified range frequently. An out of range event reports when the Supply Air Temperature has gone out of a specified range. Event objects default to this class when created.
Fire
A Fire Alarm reports conditions that indicate a fire or smoke alarm. A typical Fire alarm might be monitoring the input from a fire panel on site or from a sensor connected directly to the controller. The change of state alarm monitors the Return Air Smoke Detector Input that detects smoke inside the air handler. The event class assigns each type of transition a priority value. The priority level is used to determine what order notifications are sent out. The Event Class also specifies what transitions require an acknowledgement. Finally the EVC contains a list of
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–466
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–467
devices that the notifications are sent to. Note: Event class objects are system objects and must be configured the same on each device. Event class 1 on device 1 must be configured the same as event class 1 on device 2. 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
This class is used to notify the user that a TL on the Historian device, has gathered samples that need to be archived. See the Chapter 6 - Trending, Archiving and Reporting of the ORCAview Technical Reference manual for more information.
High Limit (Analog objects only AI, AO) See High Limit 47010–467.
(Analog objects only AI, AO) topic on page 10–
Low Limit (Analog objects only AI, AO) See Low
Limit (Analog objects only AI, AO) topic on page 10–470.
Deadband (Analog objects only AI, AO) See Deadband topic on page 10–471.
High Limit Enable Checkbox (Analog objects only AI, AO) See High Limit Enable AO) topic on page 10–471.
Checkbox (Analog objects only AI,
Low Limit Enable Checkbox (Analog objects only AI, AO) See Low Limit Enable AO) topic on page 10–471.
Total Pages in this Section: 812
Checkbox (Analog objects only AI,
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–467
10–468
Software Objects Reference Version 3.40 BACnet
Notify Type (Common to all) Defines whether notifications generated by the monitoring algorithm of the selected Event type are of either Event or Alarm type notifications. By default, Notify Type is set to Alarm. Regardless of the specified Notify Type, notifications are sent. 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.
Event Enable (Common to all) By default, all the following checkboxes are enabled: Alarm Checkbox - When checked, a notification is generated for an alarm (off normal) state. Fault Checkbox - When checked, a notification is generated for a Fault state. Return to Normal Checkbox - When checked, a notification is generated for a Return to Normal state.
Alarm Fault Values Dataview (MI only)
Dataview: Alarm and Fault Values (MI only) topic on page 10–475.
See
Acked Transitions (Common to all) A transition occurs when an Alarm Input value is outside of the defined Event conditions or returns to within the defined Event conditions. Typically, an event has a Time Delay during which the alarm input value must continue to be outside of the defined conditions before an Alarm Notification is sent. An operator can acknowledge a transition. When you acknowledge an Event, the Event Management System adds ACK to the transition description that you see in the Event Log or in Alarm Notification printouts. When operator acknowledge Out-Of-Range or Change-Of-State alarm, “To Alarm” text will be displayed on “Acked Transitions” field of the alarm object dialog. Similarly, “To Fault” or “To Normal” will be displayed when operator acknowledge Fault Alarm or Return-To-Normal Alarm.
Alarm (Common to all) Time is recorded in the field when alarm generated by the intrinsic alarming object is acknowledged,
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–468
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–469
Fault (Common to all) Time is recorded in the field when fault alarm generated by the intrinsic alarming object is acknowledged.
Return to Normal (Common to all) Time is recorded in the field when Return-To-Normal is acknowledged.
Analog Input / Output Objects Alarming Tab The Alarming tabs for the Analog Input and Analog Output objects have the same fields. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–469
10–470
Software Objects Reference Version 3.40 BACnet
High Limit (AI / AO only) 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. The field has a range of 0 - 100 with a default value of 0.0. 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.
Low Limit (AI / AO only The low limit parameter specifies the minimum value the alarm input can drop to before an Alarm (Low Limit) transition is generated. The field has a default value of 0.0 with a range of 0 - 100. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–470
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–471
Deadband (AI / AO only The deadband parameter is specified for Return to Normal calculations. The deadband provides a way to reduce nuisance or excessive alarms. The field has a default value of 0.0 with a range of 0 - 100. The role that the deadband plays in the alarm type is shown in the formulas below. The Event generates a High Limit alarm when: Alarm Input value > High Limit Setting High Limit alarm returns to normal when: Alarm Input value < (High Limit Setting - Deadband Setting) The Event generates a Low Limit alarm when: Alarm Input value < Low Limit Setting Low Limit alarm returns to normal when: Alarm Input > (Low Limit + Deadband)
High Limit Enable Checkbox (AI / AO only Enables the limit defined in the High Limit field. By default, the checkbox is not enabled.
Low Limit Enable Checkbox (AI / AO only Enables the limit defined in the Low Limit field. By default, the checkbox is not enabled.
Binary Input Alarming Tab The Alarming tab on the Binary Input object monitors a Binary Input (digital) and notifies when the input state changes, and when input detects fault. The change-of-state alarm type is used when a binary object or property is monitored. Some examples are freeze status indicators, air handler filters, smoke detectors, etc. If a new alarm condition occurs while the object is already in an alarm condition, another transition will NOT be generated.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–471
10–472
Software Objects Reference Version 3.40 BACnet
Alarm Value (BI only) This value that is compared to the alarm input object property. If the alarm input object property matches the value, an alarm transition is generated. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–472
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–473
Binary Output Alarming Tab The Alarming tab on the Binary Output object monitors a Binary Output (digital) and notifies when the output state changes, and when output detects fault. 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.
Feedback Value (BO only) Indicates the current status of the physical output. The possible values are either Inactive or Active. If Feedback is disabled in the Module section of Device tab, feedback value will always be Inactive regardless of the physical output. In this case, BO object will be in Alarm state when present value turns ON. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–473
10–474
Software Objects Reference Version 3.40 BACnet
MultiState Input Alarming Tab The Alarming tab on the MultiState Input object monitors a digital input and notifies when the input state changes to configured values and when input detect fault . 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–474
Total Pages in this Section: 812
Intrinsic Alarming (AI, AO, BI, BO, MI) [New 3.40] Description
10–475
Dataview: Alarm and Fault Values (MI only) As this object is able to read in values with more than two states, it has lists with multiple Alarm and fault values. Note that numerical values have to be entered in the field instead of string values.
Dataview Alarm Values This is a list of Alarm values that are compared to the alarm input object property. If the alarm input property matches one of these values, then an alarm transition is generated.
Dataview Fault Values This is a list of Fault values that are compared to the alarm input object property. If the alarm input property matches one of these Fault values, then a Fault transition is generated.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–475
10–476
Software Objects Reference Version 3.40 BACnet
INTRINSIC ALARM TEXT TAB (AI, AO, BI, BO, MI) [NEW 3.40] The Alarm Text tab allows a message to be specified for the Alarm, Fault, and Return to Normal transition messages. It has some similarities with the messaging tab on the Event object.
The Use Auto Generated Messages checkbox is enabled by default.
Message texts for each transition are entered here. An operator can use the Use Auto Generated Messages feature AND/OR the customized message text entered in those three fields.
Alarm, Fault and Return to Normal (Message) Fields 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, logged to Event Log (EVL), or sent as email/pager/SMS message. . 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–476
Total Pages in this Section: 812
Intrinsic Alarm Text Tab (AI, AO, BI, BO, MI) [New 3.40] Description
10–477
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 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–477
10–478
Software Objects Reference Version 3.40 BACnet
Auto Generated Alarm Messages The Use Auto Generated Messages checkbox applies to supported controllers. If the user leaves the corresponding message field for an event blank or the event is intrinsic, then a standard message is generated and no additional message or spaces are appended to the printout or notification.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–478
Total Pages in this Section: 812
Intrinsic Alarm Text Tab (AI, AO, BI, BO, MI) [New 3.40] Description
10–479
The following figure shows an Out Of Range (High Limit) alarm Notification with auto generated message.
Auto Generated Alarm Text
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–479
10–480
Software Objects Reference Version 3.40 BACnet
Standard Auto Generated Message Text Auto Generated Alarm Messages Alarm Type
Text Format
Change of State
(). () is in ALARM Example: AHU1 9400 (9400).AHU1 Filter Status (Dirty) is in ALARM
Out of Range (High-Limit)
Out of Range (Low-Limit)
Command Failure
(). () has exceeded its HIGH LIMIT () Example: AHU1 9400 (9400).AHU1 Mixed Air Temperature (28.9) has exceeded its HIGH LIMIT (26.0) (). () has dropped below its LOW LIMIT () Example: AHU1 9400 (9400).AHU1 Mixed Air Temperature (8.0) has dropped below its LOW LIMIT (11.0) (). () does not match () Example: AHU1 9400 (9400).
Auto Generated Fault/Acknowledged Messages Transition Type
Text Format
Fault
(). is in FAULT Example: AHU1 9400 (9400).AHU1 Supply Fan Control is in FAULT
Acknowledged
Delta Alarms Alarm Acknowledged by () Example: AHU1 SAT HIGH LIMIT Alarm Acknowledged by Wen (Wen’s PC) rd
3 Party Alarms Alarm Acknowledged by Example: AHU1 SAT LOW LIMIT Alarm Acknowledged by Alerton PC
Auto Generated Returned to Normal Messages Transition Type
Text Format
Return to Normal
().< Alarm Input Name> () has returned to Normal Example: AHU1 9400 (9400).AHU1 Filter Status (Clean) has returned to Normal
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–480
Total Pages in this Section: 812
LCD and Keypad Access (LCD) Header
10–481
LCD AND KEYPAD ACCESS (LCD) The LCD and Keypad Access (LCD) object is used to control the actual physical display of the Room Controller or BACstat device, as well as the beeper and key configuration information. The LCD object is created automatically by the controller and cannot be created manually. It can, however, be copied and pasted, deleted, and saved and loaded. The LCD object only displays information that relates to the type of device it is representing. Not all fields will be displayed in the Setup and Advanced tabs depending on the type of device the LCD is representing.
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 )”.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–481
10–482
Software Objects Reference Version 3.40 BACnet
Last Key Press This read-only field displays the value of the last key that was pressed on the device’s keypad. This field was previously called the Keypress Value.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–482
Total Pages in this Section: 812
LCD and Keypad Access (LCD) View
10–483
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. Icon
Total Pages in this Section: 812
Name
Icon
Name
Alarm Bell
Occupancy (Unoccupied)
Network
Fan
Auto
Heating
Humidity
Cooling
Occupancy (Occupied)
Bar Icon
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–483
10–484
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–484
Total Pages in this Section: 812
LCD and Keypad Access (LCD) View
10–485
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–485
10–486
Software Objects Reference Version 3.40 BACnet
Line1 Units Line2 Units Line2 Line3 Units
Line3
The following table lists the icons included in the previous figure. Icon
Associated property
Values
Description
Fan
0 – OFF
Used to indicate the status of the fan
1- ON Fan
2 – Low 3 – Medium
Used to indicate the speed of the fan (Low, Medium, High)
4 - High Heating
0 – OFF
Used to indicate heating mode
1 – ON Cooling
0 – OFF
Used to indicate cooling mode
1 – ON Humidity
0 – OFF
Used to indicate humidity
1 – ON
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–486
SunMoon
1
Used to indicate night mode
SunMoon
2
Used to indicate Day mode
Occupancy (Unoccupied)
1
Used to indicate that the room is unoccupied
Occupancy (Occupied)
2
Used to indicate that the room is occupied
Total Pages in this Section: 812
LCD and Keypad Access (LCD) Setup
10–487
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–487
10–488
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–488
Total Pages in this Section: 812
LCD and Keypad Access (LCD) Setup
10–489
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.
Key Repeat Delay This field is only displayed if the Device Type is a type of Room 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).
Key Repeat Interval This field is only displayed if the Device Type is a type of Room Controller. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–489
10–490
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–490
Total Pages in this Section: 812
LCD and Keypad Access (LCD) Advanced
10–491
Line 1, Line 2, Line 3 These fields are used to write to the different text sections of the LCD manually. 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.
Uppercase Display Checkbox When this field is checked, the information in the Line 1, Line 2 and Line 3 fields is changed from lowercase to uppercase. If the field is unchecked, and Apply is pressed, the information in Lines 1-3 will remain uppercase.
Time Source (BACstat II) The Time Source dropdown box is only displayed if the Device Type is a type of BACstat II (i.e. DNS-24, DNT-T221) or later. This field is used to display the current time on Line 3 of the BACstat’s 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). Example 1: Display Military Time on Line 3 Without Leading Zeroes 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.
Example 2: Display Military Time on Line 3 With Leading Zeroes 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–491
10–492
Software Objects Reference Version 3.40 BACnet LinkLCD1.Line3 = Format(Hours) & ":" & Format(Minutes,0,2,"0") Example 3: Display Time in AM/PM (12-hour) format on Line 3 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–492
Total Pages in this Section: 812
LCD and Keypad Access (LCD) Advanced
10–493
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: There are two Auto fields: Auto 1 and Auto 2. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–493
10–494
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–494
Total Pages in this Section: 812
LCD and Keypad Access (LCD) Description
10–495
Minimum The Minimum field indicates if the Minimum text is displayed on the LCD. If the value of the Minimum field is ON, the Minimum text will be displayed. If the value of the Minimum field is OFF, it will not be displayed. Maximum The Maximum field indicates if the Maximum text is displayed on the LCD. If the value of the Maximum field is ON, the Maximum text will be displayed. If the value of the Maximum 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–495
10–496
Software Objects Reference Version 3.40 BACnet
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+. 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+. Property
Value
.Description
Text string up to 2000 characters
.Name
Test string up to 67 characters
.DisplaySelection (Header Value)
Reference, Line1, Line2, Line3
.IconDisable
On/Off
.AlarmBell
On/Off
.Network
On/Off
.Auto1
On/Off
.Auto2
On/Off
.Humidity
On/Off
.Occupancy
0, 1, 2
.Fan
0-4
.Heating
0-4
.Cooling
0-4
.KeyRepeat
No Limits
.KeyDelay
No Limits
.Beeper
On/Off
.BeeperOn
No Limits
.BeeperOff
No Limits
.BeeperRepeat
No Limits
.Contrast
0-100%
.Backlight
0-100%
.BackLightEnabled
On/Off
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–496
Total Pages in this Section: 812
LCD and Keypad Access (LCD) GCL+ Properties
10–497
This table describes some additional properties that can be used in GCL+ programming code. Property
Use
.Line1
Can equate Lcd.Line1 to an alphanumeric string expression. The FORMAT function can set the appearance of the DAC display line.
.Line2
Can equate Lcd.Line2 to an alphanumeric string expression. The FORMAT function can set the appearance of the DAC display line.
.Line3
Can equate Lcd.Line3 to an alphanumeric string expression. The FORMAT function can set the appearance of the DAC display line.
.Mode1
Can equate to a value or to an object such as an input or output. This avoids having to use memory to create an Analog Variable.
.Mode2
Can equate to a value or to an object such as an input or output. This avoids having to use memory to create an Analog Variable.
.Mode3
Can equate to a value or to an object such as an input or output. This avoids having to use memory to create an Analog Variable.
.Mode4
Can equate to a value or to an object such as an input or output. This avoids having to use memory to create an Analog Variable.
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
.KeyInactive
Specifies the inactivity time in seconds
.Keysilent
0 = past the KeyInactive time 1 or greater - KeyInactive time has not expired.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–497
10–498
Software Objects Reference Version 3.40 BACnet 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 // Handle timeout of keypress IfOnce Lcd.KeySilent = 0 Then Lcd.Line3 = “Keys Silent” Endif
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–498
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Header
10–499
LIGHTING GROUP (LG) V3.40 DELTA PROPRIETARY 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, 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 with 16 Megabit
Flash.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–499
10–500
Software Objects Reference Version 3.40 BACnet Possible values are: If the Value is
The Lighting Group
Off
Last controlled the lighting outputs to their Off state.
On
Last controlled the lighting outputs to their On state
Override
Last turned on the lighting outputs because the override input was activated.
Restore
Not applicable. This value is not currently in use.
Relinquish
Automatically select an auto value.
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: Object Value
Expected result after assigning manual object value
Off
Command the lighting outputs to their Off state.
On
Command the lighting outputs to their On state
Override
Command the lighting outputs to their On state
Restore
Not applicable. This value is not currently in use.
Relinquished
Automatically select an auto value.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–500
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Header
10–501
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. Schedule/Photocell/Light Switch This priority indicates that either Retrofit Relay Control is being enabled, or the lighting outputs have been signaled to turn ON by one of the following: •
Occupancy input turned ON
•
Photocell input detected the configured darkness level
•
Controller time has passed the “Today’s On Time” for Astronomical Control
•
Group Switch was used
•
Another LG is controlling the LG as its lighting output
Manual Operator 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.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–501
10–502
Software Objects Reference Version 3.40 BACnet
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.
Description (3.40 LG Dialog)
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–502
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Setup (3.40 LG Dialog)
10–503
Setup (3.40 LG Dialog)
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. The possible Reliability status flags are: No Fault Detected This value indicates the normal state of operation. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–503
10–504
Software Objects Reference Version 3.40 BACnet 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. The field has four options: •
Relays Recalculated: Calculates the LG state and then sends that state to the outputs. This is the default setting of the field.
•
Relays On: Sets all outputs to On.
•
Relays Off: Sets all outputs to Off.
•
Relays Last State: Keeps the outputs at the current state regardless of the calculated state of the LG object.
HVAC, Access and Lighting Checkboxes These checkboxes are used to indicate which application(s) the object is part of and are used to restrict operator access. Any combination of HVAC, Lighting and Access Control can be selected. Leaving all checkboxes blank is the same as selecting them all. Lighting flag is on by default for lighting controllers. When a checkbox is selected, an indicator icon appears at the top of the dialog. The three application areas and icons are:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–504
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Outputs (3.40 LG Dialog) Application
10–505
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.
Outputs (3.40 LG Dialog) The Outputs tab links lighting outputs and/or lighting groups to the LG. It also assigns a specific switch input (digital or multistate) to each output or group. 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).
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–505
10–506
Software Objects Reference Version 3.40 BACnet
Retrofit Relay Control Checkbox The Retrofit Relay Control checkbox should only be enabled for an implementation with Sentry Switch style switches which move to the off position after 5 second or greater power interruption. The output relay turns Off for a 10 second period, and then returns to On. The switch switches to the Off position in that time, but allows the occupant to turn the switch back on after the sweep off has occurred. 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.
Lighting Outputs Dataview This Dataview is used to link lighting outputs and/or lighting groups to the group output of LG object. It also assigns a specific switch input (digital or multistate) to each lighting outputs or group. Lighting Outputs
Light Switch
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 configured as Lighting Outputs are controlled by the logic defined in the LG. An LG object cannot reference itself. By default, only local BOs will appear in the dropdown list which comes up in the column when double clicked. In order to set local/remote LG, users must type object reference in this field. 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. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–506
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Group Switches (3.40 LG Dialog)
10–507
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: Types of Control
Flick Warn occurs? (Yes/No)
Occupancy Control (With or without Delay Time or Sweep Off Timer)
Yes
Group Switch
Yes
Common Area Control
Yes
Manual Control
No
Light Switch
No
Daylight Control (Photocell and Astro)
No
GCL Control
No
Enable Checkbox (Flick Warning)
This field enables the Flick Warning feature which tells the occupants of an area when the lights are about to turn Off. By default, this checkbox is enabled.When Enabled is selected, the lights flick off briefly, and then on again, for 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 turned ON 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. By default, this checkbox is enabled.
Group Switches
(3.40 LG Dialog) Group Switches allow assigned switches to control the Lighting Group and all defined outputs. You can add additional switches which work in parallel. For example, instead of having only one group switch that can turn all lights ON and OFF, two group switches can be configured - one for turning lights ON only, and the other for turning lights OFF only.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–507
10–508
Software Objects Reference Version 3.40 BACnet
2 Wire LED Switches Checkbox This checkbox is used with the Panasonic WR style 2-wire switches on a DLCPxxxx controller. When this checkbox is enabled, the group switch pilot light is updated with the Feedback value of the associated LG. If all lighting outputs configured in the Lighting Output Data View are off, then the green LED light is ON, If one or more lights are ON, then the red LED light is ON. By default, this checkbox is enabled.
Group Switch Dataview This Dataview contains the Group Switches and associated Switch Actions pairs. Group Switch
Switch Action
This column will accept BI, BV, MI, MV, or BO objects. LG object value changes based on the selected Switch Action. If 2 Wire LED Switch is NOT used, switch action can be triggered only when Group Switch transition from OFF to ON. This field appears when 2 wire LED switches checkbox is disabled. This column defines what actions the Group Switch uses to control the LG.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–508
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Algorithm (3.40 LG Dialog)
10–509
Switch Action
Function
On / Off
The Group Switch provides normal On / Off control of the LG.
Off / Restore
This option is currently not implemented.
Off Only
The Group Switch can only turn the Lighting Group Off but not On. The On function is disabled.
On Only
The Group Switch can only turn the Lighting Group On but not Off. The Off function is disabled.
Algorithm (3.40 LG Dialog) The Algorithm tab contains options that configure Occupancy Control, Daylight Control and Common Area Control.
Enhanced Daylight Control with Enable Input The Lighting (LG) object has the ability to enhance Astronomical/Photocell control using an Analog or Binary Input reference by combining it with Enable input. The LG performs a logical AND on the Enable Input and the Astro/Photocell control. If Enable input reference is not entered, Enable Value is always ON by default.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–509
10–510
Software Objects Reference Version 3.40 BACnet 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
Lights Off 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. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–510
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Algorithm (3.40 LG Dialog) Sweep Off every
10–511
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 120 minutes with a range of 0 to 480 minutes. To disable Sweep off feature, 0 minutes should be set in this field.
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)
Value (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. 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.
Daylight Control – Astronomical Mode 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 with an offset, (i.e. dusk or night-time). The Off time is calculated by sunrise with an offset, (i.e. dawn or morning). 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–511
10–512
Software Objects Reference Version 3.40 BACnet
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 since those 2 controls cannot work together.
Lights On Checkbox
On Offset
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. 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 0 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
Lights Off Checkbox
Off Offset
Displays the calculated time factoring in the Offset that the Astronomical clock will turn the LG On. 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. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–512
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Algorithm (3.40 LG Dialog)
10–513
For example, a calculated Sunrise of 6:00am and an offset entry of 30 minutes would result in the LG turning Off at 6:30am. Today’s Off Time
Displays the calculated time (factoring in the Offset) that the Astronomical clock will turn the LG Off.
Daylight Control – Photocell Mode To enable Photocell mode, the Astronomical Control check box needs to be unchecked and an input reference specified in the Photocell dropdown box.
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 userdefined 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 userdefined Time Delay for ON and OFF transitioning to prevent cycling.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–513
10–514
Software Objects Reference Version 3.40 BACnet 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
Lights Off 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. 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
Lights Off Checkbox
This checkbox allows the input reference to trigger the LG On after the userdefined 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. This checkbox allows the input reference to trigger the LG Off after the userdefined 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–514
Total Pages in this Section: 812
Lighting Group (LG) V3.40 Delta Proprietary Algorithm (3.40 LG Dialog) Time Delay (New 3.40)
10–515
Time Delay can be applied to photocell control for ON and OFF transitioning to prevent cycling. The default is 300 Seconds with a range of 0 to 7200 Seconds.
Common Area Control Common Area Control allows the lights in a common area such as a hallway to remain On if any of the listed Lighting Groups are On. Exit Delay
Lighting Group
The field defines the amount of time after all defined Lighting Groups in the list have turned Off before the LG is turned Off. The Exit Delay default is 10 minutes with a range of 0 to 240 minutes. 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. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–515
10–516
Software Objects Reference Version 3.40 BACnet
LIGHTING GROUP (V3 BACNET) 3.33R1 DIALOG See current LG 3.40 Object starting on page 10–499 The lighting object uses two dialogs in 3.33. If the firmware build is LESS than 3.33 Build 95565, the older 3.33 R1 dialog (vn8v3lg_r1.dlg) is used. For the newer R2 dialog, see the R2 LG object topic starting on page 10–544 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 Circuits/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), 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–516
Total Pages in this Section: 812
Lighting Group (V3 BACnet) 3.33R1 Dialog Header
10–517
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: If the Value is
The Lighting Group
Off
Last controlled the lighting outputs to their Off state.
On
Last controlled the lighting outputs to their On state
Override
Last turned on the lighting outputs because the override input was activated.
Restore
Not applicable. This value is not currently in use.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–517
10–518
Software Objects Reference Version 3.40 BACnet 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. If the Value is
The Lighting Group
Off
Last controlled the lighting outputs to their Off state.
On
Last controlled the lighting outputs to their On state
Override
Last turned on the lighting outputs because the override input was activated.
Restore
Not applicable. This value is not currently in use.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–518
Total Pages in this Section: 812
Lighting Group (V3 BACnet) 3.33R1 Dialog Description (3.33R1 LG Dialog)
10–519
Description (3.33R1 LG Dialog)
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–519
10–520
Software Objects Reference Version 3.40 BACnet
Setup (3.33R1 LG Dialog)
The setup tab contains the following fields.
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. The possible fault status flags are: No Fault Detected This value indicates the normal state of operation. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–520
Total Pages in this Section: 812
Lighting Group (V3 BACnet) 3.33R1 Dialog Setup (3.33R1 LG Dialog)
10–521
Reliability Not Available This is Delta Controls, proprietary reliability code which indicates that the input as assigned does not physically exist. All virtual inputs will report Reliability Not Available. Reliability Linknet Offline This is a Delta Controls, proprietary reliability code which indicates that the LINKnet device, that an assigned input is mapped to, is not online. Reliability Missing CFG Object This is a Delta Controls, Proprietary reliability code which indicates that an assigned MI or MV object has an invalid configuration reference (MIC object). Any reference to a configuration object that does not exist in the database will report: Reliability Missing CFG Object. A blank reference is acceptable and will not report. 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.
HVAC, Access and Lighting Checkboxes These checkboxes are used to indicate which application(s) the object is part of and are used to restrict operator access. Any combination of HVAC, Lighting and Access Control can be selected. Leaving all checkboxes blank is the same as selecting them all. When a checkbox is selected, an indicator icon appears at the top of the dialog. The three application areas and icons appear as follows: 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–521
10–522
Software Objects Reference Version 3.40 BACnet
I/O Definition (3.33R1 LG Dialog)
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.
Lighting Outputs This column contains the Lighting Output reference to either local or remote BO or LG objects that are part of the LG. 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 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–522
Total Pages in this Section: 812
Lighting Group (V3 BACnet) 3.33R1 Dialog I/O Definition (3.33R1 LG Dialog)
10–523
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–523
10–524
Software Objects Reference Version 3.40 BACnet
Configuration (3.33R1 LG Dialog)
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–524
Total Pages in this Section: 812
Lighting Group (V3 BACnet) 3.33R1 Dialog Configuration (3.33R1 LG Dialog)
10–525
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–525
10–526
Software Objects Reference Version 3.40 BACnet
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.
Lights On 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, Daylight Savings Time, and UTC offset in the DEV object must be correct for the location of the controller. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–526
Total Pages in this Section: 812
Lighting Group (V3 BACnet) 3.33R1 Dialog Configuration (3.33R1 LG Dialog)
10–527
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 Specifies whether the object referenced in the Photocell Input triggers the LG On.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–527
10–528
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–528
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Header
10–529
LIGHTING GROUP (LG) V3 BACNET 3.33 R2 DIALOG See current LG 3.40 Object starting on page 10–499 The lighting object uses two dialogs in 3.33. If the firmware build is LESS than 3.33 Build 95565, the older 3.33 R1 dialog (vn8v3lg_r1.dlg) is used. For the older R1 dialog, see the R1 LG object starting on page 10–544 of this file. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–529
10–530
Software Objects Reference Version 3.40 BACnet
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: If the Value is
The Lighting Group
Off
Last controlled the lighting outputs to their Off state.
On
Last controlled the lighting outputs to their On state
Override
Last turned on the lighting outputs because the override input was activated.
Restore
Not applicable. This value is not currently in use.
Relinquish
Automatically select an auto value.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–530
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Header
10–531
If the Value is
The Lighting Group
Off
Last controlled the lighting outputs to their Off state.
On
Last controlled the lighting outputs to their On state
Override
Last turned on the lighting outputs because the override input was activated.
Restore
Not applicable. This value is not currently in use.
Relinquish
Automatically select an auto value.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–531
10–532
Software Objects Reference Version 3.40 BACnet
Description (3.33R2 LG Dialog)
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–532
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Setup (3.33R2 LG Dialog)
10–533
Setup (3.33R2 LG Dialog)
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. The possible fault status flags are: No Fault Detected This value indicates the normal state of operation. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–533
10–534
Software Objects Reference Version 3.40 BACnet Reliability Not Available This is Delta Controls proprietary reliability code which indicates that the input does not physically exist. All virtual inputs will report Reliability Not Available. Reliability Linknet Offline This is a Delta Controls proprietary reliability code which indicates that the LINKnet device, that an assigned input is mapped to, is not online. Reliability Missing CFG Object This is a Delta Controls Proprietary reliability code which indicates that an assigned MI or MV object has an invalid configuration reference (MIC object). Any reference to a configuration object that does not exist in the database will report: Reliability Missing CFG Object. A blank reference is acceptable and will not report. 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 (new 3.33R2) 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. The field has four options: •
Default: Default calculates the LG state and then sends that state to the outputs. This is the default setting of the field.
•
On: On sets all outputs to On.
•
Off: Off sets all outputs to Off.
•
Last State: Last State keeps the outputs at the current state regardless of the calculated state of the LG object.
HVAC, Access and Lighting Checkboxes These checkboxes are used to indicate which application(s) the object is part of and are used to restrict operator access. Any combination of HVAC, Lighting and Access Control can be selected. Leaving all checkboxes blank is the same as selecting them all. When a checkbox is selected, an indicator icon appears at the top of the dialog. The three application areas and icons are: 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–534
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Output (3.33R2 LG Dialog)
10–535
Output (3.33R2 LG Dialog) The Outputs tab links lighting outputs and/or lighting groups to the LG. It also assigns a specific switch input (digital or multistate) to each output or group. 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).
Retrofit Relay Control Checkbox The Retrofit Relay Control checkbox works with Sentry Switch style switches which move to the off position after 5 second or greater power interruption. The output relay turns Off for a 10 second period, and then returns to On. The switch will have switched to the Off position in that time, but will allow the occupant to turn the switch back on after the sweep off has occurred. 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 Dataview This function links lighting outputs and/or lighting groups to the group output. It also assigns a specific switch input (digital or multistate) to each breaker or group.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–535
10–536
Software Objects Reference Version 3.40 BACnet
Lighting Outputs
Light Switch
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. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–536
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Group Switches (3.33R2 LG Dialog)
10–537
Group Switches (3.33R2 LG Dialog) Group Switches allows the ability to assign switches to control the Lighting Group and all defined outputs. You can add additional switches which work in parallel.
2 Wire LED Switches Checkbox This checkbox is used with the Panasonic WR style 2-wire switches on a DLCPxxxx controller. When this checkbox is enabled, the group switch pilot light is updated with the Feedback value of the associated LG.
Group Switch Dataview This Dataview contains the Group Switches and associated Switch Actions pairs. Group Switch
Switch Action
Total Pages in this Section: 812
This column will accept BI, BV, MI, MV, or BO objects. LG changes based on the selected Switch Action only when Group Switch transition from OFF to ON. This column defines what actions the Group Switch will use to control the LG.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–537
10–538
Software Objects Reference Version 3.40 BACnet
Switch Action
Function
On / Off
The Group Switch provides normal On / Off control of the LG.
Off / Restore
This option is currently not implemented.
Off Only
The Group Switch can only turn the Lighting Group Off but not On. The On function is disabled.
On Only
The Group Switch can only turn the Lighting Group On but not Off. The Off function is disabled.
Algorithm (3.33R2 LG Dialog) The Algorithm tab contains options that configure Occupancy Control, Daylight Control and Common Area Control.
Enhanced Photocell Control with Schedule as Occupancy Input 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). The LG performs a logical AND on the Occupancy Input and the Photocell control. Lights On and Lights Off checkboxes should be disabled for Occupancy Control and enabled for Daylight control to perform the logical AND correctly.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–538
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Algorithm (3.33R2 LG Dialog)
10–539
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
Lights Off 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. 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
Total Pages in this Section: 812
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–539
10–540
Software Objects Reference Version 3.40 BACnet
Sweep Off every
The Sweep Off every field sets the amount of time that the LG object waits before it commands an output Off that was left On due to an override in an area. A person could override a zone On after the occupancy input turns a group Off. Defining a time here would cause an override to be cleared at the set intervals from the time the Input turns Off. The default value is 0 minutes (disabled) with a range of 0 to 480 minutes. 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.
Daylight Control - Astro (Astronomical) Mode The Daylight Control function is available in two modes: Astronomical and Photocell. The available Daylight Control options change depending on whether the Astronomical Control checkbox is selected or a Photocell input is defined on this tab. 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 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
On Offset
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. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–540
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Algorithm (3.33R2 LG Dialog) Today’s On Time
Lights Off Checkbox
Off Offset
10–541
Displays the calculated time factoring in the Offset that the Astronomical clock will turn the LG On. 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. 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. For example, a calculated Sunrise of 6:00am and an offset entry of 30 minutes would result in the LG turning Off at 6:30am.
Today’s Off Time
Displays the calculated time (factoring in the Offset) that the Astronomical clock will turn the LG Off.
Daylight Control – Photocell Mode The Daylight Control options change depending on the selected mode of the LG object. To enable Astro, Astronomical Control check box needs to be checked. To enable photocell, an input reference has to be selected in the Photocell dropdown box. 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. Different options exist for binary and analog photocell references. Binary Photocell Reference
With a binary object acting as the input 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. Both analog and digital Photocell have a 5 minute deadband for ON and OFF transitioning to prevent cycling.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–541
10–542
Software Objects Reference Version 3.40 BACnet
Lights On Checkbox
Lights Off 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. 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
Lights Off 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. 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.
Common Area Control Common Area Control allows the lights in a common area such as a hallway to remain On if any of the listed Lighting Groups are On.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–542
Total Pages in this Section: 812
Lighting Group (LG) V3 BACnet 3.33 R2 Dialog Algorithm (3.33R2 LG Dialog) Exit Delay
Lighting Group
10–543
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. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–543
10–544
Software Objects Reference Version 3.40 BACnet
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: •
Online - The device is communicating.
•
Offline - The Linknet device had already been disconnected when the parent device started up
•
Lost - The controller has not received any communications from the LINKnet device for about 25 seconds. Typical causes are that the device is unplugged from the network, has lost power or is not physically present but the LINKnet object was loaded with a database.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–544
Total Pages in this Section: 812
LINKnet (LNK) Setup
10–545
Setup The Setup tab contains information about the LINKnet device.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–545
10–546
Software Objects Reference Version 3.40 BACnet
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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–546
Total Pages in this Section: 812
LINKnet (LNK) Product
10–547
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–547
10–548
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–548
Total Pages in this Section: 812
LINKnet (LNK) Product
10–549
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. Some products such as an ADM do not have any of these variables.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–549
10–550
Software Objects Reference Version 3.40 BACnet
LOAD SHED (LS) OBJECT The Load Shed Object (LS) is a programmable object used to shed electrical loads. It allows a BACnet client, such as a utility company, to request that a BACnet device shed a portion of its power load for a period of time. The mechanism of how this load is shed is hidden from the client. 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)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–550
Total Pages in this Section: 812
Load Shed (LS) Object Header
10–551
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–551
10–552
Software Objects Reference Version 3.40 BACnet The State can have the following values: Shed State
Operation
Description
Inactive
Waiting
The object is waiting for a shed request.
Pending
Armed
The object is waiting for the Target Time to arrive so it can begin load shedding
Compliant
Running
A load shed is in progress. If the object is fully satisfying the request – it is compliant. The state of the request is rechecked every minute.
Noncompliant
Running
A load shed is in progress but the object is unable to fully satisfy the request because of some constraint. The object employs a best efforts approach and attempts to meet the request until the request is either reconfigured, cancelled, or completes. The state of the request is rechecked every minute.
As a Load Shed request is processed, the Load Shed object transitions through the following Shed States: 1.
Initially Inactive, the LS object awaits a Load Shed request.
2.
Receipt of a Load Shed request, causes the LS object to become Pending, waiting for the Target Time to occur.
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.
The Load Shed object state transitions are diagramed below:
Inactive Cancel Shed Request
Pending
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–552
Target Time met
Complete or Cancel
Compliant or Non-compliant
Total Pages in this Section: 812
Load Shed (LS) Object Description
10–553
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–553
10–554
Software Objects Reference Version 3.40 BACnet
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. To set a Target Time manually:
If the load shed is to start immediately, then uncheck the checkbox and the current time becomes the target time. If the load shed start is to be delayed, then check the Target Time checkbox. 1
Enter a time such as 16:00:00 in the time part of the time and date field.
2
Click on the dropdown arrow and select a date from the date picker.
3
Click Apply or OK to save the changes
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. Shed Level Definitions Type
Typical Definition
Examples
Level 0
Loads currently shed may be restored. No other shedding is necessary
•
The power spike has abated and loads may be restored
Shift electric power to any • alternate power source that is off the grid. •
Switch to stored ice in lieu of chiller plant
No Shedding Required Level 1 Switch To Alternate Energy Level 2 Shed Extraneous Loads
Level 3
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–554
Turn off all non-essential • equipment that has no ill effect to • human comfort or equipment Adjust equipment setpoints that
Switch to UPS Dim Hall Lights Shut window shades
•
Turnoff sidewalk deicers
•
Raise space temperature
Total Pages in this Section: 812
Load Shed (LS) Object Setup Reduce Convenience Loads
Level 4 Shed Convenience Loads Level 5 Shed Remaining Loads
might have an impact on human comfort
Turn off equipment to reduce power that will impact human comfort
10–555
setpoints •
Raise chilled-water temperature
•
Override VAV dampers
•
Shutdown chillers
•
Cycle air handlers
Turn off or reduce usage of all remaining controllable loads
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. To configure a controlled object:
1
In the Controlled Objects column, select an object from the list.
2
Use the arrows to select the Level for the Controlled Object.
3
Click the corresponding cell in the Kwh Usage column.
4
Enter a numeric value.
Level
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–555
10–556
Software Objects Reference Version 3.40 BACnet 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.
HVAC, Access, and Lighting Checkboxes These checkboxes are used to indicate which application(s) the object is part of and are used to restrict operator access. Any combination of HVAC, Lighting and Access Control can be selected. Leaving all checkboxes blank is the same as checking them all. 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. The three application areas are:
Application
HVAC (Red) Access (Blue)
Icon
Lighting (Green)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–556
Total Pages in this Section: 812
Menu (MN) V3 Header
10–557
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–557
10–558
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–558
Total Pages in this Section: 812
Menu (MN) V3 Setup
10–559
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–559
10–560
Software Objects Reference Version 3.40 BACnet
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. Menu Item
Function
Display Device Info
Display device information – Name, Model Name, Firmware Version, Application Software Version
Display Event Log
Displays events from the Compact Event Log
Display Object
Displays object name, value and flags
Display Text
Displays text (“Press OK to enter”)
Edit Object
Allows the user to edit the object value and properties
Enable/Disable DST
Enables or disables DST
Goto Menu
Goes to the specified menu
Goto System Display
Goes to the specified system display
Load from Flash
Loads the database from flash
Reset
Resets the specified object (entering DEV resets the entire controller)
Save to Flash
Saves the current database to flash
Set Calendar
Sets the Calendar object, recurring dates are not supported
Set Lat/Long
Sets lat and long for Astro
Set Lighting Group
Sets Lighting Group functionality, has 7 sections
Set Password
Sets the password for SUA
Set Schedule
Sets scheduled on and off times
Set Time and Date
Sets the time and date on the controller
Set UTC Offset
Sets the UTC offset time according to where the controller resides
Reconfigure Network
Used to resolves network conflicts
Set 12/24hr Display
Sets 12 hour or 24 hour mode
Choose Location
This is reserved for future applications
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–560
Total Pages in this Section: 812
Menu (MN) V3 Entering New Functions Menu Item
Function
Set Modbus Gateway
Sets the Modbus Gateway port settings.
10–561
Item Name Item name is an identifying title that appears on the LCD Keypad, and should describe the Menu Function selected.
Entering New Functions To enter new Menu (MN) (LCD Keypad) functions: 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. 3.
Total Pages in this Section: 812
Then enter the Item Name.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–561
10–562
Software Objects Reference Version 3.40 BACnet
MICRONET PROTOCOL SETTINGS (MNP) The MicroNet Protocol Settings (MNP) object is used to configure Version 2 micros or zones from a Version 3 DCU controller. The (MNP) object is a default object generated by the system and forms part of the BACnet DCU default database. The NMP object is no longer available on an OWS. The MNP Object has three functions: •
It obtains and displays the address of a single Zone Controller or Micro Controller when a single Zone Controller or Micro Controller is connected to a BACnet DCU.
•
The MNP Object can change the MAC address of a Zone Comptroller or Micro Controller when multiple Zone Controllers or Micro Controllers are connected to a BACnet DCU.
•
The MNP Object also sets the micro range within which any Micro Controllers connected to a BACnet DCU will reside.
Common Header
Status The Status drop-down dialog provides the following choices: Disabled The object is not in use and MS/TP is used. Enabled The object is in use and available to set the microrange. The controller must be reset for any changes to take effect. Note: In order for MicroNet to work, MS/TP must be disabled on the Setup tab of
the BACnet Protocol Settings (BCP) object. .
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–562
Total Pages in this Section: 812
MicroNet Protocol Settings (MNP) Addressing
10–563
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–563
10–564
Software Objects Reference Version 3.40 BACnet 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. Present (Read Write) If a single Zone Controller or Micro Controller is connected to a BACnet DCU, this field displays the current address of that Zone Controller or Micro Controller when the Get Address button is clicked. If multiple Zone Controllers or Micro Controllers are connected to a BACnet DCU, this field allows the operator to specify a single address to be changed. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–564
Total Pages in this Section: 812
MicroNet Protocol Settings (MNP) Setup
10–565
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–565
10–566
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–566
Total Pages in this Section: 812
Modem Settings (MDS) Description
10–567
MODEM SETTINGS (MDS) The Modem Settings (MDS) Object contains configuration information for a modem. The Modem Type field on the Setup tab contains a list of modems and also has a Custom option. The other fields on the dialog are set based on the Modem Type selection. 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
The description field may contain a character string of up to 2000 characters in length. The character string is limited to any printable character.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–567
10–568
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–568
Total Pages in this Section: 812
Modem Settings (MDS) Setup
10–569
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. A typical string might be: AT
Hangup This string is sent to the modem port before the modem port hangs up. Refer to your modem manual for more details. A typical string might be: ATH
Reset This string is sent to the modem port when the device is reset. Refer to your modem manual for more details. A typical string might be: ATZ
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. A typical string might be: ATDT
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–569
10–570
Software Objects Reference Version 3.40 BACnet
MULTI-STATE INPUT (MI) The Multi-state Input (MI) represents an input on a DAC controller only. The MI takes an analog input signal and converts it to X number of states, as defined by the user through the Multi-state Input Configuration (MIC) object. The MIC defines the number of states, their text values, and the voltage ranges. You can use any of the standard input types on the controller (i.e. 4 - 20mA, 10K, 0 - 5V, 0 10V). You can also represent LinkNet I/O inputs with the MI object. Note: The Multi-state Input (MI) object cannot be created on a DCU or on an OWS. This is available only on DAC controllers.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–570
Total Pages in this Section: 812
Multi-State Input (MI) Header
10–571
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.
Time of Last State Change This read-only field is the time of the last change of 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–571
10–572
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–572
Total Pages in this Section: 812
Multi-State Input (MI) Setup
10–573
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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–573
10–574
Software Objects Reference Version 3.40 BACnet 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–574
Total Pages in this Section: 812
Multi-State Input (MI) Sensor Tab
10–575
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. De-Commissioned - When this box is not checked, the Object is De-Commissioned and the Lock Icon is in the Header and in 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–575
10–576
Software Objects Reference Version 3.40 BACnet 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. Direct / Reverse Acting Direct/Reverse Acting determines whether a rising pulse (0 Volts to 5 Volts) or lowering pulse (5 Volts to 0 Volts) on the input will cause the MI to step to its next state. • •
Direct Acting: Trigger on rising edge (0 Volts to 5 Volts) Reverse Acting: Trigger on lowering edge (5 Volts to 0 Volts)
The Direct/Reverse Acting field is greyed out when anything other than the Stepping Function option is selected for the Value From field, since that is the only option that this is used for. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–576
Total Pages in this Section: 812
Multi-State Input (MI) Stats
10–577
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. Text Value The string value of the current value. Time of Last State Change This read-only field is the time of the last change of state of the MI object.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–577
10–578
Software Objects Reference Version 3.40 BACnet
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. Text Value The string value of the current value.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–578
Total Pages in this Section: 812
Multi-State Input (MI) Alarm Text (Intrinsic)
10–579
Alarm Text (Intrinsic)
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–579
10–580
Software Objects Reference Version 3.40 BACnet
MULTI-STATE INPUT CONFIGURATION (MIC) Controllers may store various Multi-State Input Configuration (MIC) Objects. They allow the operator to define the number of states and the names of the states for different types of Multi-State Objects.
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 can be utilized to provide 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–580
Total Pages in this Section: 812
Multi-State Input Configuration (MIC) Description
10–581
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–581
10–582
Software Objects Reference Version 3.40 BACnet
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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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)
Examples of Using an MIC with an MI and an MV The Multi-state Input Configuration (MIC) is a proprietary Delta Controls object used to configure Multi-state (MI) and Multi-state Variables (MV). It is within the MIC that the user provides the state text and voltage levels of each State, so that the MI and the MV can be used and the respective values computed.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–582
Total Pages in this Section: 812
Multi-State Input Configuration (MIC) Examples of Using an MIC with an MI and an MV
10–583
Configure a Multi-State Input (MI) The MIC is used to define the states for the MI (Multi-State Input). When configuring an MI, the user defines the states for the input to be used. There are 2 components to a state when configuring an MI: •
State Text
•
Voltage Range
State Text is the textual representation of the state and the Voltage Range is the lower and upper voltage of the state. When the MI executes, it calculates its value from the states defined in the MIC which is assigned as its device type. 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.
Configure a Multi-State Variable (MV) An MV is used to give textual meaning to different numerical states giving the user more informative information rather than just a number. In most cases, 3 or more states of the Multi-State Variable are used. The voltage range for the state is not needed when using an MV. The modes of a VAV box could be:
Total Pages in this Section: 812
State
State Text
1
Day Mode
2
Night Mode
3
Setup Mode
4
Night Override
Lower Voltage
Upper Voltage Not
Required
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–583
10–584
Software Objects Reference Version 3.40 BACnet
MULTI-STATE VARIABLE (MV) Multi-State Variables (MVs) are used to store the multiple state results of GCL+ program statements or to store multiple state values. Any GCL+ statement can set the value of a MV from any program within the network. Any program in any controller connected to the network can access the value. The states of a MultiState Variable are defined by the Multi-State Input Configuration (MIC).
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.
Current Index Value The Current Index Value is the number associated with the current state. For example: If there are three possible states in the object and the value is the first state, the Current Index Value will be 1. If the value is the last state, the Current Index Value will be 3.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–584
Total Pages in this Section: 812
Multi-State Variable (MV) Description
10–585
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 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 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–585
10–586
Software Objects Reference Version 3.40 BACnet
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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–586
Total Pages in this Section: 812
Multi-State Variable (MV) GCL+ Properties
10–587
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. It is not possible to assign an invalid number (state) to a Multi-State Variable with GCL+. If a GCL+ program assigns an invalid number (state) to a Multi-State Variable, the state will remain unchanged. The only way to assign an invalid value to an MV is in the GCL editor. 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+.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–587
10–588
Software Objects Reference Version 3.40 BACnet
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. 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.
Historian Note: By creating a Multi-Trend containing TL’s and their associated
Archive TL’s, users are able to view both the controller data and the historical data simultaneously.
Multi-Trend Components This section explains how the Multi-Trend object presents information. A MultiTrend object has these main components: •
Graph Area
•
Dataview
•
Slider Bar
•
Axes
•
Graph Legend (Colored Squares)
•
Toolbar
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–588
Total Pages in this Section: 812
Multi-Trend (MT) Multi-Trend Components
10–589
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–589
10–590
Software Objects Reference Version 3.40 BACnet
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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–590
Total Pages in this Section: 812
Multi-Trend (MT) Toolbar Components
10–591
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–591
10–592
Software Objects Reference Version 3.40 BACnet
The Line Properties dialog contains the following: 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–592
Total Pages in this Section: 812
Multi-Trend (MT) Toolbar Components
10–593
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. Y1-Axis and Y2-Axis Tabs 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–593
10–594
Software Objects Reference Version 3.40 BACnet Scale & Grid Interval Selecting this checkbox sets the grid interval for the Yaxis 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.
Multi-Trend Name This is the descriptor name given to the MT. Show Graph Symbols When this checkbox is selected, the MT displays symbols on the graph lines for each data sample. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–594
Total Pages in this Section: 812
Multi-Trend (MT) Toolbar Components
10–595
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. Description The description field 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.
Auto (Entire History)
Start Time
This button causes the X-axis (time axis) to auto-scale itself so that all of the available data can be seen. In the Axis dialog, the Start Time and Time Span are set to automatic.
Time Span (X axis)
AUTO: Show Entire Data
Setstart (History from Start Time)
Start Time
This button causes a user defined X-axis Start Time to be used. The X-axis Time Span would still be set to Automatic. An alternate method for achieving this viewing mode is to specify the Start Time in the Axis Properties Dialog.
Time Span (X axis)
SETSTART: Show Data from Specified Start Time
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–595
10–596
Software Objects Reference Version 3.40 BACnet
Range (Moving Frame) This button causes the viewing mode to switch to "Moving Frame" mode. In this mode, the start time is set automatically, but the time span is set by the user in the Axis dialog. The result is that a fixed time window will keep up with the new Trend Log data as it comes into the Multi-Trend.
Time Span (X axis)
RANGE: Show Specified Time Frame
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.
Back and Fwd These two buttons move the view to the left and right, respectively. Each click of the buttons will move one-half of a screen. The Back/Forward buttons can be enabled by clicking either the Range or the Pause button.
Zoom in and Zoom out These two buttons change the viewed time span by one-half and double, respectively. Zoom in will show less data, but it improves the resolution. Zoom out shows more data, but it becomes more difficult to see the detail. For example, if the viewed time span is 8 hours and Zoom in is clicked, then the new time span will be 4 hours. Clicking Zoom out will return the dialog to the original 8 hours. These buttons can be clicked as many times as necessary.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–596
Total Pages in this Section: 812
Multi-Trend (MT) Toolbar Components
10–597
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
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–597
10–598
Software Objects Reference Version 3.40 BACnet
NETWORK PROTOCOL SETTINGS (NET) The Network Protocol Settings (NET1) object is automatically created in the default database of a DAC. The object cannot be copied and pasted, saved and loaded, or deleted. It is used to set the DAC configuration options that BACnet allows as well as configuring which Network interfaces will communicate via the BACnet protocol. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–598
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–599
Setup The Setup tab specifies which communication interfaces are active and sets their parameters.
Setup Dataview Headings The Dataview has the following headings:
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–599
10–600
Software Objects Reference Version 3.40 BACnet 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. Possible states include: •
Active Status: Port is enabled and running normally. The Status Reference field will contain a reference to the Network Protocol Settings (NET1) Object.
•
In Use by: Port is being used by something else such as Linknet. The Status Reference column will display LNK* if Linknet is in use.
•
Driver Disabled: This displays when the Enabled checkbox is unchecked.
•
Gateway Disabled Status: Port is in use by a gateway and is not running BACnet, even if it is flagged as Enabled. The Status Reference will contain a reference to the Gateway Object GW1.
Status Reference Column The Status Reference column displays the object that is using the port. The object is either a Network Protocol Settings (NET1) Object, a Gateway (GW) Object, or a LNK*.
Setup Tab: Setup MS/TP The fields for Setup below the Dataview change depending on the protocol of the port that is selected in the Dataview.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–600
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–601
Baud Rate This is the communication speed between MS/TP (EIA-485) devices on this port. The following speeds are available: 9600, 19200, 38400 and 76800, with 76800 being the default. All devices on an EIA-485 subnet must use the same speed. 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 addressing is enabled, then the network 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. See the Network Numbers section in Appendix C Derived Network Addressing (DNA) for more information.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–601
10–602
Software Objects Reference Version 3.40 BACnet 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. Send Failures Counts the number of transmit errors. Protocol Errors Counts the number of MS/TP protocol errors. Total Received Counts the total number of packets received including tokens for MS/TP. Invalid Received Counts the number of receive errors. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–602
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–603
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.
Setup Tab: Setup PTP (Point to Point)
The fields for Setup below the Dataview change depending on the protocol on the port that is selected in the Dataview. Baud Rate This is the communication speed between Point-to-Point (serial) devices. Typically this would be the speed between the controller and the operator workstation or a modem. The following speeds are available: 9600, 19200, and 38400 with 9600 being the default. Both ends of a Point-to-Point connection must use the same speed. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–603
10–604
Software Objects Reference Version 3.40 BACnet 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 Type
Modem Init String
U.S. Robotics
AT&F1&R1&Y0&W0
Zoom
AT&F&K0&Y0&W0
Boca
AT&F0&K0&Y0&W0
Custom is displayed in the Modem Type drop-down if you manually change the Modem Init String. This field is available only if the current connection is Modem. 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. Remote Connections Require SUA Password Check This is a Networking Security feature. If this option is enabled, the SUA of the remote OWS that is dialing in will be compared with the controller’s SUA object. If the Username and Password do not match, the connection will be dropped and the remote OWS will not be able to communicate with the network. This field is available only if the current connection is Modem. SUA for Direct Connect to 3rd Party Specifies the Password to check when dialing into third party network.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–604
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–605
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.
Setup Tab: Statistics PTP (Same as MS/TP Statistics)
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–605
10–606
Software Objects Reference Version 3.40 BACnet
Setup Tab: Setup Ethernet (Ethernet DSC1280E/1212E/1616E)
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 addressing is enabled, then the network 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. See the Network Numbers section in Appendix C Derived Network Addressing (DNA) for more information. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–606
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–607
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.
Setup Tab: Statistics Ethernet (Ethernet DSC1280E/1212E/1616E)
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–607
10–608
Software Objects Reference Version 3.40 BACnet
Setup Tab: UDP/IP Network Specific Settings When UDP/IP is selected, the following options display below the Dataview. 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.
Setup Tab: General UDP/IP 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 subnetwork, 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 subnetwork which has no BBMD. These controllers can communicate with the larger network by registering with a remote BBMD device on another subnetwork. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–608
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–609
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. Proxy (NAT) Address This address is entered when a controller is behind a proxy server that provides Network Address Translation (NAT). The address is the outside world address of the proxy. Otherwise leave the address as 0.0.0.0 which is the default address. This field is only available when a BBMD Device is selected as the Device Type and the IP Address field has a private IP address. 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. 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. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–609
10–610
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–610
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–611
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. See the Network Numbers section in Appendix C Derived Network Addressing (DNA) for more information. 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.
Remote Connections Require SUA Password Check This is an IP Networking Security feature. If this option is enabled, foreign devices logging into the BBMD device will have their SUA objects verified against the SUA objects in the controller. If the Username/Passwords do not match, the connection will be dropped and the foreign device will be unable to communicate with the network 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–611
10–612
Software Objects Reference Version 3.40 BACnet
Setup Tab: Statistics UDP/IP
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–612
Total Pages in this Section: 812
Network Protocol Settings (NET) Setup
10–613
Setup Tab: BBMD List UDP/IP The Setup tab: BBMD List provides an easy way to enter an IP Address. You just double click on a blank entry in the field and then enter the address.
Remote BBMD Addresses If a controller (DCU or DSC) is a BBMD device, it needs to know about other BBMD devices on remote IP networks in order to communicate with the devices within the remote networks. BBMD devices store the list of known remote BBMD devices in the BMD object which is set up by the user. The list entry displays the IP address of the remote BBMD controllers. The BBMD list field in the NET1 object displays the referenced BBMD devices from the BMD object. You can change the list in either the NET1 or BMD objects, and the system updates the list in the other object. The user can copy/paste the BMD object to other controllers.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–613
10–614
Software Objects Reference Version 3.40 BACnet
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. APDU Retry Timeout 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–614
Total Pages in this Section: 812
Network Protocol Settings (NET) MS/TP Slaves
10–615
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 Timeout This field, which is very similar to the Retry Timeout, specifies the time between re-transmissions of a single segment of a multisegment 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
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–615
10–616
Software Objects Reference Version 3.40 BACnet 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.
Max APDU Size This field specifies the largest size of an Application Protocol Data Unit this slave device can receive. The range of the value is 50 to 480 bytes. This value is dependent on the implementation of the slave device. Refer to the slave device’s documentation to determine what value to use.
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.
Segmented The device is able to send and receive segmented messages. Segmented Send The device is able to send segmented messages. Segmented Receive The device is able to receive segmented messages.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–616
Total Pages in this Section: 812
Network Protocol Settings (NET) MS/TP Slaves
10–617
No Segmentation The device can neither send nor receive segmented messages.
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: •
MS/TP (1 byte): a decimal number in the range 0-254 (e.g., NET50,71);
•
Ethernet (6 bytes): 12 hexadecimal digits (e.g., NET50,357A8042FF00);
•
IP (6 bytes): 4 hexadecimal digits, representing the port, followed by a colon (:) followed by 4 decimal values in the range 0-255 separated by periods (.) (e.g., NET50,BAC3:128.67.255.0);
•
2-byte LonTalk: 2 decimal numbers in the range 0-255 separated by a comma (e.g., NET50,128,91);
•
7-byte LonTalk and all other formats: An even number of hexadecimal digits (e.g., NET50,68D51A28E443F3).
If an odd number of digits are entered for a hexadecimal value, then the last digit will be ignored. Note: A MAC address that is entered in the IP or Ethernet formats will be
formatted in the IP format if the first 3 hexadecimal digits are BAC; otherwise, it will be formatted in the Ethernet format. (E.g., if NET50,BAC38042FF00 is entered, it will be formatted as NET50,BAC3:128.67.255.0; and if NET50,357A:128.67.255.0 is entered, it will be formatted as NET50,357A8042FF00.).
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–617
10–618
Software Objects Reference Version 3.40 BACnet
OBJECT REPLICATION (RPL) 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. Navigator has a Reload Replicated Objects command available when a selected controller in the left pane of Navigator is right clicked. The command reloads replicated objects to the selected controller. This feature is mainly used for Access Control. This menu item will force a replication of all objects in the RPL object list to the selected device as long as that device is in the RPL device list, and contains an AS object.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–618
Total Pages in this Section: 812
Object Replication (RPL) MS/TP Slaves
10–619
Manual Override
Use the Manual Override button to stop replication and to resume replication.
Replicated Devices
Navigator has a Reload Replicated Objects command available when a selected controller in the left pane of Navigator is right clicked. The command reloads replicated objects to the selected controller.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–619
10–620
Software Objects Reference Version 3.40 BACnet
Last Update Time Last Update Time displays the date and time when replication last occurred.
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 Type
Objects Being Replicated
Number of Objects being replicated
ASM
Card User
10,000
DSC
Access Group Door Group Schedule Calendar System User Access Card User Access Group Door Group Schedule Calendar System User Access
No Limit No Limit No Limit No Limit No Limit 500 No Limit No Limit No Limit No Limit 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–620
Total Pages in this Section: 812
Object Replication (RPL) MS/TP Slaves
10–621
Replicated Objects
Navigator has a Reload Replicated Objects command available when a selected controller in the left pane of Navigator is right clicked. The command reloads replicated objects to the selected controller. This feature is mainly used for Access Control. This menu item will force a replication of all objects in the RPL object list to the selected device as long as that device is in the RPL device list, and contains an AS object.
Replicated Object List The Replicated Object List is used to select the object types to be replicated. Object Type This field is used to select the object types to be included in the replication process. Six object types can be replicated. They are: Access Group (AG) object Card User (CU) object Door Group (DG) object Schedule (SCH) object Calendar (CAL) object System User Access (SUA) object The same object type can be selected multiple times to allow flexibility in setting the instance range. Instance Range Instance Range sets the object instances that are included in the replication process for the corresponding object type and for the controllers listed on the Replicated Devices tab. To select all of the instances, enter a wildcard (*). Wildcard causes replication to all the instances of the object. If no instance is specified then Instance Range defaults to wildcard. To select a range of instances, enter the range in the format: 1-20. By having multiple entries, you can select different ranges. For example, for CU objects you can select an instance ranges such as 1-20 and 50 - 80.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–621
10–622
Software Objects Reference Version 3.40 BACnet
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.
Replication Log Files The RPL object includes a log file feature that helps troubleshoot problems in the setup of the replicated objects. If an Object Replication update fails, a message displays with information that identifies the controller and directs the user to a log file located at C:\Users\Public\Delta Controls\3.40\Logs. For XP, the location is: :\Documents and Settings\Public\Delta Controls\3.40 For Vista and Windows 7, the location is: :\Users\Public\Delta Controls\3.40 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–622
Total Pages in this Section: 812
Object Replication (RPL) MS/TP Slaves
10–623
is created, the Reload Replicated Objects command overwrites the RPLLog1.txt file. The number of log files never exceeds ten files. To execute the Reload Replicated Objects command, in the left pane of navigator, select either BACnet Protocol, or a specific controller, then right-click and select Reload Replicated Objects from the pop-up menu.
Object Replication Update Successful When the Reload Replicated Objects command is successful, a typical log file contains information similar to: ****************************************************************** Delta Controls, Object Replication Log File Replicating to ALL devices Object Replication Started at: 13:58:56 28-Sep-2011 ****************************************************************** ------------------------------------Processing RPL1: ------------------------------------Master Device = 3000.DEV3000 Slave Devices: 3200.DEV3200 Updating replicated objects on RPL1: put/create *.AG1: 3200.AG1 - OK put/create *.AG2: 3200.AG2 - OK put/create *.AG3: 3200.AG3 - OK put/create *.CU1: 3200.CU1 - OK put/create *.CU2: 3200.CU2 - OK put/create *.CU3: 3200.CU3 - OK put/create *.CU4: 3200.CU4 - OK put/create *.CU5: 3200.CU5 - OK put/create *.CU6: 3200.CU6 - OK put/create *.CU7: 3200.CU7 - OK put/create *.CAL1: 3200.CAL1 - OK put/create *.DG1: 3200.DG1 - OK put/create *.SCH1: 3200.SCH1 - OK put/create *.SCH2: 3200.SCH2 - OK put/create *.SCH3:
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–623
10–624
Software Objects Reference Version 3.40 BACnet 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 ******************************************************************
Object Replication Update Failure When the Reload Replicated Objects command is unsuccessful, a notification is displayed and a typical log file contains information similar to: ****************************************************************** Delta Controls, Object Replication Log File Replicating to ALL devices Object Replication Started at: 14:02:56 28-Sep-2011 ****************************************************************** ------------------------------------Processing RPL1: ------------------------------------Master Device = 3000.DEV3000 Slave Devices: 3200.DEV3200 Updating replicated objects on RPL1: put/create *.AG1: *** 3200.AG1 - failed to PUT/CREATE object *** Device 3200 not responding *** >> object replication suspended for device 3200 (14:03:43 28Sep-2011). put/create *.AG2: put/create *.AG3: put/create *.CU1: put/create *.CU2:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–624
Total Pages in this Section: 812
Object Replication (RPL) MS/TP Slaves
10–625
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 ******************************************************************
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–625
10–626
Software Objects Reference Version 3.40 BACnet
OBJECT RESTRICTION SETTINGS (ORS) [NEW 3.40] The Object Restriction Settings (ORS) object provides controller-based security that restricts access to individual database objects. Objects can be made public (visible) or private (hidden). Object Security provides an authorization mechanism but does not include requestor authentication. The approach is similar to the proposed BACnet Network Access Control Object and is designed to fit within the existing Delta security schemes and objects. 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 Login
The controller temporarily enters the login state where access is based on a specific ORS, instead of ORS1. This state will remain for the amount of time specified in the request.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–626
Total Pages in this Section: 812
Object Restriction Settings (ORS) [New 3.40] Theory of Operation
10–627
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.
Total Pages in this Section: 812
1
The first phase checks if Object Security is enabled by checking for Locked or Unlocked status.
2
If Object Security is enabled, the controller then determines which ORS object to use.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–627
10–628
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–628
Total Pages in this Section: 812
Object Restriction Settings (ORS) [New 3.40] Navigator Object Security Lock/Unlock Mechanism
10–629
Navigator Object Security Lock/Unlock Mechanism With a controller selected in the left pane of Navigator, right click to open the command menu. Selecting the Object Security option provides the Unlock, Lock, and Temporary Login command options. 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
Total Pages in this Section: 812
In the Lock state, the controller restricts access to the controller based on the rules specified in ORS1 (instance
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–629
10–630
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–630
Total Pages in this Section: 812
Object Restriction Settings (ORS) [New 3.40] Description
10–631
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–631
10–632
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–632
Total Pages in this Section: 812
Object Restriction Settings (ORS) [New 3.40] Setup
10–633
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–633
10–634
Software Objects Reference Version 3.40 BACnet
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.
Dataview: Objects Column The Objects column of the Dataview accepts individual objects or ranges of an object type. A minus sign (–) is used to indicate a range of objects and an asterisk (*) is used as a wildcard symbol. The whitespace around the minus sign in a rule entry is optional, and the interpreted information is always displayed in short form format. The Objects Column accepts an entry that contains the StartID, EndID, PropertyID, and ArrayIndex parts of the Object Security List.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–634
Total Pages in this Section: 812
Object Restriction Settings (ORS) [New 3.40] Object Exceptions
10–635
Examples are shown in the following table: Object Column Entry
Explanation
Example
StartId
This is the BACnet ID of the first instance of the object type to which the Access rule applies. The BACnet ID contains both the instance number and the object type.
AV1
EndId
This is the BACnet ID of the last instance of the object type to which the Access rule applies. The object type in the ID is ignored, but should be the same object type as StartId.
AV5
PropertyID
This is the BACnet property ID of the property that the access rule applies to. Internally, the DAC stores this in its internal property ID, but externally, this is transmitted as in BACnet space.
.Description
If PropertyID is NULL_PROPERTY (0xfffe) or 0, then the access rule will apply to all properties for the specified objects, by StartId and EndId. This field provides the means to uniquely identify the property to be modified. NULL, 0-65535 ArrayIndex
This is the array index of the element that the Access rule applies to. If the property is not an array, this is ignored. If the property is an array and the array index is set to FULL_ARRAY (-1) then the Access rules applies to all elements of the array.
.StateText[1]
This field indicates the array index of the element of the referenced property to be modified. NULL, 0-65535
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–635
10–636
Software Objects Reference Version 3.40 BACnet The interpreted information is displayed in a cell in the Objects column. The following table shows how an object column entry is interpreted and parsed for display in short format. Object Column Entry
Meaning
Displayed
AV1
AV instance 1, default property (Value in this case)
AV1
AV1.Value
AV1, Value property
AV1
AV1.*
AV1, any property
AV1.*
AV1–5
AV instance 1-5, default property
AV1-5.*
AV1 – AV5
AV instance 1-5, default property
AV1-5.*
AV1–5.Value
Value of AV instance 1-5
AV1-5
AV1.Value – AV5.Value
Value of AV instance 1-5
AV1-5
AV*.Description
Any AV's Description
AV*.Description
*.*
Any object, any property
*.*
MV*.StateText[1]
An array index may be specified with the property if the property is an array or list.
MV*.StateText[1]
Comment
If no array index is given, the reference applies to the entire array or list.
Dataview: Object Permissions Column This field defines the permission levels for an entry. To edit the permissions, double click on a selected entry and use the Edit Bitlist submenu.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–636
Total Pages in this Section: 812
Object Restriction Settings (ORS) [New 3.40] Object Exceptions
10–637
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 Level
Function
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–637
10–638
Software Objects Reference Version 3.40 BACnet
Example: Using Rules to Get Intended Function The Objects column can have scope with wildcards etc. and the Permissions column can allow everything or assign just Visible which is more restrictive (less Permissions). 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: Objects
Permissions Checked
AO1.*
Read, Write, Create, Delete, Visible
AV2-4194303.*
Read, Write, Create, Delete, Visible
*.*
Read/Visible
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–638
Total Pages in this Section: 812
Optimum Start (OS) Common Header
10–639
OPTIMUM START (OS) The Optimum Start object starts equipment before its Schedule object comes on, so that the space can be brought to the desired temperature prior to occupancy. The Optimum Start Object (OS) is a programmable object that: •
Calculates the warm-up or cool-down time, based on both past performance and changes in the Outdoor Air Temperature.
•
Determines the optimum time to start heating and cooling equipment.
Typically, an OS object is used for a fan system that does not run over night. The OS automatically determines the best time to start the equipment in the morning in order to achieve the desired temperature when the scheduled occupancy begins. 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. Off The OS Object is inactive.
Object Mode Auto The Object Value is automatically set based on the preset conditions.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–639
10–640
Software Objects Reference Version 3.40 BACnet 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: Status
Value
Schedule
Start Type
Heating Start
ON
OFF
Heating
Cooling Start
ON
OFF
Cooling
Achieved
ON
OFF
Off
OFF
Comment
Target temperature reached.
Fault
Fault has occurred.
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. The value can be entered in one of two ways. •
Fill in an object reference for the Target Temperature. This would typically be an Analog Variable (AV) which stores the space temperature setpoint.
•
Fill in the Target Temperature with a fixed value.
Time Remaining Time remaining before scheduled occupancy.
Schedule The current status of the Schedule will be displayed.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–640
Total Pages in this Section: 812
Optimum Start (OS) Description
10–641
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–641
10–642
Software Objects Reference Version 3.40 BACnet Heating Start Turns heating equipment on early so that the Indoor Temperature is raised to the Target Temperature just prior to the first occupancy time listed in the Object’s Schedule field. Cooling Start Turns cooling equipment on early so that the Indoor Temperature is lowered to the Target Temperature just prior to the first occupancy time listed in the Object’s Schedule field. 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. Enter the Target Temperature in one of two ways: •
Leave the left hand field blank. Type a numerical value in the right hand field.
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 readonly.
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 righthand field.
Example GYM_ROOM_TEMP
65.9
If the Indoor Temperature is not specified, the OS object will be in a Fault state.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–642
Total Pages in this Section: 812
Optimum Start (OS) Setup
10–643
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.
Max Start Time (Hrs.) The Maximum Start Time determines the maximum amount of warm-up or cooling time that can occur. This field defaults to 2 hours and the spin box has a range of 1 to 100. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–643
10–644
Software Objects Reference Version 3.40 BACnet 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. Max Start Time
Hours
normally left blank
2.5
When choosing a value for Maximum Start Time, consider the building thermal mass and equipment capacity. For example, a building with a large thermal mass and equipment of limited capacity takes longer to warm up.
Optional Parameters There are three optional parameters. •
Outdoor Temperature
•
Outdoor Influence
•
Unoccupied Influence
Outdoor Temperature The first parameter (Outdoor Temperature) adjusts the Start Time based on the difference between today’s Outdoor Temperature and yesterday’s. Outdoor Temperature is an object reference to the outdoor air temperature. This would typically be an Analog Input (AI), but can be another analog object. If this field is left blank, then outdoor temperature variances from one day to the next will not affect the warm up time.
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
Outdoor Influence The amount of influence that the difference between today’s Outdoor Temperature and yesterday’s has on the Heat Rate.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–644
Total Pages in this Section: 812
Optimum Start (OS) Setup
10–645
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.
Unoccupied Influence This parameter helps account for building thermal mass. The Unoccupied Influence adds additional warm-up/ precool time if the building has been sitting in an unoccupied time for more than one night. The default for this field is 50%. The unoccupied influence algorithm will calculate up to a maximum of 1 day of unoccupied time. It will not multiply this factor for extra unoccupied time. For example, if the unoccupied influence is set to 50%, the OS will not add more than 50% to the startup time regardless of how long the building has been empty. So a warm-up time of 2 hours would become 3 hours. Building dynamics play a large part in selecting an appropriate value for this field, but 50% should be a reasonable starting point. This parameter determines the amount of influence an unoccupied period has on the optimal start time calculations. An unoccupied influence is defined as a 24hour period in which the Schedule Reference has not been ON. Units are percent. A value of zero means the Unoccupied Influence is not used in the OS calculations.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–645
10–646
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–646
Total Pages in this Section: 812
Optimum Start (OS) History
10–647
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. At the end of the Optimum Start period: 5
The Rate of the Second Last Day is rolled back to the Third Last Day.
6
The Rate of the Last Day is rolled back to the Second Last Day.
7
A new Rate is calculated for the now empty Last Day.
8
The 3 Rates are averaged and stored.
This new Heat/Cool Rate Value is used to predict the following day’s Optimal Start/Stop period. These fields remain fixed if the previous day was a weekend or a holiday.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–647
10–648
Software Objects Reference Version 3.40 BACnet 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.
Optimum Start Calculation The Optimum Start (OS) object calculates the optimal start time so that a heating / cooling system can reach a scheduled target temperature in a cost-effective way. The OS object calculates optimal start time based on temperature and a time schedule and uses safeguards such as a maximum start time and temperature deadband to ensure proper start times. Outdoor Air Temperature or Heating/ Cooling Off Time factors can optionally influence the start time. The object uses a 3 day history to determine an average temperature change per hour. The Optimum Start time is calculated as follows: Parameter
Description
Optimum Start Time (OST)
OST = Schedule On Time – (Indoor Time + Unoccupied Influence Effect (UIE))
Optimum Start Time (OST)
When the History Tab has no data in it, the Optimum Start Time is calculated by:
(History Tab has no data) Indoor Time (IT)
OST = Schedule On Time – Max Start Time
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) If Cooling Start then IT = Limit((Indoor Temperature - Target Temperature) / Effective_Heat_Rate, 0, 24) The Limit function restricts the value of an expression to within specified low (0) and high (24) limits.
Outdoor Air Influence Effect
When the History Tab has data in it, the Outdoor Air Influence Effect is calculated by: If Heating Start then Effective_Heat_Rate = Historical_Heat_Rate + Outdoor_Influence * (Outdoor_Temperature_Today - Historical_Average_Outdoor_Temperature) If Cooling Start then Effective_Heat_Rate = Historical_Heat_Rate - Outdoor_Influence * (Outdoor_Temperature_Today - Historical_Average_Outdoor_Temperature)
Unoccupied Influence Effect (UIE)
For Heating or Cooling starts, with data in the History Tab, the Unoccupied Influence Effect is calculated by:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–648
Total Pages in this Section: 812
Optimum Start (OS) Optimum Start Calculation Parameter
10–649
Description UIE = Unoccupied Influence / 100 * Indoor Time
Heat Or Cool Rate: (Degrees / Hours )
Temperature Change = ( IAT @ [ Status = “On” ] ) – ( IAT @ [ Status = Achieved OR Off ] )
Heat Or Cool Rate: (Degrees / Hours )
Period of Change = ( Time @ [ Status = “On” ] ) – ( Time @ [ Status = Achieved OR Off ] )
Heat Or Cool Rate: (Degrees / Hours )
Rate = Temperature Change / Period of Change
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. All the results in the calculation are in hours (hr).
No Entries in the History Tab The OS Object turns ON when the Device time = Schedule ON time – Max Start Time and turns OFF when either the Target Temperature is met or the Schedule turns ON.
One entry in the History Tab The OS Object calculates the Indoor Time using the Rate in the History Tab and adds on the effect of the Outdoor Influence and the Unoccupied Influence. The OS will turn ON when the Device Time = Schedule ON time – Calculated time. This time is limited to the Max Start Time. The OS will turn OFF when the Target Temperature is met or the Schedule turns ON.
Two entries in the History Tab The OS Object calculates the Indoor Time using the Average Rate of the 2 previous entries in the History Tab and adds on the effect of the Outdoor Influence and the Unoccupied Influence. The OS will turn ON when the Device Time = Schedule ON time – Calculated time. This time is limited to the Max Start Time. The OS will turn OFF when the Target Temperature is met or the Schedule turns ON.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–649
10–650
Software Objects Reference Version 3.40 BACnet
PRIORITY NAMES (PAN) 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.
Priority Level 1 to Priority Level 16 These fields are where you enter the name you would like for each priority level. The default values for Priority Levels 1 to 16 are shown below.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–650
Total Pages in this Section: 812
Priority Names (PAN) Example
10–651
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–651
10–652
Software Objects Reference Version 3.40 BACnet
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. See Chapter 11 – General Control Language (GCL+) for more information. The PG Object has several features that make it easy to manipulate the database.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–652
Total Pages in this Section: 812
Program (PG) Name Controller
Max PG Size in 3.40 (bytes)
Recommended Max PG Size (bytes)
DAC 4Mb
5500 (DACs pre-2005)
4500
DAC 8Mb
10000 (DACs post-2005)
9000
DAC-E 16Mb
10000
9000
DSC 8Mb
10000 (DSCs pre-2005)
9000
DSC 16Mb
10000 (DSCs post-2005)
9000
DCU
23700
22700
OWS
N/A (PGs not normally created in the OWS)
N/A
eBCON
10000
9000
10–653
Refer to KBA 1579: SRAM & Flash Size Of DSC/DAC Depends On Hardware Version for information about specific hardware revisions. 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. The PG is designed NOT to write to commandable objects (i.e. those with a priority array) at the following priority levels: 1 - Manual Life Safety 6 - Minimum On/Off 8 - Manual Operator
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–653
10–654
Software Objects Reference Version 3.40 BACnet So a PG's write priority cannot be changed to any of these values.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–654
Total Pages in this Section: 812
Pulse Input (PI) Header
10–655
PULSE INPUT (PI) The Pulse Input (PI) object works with the DFM-400P or DBB060 boards. The object can be set to measure the number of pulses per second, per minute, per hour, or per day. Both the Instantaneous and Average pulse rates are calculated. In addition, a conversion factor and conversion units can be entered. When a conversion factor is entered, it is applied to the Instantaneous pulse rate, and the Converted Pulse Rate is calculated. The peak Average and Instantaneous Pulse rates are recorded, along with the date and time of their occurrence. The total number of pulses is also recorded. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–655
10–656
Software Objects Reference Version 3.40 BACnet
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.
Description (not available on DFM-400P) 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–656
Total Pages in this Section: 812
Pulse Input (PI) Description (not available on DFM-400P)
Total Pages in this Section: 812
10–657
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–657
10–658
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–658
Total Pages in this Section: 812
Pulse Input (PI) Setup
10–659
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.
HVAC, Access, and Lighting Checkboxes These checkboxes are not available on the DFM-400P. These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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)
Pulse Rate Units These are the Units assigned to the incoming pulses in order to calculate the Instantaneous Pulse rate. The selections are seconds, minutes, hours, or days. If hours are selected then the number of pulses received during the sample interval will be calculated as number of pulses per hour.
Pulse Duration (not apply DFM-400P) This is the duration of the expected pulse in milliseconds. The default value is set at 100 milliseconds (1/10th of a second). This field ensures that transients caused by switch bounce are not counted as pulses.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–659
10–660
Software Objects Reference Version 3.40 BACnet 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.
COV Minimum Increment Specifies the minimum amount of change in Present Value required to cause a Change_Of_Value notification event. This property is used for the purpose of trending. For more information on Trending read the Trending chapter of the Manual.
Advanced
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–660
Total Pages in this Section: 812
Pulse Input (PI) Advanced
10–661
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 decommissioned, 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. De-Commissioned When this box is not checked the Object is DeCommissioned and the Lock Icon is in the Header and in the display in Navigator.
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: No Fault Detected – This is the normal state for the input. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–661
10–662
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–662
Total Pages in this Section: 812
Pulse Input (PI) Navigator Status Values
10–663
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.
Navigator Status Values The Status field in Navigator is normally blank indicating that the PI object is working properly with NO FAULT DETECTED. It can also have the following Status values: •
FAULT – Displayed if the value of the object’s Reliability property is a value other than ‘NO FAULT DETECTED' (i.e. if the Physical input is not present).
•
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+.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–663
10–664
Software Objects Reference Version 3.40 BACnet
REGIONAL SETTINGS (RS) The Regional Setting (RS) object contains a list of cities with predefined longitude, latitude, Universal Time coordinates (UTC) offset, and Daylight Savings Time (DST) information. 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. The RS object is creatable on a 16Mbit DAC/DSC controller.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–664
Total Pages in this Section: 812
Regional settings (RS) City
10–665
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–665
10–666
Software Objects Reference Version 3.40 BACnet
UTC Offset (Universal Time Co-ordinated) This field indicates the offset in minutes (-780 to 780) between local standard time and Universal Time Coordinated (formerly Greenwich Mean Time). To use the UTC feature you must check UTC Enable and enter the UTC Offset for the location of the Device. UTC is used in several controller applications: European Daylight Savings Time – see DST STANDARD which follows for more information. Sunrise/Sunset Algorithm – please reference the GCL+ chapter of the manual for more information. Set Panel Time – please reference Chapter 3 – Navigator of the ORCAview Technical Reference manual 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. Here is a description of the DST Standards: NORTH AMERICA: •
Start – Second Sunday in March
•
End – First Sunday of November
•
Effective Hour – 2 AM
•
Offset – 60 Minutes
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–666
Total Pages in this Section: 812
Regional settings (RS) City
10–667
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: •
Total Pages in this Section: 812
No set defaults. User can enter any option that they want.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–667
10–668
Software Objects Reference Version 3.40 BACnet
REMOTE PANEL SETTINGS (RPS) The Remote Panel Settings (RPS) allows a modem connection to be established between a controller and the OWS. The connection can be initiated on the controller side for alarm dial out or it can be initiated from the OWS side to dial into the controller network. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–668
Total Pages in this Section: 812
Remote Panel Settings (RPS) Main
10–669
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–669
10–670
Software Objects Reference Version 3.40 BACnet
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 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 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–670
Total Pages in this Section: 812
Remote Panel Settings (RPS) Setup
10–671
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.
Baud Rate needs to be adjusted here.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–671
10–672
Software Objects Reference Version 3.40 BACnet
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. Users can create reports on command or generate them automatically by using a preset schedule or a triggered event. With this built-in RPT feature, six types of standard reports are created: Query, Tenant Billing, Access Configuration, Access, Controller Configuration, and Controller reports. RPTs can be viewed from the Reports folder in the Navigator Window. The purpose of this section of the Technical Reference Manual is to provide details on the RPT object and all the tabs and fields it contains. For information on how to use the RPT object, refer to Chapter 6: Trending, Archiving and Reporting.
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.
Report Type Menu The Report Type drop-down menu provides the following options: Query Generates a report listing the objects, based on user-defined criteria. For example:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–672
Total Pages in this Section: 812
Reports (rpt) Report Setup
10–673
Entering object filter criteria:
Generates a report listing:
AI.commissioned=false
All the AI objects currently decommissioned.
AI>35
All the AI objects with a value greater than 35.
Tenant Billing Generates an automatic bill to the tenant clients on a schedule determined by the building owner. These reports are usually sent to tenants, on a monthly basis, charging for the energy or resources consumed during a specific billing period. Access Configuration Generates reports which summarize information from Access Control objects within the system. Access Reports Generates reports based on the information from CEL (Compact Event Log) object. List all card users who are in the building at specified time. It is designed for building managers to know who is in and who is out and at what time. Controller Configuration Extract two report styles from former Access Configuration report list: •
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–673
10–674
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–674
Total Pages in this Section: 812
Reports (rpt) Query Setup
10–675
Note: If there is no applicable device for the drop-down menu, that specific dropdown 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
Version 2 Selecting the Version 2 checkbox, allows for address(es) which are applied to the Delta Controls V2 device network.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–675
10–676
Software Objects Reference Version 3.40 BACnet
Object Filter Examples To filter by object name:
Returns all objects:
AHU
with names containing AHU
Temp*
starting with the name Temp
*valve
ending with the name valve
To filter by object type:
Returns all:
ai
ai’s
bi
bi’s
To filter by object type and instance:
Returns:
av1, av2
av1 and av2
av(1,3,5)
av1, av3, and av5
av(1-7)
av’s 1 through 7
To filter by property value:
Returns all:
ai.Calibration > 0
ai’s with a Calibration > 0
av > 70 (or av.Value>70)
av’s with a Value > 70
Temp > 23
objects with names containing Temp and Value > 23
To filter by object type and common property:
Returns:
(ai(1-7), av, ao).ManualOverride = TRUE
ai1 - ai7, all av’s, and all ao’s that are in manual mode
To filter by multiple property values:
Returns:
ai.(Value > 23 or Value < 10)
ai’s with Value < 10 or > 23
(ai, ao).(ManualOverride = TRUE and Value > 50)
ai’s and ao’s that are in manual mode and have a Value > 50
To filter by multiple values:
Returns:
ai > 6, bv = "Fan On"
ai’s with a Value > 6, and bv’s with Value = "Fan On"
Report Format The Report Format section is used to configure how each column of the report information is displayed.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–676
Total Pages in this Section: 812
Reports (rpt) Query Setup
10–677
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. Left Aligned
Centered
Right Aligned
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. Group By Device The Group By Device checkbox groups objects by device. The sorting is defined by the column header and applied to each device group. When the checkbox is cleared, the objects are displayed in one long list. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–677
10–678
Software Objects Reference Version 3.40 BACnet •
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.
Tenant Billing Setup The following section describes all the fields and dialogs in the Setup tab when Tenant Billing Reports are selected from the Report Type drop-down menu.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–678
Total Pages in this Section: 812
Reports (rpt) Tenant Billing Setup
10–679
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: Description Displays the name of the monitored object. Trend Log Displays the object name and the TL reference. 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.
Up and Down Arrows The Up and Down arrows are used to arrange the order of the TL entries in the Dataview. This, in turn, arranges the order of the Transaction Details section of the report. The Transaction details are viewed by clicking the Preview button on the lower left corner of the Setup dialog.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–679
10–680
Software Objects Reference Version 3.40 BACnet
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.
Device The Device drop-down menu displays only V2 or V3 devices, panels, and workstations with TLs. The devices are separated by group (V2 or V3) and are sorted by DNA addresses. 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). Description Displays the name of the monitored object. It is used to change the text to better describe the transaction information which appears in the Tenant Billing Report. Rate ($/hr) This field is used to set the hourly rate for the TL. Temporary Adjustment This field is used to make temporary adjustments to the overall cost for a specific transaction. This value is only temporary; it is not saved when the RPT dialog is closed. This field accepts both positive and negative values.
Remove Button The Remove button deletes any highlighted entry from the Trend Log Dataview.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–680
Total Pages in this Section: 812
Reports (rpt) Access Configuration Setup
10–681
Calculation Settings Field These fields are used to calculate how a tenant is billed by the company. The Calculation Settings field provides users with options for the following: 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: •
If the Minimum Charge interval is 120 minutes, and the TL shows ON:07:30AM and OFF:08:45AM, the minimum time a customer is charged is 120 minutes.
Roundup to nearest The Roundup to nearest drop-down menu sets the roundup amount for any specific transaction. The drop-down menu has options of 0, 5, 10, 15, 30, or 60 minutes, or enter a value of 0 - 6000. These amounts also appear in the Tenant Billing Report. For example: •
If the roundup interval is 60 minutes, and the TL shows ON:07:30AM and OFF:08:45AM, the minimum time a customer is charged is 120 minutes.
Tax The tax field is used to enter the applicable tax percentage that needs to be calculated on the tenant bill. This field only accepts positive numbers.
Company Info and Billing Info These two sections are used to enter the appropriate company name and address, the customer’s name and address, as well as any other necessary billing information.
Access Configuration Setup The following section describes all the fields and dialogs in the Setup tab when Access Configuration Reports are selected from the Report Type drop-down menu.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–681
10–682
Software Objects Reference Version 3.40 BACnet
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. When Access Configuration is selected, a second drop-down menu displays the report templates for specific Access Control objects. The following list provides a brief description of each of the templates.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–682
Total Pages in this Section: 812
Reports (rpt) Access Configuration Setup Report Type
10–683
Object Reference
Access Configuration Setup Access Group Configuration
AG
Access Setup Configuration
AS
Card Reader Configuration
CR
Card User Summary by Instance
CU
Card User Summary by Name
CU
Card User Configuration
CU
Card User Configuration Extended
CU
Card User Summary
CU
Card Users By Access Group
CU
Door Controller Configuration
DC
Door Controller Status
DC
Door Group Configuration
DG
Access Reports Setup Event Log Summary
CEL
Event Log Summary by Controller
CEL
User Event Summary
CEL
User Event Summary by Controller
CEL
Who is in
CEL
Controller Configuration Setup Calendar Configuration
CAL
Schedule Configuration
SCH
Controller Reports Setup
Total Pages in this Section: 812
Commissioning Sheets
IP, OP
Points List
IP, OP
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–683
10–684
Software Objects Reference Version 3.40 BACnet
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
Version 2 Selecting the Version 2 checkbox, allows for address(es) which are applied to the Delta Controls V2 device network.
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).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–684
Total Pages in this Section: 812
Reports (rpt) Access Configuration Setup
10–685
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–685
10–686
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–686
Total Pages in this Section: 812
Reports (rpt) Description
10–687
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.
To:
Use
For Example:
Add a date
%d%
Report%d%.pdf = Report20_Jun_2003.pdf
Add the Time
%t%
%d%_Report_%t%.pdf = 20_Jun_2003_Report_11_15_43.pdf
Add an Invoice Number (Tenant Billing)
%i%
HVAC_Overide_Bill_%i%.pdf = HVAC_Overide_Bill_214.pdf
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–687
10–688
Software Objects Reference Version 3.40 BACnet
ROUTING TABLE AND DEVICE TABLE (DRT) The Routing Table and Device Table (DRT) object shows dynamic data structures. The Devices tab shows a list of devices that the controller is currently communicating with. The Routing tab lists addresses that allow packets to be routed from one network to another. The routing and device tables can greatly aid troubleshooting. For example, it can help to track data exchanges with remote devices and also communication with BBMDs.
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). The Dataview has three heading labels:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–688
Total Pages in this Section: 812
Routing Table and Device Table (DRT) Routing
10–689
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:
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–689
10–690
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–690
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Description
10–691
SCHEDULE 3.40 BACNET (SCH) The Schedule object writes its Present Value to the properties of an object, or set of objects, at scheduled times. The Present Value of the Schedule object is set according to the Weekly Schedule as set in the object, or by the Exception Schedule, which takes precedence. If no value is set, the Schedule Default Value is used. A Schedule Value can also be used by GCL programs to determine active or inactive periods. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–691
10–692
Software Objects Reference Version 3.40 BACnet A Schedule can control the following types of objects: •
Binary Object (i.e. On/Off)
•
Multistate Object (i.e. Low, Medium, High)
•
Analog Object (i.e. Setpoint, 72.65)
The type of object that is controlled by the Schedule determines the possible Values that can be assigned to the Schedule. Controlled Object Type
Associated Data Types
Value Definition
Objects Controlled
Binary Object (Enumerated)
Inactive, Active, NULL
Binary entries of either ON or OFF.
BO, BV
Multistate Object (Unsigned32)
NULL, Numeric (value)
Multistate entries in the range of
MO, MV
NULL, Numeric (value)
Unitary entries in the range of
Analog Object (Real) Undefined
1 to + 65534. AO, AV
-65534 to +65534.
Undefined is an unusable SCH state that indicates the Schedule Type is not yet defined and only exists temporarily during creation time.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–692
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Header
10–693
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. In Manual Mode, the Value is assigned manually, regardless of the controller time. If the Schedule is set to control binary objects, only ON/OFF will be available options in a drop down list. To manually set a Schedule Object Value
1.
Open the Schedule Object.
2.
Click on the Hand icon in the Header.
3.
Input the desired Schedule Object Value in the field that becomes available.
4.
Click Apply to save the change.
5.
The Object Value updates to reflect the assigned Value.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–693
10–694
Software Objects Reference Version 3.40 BACnet
Controller Time/ Date The current time and date on the controller hosting the schedule is shown here.
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. The system icons can be selected from the Setup tab. 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. A Lock icon indicates that the Commissioned checkbox of a Controlled Object has not been checked. When the Commissioned checkbox is checked on the Device tab, then the Lock icon is removed from the header and does not display in Navigator.
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. Description The Description tab can be used to write a simple description of what the Schedule is used for.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–694
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Main
10–695
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–695
10–696
Software Objects Reference Version 3.40 BACnet
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.
To scroll the calendar week to week
1
Click the right arrow to advance the calendar by one week.
2
Click the left arrow to go back by one week.
To select a specific date on the calendar
1
Click on the calendar icon next to Show Calendar.
2
The date picker appears.
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 5
Type in a date in the Show Calendar field in mm/dd//year format (i.e. 08/17/2011).
6
Press Enter. The calendar updates to show the Sunday to Saturday week that contains the selected date.
Add Weekly / Exception Schedule It’s easy to add a Weekly or Exception Value to the Schedule. A Weekly Schedule repeats every week, at the same time and day. Exception Schedules can be defined in a more flexible manner, and are ideal for single events, holidays, or events that occur regularly but don’t belong on a Weekly Schedule. Exception Schedules can repeat, such as a specific day per year (i.e. Christmas day), or recurring exceptions (i.e. the second Friday of every month).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–696
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Main
10–697
To create a new Schedule
1
Select the day of the week the Schedule is to occur on.
2
Determine the start time for which this Schedule Value will be active.
3
Click and drag the cursor down from the start time to highlight the required time period. Drag up to cancel the selection. When creating a Schedule that will overlap a previously created one, click and drag on the right edge of the Day column.
4
The Add Weekly/Exception Schedule dialog appears.
Note: Double clicking on a Schedule can also bring up this dialog.
To create a Weekly Schedule
Days of the Week
Start and End Time
1
Click the Weekly Schedule tab.
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.
A Weekly Schedule can occur on a single day of the week, or multiple days, or on all weekdays. Use the checkboxes to select the desired days. The Start and End Time are written in 24-hours format. While the input time on the calendar is rounded to the half-hour, the time input in the Start and End Time field can be accurate down to the minute. Note: For more detailed information about Weekly and Exception Schedules, see Weekly/Exception Schedules.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–697
10–698
Software Objects Reference Version 3.40 BACnet To add an Exception Schedule
Exception Types
1
Select the Exception Type from the drop-down list. Depending on the type selected, different fields will appear.
2
Select the applicable date(s).
3
Verify the Priority, Start Time, End Time, and Value.
4
Write a brief description for this Exception Schedule.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–698
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Main
10–699
Calendar Creates an Exception Schedule that is linked to a created Calendar Objects on the same controller. To edit a Weekly or Exception Schedule
1
Click and drag to move or resize the Schedule on the Main tab.
Or 2
Double click the Schedule on the calendar.
3
Depending on the type of Schedule created, different dialogs can appear. Edit as needed.
4
Click Apply to save changes. Click Ok to close the dialog.
For more information on the Advanced button, see Modify Schedule.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–699
10–700
Software Objects Reference Version 3.40 BACnet
Weekly / Exception Schedules Schedules can be either Weekly or Exception Schedules. Depending on the Schedule selected, the Add Schedule or Modify Schedule dialogs will display different options.
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.
Monday to Sunday and Weekdays Checkboxes
Check the boxes for the day, or multiple days, that the weekly schedule applies. Checking Weekdays will automatically check the boxes for Monday-Friday.
Start Time
End Time
Value
This field displays the time when the Schedule Object will set the Present Value to the set value. Adjust the time by clicking on the up or down arrows next to the field, or by typing in the desired time (from 00:00 – 24:00). By default, clicking on the arrows will adjust the hours column. Click on the minutes before clicking on the arrows to adjust the minutes column. This field displays the end time when the Schedule Object return the Present Value to the Default Value. Adjust this field by clicking up or down arrows, or type the time in manually. Identify the desired value that will be set as the Present Value (Schedule Value) during the identified time. If a binary value is selected, the only options available are On or Off. Analog or multistate values can be no more than 65534 (+/- for analog).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–700
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Weekly / Exception Schedules
10–701
Exception Schedule – Single Date Exception Schedules are used for unique or infrequently occurring events. The Single Date Exception is used for one day occurrences which do not repeat.
Date (Year, Month, Day, Day of Week)
The day for which this Exception Schedule is active is shown here. Click on the date to type in the desired date in mm/dd/year format, or click on the calendar icon to select a date from the date picker.
Priority
Start Time
End Time
Value
Description
Total Pages in this Section: 812
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. This field displays the time when the Schedule Object will set the Present Value to the set value. This field displays the time when the Schedule Object will set the Present Value to the default value. Identify the desired value that will be set as the Present Value (Schedule Value) during the identified time. Give the Exception Schedule a description to explain why it was created. Since Exception Schedules occur infrequently, it is easy to forget why they were created weeks or months later. The description is displayed in the Schedule listing, as well as when the cursor held over the listing on the Main Tab.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–701
10–702
Software Objects Reference Version 3.40 BACnet
Exception Schedule – Date Range The Date Range Exception is a single occurring event that spans the same time period over multiple days.
Start Date (Year, Month, Day, Day of Week)
The date this Exception Schedule takes effect is displayed here. Dates can be typed in manually, or selected from the date picker.
End Date (Year, Month, Day, Day of Week)
The date this Exception Schedule ends is displayed here. Dates can be typed in manually, or selected from the date picker.
Priority
Start Time
End Time
Value
Description
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. This field displays the time when the Schedule Object will set the Present Value to the set value. This field displays the time when the Schedule Object will set the Present Value to the default value. Identify the desired value that will be set as the Present Value (Schedule Value) during the identified time. Give the Exception Schedule a description to explain why it was created.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–702
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Weekly / Exception Schedules
10–703
Exception Schedule –Recurring Week & Day The Recurring Week & Day Exception is a Schedule that occurs on a recurring day or week of a specific month(s). This can include the third week of September, or the second Sunday of every month, for example.
Month
Week
Day
Priority
Start Time
End Time
Total Pages in this Section: 812
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). 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)). Select the day of the (selected) week when this Schedule is active. Choose between a specific day, or every day of the week. 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. This field displays the time when the Schedule Object will set the Present Value to the set value. This field displays the time when the Schedule Object will set the Present Value to the default value.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–703
10–704
Software Objects Reference Version 3.40 BACnet
Value
Description
Identify the desired value that will be set as the Present Value (Schedule Value) during the identified time. Give the Exception Schedule a description to explain why it was created.
Exception Schedule - Recurring Date
Date (Year, Month, Date, Day of Week)
Select the specified date this Exception Schedule will apply to.
•
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–704
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Weekly / Exception Schedules Start Time
10–705
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.
Exception Schedule – Calendar A Calendar Exception defines 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. This provides the operator with a convenient method of overriding the normal weekly schedule of the Schedule Object. A Calendar Exception must be linked to a corresponding Calendar Object created on the same controller. Make sure to create the Calendar Object first, or the Exception Schedule will not be created.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–705
10–706
Software Objects Reference Version 3.40 BACnet
Calendar Instance
Priority
Start Time
End Time
Value
Description
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.
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. This field displays the time when the Schedule Object will set the Present Value to the set value. This field displays the time when the Schedule Object will set the Present Value to the default value. Identify the desired value that will be set as the Present Value (Schedule Value) during the identified time. Give the Exception Schedule a description to explain why it was created.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–706
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Weekly / Exception Schedules
10–707
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.
Total Pages in this Section: 812
•
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–707
10–708
Software Objects Reference Version 3.40 BACnet
Setup
Name
Reliability
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. 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. In Manual Mode, the Reliability field can be changed manually as well.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–708
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Setup
10–709
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
Reliability Status
Explanation
No Fault Detected
No problem has been detected with the Schedule object.
Configuration Error
The object's properties are not in a consistent state. To be consistent, all non-null values in the Monday to Sunday Weekly Schedule tabs, the Exception tab, and the Schedule Default field must be of the same data type and all the object properties listed in the Controlled Objects list must be capable of accepting values of this particular data type. For example, this error will occur if both binary and analog values are present in a single Schedule Object Controlled Object List.
Other Fault
This indicates that the present value is unreliable. A generic fault has been detected.
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. It is possible to provide seasonal scheduling by creating several Schedule objects to control the same property references and define the Effective Periods so that they do not overlap.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–709
10–710
Software Objects Reference Version 3.40 BACnet
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. To add an Object to the list
1
Double click on an empty line in the Controlled Objects field.
2
Type the name of the object in. If it is located on the same controller, only the Object code is required (i.e. BO1). Include the controller number if it is located on a remote controller (i.e. 600.BO2).
3
The Object will be identified on the list by its name.
If the Object name is unknown
1
Right click on an empty line in the Controlled Objects field.
2
Click Find Object.
3
Use the Find Object dialog to locate the correct Object. The Name tab can be used if the exact Object name is known. Or search from the Object ID tab by clicking on the Panel drop-down list and selecting the controller on which the object is located.
4
Click Find and a list of matching Objects is displayed.
5
Identify the correct Object, and make not of the name.
To remove an Object from the list
1
Click on the Object name on the list.
2
With the Object name highlighted, press Delete on the keyboard.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is related to. Any combination of the HVAC, Access, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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:
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–710
Total Pages in this Section: 812
Schedule 3.40 BACnet (SCH) Details
10–711
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
Exceptions
The Details section displays the next Schedule that will be occurring, and the previous Schedule that most recently passed. The Exception field displays the total number of exceptions on a Schedule. The upper limit is 100.
Auto Delete Expired Entries After
The Auto Delete Expired Entries After field defines the interval before expired exceptions are removed from a SCH. The default is 4 weeks. Exceptions are deleted at midnight of the following day. Recurring exceptions are not deleted. This is a DAC/DSC/ Tetra feature.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–711
10–712
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–712
Total Pages in this Section: 812
Slave Device List (SDL) Description
10–713
SLAVE DEVICE LIST (SDL) The Slave Device List (SDL) object provides the information required for Delta products to communicate with MS/TP slave devices. The contents of the Slave Device List object should be copied to each Delta device that needs to know about the slaves. The contents of the Slave Device List are shown on the MS/TP Slaves tab in the Network Protocol Settings (NET) or BACnet Protocol Settings (BCP) object for the device. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–713
10–714
Software Objects Reference Version 3.40 BACnet
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.
Max APDU Size This field specifies the largest size of an Application Protocol Data Unit this controller can receive. The range of the value is 50 to 480 bytes. This value is dependent on the implementation of the slave device. Refer to the slave device’s documentation to determine what value to use.
Segmentation Refer to the slave device’s documentation to determine what level of segmentation the device supports, if any.
Segmented The device is able to send and receive segmented messages. Segmented Send The device is able to send segmented messages. Segmented Receive The device is able to receive segmented messages. No Segmentation The device can neither send nor receive segmented messages.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–714
Total Pages in this Section: 812
Slave Device List (SDL) MS/TP Slaves
10–715
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: •
MS/TP (1 byte): a decimal number in the range 0-254 (e.g., NET50,71);
•
Ethernet (6 bytes): 12 hexadecimal digits (e.g., NET50,357A8042FF00);
•
IP address in 3.33: (6 bytes, formatted as xxxx:ddd.ddd.ddd.ddd) 4 hexadecimal digits, representing the port, followed by a colon (:) followed by 4 decimal values in the range 0-255 separated by periods (.) (e.g., NET50,BAC3:128.67.255.0); (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.
•
2-byte LonTalk: 2 decimal numbers in the range 0-255 separated by a comma (e.g., NET50,128,91);
•
7-byte LonTalk and all other formats: An even number of hexadecimal digits (e.g., NET50,68D51A28E443F3).
If an odd number of digits are entered for a hexadecimal value, then the last digit will be ignored.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–715
10–716
Software Objects Reference Version 3.40 BACnet Note: A MAC address that is entered in the IP or Ethernet formats will be
formatted in the IP format if the first 3 hexadecimal digits are BAC; otherwise, it will be formatted in the Ethernet format. (E.g., if NET50,BAC38042FF00 is entered, it will be formatted as NET50,BAC3:128.67.255.0; and if NET50,357A:128.67.255.0 is entered, it will be formatted as NET50,357A8042FF00.).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–716
Total Pages in this Section: 812
Structured View (SV) [New 3.40] Description
10–717
STRUCTURED VIEW (SV) [NEW 3.40] The Structured View object organizes objects in an application or structural manner. This contrasts with the flat list of objects presented in the Device (DEV) object. This object creates multilevel hierarchies that contain references to subordinate objects or other Structured View objects. The objects can be organized in ways that convey a structure. Subordinate objects may be on the same controller as the SV object or in a remote controller on the network. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–717
10–718
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–718
Total Pages in this Section: 812
Structured View (SV) [New 3.40] Setup Node Type
10–719
Interpretation
Area
A geographical concept such as a campus, building, floor, etc.
Collection
A container used to group things together. For example, all the space temperatures in a building could be a collection.
Device
A set of elements that represents a BACnet device, a logical device, or a physical device.
Equipment
A single piece of equipment that may be a collection of objects or points.
Functional
A single system component such as a control module or a logical component such as a function block.
Network
A communications network.
Organization
A business concept such as a department or group of people.
Other
Anything that does not fit in the available categories.
Point
A set of elements that defines a single point of information. This point of data could be a physical input or output of a control or monitoring device, a software calculation, or a configuration setting.
Property
A definition of a characteristic or parameter of the parent node.
System
An entire mechanical system.
Unknown
A value for a Node type is not available or has not yet been configured.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–719
10–720
Software Objects Reference Version 3.40 BACnet
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
Annotations
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. This field contains an optional text string description for each member of the Subordinates list.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–720
Total Pages in this Section: 812
System Display (SD) V3 Header
10–721
SYSTEM DISPLAY (SD) V3 A System Display (SD) object dynamically displays objects of related information on a single screen. The SD has a list of objects that are grouped in some logical way. The list includes the object reference, names, values and flags. For example, a System Display may list objects related to a particular Air Handler Unit. It would include input /output objects and setup variables.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–721
10–722
Software Objects Reference Version 3.40 BACnet
Object List Dataview This Dataview allows the configuration of the SD object by defining the Object Ref, Value, Units, Flags and Descriptor fields for an entry.
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. The valid objects are: Analog Input
Binary Input
Calendar
Multi-state Variable
Analog Output
Binary Output
Control Loop
Schedule
Analog Totalizer
Binary Totalizer
Lighting Group
Trend Log
Analog Variable
Binary Variable
Multi-state Input
Value Displays the Object Value of each listed object.
Units Displays the Object Units of each listed object.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–722
Total Pages in this Section: 812
System Display (SD) V3 Object List Dataview
10–723
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–723
10–724
Software Objects Reference Version 3.40 BACnet
SYSTEM USER ACCESS (SUA) The System User Access (SUA) is used to determine Network Security, Local Machine Security, and Object Security. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–724
Total Pages in this Section: 812
System User Access (SUA) Common Header
10–725
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. The five states for the SUA are: •
Logged In
•
Logged Out
•
Disabled
•
Security Locked
•
Inactive
Logged In The Logged In SUA Status indicates that a user has passed all system security checks. If the SUA is in this state nobody can log into the system using this SUA. 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: •
The Login Lockout Period expires.
- Or •
The Login Lockout is unchecked (False) manually by a user logged in with another valid SUA with appropriate permissions.
- Or •
Total Pages in this Section: 812
The SUA object is reset.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–725
10–726
Software Objects Reference Version 3.40 BACnet 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. This field is read-only and not editable by the user.
Last Logged Off at This field shows the last time and date that the SUA Status was set to Logged Off. In the PC, it shows the last time someone logged off 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 Off state. In this case, the time is taken from the controller. This field is read-only and not editable by the user.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–726
Total Pages in this Section: 812
System User Access (SUA) Description
10–727
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–727
10–728
Software Objects Reference Version 3.40 BACnet
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. The Name has the following restrictions: •
Maximum 16 characters
•
Forced to be Uppercase
•
Only Version 2 acceptable characters are accepted. Do not use characters such as ( \ /:*?"< >| ). Also, spaces are not allowed. An SUA object name can have an underscore character _ in a name but it cannot be at the start of the name.
•
Minimum 1 character
These restrictions are in place to keep the SUA compatible with the Version 2 User Access object (UA).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–728
Total Pages in this Section: 812
System User Access (SUA) Setup
10–729
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 ‘*’. The Password has the following restrictions: •
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).
Security - Password Auto Expire This field is used to enable the Password Start Date and Password Expiry Date. When checked (On) the object will execute the Password Auto Expire routine. 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).
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–729
10–730
Software Objects Reference Version 3.40 BACnet
Security - Password Start Date This field allows the user to specify when the SUA can start to be used when the Password Auto Expire is on. The default value for Password Start Date will be the date and time that the user was created. If the Password Start Date has not occurred yet, then the Status of the SUA object will be set to Inactive. You can adjust the start time with the spin box, and the start date with the drop down calendar.
Security - Password Expiry Date The Password Expiry Date sets the date when the SUA expires. Once the SUA has expired, the SUA Status is set to Inactive. The default value for the Password Expiry Date is set to 6 months from when it was created. You can adjust the expiry time with the spin box, and the expiry date with the drop down calendar.
Menu Reference (Not HMI) 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.
Object Security Provides a way to select an optional Object Security Restrictions (ORS) object from a list.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–730
Total Pages in this Section: 812
System User Access (SUA) User Data
10–731
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–731
10–732
Software Objects Reference Version 3.40 BACnet 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. If a Security Panel is specified, the Disable Navigator checkbox must be checked in the SUA object on the local OWS for this feature to work.
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.
Disable Alarm Pop-up This field is used to enable or disable alarm pop-ups for the user. The default is unchecked which allows Alarm Pop-ups. 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.
Hide Server Messages This field is used to enable or disable server messages for the user. The default is unchecked which allows server messages.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–732
Total Pages in this Section: 812
System User Access (SUA) User Data
10–733
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.
Default User Graphic (HMI only) The Default User Graphic field defines the first graphic file that displays on the HMI interface after a user logs in. It is only editable in SUA1 by an Administrator. 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).
These 4 fields are specific to the HMI
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–733
10–734
Software Objects Reference Version 3.40 BACnet
Welcome Screen (HMI only) The Welcome Screen field defines the graphic that displays on the touch screen after the HMI device starts up or is reset. It is only editable in SUA1 by an Administrator. 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).
Auto-Logoff - Period (HMI only) The Auto-Log off period is the amount of time before a user is automatically logged out if there are no touches on the screen. You can disable this feature by setting the period to 0. In order for any changes in this field to take effect, you must save the changes. The default Auto-Logoff period is 10 minutes.
Login Required Checkbox (HMI only) The Login Required checkbox specifies whether a user needs to log in and its status affects the Default User Graphic and Welcome Screen fields. It is only editable in SUA1 by an Administrator. If this field is checked (enabled), a user must log in to gain full Read/Write access to graphics. All graphics are Read Only if a user is not logged in. If this field is unchecked (disabled), HMI access is granted to all users. This means that all users have full Read/Write control of graphics. A user still must have Login access as an Administrator (SUA1) to access the Configuration pages.
Refresh Rate for Objects This field is used to tell ORCAview how often to update a graphic and/or dialog for the User. The default value is 5 seconds. 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. Note: The Refresh Rate for Objects field is not currently used by HMI. It is
reserved for future features.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–734
Total Pages in this Section: 812
System User Access (SUA) User Data
10–735
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.
Starting Screen (HMI only) The Starting Screen field defines the Start Graphic to be displayed on the touch screen after a user logs in. 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 the field is empty, then HMI will use the Default User Graphic after a user logs in.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–735
10–736
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–736
Total Pages in this Section: 812
System User Access (SUA) Login
10–737
Last Login Area Date This field shows the last time and date the SUA Status was Logged In. In the PC it will show the last time someone logged into the workstation, taken from the PC clock. The SUA Status in the controller will show the last time that SUA Status in the controller was in the Logged in state. In this case the time is taken from the controller. This field is read-only and not editable by the user. 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.
Login Failure Area Date This field displays the last time and date that this SUA failed a login check. In the OWS this field will show the last time and date the security check to get into the ORCAview failed. The SUA in the controller will show the last time and date the security check to the BACnet Security Panel failed. 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. This field is read-only and cannot be adjusted by the user. 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. The default value for Maximum Failures when an SUA is created is 3.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–737
10–738
Software Objects Reference Version 3.40 BACnet
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. The Lockout defaults to unchecked (Unlocked) when an SUA is created. 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. The default value for the Period is 1440 minutes (1 day).
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.
Auto-Logoff - Period (HMI only) Period (HMI Only) The Auto-Log off period is the amount of time before a user is automatically logged out if there are no touches on the screen. You can disable this feature by setting the period to 0. In order for any changes in this field to take effect, you must save the changes. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–738
Total Pages in this Section: 812
System User Access (SUA) Object Overrides
10–739
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.
Object Access Exceptions The Object Access Exceptions section has two fields allowing input for a specific object and its corresponding access level. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–739
10–740
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–740
Total Pages in this Section: 812
Security User Group (SUG) Description Tab
10–741
SECURITY USER GROUP (SUG) 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
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–741
10–742
Software Objects Reference Version 3.40 BACnet
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.
Object Security Tab This tab contains all the fields necessary to set up object security.
The order of precedence for the fields on the Object Security tab from highest to lowest are: •
Restricted Devices (Highest Precedence)
•
Object Application Restrictions (Second Highest Precedence)
•
Object Access Permissions (Lowest Precedence)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–742
Total Pages in this Section: 812
Security User Group (SUG) Object Security Tab
10–743
Restricted Devices (Highest Precedence) The Restricted Devices field enables controllers to be restricted either by single device or a range of devices. Device Restrictions have the highest level of precedence. Any BACnet or V2 device can be restricted in the SUG object. A user who is restricted from a device cannot see or access the device in ORCAview. 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 (Second Highest Precedence) Object Application Restrictions allow objects to be hidden from the user based on their application area (HVAC, Lighting or Access). A user, who is restricted from a specific category of objects, cannot see or access objects of that category. 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.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–743
10–744
Software Objects Reference Version 3.40 BACnet 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 (Lowest Precedence) Object Access Permissions have two input fields. The Objects field is used to enter in the object instance. The Access Level is used to set the Access Level Restriction for that specific object. 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–744
Total Pages in this Section: 812
Security User Group (SUG) Using Default SUG Objects
10–745
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.
Using Default SUG Objects Eight pre-configured SUG objects are created on the local OWS by default during an ORCAview 3.30 or later new installation. These default SUG objects allow the administrator to efficiently assign groups of SUA users appropriate access levels. The default SUG objects are there as a template for the administrator to setup proper permissions for groups of users. Any of the 8 SUG objects can be modified to suit the application and they can be copied and pasted to other controllers (i.e. the Security Panel). 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–745
10–746
Software Objects Reference Version 3.40 BACnet
TREND LOG – BACNET (TL) 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. TLs will display the collected information in two ways: •
Graphically, with a line graph that has the last 200 values plotted against time.
•
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 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: If a TL is created on a network that includes Historian, users can trend more than the default maximum of 6000 samples. By selecting a TL(s), right clicking and clicking Command|Add to Historian, a user commands Historian to continuously archive the TL’s data into an ODBC database. The information from the database can be viewed in the corresponding historical TL that is created when a TL is archived. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–746
Total Pages in this Section: 812
Trend Log – BACnet (TL) Header
10–747
Header
Object Mode and Object Value There are 2 modes of operation for the Trend Log object: •
Enabled
•
Disabled
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. The header also displays icons to indicate the status of a TL: This icon indicates that the TL is being archived by the Historian Device. This icon appears on any TL’s that are being archived by Historian. The Fault Notification icon indicates that the archived TL is in fault. The Alarm Notification icon indicates that an external alarm has been triggered.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–747
10–748
Software Objects Reference Version 3.40 BACnet
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 Xaxis. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–748
Total Pages in this Section: 812
Trend Log – BACnet (TL) Setup
10–749
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. Historian Note: If a TL is being archived by Historian, changing the TL name will not automatically change the name of the Archive TL.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–749
10–750
Software Objects Reference Version 3.40 BACnet
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
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 Monitored Object can be entered in many ways: •
By the descriptor name. For example, AHU1 Supply Air Temperature.
•
By the object reference number. For example, 9100.AI1 or 9100.AI1.Commissioned.
•
Drag-and-drop an object from Navigator. (This will always trend the present value property.)
Historian Note: Changing the Monitored Object — If a Trend Log is being archived by Historian, the monitored object becomes a read-only field.
To change the monitored object of a TL that is being archived:
1.
From the Setup tab of the source TL, clear the Archived checkbox.
2.
Click Apply or OK. This will re-enable the monitored object text box.
3.
In the Monitored Object field, type the name of the new monitored object.
4.
Select the Archived checkbox.
5.
Click Apply or OK.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–750
Total Pages in this Section: 812
Trend Log – BACnet (TL) Setup
10–751
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.
Archive TLs are detached to: 1.
Ensure that the data in each archive pertains to one monitored object only (done when the monitored object of a TL is changed).
2.
Maintain a complete record of all TLs that have been archived over time (done when the source TL is deleted).
3.
Ensure that the data in each archive pertains to the same controller (done when the address of a controller has changed).
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.
Total Pages in this Section: 812
If the Log Type is:
Historian will:
Polling
Periodically collect new data samples based on the TL’s time interval.
Change of Value (with Buffer Notification)
Wait for notifications from the TL that its buffer contains samples to be archived and will periodically collect data samples as a backup in case notifications are not received.
Change of Value (without Buffer Notification)
Periodically collect new data samples based on the rate at which the source TL had previously collected samples.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–751
10–752
Software Objects Reference Version 3.40 BACnet
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.
Disable When Full When this checkbox is cleared, the TL will continue to collect samples, and will discard the oldest samples. When this checkbox is selected, the TL will stop collecting data once it has reached the Max Samples limit. When the data buffer is full, the TL object goes into Disabled mode to prevent any loss of data.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–752
Total Pages in this Section: 812
Trend Log – BACnet (TL) Setup
10–753
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–753
10–754
Software Objects Reference Version 3.40 BACnet
Archived (not editable greyed out in V3.40) V3.40 now supports multiple Historians on one site and as a result this Archived checkbox is not editable and is greyed out. Previously in V3.33, selecting this checkbox and pressing Apply or OK provided one of the methods to mark a trend(s) for archiving. The active V3.33 Historian would then add this trend(s) to its database. 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. To select a Trend for archiving in V3.40:
1
Right click on a selected trend or trends in a device's object list in the right pane of Navigator.
2
Click on Command on the menu.
3
From the Command submenu, select 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–754
Total Pages in this Section: 812
Trend Log – BACnet (TL) Setup
10–755
The Archived checkbox cannot be edited from the Setup tab of the TL.
Archival Buffer Notification Setup Reporting When the Reporting checkbox is selected, Buffer Ready Notification is enabled, and three more fields become visible in the Setup area. These include Event Class, Threshold, and Records Since Last Notification.
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. Historian Note: If a COV Trend Log is marked for archiving, Historian
automatically configures the above-mentioned fields.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–755
10–756
Software Objects Reference Version 3.40 BACnet
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.
Reset Samples Button The Reset Samples button is used to clear all of the samples in the Trend Log. When you click the Reset Samples button and click Apply or OK, all samples are cleared from the TL. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–756
Total Pages in this Section: 812
Trend Log – BACnet (TL) Description
10–757
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–757
10–758
Software Objects Reference Version 3.40 BACnet
VIEW GROUPS (VGS) 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. Physical Checkbox is Unchecked If the Physical checkbox is Unchecked it will allow you to filter objects by their descriptor names: 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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–758
Total Pages in this Section: 812
View Groups (VGS) Main
10–759
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 Physical Checkbox is Checked If the Physical checkbox is Checked it will allow you to filter objects by their physical references To filter by physical reference for all outputs on panel 100.
1
Select Row1.
2
Check the physical checkbox.
3
Under the descriptor column, double click and type in 100.BO*
4
Select Row2.
5
Check the physical checkbox.
6
Under the descriptor column, double click and type in 100.AO*
7
Click Apply.
To filter by physical reference for all AI3 objects on the network.
1
Check the physical checkbox.
2
Under the descriptor column double click and type in *.AI3
3
Click Apply.
All AI3 objects will appear in the custom view folder
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–759
10–760
Software Objects Reference Version 3.40 BACnet
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
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–760
Total Pages in this Section: 812
View Groups (VGS) Custom Views
10–761
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. ORCAview automatically saves custom views in the Workstation hard drive.
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 subfolders 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.
Creating New Custom Views Creating a custom view occurs in three steps: Create new views Create folders and sub-folders Change the folder properties to filter objects into the folders.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–761
10–762
Software Objects Reference Version 3.40 BACnet To create a custom view folder:
1.
From the ORCAview menu bar, click File, select New and then click 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–762
Total Pages in this Section: 812
View Groups (VGS) Custom Views
10–763
Sample Custom Views A Sample Custom View is provided with ORCAview and is used here to explain how this Custom View was added. To open the sample set of custom views:
1.
In a blank area of the Navigator left pane, right click.
2.
From the pop-up menu select Custom and then click Sample Custom View.
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
To add objects to custom view folders:
To place objects in your custom view folders, construct filters for each folder. The filters are constructed by changing the folder properties.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–763
10–764
Software Objects Reference Version 3.40 BACnet There are two methods for creating filters using: Descriptors, or Object References. To create a filter using descriptors:
1.
Right click on any folder in your custom view. Select Properties… The ViewGroup dialog box appears.
2.
Double click in the area immediately below descriptors. Type your filter using wildcards. For example, A* will place all objects with descriptors starting with A in the folder.
3.
Click Apply to record your filter. If you wish to close the ViewGroup dialog, click OK. The folder will contain objects according to the filter you typed.
To create a filter using object references:
1.
Right click on any folder in your custom view. Select Properties. The ViewGroup dialog box appears.
2.
If you plan to filter by Object Reference, double click in the area immediately below Physical. A check mark will appear. Type the object reference in the descriptor area. For example, AI* will place all analog inputs for all controllers in the folder. For a V2 site, IP* will place all inputs for all controllers in the folder, and 1.OP* will place all outputs from panel 1 in the folder.
3.
Click Apply to record your filter. If you wish to close the ViewGroup dialog, click OK. The folder will contain objects according to the filter you typed.
To create new sub folders:
1.
Right click on your Sample Custom View folder. Select New Folder. The Create New SubGroup dialog box appears.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–764
Total Pages in this Section: 812
View Groups (VGS) Custom Views
Total Pages in this Section: 812
10–765
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–765
10–766
Software Objects Reference Version 3.40 BACnet 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. 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 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–766
Total Pages in this Section: 812
View Groups (VGS) Custom Views
10–767
To filter by descriptor name for objects in panel 1 containing the letter A:
1.
Right Click on the folder and select Properties. The ViewGroup dialog box opens.
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.
To filter by descriptor name for all objects starting with an A, B, and C:
1.
Total Pages in this Section: 812
Right Click on the folder and select Properties. The ViewGroup dialog box opens.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–767
10–768
Software Objects Reference Version 3.40 BACnet 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.
To filter by object type for all analog inputs:
4.
Right Click on the folder and select Properties. The ViewGroup dialog box opens.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–768
Total Pages in this Section: 812
View Groups (VGS) Custom Views
10–769
To filter by object type for all analog outputs:
1.
Right Click on the folder and select Properties. The ViewGroup dialog box opens.
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.
Total Pages in this Section: 812
Right Click on the folder and select Properties. The ViewGroup dialog box opens.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–769
10–770
Software Objects Reference Version 3.40 BACnet 2.
3.
4. 5.
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*.
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*. Click Apply to accept changes and OK to exit.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–770
Total Pages in this Section: 812
View Groups (VGS) Custom Views
10–771
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.
4. 5.
Total Pages in this Section: 812
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*. Click Apply to accept changes and OK to exit.
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–771
10–772
Software Objects Reference Version 3.40 BACnet 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. 5.
Click Apply to accept changes and OK to exit.
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.
Export & Import The Export and Import commands on the ORCAview Dashboard allow existing custom views to be used in different workstations. These two commands are not required for normal operation. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–772
Total Pages in this Section: 812
View Groups (VGS) Custom Views
10–773
To Export a Custom View:
1.
Right click any custom view folder. Select Export.
2.
Select the drive and directory where you want to save the folder. Type a file name in the Filename field. Click Save.
3.
The selected folder and all its sub-folders will be saved to the selected directory.
To Import a Custom View:
1.
Select a folder in a custom view. Right Click and Select Import.
–OR–
Total Pages in this Section: 812
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–773
10–774
Software Objects Reference Version 3.40 BACnet
ZIGBEE WIRELESS DEVICE (WSD) [NEW 3.40] Each wireless device on the network has a Wireless Device (WSD) object. Commands can be issued to the wireless device. The WSD object shows: •
Hardware information about the wireless device including the Model Name, Firmware Version, Hardware Version Input Count and Output Count.
•
Wireless information such as the protocol and version, MAC address, and current network address.
•
Operational statistics such as Reset Count, Signal Strength and Last Update Time.
The WSD object can command an associated wireless object to perform the following actions: Pairing On, Pairing Off, Network Reset, Device Reset, Flash Load and Delete Sub-Devices. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–774
Total Pages in this Section: 812
ZigBee Wireless Device (WSD) [new 3.40] Custom Views
10–775
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)
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–775
10–776
Software Objects Reference Version 3.40 BACnet
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 will often be used for a detailed functional definition.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–776
Total Pages in this Section: 812
ZigBee Wireless Device (WSD) [new 3.40] Custom Views
10–777
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: No Fault Detected This is the normal state.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–777
10–778
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–778
Total Pages in this Section: 812
ZigBee Wireless Device (WSD) [new 3.40] Custom Views
10–779
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–779
10–780
Software Objects Reference Version 3.40 BACnet
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.
No. of Children Available This read-only field contains the Number of end devices entries (sensors) the device can handle. For example, if the remaining number is 5 then only five more wireless sensors can be added.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–780
Total Pages in this Section: 812
ZigBee Wireless Device (WSD) [new 3.40] Custom Views
10–781
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.
Last Update Timer This read-only field indicates the number of seconds since the last update time. The range is 0 to 65535 with a default of 0. This would be the last time that the device communicated.
Expired Timestamp This read-only field displays the Timestamp that the device was last marked as offline.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–781
10–782
Software Objects Reference Version 3.40 BACnet
ZIGBEE WIRELESS DEVICE LIST (WDL) [NEW 3.40] The Zigbee Wireless Device List (WDL) provides a list of: •
All wireless devices joined to the network. This list mimics the device list in the enteliTOUCH (eTCH) screen.
•
Status values (Online or offline ) as well as the MAC address and name of the wireless device.
Right clicking on any line in the list on the Device tab opens up the associated corresponding Wireless Device (WSD) object. The WDL also puts the device into a mode where other devices can be added to the wireless network. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–782
Total Pages in this Section: 812
ZigBee Wireless Device List (WDL) [New 3.40] Custom Views
10–783
•
None – No command selected.
•
Stop Join Mode – Does not allow new devices to join the wireless network.
•
Join Mode – A mode which allows new devices to be added to the wireless network. An address is also assigned. Join performs both the Associate and the Pair mode functions.
•
Association Mode - In this mode, devices added to the network can communicate through other devices. In the Associate operational mode, wireless devices with routing capabilities provide a communication path for devices when they join the wireless network.
•
Pair Mode assigns address only as the device is already on the network. This feature is useful for troubleshooting.
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–783
10–784
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–784
Total Pages in this Section: 812
ZigBee Wireless Device List (WDL) [New 3.40] Custom Views
10–785
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: No Fault Detected This is the normal state.
Device List
Device This read-only field contains the device name and 16-bit ZigBee network address To open the WSD object for a selected Device list entry:
With an entry is selected in the Device List, right click. A submenu appears. Click the first option on the submenu to open the WSD object
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–785
10–786
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–786
Total Pages in this Section: 812
Zigbee Wireless Settings (ZBS) [new 3.40] Custom Views
10–787
ZIGBEE WIRELESS SETTINGS (ZBS) [NEW 3.40] The ZigBee Settings object (ZBS) is used to: •
Set up the eTCH as a wireless coordinator.
•
Set the Channel and PAN ID in this object.
•
Show wireless statistics such as: Online devices, Received packets, Transmit packets, Invalid Received packets, Sent and response failures.
Delta employs ZigBee technology in its enteliMESH products. See the Glossary enteliMESH section starting on page 10–794 for some terminology.
ZigBee Wireless Technology ZigBee® is a registered trademark of the ZigBee Alliance. The following definition of ZigBee is from: http://www.digi.com/technology/rf-articles/wireless-zigbee ZigBee is a wireless technology developed as an open global standard to address the unique needs of low-cost, low-power wireless networks. The ZigBee standard operates on the IEEE 802.15.4 physical radio specification and operates in unlicensed bands including 2.4 GHz, 900 MHz and 868 MHz 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, batteryoperated devices. The protocol allows devices to communicate in a variety of network topologies and can have battery life lasting several years.
Confirm Installation of ZigBee Wireless Card To confirm that the ZigBee Wireless Card hardware is correctly installed with the enteliTOUCH, open the DEV object of the enteliTOUCH in the OWS Navigator tree.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–787
10–788
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–788
Total Pages in this Section: 812
Zigbee Wireless Settings (ZBS) [new 3.40] Custom Views
10–789
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–789
10–790
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–790
Total Pages in this Section: 812
Zigbee Wireless Settings (ZBS) [new 3.40] Custom Views
10–791
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. The supported ZigBee channel range in the enteliMESH system is 12 to 23.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–791
10–792
Software Objects Reference Version 3.40 BACnet
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
ZigBee network consists of a number of ZigBee Devices or Nodes. A node is a piece of hardware that shares a single radio. Each node can have a several subunits. Subunits are physical devices such as sensors, lamps and switches.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–792
Total Pages in this Section: 812
Zigbee Wireless Settings (ZBS) [new 3.40] Custom Views
10–793
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.
Invalid Received Packets 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 communication issues such as interference or improper configuration.
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)
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–793
10–794
Software Objects Reference Version 3.40 BACnet
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. Associate also describes an operational mode in which wireless devices with routing capabilities provide a communication path for devices when they join the wireless network.
Coordinator A coordinator controls the formation and security of a ZigBee wireless network. In Delta's enteliMESH wireless network, the DFM-ZBEE or an enteliTOUCH with the eTCH-EXP-ZBEE expansion board act as the coordinator. 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 DFMZBEE 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. Following definition taken from http://www.digi.com/technology/rfarticles/wireless-zigbee A key component of the ZigBee protocol is the ability to support mesh networking. In a mesh network, nodes are interconnected with other nodes so that multiple pathways connect each node. Connections between nodes are dynamically updated and optimized through sophisticated, built-in mesh routing table.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–794
Total Pages in this Section: 812
Glossary enteliMESH Custom Views
10–795
Mesh networks are decentralized in nature; each node is capable of self-discovery on the network. Also, as nodes leave the network, the mesh topology allows the nodes to reconfigure routing paths based on the new network structure. The characteristics of mesh topology and ad-hoc routing provide greater stability in changing conditions or failure at single nodes. ZigBee® is a registered trademark of the ZigBee Alliance.
Personal Area Network (PAN) A collection of cooperating devices which are associated and share the same address space or PAN ID
ZigBee The following definition is from: http://www.digi.com/technology/rf-articles/wireless-zigbee ZigBee is a wireless technology developed as an open global standard to address the unique needs of low-cost, low-power wireless networks. The ZigBee standard operates on the IEEE 802.15.4 physical radio specification and operates in unlicensed bands including 2.4 GHz, 900 MHz and 868 MHz. 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, batteryoperated devices. The protocol allows devices to communicate in a variety of network topologies and can have battery life lasting several years. Delta employs ZigBee technology in its enteliMESH products. ZigBee® is a registered trademark of the ZigBee Alliance.
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 supported ZigBee channel range in the enteliMESH system is 12-23.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–795
10–796
Software Objects Reference Version 3.40 BACnet
ZONE CONTROLLER FORMAT (ZF) The Zone Controller Format Object (ZF) defines the information to be displayed in any associated Zone Controller Objects (ZC). It sets the names and unit types for each of the 8 inputs, 8 outputs, setpoints 1 – 8 and fixed setpoints 11-24. 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–796
Total Pages in this Section: 812
Zone Controller Format (ZF) Inputs / Outputs
10–797
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–797
10–798
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–798
Total Pages in this Section: 812
Zone Controller Format (ZF) Description
10–799
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–799
10–800
Software Objects Reference Version 3.40 BACnet
ZONE CONTROLLER (ZC) The Zone Controller Object (ZC) is used to access all of the information from Zone Controllers. Each ZC Object represents an individual Zone Controller, and information such as input values, output values, set-points, calibrations, I/O types and other parameters are kept up to date within the ZC Object. The ZC Object has three functions: •
Reflect the current status and values from the physical Zone Controller
•
Allow the user to modify the setpoints and control values
•
Transfer information between the BACnet Controller (DCU or DSC-R2424E) and Version 2 Zone Controllers
Note: V2 Network performance will decrease if a ZC object is created before a
corresponding V2 zone controller is physically added to the subnet. This only applies to the DCU if it is routing V2 information to the BACnet network (i.e. a V2 DCU or V2 DAC are on the V2 network and are displayed in Navigator). This is a concern, especially if a lot of V2 communication is occurring such as when an OWS starts and loads the Descriptors for all the Micros. If a ZC is created for a currently unconnected device, put the ZC in Manual mode until the device is connected. 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”.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–800
Total Pages in this Section: 812
Zone Controller (ZC) Header
10–801
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. Offline Indicates no communications are occurring between the BACnet Controller and the Zone Controller. For the DSC-R2424E, the Zone Controller is declared “Offline” if there is no communication for 5 minutes.
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: DAY MORNING STANDBY ON
NIGHT RUN OFF CLG_MIN
MAXIMUM CLOSE PENDING HTG_MIN
MANUAL OPEN ARMED
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: DEADBAND HEATING COOLING
Total Pages in this Section: 812
OR_DBAND OR_HEAT OR_COOL
FERTILIZE MIST WATER
RECIRC RH_CTRL ALARM
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–801
10–802
Software Objects Reference Version 3.40 BACnet
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
Update EEPROM is used to save Setpoints 1 – 8 to the Zone Controller. (Remember to press the Apply button)
The values of Setpoints 1 – 8 are entered in these fields
The names and values of the Inputs and Outputs are displayed in these fields
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–802
Total Pages in this Section: 812
Zone Controller (ZC) I / O Value
10–803
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–803
10–804
Software Objects Reference Version 3.40 BACnet
Setpoints
The names and values of Setpoints 11 to 24 are set and displayed in 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–804
Total Pages in this Section: 812
Zone Controller (ZC) I / O Setup
10–805
I / O Setup
The parameters for the Inputs and Outputs of the Zone Controller are set in these 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–805
10–806
Software Objects Reference Version 3.40 BACnet 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 10Kthermistor sensor connected. DegF The input value will indicate degrees Fahrenheit with a standard 10Kthermistor 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). RelativeHumidity This scale range is used to indicate relative humidity of 0 – 100% for 4 – 20 ma humidity transmitters (or 1 to 5 VDC input).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–806
Total Pages in this Section: 812
Zone Controller (ZC) I / O Setup
10–807
OutdoorAirC This scale range is used to indicate degrees Celsius with a 10K outdoor air sensor (OTS430). OutdoorAirF This scale range is used to indicate degrees Fahrenheit 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. Digital The output will be digital, controlling a triac and 24 VAC. Switch, Direct, Pulse, LedSense, LedSw The implementation of these fields are specific to the type of algorithm and zone used. Please refer to the V2 documentation for correct use. 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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–807
10–808
Software Objects Reference Version 3.40 BACnet
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–808
Total Pages in this Section: 812
Zone Controller (ZC) Operation
10–809
None This value indicates the controller is not running any algorithm. Micros, Pzones, and V2 DACs display “None” for Algorithm. VAV, RoofTop, DualHeatPump, Controller, UnitVentilator, HeatPump, Custom, PulseLoop, DualDuct, FanCoil These settings indicate the specific algorithm installed in the Zone Controller. Please refer to the V2 Zone Algorithm documentation for correct use. GCL+ This algorithm is unused. Mux This setting indicates the Zone Controller is operating as a Multiplexor. The outputs are controllable via GCL+. FlashTest This setting indicates the Zone Controller is running a built-in diagnostic test (Only available with certain algorithms). 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. MuxControl Indicates the Zone Controller is operating as a multiplexor. UserControl Indicates the ZC Object is being used as a programmable object and does not have an associated Zone Controller. In this mode the BACnet Controller stops polling the Zone Controller.
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)
New Address [CAUTION] The New Address field is used only by DSC-R2424E to change the address of a Zone controller or Micro. (DCU: see MNP object)
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–809
10–810
Software Objects Reference Version 3.40 BACnet 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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–810
Total Pages in this Section: 812
Zone Controller (ZC) Description
10–811
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.
Total Pages in this Section: 812
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–811
10–812
Software Objects Reference Version 3.40 BACnet
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. As a part of OWS security, these checkboxes allow an operator to see only those objects for a particular application(s). For example, a site may have separate operators for the HVAC and Access applications and each operator may 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)
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page 10–812
Total Pages in this Section: 812
Overview
11-1
Chapter 11 – GENERAL CONTROL LANGUAGE (GCL+) 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
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-1
11-2
General Control Language (GCL+) GCL Timeout ..................................................................................... 11-44 Program Size ..................................................................................... 11-45 Numbers ............................................................................................ 11-46 Delimited User Defined Names ......................................................... 11-47 Name a Program Line ....................................................................... 11-48 Program Comments ........................................................................... 11-49 Multiple Statements on a Line ........................................................... 11-50 Line Continuation .............................................................................. 11-50 PROGRAM INPUTS ............................................................................................. 11-50 System Variables as Program Inputs................................................. 11-51 Objects Properties as Program Inputs .............................................. 11-51 Object Fields (Properties) as Program Inputs .................................. 11-52 Table of Common Object Properties ................................................. 11-54 COMPILING GCL+ PROGRAMS ......................................................................... 11-60 Valid Syntax with No Undefined Names ............................................ 11-61 Invalid Syntax .................................................................................... 11-62 Undefined Symbol.............................................................................. 11-63 Execution Error ................................................................................. 11-64 Missing Statement.............................................................................. 11-65 Execution Trace ................................................................................. 11-66 GCL+ LANGUAGE REFERENCE......................................................................... 11-67 Conventions for GCL+ Syntax .......................................................... 11-67 ABS .................................................................................................... 11-69 AND ................................................................................................... 11-69 ARCCOS ............................................................................................ 11-69 ARCSIN ............................................................................................. 11-70 ARCTAN ............................................................................................ 11-70 Assignment......................................................................................... 11-70 AVERAGE ......................................................................................... 11-71 BETWEEN ......................................................................................... 11-72 Bitwise Operators ! , && , || , ^^ ................................................. 11-73 CALL ................................................................................................. 11-73 Changed ............................................................................................ 11-74 Command Statements ........................................................................ 11-74 COMMENT ....................................................................................... 11-75 Comparison Operators =, >, >=, 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:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-36
Total Page in this Chapter: 131
Program Execution
11-37
GCL+ Code Usages to Use The following code ensures that GCL checks if AI1 has been greater than 5 first, then checks if that has been true for 1 minute. // Write code with brackets like this! If (AI1 > 5) OnFor 1M Then Start BO1 Endif 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 If (BO1 = Running) OnFor 1M Then If (BI1 = Freeze) OnFor 1M Then If (MV1 = Occupied) 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.
PG1 Defines Execution Order The system executes PG1 and you must define the execution order of programs within PG1. To define the execution of other programs, put CALL statements for the other programs in the Master Program PG1. Program 1 is called the Master Program when it is only used to call other programs. The other programs execute in the order defined in PG1. Each program called from PG1 may contain additional calls to other programs.
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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-37
11-38
General Control Language (GCL+) 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.
Note: Program 2 (PG2) is often by convention reserved as a program for Data Transfer. Any miscellaneous values that need to be passed between controllers can be written into this program. Although the PG2 program may not always be used, it creates consistency in programming from site to site.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-38
Total Page in this Chapter: 131
Program Execution
11-39
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 a Program Line Use a GOTO statement to cause the Program execution to move to the program line name specified, and then continue the normal program execution order from the specified line. A line is given a name by following the line name with a colon and not putting any space between the name and the colon. A line name may also be called a label. Note: You cannot use a GOTO statement to branch to a program or subroutine.
It is recommended programming practice to use conditional branching rather than a GOTO statement. The logic of the program is much clearer with conditional branching structures such as IF THEN. A program with an excess of GOTO statements can be difficult to read and debug. Use IF…THEN…ELSE…END IF, and FOR…ENDFOR whenever possible.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-39
11-40
General Control Language (GCL+)
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. A subroutine is defined by preceding the subroutine name with SUB (i.e., SUB NAME) at the beginning of a line and defines NAME as a subroutine. All statements from the declaration of the subroutine to a END SUB statement are included in the subroutine. A subroutine definition must have a matching END SUB statement. Example Call a subroutine MySubRoutine to set a Setpoint to a calculated value.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-40
Total Page in this Chapter: 131
Program Execution
11-41
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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-41
11-42
General Control Language (GCL+)
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 Value
Description
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-42
Total Page in this Chapter: 131
Programming Considerations
11-43
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 Halted PG When a program is in Manual it will not execute (trace) the program. A hand symbol will appear near the Program object in Navigator. The value of the program will be Idle. The Program object must be set to Auto before it will run again. 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. The PG is designed NOT to write to commandable objects (i.e. those with a priority array) at the following priority levels: 1 - Manual Life Safety 6 - Minimum On/Off 8 - Manual Operator So a PG's write priority cannot be changed to any of these values.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-43
11-44
General Control Language (GCL+)
Program Status in Navigator If a Program has syntax or execution errors, the status of the Program will be Fault in Navigator. If a program has no errors, then the status column beside the particular Program object is blank.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-44
Total Page in this Chapter: 131
Programming Considerations
11-45
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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-45
11-46
General Control Language (GCL+)
Controller
Max PG Size in 3.40 (bytes)
Recommended Max PG Size (bytes)
DAC 4Mb
5500 (DACs pre-2005)
4500
DAC 8Mb
10000 (DACs post-2005)
9000
DAC-E 16Mb
10000
9000
DSC 8Mb
10000 (DSCs pre-2005)
9000
DSC 16Mb
10000 (DSCs post-2005)
9000
DCU
23700
22700
OWS
N/A (PGs not normally created in the OWS)
N/A
eBCON
10000
9000
Refer to KBA 1579: SRAM & Flash Size Of DSC/DAC Depends On Hardware Version for information about specific hardware revisions. 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. Because GCL+ does all intermediate calculations using 32-bit arithmetic, an expression can exceed the 2147483647 value but the final result must be within range.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-46
Total Page in this Chapter: 131
Programming Considerations
11-47
Delimited User Defined Names You have the option of creating and using names containing spaces or reserved characters in the program code. Reserved characters are those used by GCL+ in its syntax. These include the &, !, *, /, ^, +, - , | characters. The compiler delimits a name containing a space or a reserved character with single quotes with the exceptions of the VARIABLE or CONSTANT statements. The single quotes help us to identify a long name with spaces as an entity. 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 // Shows delimited names with single quotes If ‘AHU1 OCCUPIED’ Then Start ‘AHU1 Return Fan Status’ If ‘AHU1 Return Fan Status’ OnFor 10s Then Start ‘AHU1 Supply Fan Status’ End If Else Stop ‘AHU1 Return Fan Status’ End If // Shows delimited name with reserved character Variable ‘BelowSP&SFoff’ as Integer If ‘BelowSP&SFoff’True then Fault8 = 1 End If
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-47
11-48
General Control Language (GCL+)
Name a Program Line At the beginning of the program line, type the desired name and follow it with a colon. A line name may also be called a label. Use a GOTO statement to branch to the newly named program line. Example Branch to a line labeled MIN_AIR.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-48
Total Page in this Chapter: 131
Programming Considerations
11-49
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. Example Comments in the last two lines of PG1.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-49
11-50
General Control Language (GCL+)
Multiple Statements on a Line More than one statement can be entered on a single program line. Separate each statement with one or more spaces. The use of multiple statements in a line is not recommended. Lines become difficult to read and when tracing problems, it is harder to pinpoint the statement that is causing the problem. The compiler accepts the old GCL convention of using a backslash \ to separate multiple statements on a line. Example Multiple statements on a line are separated with spaces. Multiple statements in a single line are not recommended.
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 //This will *not* 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-50
Total Page in this Chapter: 131
Program Inputs
11-51
System Variables as Program Inputs System Variables Any one of the following system functions can be used as an
input to a GCL+ program: •
DATE (internally coded number)
•
DAY
•
DECIMALTIME (GCL was HOUR)
•
HOURS
•
MINUTES
•
MONTH
•
MONTHDAY (GCL was MDAY)
•
SECONDS
•
SUNRISE
•
SUNSET
•
TIME (internally coded number)
•
WEEKDAY
•
YEAR
Objects Properties as Program Inputs Almost all properties of objects are available as program inputs. Programs have Read/ Write access to objects on the local or a remote controller. 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:
•
Used as an input to any GCL+ program, in any controller.
•
Set by any GCL+ program in any controller—if the OP object is set to AUTO.
When an OP object is set to AUTO, a GCL Program will: •
START or STOP a Binary Output. Binary Outputs are controlled subject to their Start Time delay and Minimum off times. If a Binary Output is set, the actual output is not changed until all GCL+ programs have been executed.
•
Set the value of an analog output. When an Output object is set to MANUAL, then the Value can be set by an operator and GCL+ has no effect on the output. The value of the current GCL+ command and commanding program is shown when the OP object is displayed.
Schedule Object (SCH) Use the Status of the SCH object as an input to any
GCL+ program, in any controller.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-51
11-52
General Control Language (GCL+) 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.
Object Fields (Properties) as Program Inputs Most fields within objects are accessible from GCL+. These field values may be used in any expression and are referenced using the following convention: Objectname.Property Example 1 Include AI1 in an average calculation only if it is commissioned.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-52
Total Page in this Chapter: 131
Program Inputs
11-53
Example 2 Set the mixed air Control Loop (CO object) Setpoint to 60.
Caution: It is possible to do a remote write from a PG to a variable even when it is in Manual mode. During a remote write, the status of the object is not checked. This behavior affects AV, BV, and MV objects on OWS, DCU, DAC, BACstat or other products. Avoid doing a remote write to a variable as it is poor programming practice and makes code difficult to troubleshoot. The remote write capability is intended only for third party devices. All programming should be local to the outputs that are being controlled.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-53
11-54
General Control Language (GCL+)
Table of Common Object Properties The following table lists some common properties of different objects that are accessible within GCL+ programming: Object
Property
Value Description
Read / Write
All
Description
Text used for notes on an object.
R/W
Outofservice
1 = true, 0 = false
R/W
when outofservice is true, object is in manual The LCD object does not support this property. Name
Descriptive text label for the object.
R/W
Value
Current object Value.
R/W
Units
The unit number of an object.
R/W
The LCD object does not support this property. Number
The .number property is not supported.
NA
CommissionFlag
1 = yes 0 = no
R/W
The LCD object does not support this property. Reliability
Detects Faults, the numeric or text value can be used in equations. Text must be in Quotes.
R
0= No fault Detected 1=No Sensor Detected 2= Over Range 3= Under range 4= Open Loop 5= Shorted Loop 6= No Output 7= Other Fault 8= Process Error 9= Not Available AI Object
LastValue
The last value sampled.
R
COVincrement
Increment of value needed before object is considered as changed value.
R/W
This does not affect the Changed function in GCL.
AO Object
Calibration
Used to calibrate a sensor, it adds an offset to the value.
R/W
ADFilter
Adds a filter to smooth out sporadic values.
R/W
DefaultValue
Value that an object is set to if all Priority Levels are null.
R/W
COVincrement
Increment of value needed before object is considered as changed value.
R/W
This does not affect the Changed function in GCL. HandsOffAuto
Verifies condition of HOA Switch. Numeric or text value
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-54
R
Total Page in this Chapter: 131
Program Inputs
Object
Property
Value Description
11-55
Read / Write
may be used in GCL+. Text must be in quotes. 1= Hand 2= Off 3= Auto
BO Object
CurrentPriority
The priority that is currently writing to the object.
R
MaxValue
Max value AO can be as defined by the AOC.
R
MinValue
Min value that the AO can be as defined by the AOC.
R
DAvalue
Value from D TO A converter.
R
ChangeofStateCount
Number of times the object has changed states.
R
MinimumOffTime
Minimum time object will stay OFF.
R
MinimumOnTime
Minimum time object will stay ON.
R
MinimumDelayTimer
Time between turning each output on.
R
HandsOffAuto
Verifies condition of HOA Switch. Numeric or text value may be used in GCL+. Text must be in quotes.
R
1= Hand 2= Off 3= Auto
BI Object
Defaultvalue
Value that an object will be set to when all Priority Levels are null.
R
ChangeofStateCount
Number of times the object has changed states.
R
Polarity
Direct Acting= 0
R
Reverse Acting= 1 BT Object
ActiveStateChanges
Number of times monitored object went active.
R
CO Object
Inputvalue
Monitored input object value used in Algorithm.
R/W
SetpointValue
Setpoint value used in algorithm.
R/W
ProportionalValue
Proportional Value.
R/W
IntegralValue
Integral Value.
R/W
Derivative value
Derivative value.
R/W
Bias
Bias.
R/W
Deadband
Deadband.
R/W
Resetband
Resetband.
R/W
Value
Numeric or text value may be used in GCL+. Text must be in Quotes.
R
CO Object
EV Object 3.40
0= Normal 1= Fault 2= Off-Normal 3= High-Limit
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-55
11-56
General Control Language (GCL+)
Object
Property
Value Description
Read / Write
4= Low-Limit 5= Life Safety 64= Unknown (was 6 in 3.33R2) 65= Off-Alarm (was 7 in 3.33R2) 66= On-Alarm (was 8 in 3.33R2) 67= Trouble (was 9 in 3.33R2) 68= Security (was 10 in 3.33R2) 69= Fire (was 11 in 3.33R2) GW object
BasicAdapterStatus
Status of the selected port on the Version 3 Delta Controller used for the gateway. This property corresponds to the Status field on the Setup tab of the GW object.
R
0=Active 1= Inactive 2= In Use By 3= Gateway Disabled 4= Driver Disabled CurrentEntry
Address of the device currently being monitored. This property corresponds to the Current Entry / Current Transmitter Address field on the header of the GW object.
R
CurrentState
Status of the current entry. This property corresponds to the Current State field on the header of the GW object.
R
1= OK 2= Object Not Found 3= Protocol Error 4= General Error 5= Communications Error LastErrorState
The last error state that the CurrentState property was in.
R
Status
Current status of the gateway. This property corresponds to the Gateway Status field on the Setup tab of the GW object.
R
1= Running, 2= No Port 3= Stopped LCD Object
Value
Current object Value
R
Type
The device type can be DSM-T0, DNT-T305, DAC-T305, or DSC-T30’ for the Room Controller or ‘DNS-14’ for the BACstat.
R
Line1
The first text section (Line1) is the largest in character size and is located in the middle on the top of the screen.
R/W
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-56
Total Page in this Chapter: 131
Program Inputs
Object
Property
Value Description
11-57
Read / Write
Line1 has four characters. Line2
The second text section (Line2) is half the character size of Line 1 and is located in the upper right corner of the screen. Line2 has four characters.
R/W
Line3
The third text section (Line3) has characters equivalent in size to the characters in line 2 and is located all along the bottom of the screen. Line3 has twelve characters.
R/W
Contrast
The contrast field controls the level of darkness on the actual and virtual LCD screens from 0% to 100%.
R/W
BackLight
The Back Lighting field controls the level of the Back Lighting on the actual LCD screen from 0% to 100%. A Back Lighting level of 0% means there is no light on at all.
R/W
BackLightEnabled
Defines if the Back Lighting option is available on the controller.
R
KeyPress
Numerical value (1-16) denoting which button is pressed.
R
KeyRepeat
This field specifies how much time passes, after the Key Repeat Delay period, between the key presses, when the button is held down.
R/W
KeyDelay
This field denotes how much time, after a button is pressed and held, passes before the constant key press simulation begins.
R/W
Beeper
If you write a 1 to this property, the beeper sounds according to the data in the Beeper On and Beeper Off fields.
W
BeeperEnable
Defines if the Beeper option is available on the controller.
R
BeeperOn
The Beeper On field denotes the amount of time (ms) that the beeper stays on.
R/W
BeeperOff
The Beeper Off field denotes the length of silence (ms) between beeps.
R/W
BeeperRepeat
Defines the number of times that the beeper sounds.
R/W
IconDisable
Clears the screen except for Lines1-3.
R/W
AlarmBell
If the value of the Alarm Bell field is ON, the Alarm Bell icon is displayed.
R/W
Network
If the value of the Network field is ON, the Network icon is displayed.
R/W
Auto1
If the value of the Auto1 field is ON, the AUTO icon in the top left corner of the LCD screen is displayed.
R/W
Auto2
If the value of the Auto2 field is ON, the AUTO icon on the right of the LCD screen, under the text in line2, is displayed.
R/W
Occupancy
There are three possible states for this field:
R/W
0= Disabled 1= Occupied 2= Unoccupied
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-57
11-58
Object
General Control Language (GCL+)
Property
Value Description
Read / Write
Fan
There are five possible states for the Fan field:
R/W
0= OFF 1= ON 2= Low 3= Medium 4= High. Heating
R/W
The Heating field has five possible states: 0= OFF 1= ON 2= Stage 1 Heating 3= Stage 2 Heating 4= Stage 3 Heating.
Cooling
R/W
The Cooling field has five possible states: 0= OFF 1= ON 2= Stage 1 Cooling 3= Stage 2 Cooling 4= Stage 3 Cooling
Humidity
If the value of the Humidity field is ON, the Humidity icon will be displayed.
R/W
Mode1 – Mode4
Four internal variables that are available to equate to a value or to an object such as an input or output. This approach avoids having to use memory to create an Analog Variable.
R/W
Model
Defines whether the device is a Room Controller or an BACstat.
R
DisplayType
Indicates the type of screen display.
R
Bacstat
Blink
R/W
Calibrate On Off Time Minimum Maximum Set Sun Moon. PI Object
DemandPulserate
The number of pulsesAveraged pulse rate.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-58
R/W
Total Page in this Chapter: 131
Program Inputs
Object
TL Object
ZC Object
11-59
Property
Value Description
Read / Write
Pulserate
Instantaneous Pulserate.
R
LogInterval
Time between samples.
R
BufferSize
Number of samples allotted for trend log data.
R
RecordCount
Current number of samples in buffer.
R
ControlMode
‘Day’
R/W
Standby
Note: Day must be put in quotes it is a system variable
Night Armed Morning Open Close Maximum Cooling Minimum Heating Minimum Manual Run Off On Pending ZC Object
ZoneMode
Deadband
R/W
Heating Cooling Error OverrideDeadband OverrideHeat OverrideCool ReCirculate RHControl Mist Water Fertilize Alarm
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-59
11-60
General Control Language (GCL+)
Compiling GCL+ Programs A GCL+ program is checked and compiled one line at a time. When a line is added or modified, the action of moving the cursor away from the line invokes the line compiler. If the line syntax is correct and no undefined names are detected, the Program Status Column remains blank. The error information appears in Program Status Column which is the space between the line # and statement. 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.
Error Status Codes
Icon
Meaning
Blank space
Valid Syntax on page 11-61
Yellow Octagon with X
Invalid Syntax on page 11-62
Yellow Octagon with ?
Undefined Word on page 11-63
Red Octagon with X
Execution Error on page 11-64
Yellow Octagon with hand icon
Missing a statement on page 11-65
Green Dot
Execution Trace on page 11-66
Note: You can get more detail on a particular error by hovering the mouse cursor
over the error icon in the Program Status Column.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-60
Total Page in this Chapter: 131
Compiling GCL+ Programs
11-61
Valid Syntax with No Undefined Names Example The blank space in the Program Status Column in line 1, of the
following figure, indicates that line 1 contains valid syntax with no undefined names (labels). The name Chiller is defined as a name for a Binary Output object (BO).
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-61
11-62
General Control Language (GCL+)
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. The program object will show as Fault in Navigator. Example An IF Statement in line 1 is missing the THEN part of the statement.
See the Conventions for GCL+ Syntax starting on page 11-67.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-62
Total Page in this Chapter: 131
Compiling GCL+ Programs
11-63
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. The program object will show as ‘Fault’ in Navigator. Example The word Schedule 3 in line 1 is not recognized by the system because it has not been created yet.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-63
11-64
General Control Language (GCL+)
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. An execution error is encountered most frequently in 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 GCL Timeout will allow. The GCL Timeout is defined in the Time Info tab of the Device object. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-64
Total Page in this Chapter: 131
Compiling GCL+ Programs
11-65
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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-65
11-66
General Control Language (GCL+)
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-66
Total Page in this Chapter: 131
GCL+ Language Reference
11-67
GCL+ Language Reference The GCL+ Language Reference is organized in alphabetic order. The first line of each entry identifies the entry as either a statement, function, operator, or system variable.
Conventions for GCL+ Syntax The following conventions are used to define the syntax of GCL+:
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 or variable on the left hand side.
variable = 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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-67
11-68
General Control Language (GCL+)
arg-list or argumentlist
Argumentlist or arg-list is a list of variables representing arguments that are passed to a subroutine when it is called. Commas separate multiple variables representing arguments.
result = LIMIT ( input-expr , low-expr , high-expr )
Replaceable parameters in the syntax of code are set in italics. For example, the user enters a valid numeric expression such as CO1 for input-expr.
Each symbolic name in GCL+ syntax must be one of the following: •
Constant
•
Variable
•
Argument
•
Subroutine
•
External (only type object)
•
Label
•
System variable
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-68
Total Page in this Chapter: 131
GCL+ Language Reference
11-69
ABS Function Calculates the absolute value of an input or expression. Syntax result = ABS (expr) 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
Difference = ABS (Outdoor_Temp - Setpoint) MyNumber = Abs(50.3) // Returns 50.3 MyNumber = Abs(-1 * 50.3) // Returns 50.3
AND Logical Operator Returns TRUE(1) if both expressions are true. Syntax expr1 AND expr2 Example Start the PUMP if the schedule and the FAN are on.
IF Pump ON AND WEEKLY_SCHEDULE ON THEN START Fan ENDIF Reference Logical Operators
ARCCOS Function Calculates the arc-cosine of a value. The result is specified in degrees. Syntax result = ARCCOS (expr) 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. Example ARCCOS Function
MyNumber = ARCCOS (0.866)
// MyNumber equals 30
Reference ARCSIN, ARCTAN, COS, SIN, TAN
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-69
11-70
General Control Language (GCL+)
ARCSIN Function Calculates the arc-sine of a value. The result is specified in degrees. Syntax result = ARCSIN (expr) 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. Example ARCSIN Function
MyNumber = ARCSIN (0.5) // MyNumber equals 30 Reference ARCCOS, ARCTAN, COS, SIN, TAN
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. Syntax result = ARCTAN ( expr, {expr1} ) 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 Reference ARCCOS, ARCSIN, COS, SIN, TAN
Assignment Statement Sets the value of an output or variable. Assigns the value of an
expression to a variable or property.
Syntax variable-name = expr or value 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-70
Total Page in this Chapter: 131
GCL+ Language Reference
11-71
Example 1 Assignment Statements
Variable Count as Integer Variable Total as Integer Variable Text as String Count = 5 Total = Count * 17.2 Text = “Hello World” & “ How are you?” Example 2 Sample_Program (ON)
//Sample Assignments Dampers = 50 Valve = Dampers + 40 Chiller = On Reference Mathematical Operators
AVERAGE Function Calculates the average value of a list of inputs or values. Syntax result = AVERAGE(expr { ,expr-n} ) Comment The result is a real value or integer depending on the inputs
expressions. The expr is a valid numeric expression. If the value of one expr is a real, the compiler expresses the result as a real. If the value of each expr is an integer, the compiler expresses the result as an integer.
You may type in avg or AVG and the compiler translates it to Average. This function replaces the GCL AVG function. Example 1
Average_Temp = Average(Room_1, Room_2, Room_3) Examples 2
Mean = Average(30, Value2, 10*(Value1+5.3)) Reference MIN, MAX
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-71
11-72
General Control Language (GCL+)
BETWEEN Status Operator Compares the value of an expression with two other values. Syntax expr BETWEEN value1 value2 Comments If the expr is greater than or equal >= value1 and less than or equal
, >=, = (greater than or equal to) < (less than) = 23 Then Start Cooling End If Reference Bitwise Operators, Logical Operators, Mathematical Operators,
String Operator, Status Operator
CONSTANT Statement Creates a user defined constant or array of constants. Syntax The three forms of valid syntax for CONSTANT are:
CONSTANT constname = constvalue CONSTANT constname = constvalue , {constvalue } CONSTANT constname =(constvalue, { constvalue }),( constvalue { , constvalue }) Comments The CONSTANT statement has the following parts: constname
The name of the constname follows standard variable naming conventions.
constvalue
The value of the constant constvalue may be an integer, floating point value or string. Data types may not be mixed in an array.
Elements
Elements define the number of entries in the constants array. Arrays may have a maximum of 2 dimensions. For example, the statement Lookup[3,2] refers to the element in the third row and second column of Lookup.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-76
Total Page in this Chapter: 131
GCL+ Language Reference
11-77
The user may enter Const and it translates to Constant. Version 2 GCL Table statements are accepted and converted to Constant. Example 1 Typical Statements Using CONSTANT
Constant Constant Constant Constant Constant Constant
Size = 10 Maximum = 88.5 Title = "This is the title" Text = "First", "Second", "Help", "Stop" Translate = 1,2,3,4,5,6,7,8,9,10 BigArray = (1,2,3,4,5),(1,2,3,4,5),(1,2,3,4,5)
Example 2 This code assigns constant values to the 6 elements in the CONSTANT Lookup. Then ConvF1 is assigned to Lookup[3,2] which is the constant in the third row and second column.
// Assigns values to the constants array Lookup // Equates ConvF to the element Lookup[3,2] Constant Lookup = (5,5), (10,100), (15,1000) ConvF1 = Lookup[3,2] // ConvF1 equals 1000 Reference VARIABLE, ASSIGNMENT, FOR
COS Function Calculates the cosine of a value. The input is specified in degrees. Syntax result = COS( expr ) Comments The result is a real number within the range of -1 to 1. The expression can be any real number. Example COS Function
MyNumber = Cos(30)
// Returns 0.866025
Reference SIN, TAN, ARCCOS, ARCSIN, ARCTAN
DATE System Variable Returns Date expressed as internally coded number: 01-JAN
through 31-DEC.
Syntax result = DATE Comments Both the DATE and TIME System Variables return an internally
coded number. These are typically used with Comparison Operators.
Example
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-77
11-78
General Control Language (GCL+) If Date = (01-Jul-2004) Then Start Fan End If If Date > (21-Jan-2004) AND (Date < 21-Apr-2004) Then Call Winter End If Reference TIME, Comparison Operators, System Variables
DAY System Variable Returns current day of year expressed as a integer from 1 to
365 (366).
Syntax result = DAY{(date_expr)} Comment If an optional date is passed as an argument, the day in the year of
that date is extracted.
Example 1 Stop Fan on Day 200 of Year
If Day = 200 Then Stop Fan Else Start Fan End If Example 2 Extract Day Of Year For Passed Date
Variable Value as Integer Value = Day(21-May-2003) // Value equals 141 Reference DAY, MINUTES, MONTH, MONTHDAY, SECONDS,
WEEKDAY, YEAR
DAYON Function Returns 1 (TRUE) if the specified date is ON in the Calendar object. Otherwise, it returns 0 (False). Syntax result = DAYON(Calendar , date-expr)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-78
Total Page in this Chapter: 131
GCL+ Language Reference
11-79
Comments The result is an integer number. Calendar references a specific
Calendar object, and date-expr is the Date to test. A date-expr can be an explicit date or a variable with a date returned by the built-in DATE function or any function that returns a date value. An explicit date is in the form DD-MMMYYYY, where DD and YYYY are numbers representing date and year respectively, and MMM is a three letter abbreviation for the month in question. The month abbreviation uses the first three letter of each month e.g. JAN for January and FEB for February etc. If a variable containing a date value is used, it should be declared as an Integer, as GCL stores dates internally as numbers.
Example 1 Stores 1 in Result if Cal1 is ON for 5-May-2004
variable Result as integer Result = DayOn(CAL1, 5-May-2004) Example 2 Stores 1 in Result if Cal1 is ON for current date
variable Result as integer Result = DayOn(CAL1, Date) Example 3 Stores 1 in Result if Cal1 is ON for current date (stored in myDate)
variable variable myDate = Result =
myDate as integer Result as integer Date DayOn(CAL1, myDate)
Reference DATE
DECIMAL Function Calculates the decimal fraction of a value. Syntax result = DECIMAL (expr) Comments The DECIMAL function result is a Real number. The expression is
any numeric expression. If the expression is an integer, the compiler converts it to a real.
Example Determines Decimal Fraction Of A Value
Result = Decimal(30.75) // Returns 0.75 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. Syntax result = DECIMALTIME
result = DECIMALTIME (expr)
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-79
11-80
General Control Language (GCL+) Comments The value returned is (hour * 100) + ((minute * 100) / 60)
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 DECIMALTIME function has an optional argument so you can convert TIME to DECIMALTIME. using a statement of the form : result = DECIMALTIME (TIME). The TIME value is converted into a DECIMALTIME value. Example Start fan if time is greater than 1270 (12:42)
If Decimaltime > 1270 Then Start Fan End If Example 2 Determine if the schedule will be on with 15 minutes
For example, if you want to know if the schedule is going to come on in 15 minutes, you can enter: Ifonce (DECIMALTIME(NextOn(sch1)) - DECIMALTIME) 30 Then Status = OFF Else Status = ON End If
HOURS HOURS can be used as a System Variable or as a Function. System Variable Returns the current hour as an integer between 0 - 23 Syntax System Variable result = HOURS Function Allows for evaluation of time as internally coded number in 0 to 23 military time format. HOURS also acts on an optional time expression and returns the current hour as an integer between 0 - 23 Syntax Function result = HOURS { (time-expr) }
The time-expr can be the following formats: •
9:00
•
Time
•
DecimalTime
Comments Do not confuse HOURS with the old GCL HOUR that was replaced
by DECIMALTIME.
Example 1 Start fan if hours greater than 12.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-91
11-92
General Control Language (GCL+) IF HOURS > 12 THEN START FAN END IF Example 2 Start fan based on a Schedule.
IF HOURS(LastOn(FanSchedule)) > 8 THEN START FAN END IF Example 3 Starts Fan Based on a Time Using HOURS
Function
IF HOURS(DECIMALTIME) >12 THEN START FAN END IF Reference DAY, WEEKDAY, MONTHDAY, DATE, TIME, MONTH
IF...THEN...ELSE...END IF Statement Conditionally executes a group of statements, depending on the value
of an expression.
Syntax The statement has the following syntax:
IF condition Then {statements} ELSEIF condition-n THEN {elseif-statements} ELSE {else-statements} END IF Comments The IF...THEN statement has the following parts: condition
Any logical expression that evaluates to TRUE or FALSE.
condition-n
Any logical expression that evaluates to TRUE or FALSE.
statements
One or more statements; executed if condition is TRUE.
elseifstatements
One or more statements; executed if condition is TRUE.
elsestatements
One or more statements separated by one or more spaces or on new lines; executed if no previous condition or condition-n was TRUE.
End If
Every IF requires a matching END IF.
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 expression may contain or be followed by line breaks.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-92
Total Page in this Chapter: 131
GCL+ Language Reference
11-93
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 Example 1 Conditionally executes statements based on the Outside Air Temperature (OAT)
If Oat > 30 Then Fan = On 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 If Oat < 20 Then Start Fan Elseif Oat > 30 Then Stop Fan Status = On 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:
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-93
11-94
General Control Language (GCL+) IF ‘OUTDOOR TEMP’ > 22.5 THEN START CHILLER DAMPERS = MIN END IF Example 4 IF statements may be nested as follows:
IF
ELSE
OCCUPIED THEN IF ROOM > 24 THEN START FAN, CHILLER ELSE STOP FAN END IF
STOP FAN, CHILLER END IF The previous statement executes in the following order: •
IF OCCUPIED is tested.
•
If True (OCCUPIED), IF ROOM > 24 is evaluated and tested.
•
If True (IF ROOM > 24), the fan and chiller START.
•
If False and the room is equal to or below 24 (ELSE), just the FAN will STOP.
•
If False (UNOCCUPIED), both fan and chiller STOP.
Although additional levels of nesting are possible, for program clarity, it is not generally recommended. Reference IF, END IF, ELSE, ELSEIF
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.
Syntax The statement has the following syntax:
IFONCE condition Then {statements} ELSEIF condition-n Then {elseif-statements} ELSE {else-statements} END IF
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-94
Total Page in this Chapter: 131
GCL+ Language Reference
11-95
Comments The IFONCE statement has the following parts: condition
Any logical expression than evaluates to TRUE or FALSE.
condition-n
The condition-n is any logical expression than evaluates to TRUE or FALSE.
statements
One or more statements; executed if condition is TRUE. The elseif-statement is one or more statements executed if condition is TRUE.
elsestatements
One or more statements; executed if no previous condition or condition-n was TRUE.
IFONCE statement
The IFONCE statement does not execute again until the expression first becomes FALSE. If ELSE is present, the statement executes every time except the first time the expression becomes TRUE.
End If
Every IFONCE must have a matching ENDIF.
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 expression may contain or be followed by line breaks. 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. Example 1 Turn a status flag on a 01:00.
IFONCE TIME = 01:00 THEN Status_Flag = On ENDIF Example 2 Change setpoint based on conditions.
//Changes setpoint based on the Outside Air Temperature // and whether the day is Tuesday IfOnce OAT > 30 Then FAN = ON End If IfOnce OAT > SETPOINT ElseIf OAT > SETPOINT ElseIf OAT > SETPOINT Else SETPOINT End If
30 And WEEKDAY = TUESDAY Then = 19 20 Then = 20 10 Then = 15 = 0
Reference IF, END IF, ELSEIF, ELSE
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-95
11-96
General Control Language (GCL+)
IntDate (New 3.40) Function The IntDate function converts an optional passed parameter representing the number of seconds from January 1, 1980 to the date using the yymmdd format. If no parameter is passed, IntDate returns the system date. Supported controllers include the enteliBUS, DSC and DAC controllers having 3.40 or newer firmware. This function is NOT supported on the enteliTOUCH. Syntax Result = IntDate {(T)} where T is the number of seconds from Jan. 1, 1980. 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: Result = IntDate() // brackets are optional when there is no parameter to be passed. 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. Example 1 Converting BV’s last written date to the yymmdd format Variable timeInSeconds as Integer Variable BVLastWrittenDate as Integer Variable systemDate as Integer 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-96
Total Page in this Chapter: 131
GCL+ Language Reference
11-97
//systemDate = Current controller Date. //ex:110705 is July 5, 2011 Example 2 Do something based on time comparison Variable X as Integer Variable Y as Integer X = IntDate(BV1.TimeOfLastWrite) Y = IntDate IfOnce X = Y then //When BV1 is written today //Do Something Endif Example 3 Enable Trend Log for 4 hours after an alarm is triggered Variable curDate as Integer Variable curTime as Integer Variable 4hoursInSec as Integer curDate = IntDate curTime = IntTime 4hoursInSec = 14400 //4hours = 4*60*60 = 14400 seconds IfOnce ('doorAlarmInput'= ON) then
'TrendLog.StartTime' = ToSeconds(curDate, curTime) ‘TrendLog.StopTime’ = ToSeconds (curDate, curTime)+ 4hoursInSec
End if
Reference IntTime, ToSeconds
IntTime (New 3.40) Function The IntTime function converts an optional passed parameter representing the number of seconds from January 1, 1980 to time using the hhmmss format. If no parameter is passed, IntTime returns the system time. Supported controllers include the enteliBUS, DSC and DAC controllers having 3.40 or newer firmware. This function is NOT supported on the enteliTOUCH. Syntax Result = IntTime {( T)} where T equals the integer number of seconds from Jan. 1, 1980. 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: Result = IntTime() // brackets are optional when there is no parameter to be passed.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-97
11-98
General Control Language (GCL+) 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). This hhmmss format can be assigned to a Real value such as an AV.Value. 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 a signed 32-bit value is accurate up to 10 digits. Supported controllers include enteliBUS, DSC / DAC families having 3.40 or newer firmware. Example 1 Converting BV’s last written time to the hhmmss format Variable timeInSeconds as Integer Variable BVLastWriteTime as Integer Variable systemTime as Integer 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 Example 2 Do something based on time comparison Variable Variable Variable Variable
X as Integer Y as Integer 5PM as Integer 6AM as Integer
5PM = 170000 //Represents 5:00:00PM 6AM = 60000 //Represents 6:00:00AM X = IntTime(BV1.TimeOfLastWrite) IfOnce ((X > 5PM) || (X < 6AM)) then //When BV1 is written between 5pm-6am //Do Something End if Example 3 Enable Trend Log for 4 hours after an alarm is triggered Variable curDate as Integer Variable curTime as Integer Variable 4hoursInSec as Integer
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-98
Total Page in this Chapter: 131
GCL+ Language Reference
11-99
curDate = IntDate curTime = IntTime 4hoursInSec = 14400 //4hours = 4*60*60 = 14400 seconds IfOnce ('doorAlarmInput'= ON) then
'TrendLog.StartTime' = ToSeconds(curDate, curTime) ‘TrendLog.StopTime’ = ToSeconds (curDate, curTime)+ 4hoursInSec //Smaller font used so previous code fits on one line
End if
Reference IntDate, ToSeconds
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
result = LASTOFF (schedule) Comments The result is the return value, an integer number. The schedule is a
reference to a Schedule object.
If there is no LASTOFF time, a value of 0 is returned. The GCL function Last_Off does not automatically convert to LASTOFF. Example 1 Stop the fan 1 hour after the LASTOFF time in SCH1.
IF (DECIMALTIME - 100) > DECIMALTIME(LASTOFF (SCH1)) THEN
STOP FAN END IF
Example 2 Returns the last time that SCH5 turned OFF
Variable TimeValue TimeValue = LastOff(SCH5) Reference LASTON, NEXTOFF, NEXTON, DECIMALTIME
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
result = LASTON (schedule ) Comments The result is the return value and is an integer number. The schedule is a reference to a Schedule object.
If there is no LASTON time, a value of 0 is returned.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-99
11-100
General Control Language (GCL+) The GCL function Last_On does not automatically convert to LASTON. Example 1 Stop the fan 1 hour after the LASTON time in SCH1.
IF (DECIMALTIME - 100) > DECIMALTIME(LASTON (SCH1)) THEN
//100 = 60 minutes STOP FAN END IF
Example 2 Returns the last time that SCH5 turned ON
Variable TimeValue TimeValue = LastOn(SCH5) Reference LASTOFF, NEXTON, NEXTOFF, DECIMALTIME
LEFT Function Returns a specified number of characters from the left side of a string. Syntax
result = LEFT( string-expr, length-expr ) Comments The result is a String. The string-expr is a valid string expression. The length-expr 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 string-expr, the entire string is returned. Example
OutString = Left("Hello World Now",5) // Returns "Hello" Reference RIGHT, MID, LENGTH, String Concatenation Operator
LENGTH Function Returns the length of a string. Syntax
result = LENGTH( string-expr ) Comments The result is an Integer number. The string-expr is a valid string
expression.
Example
Size = Length("Hello" & "World")
//Returns 10
Reference LEFT, RIGHT, MID, String Concatenation Operator
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-100
Total Page in this Chapter: 131
GCL+ Language Reference
11-101
LIMIT Function Limits the value of an object between specified low and high values. Syntax
result = LIMIT ( input-expr , low-expr , high-expr ) Comments The result is a Real number. The input-expr is an valid numeric expression. If the expression is an integer, the compiler converts it to a real. The low-expr and the high-expr are the same type as input-expr.
If the input-expr is between the two values, it is returned. If input-expr is lower than the low-expr, low-expr is returned. If input-expr is higher than high-expr, high-expr is returned. 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
result = LN( expr ) 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.
Example Natural log of 127.0.
MyNumber = Ln(127.0)
// Returns 4.84418
Reference LOG
LoadFromFlash (DAC/DSC only) Function Restores a saved to flash memory database to RAM in a DAC/DSC controller. Once the database is loaded into the controller, it begins operation of the loaded database. Syntax
LoadFromFlash
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-101
11-102
General Control Language (GCL+) 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.
Be careful when using the LoadFromFlash or SaveToFlash functions as it is possible to load the wrong database or to inadvertently overwrite the database saved in flash memory. These functions must be placed within a conditional statement (such as an IfOnce statement), so the controller does not execute the function every scan. 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.
Example The LoadFromFlash and SaveToFlash functions in GCL make it
possible to save or load the database to or from flash in a DAC/DSC controller. If 'Controller Mode' = "Config" Then // Load from flash when user hits button 16 IfOnce Lcd.KeyPress = 16 Then LoadFromFlash End If // Save to flash when user hits button 15 IfOnce Lcd.KeyPress = 15 Then SaveToFlash End If End If In this example, 'Controller Mode' is an MV object. It usually gets set by putting the Controller in Config/Menu mode through some key combination on the room controller. Reference SaveToFlash
LOG Function Calculates the log (base 10) of a value. Syntax
result = LOG( expr ) 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.
Example Log (base 10) of 127.0.
MyNumber = Log(127.0)
// Returns 2.1038
Reference LN
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-102
Total Page in this Chapter: 131
GCL+ Language Reference
11-103
Logical Operators (AND, NOT, OR, XOR) Operator Assess the relationships between objects and their values and states. Syntax
value1 operator value2 Comments The Logical Operators are:
•
AND
•
NOT
•
OR
•
XOR
The result of the operation is ON if TRUE(1) and OFF if FALSE(0). The Logical Operators may be used in an expression in an IF-THEN-ELSE-END IF statement or in a logical statement. Example Use of AND and NOT logical operators.
IF ROOM_TEMP AND ENABLE = NOT ON THEN START COOLING END IF Reference Bitwise Operators, Comparison Operator, Mathematical Operators,
String Operator, Status Operators
Mathematical Operators: ^, -, *, /, MOD, +, Operator Evaluates mathematical expressions. Syntax
(expr1) operator (expr2) Comments
The Mathematical Operators in order of precedence are:
^ (exponentiation) 2. - (negate) 3. * (multiply) 4. / (divide) The expression AV1 = 9/5 now gives a result of 1.8. Prior to 3.30, 1.
an integer division such as AV1 =9/5 gave a result of 1 and AV2 = 1/2 gave a result of 0.
5.
MOD
+ (add) 7. - (subtract)
6.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-103
11-104
General Control Language (GCL+) Mathematical expressions are evaluated from left to right. Enclosing part of an expression within parenthesis forces the contents contained in these parenthesis to be evaluated first. Example Mathematical expressions.
HEATING_VALVE = (RESET1 + 5) / 2 + SUPPLY - TEMP Reference Bitwise Operators, Comparison Operator, Logical Operators, String
Operator, Status Operators
MAX Function Returns the largest value in the list. Syntax
result = MAX( expr, expr1 { , expr-n } ) 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. Example Returns the largest value in a list of numbers.
MaxVal = Max(30, 40, 50, 10)
// returns 50
Reference AVERAGE, MIN
MID Function Extracts a substring from another string. Syntax
result = MID( string-expr, start-expr { , length-expr } ) Comments The result is a string. The string-expr is a valid string expression.
The start-expr is the expression for start position in the string-expr. 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. Example Extract a substring from a string.
OutString = Mid("Hello World Now", 7, 5) // Returns "World" Reference LEFT, RIGHT, LENGTH, String Concatenation Operator
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-104
Total Page in this Chapter: 131
GCL+ Language Reference
11-105
MIN Function Returns the smallest value in the list. Syntax
result = MIN( expr { , expr-n } ) 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. Example Returns the smallest value in a list of numbers.
MinVal = Min(30, 40, 50, 10) // returns 10 Reference AVERAGE, MAX
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
result = MINUTES { ( time-expr ) } Example 1 Start fan based on MINUTES system variable.
If Minutes = 1 Then Start Fan End If Example 2 Return MINUTES value of a time.
Value = Minutes(10:11)
// Returns 11
Reference DAY, MONTH, MONTHDAY, SECONDS, WEEKDAY, YEAR,
BETWEEN
MONTH System Variable Returns the month of year expressed as a number—1 through
12.
Syntax
variable = MONTH Example Stop fan based on month exceptions.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-105
11-106
General Control Language (GCL+) IF MONTH BETWEEN 7 8 THEN STOP FAN END IF Reference HOURS, DAY, WEEKDAY, MONTHDAY, DATE, TIME,
BETWEEN
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
result = MONTHDAY { ( date-expr ) } Comments The compiler does not convert the GCL Mday to MonthDay Example 1 Stop fan if it is the first day of the month.
If MonthDay = 1 Then STOP FAN END IF Example 2 Returns day of the month for 23-May-2002 as an integer.
Value = MonthDay(23-May-2002)
//Value equals 23
Reference WEEKDAY, MONTH, DAY, MINUTES, SECONDS, YEAR,
BETWEEN
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
result = NEXTOFF (schedule) Comments The Result is an integer such as 1245 which is equivalent to 12:45
PM. The schedule refers to a particular Schedule object. The compiler does not convert the GCL NEXT_OFF to NEXTOFF.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-106
Total Page in this Chapter: 131
GCL+ Language Reference
11-107
IF (DECIMALTIME(NEXTOFF(SCH5))-DECIMALTIME) 86 and Weekday = 1 Then Setpoint = 66 Print To EVR1 "OAT1 value >86 on a Monday (" & OAT1 &")" End If // You can also print the time, day, month etc. DoEvery 30M Print To EVR2 "AV1= " & AV1 & " at " & time & "," & date End Do
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-114
Total Page in this Chapter: 131
GCL+ Language Reference
11-115
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’.
PRINTSTATUS (DSC only) Function PrintStatus returns the number of characters that are left to be printed from any PRINT statements. It is used to ensure all the characters have been printed before trying to print more characters. A non-zero value indicates all the characters have not been sent out, and a value of zero means that all the characters have been sent out. 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. Example Print every 10 minutes if the print buffer is empty
The following GCL code will print every 10 minutes as soon as any previous characters have been printed.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-115
11-116
General Control Language (GCL+) If PrintStatus = 0 Then DoEvery 10M Print To EVR1 "The value of AV1 is " & AV1 End Do End If Using this code, the following string is printed every 10 minutes: "The value of AV1 is X", where X is the value of AV1. Reference Print To
READ (New 3.40) Function The Read() function allows GCL code to read from dynamically constructed object property references. Specifically this function allows the user to: •
Read object properties without hard-coding the references into the GCL code. (ex: av1 = Read ("av2") )
•
Access a value using a network data Name tag that is associated with an entry in a Bulk Data Exchange (BDE) object*. The Bulk Data Exchange (BDE) object provides a powerful and simple means to exchange data in an efficient and flexible manner.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-116
Total Page in this Chapter: 131
GCL+ Language Reference
11-117
*BDE object is available only on Supported Controllers. 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. Syntax READ accepts one string parameter and returns the reference's value. The format of the string parameter is either: A) String Parameter Format: Entry in a BDE (Bulk Data Exchange) object: “BDE:.” 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
(Possible previous change screen Bug DAC-3612 – also poor data) B) String Parameter Format: A local object property reference: “” For example: AV1 = READ (“AV2” )
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-117
11-118
General Control Language (GCL+) 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. Comments Read() behaves differently than if the reference was hard-coded into GCL, such as av1 = av2.Value. The value of the reference is read when Read() is called, but if the reference was hard coded, then the property is read at the start of each PG scan. Using Read() is a little slower, but it does allow the GCL code to dynamically construct the reference. Example 1 Read AV2 Value and assign the value to AV1 AV1 = Read(“AV2”) //The following statement is equivalent. //AV1=Read(“AV2.Value”) Example 2 Read OAT entry in GlobalVariables BDE object // The BDE prefix denotes that // the string following the colon // refers to a BDE entry name tag. av1 = Read("BDE:GlobalVariables.OAT") // GlobalVariables is the name of the BDE object // OAT is the data name tag of the entry in the BDE object //On the Receive Entries tab 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. Variable Variable Variable Variable Variable Variable Variable
total As Real averageval As Real minval As Real maxval As Real value As Real i As Integer test As String
total = 0 i = 0 ForAll BDE In "BDE*" value = Read ("BDE:" & BDE.Name & ".IAT")
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-118
Total Page in this Chapter: 131
GCL+ Language Reference
11-119
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 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. When Relinquishing a remote value, Data Exchange is used to write a "NULL" value to the remote panel, and thus relinquishing the remote value. The Relinquish command is like writing to a remote object in that each time the command is executed, a Write occurs. Syntax
RELINQUISH object1
{ ,object2 ...
,objectN }
Examples
Relinquish AO1, BO2 Reference STOP, START, SET, RESET
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-119
11-120
General Control Language (GCL+)
RESET Command Statement Resets the state of a particular object. Syntax
RESETvariable1 { ,variable2 ... ,variableN } Comments RESET performs the equivalent of a command reset operation on
objects. Reset is used to reset objects that have counters, timers and buffers. For example, RESET Clears a Trend Log, clears a Priority Array, and resets the Totalizer to zero. Example Use RESET as follows:
RESET OCCUPIED, STATUS // Following line clears the Trend Log data for TL1 RESET TL1
RIGHT Function Returns a specified number of characters from the right side of a
string.
Syntax
result = RIGHT ( string-expr, length-expr ) Comments The RIGHT function has the following parts: 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
OutString = Right("Hello World Now",3) // Returns “Now” Reference LEFT, MID, LENGTH, String Concatenation Operator
ROUND Function Rounds a real value to the specified number of decimal places. Syntax
result = ROUND ( input-expr { , decimal-expr } )
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-120
Total Page in this Chapter: 131
GCL+ Language Reference
11-121
Comments The ROUND function has the following parts: result
A real number.
input-expr
A valid numeric expression. If the expression is an integer, the compiler converts it to a real.
decimal-expr
An integer number from 0 to N that determines the number of decimal places to round the number. If a decimal-expr is not specified, it defaults to 0 and the compiler rounds the input expr to the nearest whole number.
Example Typical uses of ROUND function
TEMP = ROUND (TEMPERATURE) MyNumber = Round(123.5) MyNumber = Round(123.432, 2)
// Returns 124 // Returns 123.43
Reference TRUNCATE, DECIMAL
SaveToFlash (DAC/DSC only) Function Saves the current RAM database to a DAC/DSC controller’s flash memory. Once saved to flash memory, the database is safe from loss due to power failures. Syntax
SaveToFlash Comments If there is a database currently saved to flash, it will be overwritten
when the SaveToFlash function is used.
Be careful when using the LoadFromFlash or SaveToFlash functions as it is possible to load the wrong database or to inadvertently overwrite the database saved in flash memory. These functions must be placed within a conditional statement (such as an IfOnce statement), so the controller does not execute the function every scan. 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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-121
11-122
General Control Language (GCL+) Example The LoadFromFlash and SaveToFlash functions in GCL make it possible to save or load the database to or from flash in a DAC/DSC controller.
If 'Controller Mode' = "Config" Then // Load from flash when user hits button 16 IfOnce Lcd.KeyPress = 16 Then LoadFromFlash End If // Save to flash when user hits button 15 IfOnce Lcd.KeyPress = 15 Then SaveToFlash End If End If In this example, 'Controller Mode' is an MV object. It usually gets set by putting the Controller in Config/Menu mode through some key combination on the room controller. 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. Syntax Scale accepts two (x,y) pairs..
result = SCALE ( input-expr , bias-expr , x1-expr , y1-expr , x2-expr , y2-expr ) Comments The SCALE function has the following parts:
input-expr , bias-expr ,
The input-expr and bias-expr define the values to scale using 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
x1-expr , y1expr , x2-expr , y2expr
The first (x,y) data pairs. The second (x,y) data pairs.
The maximum input-expr will be automatically limited to numbers between x1 and x2.. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-122
Total Page in this Chapter: 131
GCL+ Language Reference
11-123
Example Scale an input expression
Value = Scale ( Input, 2, 0 , 0, 10, 100) //Value for Input of 0=2, 5=52, 10=102, 25=102 //Value for Input of -5=2, -25=2
SECONDS System Variable Returns current number of seconds past the minute as an
integer from 0 to 59. Syntax
result = SECONDS Example
Sec_Val = Seconds // Return integer from 0 to 59 If Seconds = 1 Then Start Fan End If Reference MINUTES, DAY, MONTH, WEEKDAY, MONTHDAY, YEAR,
BETWEEN
SetCalendar (no longer available) The SetCalendar function is no longer available in GCL+. The Setup tab of the Menu (MN) objects provides a Set Calendar function for use with the DRP-T0 room controller.
SetDate (New 3.40) Function The SETTIME and SETDATE functions provide the capability to set the Time and Date on the controller through GCL without user input from the LCD/Keypad. Currently there is a GCL SetTimeDate() function, but this works with the LCD and Keypad and requires the user to manually enter the Time/Date. The SETTIME and SETDATE functions return a value of 1 if setting time/date succeeds, otherwise returns 0. Syntax Result = SetDate {( D)} where D is in date format, e.g. SetDate(8-May-2011) will set the date to May, 8 2011 Result = SetDate(Day, Month, Year) 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.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-123
11-124
General Control Language (GCL+) 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 1 Set date on a controller using input in the dd-mmm-yyyy format Variable Result as Integer Result = SetDate(23-May-2011) //Sets the date to May 23, 2011
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
Example 3 Set date using variable for Day, Month, Year Variable Result As Integer Variable SystemTime as Integer Variable DayVal As Integer Variable MonthVal As Integer Variable YearVal As Integer DayVal = 15 MonthVal = 9 YearVal = 2011 Result = SetDate (DayVal, MonthVal, YearVal) SystemTime = IntDate //Sets date to September 15, 2011 //System Time is 110915 which is in the yy-mm-dd format
Reference SetTime, IntDate
SetSchedule (DAC only) Function SetSchedule allows you to create, delete and adjust time blocks for a Schedule object, using the keypad on the Room Controller that the function is called from. The SetSchedule function is capable of altering any Schedule object in the controller. The keypad must have at least 8 keys to use the SetSchedule function.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-124
Total Page in this Chapter: 131
GCL+ Language Reference
11-125
The SetSchedule function displays a menu on the LCD of a Room Controller. The following block diagram illustrates how to navigate through this menu. SetSchedule Flow Chart:
Key 5 ↓ Monday
→ ←
↑↓- Adjust
On time
→ ←
↑↓- Adjust
→ ←
↑↓- Adjust
Off time
→ ←
“Add”*
→
Next day…
On time
→ ←
↑↓- Adjust
Off time
→ ←
“Add”*
→
Next day…
↑↓ Tuesday
↑↓
* “Add”
↑↓
→
Sunday
Legend:
← (Left) Key 6
→ (Right) Key 7
↑ (Up) Key 3
New On
↑↓- Adjust
→ ←
New Off
↑↓- Adjust
→
↓ (Down) Key 2
The following points relate to using the SetSchedule menu: • When the SetSchedule menu is first entered, the first day that is displayed is Monday. Pressing the Up and Down buttons will scroll through the different days. Pressing the Right or Left buttons will scroll through the ON/OFF times for the selected day. •
New time blocks can be added at the end of the ON/OFF times of all the current time blocks as depicted in the previous diagram by the Add block.
•
Note: Abutting/Overlapping time blocks are automatically merged into a single block.
•
Schedule blocks will be ‘deleted’ by adjusting ON/OFF times to be the same value.
Syntax SetSchedule(Keypress, # of SCH object) Keypress
Identifies the number relating to the function command that you want the function to execute.
# of SCH object
Defines the object number of the Schedule that is referenced when the SetSchedule function is called.
Comments The Keypress parameter tells the function what subfunction to
perform and the # of SCH object parameter tells the function what schedule object to perform the function on. The Keypress parameter can be the keypress property of the LCD object, a variable, or an actual number.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-125
11-126
General Control Language (GCL+) The following table lists the purpose of each number that can be used as the Keypress parameter for the SetSchedule function: SetSchedule Keypress Parameter Subfunction Number
Purpose
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
Example 1 The keypress property of the LCD object is used as a Keypress
parameter.
// Uses Schedule 1 If Lcd0.keypress 0 then SetSchedule(Lcd0.KeyPress, 1) 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. In Example 2, key # 1 starts the function on the 3rd SCH object.
Example 2 Key #1 starts the function on Schedule 3
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. Reference FORMAT, SETTIMEDATE
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-126
Total Page in this Chapter: 131
GCL+ Language Reference
11-127
SetTime (New 3.40) Function The SETTIME and SETDATE functions provide the capability to set the Time and Date on the controller through GCL without user input from the LCD/Keypad. Currently there is a GCL+ SetTimeDate() function, but this works with the LCD and Keypad and requires the user to manually enter the Time/Date. The SETTIME and SETDATE functions return a value of 1 if setting time/date succeeds, otherwise returns 0. Syntax Result = SetTime {( T)} where T is an integer and in military time. SetTime(1430) sets the time to 2:30 p.m. Result = SetTime(H,M) where H = hours, and M = minutes. SetTime(14,30) will set the time to 2:30 p.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. A time of 24:00 is treated as 00:00 This means that both 0000 and 2400 denote midnight. 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 1 Set time on a controller when BV turns ON Variable Result as Integer Variable CurTime as Integer IfOnce (BV1 = ON) then Result = SetTime(1525) //Sets time to military time of 15:25 (3:25 p.m.) //Result returns a value of 1 //indicating a valid time was set End If CurTime =IntTime //CurTime should have an integer value representing the //current controller time in the hhmmss format //ex:152500
Example 2 Set time using variables for hours and minutes //Assume and does Variable Variable Variable Variable
Total Pages in this Chapter: 131
the following code is within a conditional //branch get executed every PG scan Result as Integer Hrs as Integer M as Integer CurTime as Integer
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-127
11-128
General Control Language (GCL+) 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
Example 3 SetTime returns 0 when invalid input is detected //Assume the following code is within a conditional //branch and does get executed every PG scan Variable Result as Integer 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
Reference SetDate, IntTime
SetTimeDate (DAC only) Function SetTimeDate puts a Room Controller into Clock Mode. The clock mode allows the user to set the time and date of the local controller using the keypad. The keypad must have at least 8 keys to allow setting of the Time and Date. See Appendix E Working with MS/TP and LINKnet. Syntax SetTimeDate(Keypress) Keypress
Identifies the number relating to the function command that you want the function to execute.
Comments The SetTimeDate function is very similar to the SetSchedule
function. The only difference is that it is setting the time and date and not the Schedule object start and stop times. The Keypress parameter tells the function what subfunction to perform. The Keypress parameter can be the keypress property of the LCD object, a variable, or an actual number.
The following table lists the purpose of each number that can be used as the Keypress parameter for the SetTimeDate function:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-128
Total Page in this Chapter: 131
GCL+ Language Reference
SetTimeDate Keypress Parameter Subfunction Number
11-129
Purpose
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.
Reference FORMAT, SETSCHEDULE
SIN Function Calculates the sine of a value. The input is specified in degrees. Syntax
result = SIN ( expr ) 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.
Example SIN Function
MyNumber = Sin(30)
// Returns 0.5
Reference: COS, TAN, ARCCOS, ARCSIN, ARCTAN
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-129
11-130
General Control Language (GCL+)
SQRT Function Calculates the square root of a value. Syntax
result = SQRT (expr) 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. Example Calculate a square root.
AIR = 2670 * SQRT (PRESSURE) Reference Mathematical Operators
START Command Statement Turns the state or value of each object property in the list
to ON (1). Syntax
START variable1 { ,variable2 ... ,variableN } Example This Command can set values or an object property.
START PUMP, BOILER, FAN, AHU1, AHU2 Reference: STOP, RESET, RELINQUISH
String Concatenation Operator & Operator Combines two or more string expressions. Syntax
string-expr1 operator string-expr2 Comments The result of the operator will be a single string formed by combining the strings.
When a variable is declared As String but without an explicit dimension, then by default, it holds a maximum of 128 characters. A statement such as Variable Outstring as String[30] may provide a variable large enough for the situation. In some situations, controller RAM memory must be conserved. A string expression cannot contain a ampersand character or a quote character inside the string-expr. String Expressions such as "&&&&" or " 1_"First_1 " are invalid.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-130
Total Page in this Chapter: 131
GCL+ Language Reference
11-131
Example Concatenation
Variable Outstring As String[30] Outstring = "system " & "printer = " & "available" // result is Outstring equals // "system printer = available" Reference Bitwise Operators, Comparison Operator, Logical Operators,
Mathematical Operators, Status Operators
STOP Command Statement Turns the state or value of each object property in the list
to OFF (0). Syntax
STOP variable1 { ,variable2 ... ,variableN } Example This Command can set values or an object property.
STOP PUMP, BOILER, AHU1, AHU2 Reference: START, RESET, RELINQUISH
SUB...END SUB Statement Creates a user defined subroutine. Syntax The following lines define a subroutine.
SUB sub-name { ( argument1 { As type } { , argumentN { As type } } ) } { As type } { statements } sub-name = expr EXIT SUB { statements } sub-name = expr END SUB STATEMENT(S) END SUB, CALL Comments The SUB statement has the following parts:
Total Pages in this Chapter: 131
sub-name
The Name of the subroutine follows standard variable naming conventions.
argument1
The argument to the subroutine is optional. It may be an entire object or any property of an object. There can be arguments defined up to argumentN. Note: You cannot have arrays as arguments in a subroutine.
type
The type of the argument is optional. Type may be one of Integer, Real, String or object-type. Object-type is one of the
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-131
11-132
General Control Language (GCL+) standard object acronyms such as AI, EV etc. statements
The subroutine executes groups of statements within the SUB.
sub-name =expr
The subroutine may have an optional return value. If the sub_name is assigned an optional Type such as Integer, then a value may be assigned to the sub-name.
EXIT SUB
This keyword causes an immediate exit from the SUB.
END SUB
Every SUB must have an END SUB. The compiler converts the GCL statement RETURN to END SUB.
Use subroutines for the following: •
Eliminate repeated code segments required in a number of places throughout a program; or,
•
Create additional GCL+ functions or custom application programs.
To call a subroutine, enter the name of the subroutine in a statement or program line. Using CALL before the subroutine name is optional but is recommended as it makes the logic of the program clearer. 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 In this example, PG3 is treated as a subroutine. The program execution leaves PG1 to execute PG3, and then returns to the line immediately following CALL. After PG3 executes, the following line of PG1 (line 2) executes. 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
Sub Absolute(Value As Real) As Real If Value < 0 Then Absolute = -Value Else Absolute = Value End If 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-132
Total Page in this Chapter: 131
GCL+ Language Reference
11-133
// 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 Example 4 The following program uses a subroutine to change the values of three AO objects. // subroutine changes output value of three AO objects Variable res1 Variable res2 Variable res3
res1 = fred (anout1, 10) res2 = fred (anout2, 20) res3 = fred (anout3, 30) Sub fred (analogOut As "AO" Object , int As Integer) As Real analogOut = int analogOut.Description = "This one" & analogOut fred = analogOut End Sub Reference CALL, ENDSUB,
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-133
11-134
General Control Language (GCL+)
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
result = SUNRISE { ( date-expr ) } 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. On a DSC/DAC controller, the UTC Enable setting is no longer required in the calculations for the Sunrise and Sunset functions. The UTC Offset setting in the DEV object is still used. Enter a signed offset in minutes in the UTC Offset field. If no date is specified, the current date is used. The result returned is (hour * 100) + ((minute * 100) / 60) For example, a time of 13:42 returns an integer value of 1370. 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
Variable TimeValue As Integer TimeValue = DecimalTime IfOnce TimeValue = 1 Then SunriseTime = Sunrise (Date) End If IfOnce TimeValue > SunriseTime Then Lights = Off End If 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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-134
Total Page in this Chapter: 131
GCL+ Language Reference
11-135
Syntax
result = SUNSET { ( date-expr ) } 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. On a DSC/DAC controller, the UTC Enable setting is no longer required in the calculations for the Sunrise and Sunset functions. The UTC Offset setting in the DEV object is still used. Enter a signed offset in minutes in the UTC Offset field. If no date is specified, the current date is used. The result returned is (hour * 100) + ((minute * 100) / 60) For example, a time of 13:42 returns an integer value of 1370. 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
{ output = } SWITCH ( output, input-expr, on-expr, off-expr )
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-135
11-136
General Control Language (GCL+) Comments SWITCH simulates the operation of a conventional ON-OFF thermostat. It provides a deadband function so that an object does not continuously switch ON and OFF based on a specific value.
The SWITCH function has the following parts: output
SWITCH turns an output variable ON or OFF. SWITCH may be assigned like a function, but this is not required as Switch changes the output (first argument) without an assignment.
input-expr
The input expression is the analog value that switches the binary output ON or OFF.
on-expr
The output switches ON when the input reaches on-expr value.
off-expr
The output switches OFF when the input reaches the off-expr value.
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) Examples 2 Switch can be used as follows:
HTG_PUMP = SWITCH (HTG_PUMP, HEATING_VALVE, 20, 5) Examples 3 Switch can be used as follows:
// these two following lines are equivalent Switch (VALVE, CONTROLLER, 10, 20) Valve = Switch (Valve, Controller, 10, 20) Reference START, STOP
System Variable System Variable Store system information such as time and date for use by all the programs on a controller. Comments System Variables:
•
DATE (internally coded number)
•
DAY
•
DECIMALTIME
•
HOURS (GCL was HOUR)
•
MINUTES
•
MONTHDAY (GCL was MDAY)
•
MONTH
•
SECONDS
•
SUNRISE
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-136
Total Page in this Chapter: 131
GCL+ Language Reference •
SUNSET
•
TIME
•
WEEKDAY
•
YEAR
11-137
The DATE returns an internally coded number. The DATE is typically used with Comparison Operators. The System Variable may be used in an expression that is in an IF-THEN-ELSEEND IF statement or a logical statement. Reference IF-THEN-ELSE-END IF, Comparison Operators, Logical Operators
TAN Function Calculates the tangent of a value. The TAN function is SIN/COS. The
input is specified in degrees. Syntax
result = TAN ( expr ) 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.
Example TAN Function
MyNumber = Tan(45) // Returns 1 Reference SIN, COS, ARCCOS, ARCSIN, ARCTAN
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.
Reference IF, IFONCE, END IF, ELSE, ELSEIF
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-137
11-138
General Control Language (GCL+)
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
IF TIME BETWEEN 730 1600 THEN START FAN END IF Reference DATE, Comparison Operators, System Variables
ToSeconds (New 3.40) Function The ToSeconds function converts date and time integer parameters to the time in seconds from January 1, 1980. The date has to be in the yymmdd format and the time has to be in the hhmmss format. ToSeconds( date, time ) is the inverse of IntTime and IntDate functions. When modifying a time or date setting by adding or subtracting numbers using GCL, numbers should first be converted into seconds from January 1st, 1980 using ToSeconds(). It is a bad practice to add/subtract numbers in the yymmdd or hhmmss format. For example, when adding 4 hours to 11PM of New year’s eve, it will cause error in the year, month and date if 40000 was simply added to the 230000. Hour should not be larger than 24, and the year, month and date have to be changed as well. Supported controllers include the enteliBUS, DSC and DAC controllers having 3.40 or newer firmware. This function is NOT supported on the HMI. Syntax Result = ToSeconds {(date), (time)} Where: Date is the integer value in the yymmdd format, and time is the integer value in the hhmmss format. Comments On supported controllers, GCL now accepts TimeDate properties which are stored as 32-bit signed integers, representing 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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-138
Total Page in this Chapter: 131
GCL+ Language Reference
11-139
Example 1 Proving that ToSeconds( date, time ) is the inverse of IntTime & IntDate Variable Variable Variable Variable
TimeInSeconds as Integer TimeVar as Integer DateVar as Integer Result as Integer
TimeInSeconds = bv1.TimeOfLastWrite TimeVar = IntTime(TimeInSeconds) DateVar = IntDate(TimeInSeconds) Result = ToSeconds(DateVar,TimeVar) //Result is the same as TimeInSeconds Example 2 Enable Trend Log for 4 hours after an alarm is triggered Variable curDate as Integer Variable curTime as Integer Variable 4hoursInSec as Integer curDate = IntDate curTime = IntTime 4hoursInSec = 14400 //4hours = 4*60*60 = 14400 seconds IfOnce (‘doorAlarmInput’)= ON) then ‘TrendLog.StartTime’ = ToSeconds(curDate, curTime) ‘TrendLog.EndTime’ = ToSeconds(curDate,curTime) + 4hoursInSec Reference IntDate, IntTime
TRUNCATE Function Removes the decimal part of a real number. Syntax
result = TRUNCATE ( expr ) Comments The result is an Integer. The expr is a valid numeric expression. If
the expression is an integer, the compiler converts it to a real.
Example
MyNumber = Truncate(30.92)
// Returns 30
Reference ROUND, DECIMAL
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-139
11-140
General Control Language (GCL+)
VARIABLE (String Variable Syntax Corrected) Statement Creates a user defined local variable or array. A VARIABLE is a
local user defined array and cannot be accessed outside of the program.
Syntax The following is valid:
VARIABLE local-name { [{elements} {, elements} ]} [ As type ] VARIABLE local-name { [elements] } [As String] { [elements] } Comments The VARIABLE statement has the following parts: local-name
The name of the VARIABLE follows standard variable naming conventions.
elements
Define the number of elements in the array. Arrays may have a maximum of 2 dimensions. The dimensions are enclosed in square parenthesis and must be separated by a comma if there are two elements. With a string variable, the [As String] { [elements] } syntax defines the number of bytes in each element in the array. If this parameter is not used, 128 bytes is used by default.
type of variable
The type is optional and may be Integer, Real or String. When we declare a variable, we define the data type. Data type indicates the kind of data that a variable may hold. The data type defaults to real if no type is declared. Real numbers would be used if you require fractions of a number. 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 38 38 between -1*10 and 1*10 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 A String is a variable data type that holds text. A string is a sequence of characters typically letters , digits or punctuation. The syntax for a String Variable differs from that for a Real or an Integer variable.
Typical variable declaration statements have the following forms: VARIABLE local-name [ As type ] VARIABLE local-name [elements ] [ As type ] VARIABLE local-name [elements , elements ] [ As type ] VARIABLE local-name [As String] { [elements] } VARIABLE local-name { [elements] } [As String] { [elements] }
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-140
Total Page in this Chapter: 131
GCL+ Language Reference
11-141
When a variable is declared As String but without an explicit dimension, it holds by default a maximum of 128 characters. One character is equal to one byte of memory, so a declared string that does not have a size defined will take up 128 bytes of memory for each element. A statement such as Variable OutString As String[40] may provide a variable large enough for a particular situation. This statement defines a single string with a length of 40 bytes and conserves controller RAM memory. A string expression cannot contain an ampersand character or a quotes character inside the string-expr. Although, it is possible to define two dimensional arrays of strings, you need to be careful as it is easy to use up the controller RAM memory. A single program is limited to a maximum allowable size of 5.5K or 10 K in a DAC depending on the hardware revision. See the Program Size section on page 11-45 in this document. VARIABLE local-name { [{elements} {, elements} ]} [As String] { [elements] } For example,: the statement Variable X[10,10] As String[40] would use require 4000 bytes of memory. 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. Example Typical uses of the VARIABLE statement:
// Following defines an single integer local variable Variable Count As Integer // Following defines a integer local variable // with space for 20 integers Variable Counter[20] As Integer // Following defines a single element // Local string variable Title // With length of 40 characters Variable Title As String[40] Title = “Electric ceiling fans in AUTO mode” // Following defines a local string variable // With 40 elements each with space for // The default 128 characters // Reserves 5120 bytes in total Variable Title[40] As String // Following defines a 10 by 10 array of reals Variable Data[10,10] As Real Reference CONSTANT
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-141
11-142
General Control Language (GCL+)
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
result = WEEKDAY { (date-expr ) } 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 1 The following runs a fan from Tuesday to Thursday.
If Weekday Between 1 5 Then Start Fan End If Example 2 Use the WEEKDAY system variable to express a day (21-May2003) as an integer.
Value = Weekday(21-May-2003) Example 3 Use the WEEKDAY system variable to run Fan6 on each Monday.
If Weekday = 1 Then Start Fan6 End IF Reference HOURS, DAY, MONTHDAY, DATE, TIME, MONTH
Write (New 3.40) Function The Write function allows GCL code to write to dynamically constructed object property references. The function takes 2 parameters; one for target property and the other for source property or value. If the write was successful, the function returns 1 otherwise 0. Specifically this function allows the user to write to object properties without hard-coding the references into the GCL code. Syntax Write() is used to write to a property. Write() accepts one string parameter enclosed with double quotes and a value preceded by a comma. String Parameter Format: A local property reference “”, For example: BV1 = Write("AV1",AV2)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-142
Total Page in this Chapter: 131
GCL+ Language Reference
11-143
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. Double quotes are required for the target property only. 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. Example 1 Write to a local property reference using another local property reference Variable WriteOK as Integer //WriteOK = Write("TargetAV", SourceAV) //WriteOK becomes 1 if the write was successful //and 0 if the write was unsuccessful. Example 2 Write to a a local property reference using an integer value Variable WriteOK as Integer Variable WriteOK2 as Integer WriteOK = Write("AV1", 60) //Write a value of 60 to AV1 WriteOK2 = Write("BV1",1) //Write ON value to BV1
XOR Logical Operator Returns TRUE if one expression is true and the other is
FALSE.
Syntax
(expr1) XOR (expr2) Comments Start the FAN if either PUMP1 or PUMP2 is on, but stop the FAN if
both PUMP1 and PUMP2 are on.
Total Pages in this Chapter: 131
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-143
11-144
General Control Language (GCL+) Example Start or stop a fan depending on status of Pump1 and Pump2.
If Pump1 Xor Pump2 Then Start Fan Else Stop Fan End If
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
result = Year { ( date-expr ) } Example Use YEAR system variable.
Value = Year(21-May-2003) If Year > 2001 Then Call Calculations02 End IF
// Returns 2003
Reference MONTH, MONTHDAY, WEEKDAY, DAY, DATE, TIME,
HOURS, MINUTES, SECONDS
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-144
Total Page in this Chapter: 131
Index GCL+
11-145
Index GCL+ —A —
ABS · 11-68 AND · 11-68 ARCCOS · 11-68 ARCSIN · 11-69 ARCTAN · 11-69 Assignment = · 11-69 AVERAGE · 11-70
—B —
BDE Read · 11-115 BETWEEN · 11-71 Bitwise Operators · 11-72 table listing · 11-25 blank space GCL+ program · 11-60 branching to a program line · 11-38
—C —
CALL · 11-73 Commands RELINQUISH · 11-118 RESET · 11-119 START · 11-129 STOP · 11-130 table listing · 11-20 Comment · 11-74 commenting programs · 11-31 Comparison Operators · 11-75 table listing · 11-24 CONSTANT · 11-75 COS · 11-76
—D —
DATE · 11-77 DAY · 11-77 DAYON · 11-78 DECIMAL · 11-78 DECIMALTIME · 11-79 delimited user defined names · 11-46 DEWPOINT · 11-80 DOEVERY · 11-33, 11-80 equivalent · 11-33
—E —
Editor for GCL+ · 11-29 ELSE · 11-82 ELSEIF · 11-82 END · 11-82 END FOR · 11-83 END IF · 11-83 END SUB · 11-83 ENTHALPY · 11-83
Total Pages in this Chapter: 131
execution of programs · 11-36 to 11-40 execution order · 11-36
—F —
FOR...END FOR · 11-84 FORALL · 11-85 FORMAT (Room Controller) · 11-88 Function DECIMAL · 11-78 DEWPOINT · 11-80 function keys GCL+ Editor · 11-29 Functions · 11-20 ABS · 11-68 ARCCOS · 11-68 ARCSIN · 11-69 ARCTAN · 11-69 AVERAGE · 11-70 COS · 11-76 DAYON · 11-78 ENTHALPY · 11-83 IntDate · 11-95 IntTime · 11-96 LASTOFF · 11-98 LASTON · 11-98 LEFT · 11-99 LENGTH · 11-99 LIMIT · 11-100 LN · 11-100 LOG · 11-101 MAX · 11-103 MID · 11-103 MIN · 11-104 NEXTOFF · 11-105 NEXTON · 11-106 POWERUP · 11-110 PRINT · 11-100, 11-110 PRINTSTATUS, DSC only · 11-114 Read · 11-115 RIGHT · 11-119 ROUND · 11-119 SaveToFlash, DAC/DSC only · 11-120 SCALE · 11-121 SetDate · 11-122 SetTime · 11-126 SIN · 11-128 SQRT · 11-129 SWITCH · 11-134 table listing · 11-20 TAN · 11-136 ToSeconds · 11-137 TRUNCATE · 11-138 Write · 11-141
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-145
11-146
General Control Language (GCL+)
Functions (Room Controller) FORMAT · 11-88 SETTIMEDATE · 11-127
—G —
GCL · 11-4 to 11-65 GCL Timeout · 11-43 GCL+ Bitwise Operators · 11-25 blank space · 11-60 branching to subroutines · 11-39 CALL · 11-73 code usage to avoid · 11-35 Commands · 11-20 comment statements · 11-48 Comparison Operators · 11-24 compiling programs · 11-59 to 11-65 conditional branching · 11-40 CONSTANT statement · 11-75 DATE · 11-77 DAYON · 11-78 DECIMAL · 11-78 DECIMALTIME · 11-79 delimited user defined names · 11-46 END DO · 11-82 END FORALL · 11-83 END IF · 11-83 ENTHALPY · 11-83 error status codes · 11-59 execution error · 11-63 execution order · 11-36 execution trace · 11-65 function keys Editor · 11-29 Functions · 11-20 green dot · 11-65 invalid syntax · 11-61 Language Reference · 11-66 to 11-143 Language Reference · 11-66 Logical Operators · 11-23 Mathematical Operators · 11-24 missing statement · 11-64 names defined by user · 11-46 new code versus 3.10 GCL in a table · 11-10 new or modified code in a table · 11-8 operator precedence · 11-26 program flow · 11-33 program line name · 11-47 program status column · 11-59 programming execution · 11-36 to 11-40 inputs to GCL+ programs · 11-49 to 11-58 programming considerations · 11-41 to 11-49 programming practice recommendations · 1131 to 11-36 statements · 11-19 Status Operators · 11-23
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-146
String Concatenation Operators · 11-25 subroutine branching · 11-39 syntax valid with no undefined names · 11-60 System Variables listed in table · 11-25 time-based functions · 11-33 undefined word · 11-62 yellow octagon with a cross · 11-61 GCL+ Editor · 11-29 mouse functions in a table · 11-30 GCL+ Language Reference · 11-66 GCL+ Language Summary tables listing · 11-18 to 11-28 General Control Language · 11-4 to 11-65, See GCL GOTO · 11-89 GOTO suggested usage · 11-38 green dot in GCL+ program · 11-65
—I —
IF THEN ELSE END IF · 11-91 IFONCE THEN ELSE END IF · 11-93 IntDate · 11-95 integer variable data type · 11-139 IntTime · 11-96
—L —
Language Reference for GCL+ · 11-66 to 11-143 LASTOFF · 11-98 LASTON · 11-98 LEFT · 11-99 LENGTH · 11-99 LIMIT · 11-100 LN · 11-100 LOG · 11-101 Logical Operator AND · 11-68 NOT · 11-106 Logical Operators · 11-102 OR · 11-110 table listing · 11-23 XOR · 11-142 Looping FOR END FOR · 11-84 FORALL · 11-85
—M —
Mathematical Operators · 11-102 table listing · 11-24 MAX · 11-103 MID · 11-103 MIN · 11-104 MINUTES · 11-104 MONTH · 11-104 MONTHDAY · 11-105
—N —
NEXTOFF · 11-105
Total Page in this Chapter: 131
Index GCL+ NEXTON · 11-106 NOT · 11-106
—O —
object property Read function · 11-115 Write function · 11-141 Objects as input to a GCL program · 11-50 field access through GCL+ · 11-51 properties listed in a table · 11-53 to 11-58 OFF · 11-107 OFFFOR · 11-33, 11-107 brackets usage · 11-36 equivalent · 11-34 ON · 11-108 ONFOR · 11-33, 11-109 brackets usage · 11-36 equivalent · 11-34 Operators Bitwise · 11-72 Bitwise Operators · 11-25 Comparison Operators · 11-24, 11-75 Logical Operators · 11-23, 11-102 Mathematical Operators · 11-24, 11-102 Status Operators · 11-23 String Concatenation · 11-129 String Concatenation Operators · 11-25 System Variables · 11-135 Operators Status CHANGED · 11-73 OR · 11-110
—P —
POWERUP · 11-110 PRINT · 11-100, 11-110 ASC II, any from DSC · 11-112 PRINTSTATUS, DSC only · 11-114 program inputs · 11-49 line name · 11-47 Program Inputs · 11-49 programming block programming · 11-32 branching to a program line · 11-38 commenting · 11-31 compiling · 11-59 to 11-65 considerations · 11-41 to 11-49 data update during program execution · 11-36 delimited user defined names · 11-46 execution · 11-36 to 11-40 formatting · 11-31 GCL Timeout · 11-43 GCL+ Language Reference · 11-66 to 11-143 halted program · 11-42 Idle program · 11-42 indenting · 11-31
Total Pages in this Chapter: 131
11-147
inputs to GCL+ programs · 11-49 to 11-58 PG object state descriptions · 11-42 PG object value descriptions · 11-41 properties, table of common read / write · 1153 to 11-58 recommendations · 11-31 to 11-36 spacing · 11-31 syntax errors · 11-43 properties common read / write properties in a table · 1153 to 11-58
—R —
Read · 11-115 real variable data type · 11-139 Recommended Programming Practice · 11-31 to 11-36 red octagon with a cross in GCL+ program · 11-63 RELINQUISH · 11-118 RESET · 11-119 RIGHT · 11-119 ROUND · 11-119
—S —
SaveToFlash , DAC/DSC only · 11-120 SCALE · 11-121 SECONDS · 11-122 SetDate · 11-122 setpoint example, call a subroutine to set setpoint · 1139 example, increment a setpoint every 10 minutes · 11-81 use GCL+ to set CO setpoint · 11-51 SetTime · 11-126 SETTIMEDATE (Room Controller) · 11-127 SIN · 11-128 SQRT · 11-129 START · 11-129 Statement Assignment · 11-69 IF THEN ELSE END IF · 11-91 Statements CALL · 11-73 Command · 11-74 Comment · 11-74 CONSTANT · 11-75 ELSE · 11-82 ELSEIF · 11-82 END · 11-82 END FOR · 11-83 END SUB · 11-83 FOR END FOR · 11-84 FORALL · 11-85 GOTO · 11-89 GOTO suggested usage · 11-38
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-147
11-148
General Control Language (GCL+)
IFONCE THEN ELSE END IF · 11-93 RELINQUISH · 11-118 RESET · 11-119 START · 11-129 STOP · 11-130 SUB · 11-130 table listing · 11-19 THEN · 11-136 VARIABLE · 11-139 Status Operators BETWEEN · 11-71 CHANGED · 11-73 OFF · 11-107 OFFFOR · 11-107 ON · 11-108 table listing · 11-23 STOP · 11-130 String Concatenation Operator · 11-25, 11-129 String Functions Concatenation Operator · 11-129 LENGTH · 11-99 MID · 11-103 RIGHT · 11-119 String Operators String Concatenation Operators · 11-25 string variable data type · 11-139 SUB · 11-130 subroutine branching to · 11-39 subroutines SUB END SUB statement · 11-130 SUNSET · 11-133 SWITCH · 11-134 System Variables · 11-135
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page 11-148
DATE · 11-77 DAY · 11-77 DECIMALTIME · 11-79 MINUTES · 11-104 MONTH · 11-104 MONTHDAY · 11-105 SECONDS · 11-122 SUNSET · 11-133 table listing · 11-25 TIME · 11-137 WEEKDAY · 11-141 YEAR · 11-143
—T —
TAN · 11-136 THEN · 11-136 TIME · 11-137 time-based functions · 11-33 ToSeconds · 11-137 TRUNCATE · 11-138
—V —
VARIABLE · 11-139
—W —
WEEKDAY · 11-141 Write · 11-141
—X —
XOR · 11-142
—Y —
YEAR · 11-143 yellow octagon in GCL+ program · 11-61 yellow octagon with a Hand in GCL+ program · 11-64
Total Page in this Chapter: 131
Appendix A – SHORTCUT KEYS Use the keyboard shortcuts listed in this table to quickly complete a variety of Navigator and ORCAview functions.
Keys Common to Both ORCAview and Navigator Function
Command
Shortcut Key Combination
File
New
Ctrl+N
Open
Ctrl+O
Save
Ctrl+S
Print
Ctrl+P
Copy
Ctrl+C, Ctrl+Insert
Cut
Ctrl+X, Shift+Delete
Paste
Ctrl+V, Shift+Insert
Delete
Delete
Undo
Ctrl+Z, Alt+Backspace
Redo
Ctrl+A
Edit
Note: Ctrl + A in Navigator means Select All Tools
Illustrator
Ctrl+I
Help
F1
Help
Shift+F1
Context Sensitive
Keys Specific to ORCAview Function
Command
Shortcut Key Combination
Search
Find
Alt+F3
Find Object
Ctrl+F3
Find Next
F3
Refresh
F5
View
Total Pages in this Appendix: 2
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page A-1
A-2
Shortcut Keys
Keys Specific to Navigator Function
Command
Shortcut Key Combination
Edit
Select All
Ctrl+A Note that this overrides the ORCAview shortcut key for Edit Redo.
Name selected object(s) in right pane
Rename
F2
Keys Specific to ORCAview Site Graphics Function
Command
Shortcut Key Combination
Edit Mode
Selection Mode:
Esc
Lasso Objects
Ctrl+U
Draw Line
Ctrl+L
Draw Freehand
Ctrl+F
Set Tab Order
Ctrl+T
Edit Lines
Ctrl+B
Next Object
Page Up
Previous Object
Page Down
Real Time Mode
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page A-2
Total Pages in this Appendix: 2
Appendix B – PREFERENCES AND SETUP 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)
Total Pages in this Appendix: 83
B-17
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-1
B-2
Preferences and Setup HEADER ............................................................................................................. B-17 System Status ....................................................................................... B-17 Last Reset Time ................................................................................... B-18 Reset Count.......................................................................................... B-18 Last Restore Time ................................................................................ B-18 Reset Reason........................................................................................ B-18 Database Scan Rate............................................................................. B-18 I/O Scan Rate....................................................................................... B-18 DESCRIPTION ..................................................................................................... B-19 Name.................................................................................................... B-19 Software Address ................................................................................. B-19 Location ............................................................................................... B-20 Latitude................................................................................................ B-20 Longitude ............................................................................................. B-20 Site Elevation....................................................................................... B-20 Elevation Units .................................................................................... B-20 CONFIGURATION ............................................................................................... B-21 RAM & CPU - Total Static Ram .......................................................... B-21 RAM & CPU - Remaining Static Ram ................................................. B-22 RAM & CPU - Total Dynamic Ram .................................................... B-22 RAM & CPU - Remaining Dynamic Ram............................................ B-22 RAM & CPU - CPU Speed .................................................................. B-22 RAM & CPU - Flash Load Time ......................................................... B-22 Output Startup Delay – Automatic ...................................................... B-22 Output Startup Delay – Delay Time .................................................... B-23 Using Output Startup Delay for DACs ................................................ B-23 LinkNet Port ........................................................................................ B-23 Controller Graphic .............................................................................. B-24 Reset Password .................................................................................... B-24 Com Control Password ....................................................................... B-24 Flash Loader Password ....................................................................... B-24 ecurity Enabled.................................................................................... B-25 Expansion I/O Boards (DCU only) ..................................................... B-26 Expansion PC104 Cards (DCU only).................................................. B-26 HVAC, Access, and Lighting Checkboxes ........................................... B-26 TIME INFO ......................................................................................................... B-27 Time ..................................................................................................... B-28 Date ..................................................................................................... B-28 GCL Timeout ....................................................................................... B-28 Save/Load Timeout .............................................................................. B-28 UTC Enable (Universal Time Co-ordinated) ...................................... B-29 UTC Offset (Universal Time Co-ordinated) ........................................ B-29 DST Enable (Daylight Savings DST) ................................................... B-29 DST Status (Daylight Savings DST) .................................................... B-30 DST Standard (Daylight Savings DST) ............................................... B-30 Type (Other Only) (Daylight Savings DST)......................................... B-31 Transition Time (Daylight Savings DST) ............................................ B-31 Time Adjustment (Daylight Savings DST) ........................................... B-31 Start DST on (Daylight Savings DST) ................................................. B-31 End DST on (Daylight Savings DST)................................................... B-32 On and After (Daylight Savings DST) ................................................. B-32 USING TIME SYNC ............................................................................................. B-32 Time Sync Operational Behavior ........................................................ B-33 TIME SYNC TAB................................................................................................. B-36 Time Interval ....................................................................................... B-36 Time Remaining ................................................................................... B-37
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-2 Total Pages in this Appendix: 83
ORCAview Settings (CMS) Setup Tab
B-3
Synchronize Time Button .................................................................... B-37 Time Synchronization Recipients ........................................................ B-37 PRODUCT ........................................................................................................... B-38 Vendor ................................................................................................. B-38 Vendor ID............................................................................................ B-38 Model Name ........................................................................................ B-38 Platform .............................................................................................. B-39 Firmware Version ............................................................................... B-39 Hardware Version ............................................................................... B-39 Application SW Version ...................................................................... B-39 Hardware Status ................................................................................. B-39 PROTOCOL ......................................................................................................... B-40 Max Master ......................................................................................... B-40 Max Info Frames ................................................................................. B-40 Protocol Version ................................................................................. B-40 Protocol Revision ................................................................................ B-40 APDU Timeout .................................................................................... B-41 APDU Retries...................................................................................... B-41 APDU Max Length .............................................................................. B-41 APDU Segment Timeout ..................................................................... B-41 Segmentation Supported ..................................................................... B-41 Services Supported .............................................................................. B-41 Object Types Supported ...................................................................... B-41 INTERNET ........................................................................................................... B-42 Panel’s E-Mail Account ...................................................................... B-42 SMTP Server ....................................................................................... B-42 Username and Password fields ........................................................... B-43 Use DHCP .......................................................................................... B-43 IP Address ........................................................................................... B-44 Subnet Mask ........................................................................................ B-44 Gateway .............................................................................................. B-45 User Defined DNS ............................................................................... B-45 NAVIGATOR STATUS VALUES ............................................................................ B-45 GCL+ PROPERTIES............................................................................................. B-46 REMOTE PANEL SETTINGS (RPS)
B-47
MAIN ................................................................................................................. B-47 Name ................................................................................................... B-47 Phone Number .................................................................................... B-48 Password ............................................................................................. B-48 Dial-out SUA....................................................................................... B-48 Delta Device........................................................................................ B-48 SETUP................................................................................................................. B-49 Baud Rate ............................................................................................ B-49 Object System ...................................................................................... B-50 Panel Number ..................................................................................... B-50 Network Number ................................................................................. B-50 MODEM SETTINGS (MDS)
B-51
SETUP................................................................................................................. B-51 Name ................................................................................................... B-52 Modem Type ........................................................................................ B-52 Initialization ........................................................................................ B-52 Hangup................................................................................................ B-52 Reset .................................................................................................... B-52 Dial Prefix ........................................................................................... B-53
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-3
B-4
Preferences and Setup Auto Answer ........................................................................................ B-53 Command Timeout .............................................................................. B-53 DESCRIPTION ..................................................................................................... B-53 SITE SETTINGS (SS)
B-54
GENERAL ........................................................................................................... B-54 Site Name............................................................................................. B-54 ADVANCED ........................................................................................................ B-55 V2 Master Panel .................................................................................. B-55 V2 Security Panel ................................................................................ B-55 BACnet Master Panel .......................................................................... B-55 BACnet Security Panel ........................................................................ B-56 User Logging ....................................................................................... B-56 User Log File....................................................................................... B-56 APPLICATION PROTOCOL ................................................................................... B-57 BACnet ................................................................................................ B-57 Delta Version 2 .................................................................................... B-57 SYSTEM USER ACCESS
B-58
HEADER ............................................................................................................. B-59 Status ................................................................................................... B-59 Last Logged In at ................................................................................. B-60 Last Logged Off at ............................................................................... B-60 DESCRIPTION ..................................................................................................... B-61 SETUP ................................................................................................................ B-62 Name.................................................................................................... B-62 User Enabled ....................................................................................... B-63 Security - Password ............................................................................. B-63 Security - Password Auto Expire ......................................................... B-63 Security - Password Start Date ........................................................... B-64 Security - Password Expiry Date......................................................... B-64 Menu Reference ................................................................................... B-64 Object Security [New 3.40] ................................................................. B-64 HVAC, Access, and Lighting Checkboxes ........................................... B-64 USER DATA ....................................................................................................... B-65 Alarm Filter ......................................................................................... B-66 Disable Navigator ............................................................................... B-66 Disable Illustrator ............................................................................... B-66 Disable Alarm Pop-up ......................................................................... B-66 Hide Server Messages [New 3.40] ...................................................... B-67 Process ID ........................................................................................... B-67 Default User Graphic (HMI only) ....................................................... B-67 Welcome Screen (HMI only)................................................................ B-67 Auto-Logoff - Period (HMI only)......................................................... B-68 Login Required Checkbox (HMI only) ................................................ B-68 Refresh Rate for Objects ...................................................................... B-69 Language ............................................................................................. B-69 Starting Screen .................................................................................... B-69 Starting Screen (HMI only) ................................................................. B-69 Full Name ............................................................................................ B-69 E-mail Address .................................................................................... B-70 Phone Number ..................................................................................... B-70 Fax Number ......................................................................................... B-70 Pager Number ..................................................................................... B-70 Cellular Number .................................................................................. B-70 LOGIN ................................................................................................................ B-71
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-4 Total Pages in this Appendix: 83
ORCAview Settings (CMS) Setup Tab
B-5
Last Login Area................................................................................... B-71 Login Failure Area.............................................................................. B-72 Login Lockout ..................................................................................... B-72 Auto-Logoff ......................................................................................... B-73 OBJECT OVERRIDES ........................................................................................... B-73 Security Group .................................................................................... B-74 Object Access Exceptions.................................................................... B-74 EVENT FILTER
B-76
MAIN ................................................................................................................. B-76 Name ................................................................................................... B-77 Priority Override ................................................................................ B-77 HVAC, Access, and Lighting Checkboxes ........................................... B-79 CUSTOM VIEWS
B-80
CREATING NEW CUSTOM VIEWS........................................................................ B-80 Sample Custom Views ......................................................................... B-81 INDEX
Total Pages in this Appendix: 83
B-83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-5
B-6
Preferences and Setup
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.
ORCAVIEW SETTINGS (CMS)
To open this object, from the ORCAview Dashboard, select Preferences and then click ORCAview. ORCAview settings object allow you to select these options.
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.
Show Navigator on Startup The Navigator window will always open when ORCAview is started.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-6 Total Pages in this Appendix: 83
Navigator Settings (NVS) Setup Tab
B-7
Alarm Sound File Pick a sound file for ORCAview to play when notifying the operator of an alarm. To change the alarm-notification audible alarm, enter a new path and filename in the Alarm Sound File box.
Site Graphic Path The path for the files shown in the graphics folder in the right pane of the Navigator window. To change the site default location for graphic files, enter a new path in the Site Graphic Path box.
NAVIGATOR SETTINGS (NVS)
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:
Splitter Bar Full Drag The splitter bar is the bar between the Navigator windows. If this box is checked then the following occurs when the splitter bar is dragged left or right: •
The Navigator dialog refreshes immediately.
•
All of the Navigator window columns are dragged with the splitter bar.
If the box is not checked then
Total Pages in this Appendix: 83
•
The Navigator dialog refreshes when the mouse button is released after dragging the splitter bar.
•
When the splitter bar is dragged, Navigator window columns do not move.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-7
B-8
Preferences and Setup
Show Graphics folder If this box is checked the graphics folder is visible on the left-hand pane of the Navigator window. If it is not checked the folder is invisible.
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.
Device Graphic Tab
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-8 Total Pages in this Appendix: 83
Drawing Settings (DWS)
Device Graphic Tab
B-9
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 Controller Graphic field allows a designated graphic to be defined in a global manner. When the DEV objects is opened with a different OWS, this designated graphic displays. The other OWS needs to have the graphic included in the directory defined in the Controller graphic field. 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. The graphic opens when you do one of the following: •
Right click on a controller in the Left Pane of Navigator and select Open
•
Select a controller in the Left Pane of Navigator and choose File and select Open on the ORCAview Dashboard.
If a device or site does not have a designated graphic, then the Device (DEV) object opens.
DRAWING SETTINGS (DWS) You can open the Drawing Settings (DWS) object from the ORCAview Dashboard. Choose Tools, select Preferences and then click Drawing. 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-9
B-10 Preferences and Setup
Drawing Settings allows you to select the following:
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.
Use White Grid Changes the grid dots to white. By default, the Use White Grid is selected and the background color is black starting with 3.30 Release 3.
Lasso must enclose to select Enable this to force the lasso to select objects only when the objects are completely inside the lasso. Uncheck this box to let the lasso select objects when the objects are only partially within the lasso.
Site Graphic Resizing Checkbox Check this box to allow resizing of a graphic in run mode. The default is unselected. Restart the OWS for this setting to take effect.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-10 Total Pages in this Appendix: 83
GCL Settings (GCS)
Device Graphic Tab
B-11
GCL SETTINGS (GCS) The GCL settings change the appearance of GCL programs in the GCL Editor. To open the GCL Settings (GCS) object, from the ORCAview toolbar choose Tools, then select Preferences and then click GCL.
Current Font: Name The Name field gives the name of the fixed-width True Type font used in the GCL editor. A typical font name might be Courier New.
Current Font: Size The Size field gives the size of the selected font.
Current Font: Change Settings Button When you press the Change Settings … button, a Font options dialog displays. The Font Selection dialog lists al the fonts installed and available in Windows.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-11
B-12 Preferences and Setup
Font Settings: Tab Spacing The Tab Spacing field defines the distance a line indents when you press the tab key. Indenting is important for easy comprehension of GCL programs.
Font Settings: Enable Line Numbering Check this box to provide line numbers on the left hand side of the GCL editor.
Styles and Colors This table lists the GCL elements on the left-hand side Sample column. In the three right-hand columns, you can select font style and foreground / background colors. The font style has options of Normal, Bold and Italics. The foreground and background color swatches provide the color options available for each GCL element. The selected styles and colors are applied to all GCL programs appearing in the GCL Editor.
Reset Button The Reset button returns all the options to the default setting of the object.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-12 Total Pages in this Appendix: 83
Server Startup Settings (SSS)
Device Graphic Tab
B-13
SERVER STARTUP SETTINGS (SSS) To open this object, from the ORCAview Dashboard choose Tools, then select Preferences and then Server. Note: Changes to these settings do not take effect until ORCAview is restarted.
Periodic Device Check: Enable Device Check If this box is checked, ORCAview will periodically check for the devices that it knows about on the network. After Logging onto the network there is a 5 minute startup period before ORCAview will begin checking devices. This check box is enabled by default.
Periodic Device Check: Device Check Interval This is the amount of time that will elapse between the checks for each individual device that ORCAview knows about. The default Device Check Interval is 15 seconds
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-13
B-14 Preferences and Setup Example After ORCAview has finished checking Device100, 15 seconds will elapse before it checks for Device200
Periodic Device Check: Start a New Round Every The Start a New Round Entry field is the amount of time that elapses at the end of a round before the next round starts. A single Device Check Round consists of ORCAview checking each known device on the network. The Default value for this field is 300 seconds
General Server Options: Language This field specifies the language that is used when you right click on the Delta Server Application icon. This icon is in the Windows system tray located in the lower right area of the screen.
General Server Options: Auto Load Descriptors This field allows you to decide whether or not ORCAview will automatically load descriptors from newly found devices, or from devices whose descriptors have changed. The process of loading descriptors from a device allows ORCAview to learn of what objects exist in the device. 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
•
Always except over RS-232
•
Never
By default, “Always except over RS-232,” is selected in the Auto Load Descriptors field. To completely disable this feature, click on the drop down menu and select, “Never.”
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-14 Total Pages in this Appendix: 83
Server Startup Settings (SSS)
Device Graphic Tab
B-15
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.
General Server Options: Auto Find Devices Network traffic can be reduced in larger or slower networks by disabling the Auto Find Devices field in the SSS object. 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.
Advanced Server Options: Verify Client Connection If ORCAview is closed and this box is checked ORCAview will verify there are no active clients before exiting completely. If another client ceases to respond ORCAview closes that client automatically. 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.
Advanced Server Options: Close After ORCAview If the box is checked, the Delta server will shut down when ORCAview is closed. 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-15
B-16 Preferences and Setup
Advanced Server Options: Enable Remote Descriptor File Loading [New 3.40] The Enable Remote Descriptor File Loading checkbox feature can reduce the time it takes for an operator to see descriptors after first logging into a large site. It does this by transferring an existing Descriptor (DS) file from a remote server and then restarting the local DS system with the downloaded file as the local Descriptor file. Existing Descriptor files are transferred from servers such as Historian and ORCAweb that are consistently connected to the network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-16 Total Pages in this Appendix: 83
Device (DEV)
Header
B-17
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:
Total Pages in this Appendix: 83
•
OPERATIONAL
•
OPERATIONAL_READ_ONLY
•
DOWNLOAD_REQUIRED
•
DOWNLOAD_IN_PROGRESS
•
NON_OPERATIONAL.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-17
B-18 Preferences and Setup
Last Reset Time This read-only field indicates the time/date when the last reset occurred. This field will be updated whenever the controller is powered on, or the device object is commanded to Reset by right-clicking on the device object in the Navigator. 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.
Last Restore Time This read-only field displays the time and date when the last successful database load occurred.
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.
Database Scan Rate This read-only field gives the actual scan rate of the database with real time updates. The scan rate represents how often the controller/OWS is executing the controller database, in other words, how many times all the objects in the controller, including GCL+, are being run per second. The OWS has a scan rate because you can create objects in it, which are executed when the OWS is running.
I/O Scan Rate This read-only field displays the rate at which the actual hardware inputs and outputs are being updated. A zero is displayed for a DCU without a base and for an OWS.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-18 Total Pages in this Appendix: 83
Device (DEV) Description
B-19
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-19
B-20 Preferences and Setup 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+.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-20 Total Pages in this Appendix: 83
Device (DEV) Configuration
B-21
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.
RAM & CPU - Total Static Ram This is the total available Static RAM in Kbytes on a controller. This memory space is allocated for the database. It is fixed in size. 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. The default Room Controller total static RAM is 63 Kbytes.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-21
B-22 Preferences and Setup
RAM & CPU - Remaining Static Ram This is the total remaining Static RAM in Kbytes on a DCU or DAC controller that is available.
RAM & CPU - Total Dynamic Ram This is the total available Dynamic RAM in Kbytes on a controller. This memory space is allocated for Descriptors, Working RAM, Network, and the Routing Table. This memory space fluctuates in size, as system requirements change. The default DCU total Dynamic RAM is 4,096 Kbytes. The default DSC total Dynamic RAM is 189 Kbytes. The default Room Controller total Dynamic RAM is 61 Kbytes. Additional Dynamic RAM is not available for DAC, DSC, VAV/VVT or Room Controllers.
RAM & CPU - Remaining Dynamic Ram This is the total remaining Dynamic RAM in Kbytes on a controller that is available for use. The remaining Dynamic RAM should be larger than 500 Kbytes for a DCU.
RAM & CPU - 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 DACs have a clock speed of 24 MHz with a 16 bit processor.
RAM & CPU - Flash Load Time This is a read-only field that indicates the last date and time that flash memory was updated.
Output Startup Delay – Automatic 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-22 Total Pages in this Appendix: 83
Device (DEV) Configuration
B-23
Output Startup Delay – Delay Time When the Automatic checkbox is unchecked, Output Startup Delay goes into manual mode. Using the Delay Time Spinbox, a specific time can be set in seconds.
Using Output Startup Delay for DACs When a controller from the DAC family (i.e. DAC, DLC, DNT, DSC, DSM, or ASM) starts up (from a controller reset, power failure, or database load), outputs are held at a safe value for a short period of time. This allows the controller to power up and begin running. Once this time period expires, it is up to GCL to determine and write the proper values to the outputs, otherwise the default values will be written to the outputs. 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.
LINKnet is not supported on a DSM-RTR device. If you try to change the LINKnet Port for a DSM-RTR, an Out of Range error displays and the port is not changed.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-23
B-24 Preferences and Setup
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 allows a designated graphic to be defined in a global manner. When the DEV objects is opened with a different OWS, this designated graphic still displays. The other OWS must have the graphic included in the directory defined in the Graphic Path field in the CMS object. 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.
Com Control Password This field defines an optional password that restricts the use of the Communication Control command in the left pane of Navigator. The default setting is none. With a password in this field, a user must enter the correct password to use the Communication Control command. The Communication Control command is available when a controller is selected in the left pane of Navigator and the right mouse button is used.
Flash Loader Password The Flash Loader Password field allows you to specify a password that is required when flashing that controller's firmware. By default, the Flash Loader Password field is empty, which means that a password is not required. In order for Flash Loader to flash a controller that has a Flash Loader Password specified, open the settings dialog in FlashLoader and enter the password into the Password field. If the wrong password is supplied, the controller will not allow you to flash its firmware.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-24 Total Pages in this Appendix: 83
Device (DEV) Configuration
B-25
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. When DST setting is enabled on OWS by default: 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-25
B-26 Preferences and Setup
Expansion I/O Boards (DCU only) This field is a read-only data-view box that indicates any input/output expansion cards that are currently connected to a DCU. The Expansion I/O Boards are auto detecting. If you plug a new expansion board into the DCU and turn the power back on, the DCU will see the expansion board and update this data-view. Make sure that the expansion boards which plug into the Base I/O board have a correct address (1, 2 or 3). The available boards that can be connected to the DCU are: •
DBB060 Base I/O Board which will appear as “DBB-060 Base I/O Board” meaning 16 Analog Inputs and 16 Analog Outputs plus 16 Modules
•
DEB100-1 Expansion I/O Board which will appear as “DEB100-1 8AI-8AO” meaning 8 Analog Inputs and 8 Analog Outputs
•
DEB100-2 Expansion I/O Board which will appear as “DEB100-2 8AI16BO” meaning 8 Analog Inputs and 16 Binary Outputs (Triac)
•
DEB101 Expansion I/O Board which will appear as “DEB101 32AI” meaning 32 Analog Inputs
•
DEB102 Expansion I/O Board which will appear as “DEB102 8AI-8AO-8M” meaning 8 Analog Inputs, 8 Analog Outputs and 8 Modules
This field does not display for a DAC controller.
Expansion PC104 Cards (DCU only) This field is a data-view box that indicates expansion cards that are connected to the DCU. If you plug a new expansion board into the DCU and turn the power back on, the DCU will see the expansion board and update this data-view. The available PC104 boards that can be connected to the DCU are: •
Ethernet Card
•
IntelliNet® Card
•
Peripherals Card
This field does not display for a DAC controller.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-26 Total Pages in this Appendix: 83
Device (DEV)
Time Info
B-27
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
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-27
B-28 Preferences and Setup
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. A DCU continues to perform control actions while saving or loading a database. The other controllers pause during save or load operations. 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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-28 Total Pages in this Appendix: 83
Device (DEV)
Time Info
B-29
UTC Enable (Universal Time Co-ordinated) This checkbox tells the DCU that the UTC Offset property is in effect, and should be used in all relevant calculations. See UTC Offset for more information. On a DSC/DAC controller, the UTC Enable setting is no longer required in the calculations for the Sunrise and Sunset functions. The UTC Offset setting in the DEV object is still used.
UTC Offset (Universal Time Co-ordinated) This field indicates the offset in minutes (-780 to 780) between local standard time and Universal Time Coordinated (formerly Greenwich Mean Time). To use the UTC feature you must check UTC Enable and enter the UTC Offset for the location of the Device. 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. UTC is used in several controller applications: European Daylight Savings Time – see DST STANDARD which follows for
more information.
Sunrise/Sunset Algorithm – please reference the GCL+ chapter of the manual
for more information.
Set Panel Time – please reference Chapter 3 – Navigator of the ORCAview
Technical Reference manual for more information.
The dates in emails and Security settings on Configuration tab of the Device object also use UTC.
DST Enable (Daylight Savings DST) 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-29
B-30 Preferences and Setup 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.
DST Status (Daylight Savings DST) 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 (Daylight Savings DST) 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. Here is a description of the DST Standards: 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-30 Total Pages in this Appendix: 83
Device (DEV)
Time Info
B-31
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.
Type (Other Only) (Daylight Savings DST) This property provides a combo-box that will allow the user to enter the DST start/end dates with either a Week & Day or Specific Date type entry. The only time that this combo-box can be modified is when OTHER is selected as the DST Standard.
Transition Time (Daylight Savings DST) 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 (Daylight Savings DST) 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 (Daylight Savings DST) 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-31
B-32 Preferences and Setup
End DST on (Daylight Savings DST) 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 (Daylight Savings DST) 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.
Using Time Sync The Time Sync Tab section starting on page B-36 describes the fields on the tab and follows this introduction section. Auto Time Synchronization Many HVAC applications require that equipment
change its operating behavior (i.e. set points), according to a defined schedule. These schedules are periodic in nature (usually daily or weekly) and specify the times during which the equipment must behave one way or another (often called “Day mode” and “Night mode”). In order to ensure that the equipment is operated in accordance with the schedule, the controlling device (controller) needs to be aware of the current time and date. However, if the controller does not have a realtime clock of its own, then it is dependent upon some other device to both maintain the correct current time and make this information available when needed.
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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-32 Total Pages in this Appendix: 83
Device (DEV)
Using Time Sync
B-33
Since the Time Synchronization message is a periodic broadcast, if a device is offline during the broadcast and/or it resets & comes on-line anytime after the broadcast, it will not have the current time until the next broadcast (often 24 hours later). This is a concern for all low-end controllers (those that have no real-time clocks) which are scheduling equipment. But it is also a larger concern for controllers trending data, as any data collected between coming on-line and the next Time Synchronization message will be lost (due to the purging of the Trend Log caused by the resulting ‘large’ time shift). The broadcast period can be shortened, but the trade-off is higher network traffic, while preventing the trending data loss. 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).
Time Sync Operational Behavior The Time Sync tab of the Device (DEV) object is used to specify when Time Synchronization messages will be sent. Time Synchronization messages may be broadcast, multicast, or addressed to a single recipient. There are two ways to enable Auto Time Synchronization: •
automatically
•
manually
These are described in the following text. Auto Time Synchronization can also be disabled.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-33
B-34 Preferences and Setup Auto-Enable / Auto-Configuration Creation of a default database (“Clear
Database” command) adds the subnet network address (e.g. NET50003) to the Time Synchronization Recipients list and sets the default Time Interval to 3600 seconds (1 hour). This enables the Auto Time Synchronization feature.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-34 Total Pages in this Appendix: 83
Device (DEV)
Using Time Sync
Total Pages in this Appendix: 83
B-35
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-35
B-36 Preferences and Setup
Time Sync Tab The Time Sync tab allows the operator to configure a DCU or DSC controller as a Time Master on the Network. If more than one controller is set as the Time Master, then problems may occur. You would typically set up Devices to have their times synchronized to prevent time skew between controllers with independent Real Time Clocks and to ensure that a Device which lacks a battery backup has a correct time/date in it if it loses power. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-36 Total Pages in this Appendix: 83
Device (DEV) Time Sync Tab
B-37
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.
Synchronize Time Button Clicking the button and pressing apply sends the time to the time synch recipients and the timer starts over again assuming that Auto Time Sync is not enabled
Time Synchronization Recipients This is the list of devices to which the current date/time will be sent every time the time remaining field counts down to zero. You can send the date/time to a specific Device, a single Network or you can broadcast to every device on every network. To broadcast to a Device you enter 100.DEV1. To broadcast to a Network you enter in the Network number (NET 4). To broadcast to all devices on every network type in Broadcast. 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-37
B-38 Preferences and Setup
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-38 Total Pages in this Appendix: 83
Device (DEV)
Product
B-39
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 realtime clock, LCD, or Ethernet port depends on the type of controller.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-39
B-40 Preferences and Setup
Protocol
Max Master This read-only field indicates the highest possible address for master nodes.
Max Info Frames This read-only field indicates the maximum number of information frames the device may send before it must pass the token.
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-40 Total Pages in this Appendix: 83
Device (DEV)
Protocol
B-41
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.
APDU Max Length This read-only field represents the maximum number of octets that may be contained in a single application layer protocol data unit.
APDU Segment Timeout This read-only field indicates the time in milliseconds, between retransmission of an APDU segment.
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.
Object Types Supported This read-only field provides a list of supported BACnet objects.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-41
B-42 Preferences and Setup
Internet
Panel’s E-Mail Account The fields contains the text that you want to appear in the From field of the emails. A descriptive name should be entered into this field so that it is easy to identify where the email came from. For example,
[email protected]. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-42 Total Pages in this Appendix: 83
Device (DEV)
Internet
B-43
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.
Username and Password fields The Username and Password fields are for SMTP Server Authentication. This is when the Email Server requires the client (in this case the DSC) to authenticate (with a Username and Password) before it will accept an email submission. The DSC supports the AUTH LOGIN and AUTH PLAIN SMTP Authentication methods. Contact your network administrator as to whether your Email Server requires authentication. Note: Leaving the Username and Password fields empty disables authentication.
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-43
B-44 Preferences and Setup 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. An IP address is a four-part address which is used to identify a particular computer, controller 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 shown below: 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: 192.168.1.10 is on the same network as 192.168.1.23
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-44 Total Pages in this Appendix: 83
Device (DEV)
Navigator Status Values
B-45
This means that these two devices can communicate without the need for a Gateway. However: 192.168.1.10 is NOT on the same network as 11.123.200.4 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.
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 (i.e. mail.deltacontrols.net).
Navigator Status Values The status field displays the same thing as the object value.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-45
B-46 Preferences and Setup
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+.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-46 Total Pages in this Appendix: 83
Remote Panel Settings (RPS) Main
B-47
REMOTE PANEL SETTINGS (RPS) The Remote Panel Settings (RPS) allows a modem connection to be established between a controller and the OWS. The connection can be initiated on the controller side for alarm dial out or it can be initiated from the OWS side to dial into the controller network. 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-47
B-48 Preferences and Setup
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-48 Total Pages in this Appendix: 83
Remote Panel Settings (RPS)
Setup
B-49
Setup
Baud Rate
Baud Rate needs to be adjusted here.
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 On the device, the default baud rate is 9600.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-49
B-50 Preferences and Setup 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-50 Total Pages in this Appendix: 83
Modem Settings (MDS)
Setup
B-51
MODEM SETTINGS (MDS) The Modem Settings (MDS) Object contains configuration information for a modem. The Modem Type field on the Setup tab contains a list of modems and also has a Custom option. The other fields on the dialog are set based on the Modem Type selection. 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-51
B-52 Preferences and 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. 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. A typical string might be: AT
Hangup This string is sent to the modem port before the modem port hangs up. Refer to your modem manual for more details. A typical string might be: ATH
Reset This string is sent to the modem port when the device is reset. Refer to your modem manual for more details. A typical string might be: ATZ
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-52 Total Pages in this Appendix: 83
Modem Settings (MDS) Description
B-53
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. A typical string might be: ATDT
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
The description field may contain a character string of up to 2000 characters in length. The character string is limited to any printable character.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-53
B-54 Preferences and Setup
SITE SETTINGS (SS) You can open this object, from the ORCAview Dashboard. Choose Tools, select Setup, and click Site.
Unwanted V2 Security Failure Notification Every Logon Sometimes the Delta
Version 2 protocol may be enabled on a site that contains only Version 3 devices. ORCAview fails a Version 2 user security check every time you log into the site. A notification displays when the Version security check fails. The solution is to disable the Delta Version 2 protocol on the Site settings (SS) object.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-54 Total Pages in this Appendix: 83
Site Settings (SS)
Advanced
B-55
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.
BACnet Master Panel If a BACnet Master Panel is specified, then ORCAview automatically loads the system objects from it on login.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-55
B-56 Preferences and Setup
BACnet Security Panel The specified 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 SUA object which matches an SUA object on the workstation. 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: •
None - does not record any activities.
•
Low - records login and logoff activities.
•
Medium - records login and logoff, save and load database and object delete.
•
High - records login and logoff, save and load database, object delete, object edit, object create, set Panel Time, Acknowledge alarm, alarm list remove, connect remote device and disconnect remote device. Also, High records Command actions, Manual, Auto, Reset, On, Off and Value#.
User Log File The name of the text file that the User Logging will be writing to.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-56 Total Pages in this Appendix: 83
Site Settings (SS)
Application Protocol
B-57
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-57
B-58 Preferences and Setup
SYSTEM USER ACCESS The System User Access (SUA) is used to determine Network Security, Local Machine Security, and Object Security. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-58 Total Pages in this Appendix: 83
System User Access Header
B-59
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. The five states for the SUA are: •
Logged In
•
Logged Out
•
Disabled
•
Security Locked
•
Inactive
Logged In The Logged In SUA Status indicates that a user has passed all system security checks. If the SUA is in this state nobody can log into the system using this SUA. 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:
•
The Login Lockout Period expires.
- Or •
The Login Lockout is unchecked (False) manually by a user logged in with another valid SUA with appropriate permissions.
- Or 1.
Total Pages in this Appendix: 83
The SUA object is reset.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-59
B-60 Preferences and Setup 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. This field is read-only and not editable by the user.
Last Logged Off at This field shows the last time and date that the SUA Status was set to Logged Off. In the PC, it shows the last time someone logged off 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 Off state. In this case, the time is taken from the controller. This field is read-only and not editable by the user.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-60 Total Pages in this Appendix: 83
System User Access Description
B-61
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-61
B-62 Preferences and Setup
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. The Name has the following restrictions: •
Maximum 16 characters
•
Forced to be Uppercase
•
Only Version 2 acceptable characters are accepted. Do not use characters such as ( \ /:*?"< >| ). Also, spaces are not allowed. An SUA object name can have an underscore character _ in a name but it cannot be at the start of the name.
•
Minimum 1 character
These restrictions are in place to keep the SUA compatible with the Version 2 User Access object (UA).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-62 Total Pages in this Appendix: 83
System User Access
Setup
B-63
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 ‘*’. The Password has the following restrictions: •
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).
Security - Password Auto Expire This field is used to enable the Password Start Date and Password Expiry Date. When checked (On) the object will execute the Password Auto Expire routine. 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).
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-63
B-64 Preferences and Setup
Security - Password Start Date This field allows the user to specify when the SUA can start to be used when the Password Auto Expire is on. The default value for Password Start Date will be the date and time that the user was created. If the Password Start Date has not occurred yet, then the Status of the SUA object will be set to Inactive. You can adjust the start time with the spin box, and the start date with the drop down calendar.
Security - Password Expiry Date The Password Expiry Date sets the date when the SUA expires. Once the SUA has expired, the SUA Status is set to Inactive. The default value for the Password Expiry Date is set to 6 months from when it was created. You can adjust the expiry time with the spin box, and the expiry date with the drop down calendar.
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.
Object Security [New 3.40] Provides a way to select an optional Object Security Restrictions (ORS) object from a list.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-64 Total Pages in this Appendix: 83
System User Access User Data
B-65
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-65
B-66 Preferences and Setup
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. If a Security Panel is specified, the Disable Navigator checkbox must be checked in the SUA object on the local OWS for this feature to work.
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.
Disable Alarm Pop-up This field is used to enable or disable alarm pop-ups for the user. The default is unchecked which allows Alarm Pop-ups. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-66 Total Pages in this Appendix: 83
System User Access User Data
B-67
Hide Server Messages [New 3.40] This field is used to enable or disable server messages for the user. The default is unchecked which allows server messages. 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.
Default User Graphic (HMI only) The Default User Graphic field defines the first graphic file that displays on the HMI interface after a user logs in. It is only editable in SUA1 by an Administrator. 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).
Welcome Screen (HMI only) The Welcome Screen field defines the graphic that displays on the touch screen after the HMI device starts up or is reset. It is only editable in SUA1 by an Administrator. 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).
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-67
B-68 Preferences and Setup
Auto-Logoff - Period (HMI only) The Auto-Log off period is the amount of time before a user is automatically logged out if there are no touches on the screen. You can disable this feature by setting the period to 0. In order for any changes in this field to take affect, you must save the changes. The default Auto-Logoff period is 10 minutes.
Login Required Checkbox (HMI only) The Login Required checkbox specifies whether a user needs to log in and its status affects the Default User Graphic and Welcome Screen fields. It is only editable in SUA1 by an Administrator. If this field is checked (enabled), a user must log in to gain full Read/Write access to graphics . All graphics are Read Only if a user is not logged in. If this field is unchecked (disabled), HMI access is granted to all users. This means that all users have full Read/Write control of graphics. A user still must have Login access as an Administrator (SUA1) to access the Configuration pages.
These 4 fields are specific to the HMI
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-68 Total Pages in this Appendix: 83
System User Access User Data
B-69
Refresh Rate for Objects This field is used to tell ORCAview how often to update a graphic and/or dialog for the User. The default value is 5 seconds. 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.
Starting Screen (HMI only) The Starting Screen field defines the Start Graphic to be displayed on the touch screen after a user logs in. 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 the field is empty, then HMI will use the Default User Graphic after a user logs in.
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-69
B-70 Preferences and Setup
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-70 Total Pages in this Appendix: 83
System User Access Login
B-71
Login This tab contains information and setup for logins and logouts.
Last Login Area Date This field shows the last time and date the SUA Status was Logged In. In
the PC it will show the last time someone logged into the workstation, taken from the PC clock. The SUA Status in the controller will show the last time that SUA Status in the controller was in the Logged in state. In this case the time is taken from the controller.
This field is read-only and not editable by the user. 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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-71
B-72 Preferences and Setup 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.
Login Failure Area Date This field displays the last time and date that this SUA failed a login check.
In the OWS this field will show the last time and date the security check to get into the ORCAview failed. The SUA in the controller will show the last time and date the security check to the BACnet Security Panel failed. 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. This field is read-only and cannot be adjusted by the user. 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.
The default value for Maximum Failures when an SUA is created is 3.
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. The Lockout defaults to unchecked (Unlocked) when an SUA is created. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-72 Total Pages in this Appendix: 83
System User Access Object Overrides
B-73
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. The default value for the Period is 1440 minutes (1 day).
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-73
B-74 Preferences and Setup
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.
Object Access Exceptions The Object Access Exceptions section has two fields allowing input for a specific object and its corresponding access level. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-74 Total Pages in this Appendix: 83
System User Access Object Overrides
B-75
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.
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-75
B-76 Preferences and Setup
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-76 Total Pages in this Appendix: 83
Event Filter Main
B-77
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. Valid entries are:
Total Pages in this Appendix: 83
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.
.*
All Events and Event Classes from a particular controller are filtered. e.g. 400.*
.EVC*
All Event Classes notifications from a particular controller are filtered.
.EV*
All Event notifications from a particular controller are filtered.
.EVC2
All Event Class 2 notifications from a particular controller are filtered.
.EV1
All Event 1 notifications from a particular controller are filtered.
*.*
All Event and event Classes notifications from all controllers are filtered.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-77
B-78 Preferences and Setup Unacknowledgeable Alarms Events or Event notifications from these classes are not acknowledgeable or removable by the user. This means that the user cannot acknowledge or delete active alarms, but they may view them in Navigator. A local or remote controller address can also be entered. The field accepts * which is the wildcards character. Valid entries are: 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.
.*
All Events and Event Classes from a particular controller are filtered. e.g. 400.*
.EVC*
All Event Classes notifications from a particular controller are filtered.
.EV*
All Event notifications from a particular controller are filtered.
.EVC2
All Event Class 2 notifications from a particular controller are filtered.
.EV1
All Event 1 notifications from a particular controller are 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-78 Total Pages in this Appendix: 83
Event Filter Main
B-79
Specify the Filter to apply here.
When the Event Filter has been selected, click the Apply button for the filter to take affect.
HVAC, Access, and Lighting Checkboxes These checkboxes indicate which application(s) the object is part of. Any combination of the HVAC, Access Control, and Lighting applications can be selected. Leaving all checkboxes blank is the same as checking them all. 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 areas are:
Application
HVAC (Red) Access (Blue)
Icon
Lighting (Green)
Total Pages in this Appendix: 83
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-79
B-80 Preferences and Setup
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.
Creating New Custom Views Creating a custom view occurs in three steps: •
Create new views
•
Create folders and sub-folders
•
Change the folder properties to filter objects into the folders.
To create a custom view folder:
1.
From the ORCAview menu bar, click File, select New and then click View.
2.
The New Custom View dialog box will appear. Type a name in the Description field for your custom view.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-80 Total Pages in this Appendix: 83
Custom Views
Creating New Custom Views
3.
B-81
Click OK. Navigator will display the newly created view. The new view contains the default special folders, Active Alarms and Graphics.
Sample Custom Views A Sample Custom View is provided with ORCAview and is used here to explain how this Custom View can be used. To open the sample set of custom views:
1.
In a blank area of the Navigator left pane, right click.
2.
From the pop-up menu select, select Custom and then click Sample Custom View.
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:
Total Pages in this Appendix: 83
•
All Inputs
•
All Outputs
•
Program and Variables
•
Schedules
•
Zones and Controllers
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-81
B-82 Preferences and Setup
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page B-82 Total Pages in this Appendix: 83
Index
Creating New Custom Views
B-83
INDEX —A —
splitter bar full drag · B-7 network open object · B-9 NVS · B-7
Alarms select sound · B-7 Always on Top · B-6 auto hide · B-6
—O —
—C —
client connection verify · B-15 Close after Commander · B-15 Commander Dashboard auto hide · B-6 Dashboard on top of other programs · B-6 modem configuration · B-51 Preferences · B-6 select site graphic · B-7 select sound to notify operator of an alarm · B7 show Navigator on startup · B-6 Custom Views creating · B-80
—D —
DDE close when ceases to respond · B-15 Delta Version 2 protocol tab enable, disable · B-57 Drawing Settings · B-10
—G —
GCS · B-11 graphic resizing, runtime · B-10 Graphics folder show · B-8 grid size · B-10 snap to · B-10 Use White Grid · B-10 visible · B-10 Grid Settings · B-10
—L —
lasso select objects · B-10
—M —
master panel as entered in Site Settings Object · B-55 function · B-55
—N —
Navigator Preferences, set · B-7
Total Pages in this Appendix: 83
Objects CMS · B-6 Device · B-17 DWS · B-9 Event Filter · B-76 GCS · B-11 Modem Settings · B-51 NVS · B-7 Pemote Panel Settings · B-47 Site Settings · B-54 SSS · B-13
—P —
Preferences Commander · B-6 Protocol selecting in Site Settings Object · B-57
—R —
refresh rate (Navigator) · B-8 resizing graphic · B-10 Runtime Graphic Resizing · B-10
—S —
Security Panel as entered in Site Settings Object · B-56 function · B-56 show Graphics folder · B-8 Show Navigator on Startup · B-6 SI server close after Commander · B-15 Site master panel · B-55 protocol selecting · B-57 site name · B-54 Site Object · B-54 Site Graphic Path · B-7 site name · B-54 snap to grid · B-10 Splitter Bar full drag · B-7 SS · B-54
—V —
View Grid · B-10
—W —
White Grid · B-10 .
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page B-83
Appendix C – DERIVED NETWORK ADDRESSING (DNA) 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
Total Pages in this Appendix: 38
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–1
C–2 Derived Network Addressing (DNA) Automatic Address Conflict ................................................................ C–31 SOFTWARE ADDRESSING ................................................................................... C–32 Introduction ........................................................................................ C–32 How to Configure a Software Addressed DCU Controller ................ C–32 How to Configure a Software Addressed Room Controller................ C–35
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–2
Total Pages in this Appendix: 38
Overview
C–3
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. Purpose This appendix describes how to use Derived Network Addressing (DNA) in your projects. Cases of recommended and incorrect applications are shown. It will also cover how to avoid conflicts in configuration and how to make a managable hierarchical structure in Navigator. Context This appendix contains more detailed information about device addressing than that found in Chapter 3 Navigator or Chapter 9 Controller Networks. The Navigator chapter includes only basic information on how to interpret existing addresses or network arrangements.
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.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–3
C–4 Derived Network Addressing (DNA) The DNA scheme handles controller addressing and Network Numbering automatically. This takes away the hassle of configuring each controller to work properly with the rest of the network. By automatically assigning Controller Addresses and Network Numbers to controllers, there is less chance that conflicts will occur when new controllers are brought online. 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. Subnet Device This is the lowest level in the network architecture. An example is a Room Controller. It is made up of unitary controllers such as VAV, FCU, or HPU. Auto-Configure When DNA is enabled, the System and Subnet devices configure themselves to fit properly under the Network architecture. Both Network Numbers and Device addresses are updated. Network Number Number specified for a given network segment in the BACnet Protocol Settings (BCP) or Network Protocol Settings (NET1) object of a Device. Network Segment A physical connection between multiple devices that carries shared network traffic between the devices. Software Addressed Controller A controller that has the DNA feature intentionally disabled allowing the address to be changed through Navigator. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–4
Total Pages in this Appendix: 38
DNA Hardware Considerations
C–5
DNA Hardware Considerations 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.
Auto Network Numbering When a controller is turned ON, it automatically determines its Network Number by taking on the Network Number of other devices around it. However, if the device was previously configured, then the new device will appear in conflict with a yellow wrench over its icon in Navigator. If no other controllers are online, it creates a new Network Number based on its physical address. This action reduces the possibility of devices not communicating properly due to incorrectly configured Network Numbers.
How To Enable DNA On a DAC or DSC controller, DNA is enabled by bridging the DNA jumper. DNA is disenabled by removing the DNA jumper on the controller. 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. On a Room Controller, DNA is enabled or disabled by using the LCD menu.
How DNA Works Controller Addressing Under the DNA scheme, a controller has a 6 digit address (AASSDD), which is made up of three 2 digit values. Example: DNA Addressing for Area, System and Subnet
Total Pages in this Appendix: 38
Controller Number
DNA Scheme
DNA Address
AA
Area number
14
AA0000
140000
SS
System number
12
AASS00
141200
DD
Subnet number
32
AASSDD
141232
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–5
C–6 Derived Network Addressing (DNA) 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.
A VAV Controller (DAC-V304) or a Room Controller (DAC-T305) are typically Subnet level devices. These devices are connected by an MS/TP network to a controller that acts as a System Device. These Subnet level controllers have a DIP switch address like the DCU, and the DIP switch address is brought in the last position of its Six digit address (AASSDD). The AASS part of the address is inherited from the System level device that the Subnet device is connected to. 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.
Area Device The DNA scheme allows a controller to be designated as an Area Device so that sites can be hooked together using WAN or Internet network arrangements. An additional level in the structure of the network tree indicates an Area Device. Only one controller per network segment can be set as an Area Device when other System or Subnet Devices are on the same network segment. The DIP switch address of an Area Device becomes the first two digits of the whole 6 digit address AA0000. When an Area Device is designated, all other V3 Controllers that are physically connected to the Area Device, inherit the Area address. If the previous figure had an Area Device of 14, the Subnet Zone would have a address of 141232 as shown in the following figure.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–6
Total Pages in this Appendix: 38
DNA Hardware Considerations
C–7
DAC address with an Area of 14
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. Device Type
DCU Switch 128 Position
DSC Jumpers
Area
ON
Area Jumper bridged
System
OFF
System Jumper bridged
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.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–7
C–8 Derived Network Addressing (DNA)
800000
801000
801002
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.
What Controllers are Supported The DNA feature was introduced in Version 3.22 and it will not work with devices from Version 3.20 or earlier. The following table lists the devices that support DNA and the options you have in designating them as either Area, System or Subnet types: Product No.
Description
Types of DNA Hierarchy Supported
Method of Setting
DSC-1616 EX
DCU
Area, System
DIP Switch 128
DSC-1616
16 x 16 Controller
Area, System, Subnet
Jumper
DSC-1280
12 x 8 Controller
Area, System, Subnet
Jumper
DSC-1212
12 x 12 Controller
Area, System, Subnet
Jumper
ASM-24X
Access Controller
Area, System, Subnet
Jumper
DAC-T305
Delta Room Controller
System, Subnet
LCD Menu
DAC-304/322
Delta VAV/VVT Controller
Subnet
N/A
DAC-606/633
6 x 6 Controller
System, Subnet
Jumper
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–8
Total Pages in this Appendix: 38
Navigator and DNA
Product No.
C–9
Description
Types of DNA Hierarchy Supported
Method of Setting
DLC-G1212
Delta Lighting Controller GE
Subnet
N/A
DNS-14/24
Delta BACstats
Subnet
N/A
Delta Field Modules
Subnet
N/A
Delta BACstats
Subnet
N/A
DFM-200/400 DNT-T103/T221
Navigator and DNA 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:
Collapse and Expand the Network Tree With DNA and Navigator in the Network view, you can collapse or expand the different network levels. You can also collapse or expand System Devices with Subnet Devices.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–9
C–10 Derived Network Addressing (DNA)
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–10
Total Pages in this Appendix: 38
Navigator and DNA
C–11
Version 2 (V2) Controllers V2 devices do not follow the DNA structuring. They are listed under their own Version 2 Protocol heading in the network tree.
V2 Devices off V3 Controllers V2 micros or P-Zones that are networked from a V3 controller are listed under the V2 Protocol. They are not included in the DNA hierarchy but with proper device addressing can quickly be located and identified.
V2 Micro off of V3 DCU 140000
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–11
C–12 Derived Network Addressing (DNA) Software Addressed Devices (DNA Off) Software Addressed Devices are not affected by an Area Controller and do not participate in DNA. A software addressed controller will always appear in Navigator with the exact address that it is given in the Software Address field on the Description tab of the Device (DEV) object. Aside from requiring manual settings for the address and network number, a software addressed controller acts as a normal V3 controller. If the address of a Software Addressed controller is set to look like a System controller that should fall under an Area Device, then it displays that way in Navigator. However, a Software Addressed controller does not auto-configure its addresses to take on the network settings of the Area. 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
Subnet Devices off Software Addressed Devices Subnet devices with DNA ON can inherit from a system device with DNA OFF. This behavior is useful if you want to number your system devices differently from what DNA uses. The subnet devices do not require manual configuration because they will inherit from the system device. If the Software Addressed System controller address is changed, the addresses of the Subnet devices will also change.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–12
Total Pages in this Appendix: 38
Navigator and DNA
C–13
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
ORCAview Workstation An Operator Workstation (OWS) does not participate in DNA. The address of a workstation is independent of the controllers on the network. However, the address of the workstation must be unique on the network.
Workstation
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–13
C–14 Derived Network Addressing (DNA)
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.
Duplicate Physical Controller Numbers When more than one Area Device is on a WAN, the system controllers can have duplicate DIP switch addresses as long as the system controllers are on a different network segments under separate Area Devices. This capability is a major enhancement to the original addressing scheme by Delta Controls. The DNA scheme can now handle a situation where there are two controllers with the same physical address but are on different network segments. For example, if you put System Device (12) under Area Device (14) and another System Device (12) under an Area Device (66) that is on a separate segment, The DNA addressing scheme will configure the controllers as 141200 and 661200.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–14
Total Pages in this Appendix: 38
Limitations of DNA
C–15
System Devices Remember their Area and Network System Devices retain their Area and Network Numbers even if they are powered down. They also maintain their settings if the Area controller is temporarily taken off line for maintenance. The Area Device broadcasts the new addresses required to automatically configure the system controllers to that Area. When a System Device is configured by an Area Device, it broadcasts the same information that the Area device does to other System and Subnet Devices that are new to the network. If the Area Device is removed from the network, the Network Numbers and address numbers of the System Devices do not change unless the Reconfigure or Remove Area commands are used.
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.
Network Number Conflicts If controller installation is not done carefully, you might find that you have two network segments with the same Network Number. When networks have duplicate Network Numbers, one of the segments will not display in Navigator. When adding a new controller onto an existing network, the controller may need to be reconfigured so that it has the correct Network Number for the segment. The new controller assumes the Network Number of the network segment that it is being connected to. It is important to turn on the controllers individually in the correct order. See the Sample Network Architectures section of this Appendix starting on page C–23 for more information on how to commission a network segment.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–15
C–16 Derived Network Addressing (DNA)
Locations of Area Devices Since an Area Device auto-configures System Devices, a network segment cannot have more than one Area Controller. In order to have multiple Area Devices on a network, they must be on separate network segments. Caution: Area devices must be separated by TCP/IP routers. They cannot be used on a flat network.
UDP/IP R
Ethernet Network #1
R
Routers
BBMD Devices
Ethernet Network #2
Other Controllers
Other Controllers
DCU Area 14
DCU Area 02
DCU System 140100
DCU System 020300
The previous figure shows a valid arrangement of multiple Area devices as BBMDs in order to connect buildings or networks together correctly. DSC controllers can also function as BBMD and Area devices. 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.
Area Controller Added to Existing Network When an Area controller is connected to a network, the addresses of system and subnet devices change to reflect the address of the Area controller. Before ORCAview 3.30, the system and subnet controllers did not know that the addresses of other controllers had changed. In ORCAview 3.30, any system or subnet controller that has objects such as PGs, TLs or EVs which reference remote objects in other controllers, will now continue to reference the correct remote object with only one exception.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–16
Total Pages in this Appendix: 38
Limitations of DNA
C–17
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. Not Reconfigured If an Area controller is added by mistake to a network, do not Reconfigure the Area controller. The addresses of the other System and Subnet controllers will not change unless Reconfigure is used. Remove the unwanted Area controller from the network.
Reconfigured If the Area controller has already been Reconfigured, it may be possible to have the controller addresses return to original settings using the Remove Area command. This feature can be used to remove unwanted Area number inheritances from the BACnet address of system and subnet controllers. To remove an unwanted Area Number setting from the network:
1
Remove the unwanted Area controller from the network.
2
Right-click a single panel with the Area setting that you wish to remove
3
Select Command->Remove Area. The unwanted Area Number will be removed from the BACnet addresses of all controllers that had inherited it.
If Remove Area is not sufficient, then you can try the following procedure.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–17
C–18 Derived Network Addressing (DNA)
To return controller address to original settings if Reconfigured by mistake and Remove Area is not sufficient: 1
With the Area controller removed, select BACnet Protocol in the left pane of Navigator.
2
Select all of the controllers with the incorrect address in the right pane.
3
Right click, choose Command-and click Reconfigure.
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.
DCUs on MS/TP Segments MS/TP is meant for communication between V3 Subnet devices and system controllers. Multiple DCU controllers do not function properly when connected together on the same MS/TP wire. The RS-485 Port on a DCU controller is like the NET2 Port on a DSC controller; it is meant to talk to DACs. Normally, Subnet devices communicate on an MS/TP network. This architecture creates the potential for Area conflicts, Subnet configuration problems, and Addressing conflicts. It is recommended to use a single System Device to begin an MS/TP network, and not to use it as part of a Subnet MS/TP network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–18
Total Pages in this Appendix: 38
Architectures to Avoid
C–19
The following figure is an example of invalid use of MS/TP:
Ethernet MS/TP
DCU DCU DCU DCU System 14 System 12 System 22 System 02 However, DCU controllers can communicate with multiple DSC system controllers over the same MS/TP wire.
Multiple Area Devices on Same Network Segment The DNA approach aims to provide a logical and consistent method for addressing Version 3 controllers. A segment with System controllers can only have one Area controller as each System controller inherits part of its address from the Area device on the same segment. An Area Device on a network segment attempts to reconfigure the addresses of the System Devices on that segment to its area scheme. If you have more than one Area Device on a network segment, each tries to reconfigure the System Devices to match its area addressing scheme. The System Devices continually change their Device Numbers to fit under each of the Areas. The following figure shows an invalid arrangement.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–19
C–20 Derived Network Addressing (DNA)
Ethernet Network Segment
Ethernet Network Segment Router
Area Level
DSM-050
BACnet MSTP Network
System Level
BACnet MSTP Network
DSM-050
LINKnet Newtork communicating @ 76.8 Kbaud
LINKnet Level
LINKnet Newtork communicating @ 76.8 Kbaud
Subnet 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–20
Total Pages in this Appendix: 38
Architectures to Avoid
C–21
Non-Area Devices as BBMDs It is recommended to designate an Area Controller as the BACnet Broadcast Management Device (BBMD) device. The function of a network will be much clearer when viewed in Navigator as the controller which acts as both Area and BBMD will display at the top of the tree. It is not recommended to designate a System controller as the BBMD when it is configured under an Area controller. The Area controller should be designated as the BBMD. This following figure shows a valid network arrangement as the Area Devices also act as the BBMD devices. UDP/IP R
Ethernet Network #1 Valid Arrangement Area Devices 14 and 02
R
Routers
BBMD Devices
Ethernet Network #2
Other Controllers
Other Controllers
DCU Area 14 DCU System 140100
DCU Area 02 DCU System 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.
Addressing V2 Micros and Zones If possible, V2 micros and P-Zones should be addressed using the same scheme that was previously used in V2. For example, a V3 DCU with an address of 100 could have micros addressed as 101-199 attached to it. The 101-199 range is defined in the MicroNet Protocol Settings (MNP) object. The only limitation is that the V2 controllers cannot have an address higher than 32000. For example, an Area DCU with an address of 140000 would need a micro range of 14000-14199 or something similar to stay below the 32000 limit. Note: Any V3 DCUs used as IP routers that have local V2 devices(DCUs or
turbos, etc) need to be addressed lower than 32767. The address of the OWS must also be below 32767.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–21
C–22 Derived Network Addressing (DNA)
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–22
Total Pages in this Appendix: 38
Sample Network Architectures
C–23
Sample Network Architectures New Single Floor Building Installation For a single floor building installation, an Area device is unnecessary when only a few Subnet devices are on a single network. However, if an Area device is placed on the network either before or after the original installation date, it will reorganize the controllers to fit the DNA structure by reconfiguring the devices.
Workstation
Ethernet
120800 DCU Area 12
120000
DCU System 08
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.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–23
C–24 Derived Network Addressing (DNA) To commission devices on a single floor:
1
Power up the Area Device, if there is one.
2
When the Area Device is on, power up each System Device individually. If you have more than one, power them on individually and wait approximately 2 minutes before powering on the next System Device.
3
When all of the System Devices are on, power up all of the Subnet Devices.
4
Right click on the Area Device, choose Command and then select Reconfigure.
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.
Alternate Approach Depending on the situation, you could also take an opposite approach and power up all the controllers at once. Then you would use the Reconfigure Command on the Area device or on each System Device if an Area Device is not present.
New Multiple Floor Building Installation A multiple floor installation is very similar to a single floor installation. A simple approach to a multiple floor buildings is to use a separate System Controller for each floor. The separate system controller for each floor approach simplifies configuring, commissioning and troubleshooting.
Ethernet Network #1
RC 04 010204
RC 05 010205
DCU AHU 01 (System) 010100
MS/TP Network #1
Roof
DCU AHU 02 (System) 010200
MS/TP Network #2
DCU Boiler 01 (Area) 010000
Floor Two RC 01 010201
RC 02 010202
RC 03 010203
Floor One RC 01 010101
RC 02 010102
RC 03 010103
RC 04 010104
RC 05 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–24
Total Pages in this Appendix: 38
Sample Network Architectures
C–25
To commission devices on a multiple floor building:
1
Power on the Area Device first when first configuring the network. Wait approximately 2 minutes.
2
When the Area Device is on, power up each System Device individually. If you have more than one, power them ON individually and wait approximately 2 minutes before powering ON another System Device.
3
Power ON all the Room Controllers (DACs) for each floor.
4
Select and right click each System Device.
5
Choose Command and select Reconfigure.
New Multiple Building Installation Consider the situation where you have two buildings with a maintenance crew working from one of those buildings. The crew wants to monitor both buildings and if possible correct problems remotely. In this situation, an extended connection such as the Internet or some other extended IP communication system may be used. Building 2
Building 1 UDP/IP (Internet)
Ethernet #1
Hub
Other Controllers
Hub
DCU Area 01
DCU Area 02
Ethernet #2
Other Controllers
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.
Total Pages in this Appendix: 38
•
The need for extended cabling or modem connections to connect two buildings is avoided by using an existing framework of cabling (the Internet).
•
System Devices do not reconfigure themselves to remote Area Devices in other building. DNA information does not pass over UDP/IP networks.
•
Navigator displays each building in a different Network tree segment. Building 1 is 010000 and building 2 is 020000.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–25
C–26 Derived Network Addressing (DNA)
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.
Modem
Modem
Ethernet #2
Workstation
DCU Area 02
020000
DCU System 02
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–26
Total Pages in this Appendix: 38
Network Numbers
C–27
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.
Network Number Assignments In the DNA system, there are three parts to a Network Number: the Network Type (or Media which it is using), Area Device, and System Device. The final Network Number will be a five digit number in the form of NAASS, where •
N is a single digit that denotes the network type,
•
AA is the Area Number, and
•
SS is the System Number.
The only type of Network that does not follow this scheme is a PTP Serial Connection. The Network Type (N) is assigned according to the following convention:
N
Ethernet
MS/TP (NET1) System Level MS/TP
Intelli-Net (DCU)
UDP/IP
MS/TP (NET2) Subnet DAC MS/TP
1
2
3
4
5
The AA and SS portion of the Network Number is assigned based on the controller that the network is attached to. If the address of the controller is 080000 it would have an AA of 08 and an SS of 00.
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.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–27
C–28 Derived Network Addressing (DNA)
Examples The order that the devices are powered up sets the Network Numbers.
Ethernet Network Number 10800
Powered Up First DCU System 22
DCU Area 08
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
DCU Area 08
Powered Up First
DCU System 22
Note: It is recommended to wait 2 minutes before powering up each controller.
Waiting two minutes each time ensures that the Network Numbers are set correctly for new controller. This approach is only required when the devices are first powered up on the network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–28
Total Pages in this Appendix: 38
Error Messages
C–29
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
If you connect ORCAview or a controller by more than one physical connection, then a circular network is created and the previous messages displays. This error can be difficult to troubleshoot, as it may be hard to find the cause. In the following figure, ORCAview and the DCU are connected via multiple connections. This is an invalid network arrangement because a circular network exists. Ethernet I-Net
DCU Area 08 Workstation OWS 27216
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–29
C–30 Derived Network Addressing (DNA)
Duplicate Controller Addresses
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 System 059 565900
DCU System 059 565900
Duplicate Network Numbers (Duplicate Routers)
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–30
Total Pages in this Appendix: 38
Error Messages
C–31
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: To correct a Duplicate Network numbers (Duplicate Routers) error:
1
Select all of the System controllers that are connected and online.
2
Right click on the group of controllers, choose Command, and then select Reconfigure. This will force this group of controllers to find a new Network Number that is not in conflict.
Automatic Address Conflict
An automatic address conflict occurs if a controller is connected to the network but does not use the same Network Number as the rest of the controllers sharing the same network segment. Also, the previous DNA address may not match the present network configuration. 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.
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–31
C–32 Derived Network Addressing (DNA)
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. Software addressing is required when: •
A single Ethernet LAN is required to connect to more than 99 system controllers. These flat networks cannot use Area Devices.
•
All controllers must be within a certain range of addresses (e.g. 800-8999) for a particular site.
Sometimes it is not possible to use DNA addressing. Some sites have devices from multiple vendors on the same network, and specific ranges of addresses may be set for each vendor. This would restrict DNA addressing to the allowed range. For example, if an address range of 800-900 was given for a site, then only two System level controllers could be connected using DNA. Software addressing was included for these types of situations. 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.
How to Configure a Software Addressed DCU Controller To configure a DCU controller using Software Addressing:
1
Connect the controller onto the network and power it ON.
2
Open the BACnet Protocol Settings (BCP) or NET object in the new controller and record the Network Numbers for later use.
3
On the Description tab of the Device (DEV) object, enter an address in the Software Address field and then click OK.
4
Turn off the controller, select the Software Addressing mode as described in the following table.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–32
Total Pages in this Appendix: 38
Software Addressing
C–33
How to select Software Addressing mode for a controller DCU
DSCxxxxE
DSCxxxx
(Ethernet)
(No Ethernet)
DAC
DIP Switches
All Open / OFF
Anything but not 0
Different from all other DSCs on the same MS/TP network
Different from all other DACs on the same MS/TP network but not 0
DNA Jumper
Not Apply
Open
Open
Open
5
Power the controller back ON. The controller is in a non-operational mode and displays in Navigator with a yellow wrench over the controller icon.
The following type of message displays:
Total Pages in this Appendix: 38
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.
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–33
C–34 Derived Network Addressing (DNA) a) DCU Controller: BCP object:
b) DSC or DAC Controller NET Object:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–34
Total Pages in this Appendix: 38
Software Addressing
8
C–35
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.
How to Configure a Software Addressed Room Controller Unlike other controllers, the Room Controller does not have a hardware jumper for selecting either DNA or software addressing mode. The addressing mode is selected through the Configuration menu using the controller’s keypad. Disabling DNA on a Room Controller puts the controller into the software addressing mode and the desired controller address is specified. To configure a Room Controller for software addressing:
1.
Enter into the Configuration menu by holding down the two inner keypad buttons in the top row of the controller’s keypad while applying power to the controller. Release the keypad buttons once the LCD screen appears as shown below.
NO
EXIT
This will display when the controller is in the Configuration Menu.
Hold down these two buttons while applying power to the controller.
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. 2.
Disable DNA by following these steps: a.
Press the right-most button in the top row of the controller’s keypad until the LCD screen appears as shown below.
ON DNA
Total Pages in this Appendix: 38
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–35
C–36 Derived Network Addressing (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:
The AREA, SYSTEM, and ADDRESS portions take up two digits, while the OEM portion takes up only one digit in the controller’s Address. For example, if you enter the following values: OEM = 0 AREA = 1 SYSTEM = 22 ADDRESS = 3 The address would be: OEM 0
AREA 01
SYSTEM 22
ADDRESS 03
=
Address 12203
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.
In order to enter the address, follow these steps: 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).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–36
Total Pages in this Appendix: 38
Software Addressing
C–37
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.
Total Pages in this Appendix: 38
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).
ORCAview 3.40 Technical Reference Manual Ed. 1.80 Original Page C–37
C–38 Derived Network Addressing (DNA) 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.
The controller will reset and resume normal operation. The controller is now in software addressing mode and will appear on the network with the address you specified. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page C–38
Total Pages in this Appendix: 38
Appendix D – USING ORCAVIEW WITH VERSION 2 SITES 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
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-1
D-2
Using ORCAview with Version 2 Sites To read a Value from a Version 2 DCU: .............................. D-37 Passing Values between Version 3 DCUs and Version 2 Micros / Pzones / DACs ................................................................................................ D-38 To Pass the Value of a Input from a Micro to a Version 3 DCU: ............................................................................... D-38 DSC-R2424E COMMUNICATION WITH V2 CONTROLLERS ................................ D-40 To add a network of V2 controllers to a DSC-R2424E: ....... D-41 TRANSFERRING VALUES BETWEEN DSC-R2424E AND V2 CONTROLLERS........ D-42 Passing Values between DSC-R2424E and V2 Micros / Pzones / V2 DACs .................................................................................................. D-43 RESTRICTION OF INTELLINET ROUTING INFORMATION ..................................... D-45 To enable routing restriction on a controller:........................ D-46 Example 1:.......................................................................................... D-46 Example 2:.......................................................................................... D-47 Adding V3 Controllers to an Existing V2 Site .................................... D-47 Replacing V2 Controllers with V3 Controllers .................................. D-49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-2 Total Pages in this Appendix: 49
Overview
D-3
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. Enable Delta Version 2 Protocol If the Operator Workstation (OWS) was installed so that only BACnet was the default protocol you may experience problems seeing the Version 2 controllers on the network. This is because the Delta Version 2 protocol was not enabled during the installation. The solution is to enable the Delta Version 2 protocol on the Site settings (SS) object. Disable Delta Version 2 Protocol Sometimes the Delta Version 2 protocol may be enabled on a site that contains only Version 3 controllers. ORCAview fails a Version 2 user security check every time you log into the site. A notification displays when the Version security check fails. The solution is to disable the Delta Version 2 protocol on the Site Settings (SS) object. To enable or disable the Delta Version 2 protocol for a particular site:
1.
From the ORCAview dashboard, choose Tools, select Setup, and then click Site… The Site Settings (SS) object opens.
2.
Select the Application Protocol tab on the Site Settings (SS) object and enable or disable the Delta Version 2.
Enable the Delta Version 2 protocol by clicking on the corresponding checkbox. A check mark indicates that the protocol is enabled. —OR— Disable the Delta Version 2 protocol by clicking so that no check mark displays.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-3
D-4
Using ORCAview with Version 2 Sites 3.
Click Apply or OK.
Security with Version 2 Controllers For sites that have Version 2 controllers installed, security is handled as it was in OWS 3.10. A specific Version 2 controller is designated the Security Panel. When someone wants to login to ORCAview, the username and password entered at the login screen is compared to 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.
Site Settings Object The Site Settings (SS) object determines whether the Version 2 protocol is enabled and sets the addresses of both the Version 2 and the BACnet Security Panels. The BACnet Security Panel is currently optional. However, when the Version 2 Protocol is enabled, a V2 Security Panel must be specified. If the correct Security Panel is not specified, then Navigator will not log into any Version 2 controllers.
Enter the V2 security controller here.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-4 Total Pages in this Appendix: 49
Security with Version 2 Controllers
D-5
Creating a New User When a new System User Access object is created it is not necessary to create a duplicate User Access (UA) object on the V2 Security Panel. The OWS automatically creates a corresponding User Access (UA) object on the V2 Security Panel. The flowchart below shows the process that the OWS uses when a new user is created: User creates a new System User Access (SUA) object on the OWS.
OWS checks for a V2 security panel in the Site Settings (SS) object.
Yes
Is a V2 Security panel online?
OWS creates a corresponding User Access (UA) object in the V2 security panel.
no
OWS will not create any corresponding UA objects since the V2 security panel is not online.
The following sequence is shown in the previous figure: 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.
The Username and Password have the following characteristics:
Total Pages in this Appendix: 49
•
The username and password are not case sensitive. ORCAview automatically converts all V2 user names and passwords to upper case.
•
The username and password can only be made up with characters acceptable in Version 2. Do not use characters such as ( \ /:*?"< >| ) when typing the username or password. The first character of a username cannot be a number. The username and password are forced to be uppercase and can have a maximum length of 16 characters. This is to ensure that the BACnet
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-5
D-6
Using ORCAview with Version 2 Sites SUA object is compatible with the User Access (UA) object in Version 2 controllers. To create a new User:
1.
From the ORCAview dashboard, choose File, select New and then click User… A System User Access object displays.
1
Switch to the “Setup” tab.
3.
Enter a valid Username (Limited to 1 - 16 characters).
4.
5.
Enter a valid password (Limited to 4 -14 characters).
Now click Apply on the SUA object.
When the Apply button is pressed, the OWS automatically creates a User Access (UA) object on the V2 Security Panel and a System User Access (SUA) object on the V3 Security Panel. If the V2 Security Panel already contains an UA object with the same name, then a dialog similar to the following displays:
If the previous dialog displays, click OK and adjust the password in the SUA on the OWS and in the V2 UA object.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-6 Total Pages in this Appendix: 49
Security with Version 2 Controllers
D-7
Deleting a User from the System The OWS automatically creates corresponding users on the Security Panels, and will also delete them when a SUA is deleted from the OWS. 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.
Logging in with a New User When a user logs into a site, the OWS verifies the username and password in 3 different places. The username and password is verified in ORCAview, the V3 Security Panel, and the V2 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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-7
D-8
Using ORCAview with Version 2 Sites The following flowchart shows how the security works at login: User enters Username and Password at login dialog.
ORCAview confirms the username and password in the SUA on the workstation.
Did user pass the ORCAview security check?
Yes
ORCAview confirms the username and password in the SUA on the V3 security panel.
No
User cannot log in to ORCAview.
Did V3 security panel pass security check?
Yes
No
ORCAview confirms the username and password in the UA on the V2 security panel.
Navigator will not display any V3 devices except local workstation.
No
Did V2 security panel pass security Check?
Navigator will not display any V2 devices.
Yes
Navigator will display all V2 devices.
The sequence shown in the previous figure: 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-8 Total Pages in this Appendix: 49
Security with Version 2 Controllers
D-9
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.
Setting Permissions for Version 2 Objects The V2 security system allows for every user to have different set of permissions. For example, there may be users that have their access restricted only to displaying objects. Some users may have full editing capabilities for all objects. 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 To set the permissions for a specific type of object:
1.
Select the Version 2 Security Panel in the left hand pane of Navigator.
2.
Open the User Access object in the right hand pane of Navigator.
3.
4.
5.
Total Pages in this Appendix: 49
Select the type of object that you wish to adjust the permissions for. Enable only the permissions you wish the user to have. In this example, the user can only display a V2 Input. They will not be able to edit any of the parameters for the Input.
Click OK or Apply.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-9
D-10
Using ORCAview with Version 2 Sites
To set all objects to the same permissions for a user:
1.
Select the Version 2 Security Panel in the left hand pane of Navigator.
2.
Open the User Access object in the right hand pane of Navigator.
3.
Select any type of object
4.
Enable only the permissions you wish the user to have. In this example, the user can only display a V2 Global Variable. They will not be able to edit any of the parameters for the Global Variable.
5.
Click the Set All button. This will duplicate the permissions onto all the Version 2 objects.
6.
Click OK or Apply.
Alarms from Version 2 Controllers The Event Management system in ORCAview has been designed to provide compatibility with version 2.9x controllers. ORCAview functions like version 3.10 Commander OWS in many respects. This section identifies the similarities and differences between Commander OWS 3.10 and ORCAview. Common alarm tracking and logging solutions are presented.
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-10 Total Pages in this Appendix: 49
Alarms from Version 2 Controllers
D-11
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.
Viewing Active Version 2 Alarms in Navigator When a Version 2 alarm becomes active, the details about it are stored in the Active Alarm List in ORCAview. The Active Alarm List in ORCAview can be viewed via the Active Alarms Folder in Navigator. Alarm Name
Alarm Status
Time of Alarm
Alarm Input Object
Class
Alarm Message
Alarm Type
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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-11
D-12
Using ORCAview with Version 2 Sites
Configure Navigator to display only active alarms here.
Loading Active Version 2 Alarms at Login When ORCAview logs into a site it checks the system for any alarms that may have become active while it was logged out. Depending on the architecture of your network there are two different places that ORCAview checks for active Version 2 alarms. 1
Alarm Report objects on Version 2 DCUs
2
Active Alarm Lists on V3 DCUs
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.
Routing V2 Alarm Notifications to Printers, Files, and Event Logs In networks where there is a mixture of V3 and Version 2 controllers it may be necessary to send Version 2 alarms to a printer that is attached to a V3 controller. You may also want to log the Version 2 alarm notification in an Event Log (EVL) on a V3 controller. A V3 DCU controller that acts as a router must have an address lower than 32767 if there are V2 devices on the network.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-12 Total Pages in this Appendix: 49
Alarms from Version 2 Controllers
D-13
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 Method 1: “Direct Report To”
•
Note: For an OWS to print alarm notifications received from a V2 Micro
subnetted off a V3 controller, it must use an Event Router in the OWS. The Direct Report to field on a V2 Alarm object will not print to the Windows printer in this situation. Method 2 describes the setup procedure.
To configure the individual Version 2 alarms to print to the Windows printer:
1.
Open the desired Alarm.
2.
Enable the “Use OWS Printer” checkbox.
3.
Select the Windows printer that the V2 alarm notification is to print from.
4.
Click OK.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-13
D-14
Using ORCAview with Version 2 Sites Method 2: Use an Event Router and the Printer Settings in ORCAview
•
To use an Event Router to send the Version 2 notification to a printer:
1.
In the Navigator, open the Printer Event Router object that was created by default .
2.
Enter the alarms that the EVR is to route to the printer.
3.
Click OK.
The previous example routes only alarm 101.AL1 to the Epson printer. The Class/Event field will accept other entries as well: Class/Event Field Entry
Function
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.
Sending Version 2 Alarm Notifications to an Event Log Version 3 controllers will accept and log Version 2 alarm Notifications. The procedure for logging Version 2 alarm notifications is similar to the method for sending the notification to a Windows printer utilizing an Event Router (EVR) object. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-14 Total Pages in this Appendix: 49
Alarms from Version 2 Controllers
D-15
To log the Version 2 notification to an Event Log:
1.
2.
Create an Event Log (EVL) object on a V3 DCU. Name it “Critical Version 2 Alarm Log”. Click OK.
On the Alarm Filtering tab, enter Critical as the class of event to log
3.
Click OK.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-15
D-16
Using ORCAview with Version 2 Sites 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 resulting classes in the system would be something like: EVC Object Instance
EVC Object Name
EVC1
Maintenance (V2)
EVC2
Network (V2)
EVC3
Security (V2)
EVC4
Critical (V2)
EVC5
Notification (V2)
EVC6
Fire (V2)
EVC7
Access Control Event (BACnet)
EVC8
Access Control Alarm (BACnet)
EVC9
Archivial (BACnet)
EVC10
Maintenance (BACnet)
EVC11
Network (BACnet)
EVC12
Security (BACnet)
EVC13
Critical (BACnet)
EVC14
Notification (BACnet)
EVC15
Fire (BACnet)
You would then have all V3 events reference EVC10 - EVC15.
Filtering Version 2 Alarm Notifications from ORCAview ORCAview uses the Event Filter (EVF) object to filter alarm notifications. Alarm filtering is done in the same way for Version 2 and Version 3 alarms. In Version 2 alarm (AL) objects, you are required to select an Alarm Type. The OWS treats the Version 2 alarm type as a event class. In other words, a Version 2 alarm of the type “Security” will be handled as if it were of the class “Security” (EVC3). The Priority Override option only applies to V3 alarms. V2 alarms ignore the priority override value stored in the EVF object.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-16 Total Pages in this Appendix: 49
Alarms from Version 2 Controllers
D-17
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. To filter Version 2 Security type alarms from the OWS:
Total Pages in this Appendix: 49
1
Select the local workstation in the left pane of the Navigator window.
2
Right click in right hand pane of Navigator and select New
3
From the Create Object window, select Event Filter (EVF) and give it a valid name. Click OK.
4
From the EVF dialog, double click in the first column of the Disallowed Alarms dataview and select Security from the drop-down list.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-17
D-18
Using ORCAview with Version 2 Sites
5
Click Apply or OK.
6
Open the System User Access (SUA) object for the user that you wish to apply the newly created filter to.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-18 Total Pages in this Appendix: 49
Alarms from Version 2 Controllers 7
D-19
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.
Select the Event Filter object here.
8
Click Apply or OK.
Now, ORCAview does not display alarm notifications generated by Version 2 Security alarms to user Dale. The active Version 2 Security alarms do not display in the Active Alarms folder either. 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: Creating EVC10 as “V2 Critical” will not work. V2 alarms types are WARNING
Total Pages in this Appendix: 49
equated directly to EVC1 - EVC6.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-19
D-20
Using ORCAview with Version 2 Sites The resulting classes in the system would be something like: EVC Object Instance
EVC Object Name
EVC1
Maintenance (V2)
EVC2
Network (V2)
EVC3
Security (V2)
EVC4
Critical (V2)
EVC5
Notification (V2)
EVC6
Fire (V2)
EVC7
Access Control Event (BACnet)
EVC8
Access Control Alarm (BACnet)
EVC9
Archivial (BACnet)
EVC10
Maintenance (BACnet)
EVC11
Network (BACnet)
EVC12
Security (BACnet)
EVC13
Critical (BACnet)
EVC14
Notification (BACnet)
EVC15
Fire (BACnet)
You would then have all V3 events reference EVC10 - EVC15.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-20 Total Pages in this Appendix: 49
ORCAview Auto-Answer for V2 Alarms
D-21
ORCAview Auto-Answer for V2 Alarms ORCAview can be configured to accept V2 Alarm Notifications that are coming in via modem connection. ORCAview will wait for the modem to receive a transmission, establish a connection with the remote network and finally accept the V2 Alarm Notification. 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. Two Auto-Answer Methods:
Total Pages in this Appendix: 49
•
Wait for Call
•
Login & Disconnect
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-21
D-22
Using ORCAview with Version 2 Sites Method 1: Wait for Call The Remote OWS is configured to wait for V2 Alarm Notifications that are coming in via the modem. To configure ORCAview to only wait for Alarm Notifications:
1.
Start up ORCAview.
2.
Enter the Username and Password.
3.
Select the proper Protocol from the Connect Using drop-down list.
4.
Select the Connect Type.
5.
Select the modem
6.
Ensure that the Speed is at 9600.
7.
Click OK
Once ORCAview is successfully logged into, it is ready to receive alarm notifications that are coming in via the modem. Navigator will appear as shown below. No devices will appear in the network tree since a network connection has not actually been established.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-22 Total Pages in this Appendix: 49
ORCAview Auto-Answer for V2 Alarms
D-23
Method 2: Login & Disconnect To configure ORCAview to receive Alarm Notifications and allow immediate network connection:
1.
Start up ORCAview.
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.
4.
Select the proper connection here.
5.
Select the Modem Dial-Out Connect type.
6.
Select Modem (MDS) object.
7.
Ensure that the Speed is at 9600.
8.
Enter the Phone Number.
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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-23
D-24
Using ORCAview with Version 2 Sites 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”
Once the network is disconnected ORCAview is still in auto-answer mode and will receive any alarms that are dialed into it. Also the Remote Panel Settings can be right clicked on and reconnected to at any time. 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 Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-24 Total Pages in this Appendix: 49
ORCAview Auto-Answer for V2 Alarms
D-25
V2 DCU Communicate with OWS via Modem In order for the V2 DCU communicate with OWS via modem the following objects must be set up: 1) Configure the Modem (MD) Object on the V2 DCU.
Enter the number of the remote panel that is to be connected via modem.
Enter the necessary modem dialing prefixed (i.e. ATDT for modems that support the AT command set).
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-25
D-26
Using ORCAview with Version 2 Sites
2) Configure the Control Panel (CP) object. The alarm destination on the main tab should NOT reference MD object created in step 1.
3) Configure the serial_Inet (NT4) object. Enter the panel number of the remote panel that all broadcast messages should be sent to. You must enter a number other than zero to enable Serial INTELLINET. Set the routing Timeout to 60 seconds.
4) Reset the V2 controller so that the settings take effect.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-26 Total Pages in this Appendix: 49
ORCAview Auto-Answer for V2 Alarms
D-27
Version 2 Trend Log 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
Improved Graph area.
Display Samples adjusts the number of samples shown in the graph
. Auto Range automatically adjusts the y axis values to fit the range of sample values.
High Range adjusts the maximum value of the Y axis.
Low Range adjusts the minimum value of the Y axis.
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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-27
D-28
Using ORCAview with Version 2 Sites 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.
Examples of Trend Log Options All the following examples show the same trend log. Only the ranges have been adjusted. In the following figure, Auto Range is enabled (default).
In the following figure, Auto Range is disabled and the High Range is adjusted to exceed the maximum sample value.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-28 Total Pages in this Appendix: 49
ORCAview Auto-Answer for V2 Alarms
D-29
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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-29
D-30
Using ORCAview with Version 2 Sites
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.
Version 3 DCUs with a Sub-Net of Version 2 Micros / PZones / DACs This section outlines the procedures to follow when setting up Version 2 Zone Controllers and Micro Controllers networked directly off a V3 DCU 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. Note: Network performance will decrease if a ZC object is created before a
corresponding V2 zone controller is physically added to the subnet. This is a concern especially if a lot of V2 communications is occurring such as when an OWS starts and loads the Descriptors for all the Micros. If a ZC is created for a
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-30 Total Pages in this Appendix: 49
Version 3 DCUs with a Sub-Net of Version 2 Micros / PZones / DACs
D-31
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. The V3 DCUs supports an RS-485 network of Version 2 Micro Panels or DACs. By default, the Version 3 DCU has been configured to support Version 3 MS/TP controllers from the RS-485 port. Do these tasks to add a network of Version 2 Micro Panels to a Version 3 DCU: I.
Configure V2 security and enable V2 protocol for the site
II.
Disable the MS/TP network in the BACnet Protocol Settings (BCP) object.
III.
Enable MicroNet protocol and set Micro range in the MicroNet Settings (MNP) object.
IV.
Reset the DCU.
The following two procedures outline the detailed steps.
For Micro Controllers to display in the Navigator network tree, Version 2 Protocol must be enabled. To configure V2 security and enable V2 protocol for the site:
Total Pages in this Appendix: 49
1
Open the Site Settings Object (SS1) in the local OWS Workstation.
2
Click on the Advanced tab and enter a valid address in the V2 Security Panel field.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-31
D-32
Using ORCAview with Version 2 Sites 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.
To add a sub network of Version 2 Micro panels to a V3 DCU:
1.
Open the BACnet Protocol Settings (BCP) object on the Version 3 DCU that has the Micro Panels.
1.
In the Setup tab of the BCP object, select the MS/TP (RS-485) Port Settings and disable it by double clicking the Enable checkbox.
3.
Click OK.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-32 Total Pages in this Appendix: 49
Version 3 DCUs with a Sub-Net of Version 2 Micros / PZones / DACs
D-33
4.
Open the MicroNet Protocol Settings object on the Version 3 DCU.
5.
Enable the MNP network here.
6.
Enter a valid micro range in the First Micro and Last Micro fields. These fields are the same as the CP Lowest Micro and Highest Micro fields.
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
Total Pages in this Appendix: 49
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-33
D-34
Using ORCAview with Version 2 Sites
Changing Micro Addresses In V3 ORCAview As with Version 2 Micro Controller or Zone Controller, addresses can be checked using the Get Address button when only a single V2 Micro Controller is online. However, if you know the address of the micro that you want to change, you can have more than one device online when changing the address. The address must not be changed to the address of another connected device. To change a V2 micro address using MicroNet
1.
Open the MNP Object in the Device that hosts the Micros and Click the Get Address Button.(The present address will appear in the Present field).
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.).
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-34 Total Pages in this Appendix: 49
Changing Micro Addresses In V3 ORCAview
Total Pages in this Appendix: 49
D-35
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-35
D-36
Using ORCAview with Version 2 Sites
Data Exchange between Version 2 Controllers and Version 3 DCUs In V3 DCUs, the programmer has been given the ability to perform data exchange between a Version 2 controller and a Version 3 DCU. DSC/DAC products with Version 3 firmware do not support communicating with V2 controllers. They cannot exchange data or route V2 network traffic. If V2 network traffic needs to be routed, a DCU is required. True data exchange is only available between V3 DCUs and Version 2 DCU/Turbo/Mini Turbo/Intellicon Plus. Instructions for passing a Version 2 Micro value to a Version 3 DCU using the Version 2 Zone Controller (ZC) object are given in the Passing Values between Version 3 DCUs and Version 2 Micros / Pzones / DACs section starting on page D-38.
Writing a Version 3 Value to a Version 2 Global Variable Some additional V2 controller types can be written from a V3 controller with the following V2 firmware loaded. Controller
DCU
PLUS
Turbo
Mini Turbo
IntelliCon
2.92 Build
26
26
27
27
27 (must be at least HW Rev. 3)
Note: The 292 Build 27 is not available for general release, contact Delta
Customer Solutions for more information.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-36 Total Pages in this Appendix: 49
Data Exchange between Version 2 Controllers and Version 3 DCUs
D-37
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.
To write a Version 3 value to a Version 2 controller:
1.
Create a new Global Variable (GV) on the Version 2 controller and name it. For this example, we use OAT as the name for GV1.
2.
Create a new Program (PG) on the Version 3 DCU and name it something like V2 Data Exchange. For the sake of organization it is recommended that all data exchange between a Version 2 and a Version 3 DCU be contained to a single program on the Version 3 DCU.
3.
When initiating the data exchange through GCL+, a DoEvery must be used to minimize the impact on the Version 3 DCU scan rate. In the program add the following lines: DoEvery 1M
1.GV1 = AI1
End Do
The 1 in 1.GV in the previous code is the address of the V2 controller that is written from the V3 controller. 4.
Click OK on the program.
5.
In the main program (PG1), add a line to CALL the new PG created above.
Version 3 Reading a Value from a Version 2 Point The example below shows how to read the outdoor air temperature from an Input (IP) in a Version 2 controller, and set a Version 3 Analog Variable (AV) equal to the value. To read a Value from a Version 2 DCU:
1.
Create a new Analog Variable (AV) on the Version 3 DCU and name it. For this example, we use Outdoor Air Temperature as the name for AV1.
2.
Create a new Program (PG) on the Version 3 DCU and name it something like V2 Data Exchange. For the sake of organization, it is recommended that a single program on the Version 3 DCU contain all the data exchange between a Version 2 and a Version 3 DCU.
3.
In the program add the following line: AV1 = 1.IP1
Note: When coding values for a remote controller, DoEvery is not recognized. By
default, V2 controllers only send data every minute.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-37
D-38
Using ORCAview with Version 2 Sites The 1 in 1.IP in the previous code is the address of the V2 controller that is read from the V3 controller. 4.
Click OK on the program.
5.
In the Main Program (PG1), add a line to CALL the new PG created in the step 2.
Passing Values between Version 3 DCUs and Version 2 Micros / Pzones / DACs When the Version 3 DCU has a sub-network of Version 2 Micro Panels or DACs, it may be necessary to pass a value between the two controllers. This can be done using the Version 2 Zone Controller (IC) point on the Micro Panel and a Version 3 Zone Controller (ZC) object on the Version 3 DCU. 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). To Pass the Value of a Input from a Micro to a Version 3 DCU:
First Task: Setup an IC and IF on the Micro Panel. 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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-38 Total Pages in this Appendix: 49
Data Exchange between Version 2 Controllers and Version 3 DCUs
D-39
Decommissioned, a lock symbol shows beside it in the Right Pane of the Navigator window when in the Detail View.
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
3.
End Do
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. 2.
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. 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.
Note: Network performance will decrease if a ZC object is created before a
corresponding V2 zone controller is physically added to the subnet. This is a concern especially if a lot of V2 communications is occurring such as when an OWS starts and it loads the Descriptors for all the Micros. If a ZC is created for a currently unconnected controller, put the ZC in Manual mode until the controller is connected. The ZC must have the same object number as the Micro’s address. For example, ZC1 is for the micro with address 1.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-39
D-40
Using ORCAview with Version 2 Sites 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. 2.
Create new Program (PG) on the Version 3 DCU and name it ZC Transfer.
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.
DSC-R2424E Communication with V2 Controllers The DSC-R2424E is a Version 3 replacement product for the V2 Intelli-Con, Turbo and Plus panels (ICP-010, ICP-015, ICP-03x). This controller has two RS485 ports (one for the V2 Zone protocol and one for V3 MS/TP). All V2 Zone controllers and Micro controllers (including Programmable Zone controllers, and DACs running V2 firmware) are treated as Zone controllers and are accessible through V2 Zone Controller (ZC) objects. A ZC object must be created for each Zone on the network (ZC instance number matches the address of the Zone). Each Zone must have a unique address. Note: Micro/Pzone programming is not supported. Micros are not shown in
Navigator as subnet controllers. They are only visible through ZC objects. Therefore, any programming changes will require local access to the micro using an OWS with Micronet (OWS 3.22 Build 490). The alternative is to replace the Micro with a V3 DAC and connect via the MS/TP port on the DSC-R2424E.
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.) The following is a summary of the tasks required to add a network of V2 controllers to a DSC-R2424E. Each task is further described in the following steps: V.
Connect all V2 Zones to the Zone Port of the DSC-R2424E
VI.
Open the NET object and enter Start and End zone addresses
VII.
Trigger an automatic scan to find online Zones. (ZC objects will be created automatically.)
VIII.
Verify Zone communications and adjust polling Interval if necessary
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-40 Total Pages in this Appendix: 49
DSC-R2424E Communication with V2 Controllers
D-41
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.
To add a network of V2 controllers to a DSC-R2424E:
5.
Connect all V2 controllers (including zones, micros, pzones, and DACs running V2 firmware) to the Zone Port of the DSC-R2424E. Ethernet
RS-485 Zone Network
Zone
Micro
PZone
V2 DAC
DSC-R2424E
2.
Open the BACnet Settings (NET) object of the DSCR2424E and change the address range to include all Zones.
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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-41
D-42
Using ORCAview with Version 2 Sites
Change the value in the New Address field to a unique address in the zone network, and then click the Apply button
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.
Transferring Values between DSC-R2424E and V2 Controllers All data transfer between a DSC-R2424E and its Zone controllers is via Zone Controller (ZC) objects. True V2 to V3, Peer-to-Peer Data Exchange is a feature of the V3 DCU. It is not provided by the DSC-R2424E. Instructions for passing a V2 Micro value to a DSC-R2424E using the Zone Controller (ZC) object are given below.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-42 Total Pages in this Appendix: 49
Transferring Values between DSC-R2424E and V2 Controllers
D-43
Passing Values between DSC-R2424E and V2 Micros / Pzones / V2 DACs I/O points on a Micro are accessed through a V3 Zone Controller (ZC) object on the DSC-R2424E. A V2 Zone Controller (IC) point must exist in the Micro Panel and be configured appropriately. 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:
Total Pages in this Appendix: 49
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
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-43
D-44
Using ORCAview with Version 2 Sites Example: Reading Room Temperature (IP1) from a Micro controller into an analog variable on the DSC-R2424E. First Task: Setup an IC and an IF on the Micro controller. 1.
On the Micro, create a Zone Control Format (IF) object.
2.
Define the Input #1 field (Inputs tab) as Room Temp. Use the drop down to select the appropriate units.
3.
Click OK.
4.
Select the Micro in the left hand pane of Navigator. Right click and choose Reload System Objects.
5.
Create a Zone Controller (IC) object on the Micro. Select the newly created IF in the Zone Controller Format field. Check the Commissioned check box.
6.
Click Apply. Ensure that the IC object displays Online.
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
2.
End Do
In the Main Program (PG1), add a line to CALL the new PG. Call ‘IC_Transfer’
Third Task: Create a ZC, a ZF and a Variable on the DSC-R2424E. 1. 2.
Create a Zone Controller Format (ZF1) object on the DSC-R2424E. Set the first Input field of the Inputs/Outputs field to Room Temp. Click OK.
3.
Attach the Micro to the Zone port of the DSC-R2424E and create a new V2 Zone Controller (ZC) object with the instance number corresponding to the Micro address.
4.
Switch to the Operation tab of the ZC and select the newly created ZF in the Format field. Check the Commissioned check box.
5.
Click Apply. Ensure that the ZC object displays Online.
6.
Create an Analog Variable (AV1) on the DSC-R2424E and name it Room Temp.
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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-44 Total Pages in this Appendix: 49
Restriction of IntelliNet Routing Information
D-45
Call ‘ZC Transfer’
When writing to ZC object properties using GCL+, delays on writes must be used. Communication problems with V2 Controllers will occur if ZC properties are written to on every database scan. It is recommended to include all writes in a DoEvery or IfOnce statement. Example: Using DoEvery Statement to set Control Mode and Setpoint1 of Zone1 DoEvery 10M
ZC1.ControlMode = ‘Day’ ZC1.SetPoint[1] = 72
End Do
Restriction of IntelliNet Routing Information When using ORCAview with Version 2 (V2) hardware, some very large sites may require that the IntelliNet routing information be restricted because of limitations in V2 controllers which allow them to talk to a limited number of controllers. Routing is the mechanism that controllers use to locate other controllers on the network. Routing information is not V2 Alarm information or Highway Output data. Routing may need to be restricted on networks with the following characteristics: •
Very large V2 networks with 100 or more controllers. (any type of V2 panel)
•
Multiple V2 Intelli-Net networks .
•
V2 controllers with controller numbers that are not sequential. For example, a large number of controllers addressed in a 1-3-5 sequence would probably require routing restrictions.
There is no hard rule as to the number of controllers that might require use of the routing restriction, it depends on the particular network. Knowledge Base Articles QA768 and QA894 provide additional useful guidelines. 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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-45
D-46
Using ORCAview with Version 2 Sites DSC/DAC products with Version 3 firmware do not support communicating with V2 devices. They cannot exchange data or route V2 network traffic. If V2 network traffic needs to be routed, a DCU is required. To enable routing restriction on a controller:
1.
Connect the controller to an ORCAview PC.
2.
Apply power to the controller.
3.
If you want to enable IntelliNet routing restriction, create a Binary Variable (BV) with the name "INET_ROUTE_RESTRICT". The name is case sensitive and must be all caps. Set the Binary Variable to active (ON).
4.
Reset the controller so that the value of the Binary Variable "INET_ROUTE_RESTRICT" is written to flash. The value of this variable is written to flash memory in case the DCU controller loses its database. The Binary Variable has a value of 1 (ON).
5.
After the resetting, the V3 controller auto creates two Analog Variable (AV) objects with the following names •
INET_ROUTE_RANGE_LOW_DEFAULT
•
INET_ROUTE_RANGE_HIGH_DEFAULT
The values of the AV objects represent the range of device numbers whose routing information is allowed to pass onto the IntelliNet segment of the DCU. Each of these Analog Variables has a default value of 0 and therefore all V2 routing information is restricted. The object reference number of these Analog Variables must be consecutive. The LOW range must be lower object reference number for this feature to work properly. For example, AV3 and AV4 are suitable objects. It is possible to rename the default ranges and to create additional ranges (up to a total of 20 ranges) so that routing restrictions is based on several ranges. Note: V2 devices do not need to be reset to enable routing restrictions, However,
the V2 devices will retain their previous routing information until the controllers are reset or their SY1 objects are reset. Therefore some V2 devices may be visible even though their routing information has been restricted. It is recommended to reset the SY1 objects on the affected V2 controllers after routing restrictions are implemented.
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:
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-46 Total Pages in this Appendix: 49
Restriction of IntelliNet Routing Information
D-47
1.
Create a BV with the name "INET_ROUTE_RESTRICT" and set its value to ON.
2.
Reset the controller.
3.
Change the value of the AV named "INET_ROUTE_RANGE_LOW_DEFAULT" to 30.
4.
Change the value of the AV named "INET_ROUTE_RANGE_HIGH_DEFAULT" to 35.
5.
Rename INET_ROUTE_RANGE_LOW_DEFAULT to INET_ROUTE_RANGE_LOW_DEVICES_30_35.
6.
Rename INET_ROUTE_RANGE_HIGH_DEFAULT to INET_ROUTE_RANGE_HIGH_DEVICES_30_35.
7.
Create an AV named INET_ROUTE_RANGE_LOW_DEVICES_110_125 and set its value to 110.
8.
Create an AV named INET_ROUTE_RANGE_HIGH_DEVICES_110_115 and set its value to 115 (ensure that the object reference number of this AV is exactly one more than the previously created AV).
9.
Reset the V3 controller and the V2 controllers.
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: 1.
Create an AV named INET_ROUTE_RANGE_LOW_OWS and set its value to 200.
2.
Create an AV named INET_ROUTE_RANGE_HIGH_OWS and set its value to 200 (ensure that the object reference number of this AV is exactly one more than the previously created AV).
3.
Reset the V3 controller and the V2 controllers.
Adding V3 Controllers to an Existing V2 Site Adding V3 controllers to a site with V2 controllers is a direct process that is not difficult. Since V2 controllers do not use Network Numbers, you should not find conflicts in the existing system. 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.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-47
D-48
Using ORCAview with Version 2 Sites Another important thing to remember is that V2 and V3 System Controllers can share the same network segment with Ethernet but Subnet Controllers do not have this flexibility. V2 and V3 controllers cannot share the same RS-485 wire. With the RS-485 port, V2 Subnet controllers use the MicroNet protocol while the V3 Subnet controllers use MS/TP protocol. Therefore, V3 and V2 Subnet controller cannot be on the same network segment with each other since they do not use the same type of protocol. Note: An RS-485 network of controllers is limited to either all V3 or all V2
controllers.
The following figure shows a valid network arrangement. Ethernet
V2 RC V2 RC
V3 DCU System 13
V2 Micronet
V3 DCU System 12
BACnet MS/TP
V2 Micronet
V2 DCU System 11
V2 RC V3 RC
Existing V2 Room Controllers attached to an existing V2 System Devices. V3 RC
V2 RC
New V3 Room Controllers attached to newly installed V3 System devices.
Existing V2 Room Controllers being attached to a newly installed V3 System device.
Note: Although V2 Subnet controllers can be attached to a V3 System Controller,
they do not fall under the DNA numbering architecture. You must manually set the addresses so that they mimic the DNA architecture by setting the First and Last Micro Address to the range desired. For more information see the MicroNet Protocol Settings (MNP) object section in the Chapter –10– Software Object Reference. When addressing V2 Subnet controllers such as Room Controllers in the MicroNet Protocol Settings (MNP) object on the V3 DCU controller, they should have their addresses set such that they match the DNA structure. This approach keeps all the addressing organized and consistent. Even though, the address range for a V2 controller is only from 1-32,767, addresses can still be structured to follow the approach of the DNA scheme.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-48 Total Pages in this Appendix: 49
Restriction of IntelliNet Routing Information
D-49
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
V3 DCU System 13
Range for V2 RC devices in the MNP object is 1301-1302.
1301
MS/TP (RS-485)
1300
V2 RC 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.
Replacing V2 Controllers with V3 Controllers It is a relatively direct process to replace a V2 controller with a V3 controller. It is similar to adding V3 controllers to an existing V2 site. There are a few points to consider when performing this operation: •
A V3 System Controller with a DIP switch address of 1 has a controller address of 100 whereas a V2 System Controller with a DIP switch address of 1 has a controller address of 1.
•
You cannot replace only one V2 Subnet Controller with a V3 Subnet Controller on an RS-485 network. You must have all the Subnet Controllers as V3 or all the Subnet Controllers as V2 because of the different protocols used to communicate with them.
•
Network Numbers do not affect V2 controllers.
•
V2 System Controllers cannot communicate with V3 Subnet Controllers. For example, a Subnet of V2 Room Controllers connected to a Turbo cannot be upgraded to V3 without changing the Turbo to a V3 System Controller.
If you wish to utilize UDP/IP, you must use V3 System controllers.
Total Pages in this Appendix: 49
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page D-49
Appendix E – WORKING WITH MS/TP AND LINKNET 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
Total Pages in this Appendix: 11
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-1
E-2
Working with MS/TP and LINKnet
Introduction This Document Audience This appendix is intended for Partner service personnel, involved in the installation and support of a facility control system. Purpose This appendix describes how to use the DSC/DAC controllers,
BACstats and DFM’s over BACnet MS/TP or LINKnet.
Supported Protocols for RS-485 (NETx) Ports All of Delta’s controllers and field modules (DFM’s) have a primary RS-485 network port (NET1). Most DSC/DAC models also have a secondary RS-485 network port (NET2). 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. LINKnet (Delta Proprietary) – All DSC/DAC controllers, BACstats and DFM’s (with the exception of the DFM-400P) support the LINKnet protocol. In addition, ADM-2W704’s (Access door module) support the LINKnet protocol. 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. Modbus – A Modbus gateway can be added to any DAC or DSC controller through Flash Loader, using Flash Loader credits. When Modbus has been added to a controller, the GW object is used for configuring which RS-485 port is configured as the Modbus network. Refer to the Modbus Gateway User Manual for information on Modbus.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-2
Total Pages in this Appendix: 11
MS/TP and LINKnet Networking
E-3
The protocol that the NET1 and NET2 ports use varies depending on the controller and the application. The typical configurations are: Ethernet DSC-Based Controller Port
Protocol
NET1
LINKnet, Modbus or BACnet MS/TP (system level)*
NET2
BACnet MS/TP (subnet level)*
Non-Ethernet DSC-Based Controller Port
Protocol
NET1
BACnet MS/TP (system level)*
NET2
LINKnet, Modbus or BACnet MS/TP (subnet level)*
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.
MS/TP and LINKnet Networking 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.
Total Pages in this Appendix: 11
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-3
E-4
Working with MS/TP and LINKnet Communications Speed All Delta devices are shipped with a default communication speed on both the NET1 and NET2 ports of 76800 baud. Changing the speed is not recommended. Unique Addresses Duplicate addresses can cause network problems. Ensure
each controller has a different address.
Cabling Incorrect installation of network cabling is another major cause of
network problems.
Power Supply Under no circumstances is a full-wave device (i.e. DCU, eTCH, or ADM) to share a common transformer with any other device. Additionally, the polarity of all connections to a single transformer is extremely important. Each controller connected to one transformer must be connected with the 24~ wires to one side of the transformer and their GND wires to the other side. Do not cross polarities. 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.
Service Port Access on MS/TP or LINKnet Most of Delta’s controllers and BACstat II’s have a service port that is accessible using either a CON-768 or a CON-768BT converter manufactured by Delta Controls. The CON-768 (direct connection) is an RS-232 to RS-485 converter. The CON-768BT is a newer, wireless, Bluetooth to RS-485 converter. Local access to the entire network is possible when using a CON-768 or CON768BT to connect an OWS on a Laptop to the network through this service port. For a CON-768, a wired connection can be made via a controller on either a LINKnet or BACnet MS/TP network with the Connect Using Serial BACnet MS / TP option in the ORCAview login dialog. For a CON-768BT, a wireless connection can be made via a controller on either a LINKnet or BACnet MS/TP network with the Connect Bluetooth: BACnet MS / TP option in the ORCAview login dialog. The Delta Controls CON-768BT 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-4
Total Pages in this Appendix: 11
LINKnet Basics
E-5
The CON-768BT allows a service technician to connect to a controller from up to 33 feet (10 meters) away. When connected via ORCAview the entire network connected to a specific controller is accessible. Upgrading controller firmware is supported directly through Flash Loader or across the network using System Loader. 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 purpose of LINKnet is to provide incremental point count expansion of Version 3 controllers, as well as providing specialized I/O in small quantities to a Delta controller (i.e. pulse inputs). LINKnet is a simple protocol for LCD thermostats (BACstat), Access Control (ADM door controller), and distributed I/O control (DFM). However, it is also capable of being used to control critical equipment (i.e. chiller/boiler pumps) where reliability and ensuring safe operation in cases of communication failure is vital. Note: The LINKnet protocol is not supported by the DCU.
Limits on Number of LINKnet Devices There is a limit on the number of LINKnet devices that can be connected to a controller. The maximum depends on the controller model. In most cases, the maximum number of BACstats is determined by the number of outputs on a DAC, and up to 12 for all DSC’s and DLC’s. 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.
Total Pages in this Appendix: 11
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-5
E-6
Working with MS/TP and LINKnet
Product Family
Model Name
Max. LINKnet Devices
Max. DFM Devices
System Controllers
DSM-RTR
0
0
DSC-1616/1616H/1616E
12
2
DSC-1212/1212H/1212E
12
2
DSC-1280/1280H/1280E
12
2
DSC-1180
12
2
DSC-1146
12
2
ASM-24E
12
12
eBCON
12
2
DAC-1600
4
2
DAC-606, DAC-633
6
2
DAC-304, DAC-322
4
2
DAC-1180
8
2
DAC-1146
10
2
DVC-304, DVC-322
4
2
DSC/DAC/DNT-T305, DSM-T0/PWR/MOD
4
2
DFC-304R3
4
2
DLC-G1212
12
2
Application Controllers
DLC-D312/D624/D936
12
2
DLC-PxxxxE
12
2
Max LINKnet Devices is the maximum number of LINKnet devices supported. 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. To determine the maximum number of BACstats that can be connected to any given controller, use the following formula: Max # of BACstats = (Max LINKnet devices) – (# of DFM devices used)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-6
Total Pages in this Appendix: 11
LINKnet Basics
E-7
Connecting LINKnet Devices The diagram below illustrates the possible LINKnet network architectures. Ethernet
BACnet MS/TP Network
LINKnet Disabled
LINKnet on NET2
BACnet MS/TP Network
LINKnet on NET1
BACnet MS/TP Network
System Level
Subnet Level
LINKnet Network
LINKnet Network
LINKnet on NET2
LINKnet Network
LINKnet Network
LINKnet on NET2
LINKnet Level BACstat
DFM
BACstat
DFM
BACstat
BACstat
DFM
DFM
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). Although it is recommended to not change the LINKnet network speed, if it is necessary (i.e. due to cable ratings or lengths), change the corresponding MS/TP port’s speed in the NET object of the DSC/DAC once all the LINKnet devices are connected (to 9600, 19200, 38400, or 76800). Note: A DFM-1616 will only communicate via LINKnet to a DSC-1616E or an ASM-24E provided that the DSC/ASM has 3.33 or higher firmware.
Total Pages in this Appendix: 11
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-7
E-8
Working with MS/TP and LINKnet
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)
The possible LINKnet options are listed below. Controller Type Ethernet DSC-Based Controller
Non-Ethernet DSC-Based Controller DAC-Based Controller
LINKnet Options NONE NET1 NET2 NONE NET2 NET2
Note: DAC-based controllers always enable LINKnet on NET2 and cannot be disabled. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-8
Total Pages in this Appendix: 11
LINKnet Basics
E-9
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.
Accessing Objects from LINKnet Devices To access remote object values on a LINKnet device, you must create a corresponding object in the DSC/DAC ‘parent’ device. For example, to reference an AI on a DFM, create an AI in the DSC/DAC with an object reference in the form of: AI((LINKnet device address * 100) + remote AI object number). 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. When LINKnet is enabled in a DSC/DAC, AV object references 101 to 9999 are used for LINKnet. AV object references outside of this range can be used as general-purpose variables. 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’.
Total Pages in this Appendix: 11
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-9
E-10
Working with MS/TP and LINKnet
LINKnet DFM I/O Behavior This section describes the input/output (I/O) behavior of a DFM specifically on LINKnet.
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).
Communication Failure (Degraded Mode) Upon declaration of a communications failure, the DFM will enter a degraded mode of operation until communications are restored. As soon as communications are re-established, the DFM will resume normal operation. 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. This behavior allows a LINKnet DFM to control critical equipment (i.e. chiller/boiler pumps) where reliability is vital. 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-10
Total Pages in this Appendix: 11
LINKnet DFM I/O Behavior
E-11
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).
Required DFM Firmware In order for the LINKnet DFM’s to utilize the previously mentioned features, they must have the firmware version listed below. Device DFM-1600 DFM-1616 DFM-200 DFM-202 DFM-220 DFM-400 DFM-400P DFM-404 DFM-440
Firmware Version V3.33 (or newer)
R3.0a build 40 (or newer)
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.
Total Pages in this Appendix: 11
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page E-11
Appendix F – SERVICE PORT ACCESS 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
Total Pages in this Appendix: 8
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-1
F-2
Service Port Access
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 Access
The overall capability supported by both hardware and software to provide system-wide access to users with an appropriate interface device connected to an RJ-11 jack.
System-wide Access
The ability to access all BACnet devices throughout a control 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.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-2
Total Pages in this Appendix: 8
Requirements
F-3
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.
Service Port Capable Hardware Most Delta Controllers are now available with a service tool port. Refer to specific product documentation to see if a particular controller comes with a Service Tool port.
Summary of Capabilities Service Port Features The Service Port Access on Delta Controls’ products supports these functional capabilities:
Total Pages in this Appendix: 8
•
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.)
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-3
F-4
Service Port Access
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. •
COMMUNICATIONS: Assuming that there are no errors (i.e. mismatched network number or address conflicts) and the baud rate is set correctly, the Service Tool device talks normally on the associated network as an independent BACnet Master device using token passing.
•
SUBSCRIPTION: When a Service Tool device is connected, it automatically subscribes to its associated MS/TP-based controller (usually the device on which the jack resides). On LINKnet, the Service Tool subscribes to the MS/TP-based controller that the LINKnet network is connected to. The Service Tool device then re-subscribes to its associated controller every 30 seconds to maintain existence on the network. If a re-subscription is not received after 40 seconds, the associated controller informs the rest of the system that the Service Tool device no longer exists and all routing to it is stopped.
Connection & Setup 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.
Service Tool Products The following Service Tool devices can plug into a Service Port jack and provide a user interface: •
PC WITH CONVERTER: Any PC that is capable of running ORCAview (i.e. Laptop or otherwise). This is fully functional, but requires an approved smart RS-232 to RS-485 converter, Delta CON-768, or CON-768BT wireless Bluetooth to RS-485 converter manufactured by Delta Controls.
•
OTHER DEVICES: At present there are no other devices designed to connect through the Service Port jack.
Connection and Configuration of a PC and ORCAview RS-232 to RS-485 Converter Since the LINKnet network communicates at 76800 bps and the MS/TP networks default to 76800 bps, and PCs cannot readily communicate at this speed, a smart converter is required. Delta Controls has developed a device (CON768 and CON-768BT), so that computers (laptop or otherwise) can connect to the Service Port jack and provide a user with system-wide access throughout an installation.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-4
Total Pages in this Appendix: 8
Connection & Setup
F-5
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.
Total Pages in this Appendix: 8
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-5
F-6
Service Port Access 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: MS/TP Configured Device When connecting to the service port of a MS/TP configured device (system or subnet), the address setting should be unique to the network segment that is connected, and be between 1 and 99. (99 generally is not an address that is already in use and is usually a good choice.) LINKnet Configured Device When connecting to the service port of a LINKnet configured device, the address setting should be unique to the network segment that is connected, and be between 1 and 13. (13 generally is not an address that is already in use and is usually a good choice.)
Flashing a Panel through the Service Tool Port To Flash a panel’s firmware through the service port requires a PC with a 3.30 Version of Flash Loader (Build 1063 or higher) and a CON-768 RS-232 to RS-485 converter or a CON-768BT Bluetooth to RS-485 converter. To prepare to run Flash Loader:
1.
Ensure that the panel database is backed up.
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 CON768BT to the service port on the controller and use Bluetooth to connect to the PC.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-6
Total Pages in this Appendix: 8
Connection & Setup
F-7
To run Flash Loader:
•
Total Pages in this Appendix: 8
Click on the Windows Start button and select Program\Delta Controls\ORCAview Flash Loader or click on the ORCAview Flash Loader icon on the desktop.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-7
F-8
Service Port Access To select a Flash Loader upgrade file:
•
In the Filename dropdown list, select the required file. The Upgrade File Details field shows the details of the selected upgrade file. For a DAC look for a filename similar to: DAC V3 322 Bxxxxx.fls.
To change the Flash Loader connection settings:
1
Click the Settings button.
2
On the Setting dialog, set the Protocol to Micronet RS-485 (DAC25x)
3
Fron the Port drop-down list, select the PC COM Port that the converter is connected to.
4
Click OK. The settings are saved and the dialog closes.
To transmit the upgrade file:
1.
Click the Query button to confirm communications with the controller and determine the current firmware in the device.
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.
To verify flashing was successful:
1.
Power the controller down and return the dip switches to their original settings and power the controller back up.
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.
3.
Reload the panel database.
For more detailed information on the Delta Flash Loader refer to the Flash Loader Users Guide.
ORCAview Version 3.40 Technical Reference Manual Ed. 1.80 Original Page F-8
Total Pages in this Appendix: 8
