DEVELOPER’S GUIDE ABSTRACT This guide is designed for someone familiar with the InTouch® WindowMaker® development environment. This guide will provide an overview of the Control Suite Application Prototype which is an InTouch® Version 9 application with built in functionality and connectivity to the Control Suite Scheduler.

2

All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means, electronics, mechanical, photocopying, recording, or otherwise, without the prior written permission of ENE Systems. No copyright or patent liability is assumed with respect to the use of the information contained herein. Although every precaution has been taken in the preparation of this documentation, the publisher and author assume no responsibility for errors or omissions. Neither is any liability assumed for damages The information in this documentation is subject to change without notice and does not represent a commitment on the part of ENE Systems. The software described in this documentation is furnished under a license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of these agreements. The confidential information contained in this document is provided solely for use by ENE Systems, Inc. employees, licensees, and system owners, and is not to be released to, or reproduced for, anyone else. Neither is it to be used for reproduction of this control system or any of its components. All specifications are nominal and may change as design improvements occur. ENE Systems, Inc. shall not be liable for damages resulting from misapplication or misuse of its products.

© 2004 ENE Systems Inc. All Rights Reserved.

427 Turnpike Street Canton, MA 02021

TELEPHONE: 781-828-6770 http://www.enesystems.com/

3

TRADEMARKS All terms mentioned in this book that are known to be trademarks or service marks have been appropriately capitalized. ENE Systems, Inc. cannot attest to the accuracy of this information. Use of a term in this book should not be regarded as affecting the validity of any trademark or service mark. Invensys, GCM, I/A Series, InTouch, InVue, Signal, LCM, MicroNet, MICROZONE II, NetDDE, NETWORK 8000, Recipe Manager, SQL Access Manager, Tree Tech, Wonderware, Wonderware FactorySuite, and Wonderware Logger are trademarks of Invensys PLC and its subsidiaries and affiliates. Wonderware, InTouch and FactorySuite Web Server are registered trademarks of Wonderware Corporation. FactorySuite, Wonderware FactorySuite, WindowMaker, WindowViewer, SQL Access Manager, Recipe Manager, SPCPro, DBDump, DBLoad, HDMerge, HistData, Wonderware Logger, Alarm Logger, InControl, InTrack, InBatch, IndustrialSQL, FactoryOffice, FactoryFocus, License Viewer, Scout, SuiteLink and NetDDE are trademarks of Wonderware Corporation.

Adobe and Acrobat are trademarks of Adobe Systems Incorporated.

IBM and Lotus 1-2-3 are trademarks of International Business Machines Corporation.

Pentium is a trademark of Intel Corporation.

ActiveX, Microsoft, Microsoft Excel, Windows, Windows 95, Windows NT, Windows XP, Windows 2000, Windows 2000 Server, Server 2003 and SQL Server are trademarks of Microsoft Corporation.

4

TABLE OF CONTENTS

Section Page TABLE OF CONTENTS................................................................................................ 4

SYSTEM REQUIREMENTS ......................................................................................... 5

INTRODUCTION .......................................................................................................... 6

CONTROL SUITE COMPONENTS .............................................................................. 7

RUNTIME INTERFACE ................................................................................................ 8

DEVELOPER INTERFACE........................................................................................... 9

CONTROL SUITE NETWORK ..................................................................................... 10

GETTING STARTED .................................................................................................... 11

CONTROL SUITE APPLICATION PROTOTYPE......................................................... 14

CS Points ................................................................................................................ 15

Standard CS Point Types ............................................................................................... 17

Special CS Point Types .................................................................................................. 20

Miscellaneous CS Point Types ....................................................................................... 23

CS Windows ................................................................................................ 24 CS Windows That Are Important to The Developer .......................................... 24

CS Palette................................................................................................................. 24

Developing Custom CS Windows ............................................................................ 26

Scheduling Windows ................................................................................................ 27

Miscellaneous Windows ........................................................................................... 29

Windows For Navigation & Configuration At Runtime....................................... 32

CS Windows For Alarm Management............................................................... 36

CS Windows For Trending, Logging, and Reporting......................................... 41

CS Scripts.................................................................................................... 45 Tagname Dictionary..................................................................................... 47 CS Indirect Tags ............................................................................................... 47

5

SYSTEM REQUIREMENTS

MINIMUM REQUIREMENTS Type: IBM® compatible, capable of running Windows XP Professional. Operating System: Microsoft® Windows 2000 Professional, SP 3 or XP SP 1a, Server 2003. Microprocessor: Pentium III® (or better) 800 MHz (or better). RAM: 256 MB or greater (1 GB) recommended. Disk Drives: 4 GB (40 GB recommended) hard drive, 24X CD-ROM drive. Video: 1024 X 768 Video card with 32K colors. Monitor: 1024 x 768 SVGA display. Network Interface Card: 10BaseT (100BaseT Recommended).

RECOMMENDED Type: IBM® compatible, capable of running Windows XP Professional. Operating System: Microsoft® Windows 2000 Professional, SP 3 or XP SP 1a, Server 2003. Microprocessor: Pentium IV® 2.4 GHz. RAM: 1 GB Disk Drives: 40 GB Video: 1024 X 768 Video card with 16 million colors, 32 MB RAM. Monitor: 1024 x 768 SVGA display. Network Interface Card: 100BaseT.

6

INTRODUCTION

NOTE: When the term Control Suite is used in this guide it will be understood as any application developed using the

“Control Suite Application Prototype” unless otherwise specified. Control Suite is a group of programs that feature flexibility and sophistication allowing it to be adapted to fit virtually any building or industrial automation system. All the necessary tools are provided by Control Suite to achieve total control of a system from the user interface to the engineering tools. Wonderware InTouch™, the heart of Control Suite, is a powerful graphical human machine interface (HMI) that is used to manage the day-to-day operations of a building’s automation equipment. Control Suite adds building automation functionality to the successful industrial software, Wonderware® InTouch™. This software provides network level supervisory and control functions for Building Automation systems such as the I/A Series MicroNet™ and NETWORK 8000™ facility management systems. InTouch is a full 32-bit application based on the Windows® XP Professional and Server 2003 operating systems. Using ActiveX® Controls, a library of Wizards, a scripting editor, and an object-oriented graphical drawing tool, InTouch is unsurpassed in bringing power and performance to the everyday user. Support for all LonWorks based control systems including the I/A Series MicroNet control system is through Echelon’s LNSDDE IO Server. Connection to NETWORK 8000 based systems is handled through the HRDBDDE IO Server which is dedicated to that product line. Hundreds of additional drivers are available for control of other Building Automation Systems. SOME FEATURES INCLUDE:

Use of ActiveX Controls, Wizards, and Smart Symbols significantly enhances functionality.

