Compass 1.6 Workstation Interface User Guide
Uploaded by
aliCompass 1.6 Workstation Interface User Guide
Uploaded by
aliPowered by BACtalk
Compass 1.6
Workstation Interface User Guide
ALERTON
Table of Contents
Welcome to Compass ....................................................................................................................................................1
New in Compass 1.6 ......................................................................................................................................................3
Schedules .......................................................................................................................................................................5
About Automation Features and Host Devices ..........................................................................................................5
Understanding Standard, Holiday, and Event Schedules ...........................................................................................5
Standard Schedule .................................................................................................................................................5
Holiday Schedule ...................................................................................................................................................5
Event Schedule ......................................................................................................................................................5
Using the Time Schedule Wizard ..............................................................................................................................6
Working with Schedules and the Time Schedule Wizard......................................................................................6
To create a new schedule set for a point in the Time Schedule Wizard ................................................................6
To add regularly scheduled ON/OFF commands in the Time Schedule Wizard ...................................................7
To add commands for a holiday or event in the Time Schedule Wizard ...............................................................7
To view event or holiday commands in the Time Schedule Wizard .....................................................................8
To link an existing schedule set to a point .............................................................................................................8
To link an existing schedule set to a zone..............................................................................................................9
To remove a schedule set from a point ..................................................................................................................9
To remove a schedule set from a zone ...................................................................................................................9
To replace a schedule in a schedule set ............................................................................................................... 10
To customize the look of the Time Schedule Wizard .......................................................................................... 10
Raw Schedule & Calendar Editors .......................................................................................................................... 10
About Raw BACnet Schedule Objects ................................................................................................................ 10
Understanding Date Listings and Options ........................................................................................................... 10
Viewing Raw Calendars ...................................................................................................................................... 11
To set up special event commands for an event period in the Raw Schedule Editor ........................................... 11
i
Rev. 01 May 2018
Table of Contents
To add a date, date range, or special event in the Raw Calendar Editor .............................................................. 12
To reference a calendar for special event dates in the Raw Schedule Editor ....................................................... 13
To set up commands on the weekly schedule ...................................................................................................... 13
Rebuild Schedule Search Index ........................................................................................................................... 13
Rebuild Schedule Search Index ............................................................................................................................... 14
Alarms ......................................................................................................................................................................... 15
About Automation Features and Host Devices ........................................................................................................ 15
About Compass Alarms ........................................................................................................................................... 15
To temporarily disable an alarm .............................................................................................................................. 15
Alarm Messages ...................................................................................................................................................... 15
About Alarm Messages........................................................................................................................................ 15
About Communications Alarms .......................................................................................................................... 16
Managing Current Alarms ................................................................................................................................... 17
To acknowledge a current alarm .......................................................................................................................... 17
To view current alarms ........................................................................................................................................ 17
Alarm Setup ............................................................................................................................................................. 17
Before You Set Up an Alarm............................................................................................................................... 17
About Alarm Descriptions ................................................................................................................................... 18
Understanding Fixed Limit Analog Alarms ........................................................................................................ 18
Understanding Floating Limit Alarms ................................................................................................................. 19
About Custom Process IDs .................................................................................................................................. 20
To edit a custom process ID ................................................................................................................................ 21
To delete custom process IDs .............................................................................................................................. 21
To add a new custom process ID ......................................................................................................................... 21
To set up a fixed limit analog alarm .................................................................................................................... 22
ii
Compass Workstation Interface User Guide PDF
To set up a floating limit analog alarm ................................................................................................................ 23
To set up a binary alarm ...................................................................................................................................... 24
Setting Up Alarm Notification & Action ............................................................................................................. 25
Trendlog Management ................................................................................................................................................. 35
About Automation Features and Host Devices ........................................................................................................ 35
About Trendlogs ...................................................................................................................................................... 35
To set up a trendlog for a property .......................................................................................................................... 35
To use companion trendlogs .................................................................................................................................... 36
To set up multiple trendlogs .................................................................................................................................... 36
To set up a workstation to receive trendlog data ..................................................................................................... 37
To delete a trendlog ................................................................................................................................................. 38
To archive trendlog data .......................................................................................................................................... 38
Energy Management .................................................................................................................................................... 39
Energy Logs ............................................................................................................................................................. 39
Working with Energy Logs ................................................................................................................................. 39
Understanding Compass Energy Logs ................................................................................................................. 39
About Meters ....................................................................................................................................................... 40
About Fluid Energy Meters ................................................................................................................................. 41
About the Demand Window ................................................................................................................................ 41
About Demand and Consumption Meters............................................................................................................ 42
Using Custom Energy Log Units ......................................................................................................................... 43
To set up an energy log ........................................................................................................................................ 43
To set up a meter for an energy log ..................................................................................................................... 43
To set up a fluid energy meter ............................................................................................................................. 44
To archive energy log data .................................................................................................................................. 45
iii
Table of Contents
To view energy log data ...................................................................................................................................... 45
To print energy log data ....................................................................................................................................... 46
Rebuilding Energy Logs ...................................................................................................................................... 46
Demand Limiting ..................................................................................................................................................... 47
About Demand Limiting ...................................................................................................................................... 47
About the Demand Window ................................................................................................................................ 47
About Demand and Consumption Meters............................................................................................................ 48
Setting up meters for a Demand Limiter.............................................................................................................. 49
Assigning Loads to a Demand Limiter ................................................................................................................ 49
To set up a Binary Load....................................................................................................................................... 50
To set up an Analog Load .................................................................................................................................... 50
Viewing the Status of the Demand Limiter ......................................................................................................... 51
Optimum Start ......................................................................................................................................................... 51
About Optimum Start .......................................................................................................................................... 51
About Zones ........................................................................................................................................................ 52
To create a zone ................................................................................................................................................... 52
To edit a zone ...................................................................................................................................................... 53
To add a schedule to a zone ................................................................................................................................. 53
To disable optimum start in a zone ...................................................................................................................... 54
To link zones to a tenant ...................................................................................................................................... 54
To copy a zone ..................................................................................................................................................... 54
To delete a zone ................................................................................................................................................... 55
Tenant Activity ............................................................................................................................................................ 57
About Tenant Activity ............................................................................................................................................. 57
About Zones ............................................................................................................................................................ 57
iv
Compass Workstation Interface User Guide PDF
To create a zone ....................................................................................................................................................... 57
To delete a zone ....................................................................................................................................................... 58
To create a tenant profile ......................................................................................................................................... 58
To edit a tenant profile ............................................................................................................................................. 59
To copy a tenant profile ........................................................................................................................................... 59
To delete a tenant profile ......................................................................................................................................... 59
To generate a tenant bill .......................................................................................................................................... 59
To adjust a tenant bill .............................................................................................................................................. 60
To edit the rate for a tenant zone ............................................................................................................................. 60
To edit a tenant event ............................................................................................................................................... 61
To create a property manager profile ....................................................................................................................... 61
To edit a property manager profile .......................................................................................................................... 61
To delete a property manager profile ....................................................................................................................... 62
To view tenant activity ............................................................................................................................................ 62
General System Setup .................................................................................................................................................. 63
General System Setup - Identification Tab .............................................................................................................. 63
General System Setup - Network Tab ..................................................................................................................... 63
Site Configuration Dialog Box ................................................................................................................................ 65
This computer is the Compass server .................................................................................................................. 65
This computer is a Compass Enterprise Server ................................................................................................... 65
Database Configuration button ............................................................................................................................ 65
Primary host device ............................................................................................................................................. 65
This computer is a Compass Client ..................................................................................................................... 65
Server device instance ......................................................................................................................................... 65
Database Configuration Dialog Box ........................................................................................................................ 66
v
Table of Contents
General System Setup - Time Sync Tab .................................................................................................................. 66
General System Setup - Preferences Tab ................................................................................................................. 67
General System Setup Startup/Shutdown Tab ......................................................................................................... 68
General System Setup - Email Setup Tab ................................................................................................................ 69
General System Setup - SSL and LDAP Tab .......................................................................................................... 70
SSL and LDAP tab .............................................................................................................................................. 70
Using a custom self-signed SSL certificate ......................................................................................................... 72
Installing an enterprise SSL certificate ................................................................................................................ 76
Installing a commercial SSL certificate ............................................................................................................... 85
Job Setup & Engineering ............................................................................................................................................. 97
Operator Workstation Setup .................................................................................................................................... 97
Setting Network Communications and Time-out Values .................................................................................... 97
Setting Time Sync Recipients .............................................................................................................................. 97
About Disable Read/Write Property Multiple ..................................................................................................... 98
Setting Startup/Shutdown Preferences................................................................................................................. 98
Alerton Standard Applications................................................................................................................................. 98
Using the Application Database .......................................................................................................................... 98
Copying Application Files ................................................................................................................................... 99
Searching for Alerton Standard applications ....................................................................................................... 99
To browse Alerton/Standard applications ............................................................................................................ 99
To assign an Alerton Standard application to a controller ................................................................................... 99
To copy Alerton Standard application files to the active rep/job....................................................................... 100
Controller Setup (Device Manager) ....................................................................................................................... 100
Using Device Manager ...................................................................................................................................... 100
Using Device Scanner........................................................................................................................................ 101
vi
Compass Workstation Interface User Guide PDF
Renumbering VLCs ........................................................................................................................................... 102
To manually add a device profile to Device Manager ....................................................................................... 103
To scan the BACnet network for devices .......................................................................................................... 103
To send or save data to BACtalk controllers ..................................................................................................... 104
To renumber VLCs based on MAC address and network number .................................................................... 104
To select VLCs in Device Manager and then renumber them ........................................................................... 105
To copy a device profile .................................................................................................................................... 105
To assign an Alerton Standard application to a controller ................................................................................. 105
To restart a device.............................................................................................................................................. 106
To control a device ............................................................................................................................................ 107
To restore a device ............................................................................................................................................. 107
To back up a device ........................................................................................................................................... 107
File Management (rep/job setup) ........................................................................................................................... 108
Understanding How Compass Manages Graphics and System Files ................................................................. 108
About Site Keys ................................................................................................................................................. 108
Creating a Job Directory and Setting a Job Name ............................................................................................. 109
To create a new Compass job directory ............................................................................................................. 109
DDC ....................................................................................................................................................................... 110
Working with VLC DDC................................................................................................................................... 110
Working with VisualLogic ................................................................................................................................ 116
Viewport Programming ......................................................................................................................................... 162
Programming Viewport Displays ...................................................................................................................... 162
To load a display file from a Viewport .............................................................................................................. 162
To load a Viewport display file from disk ......................................................................................................... 163
To save a Viewport Display file to disk ............................................................................................................ 163
vii
Table of Contents
To send a display file to the Viewport ............................................................................................................... 163
Backing Up Job Data ............................................................................................................................................. 163
Backing Up Files for a Job ................................................................................................................................ 163
User Management .................................................................................................................................................. 164
About User Profiles ........................................................................................................................................... 164
About the User Activity Log ............................................................................................................................. 164
To archive user activity ..................................................................................................................................... 164
User Activity Log, Logged Event Reference ..................................................................................................... 165
To create a user profile ...................................................................................................................................... 168
To edit a user profile .......................................................................................................................................... 168
To delete a user profile ...................................................................................................................................... 170
Users and Groups Dialog Box ........................................................................................................................... 170
Reports ................................................................................................................................................................... 170
Setting Up a Compass Report ............................................................................................................................ 170
Available Reports .............................................................................................................................................. 171
Editing Displays and Templates ................................................................................................................................ 173
About Displays ...................................................................................................................................................... 173
Creating a Display Scheme with the Display and Template Editor ................................................................... 173
About Data Displays .......................................................................................................................................... 173
About Device Templates ................................................................................................................................... 173
About Object Templates .................................................................................................................................... 173
About the Start Display ..................................................................................................................................... 174
Display Editing Basics ........................................................................................................................................... 174
Using the Display and Template Editors ........................................................................................................... 174
Choosing a Display to Edit ................................................................................................................................ 174
viii
Compass Workstation Interface User Guide PDF
Using the Display Info and Template Info Dialog Boxes .................................................................................. 175
Moving and Sizing Items on a Display .............................................................................................................. 175
Setting a Descriptor for a Display or Template ................................................................................................. 175
Setting Snap-to-grid Settings ............................................................................................................................. 176
To place and configure a new item on a display or template ............................................................................. 176
Selecting Items on a Display ............................................................................................................................. 176
To reconfigure a display item ............................................................................................................................ 176
Changing the Font and Color of Items on a Display.......................................................................................... 177
Cutting, Copying, and Pasting Items on a Display ............................................................................................ 178
Using the Repeat Item Command ...................................................................................................................... 178
Setting the Order of Overlapping Items ............................................................................................................. 179
Placing Items on a Display .................................................................................................................................... 180
Placing a Plain Text Item................................................................................................................................... 180
Selecting a Background ..................................................................................................................................... 180
Setting Up a Graphical Item .............................................................................................................................. 181
Placing a User Binary Item ................................................................................................................................ 181
Setting Up a User Analog Item .......................................................................................................................... 181
Setting Up an Omnigraphic ............................................................................................................................... 182
Embedding a DataViewer Widget ..................................................................................................................... 184
Placing the Date and Time on a Display............................................................................................................ 185
Setting Up a Pushbutton .................................................................................................................................... 185
Placing a Group Box.......................................................................................................................................... 186
Setting Up a Check Box .................................................................................................................................... 186
Display Factor and Decimal Places: Read-only Items ....................................................................................... 186
Display Factor, Spinner Resolution, and Decimal Places: Prompted Items ...................................................... 187
ix
Table of Contents
Display File Management ...................................................................................................................................... 187
General Notes About Working with Graphics ................................................................................................... 187
Display and Template File Formats ................................................................................................................... 188
How Graphics are Saved and Named ................................................................................................................ 188
Localizing Compass .............................................................................................................................................. 189
Reference ................................................................................................................................................................... 191
Process ID Reference for workstations .................................................................................................................. 191
Process ID Actions ............................................................................................................................................ 191
x
Welcome to Compass
Welcome to Compass, Alerton’s workstation software for BACnet systems. Compass is your command and control
center for facility operations--from HVAC equipment to irrigation, lighting, security, and more. Here, you can view
and command site equipment and systems with unprecedented flexibility and power.
1
New in Compass 1.6
Feature Description
EASE (Event Assist Scheduling Engine) is a licensed add-on web
application that helps users to create and manage events through a
EASE
user-friendly interface.
NOTE: EASE requires SQL Server Standard or Enterprise Edition.
Auto Logout of the New User Privilege: some users will be able to suspend Auto
Compass web user Logout of the browser.
interface
Acceptable Use Acceptable use banner for all users on the Compass web browser
banner user interface
Added support for Advanced Reporting v1.1
AR v1.1
Support for ACM BD9 DDC and other improvements.
VisualLogic 4.0 NOTE: Requires ACM ROC 1.6.15+ or 2.0.20
ACM 2.0.20 app29.bin adds support for the ACM-FPCS and
ACM 2.0 ROC file
ACM-HOTEL.
The Compass Config Tool handles basic configuration-related
settings combined within a single interface developed to reduce the
New Compass
number of times Compass needs to restart. Refer to the Compass
Config Tool
Installation and Upgrade Guide for more information about the
Config Tool.
Support for SQL (Enterprise database configuration) is now
included with COMPASS-1-SM, COMPASS-1-MD, and
SQL support COMPASS-1-LG licenses.
NOTE: SQL support is not available with COMPASS-1-XS and
COMPASS-1-XXS licenses.
ACM, BCM-ETH, BCM-MSTP, VLX, and VLCA-1688
Updated ROC files to
support EASE NOTE: Older VLXs and BTIs will not be updated to support EASE
scheduling.
3
Schedules
About Automation Features and Host Devices
A host device supervises, stores, and runs energy management and building automation features, such as trendlogs,
schedules, alarms, demand limiting, optimum start, and energy logs. You set up automation features in Compass,
which are then downloaded to the host device, where they run locally. If the connection to the Compass workstation
is lost, or is temporary in the first place, the automation features continue to run.
Global controllers (BCMs), expandable controllers (VLXs), and Alerton Control Modules (ACMs) can function as
host devices. Choose the nearest available host device to the data point being monitored, logged, or scheduled. If
you have only one global or expandable controller on site, it must serve as the host device.
Understanding Standard, Holiday, and Event Schedules
Schedules enable you to plan system operations based on time of day, special events, and holidays. The
combination of a standard, holiday, and event schedule is called a schedule set.
Standard Schedule
Controls day-to-day operations and contains the "normal" ON and OFF times. For example, 8:00 a.m. ON and 5:00
p.m. OFF Monday through Friday, and OFF all day Saturday and Sunday. For a time when no ON command is
scheduled, the standard schedule writes an OFF command.
Standard schedules write to controlled points at priority-array index 16.
Holiday Schedule
Controls the days or date ranges on which the normal, weekly schedule is overridden. This schedule overrides the
standard schedule for the entire day. For a time when no ON command is scheduled, the holiday schedule writes an
OFF command. Thus, scheduling a single OFF command on a holiday schedule, with no other command, causes the
schedule set to command OFF all day. For example, you can schedule a single OFF command for every day of
Spring Break.
When no ON or OFF command is scheduled, the holiday schedule issues a NULL command. Holiday Schedules
write to controlled points at priority-array index 15.
Event Schedule
Controls the days on which a special, one-time event occurs. Events do not recur from year to year, nor do they
override commands for the entire day. The event schedule overrides the holiday and standard schedules, but only
for the duration of any scheduled events. For example, during an evening lecture in the Auditorium.
When no ON or OFF command is scheduled, the event schedule issues a NULL command. Event schedules write to
controlled points at priority-array index 13, superseding VLC DDC.
5
Schedules
Using the Time Schedule Wizard
Working with Schedules and the Time Schedule Wizard
The Time Schedule Wizard (Compass > Schedules > Add|Edit) provides a graphical schedule editor with a
calendar-style setup for creating and editing BACnet schedule objects. You select the object you want to control—
BV-1 or the computer lab zone, for example—and the Time Schedule Wizard creates new Schedule objects for you,
assigning dates, special events, and the controlled property accordingly.
Schedules that the wizard creates are organized by controlled property or zone; each controlled property or zone has
three schedules created for it: a standard time schedule, a holiday schedule, and an event schedule. Each schedule
uses the priority-array to write to the controlled object.
Important Rules for Working with Schedules and the Schedule Wizard
1. Schedules you create with the wizard can only control binary object types (or zones) that support the priority-
array property. BOs must be in service (out-of-service to False) to be controlled.
2. The standard schedule writes to the present-value at index 16, the holiday schedule at index 15, and the event
schedule at index 13.
3. Any value other than NULL in DDC overrides standard and holiday schedules. The event schedule alone
overrides VLC DDC.
4. After you create schedules with the wizard, only use the wizard to edit them. Do not edit the schedule object
directly. You may introduce incompatibilities that prevent you from editing the schedule through the Time Schedule
Wizard. If this happens, create a new schedule, do not edit it in the Raw Schedule Editor, and then save it.
5. Use the standard time schedule to control day-to-day operations, the holiday schedule to override the time
schedule for an entire day, and the event schedule to override the time schedule only for specified times.
6. An event schedule sends a NULL command at the end of a scheduled ON or OFF period to release control to a
standard schedule, holiday schedule, or DDC as appropriate.
Caution! Do not use schedules to control BVs that Global/Building controller DDC writes to. Because
DDC writes at index 9 in expandable controllers and global controllers, the schedules will be ineffective.
Do not use the Raw Schedule Editor to edit schedules created with the wizard; doing this may cause them
to be subsequently incompatible with the wizard.
For more information about schedules and how they’re used in Compass, see your Operators Manual.
To create a new schedule set for a point in the Time Schedule Wizard
You can use the Time Schedule Wizard to create a new schedule set for any point that was previously unscheduled.
1. On the Compass menu, click Schedules, click Add, identify a point (object and property), and then click OK.
-or-
Right-click a property or point in a data display, and then click Point Schedules on the context menu.
2. Under Host Device, select or type the Device Instance of the host device that will store schedules for this
device.
6
Compass Workstation Interface User Guide PDF
3. For the standard schedule, select one of the following:
• Make New to create a new schedule for this set. Then type a unique description.
• Make a Copy of an Existing Schedule to create a new schedule based on a copy of an
existing schedule in a different schedule set. Then select the schedule you want to copy.
• Share with an Existing Schedule to have this schedule set use an existing schedule from
another schedule set. Any changes to the schedule affect all schedule sets to which it
belongs.
4. Click Next.
5. Repeat steps 3 and 4 for the holiday schedule.
6. Repeat step 3 for the event schedule, and then click Finish.
7. Rebuild the schedule search index (Compass>Schedules>Rebuild Search Index).
To add regularly scheduled ON/OFF commands in the Time Schedule Wizard
Use the Standard column in the Time Schedule Wizard to add regularly scheduled commands that you want to recur
from week-to-week or day-to-day. For example, a weekly work schedule of 8:00 a.m. to 5:00 p.m.
1. On the Compass menu, click Schedules.
-OR-
From a Data Display, right-click a point that you want to schedule, and then click Point Schedules
or Zones > Schedules (skip steps 2 and 3).
2. In the Schedules dialog box, click Add.
3. Define the point you want to schedule and click OK. The New Schedule Wizard appears.
4. Select the host device that will host schedules for this point.
5. Select or define a standard, holiday, and event schedule for this point. The Time Schedule Wizard
appears.
6. On the calendar in the upper right corner, select the day you want to schedule.
7. Click and drag under Standard in the timetable to select the block of time you want to schedule
ON.
8. Right-click the selected block, and then click New on the context menu.
Note: At least one time-slot must be selected for the context menu to appear on right-click.
9. Confirm the Start Time and End Time for which you want to command the data points
ON.
10. Click Recurrence , select the days of the week you want the command to apply (for example,
Monday through Friday), and then click OK.
11. Click Save and Exit.
12. Repeat steps 6-11 to add more recurring commands.
13. Click OK to save your changes.
To add commands for a holiday or event in the Time Schedule Wizard
You can use the Time Schedule Wizard to define holidays or events throughout the year. For example, you can
define Spring or Winter break at the beginning of a new school year.
7
Schedules
Important! Holidays or events cannot recur from year-to-year. For example, you cannot schedule Labor
Day for 2002-2006.
1. On the Compass menu, click Schedules.
2. Select the point whose schedule you want to edit, and then click Edit.
3. On the calendar in the upper right corner, select the day you want to schedule. For a date range, select the first
day in the range.
4. Click and drag under Holiday or Event in the timetable to select the block of time you want to schedule.
5. Right-click the selected block, and then click New on the context menu.
Note: At least one time slot must be selected for the context menu to appear on right-click.
6. Confirm the Start Time and End Time for the period you want this command to override subordinate schedules.
For example, if you define an event that starts at Noon, it will override a standard 8 to 5 schedule beginning at
Noon. Click All Day to override a subordinate schedule for the entire day (on a holiday, for example).
7. To set up a range of dates and apply a command on those days, click Recurrence , and then type a Start
Date and End Date.
8. Click Save and Exit .
9. Repeat steps 3-8 for each date you want to schedule that holiday or event.
To view event or holiday commands in the Time Schedule Wizard
You can use the Time Schedule Wizard to view all of the scheduled events or holidays for a controlled point or
zone. For example, if you need to adjust the time for an event, you can view all of the events and then select the one
you want to edit.
1. On the Compass menu, click Schedules to view schedules for a controlled point.
-OR-
On the Compass menu, click Zones to view schedules for a zone.
2. In the Schedules dialog box, select the point whose schedules you want to view, and then click Edit.
-OR-
In the Zones dialog box, select the zone whose schedules you want to view, and then click Schedule.
3. On the View menu in the Time Schedule Wizard, point to Dates, and then click Holiday Schedule or Event
Schedule. A list of dates that have scheduled holidays or events appears.
4. To display the timetable for a date, select the date from the list and click OK.
To link an existing schedule set to a point
When you define schedule sets, you may find that you can define one that applies to several different points. For
example, you can use one schedule set for all of the classrooms in a school that have the same occupancy times and
dates.
8
Compass Workstation Interface User Guide PDF
1. Identify a point that uses the defined schedule set that you want to link to another point.
2. On the Compass menu, click Schedules.
3. In the list of scheduled points, select the data point from step 1, and click Edit.
4. Right-click anywhere in the Controlled Points list, and then click Add Point on the context menu.
5. Define the point to which you want to link the schedule set, and then click OK. The new point appears in the
Controlled Points list.
To link an existing schedule set to a zone
When you define schedule sets, you may find that you can define one that applies to several different zones. For
example, you can use one schedule set for all of the zones in a school that have the same occupancy times and dates.
1. Identify a zone that uses the defined schedule set that you want to link to another zone.
2. On the Compass menu, click Zones.
3. In the list of zones, select the zone from step 1, and click Schedule.
4. Right-click anywhere in the Controlled Points list, and then click Add Zone on the context menu.
5. Define the zone or zones to which you want to link the schedule set, and then click OK. The new zone(s)
appears in the Controlled Points list.
To remove a schedule set from a point
You can remove a schedule set from a point when the schedule no longer applies. For example, if several
classrooms in a school are closed off for construction or emergency maintenance during the school year, you can
remove the schedule set to prevent heating or cooling the rooms unnecessarily.
1. On the Compass menu, click Schedules.
2. Select the point or points whose schedule you want to remove, and then click Delete.
3. Rebuild the schedule search index (Compass>Schedules>Rebuild Search Index).
To remove a schedule set from a zone
You can remove a schedule set from a zone when the schedule no longer applies. For example, if several
classrooms in a school are closed off for construction or emergency maintenance during the school year, you can
remove the schedule set to prevent heating or cooling the rooms unnecessarily.
1. On the Compass menu, click Zones.
2. Find the zone whose schedule you want to remove, select it, and click Schedule.
3. Right-click on the zone in the Controlled Points list, and then click Remove.
9
Schedules
To replace a schedule in a schedule set
Compass allows you to change schedules in your schedule set at any time. For example, if classrooms that were
previously being used for day classes will now be used only for night classes, you can replace the standard schedule
instead of creating an entirely new schedule set.
1. On the Compass menu, click Schedules.
2. In the Schedules dialog box, select the point whose schedule set you want to edit, and then click Edit. The
Time Schedule Wizard appears.
3. Select the standard, holiday, or event schedule that you want to use in place of the current schedule. If a
suitable schedule does not exist, you will need to create a new one. See To create a new schedule set for a point in
the Time Schedule Wizard for more information.
4. Click OK to save your changes and close the Time Schedule Wizard.
To customize the look of the Time Schedule Wizard
You can change the scale of the timetable, change the colors displayed for ON and OFF for each schedule type, and
change the default size of the window.
To change the scale of the timetable, right-click anywhere on the timetable scale and then choose the increments
you want.
To change the colors displayed for ON and OFF commands
1. Right-click anywhere in the status bar, and then click Edit from the context menu.
2. Choose Active (ON) and Inactive (OFF) colors from the list, and then click OK.
3. To change the default size of the Time Schedule Wizard window, on the View menu, point to Size, and then
click Large or Small (whichever is available).
Raw Schedule & Calendar Editors
About Raw BACnet Schedule Objects
BACnet schedules are stored and operated in a host device. They are also stored on your Compass workstation hard
disk. The device instance of the host device appears in the Dev Inst box. Under Object Location, you can choose
whether to view schedules stored at the workstation or in the host device.
In the Objects list of the Schedule editor (Tools > Advanced > Schedules > Add|Edit), each schedule is identified by
an ID ( Sched 5, for example) and a description enclosed in parenthesis. Click a schedule in the list to work with it.
Understanding Date Listings and Options
Event schedules override the holiday and standard schedules, but only for the duration of any scheduled events.
There are a number of ways you can specify the dates for a special event: a single date, a date range, a special date,
wildcard dates, or a referenced calendar.
Use the following table to identify how events are set up and to select event types according to your needs.
10
Compass Workstation Interface User Guide PDF
Note: The event priority appears only in the Event Dates list of the Raw Schedule Editor.
Example Entry in Event
Date Type Remarks
Dates List
Specifies a single date on which special event commands are
Single Date 10/1/1998, event priority = 14 active. Useful for a one-time holiday or event or for a recurring
holiday or event.
Specifies a range of dates. Event commands apply to each date
12/16/1998 to 1/4/1999, event
Date Range in the range individually, rather than applying to the whole date
priority = 12
range as a block. Useful for vacation periods.
Specifies a relative date on which special event commands are
First Monday in September,
Special Date active. Useful for holidays, like Labor Day, that are based on
event priority = 16
such criteria.
References a calendar where dates are already set up. Useful for
Referenced Calendar 1 (Master Holiday), implementing standard control for a number of events or
Calendar event priority = 5 holidays that can be anticipated far in advance or recur from
year-to-year.
Omissions when entering a date result in wildcards. For specific
10/1/****, event priority = 16 dates, these are represented by asterisks in the Event Dates list.
For special dates, wildcards result in non-specific statements: for
Dates with 10/**/98, event priority = 16 example, "Any Monday in September" or "The First Monday of
Wildcards the Month." A wildcard is the logical equivalent of "any". Thus,
**/03/****, event priority = 10/1/**** specifies 10/1 of any year; 10/**/98 specifies any
16 date in October of ’98; and **/03/** specifies the third day of
any month in any year.
Viewing Raw Calendars
Calendars store dates, date ranges, and special dates (for example, the first Saturday in March), which are used by
the event portion of schedules. Calendars in Compass exist only to provide a list of dates for special events.
Calendars make it easy to create a generic list of dates and date ranges that all schedules can reference. Rather than
editing each schedule’s event dates individually, you can edit the dates in one location—the calendar—and have the
event portion look up dates from the calendar.
To set up special event commands for an event period in the Raw Schedule Editor
You can set up special events to supersede events defined in the weekly schedule.
1. On the Tools menu, point to Advanced, and then click Schedules.
2. Select the object you want to edit, and then click Edit.
11
Schedules
3. On the Special Events tab of the Schedule Editor, click Add New Event.
4. Under Period, select whether to use another object’s calendar or to create a custom period for this event.
5. In the Event Priority box, type the event priority at which you want this event to write. This highest priority is 1
and the lowest is 16.
6. Click Add New Event.
7. Enter a time, the type of value you want to command, and the value to command.
8. Click OK. The special event command is added to the Schedule list. These commands supersede all commands
on the Weekly Schedule tab for all days in the period selected in step 4.
To add a date, date range, or special event in the Raw Calendar Editor
Use this procedure to add a single date (for example, a one-time holiday or event), a range of dates (for example,
vacation periods), or a relative date on which special event commands are active (for example, Labor Day, which
always occurs on the first Monday in September).
1. On the Tools menu, point to Advanced, and then click Calendars.
2. Select the device instance of the host device, and then click Update.
3. Click Add, select Auto to find an unused schedule entry or Manual to type an entry, and then click OK.
4. In the Calendar Date List tab, click Add New Entry.
5. In the Calendar Entry Editor, under Entry Type, select the date type you want to add to the calendar according
to the following guidelines.
Select this And then set these parameters
Month — Number from 1-12 that corresponds to the month of the year. If omitted, a wildcard is
used.
Date — Number from 1-31 that corresponds to the day of the month. If omitted, a wildcard is
Single used.
Date Year — The year in which the date occurs. If omitted, a wildcard is used.
Day of Week — Select the day of the week on which the special event will apply. Typically left
blank or used only if the Date parameter is a wildcard.
Date Type starting and ending dates according to the guidelines for Month, Day, Year and Day of
Range Week explained in the preceding item.
Month — Number from 1-12 that corresponds to the month of the year. If omitted, a wildcard is
Special used.
Date Day of Week — Select a day of the week on which the special event will apply. If omitted, a
wildcard is used.
Criteria — Select the criteria from the list. Criteria correspond to weeks in a month and the last
12
Compass Workstation Interface User Guide PDF
days of the month.
6. Click OK when you finish.
7. Repeat steps 4 through 6 for each date or date range you want to add to the calendar.
To reference a calendar for special event dates in the Raw Schedule Editor
When you are implementing a standard control for a number of events or holidays that can be anticipated far in
advance or recur from year-to-year, you can reference a calendar where dates are already set up.
1. On the Tools menu, point to Advanced, and then click Schedules.
2. Select the device instance of the host device you want to work with, and then click Update.
3. Click Add, select Auto to find an unused schedule entry or Manual to type an entry, and then click OK.
4. In the Special Events tab, click Add New Event.
5. In the BACnet Special Event dialog box, under Period, click Specify period by calendar object.
6. Click the command button beside the Calendar box to open the BACnet Calendar Selector.
7. In the Objects list, select the calendar you want to use.
8. Click OK. The Calendar appears in the Calendar box.
9. Set up special event commands to be active on the calendar days (how?).
To set up commands on the weekly schedule
1. On the Tools menu, point to Advanced, and then click Schedules.
2. Select a schedule from the Objects list, and then click Edit.
3. Click the day of the week you want to edit. The Add . . . Event button reflects your selection.
4. Click Add . . . Event.
5. In the Time box, type the time you want the command to begin.
6. Select a command type that is compatible with the properties listed on the Controlled Properties tab, and then
select the value you want to command.
7. Click OK. The command appears in the timetable box for the day you selected.
Rebuild Schedule Search Index
When a user changes a point description from a data display, the new description is not immediately available for
searching. The user must manually rebuild the search index to see the changed description in search results.
13
Schedules
From a workstation, select Compass>Schedules>Rebuild Search Index.
Rebuild Schedule Search Index
When a user changes a point description from a data display, the new description is not immediately available for
searching. The user must manually rebuild the search index to see the changed description in search results.
From a workstation, select Compass>Schedules>Rebuild Search Index.
14
Alarms
About Automation Features and Host Devices
A host device supervises, stores, and runs energy management and building automation features, such as trendlogs,
schedules, alarms, demand limiting, optimum start, and energy logs. You set up automation features in Compass,
which are then downloaded to the host device, where they run locally. If the connection to the Compass workstation
is lost, or is temporary in the first place, the automation features continue to run.
Global controllers (BCMs), expandable controllers (VLXs), and Alerton Control Modules (ACMs) can function as
host devices. Choose the nearest available host device to the data point being monitored, logged, or scheduled. If
you have only one global or expandable controller on site, it must serve as the host device.
About Compass Alarms
Alarms monitor equipment or environments in a building and alert someone when conditions are outside the
defined normal range.
There are three items at the core of any alarm in Compass:
• The monitored object and property (data point), whose status or value is watched for an alarm state. For
example, the temperature in the computer lab can be defined as the monitored property.
• The alarm setup (in BACnet, technically known as an event-enrollment object), which is saved in a
controller. It maintains alarm parameters and watches the monitored object and property to generate an
alarm. For example, the alarm setup monitors the temperature in the computer lab and generates an alarm if
it rises above or falls below the desired temperature range.
• The alarm handler (in BACnet, technically known as a notification-class object), which determines what
workstations, pagers, and email accounts are notified when an alarm occurs and what handling instructions
are sent with the alarm. For example, the alarm handler sends an alarm message to the facility manager’s
workstation if the temperature in the computer lab is out of its defined range.
To temporarily disable an alarm
For whatever reason, you may need to disable an alarm temporarily. When you disable an alarm, all notifications
and logging for the alarm are disabled.
1. On the Compass menu, point to Alarms, and then click Point Alarms.
2. Select the alarm you want to work with from the Objects list, and then click Edit.
3. Under Notifications, clear the Send on alarm and Send on fault check boxes.
Alarm Messages
About Alarm Messages
Compass alarm messages convey substantial information about when, where, and why an alarm occurred. Most
alarms are set up to require a user acknowledgment at a workstation through the Compass Alarm Message dialog
box. However, you can also set up messages to go directly to a pager or a printer. Alarm messages can also be
emailed from a workstation at the local site to a workstation at a remote site and can contain a URL address link.
The alarm message is sent when an alarm occurs.
15
Alarms
Several conditions must be met for an alarm message to appear at a Compass workstation:
1. The monitored data point must go into a state that triggers an alarm, as determined by the alarm setup.
2. The alarm setup must have the corresponding alarm type enabled: off-normal, fault, or normal.
3. For the type of alarm that occurs, the alarm handler must be set up to require a user acknowledgment for that
alarm type.
4. The alarm handler for the alarm must have the workstation listed as a recipient.
5. Email must be set up as an alarm recipient and the email settings must be set before alarms can be emailed.
6. Alarm URLs must be set up before they
7. The workstation’s recipient profile must be set up to handle the alarm type that occurs and to annunciate it.
About Communications Alarms
Communications alarms in Compass occur when the workstation attempts communication with a field device and
the field device does not respond. The communications alarm returns to normal when another such communication
attempt occurs and is successful.
Normal display update operations do not cause communications alarms. Activities such as background trendlog
processing, object saves and sends, and other processing operations will prompt communications errors if the device
of interest is offline.
Alarm descriptions for communications errors in Compass use the following syntax:
Dev <OpTermDI>, device <OfflineDI>, [<DevDesc>] Communications Error
Item Explanation
<OpTermDI> The client workstation that logged the communications alarm.
<OfflineDI> The device that was offline and caused the communications alarm.
<DevDesc> The device description, from Device Manager, of the offline device.
Examples
Workstation 307 reports a communications error with Device 211, a BTI, with
the description "My Global Controller" set in Device Manager:
Dev 307, device 211 My Global Controller (Communications Error)
Workstation 307 reports a communications error with Device 702, a VLC, with
the description "My VLC" set in Device Manager:
Dev 307, device 702 My VLC (Communications Error)
16
Compass Workstation Interface User Guide PDF
Managing Current Alarms
A current alarm is any point value that is not currently in a Normal state or an alarm that has returned to a Normal
state but has not yet been acknowledged. You can view current alarms in one device or multiple devices. View
current alarms from the Compass menu (Compass > Alarms > Current Alarms).
From the Current Alarms dialog box, you can search for current alarms, acknowledge alarms, and print alarms.
Choose from several different filter options to limit your search and use the column headings in the results area to
sort the displayed alarms after a search. See the Current Alarms Dialog Box for more information.
To acknowledge a current alarm
You can acknowledge current alarms from the Current Alarms dialog box. A current alarm is any alarm that is not
currently in a Normal state or an alarm that has returned to a Normal state but has not yet been acknowledged.
1. On the Compass menu, point to Alarms, and then click Current Alarms.
2. Select the device for which you want to view current alarms. To view alarms in multiple devices, type the
device instances or ranges separated by commas. For example, 20700, 20707, 20710, 20712-20723.
3. Select the filters you want to use for your search. See Current Alarms Dialog Box for more information about
the filter options.
4. Click Search.
5. Select one or more alarms that you want to acknowledge and then click Acknowledge. You must click Search
to refresh the window and remove the newly acknowledged alarms.
To view current alarms
You can view current alarms in one device or multiple devices. A current alarm is any alarm that is not currently in
a Normal state or an alarm that has returned to a Normal state but has not yet been acknowledged.
1. On the Compass menu, point to Alarms, and then click Current Alarms.
2. Select the device for which you want to view current alarms. To view alarms in multiple devices, type the
device instances or ranges separated by commas. For example, 20700, 20707, 20710, 20712-20723.
3. Select the filters you want to use for your search. See Current Alarms Dialog Box for more information about
the filter options.
4. Click Search.
Alarm Setup
Before You Set Up an Alarm
Before you set up an alarm, ensure you have configuration information.
For all alarms, you need:
17
Alarms
1. The object and property you want to monitor for an alarm condition, including the device instance where it is
located (for example, Dev 211, AV-105, present-value).
2. The device instance of the host device where you want to store the alarm object you create. When you select a
host, try to minimize the amount of traffic on your BACnet LAN. Choose the nearest available controller to the
property being monitored. If you have only one expandable controller or global controller on site, it must serve as
the host.
3. The device instance of the workstations where you want some alarm action performed and the action to
perform (log to alarm history, print, or annunciate with a Compass alarm message).
For alarms that are emailed, you also need the host name or IP address of an SM/TP sever and its port number.
Configure the SM/TPserver in General System Setup on the Tools menu.
For alarms that will transmit to a pager, you also need:
• The device instance of the controller whose modem dials the pager.
• The phone number of the pager or modem at the remote site.
About Alarm Descriptions
Alarm descriptions appear in parenthesis in listings of alarms, in alarm history records, and in Compass alarm
messages. In every case, the alarm description should include a pointer to the monitored property (for example,
Device 211, AV 1). In certain circumstances, the alarm description may be the only way to ascertain the true source
of the alarm.
When you set up an alarm using the Alarm Wizard, Compass can use variables to save time and help ensure
consistency.
Understanding Fixed Limit Analog Alarms
For fixed limit analog alarms, an alarm occurs when the value of the monitored property exceeds the high limit or
drops below the low limit. The deadband is subtracted from the high limit and added to the low limit to determine
when the alarm condition returns to normal.
Using the example diagram below, an alarm occurs if the temperature falls below 66 or rises above 74 degrees.
Additionally, the alarm condition returns to normal if the temperature reaches between 68 and 72 degrees.
18
Compass Workstation Interface User Guide PDF
Understanding Floating Limit Alarms
A floating limit alarm compares a monitored analog property to an analog reference property, which represents a
setpoint reference. If the monitored property varies above or below the setpoint reference by the offset values you
specify, an alarm occurs.
Using the graphic below as an example, if the temperature rises more than 2 degrees above or 4 degrees below the
setpoint, an alarm occurs.
Choosing Offsets and a Deadband
Offsets determine how far the monitored property must vary from the setpoint reference for an alarm to occur. The
high limit offset is added to the setpoint reference value; the low limit offset is subtracted from the setpoint
reference value. The deadband value determines when an alarm returns to normal and is applied in addition to the
offsets. The deadband value is added to the low limit equation and subtracted from the high limit equation.
The illustration depicts this behavior with a monitored property representing space temperature and a setpoint (SP)
reference representing space temperature setpoint.
19
Alarms
About Custom Process IDs
A process ID is a numerical identifier that BACnet devices use to identify a set of actions to perform when an event
occurs. Compass also allows you to create custom process IDs to process event notifications from other
manufacturers’ equipment.
For example, Compass uses process IDs 130, 131, 134, or 135 to log events. However, the other vendor’s
workstation uses a different process ID. If Compass requires the other vendor’s workstation to log events, you must
create a custom process ID.
Use the Custom Process IDs dialog box (Compass > Alarms > Custom Process IDs) to view a current list of all the
custom process IDs, define a new custom process ID and assign currently supported actions to it, and edit an
existing custom process ID.
Note: You must have the "Add, edit, and delete custom process IDs" user privilege selected for the current user
profile. Additionally, you can only edit one custom process ID at a time. If you select more than one custom process
ID, the Edit button is disabled.
By default, custom process IDs 129 - 135 are predefined. These custom process IDs correspond to workstation
alarm handlers with different combinations of supported actions enabled.
129 - Annunciate
130 - Log
131 - Annunciate and Log
132 - Print
20
Compass Workstation Interface User Guide PDF
133 - Annunciate and Print
134 - Log and Print
135 - Annunciate, Log, and Print
To edit a custom process ID
By default, custom process IDs 129 - 135 are predefined. These custom process IDs correspond to Compass
workstation alarm handlers with different combinations of supported actions enabled. When you edit a custom
process ID, you can change its supported actions.
1. On the Compass menu, point to Alarms, and then click Custom Process IDs.
2. Select the custom process ID you want to modify and then click Edit. You can only edit one custom process ID
at a time. If you select more than one process ID, the Edit button is not available.
3. Type a new description for the custom process ID if necessary.
4. Select the actions you want to enable for this custom process ID.
To delete custom process IDs
You can delete custom process IDs when you no longer need them.
Note: You must have the "Add, edit, and delete custom process IDs" user privilege selected for the current
user profile.
1. On the Compass menu, point to Alarms, and then click Custom Process IDs.
2. Select the custom process ID(s) you want to delete. Select multiple custom process IDs using Shift + Click or
Ctrl + Click.
3. Click Delete.
To add a new custom process ID
By default, custom process IDs 129 - 135 are predefined. These custom process IDs correspond to workstation
alarm handlers with different combinations of supported actions enabled. You can add new custom process IDs if
necessary.
Note: You must have the "Add, edit, and delete custom process IDs" user privilege selected for the current
user profile.
1. On the Compass menu, point to Alarms, and then click Custom Process IDs.
2. In the Custom Process IDs dialog box, click Add.
21
Alarms
3. Type a unique process ID number. See the Custom Process IDs Dialog Box for a list of predefined custom
process IDs.
4. Type a unique description for this custom process ID.
5. Select the actions you want to enable for this custom process ID.
6. Click OK to add the new custom process ID.
To set up a fixed limit analog alarm
Fixed limit analog alarms occur when the value of the monitored property exceeds the high limit or drops below the
low limit. The deadband is subtracted from the high limit and added to the low limit to determine when the alarm
condition returns to normal.
If you define a temperature setpoint as your monitored property, set a high limit and a low limit to notify someone
of temperatures outside of the range. For example, if the high limit is 74 degrees and the low limit is 66 degrees, an
alarm occurs if the temperature rises above 74 degrees or falls below 66 degrees. Using a deadband of 2, conditions
return to normal only when the temperature rises to 68 degrees or falls to 72 degrees.
You can set up a fixed limit analog alarm from the Point Alarms dialog box or from the New Alarm Wizard.
Using the Point Alarms dialog box
1. On the Compass menu, point to Alarms, and then click Point Alarms.
2. In the Point Alarms dialog box, click Add.
3. In the New Alarm Point dialog box, select the device and point for the analog alarm, and then click OK.
This is the object and property you want to monitor for an alarm condition. For example, Dev 211 AV 90.
4. Select Analog (fixed limit) as the New Alarm Type, and then click OK.
5. Select a controller as the Host Device. Once the alarm setup is created, the Host Device cannot be changed.
6. Type a description for the alarm. The description should help you identify the source of the alarm.
7. Select an Alarm Handler. The alarm handler defines which workstations, pagers, and email addresses
receive the alarm and what actions they should take.
8. Click the button to select a different handler or to change alarm recipients.
9. Set high and low limits under Parameters.
10. Define the deadband that controls when the alarm returns to normal.
11. Select check boxes to enable this alarm. Clear them to disable it. For example, to only receive a notification
when an alarm occurs and not a fault, click the Send on alarm check box and clear the Send on fault check
box. When an alarm is disabled, no notification or logging occurs.
12. Type the alarm messages that appear when the point generates an alarm, generates a fault, and transitions
back to normal status. This text should clearly identify the condition that is occurring and whether any action
is required. For more information, see Naming and Enabling Alarms in the Alarm Wizard.
13. Type a delay time in seconds. If an alarm condition occurs and returns to normal within this delay time, no
alarm occurs.
Using the New Alarm Wizard
1. On the Compass menu, point to Alarms, and then click New Alarm Wizard.
2. Select Analog (fixed limits) as the New Alarm Type, and then click Next.
3. Type the starting and ending device instances of the devices for which you want to create alarms. For
example, 700-800. The Wizard creates alarms for the Monitored Properties you select in these devices.
22
Compass Workstation Interface User Guide PDF
4. Type the increment for device instances you identified. For example: if you selected a device range of 700 to
800, type a spacing of 10 to create alarms for devices 700, 710, 720, 730, etc.
5. Type or select the device instance of the controller where these alarm setups will be saved. Once the alarm
setup is created, the Host cannot be changed.
6. Click to select an alarm handler or set up a new one. The alarm handler defines which client workstations,
pagers, and email addresses receive the alarm and what actions they should take.
7. Select the property or properties whose analog values you want to monitor for an alarm condition. You can
set up 1-8 alarms in one or more devices.
8. Type a delay time in seconds. If an alarm condition occurs and returns to normal within this delay time, no
alarm occurs.
9. Type a high limit. If the property reads a value higher than what you define here, a high limit alarm occurs.
10. Type a low limit. If the property reads lower than what you define here, a low limit alarm occurs.
11. Type the deadband to use for this alarm. The Deadband controls when the alarm returns to normal. The
deadband is subtracted from the high limit and added to the low limit to determine when the alarm returns to
normal. Example: high limit = 85, deadband = 5, alarm returns to normal when it falls below 80.
12. Click Next.
13. Name the alarm, enable alarm actions, and choose alarm messages. For more information, see Naming and
Enabling Alarms in the Alarm Wizard.
To set up a floating limit analog alarm
Use a floating limit alarm to compare a monitored analog property to an analog reference property, which represents
a setpoint reference. If the monitored property goes above or below the setpoint reference by offset values you
specify, an alarm occurs.
For example, set a high offset and low offset for a zone. Then, if the temperature rises more than 2 degrees above or
4 degrees below the temperature setpoint in the zone, an alarm occurs.
You can set up a floating limit analog alarm from the Point Alarms dialog box or from the New Alarm Wizard.
Using the Point Alarms dialog box
1. On the Compass menu, point to Alarms, and then click Point Alarms.
2. In the Point Alarms dialog box, click Add.
3. In the New Alarm Point dialog box, select the device and point for the analog alarm, and then click OK.
This is the ID you want to monitor for an alarm condition. For example, Dev 211 AV90.
4. Select Floating Limit as the New Alarm Type, and then click OK.
5. Select a controller as the Host Device. Once the alarm setup is created, the Host Device cannot be changed.
6. Type a description for the alarm. The description should help you identify the source of the alarm and
indicate any corrective actions.
7. Select an Alarm Handler. The alarm handler defines which workstations, pagers, and email addresses
receive the alarm and what actions they should take.
8. Click the button to select a different handler or to change alarm recipients.
9. Choose a Setpoint Reference property that represents the setpoint to compare the Point to. This is typically
the Present Value of an AI or AV. Then choose the high and low limit offsets and a Deadband. Click here
for more information about how these parameters work.
10. Type a delay time in seconds. If an alarm condition occurs and returns to normal within this delay time, no
alarm occurs.
11. Select check boxes to enable this alarm. Clear them to disable it. For example, to receive a notification only
when an alarm occurs and not a fault, click the Send on alarm check box and clear the Send on fault check
box. When an alarm is disabled, no notification or logging occurs.
23
Alarms
12. Type the alarm messages that appear when the point generates an alarm, generates a fault, and transitions
back to normal status. This text should clearly identify the condition that is occurring and whether any
corrective action is required. For more information, see Naming and Enabling Alarms in the Alarm Wizard.
Using the New Alarm Wizard
1. On the Compass menu, point to Alarms, and then click New Alarm Wizard.
2. Select Floating Limit as the New Alarm Type and then click Next.
3. Type the starting and ending device instances of the devices for which you want to create alarms. For
example, 700-800. The Wizard creates alarms for the Monitored Properties you select in these devices.
4. Type the increment for Device Instances in the Spacing box. For example: select a device range of 700 to
800 and then type a Spacing of 10 to create alarms for devices 700, 710, 720, 730, etc.
5. Type or select the device instance of the controller where these alarm setups will be saved. Once the alarm
setup is created, the Host cannot be changed.
6. Select an alarm handler or set up a new one. The alarm handler defines what client workstations, pagers, and
email addresses receive the alarm and what actions they should take.
7. Choose a property that represents the analog value to monitor (Monitored Property, typically the Present
Value of an AI or AV).
8. Choose the property that represents the setpoint to compare it to (Setpoint Reference Property, typically the
Present Value of an AI or AV). If the Monitored Property deviates from this setpoint by an amount you
specify, an alarm occurs.
9. Type a delay time in seconds. If an alarm condition occurs and returns to normal within this delay time, no
alarm occurs.
10. Type a high offset number. The Monitored Property must be greater than the value of the Setpoint Reference
plus this number for a high limit alarm to occur.
11. Type a low offset number. The Monitored Property must be less than the value of the Setpoint Reference
minus this number for a low limit alarm to occur.
12. Type a Deadband value, which determines when the alarm returns to normal. The Deadband is subtracted
from the high limit and added to the low limit.
13. Click Next.
14. Name the alarm, enable alarm actions, and choose alarm messages. For more information, see
Naming and Enabling Alarms in the Alarm Wizard.
To set up a binary alarm
Set up binary alarms to monitor a change-of-state (OFF to ON or ON to OFF) and generate an alarm if a change
occurs. For example, you can set up an alarm to occur every time a fan goes OFF.
You can set up a binary alarm from the Point Alarms dialog box or from the New Alarm Wizard.
Using the Point Alarms dialog box
1. On the Compass menu, point to Alarms, and then click Point Alarms.
2. In the Point Alarms dialog box, click Add.
3. In the New Alarm Point dialog box, select the device and point you want to monitor for an alarm condition
and then click OK.
4. Select Binary (on/off) as the New Alarm Type, and then click OK.
5. In the Binary Alarm Properties dialog box, select a controller as the Host Device. Once the alarm setup is
created, the Host Device cannot be changed.
6. Type a description for the alarm. The description should help you identify the source of the alarm and
indicate any corrective actions.
24
Compass Workstation Interface User Guide PDF
7. Select an Alarm Handler to control the devices that are notified when an alarm occurs. Click the button to
select a different handler or to change alarm recipients.
8. Select the Point status transition (OFF to ON, or ON to OFF) that will cause an alarm to occur.
9. Type a Delay time. If the point status reverts within this time, no alarm occurs.
10. Select check boxes to enable this alarm. Clear them to disable it. For example, to receive a notification only
when an alarm occurs and not a fault, click the Send on alarm check box and clear the Send on fault check
box. When an alarm is disabled, no notification or logging occurs.
11. Type the alarm messages that appear when the point generates an alarm, generates a fault, and transitions
back to normal status.
12. Click OK.
Using the New Alarm Wizard
1. On the Compass menu, point to Alarms, and then click New Alarm Wizard.
2. Select Binary (on/off) as the New Alarm Type and then click Next.
3. Type the beginning and ending Device Instances of device(s) where the properties you want to monitor
exist. To set up alarms in only one device, type its device instance in both boxes.
4. Type the increment for device instances. For example: select a device range of 700 to 800 and then type a
spacing of 10 to create alarms for devices 700, 710, 720, 730, etc.
5. Select a controller as the Host Device. This is where alarm setups will be stored. Once the alarm setup is
created, the Host Device cannot be changed.
6. Choose an Alarm Handler that determines where alarm notifications are sent.
7. Choose the binary property you want to monitor (Monitored Property, typically BIs, BVs, or BOs). Click
Next to select alarm descriptions and messages. When you finish, the Alarm Wizard creates an alarm setup
for the same property in each of the devices in the range you selected.
8. Select the transition to ON that causes an alarm. This can be OFF (INACTIVE) to ON (ACTIVE) or vice
versa.
9. Type a delay time in seconds. If an alarm condition occurs and returns to normal within this delay time, no
alarm occurs.
10. Click Next.
11. Name the alarm, enable alarm actions, and choose alarm messages. For more information, see Naming and
Enabling Alarms in the Alarm Wizard.
Setting Up Alarm Notification & Action
Naming and Enabling Alarms in the Alarm Wizard
Use the Alarm Wizard (Compass > Alarms > New Alarm Wizard) to name the alarm, enable alarm action, and
choose alarm messages. This topic covers variables you can use for alarm descriptions and messages, naming
alarms in the wizard, enabling alarms and faults, and setting alarm and fault messages.
Variables For Alarm Descriptions and Messages
The Alarm Wizard can build multiple alarms for multiple objects and properties in multiple devices. For this reason,
static alarm descriptions and alarm messages that include a device instance or property won't apply. For example, if
you use the Alarm Wizard to set up a return air alarm for 7 fan-coil controllers numbered 696 through 702, and type
an alarm description of "Device 696, AI-3, Return Air Alarm," it won't be accurate for devices 697 through 702.
To help you set up alarms, the Alarm Wizard provides variables you can use in alarm descriptions and alarm
messages. By using these variables, you can write a description or message for a range of alarms and include vital
information about the origin of the alarm, without having to edit each alarm setup individually. You can mix
variables and plain text. For example, you can type "%3, %6, Bad Space Temp. Sensor Alarm" as an alarm
description.
25
Alarms
This
Adds this to each alarm description or message: Example
variable:
The device instance of the device that hosts the
%1 702
monitored property.
The monitored object, property, and the description
%2 AI 3, present-value (return air temp.)
of the property in parenthesis.
The device instance of the device that hosts the
monitored property, preceded by the word "Device" Device 702 (Fan-Coil 6 Controller).
%3
and followed by the device's description in Included in the default description.
parenthesis.
The monitored property without the property's AI 4, present-value. Included in the
%4
description. default description.
The device description of the device that hosts the
monitored property. Example: Fan-Coil 6 Controller.
%5 Device 702
If the description is empty, returns Device <device
instance>.
The description of the monitored property. Example:
%6 return air temp. If the description is empty, returns AI 5, present-value
the monitored object and property.
Naming the Alarm: Event-Enrollment Object Description
Use the event-enrollment object description box to name the alarm. Ideally, this description points to the device,
object, and property where the alarm originates. This is important so those who view the alarm in alarm history or
alarm acknowledgment popup messages can quickly identify its origin. Use variables for device and property
specifics.
Enabling Alarms and Faults
Select Notify on Alarm if you want alarms to occur when the monitored point does not correspond to the criteria
you set up in the wizard. For example, if a fan is normally ON but goes OFF, an alarms generated.
Select Notify on Fault if you want alarms to occur when a fault condition is detected in the monitored point. For
example, if the value cannot be read or an error is returned. This option is currently only supported in the VLCA.
Setting up Alarm Messages
Alarm messages appear in alarm histories and alarm acknowledgment popup messages. They characterize the alarm
and indicate the object and property where the alarm originates. Use variables for device and property specifics. For
analog and floating limit alarms, set up high and low alarm messages as well, which appear when the monitored
property is above range (high alarm) or below it (low alarm). See the Compass Operator’s Manual for an
explanation of each message type.
26
Compass Workstation Interface User Guide PDF
Editing or Choosing an Alarm Handler
An alarm handler maintains a list of alarm recipients and defines the devices that are notified when an alarm occurs.
Recipients of an alarm can be workstations, pagers, and email addresses.
Use the Alarm Handlers dialog box (Compass > Alarms > Alarm Handlers > Add|Edit) to edit an alarm handler.
Click Add Recipient to create a new recipient profile and add it to the list. You can delete recipients from the list
without deleting the profile.
You can add the same device to the recipient list and set up different alarm handling based on the day, the time of
day, or the type of alarm (alarm, fault, return to normal).
Setting Up a Process ID to Handle Events
A process ID is a numerical identifier that BACnet devices use to identify a set of actions to perform when an event
occurs. Manually editing a process ID is necessary only for passing event notifications to other manufacturers’
equipment. For workstations, host devices, and other BACtalk devices, Compass automatically assigns a process ID
for you when you set up event handling. For example, when you set up a pager profile for alarms, Compass
automatically assigns a process ID to it, which the host device uses to interpret how to dial the pager.
If another manufacturer’s processes will pass event notifications to the Compass workstation, click here for a
reference to Compass process IDs for alarm handling.
To create an alarm handler
1. On the Compass menu, point to Alarms, and then click Alarm Handlers.
2. Select the host device on which you want to store the alarm handler.
3. Click Add.
4. Type a description for the alarm handler, and then click OK.
5. Highlight the alarm handler you just created, and then click Edit.
6. Under Acknowledge Popup Messages, select the type(s) of alarm you want to annunciate at workstations.
7. Click Add Recipient, and then select Local Workstation.
8. Select a recipient from the Workstation list.
9. Select actions the workstation performs when it receives an alarm or event notification. If none is selected, the
workstation’s Alarm Setup controls default alarm processing.
Log into Alarm Creates an entry with the alarm message and time stamp in Alarm History.
History
Annunciate if user
acknowledgement Causes an alarm message to appear at the workstation.
required
27
Alarms
Print Causes an alarm message to print at the workstation.
10. Choose the event types this workstation receives. Corresponding event types must be enabled in the Alarm
Setup. If an event is cleared, the workstation will not receive alarms and events of that type.
11. Click OK.
12. Click Select or Store Handler to save your data.
To edit an alarm handler
You can edit an alarm handler to add, change, or remove recipients or actions.
1. On the Compass menu, point to Alarms, and then click Alarm Handlers.
2. Select the alarm handler you want to modify, and then click Edit.
3. In the Alarm Handlers dialog box, edit, add, and remove recipients as needed.
Caution! If you change an existing alarm handler, changes apply to all alarms that use it.
4. Click Store Handler.
To set up different alarm handling at different times
You can set up alarm handlers to process alarms differently depending on the time of day. For example, you can
send an alarm to a workstation during the day but to a pager at night.
1. On the Compass menu, point to Alarms, and then click Alarm Handlers.
2. In the Alarm Handlers dialog box, select the host device that stores the alarm handler, select the alarm handler
that has the recipient you want to schedule, and then click Edit.
3. Click Add Recipient and select the type of recipient profile to set up.
-or-
Select a recipient from the list and click Edit Recipient.
4. Select a recipient from the Description or Workstation list, or click Add New to create a new recipient in the
Description list (pagers only).
5. Select the actions to perform when the alarm occurs. For example, log the alarm and print it. The available
actions depend on the recipient type.
6. Click the command button next to the Schedule box, and then select the days you want this recipient to receive
alarms.
7. In the From and To boxes, type the times you want this recipient to receive alarms.
8. Click OK to save the recipient profile.
28
Compass Workstation Interface User Guide PDF
9. Click Select to add the recipient profile to this alarm handler.
10. Repeat steps 3-9 for each recipient you want to schedule to receive alarm notifications.
11. Click Store Handler.
To create a schedule for an alarm recipient
If a single alarm recipient is available on different days or at different times of the day, you can create multiple
recipient profiles for the same recipient. For each recipient, you set a unique schedule. You can also set up different
handling details.
1. On the Compass menu, point to Alarms, and then click Alarm Handlers.
2. In the Alarm Handlers dialog box, select the host device that stores the alarm handler, select the alarm handler
that has the recipient you want to schedule, and then click Edit.
3. Click Add Recipient, and then click the type of recipient to set up.
4. Select a recipient from the Description or Workstation list.
-or-
Click Add New to create a new recipient (pagers and email addresses only).
Note: When creating multiple recipient profiles, you don’t need to click Add New and create a new
recipient for each profile; if a recipient is already set up, you can select it from the Description or
Workstation list.
5. Select actions and handling details for the recipient as appropriate.
6. Click the command button next to the Schedule box and then select the days you want this recipient to receive
this alarm.
7. In the From and To boxes, type the times that you want this recipient to receive this alarm.
8. Click OK to save the alarm notification.
9. Click OK to close the Recipient Setup dialog box.
10. Click Add Recipient and select the same type of recipient as you did in step 3.
11. Repeat steps 4-9 for each set of days and times you want the recipient available.
12. Click Store Handler.
Alarms Sent to Operator Workstations
Setting Up a Workstation to Receive Compass Alarms
The recipient profile for a workstation (Compass > Alarms > Alarm Handlers > Edit > Add|Edit Recipient > Local
workstation) is where you set up how a Compass workstation treats alarms. You set up the types of alarms and
29
Alarms
notifications that the workstation receives, the actions the workstation takes upon receipt, and its scheduled
availability.
For example, the facility manager works in the office from 8 to 5. You can set up the facility manager as a recipient
and have alarms sent to his workstation between the hours of 8 and 5.
Each recipient is unique. You can set up multiple recipients for a single device (even within a single alarm handler)
depending on how you want the device to handle different alarms. Edits to one recipient do not affect others.
Note Make sure that the Alarm Setup at the workstation is configured correctly for default alarm handling. More
information.
To edit an existing alarm
If you have an alarm that is set up to dial a pager but want to change it to appear on a workstation, you can create a
new alarm handler for the alarm or edit the existing alarm handler. Be careful if you edit an existing alarm handler
because all alarms using the handler will be affected.
1. Identify the object and property whose alarm you want to change and identify the alarm assigned to it.
2. Identify the device instance of the workstation where you want the alarm displayed.
3. On the Compass menu, point to Alarms, and then click Point Alarms.
4. Select the device instance of the host device.
5. In the Objects list, click the alarm setup you identified in step 1, which is listed by device and object (for
example, v 110102 BV 1), and then click Edit.
6. Click the command button beside the Handler box to create a new alarm handler or edit the existing one.
If a valid alarm handler is assigned, in the Handlers box, Compass lists the alarm handler assigned to this alarm.
The Recipients list shows the devices set up as recipients for this alarm handler.
If the alarm handler is not valid, Compass prompts you to choose a valid handler, edit the existing one using the
Raw Notification Class Editor, or cancel. Unless you are familiar with the Raw Notification Class Editor, click
Choose a Valid Handler. If none exists, you’ll be prompted to create a new one.
7. In the Alarm Properties dialog box, under Notifications, select Send on Alarm and Send on Fault. Under
Messages, type alarm messages for Alarm, Fault, and Normal text.
To set up an alarm so it logs to a workstation’s alarm history
If you want to log alarms in the Alarm History log, use an alarm handler to identify the alarms you want to log.
1. Open the Alarm Handlers dialog box for the handler assigned to the alarm.
2. Click Add Recipient, and then click Local Workstation.
3. Select a workstation from the Workstation list or type its device instance.
4. Under Actions, click Log Into Alarm History.
5. Click OK.
30
Compass Workstation Interface User Guide PDF
6. Click Store Handler.
To set up an alarm so that it is printed
If you want to print every alarm as it occurs, you can do so in the alarm handler.
1. On the Compass menu, point to Alarms, and then click Alarm Handlers.
2. Select the alarm handler you want to edit, and then click Edit.
3. Click Add Recipient, and then select Local Workstation.
4. Select a workstation from the Workstation list or type its device instance.
5. Under Actions, click Print.
6. Click OK.
7. Click Store Handler.
8. If necessary, start Compass at the workstation where the alarm will print.
9. On the Compass menu, point to Alarms, and then click Alarm Setup.
10. Under Alarm Printing, click Enable Printing.
11. Select a Printer from the list.
12. Click OK.
Alarms Sent to Pagers
Setting Up a Pager to Receive Compass Alarms
The recipient profile for a pager (Compass > Alarms > Alarm Handlers > Edit > Add|Edit Recipient > Pager)
enables you set up an alphanumeric or digital pager to receive alarms. Each recipient is unique. You can set up
multiple recipients for a single device (even within a single alarm handler) depending on how you want the device
to handle different alarms. Edits to one recipient do not affect others.
Deliver alarms to a pager when they are too critical to wait for someone to acknowledge at a workstation.
To set up an alphanumeric pager
Compass can send alarm messages and other alarm information to alphanumeric pagers. Alphanumeric pagers
display all information that appears in an alarm popup message at the workstation.
Alphanumeric pagers are dialed only once for each recipient set up.
1. Open an alarm handler, click Add Recipient, and then click Pager.
2. Click Add New.
31
Alarms
3. Type a description for the pager profile. Compass automatically assigns a process ID to the pager, which
appears as part of its description.
4. Type the phone number for the pager.
5. Select Alphanumeric pager.
6. In the Pager ID box; type the unique identifier for the pager, which is used after the call connects to the pager.
The Pager ID is usually the individual pager phone number, but specifics vary depending on the pager service.
Contact the pager service for requirements.
7. From the Dialout thru controller list, select the controller whose modem is used to dial out alarms.
8. Under Paged Events, select the check boxes for the types of events you want to send to this pager.
9. Click the command button next to the Schedule box and select the days of the week and times that you want the
pager to receive alarms.
10. Click OK, and then click Store to save the profile.
To set up a standard (numeric) pager
Standard pagers require a single phone number, which rings the pager directly. Optionally, you can specify a
numeric message, which is passed to the pager. This enables you to assign a specific code to an alarm, so the pager
recipient can tell from the numeric message what the source of the alarm is.
Standard pagers are dialed only once for each recipient profile set up.
1. From the Compass menu, select Alarms and then click Alarm Handlers.
2. Select the host device and then select the handler from the list.
3. Click Edit.
4. Open an alarm handler, click Add Recipient, and then click Pager.
5. Click Add New.
6. Type a description for the pager profile, and then click OK. Compass automatically assigns a process ID to the
pager, which appears as part of its description.
7. Type the phone number for the pager.
8. Type a numeric message using only characters that you know the pager can handle.
9. From the Dialout thru Controller list, select the controller whose modem is used to dial out alarms.
10. Under Paged Events, select the check boxes for the types of events you want to send to this pager.
11. Click the command button next to the Schedule box and select the days of the week and times that you want the
pager to receive alarms.
32
Compass Workstation Interface User Guide PDF
12. Click OK, and then click Store.
33
Trendlog Management
About Automation Features and Host Devices
A host device supervises, stores, and runs energy management and building automation features, such as trendlogs,
schedules, alarms, demand limiting, optimum start, and energy logs. You set up automation features in Compass,
which are then downloaded to the host device, where they run locally. If the connection to the Compass workstation
is lost, or is temporary in the first place, the automation features continue to run.
Global controllers (BCMs), expandable controllers (VLXs), and Alerton Control Modules (ACMs) can function as
host devices. Choose the nearest available host device to the data point being monitored, logged, or scheduled. If
you have only one global or expandable controller on site, it must serve as the host device.
About Trendlogs
Trendlogs help you troubleshoot problem areas and identify critical operating trends in your system. For example,
log the temperature in a room to see if the system is keeping it within desired setpoints.
Trendlogs are also an essential component of the Fluid Energy and Energy Log modules of Compass. Both features
rely on data gathered by trendlogs.
When you set up a trendlog at a Compass workstation, you instruct a host device to sample values from a property
at regular intervals. The monitored property can be from another controller. However, we recommend that you log
only local properties.
Caution! You must set up the UTC option properly in Device Manager or the time for trend data will not
display correctly in trendlogs. That is, you must check the Send UTC offset property to device check box
on the Capabilities tab and set a UTC offset on the Preferences tab.
To set up a trendlog for a property
You can set up a trendlog for any monitored points in your system to ensure that buildings are behaving as planned.
1. On the Compass menu, point to Trendlog Management, click Trendlogs, click Add, and then select Single
Trendlog.
-OR-
Right-click on a property in a data display, and then click Trendlog Management (skip step 2).
2. Under Object Specification, identify the object and property you want to log, and then click OK. For more
information, see Specifying an ID for a Property.
3. From the Host Device list, select or type the device instance of the controller to host the trendlog. This is the
controller where all trendlog data resides until it’s gathered by the Compass primary workstation specified in the log
handler.
4. Click the command button next to Trendlog Handler and select the default log handler.
Caution! Using a log handler other than the default may cause database errors and corruption.
5. Click Select.
35
Trendlog Management
6. Increase the Trendlog Interval entry to the maximum your application permits. The larger your trend interval,
the less likely that logged samples will be lost.
7. Normally, you can leave the Buffer Size, Notification Threshold, and Max. Samples set to their defaults.
To use companion trendlogs
Use companion logs to view data side-by-side for up to ten logs. This is a good way to compare trends for
equipment. For example, you can view temperatures in different zones side-by-side.
1. Set up trendlogs for all properties whose data you want to view. (How?)
2. On the Compass menu, point to Trendlog Management, and then click Trendlogs.
3. Select a trendlog from the list and then click View.
4. Right-click the column heading that contains the device number, and then click Add Companion Logs.
5. Select the logs you want to display as companion logs, and then click Select. Data from the logs appears side-
by-side with the primary log. Choose Graph View from the View menu to view graphs of all data.
To set up multiple trendlogs
The Multiple Trendlog Builder (Compass > Trendlog Management > Trendlogs) enables you to set up trendlogs in
a host device for multiple properties in multiple devices. You can set up as many as five logs per device.
In the controller defined as the host device, Compass creates a trendlog for each of the properties in each device. So,
for example, you can build identical logs for the present-value of AI-1, AI-2, and AI-3 in controllers 702 through
802.
The Multiple Trendlog Builder is especially useful if you have a number of VLCs that perform the same function
and are set up with the same object/property scheme: VAV controllers are a good example. It is also useful if you
have more than one trendlog to set up in a single device.
1. On the Compass menu, point to Trendlog Management, click Trendlogs, click Add, and then select Multiple
Trendlogs.
2. Type the device instance of the first device in which you want to log data. Trendlogs are built for properties in
devices from this device to the End Device Instance.
3. Type the device instance of the last device whose data you want to log. Trendlogs are built for properties in
devices from the Start Device Instance to this device.
4. Select the properties whose value you want the trendlog to sample.
5. Type text (1-30 characters) to identify the trendlogs in trendlog listings, printouts, and energy logs. An example
is "Zone Space Temp."
6. Select the units of measure to display when viewing trendlog data and to use if an energy log references this
trendlog.
36
Compass Workstation Interface User Guide PDF
7. Type the frequency, in seconds, that the logged property is sampled. Default is 60 seconds. Minimum is 10
seconds. Use the least frequent interval possible (greatest number) to minimize network traffic.
8. Type the number of decimal places to be displayed in trendlog samples.
9. For binary properties, select Show BV text to have Active, Inactive, and Null text displayed in trendlog
samples. If cleared, 1s and 0s appear.
10. Type the device instance of the controller to host the trendlog object or select one from the list. This is the
controller where the trendlog resides.
11. Click the command button next to the Trendlog Handler box, and then select a log handler. The Log Handler
determines the workstation that gathers trendlog data from the controller.
Caution! Using a log handler other than the default may cause database errors and corruption.
12. Type a notification threshold value in number of samples. The notification threshold determines when the host
device sends samples to the workstation. By default, the notification threshold is roughly one third of the buffer size
(80 and 256, respectively), which typically allows ample time for the workstation to gather samples before any are
lost. However, if the host device functions in a stand-alone capacity or you see gaps in trendlog data, you may want
to increase these values and the difference between them. The downside is that the log will consume more memory
at the host device.
13. Type a buffer size value in samples. This is the maximum number of samples that the controller retains before
samples are lost.
14. Type the number of samples the Compass database saves before it deletes the oldest data. The maximum table
size is approximately 27 million samples. The default is 5,000 samples. Smaller values help performance: Compass
reads the database more quickly, but you must archive data more frequently.
15. Click Build.
To set up a workstation to receive trendlog data
A log handler is automatically created in the host device when a trendlog is created. By default, the log handler lists
the Compass primary workstation as the only recipient of trendlog data. You can edit the recipient list in the log
handler.
Caution! Selecting a recipient workstation other than the Compass primary workstation can cause database
errors and corruption.
1. On the Compass menu, point to Trendlog Management, and then click Log Handlers.
2. Select the Log Handler to which you want to add a new recipient, and then click Edit.
3. Click Add Recipient.
4. Type or select the device instance for the workstation you want to receive trendlog data.
5. Repeat steps 3 and 4 for every workstation you want to receive trendlog data.
37
Trendlog Management
To delete a trendlog
You can delete a trendlog if you no longer need it. Logs are permanently deleted from the Compass trendlog
database and, if connected to a BACtalk system, the log is deleted from the controller.
1. On the Compass menu, point to Trendlog Management, and then click Trendlogs.
2. In the Trendlogs dialog box, click the log you want to delete. Use CTRL + click or SHIFT + click to select
more than one log.
3. Click Delete.
To archive trendlog data
Compass enables you to archive trendlog data to a comma separated values (*.csv) or Access (*.mdb) format. You
can import the file into a spreadsheet or database program if you ever need to analyze the data.
Caution! Make sure you do not inadvertently delete trendlog data or copy over an existing log. Choose
options carefully. You will not be prompted to confirm.
1. On the Compass menu, point to Trendlog Management, and then click Trendlogs.
2. Select the trendlog or logs you want to archive, and then click Archive.
3. In the Archive settings group box, select how often you want to archive the trendlog data (archive period).
4. Select Auto-archive to automatically archive at the chosen archive period. If the box is not selected, then
archiving must be manually initiated by clicking Archive Now.
5. Select the format for your data. You can save data to a comma separated values (*.csv), Access (*.mdb) format,
or both.
6. Select Replace/append... to replace (in the case of Excel (*.csv) format) or append (in the case of Access
(*.mdb) format) data to the existing archive file for that period. If the option is not checked, then archiving for that
format is skipped if the archived file for that format (Excel or Access) already exists.
7. Select Remove all but... to purge old data from the current database, and define the number of periods to retain
in the database. For example, to keep the last three months worth of data when using a Monthly Archive period
enter ”3” in the box.
8. Select Archive all entries... to archive all data in the current database, not just the period selected in the
Archive period combo box. This is useful to avoid data loss.
9. If you want to archive data now, select the dates for data you want to archive, and then click Archive Now.
38
Energy Management
Energy Logs
Working with Energy Logs
Energy logs (Compass > Energy Management > Energy Logs) calculate energy demand and consumption based on
trendlogs of meter data. Energy logs calculate peak energy demand, which is averaged over a demand window you
specify, and energy consumption data for every 15-minute period. Use energy logs to determine when your energy
is being consumed. For example, you can determine if your peak demand time occurs during a shift change.
Before you can set up an energy log you must define the following.
• Define the meters that will monitor energy use in your building or facility.
• Set up trendlogs for the points that represent the energy meter input. You can also set up
trendlogs on the fly as you set up the meter. Trended properties can report energy consumption or
demand data, and they can be regular energy meters or fluid energy meters.
A meter is actually data recorded from measuring devices, which may or may not be considered meters themselves.
For example, measuring devices include kWh pulse meter, ton-hour pulse meter, and a current transformer. You can
combine data from multiple meters to create a single energy log. These meters are typically connected to VLCs and
the trendlog captures data from the VLC.
Trendlogs instruct a host device to sample values from a point on the VLC at regular intervals. The energy log reads
the trendlog data and calculates energy usage and peak demand by hour, day, week, month, and year according to
the units of measure in the trendlog setup, the meter setup, and the report setup. For more information about
Trendlogs, see About Trendlogs.
Understanding Compass Energy Logs
There is often much confusion around the difference between energy and demand. Demand is the rate at which
energy is used. In the case of electricity, energy is typically measured in kWh and demand is measured in kW,
which could be thought of as kWh per hour. For example, if you have a piece of equipment that is rated at 17 kW, it
uses 34 kWh of energy if you leave it running for two hours (2 x 17 = 34). Most commercial electrical meters
record both the total energy (kWh) used and the highest demand or rate of energy use (kW) since the last time the
meter was read.
39
Energy Management
In the case of thermal energy, the typical unit of measure for the English system is the BTU (British thermal unit),
which is the amount of energy required to heat one pound of water 1 deg. Fahrenheit. The demand, or rate of energy
use, in these units is BTU/hr. This unit is sometimes (incorrectly) written as Btuh, which adds to the confusion
because kWh is a unit of energy, whereas Btuh (actually Btu/hr) is a unit of demand.
Other examples of demand units are tons of refrigeration (1 ton = 12,000 Btu/hr) and kilojoules (kJ). Other
examples of energy units are ton-hours of refrigeration (1 ton-hour = 12,000 Btu) and therms (1 therm = 100,000
Btu)
Setting up Energy Logs
When setting up an energy log in Compass, you define the meters that are used to measure the energy being used.
These meters are actually trendlogs of data recorded from measuring devices, which may or may not be considered
meters themselves. Some examples of measuring devices are: kWh pulse meter, ton-hour pulse meter, and current
transformer. These devices are typically connected to a VLC, and the trendlog captures data from the VLC.
Setting up Pulse Meters
An energy pulse meter, which initiates a pulse each time a specified amount of energy is consumed, can be
configured in the VLC to indicate either cumulative energy consumed (for example, kWh), or demand (for example,
kW). This selection is made in the input configuration section of VLC DDC.
If the input is configured as a pulse totalizer, the value of the associated AI increments by the value entered for
pulse value each time a pulse is detected. A trendlog of this AI can then be used as a consumption meter when
setting up a Compass energy log. This is the most accurate way to set up an energy log with a pulse meter.
If the input described above (connected to an energy pulse meter) is configured as a pulse flow meter (using VLC
DDC) or a pulse width input (using VisualLogic), the associated AI then indicates the rate of energy use based on
the time between pulses. The time base, which is entered as part of the input configuration, indicates the number of
seconds in the time portion of the demand units. It determines whether the AI is based on energy use per second
(time base = 1), energy use per minute (time base = 60), or energy use per hour (time base = 3600). For a kWh pulse
meter set up to indicate kW (which is kWh per hour), the time base should be set to 3600. A trendlog of this AI can
then be used as a demand meter when you set up a Compass energy log. However, this method is less accurate than
setting up the pulse meter as a pulse totalizer as described above.
Pulse meters are also often used to indicate water flow, where a pulse is initiated each time a specified amount of
water has passed the meter. If the input is configured as a pulse totalizer, the AI indicates the cumulative amount of
water that has passed the meter. If the input is configured as a pulse flow meter/pulse width input, the AI indicates
the rate of flow. Typically, the units for rate of flow for water would be gallons per minute (gpm), which would
require a time base of 60 (sixty seconds per minute).
Setting up a Meter Based on a Current Transformer
A current transformer (CT) can be used to measure the rate of energy use, or demand, on an electrical circuit. The
output of the CT can be scaled so that it corresponds to the kW that the circuit is using. A trendlog of the associated
AI can then be used as a demand meter when you set up a Compass energy log. Current transformers can't be set up
as consumption meters, except perhaps by using DDC to integrate the energy use over time and write the value to
an AV; energy logs accomplish the same thing, however.
About Meters
Energy logs use meters to gather demand or consumption data. An energy log can use a single meter or the sum of a
number of meters. Each meter references a trendlog, and each meter has a unique setup, or profile. A unique meter
40
Compass Workstation Interface User Guide PDF
number identifies the meter setup. For example, you might set up one meter to measure power demand in a building
and another to measure heat consumption.
When you set up a meter for an energy log, in addition to the meter name, you specify:
• The trendlog that monitors the meter input
• The type of meter, which is either demand (rate) or consumption. More information.
• The desired meter units and a conversion factor, if necessary, which is applied to the trendlog sample value
to determine a meter reading (for example, trendlog sample value X conversion factor = meter reading).
Related Topics
Using Custom Units
About Fluid Energy Meters
A fluid energy meter (Compass > Energy Management > Energy Logs > Add > Add Meter > Add > Fluid Energy
Meter) relies on three trendlogs: one for flow and two for temperature. Based on the measurement of flow and the
temperature difference in the inflow and outflow fluid, Compass calculates how much energy the fluid has absorbed
(cooling) or expended (heating). For example, you can use a fluid energy meter to measure the flow of water in and
out of a chilled water distribution system.
You can also provide a value for the Specific Heat and the Specific Gravity of the fluid being measured.
The three trendlogs used are:
• Trendlog under Fluid Measurement, which establishes the rate of fluid flow for the fluid measured. Specify
whether the meter provides rate-of-flow or consumption data, and the units the data represents. You can also
provide a conversion factor used to convert the units in the trendlog to meter units (trendlog data sample X
conversion factor = meter data value).
• Temp 1, which reads the inflow fluid temperature. Trendlog units must be degrees F, degrees C, or degrees
K.
• Temp 2, which reads the outflow fluid temperature. Trendlog units must be degrees F, degrees C, or degrees
K.
About the Demand Window
The demand window is a period of time over which demand is averaged to determine peak demand for a sample
period. Many utilities include a charge based on peak demand, which is usually calculated using a demand window.
Peak demand for a sample period (a day, for example) is equal to the highest average demand from any demand-
window time period on that day. A sample period could be an hour, a day, a week, or a month—any period for
which you want to calculate a peak demand period.
Take for example a demand window of 10 minutes. Compass averages demand over every 10-minute period within
the sample period to calculate the peak demand. It may be helpful to picture a sliding window 10 minutes wide
imposed on a graph. The figure in this topic illustrates such a window for kW demand over an hour. Placing the
demand window anywhere along the graph, average the values within the window until you get the highest value
for the sample period: this is the peak demand.
41
Energy Management
About Demand and Consumption Meters
Demand meters provide samples of instantaneous demand, telling you how much is being used at a particular
instant. Consumption meters (the more accurate and thus preferred meter type) provide samples that increment over
time. The same information can be inferred from demand and consumption meters. To illustrate the differences and
similarities, think of the speedometer in a car as a demand meter and the odometer as a consumption meter. You can
infer speed (demand) from the odometer if you read the odometer at regular intervals. Likewise, you can infer
distance traveled (consumption) from the speedometer if you mark elapsed time.
The graph below illustrates this concept for an instantaneous demand meter that reads kW in a building. Bars
represent its values. Another meter reads consumption (kWh) from the same source. The line represents its values.
42
Compass Workstation Interface User Guide PDF
Using Custom Energy Log Units
If you select custom units when you set up an energy log or an energy log meter, follow these rules:
1. Set up all meters (within the energy log) with the same custom units for rate or consumption as appropriate.
2. Energy log custom units must precisely match the meter's custom units.
3. For custom units, the relationship between demand and consumption units must always be <units>/hour and
<units>.
To set up an energy log
When you set up an energy log (Compass > Energy Management > Energy Logs> Add/Edit), you first set up
trendlogs for objects and properties that represent an energy meter input. For more information about trendlogs, see
About Trendlogs.
1. Identify the properties that will serve as meters for your energy log. Record the properties and whether they
provide demand or consumption data.
2. On the Compass menu, point to Energy Management, and then click Energy Logs.
3. Click Add.
4. Type a description to identify this energy log in listings and reports.
5. Type a demand window value in minutes. Compass calculates peak demand using a sliding window with this
time span. Default is 15 minutes. The window with the highest average within a period (hour/day/month/year) will
be that period's peak demand. See About the Demand Window for more information.
6. Type the number of digits to appear to the right of the decimal in energy log samples.
7. Click Add Meter, and then select one or more meters from the list or click Add to set up a new one. For more
information about setting up meters, see To set up a meter for an energy log. To set up a fluid energy meter, see To
set up a fluid energy meter.
Important: If you select Custom Units for any meter, all meters must be set up with the same custom units.
Additionally, the relationship between demand and consumption units is always <units>/hour and <units>.
You must also select report units that precisely match meter units. See Using Custom Energy Log Units for
more information.
8. Select the report units you want to use.
To set up a meter for an energy log
Use meters to gather demand or consumption data for an energy log. An energy log can use a single meter or the
sum of a number of meters.
1. On the Compass menu, point to Energy Management, and then click Energy Logs.
2. Click Add to create a new energy log.
43
Energy Management
3. In the Energy Logging Setup dialog box, click Add Meter.
4. In the List of Energy Meter dialog box, click Add, and then select Energy Meter.
5. Type a name for the meter.
6. Click the command button and select a trendlog from the list or set up a new one. Each meter references a
trendlog of the meter input. For more information about how to create trendlogs for a meter, see the Compass
Operator’s Manual.
7. Select whether the meter reports rate of usage (for example, tons/ hr or kW) or consumption (for example, tons
or kWh).
8. Select desired meter units from the drop-down list and then type a conversion factor, if necessary, for
converting the Units in the Trendlog setup to the meter units. This conversion factor is multiplied by the trendlog
units to obtain the meter units. For example, to convert kWh in a trendlog to meter units of BTUs, type 3412.14.
9. Click OK.
10. Click Select.
To set up a fluid energy meter
Use a fluid energy meter to measure how much energy a fluid has absorbed (cooling) or expended (heating). For
example, you can measure the flow of water in and out of a chilled water distribution system.
1. On the Compass menu, point to Energy Management, and then click Energy Logs.
2. Click Add to create a new energy log.
3. On the Energy Logging Setup dialog box, click Add Meter.
4. On the List of Energy Meter dialog box, click Add, and then select Fluid Energy Meter.
5. Type a name for the meter.
6. Click the button and then select a trendlog, or set up a new one, that logs an input reporting rate of flow (for
example, gallons/hr) or totalized flow (for example, gallons).
7. Select whether the meter reports rate of usage (for example, gallons/hr) or consumption (gallons).
8. Type the Specific Heat value for the fluid measured.
9. Type the Specific Gravity value for the fluid measured.
10. If Units of Flow are different than the Units for the Trendlog selected under Fluid Measurement, type a
conversion factor. This conversion factor is multiplied by the trendlog units to obtain the meter’s units of flow. For
example, to convert trendlog liters per second to U.S. gallons per second for the meter, type 15.848.
11. Click the command button and then select a trendlog that represents inflow fluid temperature. Make sure you
select a trendlog set up with temperature in degrees C, F, or Kelvin.
44
Compass Workstation Interface User Guide PDF
12. Click the command button and then select a trendlog that represents outflow fluid temperature. Make sure you
select a trendlog set up with temperature in degrees C, F, or Kelvin.
13. Click OK.
14. Click Select.
To archive energy log data
Compass enables you to archive energy log data to a comma separated values (*.csv) or Access (*.mdb) format.
You can import the file into a spreadsheet or database program if you ever need to analyze the data.
Caution! Make sure you do not inadvertently delete trendlog data or copy over an existing log. Choose
options carefully. You will not be prompted to confirm.
1. On the Compass menu, point to Energy Management, and then click Energy Logs.
2. Select the energy log or logs you want to archive, and then click Archive.
3. In the Archive settings group box, select the report type and how often you want to archive the energy log data
(archive period).
4. Select Auto-archive to automatically archive at the chosen archive period. If the box is not selected, then
archiving must be manually initiated by clicking Archive Now.
5. Select the format for your data. You can save data to a comma separated values (*.csv), Access (*.mdb) format,
or both.
6. Select Replace/append... to replace (in the case of Excel (*.csv) format) or append (in the case of Access
(*.mdb) format) data to the existing archive file for that period. If the option is not checked, then archiving for that
format is skipped if the archived file for that format (Excel or Access) already exists.
7. Select Remove all... to purge old data from the current database, and define the number of periods to retain in
the database. For example, to keep the last three months worth of data when using a Monthly Archive period enter
”3” in the box.
8. Select Archive all... to archive all data in the current database, not just the period selected in the Archive period
combo box. This is useful to avoid data loss.
9. If you want to archive data now, select the dates for data you want to archive, and then click Archive Now.
To view energy log data
View energy log data to identify peak demand periods at your site. For example, you can determine if your peak
demand periods fall during a shift change.
You can use the standard energy log viewer or DataViewer, which gives you more options.
To use the standard viewer
1. On the Compass menu, point to Energy Management, and then click Energy Logs.
45
Energy Management
2. Select the energy log you want to view and then click View.
3. Select whether to view energy log data by hour, day, month, or year.
4. Select the first and last day of energy log data you want to view.
5. On the View menu, click Refresh.
To use DataViewer, open a data display and then click the DataViewer smart button.
To print energy log data
Compass enables you to print energy log data to use for reports or files.
1. On the Compass menu, point to Energy Management, and then click Energy Logs.
2. Select the energy log you want to print, and then click View.
3. On the File menu, click Print.
Rebuilding Energy Logs
Use the rebuild feature if your energy logs contain miscalculated data, if you have gaps in energy logs, or if you
want to build new energy logs from pre-existing trendlog data.
About energy log calculation errors
The Energy Log Rebuild tool is a remedy for a bug that was introduced in Compass 1.4 Update 1 Patch 1. The bug
caused erroneous energy log data (negative values) to be logged in some instances.
Determining the need to rebuild energy logs
If you upgraded to Compass 1.5.1 from Compass 1.3 or earlier, there is no need to rebuild the energy logs because
the issue was introduced in Compass 1.4.
If you upgraded to Compass 1.5.1 from Compass 1.4 (after applying Update 1 Patch 1) or Compass 1.5, then you
should rebuild your energy logs to ensure data integrity.
Using the Energy Log Rebuild tool
Trendlog data must exist in the active database. If you set time frames that extend beyond the available data, the
energy log will contain only the available data. Maximum sample limits and archiving can affect the amount of data
available in the active database.
The Energy Log feature is not available during the rebuild process, which can take several hours for very large data
sets. During the rebuild process, you can click Cancel and the process will stop after rebuilding the current energy
log. It may take a few minutes to finish processing the current energy log.
Errors in the rebuild process, including gaps in the trendlog data, are logged in <rep>/<job>/ebtlog.txt. Use this log
to troubleshoot issues.
46
Compass Workstation Interface User Guide PDF
1. On the Compass menu, select Energy Management and then click Energy Logs. The Energy Logs dialog box
appears.
2. Select the logs you want to rebuild and then click Rebuild. The Rebuild Energy Logs dialog box appears.
3. Select beginning and ending dates. Use the default dates; they match the dates when the calculation error was
active.
4. Selecting time frames that exceed available data may cause excessive error log entries.
Note: Selecting time frames that exceed available data may cause excessive error log entries.
5. Click Rebuild. The progress monitor shows the status of the rebuild process.
Note: When you cancel a rebuild in process, Compass will finish rebuilding the current energy log and then
stop. Additional energy logs will not be rebuilt.
Demand Limiting
About Demand Limiting
A demand limiter is a special Compass object, which is stored and runs in a controller. Set up a demand limiter
from the Compass menu (Compass > Energy Management > Demand Limiting).
Use demand limiters to turn equipment ON or OFF based on energy demand at your site. You can also use a
demand limiter to adjust temperature setpoints in your building. For example, you can start shutting equipment
down or add temperature points to a setpoint if energy consumption reaches a defined level during the day.
Use the following checklist when setting up demand limiters:
1. Define the meter inputs that will measure energy use
2. Decide what equipment you want to control and how you want to control it
3. Identify the data points that are associated with the equipment you want to control
4. Decide the priority for turning the equipment OFF (for example, do you want to turn it off first or save it until
last)
5. Decide the priority for turning the equipment ON (for example, do you want to turn it on as soon as possible or
can it wait)
For more information about the demand limiting feature, see the Compass Operator’s Manual.
Warning! Improper configuration of a demand limiter can adversely affect site equipment operation.
About the Demand Window
The demand window is a period of time over which demand is averaged to determine peak demand for a sample
period. Many utilities include a charge based on peak demand, which is usually calculated using a demand window.
47
Energy Management
Peak demand for a sample period (a day, for example) is equal to the highest average demand from any demand-
window time period on that day. A sample period could be an hour, a day, a week, or a month—any period for
which you want to calculate a peak demand period.
Take for example a demand window of 10 minutes. Compass averages demand over every 10-minute period within
the sample period to calculate the peak demand. It may be helpful to picture a sliding window 10 minutes wide
imposed on a graph. The figure in this topic illustrates such a window for kW demand over an hour. Placing the
demand window anywhere along the graph, average the values within the window until you get the highest value
for the sample period: this is the peak demand.
About Demand and Consumption Meters
Demand meters provide samples of instantaneous demand, telling you how much is being used at a particular
instant. Consumption meters (the more accurate and thus preferred meter type) provide samples that increment over
time. The same information can be inferred from demand and consumption meters. To illustrate the differences and
similarities, think of the speedometer in a car as a demand meter and the odometer as a consumption meter. You can
infer speed (demand) from the odometer if you read the odometer at regular intervals. Likewise, you can infer
distance traveled (consumption) from the speedometer if you mark elapsed time.
The graph below illustrates this concept for an instantaneous demand meter that reads kW in a building. Bars
represent its values. Another meter reads consumption (kWh) from the same source. The line represents its values.
48
Compass Workstation Interface User Guide PDF
Setting up meters for a Demand Limiter
A meter is a property or set of properties that monitors and measures energy use. The demand limiter uses the
information obtained by the meters to determine when to turn equipment ON or OFF.
Use the Meters tab (Compass > Energy Management > Demand Limiting > Add|Edit) to assign the input that the
demand limiter uses to calculate the average demand. Meter inputs are usually AVs or AIs. For information about
types of meters, see About Demand and Consumption Meters.
The average demand is the average of the most recent samples from the meter input, based on a demand window
you specify in minutes on the Parameters tab. When the average demand rises above a setpoint you specify, the
demand limiter begins shedding loads in an attempt to lower demand. For more information about how meters
determine the average demand, see About the Demand Window.
Assigning Loads to a Demand Limiter
A load is any equipment that uses energy. For example, motors, lights, air conditioners, heaters, computers, and
appliances are all loads. In Compass, a load is represented by a property that represents an ON/OFF, demand offset,
or occupied/unoccupied command for a piece of equipment. There are three types of loads: analog, binary, and
custom binary.
Analog Normally, analog loads are used to control a demand offset affecting temperature setpoints.
49
Energy Management
Most often, binary loads are INACTIVE (OFF) when shed, but can be set up to be ACTIVE
Binary (ON) when shed. Binary loads (shed references) are organized within shed levels.
Custom Custom binary loads shed and restore at specific demand levels (independent of the control
Binary ramp).
To set up a Binary Load
Use binary loads to turn equipment ON or OFF based on your building’s average energy demand.
1. On the Compass menu, point to Energy Management, and then click Demand Limiting.
2. In the Demand Limiting dialog box, click Add to create a new demand limiting program, or select an existing
one and, then click Edit.
3. In the Edit Demand Limiters dialog box, click the Binary Loads tab.
Note: If you are creating a new demand limiting program, you must define the host device before you click
the Binary Loads tab.
4. In the Loads list, select the Shed Level you want to add a load to, and then click Add. For example, equipment
in shed level 1 is shed first and restored last by default.
5. Select the property that corresponds to the equipment you want to turn ON or OFF. For example, this might be
the present-value of a binary value in a VLC that operates a pump.
6. Type a meaningful description for this binary load. This helps you identify the load from the Status dialog box.
For example, Building # 4 pump.
7. Type a priority level from 1-16. This determines the index at which the demand limiter writes to the priority-
array.
8. Select the shed and restore commands for the binary property. For example, send a shed command of Inactive
to turn the equipment OFF.
9. Set the anticycle limits for this load; its value will not change until the minimum duration has elapsed.
To set up an Analog Load
Set up analog loads to control a demand offset, affecting system setpoints. Use a positive number for the real offset,
because internal calculations for heating and cooling setpoints subtract or add the value as appropriate.
Caution! Unless AV-106 is used, analog points used for demand limiting must be handled in DDC. Do not
assign an AV or AO used as a setpoint directly to a demand limiter. Use DDC to add or subtract the point
to the value of a setpoint.
1. On the Compass menu, point to Energy Management, and then click Demand Limiting.
50
Compass Workstation Interface User Guide PDF
2. In the Demand Limiting dialog box, click Add to create a new demand limiting program
or
Select an existing one and click Edit.
3. In the Edit Demand Limiters dialog box, click the Analog Loads tab.
Note: If you are creating a new demand limiting program, you must define the host device before you click
the Analog Loads tab.
4. Select the property on the local device that corresponds to the setpoint you want to control.
5. Type a meaningful description for this analog load. This helps you identify the load from the Status dialog box.
For example, Main Building High Temperature Offset.
6. Type a priority level from 1-16. This determines the index at which the demand limiter writes to the priority-
array.
7. Use the shed and restore parameters to set the commanded property based on the ramp setpoint. For more
information or examples, see the Edit Analog Load Dialog Box.
Viewing the Status of the Demand Limiter
The General tab in the Demand Limiter Status dialog box provides information about the demand limiter and
enables you temporarily disable the demand limiter (Compass > Energy Management > Demand Limiting > Status).
Use the Binary tab to view the current status of all defined binary and custom binary loads. Use the Analog tab to
view the status of all defined analog loads.
Tips for viewing a demand limiter’s status
1. The current average demand is calculated as an average of the samples taken from the meter input.
2. When viewing the demand control ramp value of the demand limiter, 0 = No shedding and 100 = Full load
shedding.
3. Clear the Enable box if you want to retain all the demand limiter’s setup information, but don’t want the
demand limiter to affect operations.
Optimum Start
About Optimum Start
Optimum start adjusts the heating or cooling start time in an attempt to bring zone temperatures to the appropriate
setpoint for occupancy. For example, you want the classrooms in your school to be at a comfortable temperature
(their individual setpoints) before class begins. You can do this by first setting up each classroom as a zone and
linking a schedule to each zone. Then, you set up optimum start for each zone (classroom). Optimum start
calculates when to start warming or cooling the classrooms based on the settings you define.
1. Before you can set up optimum start, you must complete the following steps.
2. Define the zones in your building. These are the areas that you want to control using optimum start.
51
Energy Management
3. Define a schedule set (standard, holiday, and event) that identifies when the zones are occupied. Optimum start
uses this schedule set to calculate when to start heating or cooling the zone in advance of occupancy.
4. Optimum start works in three modes: None (disabled), Automatic, or Manual.
5. Select None (disabled) to disable optimum start calculations in the zone. The linked schedule still controls
heating and cooling operations in the zone.
6. Select Automatic mode to calculate optimum start using building mass, outside air temperature, humidity, and
independent warmup and cooldown factors.
7. Select Manual mode when you don’t want your system to self-tune.
For more information about how optimum start is calculated in either automatic or manual mode, see the help topic
for the Edit Optimum Start Dialog Box.
Note When you use optimum start for the first time, it may be helpful to set up an alarm or trendlog to ensure
optimum start is starting when expected and functioning properly. For example, you can set up a trendlog to track
zone temperatures so that you can make adjustments if necessary.
About Zones
Zones are the areas of your building that you want to control. Zones are a key component of the optimum start,
tenant activity, and schedules features in Compass. For example, you can define offices in your building as zones
and then use optimum start to ensure that they reach a comfortable temperature before occupancy. Alternatively,
you can define the entire floor of a building as a zone and use the tenant activity feature to bill for after-hours usage.
The optimum start feature calculates heating and cooling advance times based on a zone’s configuration. The tenant
activity feature calculates tenant bills based on after-hours use.
At a minimum, you must define the host device, zone device reference, and occupied command reference for a
zone. We recommend that you also define a description to help identify the zone. To use the optimum start feature,
you must also identify properties to use when reading outside air temperature, zone temperature, target
heating/cooling setpoints, and warmup/cooldown command references. To use the tenant activity feature, you must
define zones and link them to the tenants that occupy them as well as identifying the tenant-override reference.
To create a zone
Before you can use the optimum start or tenant activity features in Compass, you must define zones. A zone is
identified by the host device and the device that controls and monitors operations in the zone. For information about
setting up devices, see Using the Device Manager.
1. On the Compass menu, click Zones.
2. In the Zones dialog box, click Add.
3. Select the host device for this zone. A host device can be a global controller (ACM or BCM) or an expandable
controller (VLX). Only devices capable of supporting Alerton zone objects or Alerton zone objects with external
points are displayed. If a device is not displayed and you think it should be, check the device’s capability settings in
the Device Manager.
52
Compass Workstation Interface User Guide PDF
4. In the Zone device reference field, select the field controller that commands this zone. For example, this might
be a VLC that controls heating and cooling for this zone.
5. Type a meaningful description for this zone. By default, the description of the zone device reference is used.
6. Select the property on the zone device that indicates when this zone is occupied or unoccupied. For example,
this is usually BV-40 in Alerton Standard applications.
7. If you want to use optimum start or tenant activity, click the Optimum Start References and Tenants tabs to
continue setting up your zone.
To edit a zone
Edit a zone to change the parameters that define the zone. For example, you can change the optimum start
references or link new tenants.
1. On the Compass menu, click Zones.
2. Sort the list by Host device, Show by status, or both. The letters in the status column indicate zones that need to
be edited because of improper or incomplete setup. See the Zones dialog box topic for a complete description of the
status codes.
3. Select the zone you want to modify, and then click Edit.
4. Make any changes, and then click OK to return to the Zones dialog box.
To add a schedule to a zone
Zones use schedules to determine when to begin and end operations in the zone. When you link schedules to a zone,
you select a standard schedule, a holiday schedule, and an event schedule. This combination of schedules is called a
schedule set. Certain features, such as optimum start, use these schedules to calculate when to begin warming or
cooling operations in the zone.
1. On the Compass menu, click Zones.
2. Select the zone you want to modify, and then click Schedule.
3. In the New Schedule Wizard, select the host device for the zone.
4. Select whether to make a new schedule, copy an existing schedule, or share an existing schedule. For more
information about schedules, see Understanding Standard, Holiday, and Event Schedules.
5. Click Next. Repeat step 4 each type of schedule (Standard, Holiday, and Event).
6. Click Finish. The Time Schedule Wizard appears and lists the zone as a controlled point.
Note: You can edit the schedule as necessary for the zone. However, if this schedule is shared by more
than one zone, changes made here will affect all linked zones.
7. Click OK.
53
Energy Management
To disable optimum start in a zone
For whatever reason, you may need to temporarily or permanently disable optimum start in a zone. For example, if
the zone is not heating or cooling as expected, you can disable optimum start while you troubleshoot the problem. If
you disable optimum start, only optimum start calculations are disabled; the linked schedule still controls heating
and cooling operations in the zone.
1. On the Compass menu, click Zones.
-OR-
Right-click a zone controlled point or referenced device, and then click Optimum Start (skip step 2).
2. In the Zones dialog box, select the zone for which you want to disable optimum start, and then click Optimum
Start.
3. Select None (disable optimum start).
4. Click OK to save the change and return to the Zones dialog box. Compass saves your settings for automatic or
manual mode and restores them when you enable optimum start again.
To link zones to a tenant
When you link zones to a tenant, you are actually linking zones to the tenant profile. You can view the tenants
linked to the zone from the Tenants tab of the Edit Zone dialog box.
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. Select the tenant from the list, and then click Edit.
3. In the Edit Tenant Profile dialog box, click the Zones tab.
4. Click Assign Zones.
5. Select the zones you want to link to this Tenant, and then click OK.
To copy a zone
If you’re setting up several zones, you may want to make copies of similar zones to save time. For example, if you
have a new zone that uses the same schedule and optimum start parameters as an existing zone, you can copy the
existing zone and edit the copy as necessary for the new zone. When you copy a zone, the zone device reference is
copied to the new zone or zones. Additionally, the schedule set that controls the zone is automatically updated to
reference each new zone you created.
1. On the Compass menu, click Zones.
2. In the Zones dialog box, select the zone you want to copy, and then click Copy.
3. In the Select Zone Devices dialog box, select the devices that control the new zones, and then click OK. Only
devices not already controlling a zone are shown.
54
Compass Workstation Interface User Guide PDF
To delete a zone
If you have zones that you do not use anymore, you can delete them from the Zones dialog box. For example, if you
combine two zones into one. When you delete a zone, the controlling schedule for the zone is updated to remove all
references to the deleted zone. Additionally, if tenant activity is configured in the zone, all zone links to tenant
profiles are deleted.
To delete a zone
1. On the Compass menu, click Zones.
2. In the Zones dialog box, select the zone or zones you want to delete, and then click Delete.
55
Tenant Activity
About Tenant Activity
Compass includes a tenant activity program that enables you to monitor after-hours override activity for tenants in
one or more zones through a tenant activity log. You can then bill the tenants for after-hours activity.
Before you begin using the tenant activity feature, you must define property manager profiles for the companies that
manage your facility, tenant profiles for the tenants you want to monitor and bill, areas (zones) in your facility that
tenants occupy, and then link zones to the tenants that occupy them.
The tenant activity feature includes the following components:
• Tenant profiles - describe the people, organization, group, or company that occupy a tenant zone. Use tenant
profiles to track tenant activity and bill tenants for after-hours activity.
• Zones - identifies the areas of a building that tenants occupy. Define zones to manage and monitor after-
hours activity.
• Activity logs - records all of the tenant activity within each defined tenant zone. Use this information to
monitor after hours activity in a zone, identify potential billing errors, or generate tenant bills.
• Property manager profiles - describe the company or organization that manages the facilities that tenants
occupy. Use to help manage or monitor tenant activity.
• Tenant billing - generates bills for tenants based on after-hours use of tenant zones.
All tenant activity information, including tenant profiles, property manager profiles, tenant zones, tenant bills, and
activity logs, is stored on the Compass primary workstation.
About Zones
Zones are the areas of your building that you want to control. Zones are a key component of the optimum start,
tenant activity, and schedules features in Compass. For example, you can define offices in your building as zones
and then use optimum start to ensure that they reach a comfortable temperature before occupancy. Alternatively,
you can define the entire floor of a building as a zone and use the tenant activity feature to bill for after-hours usage.
The optimum start feature calculates heating and cooling advance times based on a zone’s configuration. The tenant
activity feature calculates tenant bills based on after-hours use.
At a minimum, you must define the host device, zone device reference, and occupied command reference for a
zone. We recommend that you also define a description to help identify the zone. To use the optimum start feature,
you must also identify properties to use when reading outside air temperature, zone temperature, target
heating/cooling setpoints, and warmup/cooldown command references. To use the tenant activity feature, you must
define zones and link them to the tenants that occupy them as well as identifying the tenant-override reference.
To create a zone
Before you can use the optimum start or tenant activity features in Compass, you must define zones. A zone is
identified by the host device and the device that controls and monitors operations in the zone. For information about
setting up devices, see Using the Device Manager.
1. On the Compass menu, click Zones.
2. In the Zones dialog box, click Add.
57
Tenant Activity
3. Select the host device for this zone. A host device can be a global controller (ACM or BCM) or an expandable
controller (VLX). Only devices capable of supporting Alerton zone objects or Alerton zone objects with external
points are displayed. If a device is not displayed and you think it should be, check the device’s capability settings in
the Device Manager.
4. In the Zone device reference field, select the field controller that commands this zone. For example, this might
be a VLC that controls heating and cooling for this zone.
5. Type a meaningful description for this zone. By default, the description of the zone device reference is used.
6. Select the property on the zone device that indicates when this zone is occupied or unoccupied. For example,
this is usually BV-40 in Alerton Standard applications.
7. If you want to use optimum start or tenant activity, click the Optimum Start References and Tenants tabs to
continue setting up your zone.
To delete a zone
If you have zones that you do not use anymore, you can delete them from the Zones dialog box. For example, if you
combine two zones into one. When you delete a zone, the controlling schedule for the zone is updated to remove all
references to the deleted zone. Additionally, if tenant activity is configured in the zone, all zone links to tenant
profiles are deleted.
To delete a zone
1. On the Compass menu, click Zones.
2. In the Zones dialog box, select the zone or zones you want to delete, and then click Delete.
To create a tenant profile
Create a tenant profile for each group or organization you want to monitor and bill for after-hours use of tenant
zones. Use tenant profiles to define contact information, set up billing rates and notification, and link zones to
tenants.
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. In the Tenants dialog box, click Add.
3. On the Contact tab, complete the contact information for the tenant, including company name, description, and
address.
4. Select the property manager profile for the company or organization that manages the areas this tenant
occupies. Select <new> to create a new property manager profile.
5. On the Billing tab, define how you want to bill the tenant. For example, you can set the billing rate and select
how bills are sent. For more information about tenant billing information, see Edit Tenant Profile Dialog Box -
Billing Tab.
6. On the Zones tab, select the areas of the facility (zones) that this tenant will occupy and link them to this tenant.
You can also create new zones for this tenant if necessary. For more information about tenant zones, see Edit
Tenant Profile Dialog Box - Zones Tab.
58
Compass Workstation Interface User Guide PDF
To edit a tenant profile
At some point, you may need to edit a tenant profile. For example, link different zones to a tenant profile or change
contact or billing information.
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. Select the name of the tenant whose profile you want to modify, and then click Edit.
3. Click the Contact, Billing, and Zones tabs and edit information on each tab.
To copy a tenant profile
Instead of creating a new tenant profile, you can copy an existing tenant profile to save time. For example, if you
have more than one tenant at the same address, the contact and billing information would be very similar. You can
copy the existing tenant profile and make adjustments as necessary.
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. Select the name of the tenant whose profile you want to copy, and then click Copy. The new tenant profile is
added to the list with "Copy of" before the tenant name.
3. Select the new profile you created, and then click Edit.
4. Click the Contact, Billing, and Zones tabs and edit information on each tab.
To delete a tenant profile
In most cases, you won’t need to delete a tenant profile. For example, if a tenant vacates a particular zone, you can
edit the existing profile rather than deleting it and creating a new one. However, if a tenant vacates a building or
facility entirely, you can delete the tenant profile.
Important! Do not delete the tenant profile before the tenant has been billed. Once you delete the tenant
profile, you will not be able to generate bills for the tenant.
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. Select the tenant profiles you want to delete, and then click Delete.
3. When prompted to confirm, click Yes.
To generate a tenant bill
Use the Tenant Billing dialog box to generate a bill for a tenant. Before you can generate a tenant bill, you must
define the billing information in each tenant profile. The tenant profile also defines how the bill will be generated:
printed, saved to a file, or sent through email.
Note: Before you can send a tenant bill through email, you must complete the Tenant Activity Email Setup
and define the SMTP server on the Email Tab in General System Setup.
59
Tenant Activity
1. On the Compass menu, point to Tenant Activity, and then click Tenant Billing.
-OR-
Click Billing in the Tenant Activity Log.
2. Select the tenant for which you want to view billing events.
3. Select the first and last day for which you want to view billing events, and then click Recalculate. For
information about adjusting a tenant’s bill, see To adjust a tenant bill.
4. Click Bill Tenant. The bill is generated (printed, saved to a file, or sent as an email attachment) according to
the parameters defined in the tenant profile.
To adjust a tenant bill
You can adjust the seasonal multiplier and surcharge amounts for tenant bills in a couple of different ways. You can
make one-time adjustments or permanent adjustments. For example, you can make a one-time adjustment to apply a
special service charge. Use the Tenant Billing feature to make one-time adjustments and use a tenant’s profile to
make permanent adjustments.
To make a one-time adjustment
1. On the Compass menu, point to Tenant Activity, and then click Tenant Billing.
2. Select the tenant whose billing information you want to view.
3. Select the billing date or dates you want to view.
4. Type a new seasonal multiplier and or surcharge amount.
Note: The seasonal multiplier and surcharge options are only available here if they were enabled on the
Billing tab of the Edit Tenant Profile Dialog Box.
5. Click Recalculate to view the new subtotal, seasonal adjustment, surcharge, and total amounts.
6. Click Bill Tenant to generate a new bill for the selected tenant. The bill is generated using the rules defined
in the tenant’s profile. For more information, see the Edit Tenant Profile Dialog Box - Billing Tab.
To make a permanent adjustment
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. Select the tenant for whom you want to make a permanent bill adjustment, and then click Edit. The Edit
Tenant Profile dialog box appears.
3. On the Billing tab, make the necessary adjustments, and then click OK. For information about the options
available on this dialog box, see the Edit Tenant Profile Dialog Box - Billing Tab.
To edit the rate for a tenant zone
Rates are defined for each tenant in the tenant profile. However, you may need to edit the rate for a particular tenant
zone. For example, you may decide to bill at a discounted rate during construction or raise the tenant rate for a lease
renewal. You can edit the rate for a tenant zone while editing a tenant profile.
1. On the Compass menu, point to Tenant Activity, and then click Tenants.
2. In the Tenants dialog box, select the tenant occupying the zone you want to edit, and then click Edit.
60
Compass Workstation Interface User Guide PDF
3. On the Zones tab, select the zone that you want to edit, and then click Edit Rate.
4. On the Edit Rate for Tenant Zone dialog box, select Override Default, and then type the new rate (per hour) in
the Rate for this Zone field.
5. Click OK. The new rate is displayed in the Rate for this Zone column. To edit the rate for this tenant
permanently, see To edit a tenant profile.
To edit a tenant event
There may be instances when you need to edit after-hours events in tenant zones. For example, if you schedule
after-hours maintenance or repairs in the tenant zone, you can delete the event so the tenant is not billed for the
time. Use the tenant activity log to edit or remove after-hours override events.
1. On the Compass menu, point to Tenant Activity, and then click Tenant Activity Log.
2. Select the tenant whose events you want to view.
3. Select the zone where the event occurred.
4. Select the date or dates when the event occurred.
5. Click the event you want to edit, and then click Edit Event. For more information about the types of
information you can edit for an event, see the Edit Event Dialog Box.
-OR-
Click the event or events you want to delete and then click Purge. The selected events are removed permanently
and cannot be recovered.
Note: This affects all tenants to which this zone is linked.
To create a property manager profile
Property manager profiles are used to manage tenant profiles. Every tenant profile must have a property manager
linked to it. For more information about linking a property manager to a tenant profile, see Edit Tenant Profile
Dialog Box - Contact Tab.
1. On the Compass menu, point to Tenant Activity, and then click Property Managers. Click Add in the
Property Managers dialog box.
-OR-
From the Contact tab in the Edit Tenant Profile dialog box, select <new> in the Property manager field.
2. Type the property manager’s company name. This is the only required field.
3. Type the name of the contact person at the company.
4. Type the property manager’s address including, city, state, postal code, and country.
To edit a property manager profile
You can update the contact information or mailing address for a property manager from the Property Manager’s
dialog box.
61
Tenant Activity
1. On the Compass menu, point to Tenant Activity, and then click Property Managers.
2. In the Property Managers dialog box, select the profile you want to change, and then click Edit.
3. Modify the profile as necessary.
4. Click OK to save the changes to the profile and return to the Property Managers dialog box.
To delete a property manager profile
You cannot delete a property manager profile if it is linked to a tenant profile. You must first edit any linked tenant
profiles. Then delete the property manager profile as you would a user profile.
To view tenant activity
Use the Tenant Activity Log to monitor after-hours usage in a zone, identify potential billing errors, edit a tenant
event, or generate tenant bills.
On the Compass menu, point to Tenant Activity, and then click Tenant Activity Log.
-OR-
On the Compass menu, point to Tenant Activity, click Tenants, select the tenant whose events you want to view,
and then click Activity Log.
62
General System Setup
General System Setup - Identification Tab
Use the Identification tab (Tools > General System Setup) to set options for how the workstation identifies itself to
other devices on the BACnet network.
Device Type a BACnet device instance for this workstation. Each device instance throughout a
instance BACnet internetwork must be unique. A valid range is 0 to 4,193,302.
Type a BACnet device name, an identifier for the workstation. The device name must be
unique throughout the BACnet internetwork. This is the object-name property of the
Device name workstation’s device object. No other device can have the same device name. For
example, #3 workstation. This name appears in device lists and reports.
Type an identifier for the workstation’s function, location, or name. This is the
Device description property of the workstation’s device object. For example, 4th floor computer
description lab. This description appears in zone descriptions.
General System Setup - Network Tab
Use the Network tab (Tools > General System Setup) to control how this workstation communicates with the rest of
the Compass system.
Select Offline Mode if this workstation is used for off-site development (no
Offline Mode connection to any device on the network). This speeds operation and prevents the
workstation from searching for field devices.
This is the Ethernet adapter that this workstation uses to communicate on the BACnet
Network internetwork. Compass typically detects your Ethernet adapter and lists it. To use
Adapter another adapter, select one from the drop-down list.
Compass
BACtalk Choose either BACnet/Ethernet or BACnet/IP.
BACnet Settings
Enable Enables BACnet/Ethernet communication.
BACnet/Ethernet
Enable Enables BACnet/IP communications to be sent and received at this workstation. Click
BACnet/IP Settings to set up the IP connection. More about BACnet/IP.
Niagara The Niagara component of Compass facilitates the display of building control data in
BACtalk a standard Web browser using the HTTP protocol. It also communicates with devices
63
General System Setup
BACnet Settings using BACnet/IP. See Niagara BACtalk BACnet Settings.
Select Require client/server authentication to prevent access to the primary
workstation from client workstations that are running versions of Compass older than
Client/Server the version installed on the primary Compass workstation. In general, you would
Communications clear this check box during the upgrade process until all client workstations have
Protocol been updated to the same version as the primary workstation. Selecting this option
provides secure encrypted client/server communications.
Use Site Configuration to identify the workstation as a Compass server (primary
Site workstation) or as a client. For primary workstations, select a primary controller,
Configuration which is the default location for saving field data and setups. For client workstations,
select the BACnet device instance of the primary workstation (Compass server).
Use the Advanced setup to set network time-out values and retry limits for BACnet
protocol communications, for example, communications from a workstation to a
controller. These settings do not apply to IP communications.
• APDU Timeout - Type the milliseconds (1000 = 1 second) between
retransmission of BACnet messages. If you experience communication
errors or lost data that you attribute to network conditions (high volume
or slow connections, for example), try increasing this value (up to a
limit of 10000) along with the APDU Segment Timeout. Increasing this
value may adversely affect system response time. The default is 6000
milliseconds. This setting also controls the retransmission rate used in
the browser interface.
• APDU Segment Timeout - Type the milliseconds (1000 = 1 second)
between retransmission of BACnet message fragments. If you
experience communication errors or lost data that you attribute to
network conditions (traffic or slow network connections, for example),
try increasing this value (up to a limit of 10000) along with APDU
Timeout. Increasing this value may adversely affect system response
Advanced time. The default is 6000 milliseconds.
• APDU Retries - Type the maximum number of times a network
message is retransmitted if no response is received. Each retry occurs
only after the appropriate APDU timeout has elapsed. If you
experience communication errors or lost data that you attribute to
network conditions (high volume or slow connections, for example), try
increasing timeout values before increasing APDU retries (to a
maximum of 8). The default value is 3.
• Disable Read/Write Property Multiple - Select this check box if you
suspect communications difficulties in non-Alerton devices. For more
information, see About Disable Read/Write Property Multiple.
• Default encoding - The character encoding used when sending text to
BACnet devices. The default is ANSI X3.4. This is compatible with
previous versions of Compass and with WEBtalk. Use other encoding
types for foreign language interoperability with other products or third-
party devices.
• Fall back to ANSI X3.4 - Sends text data in the most compact
encoding available. If the text to be sent can be represented by an
encoding that is more compact than the default, Compass uses ANSI
X3.4 encoding. This saves space in devices and allows you to save
64
Compass Workstation Interface User Guide PDF
longer strings. ANSI X3.4 typically uses one byte of RAM per
character, while other encodings use up to 4 bytes per character.
• Treat X3.4 as UTF-8 - Converts Compass strings to UTF-8 encoding
before sending them to devices. This makes the strings readable on
any workstation or web browser that supports UTF-8. This option is
selected by default; do not clear it unless you have a specific reason.
Compass supports only the characters from the code page on the
primary workstation. You cannot mix characters from multiple code
pages on the same Compass installation. Multiple languages that
share the same code page are supported.
Typical English language (7-bit) systems are not affected by this
setting.
Important! When converting an ABS system that uses non-ASCII
characters to Compass, data must be re-sent to all devices to make
this setting effective.
Site Configuration Dialog Box
Use this dialog box to identify the workstation as a primary workstation or a client workstation. For primary
workstations, you select a primary controller, which is the default location for saving field data and setup
information. For client workstations, you select the BACnet device instance of the server.
This computer is the Compass server
Select this option to identify this workstation as the server (primary workstation). If this option is not selected, the
Server configuration group box and the Primary host device combo box are disabled.
This computer is a Compass Enterprise Server
This check box is enabled when an enterprise license is detected.
Database Configuration button
Opens the Enterprise Database Configuration dialog box.
Primary host device
Select the primary host device for this workstation.
This computer is a Compass Client
Select this option to identify this workstation as a client.
Server device instance
Enter the device instance of the server (primary workstation).
65
General System Setup
Database Configuration Dialog Box
Use this dialog box (Tools > General System Setup > Network tab > Site Configuration > Database
Configuration…) to configure the SQL Server connection when the local workstation is configured as an Enterprise
Server. If SQL and Compass are installed on the same computer, Compass will configure the database during
installation.
Enterprise/Conventional Compass detects the license type and selects the appropriate item.
If Compass and SQL are installed on different computers, type the name of the
SQL Server name SQL Server.
SQL Server database Type a database name and the path to the location of the database.
Use Windows Select if you want to use Windows authentication for SQL Server access. If
authentication selected, the Login and Password fields are disabled.
Use SQL Server Select if you want to use SQL Server authentication for SQL Server access.
authentication You must enter a Login and Password.
Use SSL encryption Select if you want to use SSL encryption for SQL Server access.
When SQL Server authentication is used, enter a login to use for SQL Server
Login access.
When SQL Server authentication is used, enter a password to use for SQL
Password Server access.
Use this button to test the SQL Server connection. If the database does not
Test connection exist, Compass creates in the location specified in the SQL Server database
field.
General System Setup - Time Sync Tab
It is import to ensure that all devices on the BACnet network have the correct time. Use the Time Sync tab (Tools >
General System Setup) to define the BACnet devices to receive date and time information from this Compass
workstation. The date and time originate from the workstation’s Windows setup.
Caution! Only one workstation (preferably the Compass primary workstation) should be set up to
broadcast the time. Inappropriate time sync settings are a common cause of trendlog and schedule
problems.
66
Compass Workstation Interface User Guide PDF
Click to add devices to your list of time sync recipients. You can specify devices by
Add button device instance or by network number and MAC address. You can also designate all
devices on the BACnet internetwork or all devices on a particular network.
Select a time sync recipient from the list and click Edit to replace it with another
Edit button recipient.
Select a time sync recipient and click Delete to remove it from the list. You can only
Delete button delete one recipient at a time.
Select how often you want to send time sync information to the devices in the list.
Available options are every 5 minutes, every hour, or every day. You can also send time
sync information immediately by clicking Send Now.
Send time
sync every
Note: Sending time sync information often and having a lot of devices on your
network increases network traffic.
For global or
network Select whether to use local or UTC time when synchronizing internal clocks in network
broadcast, devices.
use
Select this option to temporarily disable time sync information. This prevents the
Disable time workstation from sending the date and time to other devices on the network. Use this if
sync you want to set up another workstation to send time sync information.
General System Setup - Preferences Tab
Use workstation preferences (Tools > General System Setup) to set defaults for this workstation and the current job.
BACnet active - Type the text you want to appear on displays to indicate when a
binary object is active. By default, this text is set to "Active." For example, you
can set this to "ON" or "Running."
Default BACnet inactive - Type the text you want to appear on displays to indicate
active/inactive/NULL when a binary object is inactive. By default, this text is set to "Inactive." For
terminology example, you can set this to "OFF" or "Standby."
BACnet NULL - Type the text you want to appear on displays to indicate a
NULL value of a property.
Type the character you want to use to indicate an empty date character. Using the
Empty date character default (dash) as an example, an empty date field appears as - - / - - / - - - -.
67
General System Setup
Note: The empty date character is not used in the browser interface.
Type the character you want to use to indicate an empty time character. Using
the default (dash) as an example, an empty time field appears as - - : - - : - -.
Empty time character
Note: The empty time character is not used in the browser interface.
Require comment on Require users to enter a comment when they change the value of a property. A
every property prompt appears when the user presses Enter or clicks OK. IMPORTANT! When
change you change this setting, you must restart Compass.
Click Configure to define the display templates to use for the current rep/job.
These object and device templates are the ones used when you right-click on a
Display templates data point. The Alerton Standard displays are used by default. These templates
are located in the Display subfolder in the rep/job folder.
Select to enable Compass to detect devices that have been newly added to the
Compass system, notify local recipients of the new devices, and allow users at
Enable new devices workstations on the local job to add the devices to the Compass database. You
notification must set up new devices notification at each workstation. View a list of new
devices at any time from the Advanced menu in Device Manager.
Annunciate all alarms
(irrespective of the Select to annunciate all alarms sent to this workstation even if the user does not
current user's have privileges for some devices.
permissions)
When you save a schedule in the browser interface, this feature removes old
events to save disc space and decrease network traffic. Valid values are 1-999.
Selected by default and set to 7 days.
When saving
schedules, remove If a recurring event spans the cutoff date, none of the events in the series will be
events older than x removed.
days
Note: To see changes after you remove old events, refresh the page or
close and open the schedule.
General System Setup Startup/Shutdown Tab
Use this tab (Tools > General System Setup) to define how Compass behaves upon startup or shutdown.
Select this option to login the specified user whenever Compass is started on this
Login workstation. Type the user ID and password of the user you want to automatically log in.
68
Compass Workstation Interface User Guide PDF
Caution! Enable this feature only if the workstation is secure and only authorized
users are able to start Compass.
Start Type the number of the data display you want to automatically appear at start up. This is
display: also referred to as the top display. By default, the top display is set to 1.
Type the User ID and Password for the default user. Automatically logs the specified user
in to Compass when no other user is logged in. This allows data to be displayed when
nobody is logged in. Disabled by default.
Default
User
Caution! Choose the privileges for the Default User carefully. Anyone with
access to the Compass workstation will have the same privileges.
Select this option to automatically log a user out when no keyboard or mouse action is
Logout detected within a specified time frame. Type the number of minutes (when no action is
detected) before logging out the user.
Select this option to only allow certain users to shut down Compass on this workstation.
You define these users by selecting the Shut down Compass privilege on the User
Only
Privileges and Passwords dialog box. For more information about setting user privileges
authorized
and passwords, see Setting Up User Profiles.
users can
shut down
Compass Note If you clear this check box, any user (regardless of privileges) can shut down
Compass.
General System Setup - Email Setup Tab
Use this tab (Tools > General System Setup) to define SMTP server information. You must complete this
information before you can use the email billing option in Tenant Activity.
SMTP Server IP Type the IP address for your email server.
Address
SMTP Server Port Type the port number to use when sending email across the Internet.
Type the number of seconds to try and send an email message before quitting
Time Out in Seconds and prompting the user to try again. The default is 60 seconds.
SMTP Server If your email server requires authentication, enter the login and SSL information.
requires To test the email setup, enter an email address and click Test Connection.
authentication
69
General System Setup
User name Type a user name that the email server recognizes.
Password Type the password for the user name
SMTP Server
requires an encrypted Select if the email server requires an encrypted connection.
connection (SSL)
Test Connection Click to test email server authentication.
Type an email address. The system will generate a test email and send it to this
Test Email Address address.
General System Setup - SSL and LDAP Tab
SSL and LDAP tab
Secure Socket Layer (SSL) encrypts information sent over a network, reducing the risk of unauthorized access to
your control system and networks. It makes it more difficult to intercept user names, passwords, and system data.
Unless your system is behind a secure firewall, you will need a host certificate. If the host certificate is properly
signed you can trust the connection to the Web server. If the browser cannot verify the certificate, then you may not
be connected to the proper Web server and user names, passwords, and data may be at risk of being intercepted.
SSL
Before You Begin SSL implementation
If your system runs on a shared network, coordinate your SSL implementation with the network administrator.
Set up a Compass user profile with the User ID "admin".
Selecting an SSL option
You have these options for SSL implementation:
• disable SSL
• use the default self-signed SSL certificate
• use a custom self-signed SSL certificate
• use an enterprise SSL certificate supplied by your corporate information technology (IT) department
• use a commercial SSL certificate
Disable SSL
70
Compass Workstation Interface User Guide PDF
Use this option only if your system is behind a firewall on a closed and trusted network. Disabling SSL is
inexpensive, easy, and prevents browsers from displaying SSL-related warnings on client workstations. Susceptible
to data interception.
To disable SSL, click Tools>General System Setup>Configure SSL tab and clear the Enable TLS (SSL) check
box.
Default self-signed SSL certificate
Suitable for initial setup on a closed and trusted network only.
No out of pocket cost for commercial certificate. No time invested in creating a self-signed certificate.
When opening a Compass page, browsers will show a warning the certificate is not trusted. Additional steps may be
required to enable scripts and functionality of Compass. You will need to educate users about the security warnings
and how to add the default certificate to the trusted certificate list. Users will need to enter login credentials each
time they open a browser session. Certificate name will be listed as “tridium”.
If you use the default self-signed certificate, no additional setup is required.
Custom self-signed SSL certificate
This approach is suitable for a closed and trusted network only. Use it if you want to use a certificate named
different from the default (‘tridium’). It requires no out of pocket cost, but you must create a self-signed certificate.
When opening a Compass page, browsers will show a warning that the certificate is not trusted. Additional steps
may be required to enable scripts and functionality of Compass. You will need to educate users about the security
warnings and how to add the SSL certificate to the trusted certificate list. Users will need to enter login credentials
each time they open a browser session.
For instructions on how to implement this option, see Using a Custom Self-signed SSL Certificate.
Enterprise SSL certificate
Suitable for use when the Web server will be accessed from the internet or intranet by corporate workstations. Also
suitable for workstations that have the specific signer pubic root certificate installed in their certificate store(s).
Engage your corporate IT professionals to determine if this is an option and to manage certificates.
This approach provides a seamless experience for corporate users that already have the signer root certificate in
their certificate store. It may require distribution of signer root certificate to non-corporate workstations.
For instructions on how to implement this option, see Installing an Enterprise SSL Certificate.
Commercial SSL certificate
Select a certificate authority and familiarize yourself with their certificate issuing process. Choose one that delivers
certificates in .PEM format. Otherwise, you will need to convert them to .PEM.
Many certificate authorities require a specific email address at your domain ([email protected], for example).
Consider this requirement when selecting a CA.
71
General System Setup
You will need to purchase a certificate from a certification authority (CA). Most CA's web sites include useful
information about using SSL and the process of obtaining a certificate. Another good resource is openssl.org.
For instructions on how to implement this option, see Installing a Commercial SSL Certificate.
LDAP
When enabled, Compass will check user credentials against an LDAP server. Users must be specified as LDAP
users in Tools>Users and Groups>Edit.
Option Description
Enables you to specify users as LDAP users. If this is not selected, the
Enable LDAP
LDAP setting in user setup will have no effect.
Use TLS (SSL)
Encrypts communication between Compass and the LDAP server.
with LDAP
LDAP Domain Type the domain name of the LDAP server. Consult your IT department
Name for the name.
Using a custom self-signed SSL certificate
To use a custom self-signed certificate, create a new certificate and then specify the new certificate on the SSL tab
of General System Setup.
1. Create a new Compass user named ‘admin’ (Tools>Users and Groups>Add).
2. From the Tools menu, click General System Setup and then select the Configure SSL
tab.
72
Compass Workstation Interface User Guide PDF
3. Click Certificate Manager. The Authentication dialog box appears.
4. Enter the admin user credentials and then click OK. The Compass Certificate Manager appears.
73
General System Setup
5. Select the Key Store tab.
6. Click New. The Generate Self Signed Certificate dialog box appears.
74
Compass Workstation Interface User Guide PDF
7. Configure the certificate using these guidelines:
• Alias - A simple name for the certificate. You will type this name when you enable SSL.
• Common Name (CN) - A domain like "www.mydomain.com. This needs to be a valid
domain to help the certificate authority establish your identity.
• Organizational Unit (OU) - Optional.
• Organization (O) - Typically a company name. The name that appears on the certificate.
• Locality (L) - Important! This field is required.
• State/Province (ST) - Important! This field is required
• Country Code (C) - United States = US, Canada = CA. For additional country codes, see
Compass online Help.
• Not Before - Leave the default.
• Not After - Leave the default.
• Key Size - Leave the default (2048).
• Certificate Usage - Leave the default (Server Certificate).
• Email Address - Enter a valid email at the domain in the Common Name (CN) field. This
helps the certificate authority establish your identity.
8. Click OK. The new certificate appears in the Key Store.
9. On the Tools>General System Setup>Configure SSL tab, type the name of the certificate.
10. Restart Compass.
75
General System Setup
Installing an enterprise SSL certificate
To use an enterprise SSL certificate, create a self-signed certificate, get it signed by your corporate IT department,
and save it on your workstation.
1. Create a new Compass user named ‘admin’ (Tools>Users and Groups>Add). You will use this user profile to
manage certificates.
2. From the Tools menu, click General System Setup and then select the Configure SSL
tab.
3. Click Certificate Manager. The Authentication dialog box appears.
76
Compass Workstation Interface User Guide PDF
4. Enter the admin user credentials and then click OK. The Compass Certificate Manager appears.
5. Select the Key Store tab.
6. Click New. The Generate Self Signed Certificate dialog box appears.
77
General System Setup
7. Configure the certificate using these guidelines:
• Alias - A simple name for the certificate. You will type this name when you enable SSL.
• Common Name (CN) - A domain like "www.mydomain.com. This needs to be a valid domain to
help the certificate authority establish your identity.
• Organizational Unit (OU) - Optional.
• Organization (O) - Typically a company name. The name that appears on the certificate.
• Locality (L) - Important! This field is required.
• State/Province (ST) - Important! This field is required
• Country Code (C) - United States = US, Canada = CA. For additional country codes, see
Compass online Help.
• Not Before - Leave the default.
• Not After - Leave the default.
• Key Size - Leave the default (2048).
• Certificate Usage - Leave the default (Server Certificate).
• Email Address - Enter a valid email at the domain in the Common Name (CN) field. This helps
the certificate authority establish your identity.
8. Click OK. The new certificate appears in the Key Store.
Once you have created a self-signed certificate, your corporate IT department needs to sign it. This requires
a certificate request.
78
Compass Workstation Interface User Guide PDF
9. Select the self-signed certificate and then click Cert Request. The Certificate Request Info window appears.
10. Click OK. The Choose Export Directory dialog box appears.
11. Click My File System.
12. Select a directory where you want to save the request file and then click Save. The request is saved with a .csr
file extension.
13. Send the certificate signing request to corporate IT to sign. If you need to install the certificate on a non-
corporate workstation, then request the corporate public root certificate as well.
14. Wait for IT to send your domain certificate and any intermediate certificates required.
15. If the certificate(s) are not in .PEM format, convert them to .PEM. Free web-based conversion tools such as the
one at sslshopper are available.
16. If IT sent you a root certificate, then import it into the Trust Store.
17. Select the new certificate and then click Export. The Certificate Export dialog box appears.
79
General System Setup
18. Select Export the public certificate.
19. Select Export the private key.
20. Clear the Encrypt exported private key check box.
21. Click OK. The Certificate Export dialog box appears.
80
Compass Workstation Interface User Guide PDF
22. Click My File System.
23. Select a file location on the local workstation and type a file name. Accept the default file type (.PEM).
24. Click Save.
You will next create a certificate chain file, which combines a private key, private certificate, and any
intermediate certificates. The certificate chain is the “road map” for verifying an application’s authenticity.
25. Open the private key file in a text editor.
26. Copy and paste the text of the private certificate received from the CA after the key text.
27. Copy and paste the text of the intermediate certificates in reverse order. For example, if the CA sent you three
intermediate certificates, you would paste Intermediate Certificate 3 after the private certificate, then Intermediate
Certificate 2, and then Intermediate Certificate 1. The certificate chain would include five elements in this order:
• Private key extracted in Compass Certificate Manager
• Private certificate sent by CA
• Intermediate certificate 3
• Intermediate certificate 2
• Intermediate certificate 1
81
General System Setup
28. Save the certificate chain with a .PEM extension. Note the path and file name.
29. Open the Compass Certificate Manager (Tools > General System Setup > Configure SSL > Certificate
Manager).
82
Compass Workstation Interface User Guide PDF
30. On the Key Store tab, click Import. The Certificate Import dialog box appears.
31. Click My File System and browse to the location of the certificate chain.
83
General System Setup
32. Select the certificate chain and then click Open. The Certificate Import dialog box appears.
33. Click OK. The certificate appears in the Key Store.
34. Note the Alias name and then close the Compass Certificate Manager.
35. On the General System Setup Configure SSL tab, select Enable HTTPS and type the Alias name of the
certificate chain.
36. Type the fully qualified domain name associated with the certificate.
84
Compass Workstation Interface User Guide PDF
37. Click OK.
38. Restart Compass.
Installing a commercial SSL certificate
To use a commercial SSL certificate, create a self-signed certificate, get it signed by a certificate authority, and save
it on your workstation.
1. Create a new Compass user named ‘admin’ (Tools>Users and Groups>Add). You will use this user profile to
manage certificates.
2. From the Tools menu, click General System Setup and then select the Configure SSL
tab.
85
General System Setup
3. Click Certificate Manager. The Authentication dialog box appears.
4. Enter the admin user credentials and then click OK. The Compass Certificate Manager appears.
86
Compass Workstation Interface User Guide PDF
5. Select the Key Store tab.
6. Click New. The Generate Self Signed Certificate dialog box appears.
87
General System Setup
7. Configure the certificate using these guidelines:
• Alias - A simple name for the certificate. You will type this name when you enable SSL.
• Common Name (CN) - A domain like "www.mydomain.com. This needs to be a valid domain to
help the certificate authority establish your identity.
• Organizational Unit (OU) - Optional.
• Organization (O) - Typically a company name. The name that appears on the certificate.
• Locality (L) - Important! This field is required.
• State/Province (ST) - Important! This field is required
• Country Code (C) - United States = US, Canada = CA. For additional country codes, see Compass
online Help.
• Not Before - Leave the default.
• Not After - Leave the default.
• Key Size - Leave the default (2048).
• Certificate Usage - Leave the default (Server Certificate).
• Email Address - Enter a valid email at the domain in the Common Name (CN) field. This helps the
certificate authority establish your identity.
8. Click OK. The new certificate appears in the Key Store.
9. Select the self-signed certificate and then click Cert Request. The Certificate Request Info window appears.
88
Compass Workstation Interface User Guide PDF
10. Click OK. The Choose Export Directory dialog box appears.
89
General System Setup
11. Click My File System.
12. Select a directory where you want to save the request file and then click Save. The request is saved with a .csr
file extension.
13. Complete a certificate signing request according to the certificate authority's process. Note the fully qualified
domain name that you submit; you will need it later in the process.
14. Wait for the certificate authority to send your domain certificate and any intermediate certificates required.
They may also send a root certificate.
15. Once you receive your certificate(s), you may need to convert them to a format recognized by Compass. Free
web-based conversion tools such as the one at sslshopper are available.
16. Once you have the signed certificate, open Compass Certificate Manager (Tools>General System
Setup>Configure SSL>Certificate Manager).
17. If the certification authority sent you a root certificate, import it into the Trust Store.
18. Select the self-signed certificate you created earlier and then click Export. The Certificate Export dialog box
appears.
90
Compass Workstation Interface User Guide PDF
19. Select Export the public certificate.
20. Select Export the private key.
21. Clear the Encrypt exported private key check box.
22. Click OK. The Certificate Export dialog box appears.
91
General System Setup
23. Click My File System.
24. Select a file location on the local workstation and type a file name. Accept the default file type (.PEM).
25. Click Save.
You will next create a certificate chain file, which combines a private key, private certificate, and any intermediate
certificates. The certificate chain is the “road map” for verifying an application’s authenticity.
26. Open the private key file in a text editor.
27. Copy and paste the text of the private certificate received from the CA after the key text.
28. Copy and paste the text of the intermediate certificates in reverse order. For example, if the CA sent you three
intermediate certificates, you would paste Intermediate Certificate 3 after the private certificate, then Intermediate
Certificate 2, and then Intermediate Certificate 1. The certificate chain would include five elements in this order:
• Private key extracted in Compass Certificate Manager
• Private certificate sent by CA
• Intermediate certificate 3
• Intermediate certificate 2
• Intermediate certificate 1
92
Compass Workstation Interface User Guide PDF
29. Save the certificate chain with a .PEM extension. Note the path and file name.
30. Open the Compass Certificate Manager (Tools > General System Setup > Configure SSL > Certificate
Manager).
93
General System Setup
31. On the Key Store tab, click Import. The Certificate Import dialog box appears.
32. Click My File System and browse to the location of the certificate chain.
94
Compass Workstation Interface User Guide PDF
33. Select the certificate chain and then click Open. The Certificate Import dialog box appears.
34. Click OK. The certificate appears in the Key Store.
35. Note the Alias name and then close the Compass Certificate Manager.
36. On the General System Setup Configure SSL tab, select Enable HTTPS and type the Alias name precisely as it
appears in the Key Store.
37. Type the fully qualified domain name that you submitted to the certificate authority.
95
General System Setup
38. Click OK.
39. Restart Compass.
96
Job Setup & Engineering
Operator Workstation Setup
Setting Network Communications and Time-out Values
Time-out values are important to BACnet data communications. BACnet uses these values to determine how long
after transmission of an APDU or APDU segment until the lack of a reply means it was assumed to be lost and how
many times to re-send a message after it is assumed to be lost. Adjusting these values affects system performance
for BACnet messages. For example, values that are too low can cause long gaps in trendlog data and intermittent
communication with BACnet devices. As a general rule, you want to use the lowest time-out values you can while
maintaining data integrity.
Note If only IP messages are used, these settings do not apply.
If your network has a large number of devices, experiences heavy use (many points are logged, many alarms are
transmitted, for example), or is widely dispersed, increasing APDU Timeout and APDU Segment Timeout values
may improve data integrity. However, this may also adversely affect system response time, resulting in long waits
for data. Adverse effects are particularly acute if a device is offline, in which case the requesting device attempts to
establish communications until retries are exhausted. For example, a retry limit of 5 coupled with a time-out of
10000 (milliseconds) results in a 50-second wait until the status of an offline device is reported as no response
(NR).
During system setup, when communications may be intermittent or unreliable, lower time-out values may be
appropriate.
If increasing time-out values (up to a limit of 10000 milliseconds) is ineffective, try increasing APDU Retries (up to
a limit of 8). If these measures are still ineffective, a physical or other problem with the network may exist (wiring
fault, noise, for example.).
Set time-out values for your controllers and any other workstations to the same values used here.
Setting Time Sync Recipients
Use the Time Sync feature to ensure devices use the same time. The List of Time Sync Recipients (Tools > General
System Setup > Time Sync) shows the BACnet devices that receive date and time information from this
workstation. The date and time originate from the computer's Windows setup.
Caution! Set up only one BACnet device (preferably the Compass primary workstation) to broadcast the
time. Inappropriate time sync settings are a common cause of trendlog and schedule problems.
The workstation can broadcast the date and time to:
1. All internetworked BACnet devices (Global broadcast)
2. All devices on a particular network (Broadcast on net xx)
3. Individual devices, each identified by device instance (Device xxxx), recommended
4. Individual devices, each identified by network number and Ethernet MAC address (Net x, MAC x)
97
Job Setup & Engineering
About Disable Read/Write Property Multiple
This is a BACnet service that allows devices to read and write data in groups. This group data transfer is more
efficient than multiple, singular data transfers. Selecting the Disable Read/Write Property Multiple check box (in
the General System Setup dialog box) prevents your workstation from implementing the Read/Write Property
Multiple service and hurts system performance.
In nearly all cases, you want to clear the Disable Read/Write Property Multiple check box (default). However, it is
possible that some devices on your BACnet system don’t support the Read/Write Property Multiple service (VLCs
with EEPROM 1.02 or earlier, for example). Usually, values from these devices appear with a *no datum* message
on data displays. If this error message appears, try selecting the Disable Read/Write Property Multiple check box.
Setting Startup/Shutdown Preferences
Compass offers several startup and shutdown features, which you can set for a workstation (Tools > General
System Setup > Startup/Shutdown).
First, you can identify which users you want to allow to shutdown Compass on a primary workstation. This
prevents accidental shutdown of Compass.
Important! If you close Compass on the primary workstation, client workstations cannot function and
automation features are not available.
You can also define a user ID and password to use automatically at start up. You should only set up this feature if
the primary workstation is in a secure location and can only be accessed by authorized users.
Additionally, for security purposes, you can set up an automatic logout if the system does not detect any mouse or
keyboard action within a specified period.
Note: After you restrict shutdown here, go to Users and Groups and select or clear the Exit Compass
option for each user profile as appropriate. If you clear this option, setting the privilege in the user profile
will have no effect.
Alerton Standard Applications
Using the Application Database
You can use the application database feature of Compass (Tools > Application Lookup) to search for Alerton
Standard applications: VisualLogic DDC, display support files, and documentation. You can then copy these files to
a job folder for modification or use.
If you start the application database from within Device Manager (Compass > Device Manager > Add|Edit
>Preferences > App Database), you can copy the application to Device Manager and assign the application files to
devices.
Compass can filter out records and show only those that match your specifications. Click Advanced to show more
specific matching criteria, such as assignment of particular I/Os. For example, you can search for all application
materials designed for VAV boxes with two stages of heat.
98
Compass Workstation Interface User Guide PDF
Copying Application Files
The copy application (Tools > Application Lookup) feature provides an easy way for you to copy all the files for an
Alerton Standard application, or your own application, to the job folder you are currently working in. Each
application has several file components, whose file names are listed on the left side of the dialog box.
Not all applications use all components, and some text boxes may be blank, which is normal. If a file appears under
File Name, but has been moved or deleted from the Source Rep/Job location, the File Size shows 0. The file size in
bytes of each component appears under File Size, along with a sum total (Total Size) of all files selected for
copying.
For step-by-step instructions, see To copy Alerton Standard application files to the active rep/job.
Searching for Alerton Standard applications
You can use the application lookup feature to find only those applications that match your specific needs. For
example, you can search for all application materials designed for VAV boxes with two stages of heat.
1. On the Tools menu, click Application Lookup.
2. For each search criterion you want to use, select an item from the list. For criteria you do not want to use, select
(--Any--).
3. Click Search. The first application record that matches your criteria appears.
4. Use the record controls at the bottom of the dialog box to browse through matching applications.
5. Click Copy Application to copy application files to the active rep/job.
To browse Alerton/Standard applications
If you are not sure what type of application you need or you just want to view all available applications, you can
browse through all applications in the Application Lookup dialog box.
1. On the Tools menu, click Application Lookup.
2. In the Application Lookup dialog box, make sure all criteria are cleared (--Any--), and then click Search. The
first application record appears.
3. Use the record controls at the bottom of the dialog box to browse through applications.
To assign an Alerton Standard application to a controller
Alerton Standard applications allow you to assign DDC to a controller and copy all application related data to the
current rep/job from the Alerton Standard repository. You can also modify the standard applications to meet your
specific needs. For more information, see your Compass Programmer’s Guide and Reference.
1. On the Compass menu, click Device Manager.
2. In the Device Manager dialog box, click the device profile you want to work with, and then click Edit.
3. On the Preferences tab, click App Database.
99
Job Setup & Engineering
4. Select the criteria you want to search for, and then click Search. For example, you can search for applications
for a particular unit type, such as a main air handler or fan coil.
The first application that meets your search criteria is displayed. If there is more than one, use the arrows under
Goto Record to browse through the applications.
5. When the application you want to use is displayed, click Copy Application.
6. In the Copy Application dialog box, note the application file name and destination path, and then click Save.
All application materials are copied to the active rep/job folder.
7. Click OK, click Cancel, click Close, and then click Cancel to return to the Add/Edit Device Profile dialog
box.
8. Click Browse, and then select the rep/job to which you just copied the application.
9. Select the DDC file from the list, and then click Select.
10. Click OK to return to Device Manager.
To copy Alerton Standard application files to the active rep/job
You can copy Alerton standard applications from one job to another. This can be useful when setting up similar
sites.
1. Find the application you want to copy (how?). Make sure the Available check box is selected, and then click
Copy Application. Files related to the application are listed, along with the file size and a destination path.
2. Select all check boxes to copy available application components, and then click Save. Files are copied to the
appropriate subdirectories of the destination path, which is the data location for the current rep/job.
Controller Setup (Device Manager)
Using Device Manager
Device Manager (Compass > Device Manager) is the brain of the Compass system and a powerful tool for the
developer. Use Device Manager to define all controllers and workstations in your BACtalk system. Device Manager
records (device profiles) help identify the location and function of all of the devices on the internetwork.
Understanding how to use it helps you manage devices in your facility and expedites the setup and checkout of new
equipment.
Important! Many Compass features reference Device Manager records for lists of device selections. This
includes license validation. If a device profile does not exist, a *no entry* message appears on data
displays. Keep your Device Manager list up-to-date with your site’s BACnet devices. Make sure that a
device profile for the Compass primary workstation appears in its own Device Manager table.
Use Device Manager to:
• Scan to see information about the devices on your BACtalk system
• Change device descriptions
• Periodically save point data to the Compass primary workstation
• Restore data in a host device (send data to device)
100
Compass Workstation Interface User Guide PDF
• Synchronize clocks in all devices
• Scan the internetwork to see if a device is online
• Auto download basic ROC file capabilities to connected controllers
• Enable MS/TP proxy
• Back up and restore devices
• Restart and control devices
• Reassign device instances in a range of VLCs
• Print a list of device profiles
• Configure (populate) a Device Manager database
• Set device instances
• Copy device profiles
• Assign Alerton Standard applications to devices
Using Device Scanner
Device scanner is a component of Device Manager. Use Device Scanner (Compass > Device Manager > Device
Scan) to automatically locate BACnet devices on the BACnet internetwork. After you locate devices with a scan,
you can select them and add records to the Device Manager. This is a good way to update the Device Manager
when you add controllers to a system or change addressing or network configurations.
You can refine the search to include only Alerton configurable devices, only non-configured Alerton devices, and
devices within a range of device numbers.
Make sure your workstation is connected to the BACnet internetwork over Ethernet or a PTP connection before
performing a device scan. Device Manager may scan the internetwork several times to search for devices. In fact,
Device Manager continues to scan for devices as long as at least one device was found in the previous scan.
Caution! Depending on the size of your network, the amount of network traffic, and your connection, a
scan may take anywhere from three minutes to an hour or more. You can click the Stop button at any time
to interrupt a scan.
For each device found, Device Scanner displays the following:
• Device = BACnet Device Instance.
• Net = BACnet network number that the device is on. This field is blank if the device is on the local network.
• MAC Address = hexadecimal MAC address.
• Model = The model-name property of the device object. The vendor assigns the model name.
• Description = The description property of the device object.
• <WAITING> indicates that Compass is awaiting a response, which may still be forthcoming. <NO
RESPONSE> indicates a communications issue; the device was unable to respond. <STOPPED> indicates
device scanning was stopped before the scan was completed.
When the scan is complete, you can select one or more of the devices found and save them to the Device Manager
table.
Caution! With the exception of a device’s capabilities, if a device profile already exists in the Device
Manager table, it is overwritten.
101
Job Setup & Engineering
Scan BACnet Select this option to locate all BACnet devices on the BACnet internetwork.
devices
Scan
configurable Select this option to locate all Alerton configurable devices on the BACnet
Alerton internetwork. Alerton configurable devices include the ACM, BCMs, VLX, and VLCA.
devices
Show non- Select this check box to narrow your search to Alerton devices that have a device
configured instance of 200 (factory default) or devices that do not have application software (ROC)
items only loaded.
Select Device Range and then type a range of Device Instances in the From and To
Device range boxes.
Select device(s) from the list and then click this button to copy their records to Device
Save To Table Manager. If no devices are selected, all devices will be saved.
Click this button to open the Edit Device Configuration dialog box and enter or change
the settings for the selected device. The button is disabled until you select an Alerton
Configure configurable device. If the selected device is part of a device array, the Select Device
dialog box appears listing the available devices. Select the device you want to
configure, and then click Select.
Send To Click this button to open the Send Device Configuration wizard. This button is disabled
Device until you select an Alerton configurable device.
The View Array feature is used by BCMs and the ACM to identify a specific
View Array device/controller on the array or in the ACM.
Renumbering VLCs
Use the Renumber VLCs feature (Compass > Device Manager > Advanced > Renumber VLCs) to quickly set up
device instances for a group of VLCs. This is useful when setting up very large sites. The Results Preview pane
shows you the results of the changes you make before you save them. This can help you identify potential conflicts.
WARNING! Renumbering devices without sufficient knowledge can have adverse effects on your system.
If DDC or other software components (such as dynamic display items) reference data in a VLC, and you
subsequently renumber the VLC, DDC and display items must be manually updated to reflect the new
device instance.
You have two options for specifying how to renumber VLCs. Click a link below to find out more about each option.
Renumber based on device manager records - Edit Device Manager records and then send them to devices.
102
Compass Workstation Interface User Guide PDF
Renumber based on VLC Network Number and MAC Address - Create device instances based on the network
number and MAC address combination of VLCs.
To manually add a device profile to Device Manager
If you add a new controller to your BACtalk network, you can use Device Manager to create a device profile to
identify the controller’s location and function on the system. You can also scan the network to look for a device and
add it or update it in the Device Manager table. For more information about scanning for devices, see To scan the
BACnet network for devices.
1. On the Compass menu, click Device Manager.
2. In the Device Manager dialog box, click Add.
3. In the Add/Edit Device Profile dialog box, type a device instance, select a unit type, and provide other
information about the device, if necessary. For more information about specific device parameters, see the
following help topics:
Add/Edit Device Profile - Identification Tab
Add/Edit Device Profile - Capabilities Tab
Add/Edit Device Profile - Preferences Tab
4. Click OK. The Device Manager dialog box is updated with the new device in the list of devices.
5. If the device you created is online, you can send the parameters you just set to the device. Select the record, and
then click Send.
6. In the Send Data from Disk to Devices dialog box, select Device Properties, and then click Send. For more
information about sending or saving data to a BACtalk controller, see To send or save data to BACtalk controllers.
To scan the BACnet network for devices
Scanning for devices is the preferred method of verifying the devices on the network. When you scan for devices,
Device Manager confirms that the device is online and populates some device profile information automatically.
Use a device scan to find new devices on the network or update Device Manager when a device’s address was
changed.
1. On the Compass menu, click Device Manager.
2. Click Device Scan.
3. If desired, select Device Range, and then type a range of device instances to scan. For example, you can scan
for a controller in the range of 2000 to 2999. If you clear this option, the device scanner scans for all devices.
4. Click Scan. Device scanner searches the network for BACnet-compliant devices, making several passes. This
may take some time. Devices found appear immediately in the list of devices. You can interrupt this process at any
time by clicking Stop.
5. To add records to Device Manager for all devices found, click Save to Device Manager Table.
-or-
To add only records you select, select a single device, use SHIFT+click to select a range of devices, or use CTRL +
click to add a device to a selection. Then click Save to Device Manager Table.
103
Job Setup & Engineering
Note: The device property for previous records in Device Manager is overwritten when new records are
added. If device properties were previously sent to the controller, use the Save to Disk feature to recover
the information (how?).
To send or save data to BACtalk controllers
When you send to or save from a device, Compass looks in the current rep/job folder on the Compass primary
workstation’s hard disk for a folder that’s associated with the device. This folder stores information about the
device: device profile information, schedules, alarms, trendlogs, zone objects, and so on.
To send or save data to a BACtalk controller
1. On the Compass menu, click Device Manager.
2. In the list of devices, select the device profile or profiles you want to send or save.
3. Click Send or Save as appropriate. Send takes data from the Compass primary workstation hard disk and sends
it to the controller. Save retrieves files from the controller and saves them to the primary workstation hard disk.
4. Select the check boxes for the items you want to send or save.
5. Click Save, and then click OK.
To renumber VLCs based on MAC address and network number
Rather than establishing device instances for VLCs one-by-one, you can create several VLCs at once, save them in
Device Manager, and then renumber them based on MAC address or network number. This is useful when you want
all VLCs on a particular network to have sequential device instances. You can also select VLCs in Device Manager
and then renumber them sequentially.
1. On the Compass menu, click Device Manager.
2. On the Advanced menu, click Renumber VLCs.
3. In the Renumber VLCs dialog box, select Renumber the device instances of field VLCs using information I
provide.
4. Under Identify VLCs to Renumber, provide the network number of the MS/TP LAN where the devices are
located, the total number of VLCs you want to renumber, the MAC address of the first VLC in the sequence, and an
incremental counter added to the original MAC address for each successive VLC.
5. Under Set New Device Instances, type the device instance you want applied to the first Net/MAC combination
and the increment by which that device instance increases for each successive device you want to renumber.
6. Click Update Preview to see the effect your changes have. Look for any warnings in the Status column of the
Results Preview. This column can also indicate Net/MAC conflicts. A conflict occurs when two or more device
profiles use the same Net/MAC address combination.
7. Select Apply to Device Manager Records Only to update device profiles on the disk only. Clear this option to
update the device profiles on the disk and in the devices.
104
Compass Workstation Interface User Guide PDF
To select VLCs in Device Manager and then renumber them
If you have device profiles already created in Device Manager but want to renumber their device instances, you can
do this using the Renumber VLCs dialog box. This may be useful when you have the same type of VLCs on
different networks and want to number them sequentially.
1. From the Compass menu, click Device Manager.
2. Add a device profile for each unitary controller (VLC) whose device instance you want to set.
3. Click each record to select it. Use SHIFT + click to select a range of records and CTRL + click to add and
remove selected records.
4. On the Advanced menu, click Renumber VLCs.
5. Select Renumber the device instances of field VLCs based on device manager records, and then choose the
VLCs you selected in the Device Manager dialog box. The Results Preview pane shows the device instances that
will be assigned.
Important! Only devices with the Supports Device Instance Renumbering capability are shown. If you
selected any other devices, they will not be renumbered. You can change a device’s capabilities from
Device Manager (Compass > Device Manager > Edit).
6. Click Apply.
To copy a device profile
Device Manager's copy feature (Compass > Device Manager > Copy) enables you to create a device profile and
then copy it to create or update other, similar device profiles. This can be helpful if you are setting up a large
number of similar controllers.
1. From the Compass menu, click Device Manager.
2. In the Device Manager dialog box, select the device you want to copy, and then click Copy.
3. In the To devices: and thru: fields, type the Device Instances you want to create with the copy command. For
example, type 715 in the To devices field and 745 in the thru field to create devices numbered within the 715-745
range.
4. In the Spacing field, type a number to indicate how to increment the new device instance numbers. For
example, using the 715-745 range, type 10 to create records for devices 715, 725, 735, and 745.
5. Under Fields to Copy, select check boxes for the items in the record you want copied to the new records.
6. Click Copy.
To assign an Alerton Standard application to a controller
Alerton Standard applications allow you to assign DDC to a controller and copy all application related data to the
current rep/job from the Alerton Standard repository. You can also modify the standard applications to meet your
specific needs. For more information, see your Compass Programmer’s Guide and Reference.
105
Job Setup & Engineering
1. On the Compass menu, click Device Manager.
2. In the Device Manager dialog box, click the device profile you want to work with, and then click Edit.
3. On the Preferences tab, click App Database.
4. Select the criteria you want to search for, and then click Search. For example, you can search for applications
for a particular unit type, such as a main air handler or fan coil.
The first application that meets your search criteria is displayed. If there is more than one, use the arrows under
Goto Record to browse through the applications.
5. When the application you want to use is displayed, click Copy Application.
6. In the Copy Application dialog box, note the application file name and destination path, and then click Save.
All application materials are copied to the active rep/job folder.
7. Click OK, click Cancel, click Close, and then click Cancel to return to the Add/Edit Device Profile dialog
box.
8. Click Browse, and then select the rep/job to which you just copied the application.
9. Select the DDC file from the list, and then click Select.
10. Click OK to return to Device Manager.
To restart a device
Use this option to restart a device but retain all data and programming. For example, you may have to restart a
device if it stops responding.
Note: This feature is only available to users with the Restart and control devices user privilege in their user
profile.
Caution! This feature can have a dramatic impart on connected equipment. Use with caution.
1. On the Compass menu, click Device Manager.
2. Select the device(s) you want to restart. Use Shift + click or Ctrl + click to select more than one device.
3. On the Advanced menu, click Restart/Control Devices.
4. Select Restart device(s) - (cold start).
5. Type the password for the device(s). The default password for all Alerton controllers is ALERcomm (case-
sensitive).
6. If necessary, select the character set used by the device(s).
106
Compass Workstation Interface User Guide PDF
To control a device
Use the Restart/Control Devices dialog box to troubleshoot a problem with devices on the BACnet internetwork
from your workstation.
Note: This feature is only available to users with the Restart and control devices user privilege in their user
profile.
1. On the Compass menu, click Device Manager.
2. Select the device(s) you want to control. Use Shift + click or Ctrl + click to select more than one device.
3. On the Advanced menu, click Restart/Control Devices.
4. Select how you want to control this device. For example, do you want to enable or disable communications.
5. Type the password for the device(s). The default password for all Alerton controllers is ALERcomm (case-
sensitive).
6. If necessary, select the character set used by the device(s).
To restore a device
Use the Compass device restore feature to replace the existing device files with the files in the backup.dat file
located in the device subfolder. See the Back Up Devices Dialog Box for more information.
Note: The Restore BACnet device privilege must be selected in your user profile to restore devices.
Caution! This feature can have a dramatic impart on connected equipment. Use with caution.
1. On the Compass menu, click Device Manager.
2. Select the device(s) you want to restore. Use Shift + click or Ctrl + click to select more than one device.
3. On the Advanced menu, click Restore Devices.
To back up a device
Use the Compass device backup feature to save all of a device’s data to a backup file on the Compass primary
workstation. The backup file is located in a "backup" folder in the device subfolder for the current rep/job and
named Device <n> backup.dat. You can then restore the files using the restore feature. See Restore Devices Dialog
Box for more information.
Note: The Backup BACnet device privilege must be selected in your user profile to back up devices.
1. On the Compass menu, click Device Manager.
2. Select the device(s) you want to back up. Use Shift + click or Ctrl + click to select more than one device.
3. On the Advanced menu, click Back Up Devices.
107
Job Setup & Engineering
File Management (rep/job setup)
Understanding How Compass Manages Graphics and System Files
Compass creates a root directory when you run the installation program. This directory contains a rep folder. Under
the rep folder is a job folder or multiple job folders and an Alerton Standard folder. Alerton Standard displays and
templates cannot be altered and saved to the Alerton Standard folder. However, you can modify standard displays
and templates and save them to another location.
In each job folder there are three subfolders:
1. Displays - which stores all the data display and template files unique to the job or application
2. Bitmaps - which stores all the graphics used as background and dynamic items on the displays and templates.
This folder may include these file types:
Pre-Compass versions that will automatically be during editing or batch
.DSP/.OBT/.DVT conversion.
The Compass versions of older graphics. If a *X version of a file exists, the
.DSPX/.OBTX/.DVTX non-X version can be deleted.
px files Used in the Web user interface. These should not be modified directly.
3. DDC - which stores all the DDC files for the job
Other files stored directly in the job folder are the device configuration file, which stores addressing and setup
information for devices, and the user security file, which controls log in. By default, the job folder is the same as the
job title you enter when you create a new job.
This file arrangement scheme enables you to use a different set of displays, templates, graphics, DDC, device
configuration, and user security files (each stored in their corresponding job folder) for a number of jobs or
applications. You can create a maximum of one hundred million each (0-99999999) of displays, device templates,
and object templates for each job. Display 1 (0000001.dsp) for a particular job is stored in that job's Displays
subfolder.
About Site Keys
A site key enables users with sufficient security to edit and then overwrite DDC and displays in a job folder. If a site
key is not created for a job, that job cannot be set as the default job. Note that a user's permissions (set in User
Setup) still control their ability to edit displays and templates.
To create a site key
1. Open the Set Rep and Job dialog box (Tools > Set Rep and Job).
2. Click Options>>.
3. Click Make Key.
108
Compass Workstation Interface User Guide PDF
Users logged in as an Alerton rep can overwrite display and DDC files with or without a site key. Typically, jobs
without keys are created to store representative standard displays and DDC - files that a developer does not want
users to change.
Caution! You cannot make a keyless job the default job in the set Rep and Job dialog box. Do not close
Compass with a keyless job in the Job Name box.
Creating a Job Directory and Setting a Job Name
Use the Set Rep and Job dialog box (Tools > Set Rep and Job) to set the default representative and job name for this
workstation. These settings control where Compass looks for system and graphics files—such as system security,
device configuration, DDC, graphic, display, and template files. This feature enables Compass to securely organize
files for any number of sites or applications.
The rep/job folder of the Compass root directory is always identical to the entry here. For instance, if the Rep Name
is listed as AcmeSys and the Job Name as StateU, files for this job are in C:\<Compass Root>\ AcmeSys\StateU.
Limit entries to eight alphanumeric characters.
Caution! When you close Compass, make sure that the job listed in this dialog box has a site key.
Otherwise, Compass prompts you to specify a keyed job each time you start the program.
To create a new Compass job directory
You can create a job directory and set it up as the default job.
1. On the Tools menu, click Set Rep and Job.
2. In the Rep Name box, make sure the correct Alerton-assigned rep name appears (the one you logged in with as
your user ID). Limit your entry to eight alphanumeric characters (no spaces) unless you are working with a
controller that accepts longer names.
3. In the Job Name box, type the name of the job you want to create. Limit your entry to eight alphanumeric
characters (no spaces) unless you are working with a controller that accepts longer names.
4. Click Options.
Caution! Use the Default Location option. Choosing Custom Location may have unpredictable results. For
client workstations, choose a rep/job that precisely matches the rep/job on the Compass primary
workstation. For more information, see the Installation and Startup Guide.
5. Click Create Dir. This creates the directory for the job.
6. Click Make Key, and then click Yes to confirm (more information).
7. If you want to set the new rep/job as the default for log on, click Select and then restart Compass.
-or-
If you created the rep/job for another purpose select the default rep/job from the Current rep/jobs list, click Select,
and then restart Compass.
8. Log in with the LocalAdministrator user credentials.
109
Job Setup & Engineering
9. Create at least one user profile so that you can log in to the rep/job.
DDC
Working with VLC DDC
Configuring the DDC Header for a VLC
Establishing an Editing Session with a VLC in VLC DDC
The first thing you need to do when you work in VLC DDC is specify the device instance of the VLC you want to
work with and read the DDC and header information from the device. All DDC and the associated header
information are stored in the VLC’s EEPROM and run from VLC RAM.
1. On the Tools menu, point to DDC, and then click VLC.
2. Press F1 Configure in the VLC DDC Main menu.
3. Press F1 Select Device Instance in the Configure menu.
4. With the cursor positioned in the device instance field, press enter. A message appears prompting you to press
1 to type a Device Instance and press 2 for internal mode. Internal mode enables you to author a DDC file offline.
5. Press 1 to select a device instance, type the device instance of the VLC you want to work with, and press F8
when you finish. If the VLC is not communicating properly, or you typed an invalid device instance, NX appears
beside the device instance in the upper right of the VLC DDC window.
6. Choose F2-DDC from the Main menu, and then choose F4 Read DDC from VLC. There will be a brief pause
while the workstation retrieves data from the VLC.
To set a VLC Device Instance using VLC DDC
1. On the Tools menu, point to DDC, and then click VLC DDC.
2. Choose F1 Configure in the VLC DDC Main menu, and then choose F2 Configure Device Instance from the
configuration menu.
3. Use the arrow keys to position the cursor in the Network # field, and then press Enter.
4. Type the network number of the device, and then press Enter again. For VLCs, this is the network number of
the MS/TP LAN where the VLC is located.
Note: The network number and MAC address appear with the hexadecimal equivalent beside them.
5. Position the cursor in the MAC Address field, press Enter, and then type the MAC Address for the VLC you
want to configure. The MAC address is set with DIP switches on the VLC.
6. Position the cursor in the Device Instance field, press Enter, and then type the device instance you want to
assign to this VLC. Make sure no other device has this device instance.
7. Press F1 Send to VLC to load the device instance into the VLC.
110
Compass Workstation Interface User Guide PDF
To configure inputs, outputs, and program information with the DDC header
Every DDC program in a BACnet device has a DDC header that which contains information about the device’s
configuration, addressing, and input/output configuration. The header is part of the DDC program. When you load,
edit, or save DDC, the configuration data in the header is included.
The header saves the following information:
1. Program Information Determines the rep and job name where Compass saves data on the workstation, the DDC
program name, the revision number, and the associated display (not currently used). For global controllers (BTIs
and BCMs), this is the only information in the header.
2. AI Configuration Determines the software setup for VLC physical inputs, including scaling, input type,
English/metric, and unit of measure.
3. AV Configuration Determines the unit of measure for AVs.
4. BO Configuration Determines the relinquish-default and out-of-service status (TRUE or FALSE) for BOs.
5. AO Configuration Determines the unit of measure, relinquish-default, and out-of-service status for AOs.
To configure header information using VisualLogic, double-click the device icon on a DDC drawing for the device.
To configure header information using a DDC editor, from the DDC editor main menu, choose F2-DDC, choose
F2-Edit DDC Header, and then choose the submenu you want to work with.
Program Information Screen
The Program Information screen (F1 Program Information from the DDC Header menu) gives you data about the
currently viewed DDC file. This file information helps you identify the origin of the DDC file for troubleshooting.
Use the mouse to position the cursor in the field you want to change, press enter, and then type the settings you
want according to the following guidelines.
Note The data in the Program Information screen also appears and can be edited in the Disk Files screen.
Representative and Job
The representative\ job subdirectory of the Compass root directory where the file is saved on the workstation’s hard
disk.
Program
The file name (minus the BDC extension) of the DDC program.
Revision
The revision number for the DDC program. A DDC author can use this revision number to manage versions of
custom DDC.
Display
111
Job Setup & Engineering
The display number associated with this DDC file (for future use).
AI Setup
Use the AI Setup screen to set up physical inputs to the VLC. You designate the type of signal the input device
produces, the unit of measure for the input, and the type of scaling (if any) you want performed on the input prior to
DDC processing.
Keep the following in mind:
• AI numbers correspond to terminal numbers on the VLC. AI-1 corresponds to IN-1 and so on.
• Use the VAV Flow Sensor Setup screen (from the Main menu in VLC DDC, press F1-Configure, F3-
VAV Flow Sensor) to set up airflow sensors on VAV-series VLCs. The selection of metric or English
units in the AI Setup screen affects whether airflow is read in lps or cfm.
• Any AI set up as a thermistor input is read automatically in °F or °C as appropriate for the selection of
English or metric units.
• The scaling options you select are saved in the device along with the DDC.
To configure and scale AIs for a VLC in VLC DDC
1. On the Tools menu, point to DDC, and then click VLC.
2. Make sure the device instance of the VLC you want to work with is specified in the F1 Select Device Instance
option of the Configure menu. (How?)
3. In the VLC DDC Main menu, choose F2 DDC, and then choose F2 Edit DDC Header.
Note: For VAV controllers, the setting of the Program Units field determines whether airflow is reported
in cfm or lps.
4. From the Edit DDC Header menu, choose F2 AI-Analog Inputs.
5. Position the cursor in the English/Metric Mode field and press Enter to toggle between English or metric
units of measurement for all AIs.
6. Position the cursor in the Type field for the AI you want to configure, and then press Enter. A list of options
for input type appears.
7. Choose an input type, zero/time base, and range/pulse value according to guidelines in the VLC Installation and
Operations Guide.
8. Position the cursor in the Units field and then press F5 to set the units property of the AI. (This is not necessary
if counts, 10K thermistor, or 3K thermistor was chosen in step 7.) A list of BACnet engineering units appears.
9. In the list of BACnet engineering units, press F9 or F10 to move through the list of options, and then click an
engineering unit to add its code to the Units field.
10. Repeat steps 6-9 for all inputs used.
11. When you finish, return to the DDC menu and press F5 Send DDC to VLC to send the DDC header to the
VLC. Make sure the one DDC program is one you want loaded into the VLC.
112
Compass Workstation Interface User Guide PDF
AV Setup
In the AV Setup screen (F3 AV-Analog Values from the DDC Header menu), you determine the units property of
AV objects in the VLC. The units property is optional and has no effect on the present-value property of the object.
To set up the units property of AV objects
1. On the Tools menu, point to DDC and then click VLC.
2. Make sure the device instance of the VLC you want to work with is specified in the F1 Select Device Instance
option of the Configure menu. (How?)
3. Choose F3 AV-Analog Values. A list of AVs appears; each AV has a corresponding Units field. The Units
field lists the BACnet engineering units code is for the AV.
4. Position the cursor in the Units field for the AV you want to configure, press F5 to view a list of engineering
unit codes (press F9/F10 to page through unit codes), and then click the unit of measure you want associated with
the AV.
Note: You can also press ENTER in the Units field and type the engineering unit code directly.
Note: When you return to the AV Setup screen, the unit type you selected appears in the Units field.
BO Setup
In the BO Setup screen (F4 BO-Binary Objects from the DDC Header menu), you configure two important
elements of each BO: the relinquish-default and the out-of-service properties.
Relinquish-default
The relinquish-default is the value of the BO when commands for every level of its priority array are NULL--
essentially, its normal state when no command is issued. Options are ACTIVE and INACTIVE. INACTIVE is the
default. Position the cursor in this field for the BO you want to configure, and then press enter to toggle between
ACTIVE and INACTIVE.
Out-of-service
The out-of-service property of a BO is a flag that determines whether the actual physical status of the BO is a result
of the priority array. Position the cursor in this field for the BO you want to configure, and then press enter to toggle
between TRUE and FALSE.
TRUE The BO state is the result only of DDC in the VLC. The priority-array is not used. The present-value
property, being the result of the priority array, is decoupled from the actual state of the BO. Only the VLC’s internal
DDC controls the status of the BO. Note that when out-of-service = TRUE, the present-value may not correspond to
the status of the BO; a more reliable indicator is Index 14 from the BO’s priority-array, which shows the status of
VLC DDC.
FALSE The BO state is tied to its present-value, which is the result of the priority-array.
To configure parameters for a VAV airflow sensor
113
Job Setup & Engineering
VAV controllers have a special screen for setting up airflow sensor parameters, which you use to specify a box size,
a calibration factor, and the point at which airflow should read zero. Perform this one-time setup for each VAV
VLC. The setup is stored in the VLC independently of DDC or header information. This configuration affects the
value of AI-4, which is the airflow measurement for VAV VLCs.
Note The Program Units setting (English or metric) in the Analog Input Setup screen determines whether AI-4
reports airflow in units of cfm or lps and whether temperature inputs are reported in °F or °C.
1. On the Tools menu, point to DDC, and then click VLC.
2. Make sure the device instance of the VLC you want to work with is specified in the F1 Select Device Instance
option of the Configure menu. (How?)
3. In the Main menu, choose F1 Configure, and then choose F3 VAV Flow Sensor in the Configure menu. The
VAV Flow Sensor Setup screen appears, with fields for entering a box diameter, calibration factor, and velocity
zero cutoff.
4. Position the cursor in the field you want to edit, press Enter, and then choose options according to the following
guidelines.
The box diameter for the VAV box that this VLC controls. Enter a value in inches or
Box Diameter cm, depending on whether you choose English or metric units. Box diameter data is
available from the VAV box manufacturer.
The calibration factor (CF) adjusts the VLC airflow readings to match the specific VAV
Calibration box and conditions of an installation. The CF is inversely proportional to the actual
Factor measured airflow from a balancing hood. Adjust this value during balancing until AI-3
matches the balancing hood airflow measurement.
This is the percentage of full airflow at which you want zero airflow reported. This is
Velocity Zero similar to a deadband; it typically compensates for minor inaccuracies and fluctuations
Cutoff in sensor readings during periods of no airflow.
5. When you finish, return to the Main menu, choose F2 DDC and then choose F5 Send DDC to VLC. The
airflow parameters you entered are saved in VLC memory.
To assign device instances to Compass devices
A unique device instance identifies each device on a BACnet internetwork. The device instance is a numerical
identifier. The device instance is part of the object-identifier property of a device object. No two devices on the
same BACnet internetwork may have the same device instance.
When you set up the device instance for VLCs, the VLC must be communicating with the workstation. Setting the
device instance verifies communication to the VLC.
To define device instances for devices
1. On the Compass menu, click Device Manager.
2. Click Add to set up a new device and define its device instance.
114
Compass Workstation Interface User Guide PDF
Managing DDC Files
Sending DDC and the DDC Header File to a VLC
When you send a DDC file to a VLC, you transfer the DDC program and header from the workstation’s memory to
the VLC, where it runs. Sending a DDC file to a VLC archives it simultaneously to the workstation’s hard disk in
the appropriate rep and job folder.
To send a DDC file to a VLC
1. Make sure the device instance of the VLC you want to work with is specified in the F1 Select Device Instance
option of the Configure menu. (How?)
2. From the VLC DDC Main menu, choose F2 DDC.
3. From the DDC menu, choose F5 Send DDC to VLC, and then choose Yes when prompted to confirm.
The DDC program and header currently loaded in the workstation are sent to the VLC and overwrite any
previous DDC.
To load a DDC file from hard disk to work on
1. Make sure that the header information and DDC currently loaded has been saved or is okay to be deleted.
2. In the DDC menu of VLC DDC, choose F9 Program Disk Storage. The Disk Files screen appears, listing the
default representative and job and any files stored in its DDC subdirectory. The DDC files in this directory are listed
under DDC Programs Available.
3. In the Representative and Job fields, press enter and then type the representative and job name where the DDC
file you want to load is stored. The DDC files in the current DDC subdirectory of the selected job directory are
listed under DDC Programs Available.
4. Choose F10 Load DDC.
5. Type the file name you want to load in the DDC Program to Load field, and then press Enter. The DDC
program and header are loaded into the client workstation’s RAM, supplanting any previous DDC program or
header data.
To save a DDC file and header to hard disk
The DDC file and header are automatically archived when you send DDC to the controller. Use the Program
Information screen to see the file name and its location on the workstation. There may be instances where you want
to save DDC independently of a download.
To save a DDC file to the workstation’s hard disk
1. Make sure that the header information and DDC currently loaded is what you want to save.
2. On the DDC menu of VLC DDC, choose F9 Program Disk Storage. The Disk Files screen appears, listing the
default representative and job and any files stored in its DDC subdirectory. The DDC files in this directory are listed
under DDC Programs Available.
115
Job Setup & Engineering
3. Position the cursor in each of the Representative, Job, and Program fields, press enter, and then type the
representative, job, and file name for the DDC file. This indicates the location (representative and job folders) to
which you want to save.
4. Choose F6 Save. A DDC Program to Save field appears, with confirmation of the file name.
5. Press Enter to save the DDC file.
Treatment of NULL Values in Global Controller/Building Controller DDC
NULL values in Global Controller/Building Controller DDC are treated as OFF for binary-type operations and 0 for
analog-type operations.
Working with VisualLogic
About VisualLogic
VisualLogic is a graphical DDC programming environment you can use to manage and author DDC files for all
controllers that execute DDC. It requires Microsoft Visio. Use VisualLogic if you’re new to DDC programming, if
you need to create drawings concurrently with your DDC, or if you’re familiar with Windows-based applications.
Files authored for VLCs in VisualLogic are compatible with the VLC DDC programming environment.
VisualLogic uses the Visio® drawing and design tool as its engine. When you start VisualLogic, custom menu
items and functions in Visio enable you to author and manage DDC files in Alerton controllers.
In VisualLogic, the DDC program and the drawing are closely connected. When you save your drawing, code for
the controller is saved along with it. This means you can generate a DDC program from a Visio drawing or convert
DDC from a device into a Visio drawing.
Use VisualLogic to:
• Author DDC in a graphical environment, creating documentation simultaneously as you program.
• View data in real-time from controllers, monitoring DDC execution to test and verify operation.
• Manage DDC files on the primary workstation hard disk and in field controllers, reading and loading DDC
even if the sequence was authored in other development environments (VLC, Advanced VLC and
Global/Building Controller DDC).
• Set up the unit of measure and other object properties in global controllers and VLCs.
Note: For instructions about using Visio tool bars and commands and general information about Visio, see
Visio online Help or other user documentation.
VisualLogic Toolkit
VisualLogic features a convenient toolkit that enhances user performance during DDC drawing creation and
debugging. VisualLogic Toolkit is a floating or anchored dialog that provides easy access to common VisualLogic
functionality. A separate instance of VisualLogic Toolkit is created for every opened DDC drawing. VisualLogic
Toolkit dialog is visible only for the currently active DDC drawing.
Cross-reference
Displays all DDC functions matching the input criteria. Users can select any DDC
tab
function in the output cross-reference table and go to the drawing shape associated
116
Compass Workstation Interface User Guide PDF
with the DDC function.
Lists the files sizes of the executable DDC code, descriptors, and geometric
Statistics tab information.
Errors/Warnings Allows you to check drawings for logic errors and correct them.
tab
Repeat tab Provides a way to create several DDC functions of any kind at one time.
Search tab Allows you to search for a point and replace it with another point.
Program Info Lists the rep/job, application, application revision, and default display as defined in
tab the DDC header.
Device Settings Dialog Box
Lets you set descriptions, custom Microset programming, and other operating specifics for the device. An image of
a VLC, Advanced VLC, or global controller appears on the DDC drawing depending on the type of DDC program
you are viewing.
Double-click the Device Settings icon on a DDC drawing to open the Device Settings dialog box.
Select English or metric program units, select writeable or DDC descriptions,
General tab enable/disable Microset auto-detection, allow/disallow DDC reads, and import/export
Excel files.
Point Setup tab Add, edit, and collect points.
Analog Input Select the Type and Units for AIs and apply filtering to an AI.
Setup tab
Analog Output Select units, set the relinquish-default value, and set the out-of-service value.
Setup tab
Binary Output Select relinquish-default and out of service values for BOs.
Setup tab
Analog Value Select units for AVs.
Setup tab
117
Job Setup & Engineering
Microset Field
Service Setup Add, edit, or delete Field Service codes. Double-click the Code name to edit a code.
tab
Send the DDC file to the controller after making changes.
Converting bd4 Files to bd6 Format
When creating DDC for an Advanced VisualLogic Controller, you can save time by converting from existing bd4
files to bd6 format. This involves converting a bd4-format drawing to a bd6 DDC file and then creating a bd6-
format drawing based on the new DDC file. When you convert from bd4 to bd6, all points will be added to the
DDC header.
To convert bd4 DDC to bd6
1. Open the bd4 drawing in VisualLogic.
2. On the VisualLogic menu, point to File, and then select Save as Advanced VLC DDC.
3. If the VisualLogic Errors dialog box appears, click Close.
4. Select a rep/job specify a file name for the bd6 file.
5. Click Save.
6. On the VisualLogic menu, point to File and then select Read DDC from file.
7. Select the bd6 file you just saved, and then click Open. The drawing opens with the VisualLogic Advanced
VLC Visio stencil.
VisualLogic Functions
DDC Function Quick Reference Table
This table is a summary of all Compass DDC Functions, identified by DDC format type.
BD9:
BD3: BD6:
BD4: ACM (all
Functions VLX Global VLCA-1688
VLC Controller models) Global
Controller Controller
Controller
1: End of
YES YES YES YES
Normal
2: End of
YES no no YES
Subroutine
118
Compass Workstation Interface User Guide PDF
3: Set Context YES no no YES
6: Velocity
YES YES YES YES
Pressure
7: DATA Init no no no YES
8: Enthalpy
no no YES YES
Calculation
9: Wet Bulb
no no YES YES
Calculation
10: 2 Input
YES YES YES YES
AND Gate
11: 6 Input
YES YES YES YES
AND Gate
12: 2 Input OR
YES YES YES YES
Gate
13: 6 Input OR
YES YES YES YES
Gate
15: One Shot YES YES YES YES
16: Delay On
YES YES YES YES
Make (seconds)
17: Delay On
YES YES YES YES
Break (seconds)
119
Job Setup & Engineering
18: 2 Input Exclusive
YES YES YES YES
OR
20: Flip Flop
YES YES YES YES
Gate
21: Anti-Short
YES YES YES YES
Cycle Relay
22: Analog Input
YES YES YES YES
Comparator
23: Change Of
YES YES YES YES
State Detector
24: Restrictor YES YES YES YES
26: Priority Array
no YES YES no
Read
27: Increment/
YES YES YES YES
Decrement
28: Gated
YES YES YES YES
Transfer
29: Gated Priority
YES YES YES YES
Transfer
30: Subtraction no YES no no
31: Addition YES YES YES YES
120
Compass Workstation Interface User Guide PDF
32: Transfer
YES YES YES YES
Data
34: 8 Input
no no no YES
Average
35:
YES YES YES YES
Multiplication
36: Division YES YES YES YES
38: 8 Input
no no no YES
Average
39: Within A
YES YES YES YES
Range
40: Switch YES YES YES YES
41: High/Low
YES YES YES YES
Limiter
44: Run-Time
YES YES YES YES
Accumulator
45: 2 Point Linear
YES YES YES YES
Converter
46: Linear
YES YES YES YES
Converter
47: Sample And YES YES YES YES
121
Job Setup & Engineering
Hold
48: Analog To
Timed Binary YES YES YES YES
Converter
49: Thermal
Value, Modulating no YES no no
Output
50: High/Low
YES YES YES YES
Selector
51: Proportional
Integral (PI) YES YES YES YES
Loop
52: Proportional
Integral Derivative YES YES YES YES
(PID)
54: Floating
Motor Controller
YES YES YES YES
With No
Time-Out
55: Floating
Motor Controller
YES YES YES YES
With Time-
Out
122
Compass Workstation Interface User Guide PDF
56: Delay On
Make With no no no YES
Reset
57: Delay On
Break With no no no YES
Reset
58: Extended
no no no YES
PIX Controller
59: Extended
PIDX no no no YES
Controller
60: Read External
no YES YES YES
Device
61: Read External
no YES YES no
Slave Device
62: Write External
no YES YES no
Device
63: Write External
no YES YES no
Slave Device
64: 8 Input
no no no YES
AND
65: 8 Input OR no no no YES
123
Job Setup & Engineering
67: Subroutine
YES no no YES
Caller
68: Data Writer YES no no YES
70: Polynomial
no no YES YES
Computation
71: Power no no YES YES
72: Natural
no no YES YES
Logarithm
73: Log Base 10 no no YES YES
74: Nth Root no no YES YES
75: Exponential no no YES YES
76: Sunrise/
Sunset no no YES YES
Calculator
77: Daily
no no YES YES
Schedule
78: Convert to
no no YES YES
HHMM
79: Multi-
no no no YES
Trigonometric
80: ATAN2 no no no YES
124
Compass Workstation Interface User Guide PDF
81: Floor/Ceiling/
no no no YES
Round
82: Absolute
no no no YES
Value
90: Psychrometric
no no no YES
Chart
91: Atmospheric
Pressure no no no YES
Calculator
92: Interpolate no no no YES
93: Bit Unpack no no no YES
94: Bit Pack no no no YES
95: Choose
Highest/Lowest no no no YES
Score
Data Writer
The Data Writer is not a function but a tool. Use it with VisualLogic DDC drawings only (not the DDC Editors) for
presetting values to be written to a controller during a DDC download or update values while troubleshooting in
Live Data View mode. For the Data Writer, you must specify the controller I/O point (data point) to write to.
Additionally, you can set values for points to be inserted into the device during a DDC view live data
troubleshooting session.
Downloading DDC
To configure, right-click the data writer function and enter the following data.
125
Job Setup & Engineering
This is the value that you want to write to the controller I/O point. What you enter here
Value depends on your Type selection. For Real numbers, enter any value with up to six
significant digits of resolution. For Boolean values, enter ON or OFF.
This is the type of value you want to write. Select Real to write a real number (usually for
Type analog values). Select Boolean to write an ON or OFF value (usually for binary values).
Select Null to write a Null value (with Null selected, Value is unavailable).
Select the object in the controller that you want to write the value to. You can choose AI,
Object AO, AV, BI, BO, or BV.
The instance of the object to write to. For example, with BO selected as the object, and 1
Instance selected as the instance, the value is written to BO-1.
Select either present-value or the priority array. This property is written to the property of
Property the Object and Instance.
If you select priority array as Property, this determines the index of the priority-array that
is written to. If you select present-value for Property, and the object you are writing to
supports the priority-array, the value is written to the present-value using the priority array
Index index specified. For example, with BO-1, present-value selected as the controller I/O
point, and an Index of 8, the value is actually written to priority array Index. For objects
that do not support the priority-array property, Index is ignored.
Perform the following steps:
Troubleshooting DDC
After the data writer function is configured, you must right-click on the function again and select Write Data to
write the data to the device.
Function 1: End of Normal Sequence
Denotes the end of normal DDC.
Function 1 must be included in every controller. Only one Function 1 can be programmed per controller.
Function 2: End of Subroutine (.bd3 and .bd9 only)
126
Compass Workstation Interface User Guide PDF
Denotes the end of subroutine DDC.
Function 2 must be included if subroutine DDC is used. Only one Function 2 can be programmed per controller,
and it must be programmed in sequence after Function 1.
Function 3: Set Context (.bd3 and .bd9 only)
Defines the subroutine context device and is a critical component of reusable subroutine DDC (see the example),
providing a Device Instance context for each iteration of the subroutine. The input may be either a data value equal
to a Device Instance, or a Data Point ID that identifies a particular BACnet device. The subroutine context device
remains set until another Set Context function executes or the subroutine ends.
When you enter a data point in global controller/building controller DDC, you have three options: you can specify
the device where the data point originates, you can specify the local device (the controller in which the DDC
executes), or you can choose a subroutine context device. If you choose the subroutine context device, the function
must exist in subroutine DDC, and the function references the data point in the Device Instance established by the
last Set Context Function to execute.
A subroutine transfers data to and from multiple VAV-SDC3 controllers. For each VAV-SDC3 a Function 67:
Subroutine Caller calls the same subroutine DDC. Substitution Point 0 in each Subroutine Caller is the Device
Instance of the associated VAV-SDC3. The first function in the subroutine is Function 3: Set Context, with
Substitution Point 0 entered as the Context Device Instance. All subsequent data points in the subroutine DDC that
must reference the associated VAV-SDC3 are entered with the Subroutine Context Device check box selected.
Function 6: Velocity Pressure to fpm Converter
Description Perform square root extraction in order to convert an analog input that represents velocity pressure (vp)
to an analog signal that represents velocity in feet per minute ( FPM) or meters per minute, depending on the value
of k.
Remarks The inputs are input, zero, and k factor. Input should be a signal representing the velocity pressure (vp) of
the measured outflow. The k factor is used as a multiplier. The zero is used to compensate for variations in
transducer readings at zero airflow; set the zero input equal to the value of the vp input when there is no airflow.
The output of Device 6 can be expressed as:
Output = k
where k = k factor
vp = velocity pressure input
z = zero
The k factor can be used to correct for the pickup multiplier and any other factors necessary to convert the input
signal value to actual velocity pressure. Most vp pickups (except true pitot tubes) produce a pressure differential
that is greater than the actual vp. The conversion factor is typically referred to as a pickup multiplier. Use the
following equation to calculate the k factor using the pickup multiplier (PM) and the signal range (SR) as the
pressure varies over the pressure range (PR) of the sensor:
k factor =
Function 07: Data Init - Initialize range of objects (.bd9 only)
127
Job Setup & Engineering
Used to initialize a range of internal point objects. This function behaves similar to a Gated Transfer, but instead of
transferring a single input value to a single output value based on the Gate status, the Data Init function transfers a
single (Input) value to a range of Outputs defined by the starting (Out) point and the (n) number of consecutive
points.
NOTE: Explicitly prevented from writing to external objects, even in virtual devices.
Parameter Definitions:
• Input – The Input value to write when the Gate is ON.
• Out – Defines the Starting Object the function will write too (such as AV-100).
• n – Defines the number of consecutive points that will be written (a value of 10 for example will write to
AV-100 through Av-109).
• Gate – Determines when the Input will be written. If the Gate is ON the Input is written to each object in the
range of Outputs. If the Gate is OFF, the Data Init function stops writing and allows the Output points to be
changed from other sources.
The following describes all use cases for "first item to set"
• To set a range of branches: BR-n
• To set Present_Value on a range of points: TT-n
• To set a specific property on a range of points: TT-n-Pm
• To set a specific array element of a property on a range of points: TT-n-Pm[x]
(note that the array index does not increment)
In the list above, "TT" is one of AI/AO/AV/BI/BO/BV/MI/MO/MV.
Any of the following conditions cause the DATAINIT function to do nothing at all:
• The "first item to set" object doesn't exist
• The "first item to set" object is external or in a virtual device
• The "first item to set" object is not a branch or not an AI/AO/AV/BI/BO/BV/MI/MO/MV
• The "number of items to set" is greater than 10000
NOTE: While the first object must exist, the DATAINIT function silently skips over any non-existent objects
thereafter.
Function 8: Enthalpy Calculator (.bd6 and .bd9 only)
Calculates enthalpy from temperature and relative humidity.
128
Compass Workstation Interface User Guide PDF
Function 8 uses two input values, temperature in degrees F and relative humidity (RH) in %, to calculate enthalpy in
BTU/lb. Minimum temperature used is 0 degrees F. Maximum temperature used is 102 degrees F. Inputs must be
positive numbers.
Maximum enthalpy that can be calculated is 68 BTU/lb. at 102 degrees Fahrenheit and 100% relative humidity. The
accuracy of this calculation is best between 55 and 80 degrees Fahrenheit.
NOTE: Controllers that support BD6 have an enhanced Enthalpy Calculator for both BD4 and BD6. The enhanced
Enthalpy Calculator is based on equations from the 1993 ASHRAE Fundamentals Handbook. The enthalpy
calculation is based on an atmospheric pressure of 14.696 psia and dry-bulb temperature is limited to -148 to 392
degrees F.
Function 9: Wet Bulb Calculator (.bd6 and .bd9 only)
Calculates wet bulb temperature from dry bulb temperature, relative humidity, and altitude.
The enhanced Enthalpy Calculator is based on equations from the 1993 ASHRAE Fundamentals Handbook. The
enthalpy calculation is based on an atmospheric pressure of 14.696 psia and drybulb temperature is limited to -148
to 392 degrees F.
Function 10: Two-Input AND Gate
Performs the logical AND function of two binary-type inputs and set a binary output accordingly.
The output will be set to ON only if both inputs are ON. If either input is OFF, the output is OFF.
In unitary controller DDC, do not leave inputs unassigned or assign inputs whose value may be NULL. Instead, set
unused inputs to TRUE (ACTIVE, ON). NULL inputs are acceptable in global controller/building controller DDC
only and are typically converted to OFF.
Input 1 Input2 Output
OFF OFF OFF
129
Job Setup & Engineering
ON OFF OFF
OFF ON OFF
ON ON ON
Function 11: Six-Input AND Gate
Performs the logical AND function of six binary inputs and set the binary output accordingly.
Function 11 is similar to Function 10: Two-input AND Gate, except that six binary inputs are logically compared to
generate one binary output. Function 11 is used when there are more than two inputs. All six inputs must be
assigned. If there are fewer than six inputs, the unused inputs should be set to any of the used input values or to a
data value of (ON) but cannot be left blank.
The function uses all six inputs to set the output ON or OFF. If any of the six inputs is OFF, the output will be set to
OFF. The output will be set to ON only if all of the six inputs are ON.
In unitary controller DDC, do not leave inputs unassigned or assign inputs whose value may be NULL. Instead, set
unused inputs to TRUE (ACTIVE, ON). NULL inputs are acceptable in global controller/building controller DDC
only.
Startup NULL values and NULL values read from a property are treated as OFF.
Function 12: Two-Input OR Gate
Performs the logical OR comparison of two binary inputs and set the binary output accordingly.
The output is ON if either or both inputs is ON. The output is OFF only if both inputs are OFF
In unitary controller DDC, do not leave inputs unassigned or assign inputs whose value may be NULL. Instead, set
unused inputs to FALSE (INACTIVE, OFF). NULL inputs are acceptable in global controller/building controller
DDC only and are typically converted to OFF
Input 1 Input 2 Output
ON OFF ON
130
Compass Workstation Interface User Guide PDF
ON ON ON
OFF OFF OFF
OFF ON ON
Function 13: Six-Input OR Gate
Performs the logical OR of six binary inputs and set the binary output accordingly.
Function 13 is similar to Function 12: Two-input OR Gate, except that it works with six binary inputs to generate
one binary output. Function 13 is used when there are more than two inputs. All six inputs must be assigned. If
there are fewer than six inputs, the unused inputs should be set to any of the used input values or to a data value of
(OFF) but cannot be left blank.
The function uses all six inputs to set the output as ON or OFF. If any of the six inputs is ON, the output will be
ON. The output will be OFF only if all six inputs are OFF.
In unitary controller DDC, do not leave inputs unassigned or assign inputs whose value may be NULL. Instead, set
unused inputs to FALSE (INACTIVE, OFF). NULL inputs are acceptable in global controller/building controller
DDC only.
Function 15: One Shot
Sets the output ON for one pass of DDC whenever the input transitions from OFF to ON.
The output remains ON only for the single pass of DDC, even if the input stays ON for a longer or period.
Function 16: Delay on Make (Seconds)
Delays a binary transition from OFF to ON.
When the Input transitions from OFF to ON, the output transitions ON only after the specified delay time (t). You
can provide a delay time (t) with resolution to 1 second for global controllers and building controllers, and 0.1
second in VLCs.
If the input value transitions OFF at any time during the delay period, the timer resets. The output transitions OFF
immediately when the function reads OFF from the Input.
Function 17: Delay on Break
131
Job Setup & Engineering
Delays a transition from ON to OFF.
When the Input transitions from ON to OFF, the output transitions OFF only after the specified delay time (t). If the
input value changes to ON at any time during delay time (t), the timer resets. You can provide a delay time (t) with
resolution to 1 second for global controllers and building controllers, and 0.1 second in VLCs.
If the input value changes to ON at any time during delay time (t), the timer resets. The output transitions ON
immediately when the function reads ON from the Input.
Function 18: Two-Input Exclusive OR
Sets the binary output OFF if both inputs match (both ON or both OFF), and set the output ON if only one of the
inputs is ON.
Function 18 is similar to Function 12: Two-input OR Gate, with one exception: the output is OFF if both inputs are
ON. Other values remain consistent with the OR function: The output is OFF if both inputs are OFF, and the output
is ON only if one input is ON. NULL inputs are acceptable in global controller/building controller DDC only and
are typically converted to OFF.
Input 1 Input 2 Output
ON ON OFF
ON OFF ON
OFF OFF OFF
OFF ON ON
Function 20: Flip Flop Gate
Two binary inputs, set (S) and reset (R), are used to switch the binary output between ON and OFF respectively.
Function 20 has two binary inputs, set (S) and reset (R), which determine how the output is set. A momentary ON
of the set (S) input turns the output ON if the reset (R) input is OFF.
The output will stay ON once it is set, even if the set (S) input transitions OFF. If the reset (R) input turns ON, the
output transitions OFF. The reset (R) input has priority over the set (S) input, so the output will be OFF if both
inputs are ON. NULL inputs are acceptable in global controller/building controller DDC only and are typically
converted to OFF.
Set Reset Output
OFF OFF OFF
OFF ON OFF
132
Compass Workstation Interface User Guide PDF
ON OFF ON
ON ON OFF
Function 21: Anti Short Cycle Relay
Prevents an output from changing state repeatedly, or "short cycling," by setting minimum ON and OFF times.
Once the output turns ON, it will stay ON for the minimum ON time, even if the input goes OFF. When the output
goes OFF, it will stay OFF for the minimum OFF time, even if the input goes ON. Minimum ON and OFF times
can be set to different values. The time resolution is 0.1 second.
Function 22: Analog Input Comparator
Compares two analog inputs and produce a binary signal as a result of the comparison.
The output will be ON when the plus input is greater than or equal to the minus input plus the trigger deadband (
TDB). The output will go OFF when the plus input is less than or equal to the minus input minus the restore
deadband ( RDB).
Output Condition
ON Plus Input ≥ (Minus Input + TDB)
OFF Plus Input ≤ (Minus Input - RDB)
No Change (Minus Input - RDB) < Plus Input <(Minus Input + TDB)
Function 23: Change of State (COS) Detector
Turns a binary output ON momentarily whenever the AI changes by more than the value entered for deadband
(DB).
Function 23 compares an AI to a stored value. The stored value is set to the input value each time the output is ON
and does not change while the output is OFF.
The output is ON when the AI is greater than the stored value plus the DB, or the AI is less than the stored value
minus the DB. Otherwise, the output is OFF.
Example:
If DB is set to 1.0, and the input when the DDC is first initiated is 13.2 (which then becomes the stored value), then
the output will turn ON for one pass of the DDC the first time the input reaches 14.3 or greater or 12.1 or fewer. If
the input varies between 12.2 and 14.2, the stored value will remain the same. If the input were to suddenly change
to 14.6; for example, the output would turn ON and 14.6 would become the new stored value.
133
Job Setup & Engineering
Function 24: Restrictor
Restricts the rate of change of an analog value.
The inputs to Function 24 are analog data input, binary reset input ( RST), maximum up count, and maximum down
count. As long as the binary reset input is ON, the output will attempt to match the analog data input; however, the
rate of change of the output is limited by the maximum up and maximum down inputs. The maximum up input
regulates the maximum increase allowed in the output per second, while the maximum down input regulates the
maximum decrease allowed in the output per second. The maximum up count and maximum down count are
independently adjustable.
The output will immediately be set to zero when the reset input turns OFF.
Function 26: Priority Array Read (.bd4 and .bd6 only)
Output the value of a specified element of an object's BACnet priority array. Indicate with a separate output whether
the specified element is NULL.
The BACnet object ( OBJ) and priority array index (PR) are inputs to this function. The data output equals the
current value of the specified element of the priority array, except when the element is NULL, in which case the
data output is 0 (or OFF when used as a binary value).
The function's NULL output is binary. It is OFF if the specified element is NULL and ON if other than NULL.
134
Compass Workstation Interface User Guide PDF
Example: To determine when a priority is OFF.
Function 27: Increment/Decrement
Increases the In/Out value by an Up/Pass value or decrease it by a Down/Pass value only if an ON value is passed to
the Up Input or Down Input, respectively, for each pass of the DDC.
For each pass of the DDC, the value of the Up/Pass input value is added to In/Out whenever the Up Input is ON.
Similarly, the value of the Down/Pass input is subtracted from the In/Out whenever the Down Input is ON. The
In/Out value is limited to the range defined by the Upper Limit and Lower Limit inputs.
NOTE: This function only adds to the In/Out point or subtracts from it when either the Up Input or Down Input is
ON.
Function 28: Gated Transfer
Writes the input value to the output value only when the Gate input is ON.
This function will not write to the output if the Gate input is OFF. Note that, unlike Function 47: Sample and Hold,
this function does not store the value of the output, meaning the output will not necessarily remain constant when
the Gate input is OFF.
Function 29: Gated Priority Transfer (.bd4 and .bd6 only)
Writes the input value to a BACnet object with the specified priority other than the default priority. When the binary
gate control is OFF, a NULL value is written to the specified output.
When the binary gate control is ON, the value of the input is written to the output (which should be a BACnet
object), with the priority specified by the priority input. The output must be a BACnet object that has a priority
array. Inputs must be positive numbers.
135
Job Setup & Engineering
NOTE: The input cannot be negated or reversed.
Function 29 cannot write to these priority array indices:
• 1: Manual Life Safety
• 2: Automatic Life Safety
• 5: Critical Equipment
• 6: Minimum ON/OFF
• 8: Manual Operator
• 9: Alerton Global Controller
Function 30: Subtraction
Subtracts one input value from another.
Function 30 subtracts the value of analog input two(minus) from the value of analog input one(plus). The output is
then set to the result.
Function 31: Addition
Adds two input values.
Function 31 adds analog input one and analog input two. The sum is written to the output.
Function 32: Transfer Data
Copies a value from one property to another.
Function 32 is used to transfer analog or binary data from one property to another without changing the data
content.
Function 33: Six-input Addition
Adds six input values.
Function 33 adds analog inputs one through six. The sum is written to the output.
Function 34: 8 Add - 8 Input Addition (.bd9 only)
136
Compass Workstation Interface User Guide PDF
Adds Inputs one through eight, and writes the sum to the output.
Function 35: Multiplication
Multiplies (X) one value by another.
Input one (multiplicand) is multiplied by input two (multiplier), and the product is written to the output.
Function 36: Division
Divides one value by another.
Input one (dividend) is divided by input two (divisor), and the resulting quotient is written to the output.
Function 38: 8-AVG - Compute average (.bd9 only)
This function computes the sum of up to eight valid inputs divided by the number of valid inputs. Inputs are only
considered valid if they evaluate to a numeric or boolean value (with true=1 and false=0). "NULL" values are
ignored.
Function 39: Within a Range
137
Job Setup & Engineering
Turns the output from OFF to ON whenever the Input Value is within the range defined by the Limit 1 and Limit 2
values.
Function 39 has three analog inputs and one binary output. The output is ON whenever the Input Value is greater
than or equal to the lower limit value and the Input Value is less than or equal to the higher limit value. Otherwise,
the output is OFF. Note that the output is ON if the Input Value is equal to either of the limits, and that Limit 1 does
not necessarily have to be less than Limit 2.
Function 40: Switch
Selects an output value from two input values, depending on the value of a binary input.
Function 40 has two analog inputs, one binary input and an analog output. The output equals the ON analog input if
the binary control input is ON, and the output equals the OFF analog input if the binary control input is OFF.
Function 41: High/Low Limiter
Restricts an analog value to a range defined by two limits.
Function 41 has three analog inputs and one analog output. The output will equal the analog input as long as it is
within the range defined by the high limit and low limit.
If the analog input exceeds the high limit, the output will be set to the value of the high limit. If the analog input is
less than the low limit, the output will be set to the low limit.
If the high limit value is less than the low limit value, the high limit has priority (that is, the output will be set to the
high limit, regardless of the analog input value).
Function 44: Run-Time Accumulator
Outputs a cumulative analog run time value for a binary input.
The output (run time) equals the total accumulated time that the binary input has been ON. Run-time increases by 1
for each hour that the input has been ON. The run-time output can be assigned to any AV in the VLC, including
those stored directly in EEPROM. The AV will be written to only when an additional hour of run-time has
accumulated. This is the only DDC function that can write to an EEPROM-stored AV.
Function 45: Two-Point Linear Converter
Performs a linear conversion on the input to produce an output. Two points (IN1, OUT1) and (IN2, OUT2) are used
to define the line relating input to output.
A straight-line relationship (of the form y = a + bx) determines the output as a function of the input. By inputting
two points on this line, the line is then defined. When input = IN1, output = OUT1, and when input = IN2, output =
OUT2.
Example:
If you wanted to use this function to convert F° to C°, you could use the following values for IN1, OUT1, IN2 and
OUT2:
138
Compass Workstation Interface User Guide PDF
IN1=32
OUT1=0
IN2=212
OUT2=100
Function 46: Linear Converter
Performs a linear conversion on the input and produce an output using zero and range values as follows:
Output = Zero + Input X Slope
Input must be a positive number.
Function 47: Sample and Hold
Records and store an analog value as prompted by a binary input.
Function 47 has one analog input, one binary sample control (CTRL) input , and an analog output. When the CTRL
input is ON, the output and the stored value are set equal to the input. When the CTRL input is OFF, the output is
set to the last stored value.
Function 48: Analog to Timed Binary Converter
Cycles the output ON for a portion of each cycle time ( CYC), which is adjustable, based on a 0.0 to 100.0 analog
input control signal. A minimum ON time ( MON) and minimum OFF time ( MOF) prevent short cycling. Time
resolution is 1 second (longer if DDC takes longer than one second to run).
Calculated ON time =
Calculated OFF time = cycle time minus calculated ON time
The output will turn ON only if the calculated ON time is greater than the MON. If the output is ON, it will remain
ON until it has been ON for the calculated ON time and the MON has expired. The output will remain ON
continuously if the calculated OFF time is less than the MOF.
Function 49: Thermal Valve, Modulating Output (.bd4 and .bd6 only)
Pulses the binary output ON every 2.55 seconds, varying the ON time of the output (pulse width) from 0 to 2.55
seconds as the analog input varies from 0 to 100.0. If analog input is 0, the output remains OFF.
The pulse width is calculated using a non-linear conversion to better match the thermal modulating valve (TMV).
Do not use a NOT on the output of this device. To reverse a valve, reverse the signal by subtracting it from 100
before inputting it to this function.
139
Job Setup & Engineering
NOTE: The input cannot be negated or reversed.
Function 50: High/Low Selector
Selects the highest and lowest values from among six inputs.
Function 50 has six analog inputs and two analog outputs. The high output will equal the value of the highest input.
The low output will equal the value of the lowest input. All inputs must be assigned. If fewer than six inputs are
needed, one or more of the input assignments should be repeated to fill the remaining inputs.
Function 51: Proportional Integral (PI) Controller
Provides proportional integral (PI) control. Output is adjusted in an attempt to get the feedback input (FB) to match
the setpoint (SP).
Inputs are feedback (FB--typically a space temperature), setpoint (SP), proportional constant (Kp), integral constant
(Ki), maximum integral change (IMX), integral startup (STUP), and integral limit (ILMT). The output of this
function can be expressed as P+I+50, where P is the proportional component and I is the integral component. Each
of these is calculated as indicated below. Note that Error (E) is an intermediate variable equal to FB minus SP.
Output = P + I + 50, where P = Kp(E), and I = I prev + I inc,
Where Iinc = . Iinc is calculated once per second and Iprev is I from the most recent calculation. Iinc is
limited to a maximum of IMX/60, and I is limited to +/-ILMT. When DDC is initialized, Iprev is set to STUP for
the first DDC loop. Also, when Ki = 0, the value of I = STUP.
Function 52: Proportional Integral Derivative (PID) Controller
Provides proportional integral derivative (PID) control. Output is adjusted in an attempt to get the input to match the
setpoint.
Similar to Function 51, except that a derivative component, D, is included in the output calculation. D is the rate of
change in E per second times the constant Kd, which is an input to the device. Note that Error (E) is an intermediate
variable equal to FB minus SP.
Output = P + I + D + 50, where P and I are as calculated for Function 51 and D = 10 Kd (E - Eprev). Eprev
represents the value of E from the previous pass of DDC. D is calculated every 0.1 second.
Function 54: Floating Motor Controller with No Time-out
Provides floating point control of a motor based on a 0 to 100.0 control signal.
140
Compass Workstation Interface User Guide PDF
Function 55 has three analog inputs, two binary outputs, and one analog output. The input control signal (0.0 to
100.0) is compared to the current motor position (as estimated internally by the function). If the desired position is
greater than the current position by more than DB, the open motor (OP) output will be ON. If the desired position is
less than the current position by more than DB, the close motor (CL) output will be ON. If the current position is
within DB of the input, both binary outputs will remain OFF.
The motor time (MT) input represents the time required (in seconds) for the motor to go from fully closed to fully
open. The function estimates the current motor position (%) output based on the motor time and the cumulative ON
times of the open motor and close motor outputs.
As the motor modulates open and closed, the function-estimated motor position will typically deviate further from
the actual position. Also, the VLC assumes on power up that the motor is fully closed and will pulse the motor open
to the currently desired position. This means that the motor can also get out of phase with the function-estimated
position if it is driven open and a power interrupt occurs. Use the initialization flag, which is ON only during the
first DDC loop, and additional DDC to eliminate this out-of-phase condition on power-up.
When the control signal reaches 0.0 or 100.0 and the motor is driven fully closed or open, the estimated position is
automatically re-calibrated.
Function 55: Floating Motor Controller with Time-out
Provides floating point control of a motor (or any device driven open or closed by a BO) based on a 0 to 100.0
control signal.
Same as Function 54, with the addition of a timeout feature: When the input remains at 0.0 for an extended period,
the close command (CL) output will turn OFF motor time (MT) seconds after the estimated damper position is fully
closed. When the input remains at 100.0 for an extended period, the open command ( OP) output will turn OFF MT
seconds after the estimated damper position is fully open.
Function 56: DOMR - Delay On Make with Reset (.bd9 only)
Similar to the standard DOM, the DOMR delays a binary transition from OFF to ON based on a user settable
(Delay) time. Unlike the standard DOM however, the DOMR provides the user with a way to see how long the
delay timer has left before transitioning by providing a (Time Remaining) output in seconds. The DOMR also has
the ability to specify a (Suspend) input which can be activated to halt the Time Remaining delay counter. When the
Suspend Input is turned ON the delay counter halts at its current value, and when the Suspend Input is turned OFF
the delay counter starts counting down normally from its current value. The DOMR also gives the user a (Reset)
Input which allow the user to specify a point that can be used to Reset the delay counter to 0. With the Reset Input
ON the Time Remaining delay counter is forced to 0 whenever the input turns ON, effectively disabling the delay
and allowing the output to turn ON as soon as the input goes ON (no delay).
NOTE: The time delay function contains logic to adjust for DDC cycles that take longer than 1 second to complete,
therefore keeping accurate time regardless of the DDC cycle time.
141
Job Setup & Engineering
Function 57: DOBR - Delay on Break with Reset (.bd9 only)
Similar to the standard DOB, the DOBR delays a binary transition from ON to OFF based on a user settable (Delay)
time. Unlike the standard DOB however, the DOBR provides the user with a way to see how long the delay timer
has left before transitioning by providing a (Time Remaining) output in seconds. The DOBR also has the ability to
specify a (Suspend) input which can be activated to halt the Time Remaining delay counter. When the Suspend
Input is turned ON the delay counter halts at its current value, and when the Suspend Input is turned OFF the delay
counter starts counting down normally from its current value. The DOBR also gives the user a (Reset) Input which
allows the user to specify a point that can be used to Reset the delay counter to 0. With the Reset Input ON the Time
Remaining delay counter is forced to 0 whenever the input turns ON, effectively disabling the delay and allowing
the output to turn OFF as soon as the input goes OFF (no delay).
NOTE: The time delay function contains logic to adjust for DDC cycles that take longer than 1 second to complete,
therefore keeping accurate time regardless of the DDC cycle time.
Function 58: PIX - Extended PI Controller (.bd9 only)
Similar to the standard IP Controller, the PIX provides Proportional and Integral Control based on Setpoint and
Feedback values.
In addition to the standard PI, the PIX adds a (Suspend) Input which will halt the Integral calculation at its current
value.
Unlike the standard PI function (with a base output of 50), the PIX sets its base output to 0 when the Feedback and
Setpoint are equal (and with no Integral adjustment), to allow for easier calculation of separate HTG and CLG
signals. The PIX instead provides a (Bias) Input which allows the user to specify a bias if desired (setting a Bias of
50 would mimic a PI).
The PIX also provides separate Outputs letting the user know the raw values for Proportional (P), and Integral (I),
and allowing the user to see how these values are effecting the Output.
NOTE: Output is always limited to 0 – 100.
Inputs are feedback (FB--typically a space temperature), setpoint (SP), proportional constant (Kp), integral constant
(Ki), maximum integral change (IMX), integral startup (STUP), and integral limit (ILMT). The output of this
function can be expressed as P+I+Bias, where P is the proportional component and I is the integral component.
Each of these is calculated as indicated below. Note: Error (E) is an intermediate variable equal to FB minus SP.
Output = P + I + Bias, where P = Kp(E), and I = I prev + I inc,
142
Compass Workstation Interface User Guide PDF
Where Iinc = . Iinc is calculated once per second and Iprev is I from the most recent calculation. Iinc is
limited to a maximum of IMX/60, and I is limited to +/-ILMT. When DDC is initialized, Iprev is set to STUP for
the first DDC loop. Also, when Ki = 0, the value of I = STUP.
Function 59: PIDX - Extended PID Controller (.bd9 only)
Similar to the standard IPD Controller, the PIDX provides Proportional, Integral and Derivative Control based on
Setpoint and Feedback values.
In addition to the standard PID, the PIDX adds a (Suspend) Input which will halt the Integral and Derivative
calculations at their current value.
Unlike the standard PID function (with a base output of 50), the PIDX sets its base output to 0 when the Feedback
and Setpoint are equal (and with no Integral, or Derivative adjustment), to allow for easier calculation of separate
HTG and CLG signals. The PIDX instead provides a (Bias) Input which allows the user to specify a bias if desired
(setting a Bias of 50 would mimic a PID).
The PIDX also provides separate Outputs letting the user know the raw values for Proportional (P), Integral (I) and
Derivative (D), and allowing the user to see how these values are effecting the Output.
NOTE: Output is always limited to 0 – 100.
Inputs are feedback (FB--typically a space temperature), setpoint (SP), proportional constant (Kp), integral constant
(Ki), derivative constant (Kd), maximum integral change (IMX), integral startup (STUP), and integral limit (ILMT).
The output of this function can be expressed as P+I+D+Bias, where P is the proportional component, I is the
integral component and D is the derivative component. Each of these is calculated as indicated below. Note that
Error (E) is an intermediate variable equal to FB minus SP.
Output = P + I + D + Bias, where P = Kp(E), I = I prev + I inc, and D = 10 Kd (E - Eprev). Eprev represents the
value of E from the previous pass of DDC. D is calculated every 1 second.
143
Job Setup & Engineering
Where Iinc = . Iinc is calculated once per second and Iprev is I from the most recent calculation. Iinc is
limited to a maximum of IMX/60, and I is limited to +/-ILMT. When DDC is initialized, Iprev is set to STUP for
the first DDC loop. Also, when Ki = 0, the value of I = STUP.Job Setup & Engineering.
Function 60: Read External Device (.bd4 in VLC v4.02 or newer, .bd6, and .bd9)
Reads data from an external BACnet device object at a specified rate (READ FREQUENCY = seconds).
The INPUT is the device instance, object, and property that is transferred to the present-value of the OUTPUT
object. If the VLC can successfully read the INPUT, the DATA RELIABILITY is 1 (ON), otherwise it is 0 (OFF).
NULL OUTPUT is normally 0 (OFF). If the device object being read contains a BACnet value of NULL (empty),
the NULL OUTPUT is set to 1 (ON) to indicate the DATA OUTPUT is invalid.
CAUTION: Use the RED function to pull data rather than push it using the WED function because troubleshooting
can become complex where WED functions are used. For example, if a VLC value changes with no apparent
explanation, and there are some WED functions used in some VLCs, the user must examine the DDC in every VLC
in the system to determine which one has the WED function.
144
Compass Workstation Interface User Guide PDF
CAUTION: When DDC is first started after being loaded or after a power cycle, data values from RED and REDS
functions are 0 (or OFF if a binary value). They remain at 0 until a successful read is completed. In the event that
the RED or REDS function loses communication with the target device, the data value remains at the last retrieved
value. To prevent problems, use the data integrity output of the RED and REDS functions in your DDC as
appropriate.
Function 61: Read External Slave Device (.bd4 in VLC v4.02 and newer, and .bd6 only)
Reads data from an external BACnet slave device object at a specified rate (READ FREQUENCY = seconds).
The NETWORK and MS/TP MAC specify the network and MAC address of the external object. The INPUT is the
device instance, object, and property that is transferred to the present-value of the OUTPUT object. If the VLC can
successfully read the INPUT, the DATA RELIABILITY is 1 (ON), otherwise it is 0 (OFF). NULL OUTPUT is
normally 0 (OFF). If the device object being read contains a BACnet value of NULL (empty), the NULL OUTPUT
is set to 1 (ON) to indicate the DATA OUTPUT is invalid. Otherwise, NULL OUTPUT is set to 0 (OFF).
NOTE: If the slave device that is being read is on the same MSTP network, set the Network number to 0 (zero).
CAUTION: When DDC is first started after being loaded or after a power cycle, data values from RED and REDS
functions are 0 (or OFF if a binary value). They remain at 0 until a successful read is completed. In the event that
the RED or REDS function loses communication with the target device, the data value remains at the last retrieved
value. To prevent problems, use the data integrity output of the RED and REDS functions in your DDC as
appropriate.
Function 62: Write External Device (.bd4 in VLC v4.02 and newer and .bd6 only)
Writes data (DATA TO WRITE) to an external BACnet device object.
The DESTINATION specifies the object, property, and index to be written to. A write is attempted whenever the
DATA TO WRITE changes by the amount of DEADBAND. DATA/NULL is set to 1 (DATA) to send the value in
DATA TO WRITE, and 0 (NULL) if the special BACnet NULL (empty) value is to be written. The WRITE
RELIABILITY is set to 1 (ON) when the external device acknowledges the write. It is set to 0 (OFF) whenever the
external device does not respond.
145
Job Setup & Engineering
CAUTION: Use the RED function to pull data rather than push it using the WED function because troubleshooting
can become complex where WED functions are used. For example, if a VLC value changes with no apparent
explanation, and there are some WED functions used in some VLCs, the user must examine the DDC in every VLC
in the system to determine which one has the WED function.
Function 63: Write External Slave Device (.bd4 in VLC v4.02 or newer, and .bd6 only)
Writes data (DATA TO WRITE) to an external BACnet slave device object.
The NETWORK and MS/TP MAC specify the BACnet network and mac where the slave device resides. The
DESTINATION specifies the object, property, and index to be written to. A write is attempted whenever the DATA
TO WRITE changes by the amount of DEADBAND. DATA/NULL is set to 1 (DATA) to send the value in DATA
TO WRITE, and 0 (NULL) if the special BACnet NULL (empty) value is to be written. The WRITE
RELIABILITY is set to 1 (ON) when the external device acknowledges the write. It is set to 0 (OFF) whenever the
external device does not respond.
Function 64: 8 AND - Eight-Input AND Gate (.bd9 only)
Function 64 is similar to Function 11: Six-Input AND Gate, except that eight binary inputs are logically compared
to generate one binary output. An important difference between the 8AND and the 6AND however, is the 8AND
does not require all inputs to be defined. By hard coding and input to the “NULL” value (the default value), the
8AND will effectively ignore that input. This allows the user to only setup as many inputs as they need.
Another important change is the ability for the user to specify a default value to be used when reading a (BACnet
NULL). Setting the BACnet NULL input to ACTIVE, will mimic the behavior of the 2AND and 6AND by reading
146
Compass Workstation Interface User Guide PDF
any BACnet NULL values as TRUE, or ON. Setting the BACnet NULL input to INACTIVE will cause the function
to read BACnet NULL values as FALSE, or OFF.
Examples of where variable BACnet NULL values may arise:
• When reading an external BACnet property, the value is NULL until data is received from the remote
device. If there is an error (unknown object or unknown property), the value will remain at NULL
indefinitely.
• Priority arrays and some other properties may explicitly contain the value NULL.
• Branches are set to NULL before DDC runs the first time
Function 65: 8 OR - Eight-Input OR Gate (.bd9 only)
Function 65 is similar to Function 13: Six-input OR Gate, except that it works with eight binary inputs to generate
one binary output. An important difference between the 8OR and the 6OR however, is the 8OR does not require all
inputs to be defined. By hard coding and input to the “NULL” value (the default value), the 8OR will effectively
ignore that input. This allows the user to only setup as many inputs as they need.
The function uses all eight inputs to set the output as ON or OFF. If any of the eight input is ON, then the output
will be ON. The output will be OFF only if all eight inputs are OFF. A BACnet NULL value will be read as OFF,
and should work for all cases.
147
Job Setup & Engineering
Function 67: Subroutine Caller (.bd3 and .bd9 Only)
Calls a subroutine and sets values of the substitution points to be used for the subroutine.
When Function 67: Subroutine Caller executes, the next function executed is the sequence number specified as the
Subroutine's Starting Sequence in the Subroutine Caller setup. The Subroutine Starting Sequence must be
programmed at a sequence number higher than Function 1: End of Normal and lower than Function 2: End of
Subroutine (that is, it must be outside normal DDC space and within subroutine DDC space). Functions execute in
order until End of Subroutine is encountered, at which point program execution returns to the normal DDC space,
be ginning with the function immediately after the Subroutine Caller.
Parameters are equivalent to substitution points. Parameter 0, for example, is equivalent to Substitution Point 0.
When subroutine DDC encounters an input or output defined as a substitution point, the value or data point entered
at the Subroutine Caller is used.
Each Subroutine Caller can have different data points assigned. In this way, a single DDC subroutine can execute
using different data points and values, as long as the subroutine is called with different Subroutine Callers.
NOTE: You can configure the subcaller function to display or hide the substitution points on the VisualLogic
drawing.
NOTE: Do not define a substitution point as another substitution point.
Function 70: Polynomial (.bd6 and .bd9 only)
Algebraic function consisting of a sum of multiple terms, each term consisting of a constant multiplier and a
variable raised by an integer power.
The output is the value of the polynomial A + Bx + Cx2 + Dx3 + Ex4, which is calculated for efficiency as (((E*X)
+ D)*X + C)*X + B)*X + A.
Function 71: Power (.bd6 and .bd9 only)
148
Compass Workstation Interface User Guide PDF
Raises x to the y power.
The output is the mathematical result of input x raised by the power of input y.
Function 72: In- Natural Logarithm (.bd6 and .bd9 only)
The natural logarithm of x (written loge(x) or ln(x)) is the power to which e would have to be raised to equal x,
where e is an irrational number that is approximately 2.718281828.
The output is the value y where ey = x. The input x must be greater than 0.
Function 73: Log Base 10 (.bd6 and .bd9 only)
The logarithm base 10 of x (written log10(x)) is the power to which 10 would have to be raised to equal x.
The output is the value y where 10y = x. The input x must be greater than 0.
Function 74: nth Root (.bd6 and .bd9 only)
The nth root of x is the value y such that y raised to the nth power equals x.
Use an integer for n.
The output is the value y, where y raised to n = x.
The input x must be greater than or equal to 0.
Function 75: Exponential (.bd6 and .bd9 only)
e raised to x is the number e (approximately 2.71828128) raised to the x power.
149
Job Setup & Engineering
Function 76: Sunrise/Sunset Calculator (.bd6 and .bd9 only)
Calculates sunrise and sunset time in decimal degrees using latitude and longitude inputs. The current date is used
an implicit input to this function.
Function 76 returns correct values only if the current date is set correctly. All times are specified in minutes since
midnight.
Coordinated universal time (UTC) offset muyst be set correctly in the Device Profile in Device Manager.
Latitude should be in the range –90 to +90 degrees, where + indicates North latitude, – indicates South latitude.
Longitude should be in the range –360 to +360 degrees, where + indicates East longitude, and – indicates West
longitude.
The outputs Always Up and Always Down are always FALSE unless the latitude is above the Arctic circle or below
the Antarctic circle, in which case they indicate TRUE if the sun either does not set or not rise, respectively.
Example:
Where is zero? Longitude 0 degrees passes through the original site of the Royal Observatory in Greenwich,
England. Seattle’s latitude is entered in decimal degrees as 47.617,-122.333 (47° 37’ N, 122° 20’ W). Using the
specified latitude and longitude, the current local date/time/UTC offset, and Daylight Saving Status are taken into
consideration. This function generally runs only at midnight, but it also runs on change of latitude, longitude,
system date/ time, UTC offset, to Daylight Saving Status.
Function 77: Daily Schedule (.bd6 and .bd9 only)
Calculates the daily schedule from ON, OFF, and Current Time inputs.
This function compares the current minutes before or after midnight against desired ON and OFF times. The
purpose of this function is to determine when to turn a load ON or OFF at a given time on a daily basis.
Inputs are handled modulo 1440 (60 minutes x 24 hours, the number of minutes in a day). All times are expressed in
digits that represent the number of minutes either before midnight (using a negative digit) or after midnight (using a
positive digit). Midnight (12:00 A.M.) can be represented either by 0 or by 1440.
Therefore, for programming purposes, each minute of the day can be expressed as either a positive or negative digit,
as shown in the examples below:
150
Compass Workstation Interface User Guide PDF
• 11:50 P.M. can be expressed as either -10 or as 1350.
• 6:05 A.M can be expressed as either -1075 or as 365.
• 11:32 A.M can be expressed as either -748 or as 692.
• 12:00 P.M. (noon) can be expressed as -720 or as 720.
The ON and OFF times need not be in any order. The output must be binary.
This function is more complex than a normal comparator function because it works for cases where the ON time is
at the end of the day and when the OFF time is at the beginning of the day. such as for outdoor lighting applications.
Output
Current Time < OFF Time < ON
TRUE
Time
Current Time < ON Time < OFF
FALSE
Time
ON Time < Current Time < OFF
TRUE
Time
OFF Time < Current Time < ON
FALSE
Time
NOTE: You can also use Function 78: Convert HHMM to display sunrise and sunset times using Compass.
Function 78: Convert to HHMM (.bd6 and .bd9 only)
Converts time to HHMM format from Time input. Converts minutes since midnight to either 12- or 24-hour
HH:MM format.
HH24 = The hour of day for a 24–hour clock, 0–24.
MM = Minutes past the current hour, 0–59.
HH12 = The hour of day for a 12–hour clock, 1–12.
PM = This flag determines AM or PM for the 12–hour clock.
151
Job Setup & Engineering
All times are specified in minutes since midnight.
The input is considered modulo 1440 (60 minutes x 24 hours, the number of minutes in a day.)
Use Function 78 to indicate the sunrise and sunset times on a Compass display or template. To display time in 24–
hour format, use only HH24 and MM. To display time in 12–hour format, use HH12, MM, and PM.
BV is displayed as a read-only property with active text set to PM and inactive text set to AM.
Function 79: TRIG - Multi-Trigonometric Function (.bd9 only)
The TRIG function is a configurable, multi-purpose trigonometric calculation function.
Configuration parameters for the (x) Input are as follows:
• Units – Sets the units for the calculation (0=degrees, 1=radians)
• Cal – The Trig calculation to perform (1=sin, 2=cos, 3=tan, 4=csc, 5=sec, 6=cot)
• Hyp – Use the Hyperbolic form of Calculation (0=normal, 1=hyperbolic)
• Inv – Use the Inverse form of the Calculation (0=normal, 1=inverse)
There are also some cases where the Output cannot be calculated (or calculated accurately), in which case the
Reliability (Rel) Output will turn OFF and the (Output) value will get set to 0.
This produces a large number of possibilities. Some results can be stated in more than one way.
With hyperbolic = 0:
sin cos tan csc sec cot
inverse=0 sin cos tan csc sec cot
sin-1 cos-1 tan-1 csc-1 sec-1 cot-1
inverse=1
arcsi arcco arcta arccs arcse arcco
With hyperbolic = 1:
sin cos tan csc sec cot
inverse=0 sinh cosh tanh csch sech coth
152
Compass Workstation Interface User Guide PDF
sinh-1 cosh-1 tanh-1 csch-1 sech-1 coth-1
inverse=1
arcsin arccos arctan arccsc arcsec arccot
The non-inverse functions can all be built from sin, cos, sinh, and cosh:
tan = sin/cos tanh = sinh/cosh
csc = 1/sin csch = 1/sinh
sec = 1/cos sech = 1/cosh
cot = 1/tan =cos/sin coth = 1/tanh = cosh/sinh
Hyperbolic functions ignore the degrees/radians input.
Function 80: Atan2 (.bd9 only)
Computes tan-1(y/x) or atan(y/x). The output of Function 80 is between -π and + π.
There are also some cases where the Output cannot be calculated (or calculated accurately), in which case the
Reliability (Rel) Output will turn OFF and the (Output) value will get set to 0.
Units for the inputs can be set by user (0=degrees. 1=radians).
Function 81: FCR - Floor/Ceiling/Round (.bd9 only)
Multi-purpose value conditioning function producing integer value from decimal values.
153
Job Setup & Engineering
There is a user selectable Function (Func) Input that allow the user to determine whether the function will apply the
“Floor” (Func=1), “Ceiling” (Func=2), or “Round” (Func=3), calculation on the (x) Input value.
• Floor – Output = the highest Integer that is lower than, or equal to the x Input.
• Ceiling – Output = the lowest Integer that is higher than, or equal to the x Input.
• Round – Output = floor(x + 0.5) if x > =0 and ceiling(x - 0.5) if x < 0. This results in the typical
interpretation of rounding to the nearest integer.
Function 82: ABS - Absolute Value (.bd9 only)
Calculates the Absolute Value of (x).
Function 90: Psychrometric Chart (.bd9 only)
The Psychrometric Chart function is a multi-purpose function intended to give the user any easy way to calculate a
number of different values from the Psychrometric Chart.
The parameters for setting up the Psychrometric Chart function are as follows:
Units – Defines what units the function will use for calculations (0=English, 1=SI)
T db – Dry Bulb Temperature (in degrees F or degrees C, depending on units)
RH% - Relative Humidity
A pres - Atmospheric Pressure (in psia or kPa, depending on units)
Comp - Computation to perform. Options are as follows:
1 = Moist air enthalpy (English version) (Btu/Lbda or kJ/kga)
2 = Moist air enthalpy (SI version) (Btu/Lbda or kJ/kga)
3 = Moist air specific volume (Ft3/Lbda or m3/kga)
4 = Humidity ratio (Lbw/Lbda or kgv/kga)
154
Compass Workstation Interface User Guide PDF
5 = Wet bulb temperature (deg F or deg C)
6 = Dew point (deg F or deg C)
7 = Virtual temperature (deg F or deg C)
8 = Saturation vapor pressure (psia or kPa, valid for temps -148...392 deg F)
9 = Partial pressure of water vapor (psia or kPa)
Out – Output result of specified calculation
UnRel – The Unreliable Output indicates the currently calculated output might not be reliable/accurate due to inputs
being clipped (outside supported range).
Enthalpy Notes:
There are two separate calculations available for enthalpy because in English units, zero enthalpy occurs at zero
degrees F. In SI units, zero enthalpy occurs at zero degrees C. This results in two similar but different models.
Simple unit conversion does not work between the two.
To compute enthalpy as defined by ASHRAE, the English version should be used with English units and the SI
version with SI units.
However, enthalpy values are usually compared with one another rather than taken as absolutes, so it should not be
required to use one or the other. One use case for using the English version with metric units is to get extra range.
The English version calculates values down to 0 deg F (-18 deg C), but the SI version only works down to 0 deg C.
Calculations in SI units:
Except for SI version of enthalpy, all SI calculations are done by converting from metric to English, using the
English calculation and then converting back to metric.
Ranges:
Except where otherwise noted, this psychrometric chart function works over the following ranges.
Input data is clipped to these ranges (or other specified ranges) before doing further calculations. When clipping
occurs, the Unreliable output turns ON. This means that the output value is based on the clipped values, not the
original values input into the function. This can be interpreted as Not Reliable or as Best Available Data, depending
in customer preference.
In general, %RH is clipped to the range 0...100 for all computations. Individual function ranges are as follows:
Function min temp max temp min pressure max pressure
Moist air enthalpy 392 deg F (200 deg
0 deg F (-17.8 deg C) 1 psi
English) C)
Moist air enthalpy 392 deg F (200 deg
32 deg F (0 deg C) tbd tbd
(SI) C)
155
Job Setup & Engineering
Moist air specific -148 deg F (-100 deg 392 deg F (200 deg
tbd tbd
volume C) C)
-148 deg F (-100 deg 392 deg F (200 deg
Humidity ratio tbd tbd
C) C)
-148 deg F (-100 deg 200 deg F (93.3 deg
Wet bulb temperature 1 psi
C) C)
-148 deg F (-100 deg 392 deg F (200 deg
Virtual temperature tbd tbd
C) C)
-148 deg F (-100 deg 200 deg F (93.3 deg
Dew point
C) C)
Saturation vapor -148 deg F (-100 deg 392 deg F (200 deg
pressure C) C)
Partial pressure of -148 deg F (-100 deg 392 deg F (200 deg
water vapor C) C)
Function 91: ATM - Atmospheric Pressure Calculator (.bd9 only)
The Atmospheric Pressure Calculator function calculates atmospheric pressure, in the specified units, for a given
altitude.
Alt: Altitude in Feet or Meters depending on selected units.
Units: Selected Units to be used for calculation (0=English, 1=SI).
Pres: Atmospheric Pressure Output (psia pr kPa).
156
Compass Workstation Interface User Guide PDF
Rel: *Reliability of the calculated pressure value.
*Only accurate up to 30,000 feet (9144 m). At higher altitudes, a pressure is calculated, but Reliable output turns
OFF. This can be interpreted as Not Reliable or as Best Available Estimate.
Function 92: Interpolate (.bd9 only)
Does linear interpolation based on given data. Data points may be given in any order. Data is clipped to the input
range before interpolating, so the output value is always between the minimum and the maximum Yn values.
Function 92 has outputs to indicate when the input is outside the input range, allowing for cascading logic to make
bigger lookup tables. These can be ignored if the normal slipping is acceptable.
Input: This is the Input value to be interpolated.
These inputs indicate the 7 points (as x, y coordinates), used to calculate the interpolation. Such as:
X1 through X7: Points 1–7 x coordinates
Y1 through Y7: Points 1–7 y coordinates
Curve: *Type of curve to fit for interpolation (0=linear).
Output: Interpolated Output value.
X to High: Binary value indicating whether the x value is higher than the largest point on your defined curve.
X to Low: Binary value indicating whether the x value is lower than the smallest point on your defined curve.
*A curve algorithm currently supports zero value only, which results in linear interpolation.
157
Job Setup & Engineering
Function 93: UNPACK - Bit Unpacker (.bd9 only)
The Bit unpack function takes an analog value and "unpacks", or reads out the status of individual bits making up
that value. This function reads up to 8 consecutive bits from a specified starting bit, to allow for reading portions of
an analog value, or to allow "stacking" unpackers to read all the bits in larger numbers.
Data Value: Analog Value to unpack.
Start Bit (n): Specifies the first bit to read (typically 0, 8, 16, etc).
Bit n: Binary status of starting bit n.
Bit n + 1: Binary status of bit n + 1.
Bit n + 2: Binary status of bit n + 2.
Bit n + 3: Binary status of bit n + 3.
Bit n + 4: Binary status of bit n + 4.
Bit n + 5: Binary status of bit n + 5.
Bit n + 6: Binary status of bit n + 6.
158
Compass Workstation Interface User Guide PDF
Bit n + 7: Binary status of bit n + 7.
Function 94: PACK - Bit Packer (.bd9 only)
The Bit Pack function takes up to 8 separate binary values and "packs" them into different consecutive bits of an
analog value. The Start Bit parameter allows you to specify to which bit to start writing.
Data Output: Analog point to which new bit packed value is written.
Start Bit (n): Specifies the first bit to write (typically 0).
Bit (n): Binary value to be written to starting Bit n.
Bit n + 1: Binary value to be written to Bit n + 1.
Bit n + 2: Binary value to be written to Bit n + 2.
Bit n + 3: Binary value to be written to Bit n + 3.
Bit n + 4: Binary value to be written to Bit n + 4.
Bit n + 5: Binary value to be written to Bit n + 5.
Bit n + 6: Binary value to be written to Bit n + 6.
Bit n + 7: Binary value to be written to Bit n + 7.
159
Job Setup & Engineering
NOTE: If you need to pack more than 8 consecutive bits into a single analog value, you can "stack" bit packers by
having one packer start at bit 0 and going up to bit 7, then having a second packer start at bit 8 and going up to bit
15. The output of each Bit Packer needs to be written to an intermediate AV, then the intermediate AVs need to be
added together to get the final analog value result.
IMPORTANT! You CANNOT have multiple Bit Packer Functions write to the same analog value output, each Bit
Packer function completely overwrites the output analog value with only the bits getting packed from that function.
Function 95: Score (.bd9 only)
The Score function is designed to Activate up to 6 pieces of equipment (such as Rooftop Units), based on the
number of units desired to run, and the units score value (score would typically be something like runtime).
Determination on whether the highest or lowest scored equipment is activated first is user selectable.
# to Run: Specifies the number of units you want to run.
Enable n: Indicates the piece of equipment associated with the Run n output is available to run.
Score n: Specifies the score value for the piece of equipment associated with the Run n output.
Order: Specifies whether the Highest or Lowest scored equipment is started first (0=Highest and 1=Lowest).
Run n: Point indicating the specified piece of equipment should start running.
160
Compass Workstation Interface User Guide PDF
EXAMPLE:
Suppose we want to automatically choose 3 out of 5 rooftop units with the least amount of runtime and use those for
a week at a time. Each week, we want to reevaluate the runtimes and maybe choose different units to run. If
equipment breaks down, then we want to rotate in the most appropriate replacement immediately.
In this scenario, the inputs and outputs of the SCORE function have the following meanings:
• enable means unit is capable of running (for example, not broken down, disabled by operator, or
disabled due to self fault detection.)
• score is snapshot of the equipment runtimes, updated weekly
• n=3
• lowest = 1 (lowest score means lowest runtime)
• run n means to enable equipment n to be run at this time. I fit does not run, more logic is needed
to decide if this is a fault condition that should result in its enable input being turned OFF.
To avoid continuous rotation, the equipment runtimes must be sampled and held fixed during the week. The most
reliable place to store this information is in AVs.
Assume the equipment enable inputs are such that a user can force then OFF at any time. When an user enables any
given equipment, DDC may decide to override that decision due to sensor feedback. For example, if the unit has
161
Job Setup & Engineering
been supposedly running for 5 minutes, but sensor feedback says it is not running, this could force the enable input
to false, allowing other to be chosen.
For safety, assume that once a piece of equipment is disabled, it requires user intervention to re-enable it. Letting
the system automatically decide to re-enable the equipment could lead to undesired cycling.
With this scheme, the current set of equipment runs as-is until one of the following occurs:
• The next rotation command is given, new runtimes are sampled, and some equipment may get
rotated as a result.
• One of the Enable inputs changes from ON to OFF. This could be due to a user command or due
to automatic equipment failure detection. A new piece of equipment get rotated into its place
immediately.
• One of the enable inputs changes from OFF to ON due to user input. Then the newly enabled
equipment may have less runtime than one of the currently running ones, resulting in immediate
rotation.
Viewport Programming
Programming Viewport Displays
The Compass Viewport is a compact operator terminal for BACnet systems. It enables an occupant or technician to
view and command properties in a BACnet-compliant system from a convenient, wall-mounted unit. The Viewport
has a 4-line by 20-character backlit LCD display and simple pushbuttons to navigate through displays and issue
commands for properties.
You can create Viewport displays using Compass’s Viewport display editor (Edit > Viewport Displays). When you
create Viewport displays, you work with a single file. Codes in the file determine where displays begin, where data
appears, and where jumps to other displays appear on the Viewport LCD. Other special codes define passwords and
configuration information. These are also encoded in the display file, but don’t appear to the Viewport user. See the
Viewport Installation & Operations Guide for more details.
Compass saves display files ( viewport.dsp ) to the workstation hard disk. To work with display files, files must be
saved in the appropriate subdirectories of Compass folder (as indicated below) and be named correctly. Compass
saves and loads files here automatically.
< Compass root>\<rep>\<job>\ dev<viewport device instance>
To load a display file from a Viewport
You may need to edit a Viewport display from time to time. Before you can edit it, you must load it from the
Viewport into the display editor in Compass.
1. On the Edit menu, click Viewport Displays to open the Viewport display editor.
2. On the File menu in the Viewport display editor, click Load from Viewport.
3. Type the device instance of the Viewport or select it from the list, and then click OK. Compass loads the
display file from the Viewport into the display editor.
162
Compass Workstation Interface User Guide PDF
To load a Viewport display file from disk
If you have Viewport displays saved on a hard drive or disk, you can load them into the display editor to modify
them or to send them to a Viewport.
1. On the Edit menu, click Viewport Displays to open the Viewport display editor.
2. On the File menu, click Load from Disk. Compass prompts you for the device instance of the Viewport you
are working with.
3. Type the device instance of the Viewport or select it from the list, and then click OK.
To save a Viewport Display file to disk
After modifying a Viewport display, you can send it directly to a Viewport or save it to a disk for later use.
1. On the File menu in the Viewport display editor, click Save. Compass saves the file to the workstation’s hard
disk and prompts you to send the file to the Viewport.
2. Click OK to save and send.
To send a display file to the Viewport
After modifying a Viewport display, you can send it directly to a Viewport. Compass simultaneously saves the file
to the operator workstation’s hard disk.
1. On the Edit menu, click Viewport Displays to open the Viewport display editor.
2. On the File menu, click Send to Viewport.
3. Type or select the device instance of the Viewport where you want to send the display, and then click OK.
Backing Up Job Data
Backing Up Files for a Job
Compass’s backup utility (Tools > Backup > Backup Job) enables you to quickly create a backup image of the
active job, and then restore it when necessary. You can also schedule regular backups (Tools > Backup > Schedule
Backups). It is a good idea to back up your jobs regularly.
Backup saves all the files for a selected job to a zip file format (*.zip). You can then run the Compass Restore
Utility to restore the files to their appropriate locations in your Compass program directory. Start the restore utility
from the Compass program folder on the Windows Start menu.
Backup creates information files in the rep/job directory you back up and saves them within the backup zip file
itself:
1. Backup.log contains an entry for each file backed up, with the file name and the date and time the file was last
saved.
163
Job Setup & Engineering
2. Backup.info contains a single entry with information about the backup: the date and time it occurred, the
rep/job that was backed up, the source directory (usually the same as the rep/job), and the destination zip file.
User Management
About User Profiles
A user’s access to Compass functions and features depends on the privileges and security level defined in the user
profile. Information defined in the user profile includes the user name (an optional identifier) and user ID. The user
ID is also used to identify operations in the User Activity Log.
About the User Activity Log
The User Activity Log (View > User Activity) enables you to monitor activity throughout the BACnet internetwork
for the current job. For each activity, the operation performed is shown, along with the date/time the operation was
performed; the user ID of the user logged in when the action occurred; and the old value and new value, if
appropriate. View the List of Logged Events for details.
You can also open the User Activity Log from a data display. For example, to check who turned a fan on, right-
click a dynamic item on a display and click User Activity on the context menu. The user activity log opens, with
entries confined to the selected item.
You can view current data or select an archive file to view.
You can view activity by user or date and time range. You can filter and sort the information in the User Activity
log depending on what you want to see. For example, you can type a user ID in the box, and then click Lookup User
or Reset Filter to view only activity by that user.
To archive user activity data, click Archive Data on the file menu. The Archive User Activity dialog box appears.
Click Print on the File menu to send a copy of the user activity log to a printer. Only activity during the defined
User activity time interval is printed.
To archive user activity
Compass enables you to archive user activity data to an Access (*.mdb) file. You can import the file into a
spreadsheet or database program if you ever need to analyze the data.
Caution! Make sure you do not inadvertently delete data or copy over an existing log. Choose options
carefully. You will not be prompted to confirm.
1. On the View menu, click User Activity.
2. Select Archive Data from the File menu.
3. In the Archive settings group box, select how often you want to archive data (archive period).
4. Select Auto-archive to automatically archive at the chosen archive period. If the box is not selected, then
archiving must be manually initiated by clicking Archive Now.
164
Compass Workstation Interface User Guide PDF
5. Select Replace/append... to replace/append data to the existing archive file for that period. If the option is not
checked, then archiving is skipped if the archived file already exists.
6. Select All but the most recent... to purge old data from the current database, and define the number of periods
to retain in the database. For example, to keep the last three months worth of data when using a Monthly Archive
period enter ”3” in the box.
7. Select Archive all entries... to archive all data in the current database, not just the period selected in the
Archive period combo box. This is useful to avoid data loss.
8. If you want to archive data now, select the dates for data you want to archive, and then click Archive Now.
User Activity Log, Logged Event Reference
The following system events will cause an entry to appear in the user activity log.
1. Compass startup (date/time)
2. Compass shutdown (date/time)
3. User login/logout (date/time/user)
4. Change values from Compass displays (date/time/user/point/old value/new value)
5. Change displays/templates (date/time/user/display or template number)
6. Changes made in the web interface (changing alarms, changing a point value, editing a schedule, and so on)
Alarm Setup
1. Change Alarm Site Description (date/time/user/old value/new value)
2. Change Printer (date/time/user/old value/new value)
3. Enable/disable printing (date/time/user/old value/new value)
4. Enable/disable print user acknowledgements (date/time/user/old value/new value)
5. Change generic handling (date/time/user/old value/new value)
New Alarm Wizard
1. Add alarm (date/time/user/ Object=modified event enrollment object)
2. Alarm handlers (see below)
Point Alarm Setup
1. Add/delete (date/time/user/ Object=modified event enrollment object/ Point=monitored property).
2. Changes to event enrollment objects
Scheduled Points: Each schedule component logged separately
1. Add/delete scheduled point (date/time/user/ Object=modified schedule/ Point=controlled point). Note:
controlled point is logged only if point was used to locate schedule.
2. Modifications (date/time/user/ Object=modified schedule)
Alarm Handlers/Log Handlers/Raw Notification Classes
1. Add/delete handler--notification class (date/time/user/Notification Class)
2. Changed settings (date/time/user/Notification Class)
3. Pager entry additions/deletions (date/time/user/process I.D./description)
165
Job Setup & Engineering
Add User
1. Add/delete user (date/time/user/userid that was changed)
2. Change user settings (date/time/user/userid that was changed)
Add Group
1. Add/delete group (date/time/group that was changed)
2. Change group settings (date/time/group that was changed)
Global Controller/Building Controller DDC, VLC DDC, and Advanced VLC DDC
1. Save DDC file
2. Send DDC to device
Device Manager
1. Add/delete/change device records (date/time/user/device inst/description)
2. Load/save device data for each device (date/time/user/ dev inst)
BACnet Object Editors
1. Add/delete (date/time/user/object/instance/description)
2.
Compass Reports
1. Add/delete report (date/time/user/report description)
2. Change report (date/time/user/report description)
3. Copy report or add new (date/time/user/report description)
Trendlogs
1. Change trendlog (date/time/user/)
2. Add/delete trendlog (date/time/user/trend host/trendlog instance)
3. Purge (date/time/user/trend host/trendlog instance)
4. Archive (date/time/user/trend host/trend instance)
Energy Logs
1. Add/delete program (date/time/user/program number/description)
2. Change energy report program (date/time/user/program number/description)
Default Rep/Job
1. Set Default Rep/Job (date/time/user/old value/new value)
2. Create site key (date/time/user)
Viewport
1. Save display file (date/time/user)
2. Send display to device (date/time/user)
166
Compass Workstation Interface User Guide PDF
General System Setup
Identification tab
1. Change device instance (date/time/user/old value/new value)
2. Change device name (date/time/user/old value/new value)
3. Change device description (date/time/user/old value/new value)
Network tab
1. Enable/disable offline mode (date/time/user/old value/new value)
2. Edit network number (date/time/user/old value/new value)
3. Change primary Ethernet adapter (date/time/user/old value/new value)
4. BACnet protocol (date/time/user/old value/new value)
5. Enable/disable Annex J BACnet/IP (date/time/user/old value/new value)
6. Edit PTP virtual net (date/time/user/old value/new value)
7. Change APDU timeout (date/time/user/old value/new value)
8. Change APDU seg timeout (date/time/user/old value/new value)
9. Change APDU retries (date/time/user/old value/new value)
10. Enable/disable read property multiple (date/time/user/old value/new value)
11. Change Site configuration--client or primary workstation, primary workstation device instance/ primary
controller device instance (date/time/user/old value/new value)
12. Change Annex J BACnet/IP configuration--Local UDP port, BACnet network number, BBMD IP, BBMD
UDP, and re-registration interval (date/time/user/old value/new value)
Time Sync tab
1. Change Time Sync settings (date/time/user/old value/new value)
2. Manually initiate Time Sync--Send Now (date/time/user)
3. Change Time sync recipient list (date/time/user)
Preference tab
1. Change active/Inactive/date default text (date/time/user/old value/new value)
Startup/Shutdown tab
1. Enable/disable auto login (date/time/user/user/old value/new value)
2. Change start display (date/time/user/user/old value/new value)
3. Enable/disable shutdown by authorized user only (date/time/user/old value/new value)
4. Enabling or disabling auto logout
5. Modifying auto logout time
6. User automatically logged out after a time out (auto logout)
Tenant Activity
1. Adding, changing, or deleting a tenant profile
2. Adding, changing, or deleting a tenant zone
3. Adding, changing, or deleting a property manager profile
4. Changing or purging tenant override events
5. Changing tenant billing email settings
167
Job Setup & Engineering
Optimum Start/Zones
1. Creating a zone
2. Deleting a zone
3. Modifying a zone
4. Modifying Optimum Start parameters
Demand Limiting
1. Adding, changing, or deleting a demand limiter object
2. Enabling or disabling a demand limiter object
3. Adding a point to a demand limiter object
4. Removing a point from a demand limiter object
To create a user profile
When you create a new user profile, by default that user has no privileges and the security level is 0. You must then
set the user’s privileges and security level.
1. On the Tools menu, click Users and Groups.
2. In the Users and Groups dialog box, click Add.
3. Type a user ID. Use a maximum of 40 alphanumeric characters (you can also use an underscore).
Note The user ID is saved in all upper case letters regardless of how it’s typed.
4. If you are not using LDAP, type a password for the new user. The password is case-sensitive and must be at
least 8 but not more than 20 alphanumeric characters (no special characters).
Important: LDAP users must be configured as Unrestricted Account in the Authorized Period field.
5. Type the password again to ensure you typed it correctly.
6. Click OK.
7. In the Users and Groups dialog box, type a new user name. Use up to 80 characters.
8. Set the user’s security level from 0 to 10.
9. If you want to set a specific starting display for this user, click the command button in the Starting display field,
and then select a data display or display template.
10. Select the privileges for the user.
To edit a user profile
To edit a user profile
1. On the Tools menu, click Users and Groups.
168
Compass Workstation Interface User Guide PDF
2. On the Users tab, select the user profile you want to edit. If you select more than one user profile, the Edit
button is disabled.
3. Click Edit.
Field Description
User ID Select the user you want to edit.
Name Type a descriptive name for each user. Maximum of 80 alphanumeric characters.
Type a description of each user. For example, job title, location or building name. Maximum of
Description
80 alphanumeric characters.
Select this option if the user will be authenticated by an LDAP server. Configure the server on
LDAP User
Tools>General System Setup>SSL and LDAP.
Security level Specify a security level for each user between 0 and 10. Zero is no access.
The security level Compass uses to determine if the user has access to certain display items. The
Effective
highest security level in the user’s profile or any of the group profiles for which the user is a
security level
member.
Type a password for each user. Passwords are case-sensitive and must be a minimum of 3 and a
maximum of 20 alphanumeric characters.
Password
Note: Only administrators can change passwords from the Edit User dialog box. To change your
own password, click Compass>Login/Logout>Change Password.
Confirm
Confirm the password.
password
Specify a start display for each user, or leave blank and the user’s start display will be the system
Start display
default start display. Start display may also be determined by group membership.
If there is a Start Display defined for this User Profile, it will be the Effective Start Display. If a
Effective start Start Display is not defined but the User Profile has a Primary Group assigned and that group has
display a Start Display, it will be the Effective Start Display. If neither is true, the Effective Start Display
is the default Start Display for the Rep/Job.
Authorization Specify either an unrestricted account or define an expiration date. System access will expire on
Period the defined date when the primary workstation strikes midnight.
169
Job Setup & Engineering
To delete a user profile
1. On the Tools menu, click Users and Groups.
2. On the Users Tab, select the user profile or profiles you want to delete, and then click Delete.
Users and Groups Dialog Box
Use this dialog box (Tools > Users and Groups) to define users and groups for your Compass system.
Users tab
The list is initially sorted by User ID, click a column heading to change the sort order.
Add Opens the Add User dialog box.
Opens the Edit User dialog box. This button is only enabled when a user (and only one) is
Edit selected.
Opens the Add User dialog box pre-populated with the selected user’s profile. The only fields
Copy not populated are the User ID and Password fields.
Groups tab
The list is initially sorted by the ID, click any column heading to change the sort order.
Add Opens the Add Group dialog box.
Opens the Edit Group dialog box. This button is only enabled when a group (and only
Edit one) is selected.
Opens the Add Group dialog box pre-populated with the selected group’s profile and
Copy the group ID blank.
Reports
Setting Up a Compass Report
When you set up a report (Compass > Reports > Add | Edit), you select the pre-defined report you want to generate
from the Report Name list. Different options then appear for the type of report you select.
Understanding Print Frequency and Print/Separator Date/Time
Click Set under Print/Separator Date/Time to control the range of data and the precise printing time for the report.
Options depend on the report's Print Frequency.
170
Compass Workstation Interface User Guide PDF
The Print Time is the month, day, date, and time the report will print. Because reports recur on an hourly, daily,
weekly, or monthly schedule, use portions of the print time to set recurrence. For example, an hourly report set up to
print on April 2 at 8:00 a.m., will print at 8:00, 9:00, 10:00, and so on. A daily report with the same setting will print
every day at 8:00 a.m. A weekly report will print every Monday at 8:00 a.m. (since the date selected is a Monday).
And a monthly report will print on the second of every month at 8:00 a.m.
The Separator Time is the date and time of the last sample you want to include in the report when the report prints.
It must be a date and time earlier than the Print Time. The Separator Time updates for each subsequent printing of
the report based on the report frequency
For example, you set up a report to print on Monday, April 2, 2001 at 8:00 a.m. You choose a separator date of
April 2, 2001 at 7:00 a.m. If setup as an hourly report, when the report prints at 8:00 a.m., it includes data from 6:00
a.m. through 7:00 a.m.; when it prints at 9:00 a.m., it includes data from 7:00 a.m. to 8:00 a.m.; and so on. If it's a
weekly report, it includes data from Monday, March 26, at 7:00 a.m. through Monday, April 2, at 7:00 a.m.; when
the report prints the next Monday, it includes data from May 7 to May 14; and so on.
Printer and Export Options
You can save your report to a file or print to a Windows printer set up in the Windows Control Panel.
Save to File - Compass names the file for you and saves it in <Compass root>/<rep>/<job>/Archive/Reports. You
can generate a Microsoft Excel file (*.xls) or a rich text file (*.rtf).
Caution! Compass overwrites previously saved files each time it saves. Previous reports are lost. To save
old reports, rename or copy them to a different folder.
Print to Printer - Compass generates a print job and sends it to the Windows printer that you select from the list.
Available Reports
The reports available in Compass provide information useful in troubleshooting and understanding your system.
Alarm Handler Lists the devices configured as alarm handlers and shows the configuration of each handler.
Alarm Lists the recipients of alarms and shows the configuration of each recipient.
Recipients
Demand Lists the demand limiters set up in the system and shows the configuration of each demand
Limiters limiter.
Device List Lists the devices in the system and shows the configuration of each device.
Energy Logs Lists the energy logs set up in the system and shows the configuration of each log.
Energy Meters Lists the energy meters set up in the system and shows the configuration of each meter.
Shows the configuration settings from General System Setup.
General
171
Job Setup & Engineering
System
Point Alarms Lists the alarms that are set up in the system and shows the configuration of each alarm.
Schedules Lists the schedules that are set up in the system and shows the configuration of each schedule.
Tenants Lists the tenants that are set up in the system and shows the configuration of each tenant.
Trendlogs Lists the trendlogs that are set up in the system and shows the configuration of each trendlog.
Trendlog Lists the trendlog handlers that are set up in the system and shows the configuration of each
Handlers trendlog handler.
VAV Balances Lists the VAVs that are set up in the system and shows the configuration of each VAV.
Zones Lists the zones that are set up in the system and shows the configuration of each zone.
172
Editing Displays and Templates
About Displays
Creating a Display Scheme with the Display and Template Editor
The display scheme you customize for a site is critical. It presents users with on-screen tools to control and monitor
Compass system parameters and equipment operation. Users can simply point and click an on-screen tool to
command facility equipment controlled by any BACnet device.
An eight-digit number identifies each display, device template, and object template you create so it can be
referenced and summoned by push buttons on other displays.
You create a display scheme screen-by-screen. You design each display from scratch - specifying a background,
placing control and feedback items, placing push buttons so the user can view other displays or templates, and then
saving the display to the job directory. All displays have a background, which can be either a solid color or a
graphics file. Supported graphic formats are .png, .gif, and .jpg.
Displays can be viewed only in the web interface.
Displays are created and edited on a workstation. You can change only those values and command parameters for
which you have sufficient privileges. While editing displays, you can place items on the display and assign them to
BACnet properties; you can change the background; and you can move, delete, and copy items between displays
and templates.
Navigation Tree
When you view a display, the navigation tree expands from the tool menu at the left of the display. Click the
navigation icon to open it.
The tree is created using data from a spreadsheet file on the Compass primary workstation. This file can be edited in
Excel. See the Display Developer’s Guide (available on the Alerton Support Network) for more information.
About Data Displays
Data displays typically give users general information or choices, serving as springboards to more specific data
displays, device templates, and object templates.
Although a data display can present specific operating data from a device, most often this job is left to device
templates and object templates. Templates save time by allowing you to use one file for multiple devices or objects.
About Device Templates
Device templates are powerful because a single device template can present operating data from any number of
similar BACnet devices. The key to this is the pushbutton that summons the device template. This pushbutton
"passes" the device instance to the template. Dynamic items on the template can be set up to use this passed device
instance.
About Object Templates
Object templates are similar to device templates. Use them when you want to view the same properties in any
number of similar objects. For example, the device object has properties that give users critical information about a
173
Editing Displays and Templates
device. You can set up one object template that shows all the properties of the device and use it again and again for
all devices of the same type.
Each pushbutton that summons an object template passes a unique object instance number to the template. The
dynamic items on an object template can be set up to use this passed object instance number.
About the Start Display
The start display is the first data display that appears when you start Compass. If you specify the numeric ID of a
start display in the General System Setup dialog box, Compass opens with that data display.
You can also set a user-specific start display in the User Setup dialog box. You can either specify the numeric ID of
a data display or the numeric ID of a display template along with a device instance to associate with that template.
Compass opens with that data display when the user logs in.
If Starting Display is blank in the User Setup dialog box, the start display specified in General System Setup is
used. If Start Display is blank in the General System Setup dialog box, then Data Display 1 is used as the starting
display.
Display Editing Basics
Using the Display and Template Editors
Note: When editing displays from a client workstation, you must set the rep/job data location to the primary
workstation (Tools > Set Rep and Job > Options > Data Location).
Use the Compass display and template editors to reconfigure or create displays and templates. To edit in the active
display window, on the Edit menu click Data Displays. To open a new window, click Edit > Data Displays, Object
Templates, or Device Templates on the menu bar.
To view the changes, click Edit and then click View in Web UI.
Note: In edit mode, dynamic items show invalid data.
Choosing a Display to Edit
While working in a display or template editor, you can quickly navigate between displays or templates using the
Display Info dialog box. You can also edit a template by setting up a pushbutton for the template and then clicking
the Edit Template button in the Pushbutton Item dialog box.
To make the Display Info dialog box available, on the View menu select Display and then click Display Info.
To open a display for editing
1. From the Edit menu, click Data Displays. The current user's top display opens in the Data Display Editor.
2. To select a different display to edit, type the display number in the Display Info dialog box and then press
Enter.
OR
174
Compass Workstation Interface User Guide PDF
Click Edit->View in WebUI, navigate to the display you want to edit, and then click Edit Current Display
in the Compass menu on the left.
Note: The Compass menu is available only if the browser is launched from Compass.
3. From the Edit menu, select View in WebUI, navigate to the display you want to edit, and then
click Edit Current Display.
Using the Display Info and Template Info Dialog Boxes
By default, the Display Info dialog box appears in the lower right of your screen when editing a data display. This
small dialog box shows you the number of the display currently shown. It also enables you to choose a different
display from the same job folder as the current display or template. Information about the grid position and size of
the item you select also appears in this dialog box. This can be useful if you are having trouble aligning items or
sizing them to match other objects on a display.
To view the Display Info dialog box, from the View menu point to Display and then select Display Info.
Moving and Sizing Items on a Display
Once you have selected an item or group of items while editing a display, you can click and drag to move the item
or group of items to another location on the same display. If you are moving a single item, make sure you click in
the center of the selection box. You can also size individual items.
Note: A group of items cannot be sized together.
To move an item
1. Click and hold in the middle of the item or group of items so that it is bound by a dotted line and the mouse
pointer appears normal. As you drag the mouse, a silhouette of the item appears.
2. Position the silhouette where you want the item to appear, and then release the mouse button.
To size an item on a display
1. Select the object to display the selection box and handles.
2. Click and drag one of the handles--a side handle to size horizontally, a top or bottom handle to
size vertically, or the corner handle to size both--until the object is the size you want.
Setting a Descriptor for a Display or Template
When you create a descriptor for a display or template (Edit > Display Selector), you type the text that appears
beside the display or template when you choose Display > By Descriptor from the View menu in edit mode.
Tip: Establish a descriptor for every display and template you create that conveys its function. This way,
you can choose to go to displays by descriptor, and when you establish pushbuttons to access a display, you
have a built-in quick reference.
175
Editing Displays and Templates
Setting Snap-to-grid Settings
Every position on a display or template maps to an invisible "X, Y" grid. You can adjust this grid so that objects
snap to it while you design (View > Display > Snap). The unit of measure for this grid is pixels. Every position is
expressed in terms of {X,Y}, where X is the horizontal position and Y is the vertical position in pixels. For
example, {0,0} indicates the upper left corner of the display.
When you set the grid, type a horizontal snap value and a vertical snap value. These determine the pixel increments
in which you can move and size items vertically (up and down) and horizontally (left and right). Objects "snap to"
the grid setting you select. The coarser your grid--that is, the greater the pixel settings--the more you notice this
"snap to" effect. A value of 1 effectively turns off grid snapping.
As a general rule, it’s easier to align objects when the grid is coarser, but harder to fine-tune their placement.
Experiment with grid settings until you find the setting you are most comfortable with.
Important! Any changes you make to grid settings remain until you change them again. If you create
displays with one grid setting and then edit them with another, it will be difficult to align objects. If you
must change grid settings, make sure the new and old grid settings share a divisor, and the new grid settings
are less than the old ones.
To place and configure a new item on a display or template
1. On the Place Item menu, click the type of item you want to add to the display or template you are editing. The
cursor appears as a rectangle.
2. Position the cursor where you want the upper left corner of the item to appear on the display and click once.
The item now appears on the display or template.
3. To position the item relative to other items, right-click it and then select Bring to Front or Send to Back.
4. Double-click the item to set it up. For information about how to set up a particular type of item, click Help in
the item's setup dialog box.
Selecting Items on a Display
While editing data displays and templates, you can select one item at a time by clicking the item. To select a group
of items, click an unoccupied area of the data display and drag the cursor. A selection rectangle appears. When you
release the mouse button, any items within this rectangle or touching its borders will be selected.
To add an item to a group of selected items, shift+click on it.
A selected item is bound by a selection box, which appears with six squares, called handles. You can use these
handles to size the item. When you select items as a group, you can move the items and retain their spacing. You
can also copy a group of items to another region of the display or from one display to another.
To reconfigure a display item
In edit mode, double-click an item to display its setup dialog box. Click Help in the setup dialog box for more
information about configuring that type of item.
176
Compass Workstation Interface User Guide PDF
Changing the Font and Color of Items on a Display
You can change the formatting of individual items in the setup dialog box for the item, or you can change the
formatting of a group of items simultaneously using the Format Text menu.
Note: If you are creating data displays on a computer other than the one where they will be used, pay close
attention to the fonts you use for items. Try to use fonts that are commonly available -- MS Serif (for a serif
font) and MS Sans Serif (for a sans serif font) are good choices because they ship with Windows. If the
fonts you choose are not available on a computer, another similar font is substituted and the display may
not appear as planned. See Windows documentation for more information about fonts and font substitution.
To change the font and color of an individual item on a display
1. Double-click the item whose font you want to change to display the item’s setup dialog box.
2. Click Font on the menu bar. The Font dialog box appears, with options for choosing font and
formatting options for the text, along with a preview of what your selection will look like.
3. Select formatting options, and then click OK.
4. From the Color menu, choose one of the following options.
Foreground - Change the color of text.
Background - Change the color of the item’s background.
Alarm Color - Change the color of the item when the data point or control panel it references is in alarm
(typically red).
Active Color - If applicable, change the color of text displayed when the referenced property is ACTIVE
(ON).
Inactive Color - If applicable, change the color of text displayed when the referenced property is
INACTIVE (OFF).
NULL Color - If applicable, change the color of text displayed when the referenced property is NULL.
The Windows color palette appears, depicting basic colors and custom colors, which you can define.
5. Click once on the color you want to use or choose Define Custom Colors to create a new color.
6. In the setup dialog box, click Close.
7. Size the item on the data display until it appears as you want it.
Note Text boxes will not automatically resize to accommodate the font you select.
5. Click OK.
To change the font or color of a number of items simultaneously
1. Select the objects whose font and color you want to be the same.
2. On the Format menu, point to Text, and then select options according to the following guideline.
Foreground - Change the color of text.
Background - Change the color of the item’s background.
Alarm Color - Change the color of the item when the data point or control panel it references is in alarm
(typically red).
Active Color - If applicable, change the color of text displayed when the referenced property is ACTIVE
(ON).
Inactive Color - If applicable, change the color of text displayed when the referenced property is
177
Editing Displays and Templates
INACTIVE (OFF).
NULL Color - If applicable, change the color of text displayed when the referenced property is NULL.
3. Size the items individually until they appear as you want them.
4. Click OK.
Cutting, Copying, and Pasting Items on a Display
After you select an item or a group of items on a display in edit mode, you can cut or copy them and place them on
other displays or templates. Cutting an item removes it from its original position; copying an item does not. Once an
item is cut or copied, it can be pasted any number of times to any number of displays or templates.
Note: Compass uses the Windows Clipboard when you cut or copy. Therefore, if you use the cut or copy
command in another application, the items in Compass are not saved. Compass does not support copying
and pasting between applications.
To cut or copy items on a data display and then paste them
1. Select the item or items you want to cut or copy.
2. On the Edit menu, click Cut or press CTRL+X to cut the items. Or, click Copy or press CTRL+C to copy
the items.
3. View the display to which you want to paste the items.
4. On the Edit menu, click Paste or press ctrl+v.
The mouse pointer appears as a black rectangle.
5. Position the upper left corner of the rectangle, and then click once. The items you cut or copied appear on
the display or template.
6. Repeat steps 4 and 5 for all the displays or templates to which you want to paste the items.
To copy an entire display and paste it to a new display or template
1. View the display you want to copy.
2. On the Edit menu, click Copy Display.
3. View the display to which you want to paste, and then click Paste Display from the Edit menu.
4. Click Yes to copy the items and background from the original display to the current display, overwriting all
other items.
Using the Repeat Item Command
The Repeat Item command (Edit > Repeat Item) is a time-saving tool that is useful if you place a number of items
that are functionally similar but reference unique elements. For instance, you could use the Repeat Item command
to create a single feedback item for an AV property in a particular device and make another 20 feedback items, each
referencing the same AV property in subsequent devices.
1. Select the item you want to repeat, right-click the item, and then select Repeat Item from the context menu.
The Repeat Item dialog box appears.
2. Set your options and then click Do it.
178
Compass Workstation Interface User Guide PDF
Number of The number of copies of the item you want to make.
Copies
Use this box to change the Resulting Pixels Between Items. By default, the Total Item Spacing
accounts for no spacing between items. To change the pixels between items, determine the
Total Item amount of spacing you want between items in pixels. Multiply this by the number of copies you
Spacing are making. Then add this to the default spacing. If the number you type is not valid, it will
default to the next lowest valid number.
Increment Select an increment option.
Subsequent copies of the item increment the device instance by one. For example, subsequent
Device copies of an item that references the present-value property of AI Object 6 in Device 14 will
Number reference the present-value property of AI-6 in Device 15, 16, 17, and so on.
Subsequent copies of the item reference the same property and object type, but from the next
Object highest object instance. For example, subsequent copies of an item that references the present-
Instance value property of AI Object 6 in Device 14 will reference the present-value of AI Object 7, 8, 9,
and so on in Device 14.
Available only when the object being copied references a priority-array index number. For
Array Index example, subsequent copies of an item that references Device 1, BO-1, priority-array[1] will
reference priority-array[2], priority-array[3], and so on for the same device and object.
Increment by one any numerals in the text that appear on the item. For instance, subsequent
Text Items copies of a pushbutton that reads "Room 10" will read "Room 11," "Room 12", and so on. It
makes no difference where the numerals appear in the text.
Select the Down option to copy the item down or select the Across option to copy the item across
Direction the display.
Setting the Order of Overlapping Items
When items overlap on a display, you can configure how they appear in relation to each other. Compass gives you
two tools, Send to Back and Bring to Front, to set this order. To set the order in which items appear, right-click an
item and select an option from the context menu.
To stack several objects in order, select the object you want on top and then send it to the back. Repeat this step in
the order you want the items to appear. When all items have been sent to the back, they will appear in the desired
order.
Note: Omnigraphics will appear behind other items. They cannot be brought to front.
179
Editing Displays and Templates
Placing Items on a Display
Placing a Plain Text Item
Plain text items provide heading information or labels. Plain text items do not reference dynamic system properties
and are static.
To set up a plain text item
1. While in Edit Mode, click Place Item and then click Plain Text
2. Place the item on the display and then double-click it.
3. Use the Font menu item to change the font of the text.
4. On the Color menu, click Foreground to change the color of the text and click Background to change the color
of the background for the text.
5. Select a justification - left, right, or center.
6. Click Close.
Selecting a Background
A display or template can use a graphic file or a solid color as a background. Backgrounds can also be transparent.
You can use a commercial graphics editing program to edit an image and then save it to use as a background.
Graphic files used as backgrounds can be saved in any local or network folder accessible to the Compass
workstation. Recommended formats are .png, and .gif. Compass also supports .jpg files.
Caution! Do not move or delete a graphic file after you place it as a background because Compass stores a
pointer to the file to speed performance.
Using an image file as a background
1. Open the display or template in the editor (Edit > Displays).
2. On the Format menu, point to Background, and then click Image File.
3. Under Image Location, select the option that corresponds to where the graphic file is saved.
4. Click the command button in the Filename area to view a list of graphic files in that folder.
5. Select a file from the list, and then click OK.
Using a Solid Color as a Background
1. Open the display or template in the editor (Edit > Displays).
2. On the Format menu, click Background.
3. Under Background Color, select Color.
4. Select a color using the color picker.
Using a Transparent Background
1. Open the display or template in the editor (Edit > Displays).
180
Compass Workstation Interface User Guide PDF
2. On the Format menu, click Background.
3. Under Background Color, select None.
Setting Up a Graphical Item
Graphical items (Place Item > Graphical Item) convey status information or mimic real-time equipment operation.
Graphical items use a graphic or series of graphics. You can use Alerton Standard graphics or create your own and
save them in the Bitmaps subdirectory of your rep/job folder.
Four types of graphical item are available: User binary item, User analog item, and Omnigraphic. Place the item on
the display, and then double-click it to set it up.
User Binary Item
A still graphic that portrays the status of a binary property. For example, the present-value of a BI can be ACTIVE
or INACTIVE. You assign graphics to display for each state. This type of graphic is not animated. Supports .png,
.jpg, and .gif files. More information
User Analog Item
A still graphic that displays one of five graphics based on an analog property. Supports .png, .jpg, and .gif files.
More information
Omnigraphic
Omnigraphics help you transform background images into interactive controls and to communicate system status
visually. Supports .bmp, .png, .jpg, and .gif files. More information
User Image
A simple, static image that is not linked to an object. Utilize user images for logos, informational graphics, and
other applications that do not require a link to an object. More information
Placing a User Binary Item
A user binary item (Place Item > Graphical Item > User Binary Item) has four different bitmaps that correspond to a
binary data point’s status: ACTIVE (ON), INACTIVE (OFF), Alarm ON, and Alarm OFF. You can set up the
graphic to be commandable or read-only. For commandable items, a user with sufficient security can click the
graphic to toggle the status of the data point.
You can use your own bitmap for each status, or you can click the Standards button to quickly set up standard
bitmaps--pilot lights, panel lights, switches, and heating status bars.
Place the item on the display, and then double-click it to set it up.
Setting Up a User Analog Item
A user analog item (Place Item > Graphical Item > User Analog Item) displays a different graphic depending on the
value of a property. You can specify as many as five graphics and the corresponding range for which each graphic
is displayed. You can also specify as many as three alarm graphics—high, low, and other. If the value of the
181
Editing Displays and Templates
property exceeds the high limit, the high alarm graphic appears; if the value is below the low limit, the low alarm
graphic appears; if any other condition causes the alarm, the other alarm graphic will appear.
When you set up a user analog item, you establish crossover points. A crossover point is the value at which the next
graphic displays. Then, when you assign graphics, the range for which each graphic will be displayed is listed
beside it. You can change this range by changing the corresponding crossover point.
Place the item on the display, and then double-click it to set it up.
Setting Up an Omnigraphic
Omnigraphics help you transform background images into interactive controls and to communicate system status
visually. For example, an omnigraphic used to represent a room in a floor plan can change color based on space
temperature - red if it is too warm and blue if it is too cold. When the value of the associated point is NR, the
omnigraphic turns gray.
Omnigraphics can also display the point value and allow users to access context menus related to the monitored
point.
Because they are constructed of lines and curves, omnigraphics can fit irregular regions. They can also be made
partially or completely transparent. Links added to omnigraphics enable a user to open a URL, template, or display
by clicking the omnigraphic.
To set up an omnigraphic, you define it, add navigation (optional), and configure its appearance.
Defining an Omnigraphic
1. Open a data display in the Compass workstation's Display Editor. See Choosing a Display to Edit.
2. From the Place Item menu, select Graphical Item and then click Omnigraphic. The cursor changes to a black
floating box.
3. Click on the display to place the black box. During creation of an omnigraphic, the top left corner of the
bounding box is defined by the geometry property. After the omnigraphic has been saved, moving or nudging the
omnigraphic on the display will re-define the top left corner of the bounding box.
4. Double-click the omnigraphic. The Omnigraphic Item editor opens.
5. Select Property.
6. Click the blank button next to the Property field. The Object Specification dialog box appears.
7. Select the device, object, and property and then click OK.
8. If you want the point value to appear on the omnigraphic, select Show property value in omnigraphic.
9. Set the Decimal places. This is the number of decimal places shown for the point value.
10. If you want to show the units for the point value, select Include unit text and then select whether to show units
you define or to get the units from the object properties.
182
Compass Workstation Interface User Guide PDF
11. If you want a label on the omnigraphic, select Show text and then type the text that will appear in the center of
the omnigraphic. This text will appear above the point value.
12. If you do not want a tooltip to display when the user hovers over the omnigraphic, clear the Show tooltip check
box.
Adding Navigation to an Omnigraphic
To link the omnigraphic to a display or template, select Display and then click the command button to select the
display or template.
To link the omnigraphic to a URL, select URL and then type or paste the URL. Ensure the URL contains the full
"http://" prefix.
Set the security level. Users with security level less than this value will see the omnigraphic, but will not be able to
use it for navigation and will not be able to access items on the context menu.
Defining Omnigraphic Appearance
You can set the background of an omnigraphic to a single (static) color or you can configure the background to
dynamically change color based on the value of a point.
Using a Static Color for an Omnigraphic Background
1. Paste or type the path in the Geometry field. See Creating Paths for Omnigraphics.
2. Select Single color.
3. Choose a color using the color picker.
4. Set the opacity. 0 is invisible and 100 is solid.
Using Dynamic Colors for an Omnigraphic Background - Analog Value
Dynamic background colors give users visual indication of system status. For details about the settings, see About
Spectrum Colors.
1. Paste or type the path in the Geometry field. See Creating Paths for Omnigraphics.
2. Select Spectrum colors.
3. Use the color picker to choose colors for the Upper, Middle, and Lower ranges. Red, gray, and blue are
typical choices.
4. Set the opacity for the backgrounds. 0 is invisible and 100 is solid.
5. Select an Upper extent. This value is added to the Upper setpoint limit to determine the value at which the
dynamic color reaches full saturation. If the monitored point value goes above this value, the color will no
longer change. You can select either a point value or a set a hard value.
6. Select an Upper setpoint limit. This is the value at which the Middle Range color begins to change to the
Upper Range color. You can select either a point value or a set a hard value.
Note: When the bound value is between the Upper setpoint limit and the Lower setpoint limit, the
background will remain constant at the color and opacity selected for the Middle Range.
7. Select a Lower Setpoint limit. This is the value at which the Middle Range color begins to change to the
Lower Range color. You can select either a point value or set a hard value.
183
Editing Displays and Templates
8. Select a Lower extent. This value is subtracted from the Lower setpoint limit to determine the value at
which the dynamic color reaches full saturation. If the monitored point value goes below this value, the
color will no longer change. You can select either a point value or a set a hard value.
Using Dynamic Colors for an Omnigraphic Background - Binary Value
Dynamic background colors give users visual indication of system status. For binary values, you choose three
colors to represent Active, NULL, and Inactive values.
1. Paste or type the path in the Geometry field. See Creating Paths for Omnigraphics.
2. Select Spectrum colors.
3. Use the color picker to choose colors for the Active, Null, and Inactive values.
4. Set the opacity for backgrounds. 0 is invisible and 100 is solid.
Setting the Label Font and Foreground Color
To change the font of the label and point value, click Font and then select a font from the pop-up.
To change the foreground color for the label and point value, from the Color menu select Foreground color and then
select a color.
Embedding a DataViewer Widget
DataViewer widgets embedded on graphic displays provide you to monitor a trendlog or energy log without
navigating away from the display.
The widget will show only the main chart area.
1. Open the DataViewer and set up the log with the settings you want.
Important! Ensure you are viewing the log as a graph. If you copy the URL of a log viewed as a table, it
will not embed properly.
2. Copy the URL using the Copy URL icon.
3. Open the data display for editing.
4. From the Place Item menu, select Embed DataViewer.
5. Place the widget where you want it and then double-click it. The Embed DataViewer dialog box appears.
6. Paste the DataViewer URL into the URL field.
184
Compass Workstation Interface User Guide PDF
Placing the Date and Time on a Display
Compass offers two methods for placing the date and time on a display or template. You can display the local client
workstation’s date and time (as read from the operating system clock). You can also set up a read-only item to
retrieve the local-time property of any device object. This enables you to view the operating time of any time-savvy
BACnet device at the workstation.
To place the date and time as read from the workstation’s operating system clock on a data display or template
1. View a display or template in edit mode.
2. On the Place Item menu, click Date/Time.
Setting Up a Pushbutton
Place pushbuttons on displays and templates (Place Item > Pushbutton Selector) to enable users to navigate. You
can also place pushbuttons to edit BACnet objects (such as schedules and alarms.), launch another Windows
application (such as Word or Excel.), or perform a Compass function (such as log in and out or view a user activity
log.).
From the Button Type list, select the type of pushbutton you want. See the following list and links for more
information.
Place the item on the display and then double-click it to set it up.
Display Selector
A different data display appears. (Note: This option button is labeled Template Selector if the pushbutton is placed
on a template, and it will display another template.) More information.
Device Template
A device template appears in front of the display. The pushbutton passes information to the template so the same
device template can display data from different devices depending on the pushbutton that called it. More
information.
Object Template
An object template appears in front of the display. An object template is similar to a device template; a single object
template can display the properties of similar BACnet software objects, such as an AI object. More information.
Edit BACnet Object
Starts a BACnet object editor within Compass. More information.
Launch Application
Starts a Windows application. More information.
Invoke Compass Function
Opens a Compass dialog box or module. More information.
185
Editing Displays and Templates
Placing a Group Box
A group box (Place Item > Group Box) visually "fences in" related items. For instance, you can use a group box to
visually group all setpoint information for a particular zone or all items pertaining to airflow. A group box can be as
large or small as you want.
Tip: Place the items to be bound by the group box first and then position the group box around them. This
is easier than trying to fit a number of items into a pre-sized group box.
Place the item on the display, and then double-click it to set it up.
1. In the Text box, type the title to appear in the upper left corner. You can change the font of this title using the
Font menu.
2. Choose Foreground from the Color menu to change the color of the title text. Choose Background to change the
color behind the title text. The group box itself is always transparent.
The group box below was created with a red foreground, black background, and placed on a gray screen.
Setting Up a Check Box
Check boxes on a display (Place Item > Checkbox Property) let a user enable equipment, set a mode of operation,
or make another yes-or-no choice. When a user selects a check box, the property associated with it typically turns
ON or is made ACTIVE.
Place the item on the display, and then double-click it to set it up.
Display Factor and Decimal Places: Read-only Items
When you set up a read-only item, you specify a display factor and the number of decimal places. By default, both
of these are set to one. These settings are typically used to display values originating in DDC that you don’t want to
scale in DDC to maintain resolution. Smaller numbers, such as pressure readings, are often displayed with a display
factor. The value in DDC is known as the internal value. The relationship of the displayed value to the internal
value can be expressed as:
Displayed Value = Internal Value X Display Factor
Note: that the decimal position indicates the number of digits that will appear to the right of the decimal
point and must be a positive whole number. The decimal places setting does not figure into the calculation
for the displayed value.
186
Compass Workstation Interface User Guide PDF
Examples
Internal Value = 30.8, Display Factor = 4, Decimal =3
Displayed Value = 123.200
Internal Value = -3276.7, Display Factor=10, Decimal=4
Displayed Value = -32767.0000
Internal Value = 72.4, Display Factor=.01, Decimal=2
Displayed Value = 7.24
Display Factor, Spinner Resolution, and Decimal Places: Prompted Items
The display factor is often used with small numbers -- for example, static pressure (see the example). By using a
display factor appropriately, you avoid scaling the value in DDC and losing data resolution. It is important to realize
how these items affect the value used in the system or in DDC, called the internal value, as opposed to how the
value appears on a data display.
Display Factor The internal value sent to the system is the product of the displayed value divided by the display
factor.
Decimal Places The decimal places value indicates the number of digits that will appear to the right of the decimal
point. It must be a positive whole number, and it does not figure into the calculation for the displayed value.
Use Spinner/Spinner Resolution If the spinner check box is selected in the Prompted Property dialog box, spinner
arrows appear beside the control. The spinner resolution determines the amount by which the value increments or
decrements when the user clicks the spinner arrows. The spinner resolution must be a multiple of 0.1 times the
display factor. If it is not, it will default to the next lowest number that is.
Examples
Internal Value = 100, Display Factor = .001, and Decimal = 3
Displayed Value = 0.100
Internal Value = 32.7, Display Factor = 20, and Decimal = 0
Displayed Value = 654
Display File Management
General Notes About Working with Graphics
Keep the following in mind when working with display files, template files, and graphics:
1. Display files, template files, and graphics are stored by rep/job. Compass organizes displays and templates by
job so that a single Compass workstation can be used on a number of sites. Display files must be in the Displays
subdirectory of the job. Graphic files must be in the Bitmaps subdirectory to be used on displays (except for
background graphics).
2. A site key must exist in a job directory for users to overwrite displays and templates. A representative can make
a site key for a job, which enables users to edit displays and templates for that job and then save them in that job
187
Editing Displays and Templates
directory. Settings in the User Setup dialog box still determine a user's editing privileges. Representatives can edit
displays and templates in their jobs regardless of the site key.
3. Compass will not allow you to overwrite Alerton standard graphics. If you work with an Alerton standard
graphic in the display editor and try to save it, Compass prompts you to save it to a job directory instead. Neither
users nor representatives can overwrite Alerton Standard displays and templates.
4. Graphic files used on a display or template cannot be moved. Once you create a Compass display, do not move
or change the file names of any graphics used. Displays and templates store a pointer to the graphics file, not the file
itself.
Display and Template File Formats
Data displays and templates are stored in a proprietary Alerton file format and can only be edited in Compass. They
cannot be opened and edited directly using a graphics application. Displays and templates can be copied from one
workstation to another.
The file names of display and template files correspond directly to their ID number in Compass. Display 1, for
instance, is named 00000001.dsp. File extensions for different display types are listed below.
Type of Display File Extension
Data Display .dspx
Device Template .dvtx
Object Template .obtx
How Graphics are Saved and Named
Graphics can be used for display and template backgrounds or for graphic items on a display. They must be stored
in the bitmaps subdirectory of the rep/job directory. Recommended formats are .png, .gif, and animated .gif.
Compass also supports .jpg files.
File names for graphics can be up to 119 characters long including the file extension.
You can use a graphics application to develop and edit custom graphics for your displays and templates. Displays
and templates store a pointer to the graphic file so the graphic can be edited separately and the changes will appear
on the display. Any graphic files placed as background or dynamic items on a data display must remain in the
original directory. If they are moved or deleted, the graphic will not appear when the display or template is opened.
Note: BMP files are converted to PNG format when a display is saved. PNG is required for the web
interface.
188
Compass Workstation Interface User Guide PDF
Localizing Compass
Localizing the Compass interface makes it accessible to users with different languages, locations, and cultures. For
assistance with localizing the Compass user interface, contact your dealer.
189
Reference
Process ID Reference for workstations
BACnet devices use Process IDs to identify a set of actions to perform when an event occurs. The Compass
workstation recognizes the following Process IDs.
Process ID Actions
129. Annunciate (generate alarm popup message) only
130. Log only
131. Annunciate and log
132. Print only
133. Annunciate and print
134. Log and print
135. Log, print, and annunciate
191
You might also like
- Compass 2 - Installation & Upgrade Guide - 31-00314-04 - 1222100% (1)Compass 2 - Installation & Upgrade Guide - 31-00314-04 - 1222138 pages
- ALERTON COMPASS 2 Building Automation System User GuideNo ratings yetALERTON COMPASS 2 Building Automation System User Guide20 pages
- EcoStruxure Building Operation - System Upgrade Reference GuideNo ratings yetEcoStruxure Building Operation - System Upgrade Reference Guide178 pages
- Wonderware Alarm DB Logger Object For Wonderware Application Server User Guide Ver 1.x Rev 1.0 PR 00186No ratings yetWonderware Alarm DB Logger Object For Wonderware Application Server User Guide Ver 1.x Rev 1.0 PR 0018617 pages
- Technical Document: Niagara Kitcontrol GuideNo ratings yetTechnical Document: Niagara Kitcontrol Guide80 pages
- Ccure Istar Pro Install Config Guide Rg6 LT enNo ratings yetCcure Istar Pro Install Config Guide Rg6 LT en194 pages
- Computer Networks (CS-577) : University Institute of Information TechnologyNo ratings yetComputer Networks (CS-577) : University Institute of Information Technology6 pages
- BACtalk Control Modules Installation and Operation GuideNo ratings yetBACtalk Control Modules Installation and Operation Guide171 pages
- Lgr25, Lgr250, & Lgr1000: High-Speed Bacnet Routing & IntegrationNo ratings yetLgr25, Lgr250, & Lgr1000: High-Speed Bacnet Routing & Integration2 pages
- Safety Considerations Guide For Tricon v9-v10 SystemsNo ratings yetSafety Considerations Guide For Tricon v9-v10 Systems122 pages
- Cyber Security For Automation Systems - v1.0 - Training ManualNo ratings yetCyber Security For Automation Systems - v1.0 - Training Manual53 pages
- EBI R500.1 CU5 Software Release BulletinNo ratings yetEBI R500.1 CU5 Software Release Bulletin43 pages
- Niagara 4 Installation Guide: Technical DocumentNo ratings yetNiagara 4 Installation Guide: Technical Document25 pages
- Niagara Data Recovery Service Guide: Technical DocumentNo ratings yetNiagara Data Recovery Service Guide: Technical Document28 pages
- BACnet Advanced Workstation BACnet Operator WorkstationNo ratings yetBACnet Advanced Workstation BACnet Operator Workstation2 pages
- HBT TR50 IAQ Sensor User Guide 31 00567M 02No ratings yetHBT TR50 IAQ Sensor User Guide 31 00567M 0286 pages
- 963 Installation Instructions: (Applies To v3.71 Software)No ratings yet963 Installation Instructions: (Applies To v3.71 Software)62 pages
- Introduction: What To Expect: Niagara4 Technical Certificate Program - Briefing NotesNo ratings yetIntroduction: What To Expect: Niagara4 Technical Certificate Program - Briefing Notes1 page
- Compass v1.6.5 - Browser Interface User Guide (20.09.28)No ratings yetCompass v1.6.5 - Browser Interface User Guide (20.09.28)71 pages
- DS-2TD1117-2/P Thermal Network Turret Camera: Key FeatureNo ratings yetDS-2TD1117-2/P Thermal Network Turret Camera: Key Feature6 pages
- （2020.03.05）邦普通用版联网监控说明X1.HL006A.K11 001-1.Instructions for Online Monitoring Service.V100B54No ratings yet（2020.03.05）邦普通用版联网监控说明X1.HL006A.K11 001-1.Instructions for Online Monitoring Service.V100B5440 pages
- Kardiachain - The First Decentralized Interoperable and Self-Optimised Blockchain EcosystemNo ratings yetKardiachain - The First Decentralized Interoperable and Self-Optimised Blockchain Ecosystem11 pages
- Working of ARP and IP Forwarding in LAN and Across A RouterNo ratings yetWorking of ARP and IP Forwarding in LAN and Across A Router9 pages
- Implement Split Tunneling With MikrotikNo ratings yetImplement Split Tunneling With Mikrotik38 pages
- A Reference Model of Internet Service Provider BusinessesNo ratings yetA Reference Model of Internet Service Provider Businesses9 pages
- Cheking List Accordind To ISO27001: TOWER Semiconductor LTD N.A. Security0% (1)Cheking List Accordind To ISO27001: TOWER Semiconductor LTD N.A. Security6 pages