Support for OPC, DDE, and fast DDE standards.

Control System graphics can be made available via Terminal Services.

Integration with industrial automation protocols like Modbus.

Integration with MS-SQL and MS-Access databases.

Integration with third party OPC, DDE, and SuiteLink I/O servers.

Real-time data on interactive, graphical displays.

Supports client/server operation.

Hierarchical view of the entire control system.

Ethernet communication to Network 8000.

Exception based alarm handling for Network 8000.

Supports the use of bitmaps, photos, and other digital images for graphic displays.

Powerful scripting engine and editor for creating and performing system tasks.

Integrated engineering tools.

7

CONTROL SUITE COMPONENTS

CONTROL SUITE CONSISTS OF SEVEN CORE COMPONENTS:

1. InTouch Window Viewer (View) for monitoring and controlling.

2. InTouch Window Maker (Developer) for engineering and modifying graphics.

3. Control Suite Event Scheduler.

4. Control Suite Application Prototype complete with ready to use Building Automation Smart Symbols.

5. Wonderware OPC Link for communications with OPC Servers.

6. Echelon LNSDDE I/O Server for direct communication to I/A Series controllers and other integrated LonWorks devices.

7. Wonderware InTouch® Alarm Database. THE CONTROL SUITE MEDIA PACK CAN ALSO BE ORDERED WITH THE FOLLOWING OPTIONAL COMPONENTS:

Invensys Tree-Tech for upload / download and offline editing of Network 8000®.

Invensys HRDBDDE for communication with Network 8000® and DMS® controllers.

ENE Systems Alarm Capture for capturing exception based alarms from Network 8000®.

An optional Suite of other OPC / SuiteLink I/O Servers is provided to enable communication to many other vendors using protocols such as Modbus TCP.

Wonderware SCADAlarm for Alphanumeric paging, email, or voice call and acknowledgement of alarms.

SyTech XLReporter for trending, graphing, and emailing trend data. Control Suite is compatible with most components developed to work with Wonderware InTouch. These components include third party applications and standard Wonderware products. See www.wonderware.com for more information about these components.

8

RUNTIME INTERFACE

WINDOW VIEWER SPECIFICATIONS GRAPHICAL USER INTERFACE Windows are brought to life by dynamic 2-D and realistic 3-D graphics, photos, and other digital images that represent your facility. End users can monitor operations at a glance, perform routine tasks, adjust schedules, and perform commands and overrides. Real-time data presented on the displays enable users to monitor and analyze conditions to make informed decisions. EXTENSIVE ALARM CAPABILITIES Control Suite provides for 1 through 998 alarm priorities, allows alarm color changes according to alarm status, and supports hierarchical alarm groups to eight levels. Alarms can be displayed on screen, logged to a database, and output to a printer. Alarm functions include annunciation with audio and video, single and multiple acknowledgments, and alarm scrolling. It is also possible to log comments with each acknowledgement. Compatibility with Wonderware InSQL and Microsoft MS-SQL Server make alarm management extremely robust. ADJUSTING VALUES Events, Overrides, and the adjustment of values are performed via Smart Symbols. If the point placed on-screen is override-able, the screen displays the appropriate dialog box to initiate overrides. Overrides can be pre-programmed, timed or indefinite. DYNAMIC AND HISTORICAL TRENDS Built-in objects allow easy creation of real-time and historical trend displays. Trends can display up to eight parameters at a time in historical trend charts and each can reference a different historical file. Each historical trend has data point selection, value at cursor display, zooming, scrolling, and centering capabilities. Real-time trend displays support sixteen parameters. There is no limit to the number of trend charts that can be displayed per application. Data can be exported to common software packages such as Microsoft Excel or text files to meet reporting needs. Optionally, XL-Reporter can be used to automate trend collection and distribution. PASSWORD PROTECTION Password protection offers up to 999 levels of assignable access, and provides extensive capability for password access and conditional operations to specific windows, objects, and buttons. There are four basic groups of users built into Control Suite. Administrators can assign any user to any group and restrict access to core functions via check boxes.

9

DEVELOPER INTERFACE

WINDOW MAKER SPECIFICATIONS OBJECT-ORIENTED GRAPHICS Objects and groups of objects can be moved and animated more quickly and simply than bit-mapped graphics. Powerful object oriented design tools make it easy to draw, arrange, align, layer, space, rotate, invert, duplicate, cut, copy, paste, erase, and more. APPLICATION MANAGER The Application Manager sets up default windows that are provided with Control Suite including CS-Home Window, CS-Main Control, CS-Alarm History, CS-Alarm Summary, CS-Password Administration, CS-Trend Wizard, and Event Scheduling windows. ANIMATION LINKS Animation links may be combined to provide complex size, color, movement, and/or position changes. Animation links are provided for: discrete, analog, and string touch inputs and outputs. Links include horizontal and vertical sliders; discrete and action push buttons; show and hide window push buttons; line, fill, and text color links; object height and width links; vertical and horizontal position links; vertical and horizontal percent fill links; visibility links; rotation links and blink links. WIZARDS & SMART SYMBOLS Wizards & Smart Symbols are pre-engineered functional graphic value displays that can be configured by the engineer to perform a specific function or display a value. They are designed to save time in engineering the graphical representation of a job. SCRIPT EDITOR AND FUNCTIONS Control Suite provides extensive scripting capability for rapid prototyping, background calculations, and simulation. All script functions and data variables are chosen by point-and-click. Script functions support logical and mathematical expressions. REPORTING Engineers can easily design custom reports directly from within Control Suite applications by simply formatting a screen and pre-selecting points (tags) that will be logged.

10

CONTROL SUITE NETWORK

Control Suite is flexible in the way Client / Server applications can be deployed. Information can be viewed locally or over the Internet using a system of Thick Clients or Thin Clients. Thick client licenses reside on each machine that has access to the system. This method provides an added layer of security by requiring those with access to the system to have the necessary software loaded to view the system. Thin client licenses reside on the Control Suite server. Thin Client computers require nothing more than Internet Explorer 5.5 to access the system via Terminal Services. Thin Client security is accomplished using standard Windows 2003 server security.

11

GETTING STARTED Use this “Getting Started” section as a reference once you are familiar with all of the elements provided in Control Suite. More detailed descriptions of these elements are found in this guide and the InTouch User’s Guide. After installing all of the software, there are a few steps to prepare the system for development and runtime. 1. License all of the components.

a. Control Suite b. InTouch c. Drivers (LNSDDE, HRDBDDE) d. Databases (MS-SQL) e. Configuration Tools (LonMaker, Workplace Tech)

2. Use the InTouch Application Manager’s “Find Applications” utility to load the “Control Suite

Application Prototype.

NOTE: It may be a good idea to rename this folder before making any changes as you may overwrite your changes with a future installation of the application prototype.

a. This will be in a folder called “CS_NEWX.XX where X.XX is the version. b. Typically “C:\Program Files\Wonderware\InTouch\CS_NEWX.XX

3. Prepare the system to automatically restart on re-boot using the “Control Suite Startup Utility” and

TweakUI. See the “Control Suite Startup Utility User’s Guide” for more information. Make sure all of the required components launch.

a. LNSDDE (or other IO Servers as required) b. WindowViewer c. Control Suite Scheduler d. MS-SQL Server or MSDE (This can be found in the “Services” section of the MMC. e. Alarm DB Logger Utility (This can be run as an application or a service.

12

GETTING STARTED 4. Configure the “Control Suite Event Scheduler” if required.

a. The scheduler does not require any configuration unless wild-card override will be used, in which the “Affected Tag” drop down box must be populated with tags.

b. There are two methods for populating the “Affected Tag” drop down box. i. Place a copy of the “tagnames.ndx” file from the InTouch application directory into the “Control

Suite Scheduler” directory. By default “C:\Program Files\Control Suite Scheduler”. ii. Type the strings you want to appear in the drop down box into the “tagfile.txt” file located in the

“Control Suite Scheduler” directory. By default “C:\Program Files\Control Suite Scheduler”. 5. Configure the Alarm DB Logger Utility to store alarms in a database. See the section “Alarm

Management” for more information. 6. Launch the new application in WindowMaker and begin setting up communications.

a. Setup users. See the InTouch User’s Guide for more information. b. Setup the Distributed Name Manager. See the section “Alarm Management” for more information. c. Setup the Distributed History if required. d. Setup access names to communicate with the IO Servers. (LNSDDE)

i. By default the application will have a number of access names. Make sure these access names are configured correctly to communicate to the system you are working on. See the section “Access Names” for more information.

e. Edit the “CS Main Control” window for the site you’re working on. f. Develop the screens for the site you’re working on.

13

GETTING STARTED LAUNCHING INTOUCH® WINDOWMAKER® FROM THE CONTROL SUITE OPERATOR INTERFACE After installing the Control Suite Application Prototype you can load the application in either WindowViewer or WindowMaker. If you loaded the application in WindowViewer, you must log on as an Administrator to switch to WindowMaker. The default username is ‘Administrator’ and the password is ‘wonderware’. LOGGING ON / LOGGING OFF: To log onto Control Suite simply click the “Log On” button located on the “CS Home Window”. You will be presented with the “Log On” dialog box. Type in your user name ‘Administrator’, which is not case sensitive. Then, type in your password, ‘wonderware’ which is case sesitive.

To log off Control Suite return to the “CS Main Control” screen and click the “Log Off” button. You can always return to the “CS Main Control” window by pressing the “F1” key and bringing up the “CS Information” window. The “CS Information” window has a button labeled “Go to Main Control”. Click this button to return to the “CS Main Control” window where you can log off.

14

CONTROL SUITE APPLICATION PROTOTYPE Control Suite is supplied with an application prototype to help you get started. The functionality that a BAS user would expect to find in an HMI is already built in, making development much easier. Although the application has been built with LonWorks and Invensys IA Series Controllers in mind, most of the functionality is generic and can be extended to other BAS systems. The application is designed so that developers can create new screens then populate the new screens by simply using the SmartSymbols that are provided with the application or by copying cells from the “CS Palette” THE CONTROL SUITE APPLICATION PROTOTYPE IS MADE UP OF 4 BASIC ELEMENTS: 1. CS Points 2. CS Windows 3. CS Scripts

15

CONTROL SUITE APPLICATION PROTOTYPE 1. CS POINTS

USING “CS POINTS” 1. In Window Maker, open the CS Palette Window (see Figure 1) or the SmartSymbols Wizard (see

Figures 2 & 3). 2. Copy the appropriate “CS Point” from the palette or select it from the SmartSymbols Wizard (see

Figure 3) and paste it onto your screen. 3. Double click the “CS Point” to assign a tag to it.

a. You may optionally define the tag at this time.

Figure 1. CS Palette

16

CONTROL SUITE APPLICATION PROTOTYPE CS POINT TYPES There are 14 CS Point Types to choose from. Each CS Point Type provides unique functionality in the runtime environment.

Figure 2. Button to Open SmartSymbols Library

Figure 3. SmartSymbols Wizard

17

CONTROL SUITE APPLICATION PROTOTYPE STANDARD CS POINT TYPES There are 6 CS Standard Point Types. The standard point types can be used with any tag that conforms to the basic data type requirements. READ ONLY ANALOG Points of this type will display the value of any read only analog tag. When the tag is in alarm (.Alarm dotfield of the tag is ‘1’) the point will appear red. When the tag not in alarm (.Alarm dotfield of the tag is ‘0’) the point will appear non-black. Clicking a point of this type in runtime will display the “CS Detail Analog Point” window (See Figure 4). The current value will be displayed as non-black and will not be change-able. The “Schedule an Event” button will not be visible. READ WRITE ANALOG Points of this type will display the value of any read only analog tag. Clicking a point of this type in runtime will display the “CS Detail Analog Point” window (See Figure 4). The current value will be displayed as black and will be change-able. The “Schedule an Event” button will be visible. READ ONLY DISCRETE Points of this type will display the value of any read only discrete tag. The values displayed for discrete values of ‘0’ and ‘1’ are the tag’s .OnMsg and .OffMsg respectively. When the tag is in alarm (.Alarm dotfield of the tag is ‘1’) the point will appear red. When the tag is not in alarm (.Alarm dotfield of the tag is ‘0’) the point will appear non-black. Clicking a point of this type in runtime will display the “CS Detail Discrete Point” window (See Figure 5). The current value will be displayed as non-black and will not be change-able. The “Schedule an Event” button will not be visible. NOTE: Regardless of the settings of .OnMsg and .OffMsg the display will depict “ON” and “OFF”. READ / WRITE DISCRETE Points of this type will display the value of any read only discrete tag. The values displayed for discrete values of ‘0’ and ‘1’ are the tag’s .OnMsg and .OffMsg respectively. Clicking a point of this type in runtime will display the “CS Detail Discrete Point” window (See Figure 5). The current value will be displayed as black and will be change-able. The “Schedule an Event” button will be visible. NOTE: Regardless of the settings of .OnMsg and .OffMsg the display will depict “ON” and “OFF”. READ ONLY MESSAGE Points of this type will display the value of any read only message tag. Clicking a point of this type in runtime will display the “CS Detail Message Point” window (See Figure 6). The current value will be displayed as non-black and will not be change-able. The “Schedule an Event” button will not be visible. READ / WRITE MESSAGE Points of this type will display the value of any read only message tag. Clicking a point of this type in runtime will display the “CS Detail Message Point” window (See Figure 6). The current value will be displayed as black and will be change-able. The “Schedule an Event” button will be visible.

18

CONTROL SUITE APPLICATION PROTOTYPE STANDARD CS POINT TYPES (continued)

Figure 4. CS Detail Analog Point

Figure 5. CS Detail Discrete Point

19

CONTROL SUITE APPLICATION PROTOTYPE STANDARD CS POINT TYPES (continued)

Figure 6. CS Detail Message Point

20

CONTROL SUITE APPLICATION PROTOTYPE SPECIAL CS POINT TYPES There are 8 Special CS Point Types. The special point types are designed to provide additional or specialized functionality in the runtime environment for tags that represent specialized data. (i.e. LonWorks NCI points that are used as an override input to a priority block in an IA series controller). SPECIAL CS POINT TYPES ASSOCIATED WITH LONWORKS LONWORKS NCI OVRD AS ANALOG Points of this type should be used to display the value of a MESSAGE tag that references an NCI. This NCI should be one that is used for overriding an analog value in a priority block. By override, it is meant that the NCI is an input to a priority block in an IA Series controller. The NCI should have a higher priority than some other value and therefore the NCI can “override” that value. For example, imagine a system of VAV controllers that are designed to share a common set point that is bound from a rooftop unit controller. This bound value would be the 4th input on a priority 4 block. The NCI with the user adjustable set point would be the 3rd input on the same priority 4 block. Using the “LonWorks NCI OVRD as “Analog” point will enable the runtime user to “override” the bound set point and schedule set point changes using the Control Suite Scheduler. The point will be displayed as either a yellow override value or a black “not overridden” message will be displayed. When the point is clicked the “CS LON OVRD Point” window will be displayed. The “Schedule an Event” button will be visible (see Figure 7). LONWORKS NCI OVRD AS DISCRETE Points of this type should be used to display the value of a MESSAGE tag that references an NCI. This NCI should be one that is used for overriding a discrete value in a priority block. By override, it is meant that the NCI is an input to a priority block in an IA controller. The NCI should have a higher priority than some other value and therefore the NCI can “override” that value. For example, imagine a system of VAV controllers that are designed to share a schedule that is bound from a rooftop unit controller. This bound value would be the 4th input on a priority 4 block. The NCI with the user adjustable discrete value would be the 3rd input on the same priority 4 block. Using the “LonWorks NCI OVRD as Discrete” point will enable the runtime user to “override” the bound schedule and schedule short term scheduled overrides using the Control Suite Scheduler. The point will be displayed as yellow “overridden on”, yellow “overridden off”, flashing “Abnormal”, or black “not overridden”. When the point is clicked the “CS LON OVRD Point” window will be displayed. The “Schedule an Event” button will be visible (see Figure 7).

21

CONTROL SUITE APPLICATION PROTOTYPE SPECIAL CS POINT TYPES ASSOCIATED WITH NETWORK 8000 NET8 OVRD POINT Points of this type should be used to display the value of a MESSAGE tag that references the output of a Network 8000 block. For example, (E:001.GCM_04.LCM_00.APT.RT3_CLSP;AV). The point will display either the current value of the output in black or the overridden value of the output in yellow with the letters “OV” to the right of the value. When the point is clicked the “CS NET8 OVRD Point” window will be displayed. The “Schedule an Event” button will be visible (see Figure 8). SPECIAL CS POINT TYPES ASSOCIATED WITH FLOOR PLANS Customers have indicated to us that they would like to have a way to easily identify hot or cold areas of a floor. Unfortunately, using standard alarm features for points caused nuisance alarms. For that reason we put together a simple method to accomplish this goal. Put a copy of the “Floor plan High Set point” and the “Floor plan Low Set point” on each floor plan that you create. Then populate the floor plan with “Floor plan High / Low Value Indicators” that have space temperatures associated with them. Each “Indicator” point will turn red if its temperature exceeds the “Floor plan High Set point”. Each “Indicator” point will turn blue if its temperature decreases below the “Floor plan Low Set point”. A customer can then adjust the “Floor plan High Set point” or “Floor plan Low Set point” to easily identify hot or cold areas. Other than this added functionality, these points will act as normal “Read Only Analog” points. FLOOR PLAN HIGH SET POINT Points of this type are designed to display the value of only one tag in the tagname dictionary (CS-High_Real_Setpoint). This tag is the upper limit for “Floor plan High / Low Value Indicators”. FLOOR PLAN LOW SET POINT Points of this type are designed to display the value of only one tag in the tagname dictionary (CS-Low_Real_Setpoint). This tag is the lower limit for “Floor plan High / Low Value Indicators”. FLOOR PLAN HIGH / LOW VALUE INDICATOR Points of this type are designed to depict the value of a read only analog type that references a space temperature. This point should be used on a floor plan in conjunction with the “Floor plan High Set point” and the “Floor plan Low Set point”. This point will turn red if its value exceeds the “Floor plan High Set point” and it will turn blue if its value decreases below the “Floor plan Low Set point”. When the tag is in alarm (.Alarm dotfield of the tag is ‘1’) the point will appear blinking. When the tag is not in alarm (.Alarm dotfield of the tag is ‘0’) the point will appear non-blinking. Clicking a point of this type in runtime will display the “CS Detail Analog Point” window (See Figure 4). The current value will be displayed as non-black and will not be change-able. The “Schedule an Event” button will not be visible.

22

CONTROL SUITE APPLICATION PROTOTYPE SPECIAL CS POINT TYPES ASSOCIATED WITH FLOOR PLANS (continued)

Figure 7. CS Detail LON OVRD Point

Figure 8. CS Detail NET8 OVRD Point

23

CONTROL SUITE APPLICATION PROTOTYPE MISCELLANEOUS CS POINT TYPES ALARM INDICATOR Points of this type should be used to display the status of a discrete tag. It can be used to display the value of any discrete tag as though it were an alarm. When the tag is ‘1’ (True) the point will appear red. When the tag is ‘0’ (False) the point will appear green. ENUMERATED VALUE Points of this type will display a string associated an integer tag value. Each possible value of the tag between ‘0’ and ‘16’ can be assigned a string. A value less than ‘0’ will display “NULL” and a value greater than “16” will also display null. To enter the tag, right click the cell and select “substitute tags”. To enter the strings associated with each value between ‘0’ and ‘16’ right click the cell and select “substitute strings. Clicking a point of this type in runtime will display the “CS Detail Enumerated Point” window (See Figure 9). The “Schedule an Event” button will not be visible.

Figure 9. CS Detail Enumerated Point

24

CONTROL SUITE APPLICATION PROTOTYPE 2. CS WINDOWS

The Control Suite application prototype is provided with (23) windows. Each of these windows has a name that begins with “CS”. The screens are called from the scripts built into the system and changing the names of the screens is not recommended. As a developer you should be familiar with the way users will navigate in runtime. Please refer to the “Window Flow Diagram” for more information. The following is a description of each of the 23 Windows. CS WINDOWS THAT ARE IMPORTANT TO THE DEVELOPER CS PALETTE The most important window to a developer is the “CS Palette”. The CS Palette is provided with a number of “CS Points” that are designed to provide runtime users with the functionality they expect from a building automation HMI. For more information about “CS Points”, read the section “CS Point Types”. A developer can use the palette to copy points then paste them onto new windows. The pallet can also be used to familiarize a developer with the functionality of each point type, both in runtime and development.

Figure 10. CS Palette

25

WINDOW FLOW DIAGRAM

26

CONTROL SUITE APPLICATION PROTOTYPE DEVELOPING CUSTOM CS WINDOWS FLOOR PLANS By default floor plans depict an area within a building or campus that contains the following graphic elements: Floor Plan Temps – These are special values that display temperatures in an area on a floor plan. These special values do not follow normal color conventions. If the temperature is above the Floor Plan High Set Point the point will appear red. If the temperature is below the Floor Plan Low Set Point the point will appear blue. If the point tag that the point is displaying is in alarm, the point will be blinking. Floor Plan Low Set Point – This is typically depicted as a slider. If any floor plan temps are below the value set at this slider they will appear blue. Floor Plan High Set Point - This is typically depicted as a slider. If any floor plan temps are above the value set at this slider they will appear red. EQUIPMENT GRAPHICS There are two basic types of equipment graphics, complex equipment screens and unitary equipment screens. Complex equipment screens can display a variety of data from any number of controllers and may have specialized display properties for each screen. An example of a complex equipment screen would be a screen depicting a boiler room complete with multiple boilers, pumps and dampers. Unitary equipment screens display data from only one controller and will usually presents the data in the same for all controllers of that type. An example of a unitary equipment screen would be a screen depicting a single VAV box. POINTS There are a number of common elements found on equipment graphics. Each variable depicted on a screen is called a point. A point usually displays the value of a tag but may also depict other variable information such as the current date or the user’s name. POINT COLORS The color of points in Control Suite can communicate a lot of information. Points that are on full screen graphic displays conform to the following color convention: Non-Black, Non-Yellow, Non-Red, Non-Blue = Read only White = Read Only Black = Changeable or Override able Yellow = Point is override able and is currently overridden *Red = Point is in alarm (or has exceeded the high floor plan temp set point) *Blue = Point is below low floor plan set point (used only on floor plans) *NOTE: Points that are on floor plans change color according to their temperature with relation to the “High Floor Plan Temp”

and “Low Floor Plan Temp” set points. For example; if the space temperature depicted on a floor plan is 65°F and the “Low Floor Plan Temp” set point is 68°F, then the temperature indication will appear blue.

27

CONTROL SUITE APPLICATION PROTOTYPE SCHEDULING WINDOWS CS I.LON100 SCHEDULER This window provides users a method to access network resident schedules located in an Echelon® i.LON 100. Network resident schedules are those schedules that provide routine scheduling for equipment. This scheduling is normally handled by a hardware device that resides on the control network and is not dependent upon the operation of the PC. Although there are a number of different network resident schedulers available on the market, we will limit our discussion to the Echelon® i.LON 100. This window should be called using the following script: IF (($AccessLevel > 4000) AND (CS-Admin_008 == 1)) THEN

CS-Scheduler_URL = "http://192.168.1.222/forms/ENE/ControlSuiteSched.htm"; Show "CS I.LON 100 Scheduler"; LogMessage(StringFromIntg($AccessLevel, 10) + " Is Sufficient To Access Network Schedulers");

ELSE CALL ERROR (StringFromIntg($AccessLevel, 10) + " Is Not Sufficient To Access Network Schedulers");

ENDIF; NOTE: Be sure that you load the directory “ENE” onto the i.LON100 and that you are using the correct

URL in the script. You can purchase pre-configured i.LON100s from ENE Systems.

28

CONTROL SUITE APPLICATION PROTOTYPE SCHEDULING WINDOWS (continued) The Echelon® i.LON 100 provides 16 schedules that can be used to change the value of network variable outputs (NVO) at specified times and dates. In the example (see Figure 11) we are displaying a web page available in the Echelon® i.LON 100 that can be used to configure schedules. Control Suite is able to display this web page as a normal graphic screen by using an ActiveX web browser integrated into a standard graphic screen. For more information about the Echelon® i.LON 100 please refer to the “Echelon® i.LON 100 User’s Guide”.

Figure 11. CS I.LON100 Scheduler

29

CONTROL SUITE APPLICATION PROTOTYPE MISCELLANEOUS WINDOWS CS ERROR The “CS Error” window is called whenever the “ERROR” script is executed. The “ERROR” script is provided to enable developers to send messages to a user during runtime. Use a script similar to this to post error messages to a user: CALL ERROR ("This Is A Test Error Message");

CS INACTIVITY WINDOW The “CS Inactivity Window” informs the user that they are about to be logged off due to inactivity. This window is called by the $InactivityWarning data change script. CS INTERROGATION ERROR The “CS Interrogation Error” window informs the user that they have tried to open too many detail windows at once (they are interrogating too many points). CS COPY TO REPORT WIZARD The “CS Copy to Report Wizard” window is called when a user clicks the “Copy Logged Data to Report Wizard” button from a detail screen. This screen provides the user with a set of radio buttons to select which pen will display the logged data for the selected point on the “CS 8HT Pen Report Wizard1” window. CS DETAIL X POINT The “CS Detail X Point”, where ‘X’ is the point type, is called whenever a user clicks a CS Point that has been selected from the SmartSymbols Wizard or copied from the CS Palette window. See the section “CS Points” for more information.

30

CONTROL SUITE APPLICATION PROTOTYPE MISCELLANEOUS WINDOWS (continued) CONTROL SUITE EVENT SCHEDULER WINDOW Although this window is provided by an application outside of the application prototype, it is available in the user environment and is tightly integrated with the application prototype.

NOTE: You must be logged onto WindowViewer with an $AccessLevel of at least 4000 to make changes on the Control Suite Event Scheduler window.

All points selected from the SmartSymbols Wizard or copied from the CS Palette will automatically be linked to the “Control Suite Event Scheduler”. For more detailed information about the “Control Suite Event Scheduler” see the “Control Suite Event Scheduler User’s Guide”. Scheduling an event is accomplished through the “Control Suite Event Scheduler”. There are two ways to access the Scheduler. 1. Click the “Schedule an Event” button on a “Tag Detail” window. 2. Right click the “Control Suite Scheduler” icon in the system tray, then left click “Show Event Scheduler”

Control Suite Scheduler Icon

Figure 12A. Fly Out Menu

The Scheduler screen provides a method for setting up an event in the future that will change the value of any Tag in the Tag Dictionary. You can learn more about the scheduler by reading the “Control Suite Scheduler User’s Guide”. If you accessed the Scheduler from the “Tag Detail” window most of dialog box will be filled in for you (see Figure 12B).

NOTE: Events that are scheduled in the past will be executed immediately.

31

CONTROL SUITE APPLICATION PROTOTYPE MISCELLANEOUS WINDOWS (continued)

Figure 12B. Event Scheduler

32

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR NAVIGATION AND CONFIGURATION AT RUNTIME CS PASSWORD ADMINISTRATION The “CS Password Administration” window provides a simple interface for administering users and passwords during runtime. This window is available to all users who have been configured for access. However, only Administrators with an Access Level greater than 9000 can configure users. If someone who is not authorized to view “CS Password Administration” attempts to open this window they are immediately logged off and the failed attempt is logged in the system management console.

A user that is authorized to view “CS Password Administration” may assign or remove privileges from any user group by clicking the box to the right of the privilege and below the user group heading. NOTE: Click “Commit Changes” to see how the changes you have made will affect the user group. Many privileges that can be

assigned will automatically enable the privileges below. For example; enabling a user to access the Windows system keys will also enable them to do everything below that privilege. Grayed out boxes are pre-determined privileges and cannot be changed by users.

An administrator can create users and assign them any one of the four user groups listed below:

Administrator = Access Level > 9000: Can do everything below PLUS add and remove users Super User = Access Level 8001 – 9000: Can do everything below PLUS see toolbar User = Access Level 7001 – 8000: Can navigate screens, acknowledge alarms, and use assigned privileges. View Only User = Access Level 4001 – 7000: Can navigate screens and use assigned privileges.

33

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR NAVIGATION AND CONFIGURATION AT RUNTIME (continued) CS HOME WINDOW The “CS Home Window” is the home window for the system and provides a button for users to log on. The CS Home window is used in conjunction with the “CS Navigation Blocker” to prevent unauthorized access to the application in runtime. The “CS Navigation Blocker” is simply a long black bar that covers the top of the screen and prevents access to menus at the top of the screen. Once the user logs on, they will be greeted with the “CS Main Control” window. If a user logs on as an Administrator ($AccessLevel > 9000) then the “CS Navigation Blocker” will be hidden, allowing the user access to the top menus.

Figure 13. CS Home Window

34

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR NAVIGATION AND CONFIGURATION AT RUNTIME (continued) CS MAIN CONTROL The “CS Main Control Screen” should be customized for each site but should enable users to navigate all into the system. This window is a good place to provide access to areas such as Alarm Management, Trending, and Password Administration. Typically a drop down list of floors or a campus overview will be depicted on this window.

35

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR NAVIGATION AND CONFIGURATION AT RUNTIME (continued) CS INFORMATION Pressing the “F1” key in runtime will pop up the “CS Information” window. What buttons are available to a user on the “CS Information” window will depend on his/her access level and the privileges granted by an administrator. The “CS Information” window provides access to the following functions: SHOW COMMON INFO FILE Clicking here will open the “Common.txt” file in the application directory. The common info file is a text file that is common for all users of this application. In NAD environments such as terminal servers, this file will be common to all who log into Windows with the same username and password. This is designed to stores common information such as shift reports. GENERAL HELP Clicking here will open the “GeneralHelp.txt” file in the application directory. This file will contain general help information that is specific to your system. CHANGE MY PASSWORD Clicking here will enable a user to change his/her password. SHOW MY OPERATOR INFO FILE Clicking here will open the username.txt file where username is the currently logged on users log in name. LAUNCH WINDOWMAKER Clicking here will launch WindowMaker. VIEW WINDOWS DESKTOP Clicking here will minimize WindowViewer and expose the Windows desktop. GO TO MAIN CONTROL Click here will open the “CS Main Control” window. LOGGING MODE This provides information as to the current mode that WindowViewer is running in. There are three possible modes. Workstation, Console, and Client. Workstation and Console can both have historical logging enabled, Client cannot. This is useful if you are trying to remotely access the Console of a terminal server from a remote desktop. CLOSE / DONE Clicking here will close the “CS Information” window.

36

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR ALARM MANAGEMENT Alarms are detected using the standard alarm features of tags in InTouch. The “Distributed Alarm Display” is used to display the alarms in three of the four Alarm Management windows. Each display is configured differently for the context in which it is used. By default the distributed name manager and all of the displays reference “TAGSERVER” for alarms. The simplest way to get the alarm displays to all look in the same place for data is to add the following line to the HOSTS file.

127.0.0.1 TAGSERVER #the IP address at left can also be the IP of the local PC. The hosts file can typically be found in one of the following two locations: 1. For Windows XP and Server 2003: “c:\windows\system32\drivers\etc\hosts” 2. For Windows 2000: “c:\WINNT\system32\drivers\etc\hosts”

As an alternative to editing the host file, the members Section of the distributed display manager could be configured with the DNS name of the PC.

There are four windows that are used to manage alarms. They are: 1. CS Alarm Annunciation – This window will pop up any time a new alarm occurs and the user is not

already viewing one of the other three alarm management windows. The window displays alarms that are unacknowledged and allows users to acknowledge the displayed alarms.

2. CS Alarm Summary – This windows displays alarms that are in alarm or unacknowledged and allows

users to acknowledge the displayed alarms. 3. CS Alarm History – This window displays a line for each change of state of an alarm that has occurred

since the last restart of the server application up to 500 entries. 4. CS Alarm Database Viewer – This window displays the last change of state for any alarm that has

occurred within the last 60 days (adjustable).

37

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR ALARM MANAGEMENT (continued) CS ALARM ANNUNCIATION This window will pop up any time a new alarm occurs and the user is not already viewing one of the other three alarm management windows.

The Alarm Annunciation window will show any alarms that are unacknowledged. Alarms that are either in alarm and unacknowledged or returned and unacknowledged. Each alarm state will be color coded according to the following:

RED = In alarm and unacknowledged BLUE = Returned from alarm and unacknowledged

Once an alarm is acknowledged, it will no longer be displayed in the alarm annunciation window. It can however be viewed in the alarm history or the alarm database. If it is still in alarm, it will also be seen in the alarm summary. Clicking an alarm in the alarm display will toggle the background color of the clicked line between blue and white. Blue lines are currently selected. There are three buttons on the “CS Alarm Annunciation” window: 1. Alarm Management – This button will only function for users with an access level greater then 4000.

Clicking this button will open the “CS Alarm Summary” window.

2. Acknowledge Selected Alarms – This button will only function for users with an access level greater then 7000. Clicking this will change the state of any alarms selected in the display to Acknowledged and associate the logged on username with the alarms. The alarm will disappear from the “Alarm Annunciation Window”.

3. Close – This button will only function for users with an access level greater then 4000. This button will close the alarm annunciation window.

38

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR ALARM MANAGEMENT (continued) CS ALARM SUMMARY The alarm summary will show the current state of all alarms that are currently in alarm OR unacknowledged alarms that have returned. Each alarm state will be color coded according to the following:

RED = In alarm and unacknowledged BLACK = In alarm and acknowledged BLUE = Returned from alarm and unacknowledged

Once an alarm is returned and acknowledged, it will no longer be displayed in the alarm summary. It can however be viewed in the alarm history or the alarm database. Clicking an alarm in the alarm display will toggle the background color of the clicked line between blue and white. Blue alarms are currently selected. There are five buttons on the “CS Alarm Summary” window: 1. Main Control – Clicking this button will

return to the “CS Main Control” window. 2. Alarm History – Clicking this button will

open the “CS Alarm History” window. 3. Alarm Database Viewer – Clicking this

button will open the “CS Alarm Database Viewer” window.

4. Acknowledge Selected Alarms – This

button will only function for users with an access level greater then 7000. Clicking this will change the state of any alarms selected in the display to Acknowledged and associate the logged on username with the alarms.

5. Acknowledge All Alarms - This button will only function for users with an access level greater then

7000. Clicking this will change the state of all alarms in the display to Acknowledged and associate the logged on username with the alarms.

39

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR ALARM MANAGEMENT (continued) CS ALARM HISTORY The alarm history will show all states of all alarms that have occurred since the last restart of the application (up to a limit of 500 entries). There can be as many entries in the alarm history for each alarm state. Each alarm state will be color coded according to the following:

RED = In alarm and unacknowledged BLACK = In alarm and acknowledged BLUE = Returned from alarm and unacknowledged

There are three buttons on the “CS Alarm History” window: 1. Main Control – Clicking this button will return to the “CS Main Control” window. 2. Alarm Summary – Clicking this button will open the “CS Alarm Summary” window 3. Alarm Database Viewer – Clicking this button will open the “CS Alarm Database Viewer” window.

40

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR ALARM MANAGEMENT (continued) CS ALARM DATABASE VIEWER The “CS Alarm Database Viewer” window must be used in conjunction with a Microsoft SQL Server or Microsoft Data Engine (MSDE) database and the “Alarm DB Logger”. The InTouch Distributed Alarm system includes the Alarm DB Logger utility that logs alarms and events to a Microsoft SQL Server or Microsoft Data Engine (MSDE) database. Alarm DB Logger is an Alarm Consumer. You configure it with an alarm query that defines which alarms are to be logged. You use the Alarm DB Logger to specify alarm queries and to log the resultant alarm records. These alarm queries are sent via the Alarm Consumer interface of the Distributed Alarm System. The alarm database viewer will show all states of all alarms that have occurred in the last 60 days (adjustable) from any node on the network. There can be many entries in the alarm database for each alarm and alarm state. Each alarm state will be color coded according to the following:

RED = In alarm and unacknowledged BLACK = In alarm and acknowledged BLUE = Returned from alarm and unacknowledged

There are three buttons on the “CS Alarm Database Viewer” window: 1. Main Control – Clicking this button will return to the “CS Main Control” window. 2. Alarm History – Clicking this button will open the “CS Alarm History” window. 3. Alarm Summary – Clicking this button will open the “CS Alarm Summary” window.

41

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR TRENDING, LOGGING, AND REPORTING

Trending in Control Suite is the combined capability to log data to a file and also report the data on a chart or spreadsheet in either a real-time or historical display. LOGGING DATA Tags must be configured to Log Data in InTouch WindowMaker. From the tagname dictionary select the tag you want to log and check the box labeled “log data”. There are two types of data that can be trended within Control Suite. First, is real time data that can be monitored either on a “Tag Detail” window or the “16 Pen Strip Chart”. Second is logged data that can be visualized using the 8 Pen Report Wizard or Microsoft® Excel®. CS 16PT REAL TIME CHART1 Users can monitor the current value of any tag in the system by opening the “CS 16 Pen Real Time Chart1” window. This window depicts real-time trend data that is clickable. By clicking the trend, the “PenTrend Control” dialog box will open enabling the user to choose a tag to associate with a colored pen.

42

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR TRENDING, LOGGING, AND REPORTING (continued) CS 8HT PEN REPORT WIZARD1 Users can visualize previously logged data associated with any tag in the system by opening the “CS 8HT Pen Report Wizard1” window. There are two ways users can associate tags with the 8 Pen Report Wizard: 1. The first method is from any graphic point. Click a point of interest on a graphics screen. When the “Tag

Detail” window opens click the “Copy Logged Data to Report Wizard” button. Users then have the option to select a pen to represent the data. Once the user has selected a pen, they can then choose to see this data with other pens on the chart or to clear the chart and only show this pen and its logged data.

43

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR TRENDING, LOGGING, AND REPORTING (continued) 2. The second method is from the 8 Pen Report Wizard. Click the chart and you will be presented with the

“Historical Trend Setup” dialog box. From here users can select up to 8 tags that have logged data associated with them. When a user clicks the “OK” button after selecting tags the data will be displayed on the chart.

44

CONTROL SUITE APPLICATION PROTOTYPE CS WINDOWS FOR TRENDING, LOGGING, AND REPORTING (continued) There are several buttons on the 8 Pen Report Wizard. 1. The buttons immediately under the chart are provided to enable the user to select a range of time. The

“Zoom In” and “Zoom Out” buttons are associated with the scooters on the chart. NOTE: Displaying wide ranges of time can cause the chart to react slowly.

2. Buttons depicting pen colors to the left of the chart display the values of the pen immediately under the

right and left scooters. These buttons can be clicked to adjust to vertical scale to match the default scale of the tag associated with that pen.

3. Refresh Data – This will update the right side of the chart to reflect the most current logged data.

4. Save To File – This will save the data depicted on the chart to a comma separated variable (CSV) file that can be opened in Microsoft® Excel®. The name of the file is depicted to the right of “Filename:” and can be changed by clicking the blue text and typing a new path. The path must be to an existing directory.

5. Open File W/ Excel – Clicking this button will open the file referenced by “Filename” in Microsoft® Excel®.

6. Open File W/ Notepad - Clicking this button will open the file referenced by “Filename” in Notepad.

45

CONTROL SUITE APPLICATION PROTOTYPE 3. SCRIPTS

BUTTON SCRIPTS There are several button scripts associated with the buttons on the “CS Palette” window. Of these buttons only the “Schedule” button requires editing during development. Copying these buttons will make the application that is being developed function consistent during runtime. Buttons that are cells do not need to be edited. The “Schedule” button must have an appropriate URL for the i.LON 100 if one is used. DATA CHANGE SCRIPTS None of the four data change scripts that are provided with the application prototype require editing unless additional functionality is desired. Three are required for proper system functionality and the fourth is a sample. 1. $AccessLevel – This script is used to detect when a user logs on or off and assign a user rights that

correspond with the setting assigned in the “CS Password Administration Screen”.

2. $InactivityWarning – This script is used to warn the user that he / she is about to be logged off.

3. $NewAlarm – This script open the “CS Alarm Annunciation” window when a new alarm occurs.

4. CS-Fake_Discrete – This is a sample method for synchronizing memory data types between sessions on a terminal server.

KEY SCRIPTS There are four key scripts provided with the application prototype.

1. F1 - Displays the “CS Information” window if the user is logged on.

2. F2 – Logs the user off.

3. F3 – Show the “CS Main Control” window.

4. F9 – Prints the currently displayed window. APPLICATION SCRIPT The application script is important for control over logging and alarming. The application script is primarily use for the following two functions. 1. Suspends alarming until the IO Servers have had time to establish communications.

2. Suspends logging until WindowViewer can determine the session type (i.e. Workstation, Console, or Client). This is very important in the terminal server environment to prevent client sessions from attempting to write historical log data to the same file that a console session is writing to.

46

CONTROL SUITE APPLICATION PROTOTYPE QUICK FUNCTIONS There are six QuickScript functions that are provided with the application prototype. Two are provided for use by the developer; the other four support functionality built into the application prototype and should not be edited unless additional functionality is required. 1. CLEANUPINDIRECTS(CleanUpIndirects) – This is provided for use by the developer and take one

discrete argument. This script is designed to be used in conjunction with indirects. There are a number of indirects provided for use by the developer in the application prototype. Use this QuickFunction in the “On Hide” script for a window that uses indirects. If you want all the indirects cleared after the screen is no-longer visible, call the CLEANUPINDIRECTS(“1”) script and pass it a discrete 1.

a. Argument 1 = CleanUpIndirects – Discrete value that when true causes all of the indirects

provided in the application prototype to return to the unassigned state. 2. ERROR – This is provided for use by the developer and takes one string argument. Passing this script

an error message will write the error message to the log file and pop up the “CS Error” window and present the error message to the runtime user.

a. Argument 1 = ErrorMsg – String value that will be written to the log file and presented in the “CS

Error” window. 3. EVENT – This script is used in conjunction with the “Control Suite Event Scheduler” and the CS Detail

windows. This script should not be edited except to provide additional functionality. 4. LONOVRD – This script is used in conjunction with the “Control Suite Event Scheduler” and the CS

Detail windows. This script should not be edited except to provide additional functionality. 5. NET8OVRD – This script is used in conjunction with the “Control Suite Event Scheduler” and the CS

Detail windows. This script should not be edited except to provide additional functionality. 6. TAGDETAIL – This script is used in conjunction with the “Control Suite Event Scheduler” and the CS

Detail windows. This script should not be edited except to provide additional functionality.

47

TAGNAME DICTIONARY The application prototype is provided with over four hundred tags already defined. Each of these tags is prefixed with either a ‘$’ to indicate that it is an InTouch System Tag or a ‘CS-‘ to indicate that it is a Control Suite Application Prototype tag. None of these tags of either type should be deleted. CS INDIRECT TAGS The best method we have found for depicting large numbers of terminal devices such as VAV boxes or unit ventilators is indirect scripting on “Indirect Screens”. Using this method, the developer creates just one screen that represents a generic device and uses the CS Indirect Tags to populate the screen with data points. For convenience, the application prototype is provided with three hundred CS Indirect Tags for use by the developer. These indirect tags provide a simple and consistent way for assigning and unassigning tags on repetitive screens. There are three types of CS Indirect Tags: 1. Indirect Analog – There are 100 CS Indirect Tags named

“CS-Screen_Indirect_Analog_XXX” where XXX is a number between 001 and 100.

a. Assign real or integer data type tags to this CS Indirect. 2. Indirect Discrete - There are 100 CS Indirect Tags named

“CS-Screen_Indirect_Discrete_XXX” where XXX is a number between 001 and 100.

a. Assign discrete data type tags to this CS Indirect. 3. Indirect Message - There are 100 CS Indirect Tags named

“CS-Screen_Indirect_Message_XXX” where XXX is a number between 001 and 100.

a. Assign message data type tags to this CS Indirect.

48

TAGNAME DICTIONARY CS INDIRECT TAGS (continued) For example, consider a system with 50 VAV boxes. 1. Create one window depicting a Floor Plan and call it “SAMPLE Floor Plan”.

a. Put the following line in the “On Hide” script for the Floor Plan window. i. CS-LAST_SCREEN = “SAMPLE Floor Plan”

2. Create one window depicting a VAV box.

a. Place a button on the VAV window that will go back to the floor plan that you created in step 1. Put the following line in the action script for the button. i. Show CS-LAST_SCREEN;

b. Put the following line in the “On Hide” script for the VAV window. i. CALL CLEANUPINDIRECTS(1);

3. Place CS Points copied from the palette onto the VAV window and label each one.

a. (i.e. Read Only Analog ) 4. Assign each of the CS Points on the VAV window to a unique indirect tag. This can be done by double

clicking each of the CS Points and replacing the tag with an indirect tag. Use a different indirect tag for each of the CS Points. a. (i.e. CS-Screen_Indirect_Analog_001).

5. Create a button on the floor plan. 6. Create an action script within the button created in step 6 that assigns the tags associated with a VAV

to the indirects on the VAV window. The script should also open the VAV window. a. (i.e. CS-Screen_Indirect_Analog_001.Name = “SAMPLE_VAV_001_SpaceTemp”

i. SAMPLE_VAV_001_SpaceTemp is an IOReal tag that can present the value of the space temperature at VAV #1.

b. A user clicking this button in runtime will see the space temperature for VAV #1 displayed on the VAV screen.

7. Copy this button 49 times and update the action script of each button to assign the appropriate tags for

each of the VAV boxes.

REVISION 1 December 15, 2005

427 Turnpike Street Canton, MA 02021

TELEPHONE: 781-828-6770 http://www.enesystems.com/ Developer’s Guide