broadsword programming tool - aeiuk.com€¦ · open system solutions limited welcomes you to the...

Broadsword Programming Tool

All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, ormechanical, including photocopying, recording, taping, or information storage and retrieval systems - without thewritten permission of the publisher.

Products that are referred to in this document may be either trademarks and/or registered trademarks of therespective owners. The publisher and the author make no claim to these trademarks.

While every precaution has been taken in the preparation of this document, the publisher and the author assume noresponsibility for errors or omissions, or for damages resulting from the use of information contained in this documentor from the use of programs and source code that may accompany it. In no event shall the publisher and the author beliable for any loss of profit or any other commercial damage caused or alleged to have been caused directly orindirectly by this document.

Printed: July 2009.

Broadsword Programming Tool

PublisherSpecial notes:

Managing Editor

Technical Editors

Open System Solutions

Steve Brown

Steve Brown

Ross Tuck

All registered trademarks, trademarks and brand names are acknowledged as the property of their respective owners.

The content of this publication is subject to change without notice. E&OE. © 2009 Steve Brown. Issue 1.2

3Contents

3

© 2009 Steve Brown. Issue 1.2

Table of Contents

Foreword 9

Part I Introduction 11

................................................................................................................................... 111 Welcome

................................................................................................................................... 112 Aims

................................................................................................................................... 113 Prerequisites

................................................................................................................................... 114 Technical Support

................................................................................................................................... 125 Design Flow

Part II Broadsword 14

................................................................................................................................... 141 Overview

................................................................................................................................... 142 Installation

................................................................................................................................... 143 Creating The Project

................................................................................................................................... 184 Design The Device LON Interface

................................................................................................................................... 225 Add Program Functionality

................................................................................................................................... 256 Creating Schematics

.......................................................................................................................................................... 25Schematic Overview

.......................................................................................................................................................... 26Editing An Existing Schematic.

.......................................................................................................................................................... 26New Schematic Example

......................................................................................................................................................... 26Creating The Bare Schematic

......................................................................................................................................................... 28Adding a control

................................................................................................................................... 317 Generate Files and Upload

................................................................................................................................... 318 Other Significant Menu Options

.......................................................................................................................................................... 31File : Repository

.......................................................................................................................................................... 31Project : Sequence Table

.......................................................................................................................................................... 32Project : XIF Table

.......................................................................................................................................................... 32Project : Validate

.......................................................................................................................................................... 32File: Browse Device

.......................................................................................................................................................... 32Project : Generate Resource Files

.......................................................................................................................................................... 32Macro's

Part III Appendix A 34

................................................................................................................................... 341 Programming Module Descriptions

.......................................................................................................................................................... 34Alarms

......................................................................................................................................................... 34Alarm Group

......................................................................................................................................................... 34Analog Alarm

......................................................................................................................................................... 34Digital Alarm

.......................................................................................................................................................... 35Connectors

......................................................................................................................................................... 35Analog IP Input

......................................................................................................................................................... 35Analog IP Output

......................................................................................................................................................... 35Digital IP Input

......................................................................................................................................................... 36Digital IP Output

......................................................................................................................................................... 36From Snvt

......................................................................................................................................................... 36Off Page

Broadsword Programming Tool4


......................................................................................................................................................... 36On Page

......................................................................................................................................................... 36SNVT Bound

......................................................................................................................................................... 37Snvt Error

......................................................................................................................................................... 37Snvt IP Input

......................................................................................................................................................... 37Snvt IP Output

......................................................................................................................................................... 37To Snvt

.......................................................................................................................................................... 38Emerson

......................................................................................................................................................... 38Emerson Input

......................................................................................................................................................... 38Emerson Output

.......................................................................................................................................................... 38Functions

......................................................................................................................................................... 38Absolute

......................................................................................................................................................... 38Accumulator

......................................................................................................................................................... 39AdderScaler

......................................................................................................................................................... 39Analog2Binary

......................................................................................................................................................... 39Average

......................................................................................................................................................... 39Average 2

......................................................................................................................................................... 40Average 4

......................................................................................................................................................... 40Average 8

......................................................................................................................................................... 40Binary to Analogue

......................................................................................................................................................... 40Damper

......................................................................................................................................................... 41Divide

......................................................................................................................................................... 41Divide And Scale

......................................................................................................................................................... 41Enthalpy

......................................................................................................................................................... 41Hysterisis

......................................................................................................................................................... 42Input Count

......................................................................................................................................................... 42Limit

......................................................................................................................................................... 42Log

......................................................................................................................................................... 43PID Loop

......................................................................................................................................................... 45Maximum 4

......................................................................................................................................................... 46Maximum 8

......................................................................................................................................................... 46Minimum 4

......................................................................................................................................................... 46Minimum 8

......................................................................................................................................................... 46Min Max

......................................................................................................................................................... 47Multiply

......................................................................................................................................................... 47Multiply And Scale

......................................................................................................................................................... 47Rescale

......................................................................................................................................................... 47Square Root

......................................................................................................................................................... 48Subtract

......................................................................................................................................................... 48Subtract And Scale

......................................................................................................................................................... 48Add 2

......................................................................................................................................................... 48Add 4

......................................................................................................................................................... 49Add 8

.......................................................................................................................................................... 49Hardware I/O

......................................................................................................................................................... 49Analogue Input

......................................................................................................................................................... 50Analogue Output

......................................................................................................................................................... 50Digital Input

......................................................................................................................................................... 50Digital Output

.......................................................................................................................................................... 51Logic

......................................................................................................................................................... 51Analog Gate

......................................................................................................................................................... 51And 2

......................................................................................................................................................... 51And 4

......................................................................................................................................................... 52And 8

......................................................................................................................................................... 52Combination 4

......................................................................................................................................................... 52Combination 8

5Contents

5


......................................................................................................................................................... 53Comparator

......................................................................................................................................................... 53Counter

......................................................................................................................................................... 54Digital Decode 16

......................................................................................................................................................... 54Digital Decode 8

......................................................................................................................................................... 55Digital Encode 16

......................................................................................................................................................... 55Digital Encode 8

......................................................................................................................................................... 55Digital Gate

......................................................................................................................................................... 56Digital Latch

......................................................................................................................................................... 56Inverter 1

......................................................................................................................................................... 56Inverter 2

......................................................................................................................................................... 56Inverter 4

......................................................................................................................................................... 57Inverter 8

......................................................................................................................................................... 57Or 2

......................................................................................................................................................... 57Or 4

......................................................................................................................................................... 58Or 8

......................................................................................................................................................... 58Pulse

......................................................................................................................................................... 58Readback

......................................................................................................................................................... 59Digital Ring Counter

......................................................................................................................................................... 59XOR 2

......................................................................................................................................................... 59XOR 4

......................................................................................................................................................... 60XOR 8

.......................................................................................................................................................... 60Miscellaneous

......................................................................................................................................................... 60Generic IP Address

.......................................................................................................................................................... 60Modbus

......................................................................................................................................................... 60Master

......................................................................................................................................... 60Coil

......................................................................................................................................... 61Holding Register

......................................................................................................................................... 62Input Register

......................................................................................................................................... 63Input Status

.......................................................................................................................................................... 63Plots

......................................................................................................................................................... 63Plot

.......................................................................................................................................................... 64Sensor Scaling

......................................................................................................................................................... 640 to 10 Volt

......................................................................................................................................................... 644 to 20 mA

......................................................................................................................................................... 64Digital

......................................................................................................................................................... 65Resistive

......................................................................................................................................................... 65Thermistor

.......................................................................................................................................................... 65SNMP

......................................................................................................................................................... 65Slave

......................................................................................................................................................... 65Trap

.......................................................................................................................................................... 66Switches

......................................................................................................................................................... 66Analog Switch 16

......................................................................................................................................................... 66Analog Switch 2

......................................................................................................................................................... 67Analog Switch 4

......................................................................................................................................................... 67Analog Switch 8

......................................................................................................................................................... 68Digital Switch 16

......................................................................................................................................................... 68Digital Switch 2

......................................................................................................................................................... 69Digital Switch 4

......................................................................................................................................................... 69Digital Switch 8

.......................................................................................................................................................... 69Tend

......................................................................................................................................................... 69Tend Analogue

......................................................................................................................................................... 70Tend Digital

.......................................................................................................................................................... 71Time

......................................................................................................................................................... 71Clock Time



......................................................................................................................................................... 71Delay Off

......................................................................................................................................................... 72Delay On

......................................................................................................................................................... 72Run Time

......................................................................................................................................................... 72SNTP & Daylight Saving

.......................................................................................................................................................... 73Timezones

......................................................................................................................................................... 73Special Days

......................................................................................................................................................... 73Time Zone 1

......................................................................................................................................................... 74Time Zone 2

......................................................................................................................................................... 74Time Zone 3

......................................................................................................................................................... 75Time Zone 4

......................................................................................................................................................... 75Optimizer

.......................................................................................................................................................... 78Values

......................................................................................................................................................... 78Analog Constant

......................................................................................................................................................... 78Digital Constant

......................................................................................................................................................... 78String Constant

......................................................................................................................................................... 78String Variable

Part IV Appendix B 80

................................................................................................................................... 801 Schematic Control Descriptions

.......................................................................................................................................................... 80Controls Types Overview

.......................................................................................................................................................... 80On/Off

......................................................................................................................................................... 80Description

......................................................................................................................................................... 81General

......................................................................................................................................................... 82Colours

......................................................................................................................................................... 83Network

......................................................................................................................................................... 85Control List

......................................................................................................................................................... 86Text

......................................................................................................................................................... 87Position & Size

......................................................................................................................................................... 88Pop-up

.......................................................................................................................................................... 89Variable Text

......................................................................................................................................................... 89Description

......................................................................................................................................................... 89General

......................................................................................................................................................... 91Colours

......................................................................................................................................................... 92Network

......................................................................................................................................................... 95Control List

......................................................................................................................................................... 96Position & Size

......................................................................................................................................................... 97Pop-up

.......................................................................................................................................................... 98State Picture

......................................................................................................................................................... 98Description

......................................................................................................................................................... 98General

......................................................................................................................................................... 100Network

......................................................................................................................................................... 101Control List

......................................................................................................................................................... 102Position

......................................................................................................................................................... 103Pop-up

.......................................................................................................................................................... 104Static Picture

......................................................................................................................................................... 104Description

......................................................................................................................................................... 104General

......................................................................................................................................................... 105Position & Size

......................................................................................................................................................... 106Pop-up

.......................................................................................................................................................... 107Static Text

......................................................................................................................................................... 107Description

......................................................................................................................................................... 107General

......................................................................................................................................................... 108Colours

7Contents

7


......................................................................................................................................................... 109Position & Size

......................................................................................................................................................... 109Pop-up

.......................................................................................................................................................... 110Animation

......................................................................................................................................................... 110Description

......................................................................................................................................................... 111General

......................................................................................................................................................... 112Network

......................................................................................................................................................... 114ControlList

......................................................................................................................................................... 115Position

......................................................................................................................................................... 115Pop-up

.......................................................................................................................................................... 116Horizontal Bar

......................................................................................................................................................... 116Description

......................................................................................................................................................... 117General

......................................................................................................................................................... 118Colours

......................................................................................................................................................... 119Network

......................................................................................................................................................... 122Control List

......................................................................................................................................................... 123Position & Size

......................................................................................................................................................... 124Pop-up

.......................................................................................................................................................... 125Vertical Bar

......................................................................................................................................................... 125Description

......................................................................................................................................................... 125General

......................................................................................................................................................... 127Colours

......................................................................................................................................................... 128Network

......................................................................................................................................................... 131Control List

......................................................................................................................................................... 132Position & Size

......................................................................................................................................................... 133Pop-up

.......................................................................................................................................................... 134Button

......................................................................................................................................................... 134Description

......................................................................................................................................................... 134General

......................................................................................................................................................... 136Colours

......................................................................................................................................................... 137Network

......................................................................................................................................................... 140Text

......................................................................................................................................................... 141Position & Size

......................................................................................................................................................... 142Jump

.......................................................................................................................................................... 144Hot Spot

......................................................................................................................................................... 144Description

......................................................................................................................................................... 144General

......................................................................................................................................................... 147Position & Size

.......................................................................................................................................................... 147Combination

......................................................................................................................................................... 147Description

......................................................................................................................................................... 148General

......................................................................................................................................................... 149Configuration

.......................................................................................................................................................... 149Gauge

......................................................................................................................................................... 149Description

......................................................................................................................................................... 150General

......................................................................................................................................................... 151Network

......................................................................................................................................................... 153Control List

......................................................................................................................................................... 154Scale

......................................................................................................................................................... 155Annulars

......................................................................................................................................................... 156Tics

......................................................................................................................................................... 157Needle/Hub

......................................................................................................................................................... 158Captions

......................................................................................................................................................... 158Position & Size

......................................................................................................................................................... 159Pop-up

.......................................................................................................................................................... 160State Text



......................................................................................................................................................... 160Description

......................................................................................................................................................... 160General

......................................................................................................................................................... 162Network

......................................................................................................................................................... 164Control List

......................................................................................................................................................... 165Position & Size

......................................................................................................................................................... 166Text

......................................................................................................................................................... 167Colours

......................................................................................................................................................... 168Pop-up

.......................................................................................................................................................... 169Script

......................................................................................................................................................... 169Description

......................................................................................................................................................... 169General

......................................................................................................................................................... 170Network

......................................................................................................................................................... 172Control List

.......................................................................................................................................................... 172Scrolling Chart

......................................................................................................................................................... 172Description

......................................................................................................................................................... 173General

......................................................................................................................................................... 174Configuration

......................................................................................................................................................... 176Settings

......................................................................................................................................................... 177Position & Size

......................................................................................................................................................... 178Pop-up

.......................................................................................................................................................... 179State Switch

......................................................................................................................................................... 179Description

......................................................................................................................................................... 179General

......................................................................................................................................................... 181Network

......................................................................................................................................................... 183Position

......................................................................................................................................................... 184Values

......................................................................................................................................................... 185Pop-up

Foreword

Open System Solutions

9Foreword


Putting you in control

Part

IIntroduction

Introduction 11

02 July 2009

1 Introduction

1.1 Welcome

Open System Solutions Limited welcomes you to the Broadsword® programming tooldocumentation. This manual is intended for use by for systems integrators and any other person whomay have the need to program or modify a device from the Excalibur® range of controllers. Theinformation contained herein is current at the time of publication but may be updated or added to on aregular basis. It is therefore recommended that a regular check is kept for the latest version of thedocument available on our website.

To see the list of controllers that may be programmed by this tool please visit our website.

1.2 Aims

This manual will guide you through the steps needed to create the files required to configure Excalibur® controllers ready for end user application.

For device specific information that does not come under the scope of this document, please see therelevant manual for the device in question.

For thoroughly detailed instruction it is recommended that users attend a training course with OpenSystem Solutions Limited.

1.3 Prerequisites

This manual will not cover items outside of the scope of the Broadsword® programming tool.Readers are expected to have an existing working knowledge of the following as required...

· Microsoft Windows®

· SNMP

· LonWorks®

· LON® Devices· TCP/IP Networking

· Trend®

· Modbus®

· BacNET®

Also, if LON is to be implemented on the device, the latest LonMark® resource files should be installedon the working PC.

1.4 Technical Support

If you have an issue that can not be answered by this or other related documentation please contactOSS Technical Support:

Open System SolutionsTechnical SupportPhone: +44 (0)2380 453700email: [email protected]


02 July 2009

1.5 Design Flow

The following steps will be performed during the design process.

· Overview of process· Create a new Broadsword® project· Design the device interface· Add device functionality· Add HMI schematics· Generate device files· Upload project to device

Part

IIBroadsword


02 July 2009

2 Broadsword

2.1 Overview

The Broadsword® programming tool allows you to take any controller from the Excalibur® rangeand completely configure it to meet your control requirements. You are given complete control over thefollowing items...

· The LON, Trend, Modbus interface· The control strategy· Logging· Alarm handling· HMI Graphics· Time Schedules

When the completed project is generated, an XIF file that matches the device interface is automaticallycreated.

It is also possible to generate a complete set of LON resource files if required. This also enables youto supply/sell your programmed device on to a third party as a complete custom ready to use valueadded device.

2.2 Installation

Run the setup program and follow the on screen instructions.

2.3 Creating The Project

Start Broadsword® and create a new project (it is also possible to download an existing projectfrom a device).

Broadsword 15

02 July 2009

Select the device type and enter a project title (no spaces are allowed) and click OK. (As new devicesare released they will become available to select).

Now enter a page title for the first page (this can be anything that suits your requirements. A project willnormally consist of many pages) and click OK.


02 July 2009

The main window now presents itself and is ready for you to start development. If LonWorks isinstalled on the working PC you will notice that when a new project is created a Node Functional Profileis automatically added. This is because all devices that are to be LonMark® compliant must containthis profile.

A default Alarm Group is also added. Any alarm objects that are added later will initially be associatedwith this group. Alarm groups and alarm objects will be discussed later.

Double clicking on the project info box will allow you to edit project information as shown here...

The main project window is where you will graphically create your project. Because projects willobviously be larger than could be fitted on a single page, you can add as many pages to your projectas you like. Data points and objects on any page are available project wide. This allows you tostructure the project in such a way that the drawings can be used directly for the O & M manuals.

Broadsword 17

02 July 2009

To add a new drawing page select "Project, New Page" from the menu then fill in the name for the newpage when asked.


02 July 2009

2.4 Design The Device LON Interface

Expanding the LonWorks® tree in the left window pane will provide a list of all SNVT's, FunctionalProfiles and Configuration Properties that are available in the LonMark® Device Resource Catalogueas installed on the working PC. This will include the standard types along with any manufacturerspecific resource files that may have been installed.

Designing the LON interface is just a matter of dragging on to the right pane Functional Profiles asrequired. Once a profile is added it can be modified by enabling or disabling optional properties and by

Broadsword 19

02 July 2009

adding new Network Variables and Configuration Properties as required.

When you drag on a functional profile of any type you will be asked for a name. For example if youwere to have multiple VAV profiles you would name them accordingly ie: GND_FLR_VAV_1,GND_FLR_VAV_2 etc. You will also notice the option to "Reverse for Monitoring". This creates amirror image of the profile so that it can be used to monitor the original profile on another device.

You will then be asked wether to enable all optional properties. You can go back later and select whichoptional properties if any are included in the interface.

You should now have a new profile added to the drawing.


02 July 2009

Double clicking on the profile will open the edit window where you can enable or disable optionalproperties and edit default values for NVT's and Configuration Properties.

A Functional Profile is represented in Broadsword® as shown above. It is important to understandthis so that you can add new Network Variables and Configuration Properties to suit yourrequirements.

To add a new NV Input or Output to the profile, simply drag the required NV from the appropriatesection of the LonWorks tree on the left and drop it either on the User NV Inputs or Outputs section ofthe profile as required. You will then be asked to name the NV and set its default value if required.

Broadsword 21

02 July 2009


02 July 2009

To add a new CP just drag on the required type from either the Configuration Properties OR theNetwork Variable section of the LonWorks tree and drop it onto the Configuration Properties section ofthe profile.

You will then be asked to enter a new Type name for this CP (this will be used in the resource files forthis device), the name of the CP, what it applies to and a default value.

The above procedures can now be repeated to add any profiles, NV's and CP's that you require foryour device interface.

2.5 Add Program Functionality

We now divert our attention to the "Modules" tree in the left pane. If you expand the tree you will findvarious programming and interface modules that can be dragged into your project and wired togetherto provide the required functionality.

Which programming and interface modules are available for use will depend upon which device is tobe programmed with the project.

This chapter will only show you how to access data in NV's, how to access data across pages and howto wire modules together. To gain an understanding of each available module a complete list anddescription of each is provided in Appendix A at the end of this manual.

Broadsword 23

02 July 2009

Expand the connectors branch of the modules tree then drag on a From_SNVT followed by aTo_SNVT. If you then click on the connector an edit window opens that will allow you to select whichNV this connector is associated with.

The connector will then be ready to wire up to other modules. The following example shows howmodules can be wired together to perform your required task. You will also notice that an Off_Pageconnector has been added. This can be used in conjunction with the On_Page connector to make dataavailable across pages. To wire objects just click on the object connector point, then while holding themouse button down drag and release the button over the receiving connector.


02 July 2009

You will notice that all modules have an identifier (L1, S1, C2 etc). Some modules also have asequence number in an oval. This number shows you in what order the modules will be actioned in thefinal program.

If you wish to reorder the sequence of operation, from the "Project" menu select "Sequence Table".

Broadsword 25

02 July 2009

This will open the table list where you can change the order of execution for all objects. This allows youto structure your program and ensure that it runs in the intended order.

2.6 Creating Schematics

2.6.1 Schematic Overview

Schematics and other HMI functionality only apply to devices that support this capability such as the NeOSS-V3

What is a schematic ?

A schematic is a way to present information from a control system in an easy to understand humanreadable format. It may consist of buttons and switches to allow values in a system to be modified anddynamic text, animations and other graphics which can show the current status of the control system.

Schematics can be organized into an easy to follow tree or directory structure. This allows informationfor different sites and their subsystems to be segregated into manageable blocks.

How is a schematic created ?

A set of controls are made available by the software which you can place onto a schematic. Properties


02 July 2009

of these controls are edited to configure such things as colour, text, picture and what information toretrieve from the control system.

The following topics give an example of how to create a new schematic, add controls to it and adapt itto suit your needs. Appendix B contains a list of controls that are available for use on schematics.

2.6.2 Editing An Existing Schematic.

To edit an existing schematic, select 'Mode' then 'Edit' from the main menu. This will put you into editmode (providing you are logged on at a high enough security level). Then follow the same proceduresfor editing as covered in the following chapters.

From the 'Edit', 'Global Changes' menu options you can access the following window:

This dialog allows you to change selected or global codes in a schematic or group of schematics. Thisis useful when copying a job from one site to another or if a device name has been changed.

2.6.3 New Schematic Example

2.6.3.1 Creating The Bare Schematic

Add a new schematic by going to the schematics tab, <Right Clicking> in the tree list and selecting addschematic. Here you can also create a new directory to organise your files.

<%PROD_ID%> will now be in edit mode with the new blank schematic opened.

Before placing any controls we should set up the basic schematic properties. To do this <DoubleClick> in the blank window area, this will display the window as shown in figure 22.

Broadsword 27

02 July 2009

Figure 22

Various information is automatically filled in, but there are several options that may be changedas described below.

· Bitmap

<Clicking> this button will open a file dialog which can be used to load a bitmap to use as theschematic background picture.

For this example we can use the supplied fancoil bitmap called FCU.BMP which is located inthe "\ProgDir\Bitmaps\Backdrops\" directory where ProgDir relates to the location that youinstalled <%PROD_ID%>.

· Clear

This button will unload the schematic background picture.

· Colour

If a background picture is not going to be used, a background colour can be selected by<Clicking> this button.

· Refresh

The default refresh rate (rate at which information is updated from the control system) forschematics is 30 seconds. <Clicking> this button will allow you to alter this value.


02 July 2009

· Phone

Not Used.

· Script Function

Not Used

· Auto Size On Load

If this check box is ticked, the main program window will size to fit the background picture (ifloaded). We recommend drawing your background pictures to the required size and setting thisoption.

The next step is to start adding controls which is explained in the next topic.

2.6.3.2 Adding a control

When you go into edit mode, the following toolbar will be displayed.

Figure 23

This toolbar gives a selection of available control types that can be placed on a schematic. All of thesecontrols are discussed in detail later in the chapter "Control Descriptions".

If the toolbar is <Dragged> to the top or left of the main window it will 'Dock' in that position. If requiredit can be <Dragged> away from the docked position to become floating again.

Broadsword 29

02 July 2009

The toolbar can also be re-sized to your preference.

For this example choose <Click> 'Variable Text' then draw the control to the required size with themouse onto the main window. The result of this action will be a 'Variable Text' control placed on theschematic and a property editor window displaying.

The 'Variable Text' control is a text box that is used to display a piece of information from a controlsystem in a textual format. The property editor allows you to alter the look of the control to suit yourneeds, and also enables you to tell the control what information to ask the control system for.

For simplicity this example will only modify a few of the many properties available, as mentionedearlier, all controls are covered in detail later.

The property editor for the 'Variable Text' control, when first displayed, will look as in figure 24.

Figure 24

The first property of interest is 'Control Name'. Although all controls are allocated a default name, westrongly recommend that you re-name them with a name that describes its function. For example, ifthe control is going to display a room temperature it could be named "Room Temperature". In fact ifyou are following this example, edit the control name using the name just given.

The main reason for entering a meaningful name is that controls can be set to read data from othercontrols. Trying to select the right control to read from can be almost impossible if you are presentedwith a list of vague names.

Now <Click> on the 'Network' tab. The property editor will now change to look as follows:


02 July 2009

Figure 25

The three most important properties on this page are:

Device DriverWhat to read (also referred to as code).DeviceNetwork

In the 'What to read', 'Device' and 'Network' fields enter the information as required for theobject to read. This information must be supplied by the object selector..

<Double Clicking> either of the above fields will open the object selector window which will allow you toselect information that can be automatically pasted into the fields to link with data objects in the devicebeing programmed.

Once the above information has been entered, <Click> the 'General' tab then <Click> the 'OK' button.This will close the property editor. If you wish to re-edit a control, <Double Clicking> on it will open theproperty editor again.

To move the control, hold down the <Shift> key then drag the control with the mouse while pressingthe left mouse button.

To size the control, make sure that the control is selected, then as the mouse is moved over the edgesof the control the cursor will change to a sizing symbol. When this happens, hold down the left mousebutton and drag the mouse to re-size the control.

The above procedure is carried out to add other controls as required to the schematic.

When editing is completed, save the schematic.

Broadsword 31

02 July 2009

2.7 Generate Files and Upload

Once your project is ready all that is required is to upload it to the device.

From the Project menu select Generate Files followed by Upload Project and follow the on screeninstructions. Any files that need to be uploaded will be selected and grayed out. Options for other fileswill have tick boxes available for selection.

During the upload, any connected users will be logged off. Once the project has been uploaded thedevice will reboot.

2.8 Other Significant Menu Options

2.8.1 File : Repository

This menu tree has options that allow you to backup and restore projects.

2.8.2 Project : Sequence Table

By moving items up or down in the list you can alter the sequence of operation of you program.


02 July 2009

2.8.3 Project : XIF Table

By moving items up or down in the list you can alter the index of NV's in the device interface.

2.8.4 Project : Validate

Validate project ensures that all modules are updated the the current version of software.

2.8.5 File: Browse Device

This opens a web browser window.

2.8.6 Project : Generate Resource Files

This option will generate all required resource files for the device. These can then be used by theresource catalogue.

2.8.7 Macro's

If you select a group of objects on a page, you can right-click and select Create Macro. These macrosthen become available for re-use in any project.

Part

IIIAppendix A


02 July 2009

3 Appendix A

3.1 Programming Module Descriptions

3.1.1 Alarms

3.1.1.1 Alarm Group

Alarms are associated with an alarm group. Groups can be configured via the web browser for re-transmission options. There is always a Default alarm group.

· Setting the Clear input will delete all alarms in the group.· If the Snmp Trap input is connected to an SNMP TRAP module, any alarms received by this

group will be sent to the corresponding snmp trap.· The Count output contains the number of alarms in the group.· The Active output is set whenever the alarm count is greater than 0.

3.1.1.2 Analog Alarm

Generates an alarm if the value on the Input is greater than High or Lower than Low and re-transmits ifthe associated alarm group requires it. A delay can be entered to stop false alarms. The digital outputssignal the current state of the alarm. The Enable input can be used to disable the alarm if required.

The Alarm Text can be pre-set or connected to a String Constant / Variable or a SNVT.

3.1.1.3 Digital Alarm

Appendix A 35

02 July 2009

Generates an alarm if the Input value equals the Alm State and re-transmits if the associated alarmgroup requires it. A delay can be entered to stop false alarms. The digital outputs signal the currentstate of the alarm. The Enable input can be used to disable the alarm if required.

The Alarm Text can be pre-set or connected to a String Constant / Variable or a SNVT.

3.1.2 Connectors

3.1.2.1 Analog IP Input

Receives analogue values from another Excalibur® series device across a TCP/IP network. IfMaxRcvTime is exceeded the Error bit is set. When the device first starts up and data has not beenreceived the Invalid bit is set.

3.1.2.2 Analog IP Output

Enables analogue data to be sent to another Excalibur® series device across a TCP/IP network.The web viewer allows destination IP address to be set for each of these modules.

3.1.2.3 Digital IP Input

Receives digital values from another Excalibur® series device across a TCP/IP network. IfMaxRcvTime is exceeded the Error bit is set. When the device first starts up and data has not beenreceived the Invalid bit is set.


02 July 2009

3.1.2.4 Digital IP Output

Enables digital data to be sent to another Excalibur® series device across a TCP/IP network. Theweb viewer allows destination IP address to be set for each of these modules.

3.1.2.5 From Snvt

Makes data from SNVT's available to the program.

3.1.2.6 Off Page

Can be wired to any data point and make it available on any page.

3.1.2.7 On Page

Allows connection to data from off page connectors on other pages.

3.1.2.8 SNVT Bound

This connector indicates if the selected SNVT is currently bound.

Appendix A 37

02 July 2009

3.1.2.9 Snvt Error

Can be associated with an input SNVT and the output will be set if the SNVT's MaxReceiveTime hasbeen exceeded.

3.1.2.10 Snvt IP Input

Receives SNVT values from another NeOSS device across a TCP/IP network. If MaxRcvTime isexceeded the Error bit is set. When the device first starts up and data has not been received theInvalid bit is set. The destination should be wired to a SNVT.

3.1.2.11 Snvt IP Output

Enables SNVT data to be sent to another NeOSS device across a TCP/IP network. The web viewerallows destination IP address to be set for each of these modules.

3.1.2.12 To Snvt

Sends data to the selected SNVT.


02 July 2009

3.1.3 Emerson

3.1.3.1 Emerson Input

Allows read and write access to an SNMP input data item on an Emerson device. Input and Outputcan be wired to any local data point or SNVT. Poll Time says how often to read the data. If Error Timeis exceeded due to no response the Error bit is set.

3.1.3.2 Emerson Output

Allows read access to an SNMP output data item on an Emerson device. Output can be wired to anylocal data point or SNVT. Poll Time says how often to read the data. If Error Time is exceeded due tono response the Error bit is set.

3.1.4 Functions

3.1.4.1 Absolute

Output = Absolute value of the Input.

3.1.4.2 Accumulator

When Enable = TRUE...Output = Output + (Input * Scale)

Appendix A 39

02 July 2009

If Reset = TRUE then Output = 0.0

3.1.4.3 AdderScaler

Output = (Input A * Scale A) + (Input B * Scale B)

3.1.4.4 Analog2Binary

If (Input = 0.0) Output = FALSEelse Output = TRUE

3.1.4.5 Average

Output = running average of Input

3.1.4.6 Average 2

Output = (Input(A+B) / 2)


02 July 2009

3.1.4.7 Average 4

Output = (Input(A+B+C+D) / 4)

3.1.4.8 Average 8

Output = (Input(A+B+C+D+E+F+G+H) / 8)

3.1.4.9 Binary to Analogue

If (Input = FALSE) Output = 0.0else Output = 1.0

3.1.4.10 Damper

If Input change is >= Delta Output = Inputelse Output is unchanged

Appendix A 41

02 July 2009

3.1.4.11 Divide

Output = (Input / Divisor)

3.1.4.12 Divide And Scale

Output = (Input / Divisor) * Scale

3.1.4.13 Enthalpy

Output = Enthalpy RH% Temp(Deg C)

3.1.4.14 Hysterisis

If Input >= OnLevel Output = TRUEIf Input <= OffLevel Output = FALSE


02 July 2009

3.1.4.15 Input Count

Output = count of Inputs(A through H) that are TRUE

3.1.4.16 Limit

If Input > HighLimit Output = HighLimitIf Input < LowLimit Output = LowLimitElse Output = Input

3.1.4.17 Log

Output = Log(Input) * Scale

Appendix A 43

02 July 2009

3.1.4.18 PID Loop

The PID Loop has many parameters that can be used to generate the calculated output. However onlya very few of them are generally used. Any parameters that are not to be used should be set to zerowhich will cause them to be ignored for calculation purposes. The various parameters are describedbelow:

PV - Process Variable

This is the feedback signal representing the current value of the real-world item being controlled(such as room temperature or flow speed).

Os - Occupied set point

This is the desired value of the Process Variable when the Os is selected by the Set point selectinput.

Us - Unoccupied set point

This is the desired value of the Process Variable when the Us is selected by the Set point selectinput.

Dead Band

If the Process Variable is within the Dead Band area (centered around the set point) the Output isnot recalculated.

Manual

If the Manual input is TRUE the Output is set to the Manual Value and the loop is not calculated.

Ss - Set point select


02 July 2009

When this input is FALSE the Os is used for the PID calculation and when TRUE the Us is used.

E - Enable

When this input is TRUE the PID Output is calculated. Otherwise the Output is set to zero.

I Anti-Windup

When the Output reaches or passes the set limits the calculated integral is multiplied by this factorto limit integral run-away.

I Latchup

When the Output is at the limit plus this percentage, integral calculation is halted.

P Gain - Proportional Gain

The P Gain and the current error are used to calculate part of the Output value.

I Gain - Integral Gain

The I Gain is used along with time and the current error to calculate part of the Output value.

D Gain - Derivative Gain

The D Gain and the rate of error change are used to calculate part of the Output value.

Manual Value

If the Manual input is TRUE the Output is set to the Manual Value and the loop is not calculated.

Resch Time - Reschedule Time

How often the Output is re-calculated. This time is in seconds.

Bias

This value is added to the calculated Output. It may be used to provide an offset.

Max

Sets the maximum Output limit of the loop.

Min

Sets the minimum Output limit of the loop.

Slew

This value is used to limit the rate of Output change. If the calculated Output change is greaterthan Slew, the Output change is limited to Slew. This can be used for example to protect motorsand drives or to reduce jerking.

Accel FF - Acceleration Feed Forward

If the set point changes, Acceleration Feed Forward produces an immediate change of the output

Appendix A 45

02 July 2009

without waiting for an error to build up.

Fric FF - Friction Feed Forward

At low output values sometimes the Process Variable will not change due to stationary friction. Ifthis is detected, Friction Feed Forward is used to overcome this problem.

Vel FF - Velocity feed Forward

Velocity Feed Forward is a modified form of Bias. It is computed by applying a constant factor tothe set point.

Accel - Acceleration Rate

In some instances it may be necessary that the Process Variable change at a specific rate calledthe acceleration rate.

Acceleration

Current acceleration of the system.

Derivative

Current derivative value.

Integral

Current integral value.

Calc'd Output

True unlimited loop output.

Output

Output = calculation of PID loop

RMS Error

The RMS Error of the Process variable.

3.1.4.19 Maximum 4

Output = highest Input(A, B, C or D)


02 July 2009

3.1.4.20 Maximum 8

Output = highest Input(A, B, C, D, E, F, G or H)

3.1.4.21 Minimum 4

Output = lowest Input(A, B, C or D)

3.1.4.22 Minimum 8

Output = lowest Input(A, B, C, D, E, F, G or H)

3.1.4.23 Min Max

Min = minimum value of InputMax = maximum value of Input

Appendix A 47

02 July 2009

If Reset = TRUEMin = Input, Max = Input

3.1.4.24 Multiply

Output = (Input * Multiplier)

3.1.4.25 Multiply And Scale

Output = (Input * Multiplier) * Scale

3.1.4.26 Rescale

Output = Input rescaled From -- To

3.1.4.27 Square Root

Output = SquareRoot(Input) * Scale


02 July 2009

3.1.4.28 Subtract

Output = (Input - Subtractor)

3.1.4.29 Subtract And Scale

Output = (Input - Subtractor) * Scale

3.1.4.30 Add 2

Output = Input(A+B)

3.1.4.31 Add 4

Output = Input(A+B+C+D)

Appendix A 49

02 July 2009

3.1.4.32 Add 8

Output = Input(A+B+C+D+E+F+G+H)

3.1.5 Hardware I/O

3.1.5.1 Analogue Input

When an Analogue Input module is added the picture shows an unspecified input picture.

As soon as the input is associated with a scaling module it will change to display one of the picturesshown above as appropriate. The input module must be associated with a physical hardware input. Allother input configuration is done in the scaling module.

WARNING


02 July 2009

The physical input jumpers must be correctly configured on the device to avoid damage. Readthe user manual for the device in question.

3.1.5.2 Analogue Output

When an Analogue Output module is added the picture shows an unspecified input picture.

As soon as the output type is selected it will change to display one of the pictures shown above asappropriate. The output module must be associated with a physical hardware output.

3.1.5.3 Digital Input

This module will give the state of the associated physical digital input.

The digital inputs also contain de-bounced pulse counters that can be used for functionality such asmeter reading. The Pulses output gives the count of input pulses. The Reset input can be used to clearthe pulse count.

3.1.5.4 Digital Output

This will drive the associated hardware digital output on or off.

Appendix A 51

02 July 2009

3.1.6 Logic

3.1.6.1 Analog Gate

If Enable = FALSE Output = Input AElse Output = Input B

3.1.6.2 And 2

If Input(A&B) = TRUE Output = TRUEElse Output = FALSE

3.1.6.3 And 4

If Input(A&B&C&D) = TRUE Output = TRUEElse Output = FALSE


02 July 2009

3.1.6.4 And 8

If Input(A&B&C&D&E&F&G&H) = TRUE Output = TRUEElse Output = FALSE

3.1.6.5 Combination 4

If Inputs match any condition Output = TRUEElse Output = FALSE

State No: indicates which condition is matched.

Conditions: 0 = FALSE, 1 = TRUE, * = IGNORE

3.1.6.6 Combination 8

If Inputs match any condition Output = TRUEElse Output = FALSE

Appendix A 53

02 July 2009

State No: indicates which condition is matched.

Conditions: 0 = FALSE, 1 = TRUE, * = IGNORE

3.1.6.7 Comparator

Six different types of comparator are available:

· > A is greater than B· >= A is greater than or equal to B· = A equals B· != A does not equal B· <= A is less than or equal to B· < A is less than B

In all cases, if the test result is TRUE, the Output will be TRUE and the !Output will be the inverse.

3.1.6.8 Counter

If Reset = TRUE Output = 0Else If Load = TRUE Output = PreloadData Else If Input changes from FALSE to TRUE Output = (Output + 1)


02 July 2009

3.1.6.9 Digital Decode 16

Outputs give Binary representation of the Input

3.1.6.10 Digital Decode 8

Outputs give Binary representation of the Input

Appendix A 55

02 July 2009

3.1.6.11 Digital Encode 16

Output = Analogue representation of Binary Inputs

3.1.6.12 Digital Encode 8

Output = Analogue representation of Binay Inputs

3.1.6.13 Digital Gate

If Enable = FALSE Output = Input AElse Output = Input B


02 July 2009

3.1.6.14 Digital Latch

If Reset = TRUE Output = FALSEElse If Enable = TRUE If ToHigh changes from FALSE to TRUE Output = TRUE If ToLow changes from TRUE to FALSE Output = TRUE

3.1.6.15 Inverter 1

Output = Inverted value of Input

3.1.6.16 Inverter 2

Output(A,B) = Inverted value of Input(A,B)

3.1.6.17 Inverter 4

Output(A,B,C,D) = Inverted value of Input(A,B,C,D)

Appendix A 57

02 July 2009

3.1.6.18 Inverter 8

Output(A,B,C,D,E,F,G,H) = Inverted value of Input(A,B,C,D,E,F,G,H)

3.1.6.19 Or 2

If Input(A or B) = TRUE Output = TRUEElse Output = FALSE

3.1.6.20 Or 4

If Input(A or B or C or D) = TRUE Output = TRUEElse Output = FALSE


02 July 2009

3.1.6.21 Or 8

If Input(A or B or C or D or E or F or G or H) = TRUE Output = TRUEElse Output = FALSE

3.1.6.22 Pulse

If Input goes from FALSE to TRUE then Output will pulse to TRUE then back to FALSE next time round the program

3.1.6.23 Readback

If A = B then Output = FALSEelse after GraceTime Output = TRUE

Appendix A 59

02 July 2009

3.1.6.24 Digital Ring Counter

Each time Input changes state the next Output(A,B,C,D,E,F,G or H) in sequencebecomes set to TRUE and the previous Output is set to FALSE.

If Reset is TRUE then Output A is set to TRUE and the previous Output is set to FALSE.

3.1.6.25 XOR 2

If only 1 Input(A or B) = TRUE Output = TRUEElse Output = FALSE

3.1.6.26 XOR 4

If only 1 Input(A or B or C or D) = TRUE Output = TRUEElse Output = FALSE


02 July 2009

3.1.6.27 XOR 8

If only 1 Input(A or B or C or D or E or F or G or H) = TRUE Output = TRUEElse Output = FALSE

3.1.7 Miscellaneous

3.1.7.1 Generic IP Address

The Generic IP Address module is used by other modules that need an IP connection. A port rangecan be selected which will be cycled through to the next port each time the port opened.

Setting the Enable input opens the port, while clearing it closes the port.

3.1.8 Modbus

3.1.8.1 Master

3.1.8.1.1 Coil

Allows read/write communication to a ModBus Coil register on a ModBus slave.

Poll Time

How often to poll the device for data.

Appendix A 61

02 July 2009

Error Time

If data is not received with in Poll Time the Error output will be set.

Slave Address

Address of the ModBus device

Offset

Register offset/number within the ModBus device of the required data.

Output

Value of data read back from ModBus device.

Invalid

This bit is set until data is received from the ModBus device for the first time.

3.1.8.1.2 Holding Register

Allows read/write communication to a ModBus Holding Register on a ModBus slave.

Poll Time


Error Time


Slave Address


Offset


Format

How to format the received data. The format options can be seen in the editor window.


02 July 2009

Scale

Received data will be multiplied by this value and transmitted data will be divided by this value.

Output


Invalid


3.1.8.1.3 Input Register

Allows read only communication to a ModBus Input Register on a ModBus slave.

Poll Time


Error Time


Slave Address


Offset


Format

How to format the received data. The format options can be seen in the editor window.

Scale

Received data will be multiplied by this value and transmitted data will be divided by this value.

Output


Invalid

Appendix A 63

02 July 2009


3.1.8.1.4 Input Status

Allows read only communication to a ModBus discrete Input on a ModBus slave.

Poll Time


Error Time


Slave Address


Offset


Output


Invalid


3.1.9 Plots

3.1.9.1 Plot

If Enable = TRUE the Input is logged at the selected Period.

If Reset is TRUE the log is emptied.


02 July 2009

There are inbuilt options to set the plot as continuous or rolling.

3.1.10 Sensor Scaling

3.1.10.1 0 to 10 Volt

When associated with an analogue input this module will scale the 0-10 Volt input signal betweenSensor Value @ 0V and Sensor Value @ 10V. The correction if set is then added to the result.

WARNING

The physical analogue input jumpers must be correctly configured on the device to avoiddamage. Read the user manual for the device in question.

3.1.10.2 4 to 20 mA

When associated with an analogue input this module will scale the 4-20 mA input signal betweenSensor Value @ 4mA and Sensor Value @ 20mA. The correction if set is then added to the result.The input and the scaling module will function down to 0mA.

WARNING


3.1.10.3 Digital

When associated with an analogue input this module will scale the input signal to be On or Off. Anyinput greater than 0 is deemed to be On.

WARNING


Appendix A 65

02 July 2009

3.1.10.4 Resistive

When associated with an analogue input this module will give the reading in Ohms of the connectedresistor. The correction if set is then added to the result.

WARNING


3.1.10.5 Thermistor

When associated with an analogue input this module will scale the input signal to fit the thermistor typeselected in the module editor window. The correction if set is then added to the result.

WARNING


3.1.11 SNMP

3.1.11.1 Slave

The Read and Write Community should be set as required and the input should be connected to thedata item that is to be made available to SNMP monitoring/management tools.

If a project contains any SNMP modules, a MIB file is automatically produced when the project isgenerated.

3.1.11.2 Trap


02 July 2009

The SNMP alarm trap output should be connected to the associated alarm group. The Read and WriteCommunity should be set as required. The module also has a TRAP IP destination address thatshould be set by the SNMP monitoring/management software.

If a project contains any SNMP modules, a MIB file is automatically produced when the project isgenerated.

3.1.12 Switches

3.1.12.1 Analog Switch 16

Value of Index selects which Input is sent to Output

Example:

Index = 1, Output = Input AIndex = 16, Output = Input P

If Index < 1 or > 16 Output = 0



Example:

Index = 1, Output = Input AIndex = 2, Output = Input B


Appendix A 67

02 July 2009



Example:

Index = 1, Output = Input AIndex = 4, Output = Input C




Example:

Index = 1, Output = Input AIndex = 8, Output = Input H



02 July 2009

3.1.12.5 Digital Switch 16


Example:

Index = 1, Output = Input AIndex = 16, Output = Input P

If Index < 1 or > 16 Output = FALSE



Example:

Index = 1, Output = Input AIndex = 2, Output = Input B


Appendix A 69

02 July 2009



Example:

Index = 1, Output = Input AIndex = 4, Output = Input C




Example:

Index = 1, Output = Input AIndex = 8, Output = Input H


3.1.13 Tend

3.1.13.1 Tend Analogue


02 July 2009

This module allows read/write access to analogue values in a Trend outstation.

The outstation address, lan and code [K1(V) etc] are entered in the editor window and can be changedvia the web interface (in NeOSS Configuration).

The communication type (RS232, EINC, IQ3) is also configured via the web interface.

Input

Data to send to Trend outstation.

Poll Time

How often to poll the Trend outstation for data.

Error Time


Enable

Enable or disable communications.

Force Write

If the Trend data does not match the Input and this bit is set, local data will be sent to the Trendoutstation even if the Input has not recently been changed.

Output

Value of data read back from Trend outstation.

Invalid

This bit is set until data is received from the Trend outstation for the first time.

3.1.13.2 Tend Digital

This module allows read/write access to digital values in a Trend outstation.

The outstation address, lan and code [W1(S) etc] are entered in the editor window and can bechanged via the web interface (in NeOSS Configuration).

The communication type (RS232, EINC, IQ3) is also configured via the web interface.

Input

Data to send to Trend outstation.

Appendix A 71

02 July 2009

Poll Time

How often to poll the Trend outstation for data.

Error Time


Enable

Enable or disable communications.

Force Write

If the Trend data does not match the Input and this bit is set, local data will be sent to the Trendoutstation even if the Input has not recently been changed.

Output

Value of data read back from Trend outstation.

Invalid

This bit is set until data is received from the Trend outstation for the first time.

3.1.14 Time

3.1.14.1 Clock Time

The clock module makes the clock time available to the user program. MSM is Minutes SinceMidnight.

3.1.14.2 Delay Off

I

If Input goes from TRUE to FALSE Output will be set to FALSE after Delay time in seconds

If Input is TRUE or goes from FALSE to TRUE Output = TRUE


02 July 2009

3.1.14.3 Delay On

If Input goes from FALSE to TRUE Output will be set to TRUE after Delay time in seconds

If Input is FALSE or goes from TRUE to FALSE Output = FALSE

3.1.14.4 Run Time

While Input = TRUE and Reset = FALSE Total times increment.

If Reset = TRUE Total times are reset to 0

If Hours = 1 thenMinutes = 60Seconds = 3600

3.1.14.5 SNTP & Daylight Saving

The SNTP module serves two functions. The first is time synchronization to an NTP server. Thesecond is the management of daylight saving settings.

If the Enable Sntp bit is TRUE the module will try to communicate with an NTP server at Address to

Appendix A 73

02 July 2009

obtain the current UTC time. The UTC Offset value will then be used to modify the time as required.

If the Enable DST bit is TRUE the DST start and stop parameters will be used to adjust the currenttime by DST Minutes. The DST Active output indicates wether daylight saving is active.

3.1.15 Timezones

3.1.15.1 Special Days

Allows selection of special days

TZ1 and TZ2 should be connected to the Optimizer outputs of the standard Time Zone and specialTime Zone respectively

If Enable = TRUE If today is special day switch through TZ2 to the Optimizer output Else switch through TZ1 to the Optimizer outputELSE switch through TZ1 to the Optimizer output

Special Day is TRUE if it is considered a special day.

Active is TRUE is the currently selected time zone is active.

3.1.15.2 Time Zone 1

Time zone with 1 on/off period per day.

When the clock time is within the on period the Active output will be TRUE and the !Active output willbe the inverse.

If the Ovrde On input is TRUE the Active output will be forced to TRUE.If the Ovrde Off input is TRUE the Active output will be forced to FALSE.Ovrde Off takes precidence.

Next Event contains minutes to next event.

The Optimizer output feeds time zone information to Special Days and Optimizer modules.


02 July 2009


Time zone with 2 on/off periods per day











Appendix A 75

02 July 2009







3.1.15.6 Optimizer

The Optimizer module allows start-up and cool down optimization of both heating and cooling. whilstthe terminology used all relates to heating and cooling, the optimizer can in fact be used for anyprocess that requires start-up or shut down optimization.

The various control parameters of the optimizer are described below:


02 July 2009

Enable

Enables or disables the optimizer.

Optimize On

Enables the module to perform Start-Up optimization.

Optimize Off

Enables the module to perform Shut Down optimization.

Timezone

This should be connected to the Optimizer output of the time zone that is to be optimized.

PV - Process Variable

This is the feedback signal representing the current value of the real-world item being controlled(such as room temperature or flow rate).

SP - Set Point

This is the target value that the control system needs to achieve.

Deadband

The Deadband is centered around the set point. If the PV is within the Deadband, optimization willnot be performed.

OAT - Outside Air Temperature

If available the OAT is used in the calculation of the heating and cooling gains and losses toprovide more accuracy.

OAT Enabled

Set this bit if the OAT is available to the module.

Compensator

This value is a percentage of the Gain/Loss and will be added the the Gain/Loss.

Max Heat On

Maximum number of minutes that the optimizer is allowed to modify the Heat On time by.

Max Heat Off

Maximum number of minutes that the optimizer is allowed to modify the Heat Off time by.

Max Cool On

Maximum number of minutes that the optimizer is allowed to modify the Cool On time by.

Max Cool Off

Appendix A 77

02 July 2009

Maximum number of minutes that the optimizer is allowed to modify the Cool Off time by.

Use Overrides

If this bit is set, the optimizer will not use the calculated Gains and Losses but will instead use theoverride values.

Heat Gain Override

Value in °C per minute of Heat Gain to use when the Use Overrides bit is set.

Heat Loss Override

Value in °C per minute of Heat Loss to use when the Use Overrides bit is set.

Cool Gain Override

Value in °C per minute of Cool Gain to use when the Use Overrides bit is set.

Cool Loss Override

Value in °C per minute of Cool Loss to use when the Use Overrides bit is set.

Active !Active

These are the optimized outputs that replace the similar named outputs of the connected timezone and give the state of the optimized time zone.

Mode

Outputs the current mode of the optimizer. The various states are:

· START-UP 0· IDLE 1· HEATING-ON 2· COOLING-ON 3· MONITORED-HEATING-ON 4· MONITORED-COOLING-ON 5· MONITORED-HEATING-OFF 6· MONITORED-COOLING-OFF7· IDLE-ON 8· IDLE-OFF 9

Next Event

This is an optimized output that replaces the similar named output of the connected time zone. Itcontains minutes to next event.

Estimate

Current estimate of how long the system will take to reach target.


02 July 2009

3.1.16 Values

3.1.16.1 Analog Constant

Store for an analogue constant value.

3.1.16.2 Digital Constant

Store for a digital constant value.

3.1.16.3 String Constant

Store for a string constant value.

3.1.16.4 String Variable

Store for a string variable value.

Part

IVAppendix B


02 July 2009

4 Appendix B

4.1 Schematic Control Descriptions

4.1.1 Controls Types Overview

In the following chapters each of the available control types are described. The format of thedescriptions is as follows:

· Description

A description of the purpose of the control.

· Property topics

A list of topics which cover each of the property editor tabs for this control type.

A picture of every editor tab is given along with a description of the purpose and effect of eachproperty.

Control types available in this version of <%PROD_ID%> are:

On/OffVariable TextState PictureStatic PictureStatic Text AnimationHorizontal BarVertical BarButtonHot SpotCombinationGaugeState TextScriptScrolling Chart

As <%PROD_ID%> evolves new types may be added along with suitable documentation updates.These will be available at.

http://www.opensystemsolutions.co.uk

4.1.2 On/Off

4.1.2.1 Description

The On/Off control is a simple object that is used to read data from a device and display a piece of textto describe the state of that data.

If enabled the control can be clicked on at run-time to enable retrieval and display of a data log from anetwork device.

Two text strings can be entered, one of which will be displayed when the input data is non zero(classed as an ON state) and the other which will be displayed when the data is zero (OFF state).

http://www.opensystemsolutions.co.uk

Appendix B 81

02 July 2009

Various properties are adjustable that allow the look of the control to be altered to suit your needs.

4.1.2.2 General

· Control Name

A unique name to identify this control within the schematic.

· BorderStyle

Selects the type of border that is draw around the control.

· Vertical Alignment

Determines whether text is justified to the top, bottom or centre of the control.

· Horizontal Alignment

Determines whether text is justified to the left, right or centre of the control.

· Font

Opens a font selection dialog. The selected font is used to display text in the control.

· OK

Closes the property editor.

· Help

Displays the online help for the control.

· Invisible

If ticked, makes this control invisible at runtime. This is useful if the control is just being used


02 July 2009

as a data source for other controls and has no visual importance.

· Translate

Opens the translation edit window. This allows you to enter data that controls what the usersee's and what is sent to the driver.For more detailed information see the chapter about the translation editor.

· Use Translations

If ticked and translations have been setup, they will be used. If un-ticked, translations will beignored.

· Display Transparent

If ticked, hides the background of the control in run mode.

· Hint

Enter text that explains purpose of control to user.

· Show Hint

If ticked the hint text will be shown to the user when the mouse pauses over the control.

4.1.2.3 Colours

<Clicking> On a coloured box displays a colour selection dialog.

· Off State Colours

The colours selected here will be used to display the text when the data received by the controlis OFF

· On State Colours

Appendix B 83

02 July 2009

The colours selected here will be used to display the text when the data received by the controlis ON

4.1.2.4 Network

· Device Driver

Select the device driver from which this control should request its data.

· What to read (sometimes referred to as code)

Digital object to read - Consult 'Adding a control' topic for further information.

· Device

Device to read object from - Consult 'Adding a control' topic for further information.

· Network

Network on which device resides - Consult 'Adding a control' topic for further information.

· Access Level

Security level at which a user must be logged on to be able to adjust status of the digital object(ie: change from Off to On) or to be able to open the terminal window.

· Plot Code

If the device can log its own data, enter the code here that will retrieve the data for graphing -Consult 'Adding a control' topic for further information.

· Use Global Device/Network

A jump from another schematic can pass in new Code, Device and Network values. If this box


02 July 2009

is ticked, these are used in place of the values entered here. This facility enables oneschematic to be used for multiple devices.

If a control is to look at different codes when a jump is performed, a list of codes has to begiven to the control. To do this, <Right Click> on the 'What To Read' field. This will show apop-up menu from which you should select 'Multiple Codes'. This will display the followingwindow where you can add or remove codes.

· Terminal Access

When ticked, and if the selected driver supports terminal mode the user can <Right Click> onthe control at run time to open the terminal window. Consult 'Adding a control' topic for furtherinformation.

Appendix B 85

02 July 2009

4.1.2.5 Control List

· Get Data From

This combo box allows you to select from a list of other controls that are on this schematic. Ifthis property is not empty, this control will source its data from the selected control INSTEADof from the network.

Any non zero value supplied to this control will be treated as an ON condition and any zerovalue will be treated as an OFF condition.

If the type of the source control is not a combination module, the following properties will bedisabled otherwise they are use to select from which output of the combination module tosource the data.

· Read Combination

If the type of the source control is a combination module, the data can be read from one ofseveral outputs as follows:

· D/A Output

Source data from combination module Digital to Analogue output (this is the decimal valuecalculated from the 8 digital inputs of a combination module).

· Count Output

Source data from combination module Count output (this is a count of how many inputs to thecombination module are non zero).

· State Number

Source data from one of the state condition outputs of a combination module. The state to useis selected with the 'State To Use' property.


02 July 2009

· Any State Output

If any of the state condition outputs of a combination module are true, this control will showON, otherwise it will show OFF.

· State Number To Use

Which state output to read from a combination module. Only relevant if 'State Number' isselected.

4.1.2.6 Text

· On Text

Enter the text that will be displayed when the incoming data is non zero or ON.

· Off Text

Enter the text that will be displayed when the incoming data is zero or OFF.

Appendix B 87

02 July 2009

4.1.2.7 Position & Size

· Left/Right

Moving this slider will move the controls horizontal position on the schematic.

· Up/Down

Moving this slider will move the controls vertical position on the schematic.

· Size

Pressing this button will change the function of the sliders so that they will re-size the controlinstead of moving it.


02 July 2009

4.1.2.8 Pop-up

· Schematic

<Click> here to select the schematic to open as a pop-op when this control is <Right Clicked>on.

· Device

A device can be entered here that will be passed to all controls on the pop-up schematic.Consult 'Adding a control' topic for further information.

· Network

A network can be entered here that will be passed to all controls on the pop-up schematic.Consult 'Adding a control' topic for further information.

· Description

Text entered in this property will be passed to the pop-up schematic and will be used by anystatic text controls that have their Use Global Description property set.

· Code Index

If this property is greater than zero this number tells the controls on the pop-up schematicwhich code to use to retrieve their data (if the controls have multiple codes entered).

· Open Centered

If checked the pop-up schematic will open centered on the screen.

· Use Controls Device/Network

If checked and this control is using a global device/network it will pass it on to the pop-upschematic

Appendix B 89

02 July 2009

4.1.3 Variable Text

4.1.3.1 Description

The Variable Text control is an object that is used to read and display data from a device. If enabledthe control can be clicked on at run-time to allow adjustment of the value or to retrieve and display adata log from a network device.

Various properties are adjustable that allow the look of the control to be altered to suit your needs.

4.1.3.2 General

· Control Name


· BorderStyle







02 July 2009

· Font


· Translate


· Use Translations


· OK


· Help


· Invisible

If ticked, makes this control invisible at runtime. This is useful if the control is just being usedas a data source for other controls and has no visual importance.



· Hint


· Show Hint


Appendix B 91

02 July 2009

4.1.3.3 Colours


· BackGround

Background colour of control.

· Text

Font colour used for displayed text.

· Normal Text Colours

Colours used to display the text when the incoming data is within alarm limits.

· High Alarm text Colours

Colours used to display the text when the incoming data is equal to or above the controls highalarm limit.

· Low Alarm Text Colours

Colours used to display the text when the incoming data is equal to or below the controls lowalarm limit.


02 July 2009

4.1.3.4 Network

· Device Driver



Object to read - Consult 'Adding a control' topic for further information.

· Device


· Network


· Access Level

Security level at which a user must be logged on to be able to adjust the value of the object orto be able to open the terminal window.

· High Alarm

If the value received by this control is equal to or above the value entered here, the text displaycolours will be changed to those set on the colours tab.

· Low Alarm

Appendix B 93

02 July 2009

If the value received by this control is equal to or below the value entered here, the text displaycolours will be changed to those set on the colours tab.

· Tick If Adjustable

If you wish a user to be able to adjust the value displayed by this control, this box must beticked.

· Tick If Item Is Numeric

If the value displayed is numeric, tick this box. This affects the type of input box that isdisplayed to the user to make an adjustment.

· Upper Limit

If the value is numeric and adjustable, this value sets the upper limit of the users input range.

· Lower Limit

If the value is numeric and adjustable, this value sets the lower limit of the users input range.

· Enumerations

If the value is adjustable and you want to limit the adjustments to a set of predefined values,enter the allowed values into this field with each one being separated by a comma. Forexample:

Off,Manual,Auto

or

19,20,21,22,23

When the user <Clicks> on the control to adjust the value, a dialog window opens presentingthe list of allowed values to choose from. When the user makes a selection one of two thingswill happen depending on the state of the check box called 'Tick If Item Is Numeric'.

If the check box is not ticked, the chosen value will be sent to the device driver.

If the check box is ticked, a number representing the position of the selection in the list is sentto the device driver.

ie: If Off was selected, 0 will be sent to the driver.If Auto was selected, 3 will be sent to the driver.If 20 was selected, 1 will be sent to the driver.

To enable the normal adjustment dialogs just empty this field.

· Prefix

Any text entered into this field will be prepended with a space to the displayed value.

· Units

Any text entered into this field will be added with a space to the displayed value. The dropdown list contains some standard units.


02 July 2009

· Plot Code


· Password

Any text entered here is passed to the device driver when an adjustment is carried out -Consult 'Adding a control' topic for further information.


If the viewer of a schematic should be able to adjust


A jump from another schematic can pass in new Code, Device and Network values. If this boxis ticked, these are used in place of the values entered here. This facility enables oneschematic to be used for multiple devices.


· Terminal Access

When ticked, and if the selected driver supports terminal mode the user can <Right Click> on

Appendix B 95

02 July 2009

the control at run time to open the terminal window. Consult 'Adding a control' topic for furtherinformation.


· Get Data From



· Read Combination


· D/A Output


· Count Output



02 July 2009

· State Number


· Any State Output

If any of the state condition outputs of a combination module are true, this control will show 1,otherwise it will show 0.




· Left/Right


· Up/Down


· Size

Pressing this button will change the function of the sliders so that they will re-size the control

Appendix B 97

02 July 2009

instead of moving it.

4.1.3.7 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index



02 July 2009

· Open Centered




4.1.4 State Picture

4.1.4.1 Description

The State Picture control is an object that is used to read data from a device and then display a pictureto show the status of the data.

In order to achieve this, a bitmap is created containing a number of equally sized pictures (calledframes) placed side by side, much like a strip of movie film.

Which frame is displayed is dependent on the data received by the control. For example, if theincoming data were to be 3 then frame 3 would be displayed. If the incoming data were to be 0 thenframe 0 would be displayed (the first frame in the strip is frame 0). Some example bitmaps are shownin the 'Network' section about this control.

This control can be used to great effect with the Combination control to monitor multiple digital valuesthat may describe whether a pump is running, stopped or failed.

4.1.4.2 General

· Control Name


· BorderStyle


· OK

Appendix B 99

02 July 2009


· Help


· Picture

Displays a bitmap selector so that a bitmap that contains a set of pictures can be loaded. Thebitmap selector is discussed in the chapter called "The Bitmap Selector".

The bitmap should consist of a strip of equal size picture frames. Here are a couple ofexamples:

· Clear

Unloads the current bitmap.

· No: Frames

Tells the control how many individual picture frames are contained in the loaded bitmap. Bothof the above examples contain 2 frames.

· Display Picture Transparent

When ticked this tells the control to display the picture transparently. The control uses thecolour of the bottom left pixel as the transparent colour.If the control is a type that uses multi-frame pictures, each frame must have its bottom left pixelset to the required transparent colour.

· Translate


· Use Translations



02 July 2009

4.1.4.3 Network

· Device Driver



Object to read - consult Consult 'Adding a control' documentation for further information.

· Device


· Network





Appendix B 101

02 July 2009

· Terminal Access



· Get Data From

This combo box allows you to select from a list of other controls that are on this schematic. If


02 July 2009

this property is not empty, this control will source its data from the selected control INSTEADof from the network.


· Read Combination


· D/A Output


· Count Output


· State Number


· Any State Output




4.1.4.5 Position

Appendix B 103

02 July 2009

· Left/Right


· Up/Down


This control automatically sizes to fit the size of a single picture frame (as contained in the loadedbitmap).

4.1.4.6 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered


02 July 2009




4.1.5 Static Picture

4.1.5.1 Description

The Static Picture control is used only to display a picture or to open a pop-up schematic. It has noother function or purpose.

4.1.5.2 General

· BorderStyle


· Size Control To Fit Picture

When ticked, the control will size to fit the loaded picture. If not ticked, the picture is stretchedto fit the control.

· Picture

Displays a bitmap selector so that a bitmap can be loaded. The bitmap selector is discussed inthe chapter called "The Bitmap Selector".

· Clear

Unloads the current bitmap from the control.


When ticked this tells the control to display the picture transparently. The control uses the

Appendix B 105

02 July 2009

colour of the bottom left pixel as the transparent colour.If the control is a type that uses multi-frame pictures, each frame must have its bottom left pixelset to the required transparent colour.

· OK


· Help



· Left/Right


· Up/Down


· Size



02 July 2009

4.1.5.4 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered




Appendix B 107

02 July 2009

4.1.6 Static Text

4.1.6.1 Description

The Static Text control is used only to display a piece of text. It has no other function or purpose.

4.1.6.2 General

· BorderStyle


· Caption

Text that this control will display.





· Font


· OK


· Help



02 July 2009

· Use Global Description

A jump from another schematic can pass in a new caption. If this box is ticked, this new text isdisplayed in place of the caption entered here.



4.1.6.3 Colours


The colours selected here will be used to display the text entered in the caption property.

Appendix B 109

02 July 2009


· Left/Right


· Up/Down


· Size


4.1.6.5 Pop-up


02 July 2009

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered




4.1.7 Animation

4.1.7.1 Description

The Animation control will run a picture animation (like a movie film strip) when its input value is nonzero. When the input is zero the animation will stop.

Appendix B 111

02 July 2009

4.1.7.2 General

· Control Name


· BorderStyle


· Picture


The bitmap should consist of a strip of equal size picture frames. Here is an example:

The first frame in the set is the one that will be displayed when the animation is stopped. Whenrunning the rest of the frames are displayed in sequence.

· Clear


· No: Frames

Tells the control how many individual picture frames are contained in the loaded bitmap. Theabove examples contain 4 frames.




02 July 2009

· Run when Off not On

This will invert the run state of the control. (i.e. it will run when the network data is off).

· Run

<Clicking> This button will start the animation running so that you can see how it will look whenthe schematic is working.

· Stop

<Clicking> This button will stop the animation from running.

· Translate


· Use Translations


· OK


· Help


4.1.7.3 Network

· Device Driver



Appendix B 113

02 July 2009


· Device


· Network





· Terminal Access



02 July 2009

4.1.7.4 ControlList

· Get Data From



· Read Combination


· D/A Output


· Count Output


· State Number


· Any State Output



Appendix B 115

02 July 2009


4.1.7.5 Position

· Left/Right


· Up/Down


This control automatically sizes to fit the size of a single picture frame (as contained in the loadedpicture).

4.1.7.6 Pop-up

· Schematic



02 July 2009

· Device


· Network


· Description


· Code Index


· Open Centered




4.1.8 Horizontal Bar

4.1.8.1 Description

The Bar controls are used to display a coloured sliding bar that changes with its input value. This canbe used to represent such things as tank levels or thermometer readings if overlayed on a suitablebackground picture.

Appendix B 117

02 July 2009

4.1.8.2 General

· Control Name


· BorderStyle






· Font


· Translate


· Use Translations


02 July 2009


· Display Caption

If ticked, the control displays the value in text format as well as a sliding bar colour. Whenun-ticked, no text is displayed.

· OK


· Help


· Hint


· Show Hint


4.1.8.3 Colours


· BackGround

Appendix B 119

02 July 2009


· Text


· Bar

The Colour used to display the sliding bar portion of the control.

· Normal Colours

Colours used to display the bar control when the incoming data is within alarm limits.

· High Alarm Colours

Colours used to display the bar control when the incoming data is equal to or above thecontrols high alarm limit.

· Low Alarm Colours

Colours used to display the bar control when the incoming data is equal to or below thecontrols low alarm limit.

4.1.8.4 Network

· Device Driver



02 July 2009



· Device


· Network


· Access Level


· High Alarm


· Low Alarm


· Upper Value

This property sets the upper limit of the bars display range.

· Lower Value

This property sets the lower limit of the bars display range.



· Upper Limit


· Lower Limit


· Prefix


· Units


Appendix B 121

02 July 2009

· Plot Code


· Password







· Terminal Access



02 July 2009


· Get Data From



· Read Combination


· D/A Output


· Count Output


Appendix B 123

02 July 2009


· Left/Right


· Up/Down


· Size



02 July 2009

4.1.8.7 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered


Appendix B 125

02 July 2009



4.1.9 Vertical Bar

4.1.9.1 Description

The Bar controls are used to display a coloured sliding bar that changes with its input value. This canbe used to represent such things as tank levels or thermometer readings if overlayed on a suitablebackground picture.

4.1.9.2 General

· Control Name


· BorderStyle






02 July 2009


· Font


· Translate


· Display Caption

If ticked, the control displays the value in text format as well as a sliding bar colour. Whenun-ticked, no text is displayed.

· OK


· Help


· Hint


· Show Hint


Appendix B 127

02 July 2009

4.1.9.3 Colours


· BackGround


· Text


· Bar

The Colour used to display the sliding bar portion of the control.

· Normal Colours

Colours used to display the bar control when the incoming data is within alarm limits.

· High Alarm Colours

Colours used to display the bar control when the incoming data is equal to or above thecontrols high alarm limit.

· Low Alarm Colours

Colours used to display the bar control when the incoming data is equal to or below thecontrols low alarm limit.


02 July 2009

4.1.9.4 Network

· Device Driver




· Device


· Network


· Access Level


· High Alarm


· Low Alarm

Appendix B 129

02 July 2009


· Upper Value

This property sets the upper limit of the bars display range.

· Lower Value

This property sets the lower limit of the bars display range.



· Upper Limit


· Lower Limit


· Prefix


· Units


· Plot Code


· Password






If a control is to look at different codes when a jump is performed, a list of codes has to begiven to the control. To do this, <Right Click> on the 'What To Read' field. This will show apop-up menu from which you should select 'Multiple Codes'. This will display the following


02 July 2009

window where you can add or remove codes.

· Terminal Access


Appendix B 131

02 July 2009


· Get Data From



· Read Combination


· D/A Output


· Count Output



02 July 2009


· Left/Right


· Up/Down


· Size


Appendix B 133

02 July 2009

4.1.9.7 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered



02 July 2009



4.1.10 Button

4.1.10.1 Description

The Button Control has several functions that it can perform as listed below:

Turn something On or Off on a network device.Jump to another schematic.Display a graph of a Data Log Template.Run a user supplied VBScript.Run a driver specific function.

The button can look like a standard windows button with user selected colours or can have a bitmaploaded to make it look any way the user chooses (ie: like a toggle switch etc).

4.1.10.2 General

· Control Name


· BorderStyle

Appendix B 135

02 July 2009






· Font


· OK


· Help


· Picture

Displays a bitmap selector so that a bitmap that contains a 2 state picture can be loaded. Thebitmap selector is discussed in the chapter called "The Bitmap Selector".

The bitmap should consist of 2 equal size picture frames. Here is an example:

· Clear




· On

<Clicking> This shows how the control will look in its on state.

· Off

<Clicking> This shows how the control will look in its off state.

· Hint



02 July 2009

· Show Hint


4.1.10.3 Colours


· Off State Colours

The colours selected here will be used to display the text when the data received by the controlis OFF

· On State Colours

The colours selected here will be used to display the text when the data received by the controlis ON

Appendix B 137

02 July 2009

4.1.10.4 Network

· Device Driver




· Device


· Network


· On Value

By default the button accepts 1 as the on value. Some drivers can not support this and need atext value. Whatever you enter here will be used as the on value instead.

· Off Value

By default the button accepts 0 as the off value. Some drivers can not support this and need atext value. Whatever you enter here will be used as the off value instead.

· Access Level


02 July 2009


· Plot Code


· TimeZone Code

If the device driver supports Time Profiles, enter the code here that will retrieve the time data.When time data is received, a window will open showing the start stop times for each day ofthe week. Consult 'Adding a control' topic for further information.

· Time Periods

If a TimeZone code is entered, this field sets how many on/off periods there are in each day.Consult 'Adding a control' topic for further information.

· Password





Appendix B 139

02 July 2009

· Terminal Access



02 July 2009

4.1.10.5 Text

· On Text

Enter the text that will be displayed when the incoming data is non zero or ON.

· Off Text

Enter the text that will be displayed when the incoming data is zero or OFF.

Appendix B 141

02 July 2009


· Left/Right


· Up/Down


· Size



02 July 2009

4.1.10.7 Jump

· Jump To

A button can be configured to perform the following actions:

Display a graph of a local data log.Jump to another schematic (with the option of passing in new device, network and codeinformation).Open another schematic as a Pop-up (with the option of passing in new device, network andcode information).Run a VBScript procedure.Open an Optimised Time Zone (only if the OZM 2000 Plug-In is installed).Run a driver specific function.Run another application.Deliver a set of packaged files/apps to a remote user.

When the Jump To field is <Clicked> the following window is displayed:

Appendix B 143

02 July 2009

This allows you to select the action that the button will perform and will lead you throughchoosing the item to jump to. Clear will clear the Jump To property.

· Device

If this button is set to jump to another schematic, a device can be entered here that will bepassed to all controls on the schematic to be used. Consult 'Adding a control' topic for furtherinformation.

· Network

If this button is set to jump to another schematic, a network can be entered here that will bepassed to all controls on the schematic to be used. Consult 'Adding a control' topic for furtherinformation.

· Description

If this button is set to jump to another schematic, text entered in this property will be passed tothe new schematic and will be used by any static text controls that have their Use GlobalDescription property set.

· Code Index

If this property is greater than zero and the button is to jump to another schematic, this numbertells the controls which code to use to retrieve their data (if the controls have multiple codesentered).

· Data For Driver Specific Function

This field is just for reference. It shows what will be passed to a driver specific function.

· Can Run Remotely

If the function being performed by the button can be performed by a PC logged in remotely tick


02 July 2009

this option.

· Support Files

If the function being performed by this button can be performed by a PC logged in remotely andsupport files will be required at the remote machine, use this button to select the requiredsupport packages. Support packages are created and maintained by NDS 2000. See the NDS2000 help file for further information.

4.1.11 Hot Spot


** THE HOT SPOT IS RETAINED FOR BACKWARD COMPATABILITY **** WE RECOMMEND USING AN INVISIBLE BUTTON **

The Hot Spot Control has several functions that it can perform as listed below:

Jump to another schematic.Display a graph of a Data Log Template.Run a user supplied VBScript.Run a driver specific function.

The Hot Spot is an invisible control at runtime and is generally placed over some specific part of theschematics background picture.

4.1.11.2 General

Appendix B 145

02 July 2009

· Jump To

A Hot Spot can be configured to perform the following actions:

Display a graph of a local data log.Jump to another schematic (with the option of passing in new device, network and codeinformation).Open another schematic as a Pop-up (with the option of passing in new device, network andcode information).Run a VBScript procedure.Open an Optimised Time Zone (only if the OZM 2000 Plug-In is installed).Run a driver specific function.Run another application.Deliver a set of packaged files/apps to a remote user.

When the Jump To field is <Clicked> the following window is displayed:

This allows you to select the action that the button will perform and will lead you throughchoosing the item to jump to. Clear will clear the Jump To property.

· Device

If this Hot Spot is set to jump to another schematic, a device can be entered here that will bepassed to all controls on the schematic to be used. Consult 'Adding a control' topic for furtherinformation.

· Network

If this Hot Spot is set to jump to another schematic, a network can be entered here that will bepassed to all controls on the schematic to be used. Consult 'Adding a control' topic for furtherinformation.

· Description


02 July 2009

If this Hot Spot is set to jump to another schematic, text entered in this property will be passedto the new schematic an will be used by any static text controls that have their Use GlobalDescription property set.

· Code Index

If this property is greater than zero and the Hot Spot is to jump to another schematic, thisnumber tells the controls which code to use to retrieve their data (if the controls have multiplecodes entered).

· Data For Driver Specific Function

This field is just for reference. It shows what will be passed to a driver specific function.

· OK


· Help


· Can Run Remotely

If the function being performed by the button can be performed by a PC logged in remotely tickthis option.

· Support Files

If the function being performed by this button can be performed by a PC logged in remotely andsupport files will be required at the remote machine, use this button to select the requiredsupport packages. Support packages are created and maintained by NDS 2000. See the NDS2000 help file for further information.

Appendix B 147

02 July 2009


· Left/Right


· Up/Down


· Size


4.1.12 Combination


The Combination control is a powerful logic module.

The control has eight digital inputs which source their data from other controls on the schematic. Anynon zero value read by an input is treated as the ON state and any zero value is treated as the OFFstate.

The control has several different types of output, all of which are calculated from the inputs. Theavailable outputs are:

D to A Output


02 July 2009

This output treats the eight inputs as a binary number and converts them to their decimalequivalent.

Count Output

This output is a count of how many of the inputs are in the ON state.

Numbered State Output

Described in the Config section.

Any State Output

Described in the Config section.

4.1.12.2 General

· Control Name


· OK


· Help


Appendix B 149

02 July 2009

4.1.12.3 Configuration

· Data Source 1 to 8

Select which control each input reads its data from. Not every input has to be used.

· States

Each horizontal row equates to what condition the inputs must be in for this state output to betrue.

· Enable

Determines whether the adjacent state condition should be evaluated. If not ticked the stateoutput will not be calculated and will always equal false.

The Any State output will be true if any of the enabled state outputs are true.

4.1.13 Gauge


The Gauge control provides another way to present a value to a user. A background picture can beloaded to make the control look like its real life counterpart and the scale, annualars, ticks and needlecan all be modified to suit the required look and feel.


02 July 2009

4.1.13.2 General

· Control Name


· Bevel Style


· Background

If no background bitmap is loaded, this colour is used to draw behind the dial area of thecontrol.

· Load Background

This will open a bitmap selector to enable a picture to be loaded that will display behind the dialarea of the control.

· Clear Background

This will unload the background picture.

· Font


· Translate


· Use Translations

Appendix B 151

02 July 2009


· OK


· Help


· Hint


· Show Hint


4.1.13.3 Network

· Device Driver




· Device


· Network


02 July 2009


· Units


· Plot Code





· Terminal Access


Appendix B 153

02 July 2009


· Get Data From



· Read Combination


· D/A Output


· Count Output



02 July 2009

4.1.13.5 Scale

· Start Angle

Angle for scale start position.

· Stop Angle

Angle for scale stop position.

· Min Value

Starting value of scale.

· Max Value

End value of scale.

· Counter Value

Step value for major tick marks.

· X Offset

Horizontal offset of gauge within its window area.

· Y Offset

Vertical offset of gauge within its window area.

· Scale Factor

Alters the size of gauge relative to its window area.

· Direction

Appendix B 155

02 July 2009

Which direction the gauge operates in.

4.1.13.6 Annulars

· Number Of Annulars

How many annulars this gauge is to have (Maximum 6).

· Select Annular

Number of annular to work with.

· Annular Start Value

At what value the currently selected annular will start.

· Annular Stop Value

At what value the currently selected annular will stop.

· Annular Inner Radius

What the inside diameter of the selected annular will be as a percentage of the overall gaugewindow size.

· Annular Outer Radius

What the outer diameter of the selected annulars will be as a percentage of the overall gaugewindow size.

· Annular Colour

What Colour to use for the selected annular.


02 July 2009

4.1.13.7 Tics

· Number Of Ticks

How many tick scales to use.

· Select Tick

Select tick set to work with.

· Tick Adjuster

Adjusts gap between major tick marks.

· Tick Inner Radius

What the inside diameter of the selected tick set will be as a percentage of the overall gaugewindow size.

· Tick Outer Radius

What the outside diameter of the selected tick set will be as a percentage of the overall gaugewindow size.

· Tick Label Radius

What the inside diameter of the selected tick set labels will be as a percentage of the overallgauge window size.

· Tick Pen Width

How thick to make the tick marks.

· Tick Space

Appendix B 157

02 July 2009

Spacing between minor ticks.

· Tick Style

Shape of tick marks.

· Show Labels

Whether to show tick labels.

4.1.13.8 Needle/Hub

· Needle Length

What the length of the needle will be as a percentage of the overall gauge window size.

· Hub Scale

What the diameter of the hub will be as a percentage of the overall gauge window size.

· Needle Width

Thickness of the needle.


02 July 2009

4.1.13.9 Captions

A Gauge control can display up to four individual captions which can be positioned anywhere on thecontrols surface.


· Left/Right


· Up/Down


Appendix B 159

02 July 2009

· Size


4.1.13.11 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered


02 July 2009




4.1.14 State Text


The State Text control is an object that is used to read data from a device and then display a piece oftext to describe the value of the data.

Which string displayed is dependent on the data received by the control. For example, if the incomingdata were to be 3 then string 3 would be displayed. If the incoming data were to be 1 then string 1would be displayed.

This control can be used to great effect with the Combination control to monitor multiple digital valuesthat may describe whether a pump is running, stopped or failed.

4.1.14.2 General

· Control Name


Appendix B 161

02 July 2009

· BorderStyle






· Font


· Translate


· Use Translations


· OK


· Help




· Hint


· Show Hint



02 July 2009

4.1.14.3 Network

· Device Driver



Object to read - Consult Consult 'Adding a control' topic for further information.

· Device


· Network


· High Alarm


· Low Alarm


Appendix B 163

02 July 2009




· Terminal Access



02 July 2009


· Get Data From



· Read Combination


· D/A Output


· Count Output


Appendix B 165

02 July 2009

· State Number


· Any State Output





· Left/Right


· Up/Down


· Size


02 July 2009


4.1.14.6 Text

· No: strings

Enter the number of states that this control may display.

· 1 to .... ?

Text strings, one for each state.

Appendix B 167

02 July 2009

4.1.14.7 Colours

If the High Alarm Value for this control were to be set to 1 and the High Alarm Value were to be set to3, the corresponding colours would be used to display the selected string ie:

String 1 would use the Low Alarm colours.String 2 would use the Normal colours.String 3 would use the High Alarm colours.


02 July 2009

4.1.14.8 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


Appendix B 169

02 July 2009

· Open Centered




4.1.15 Script


The Script control will retrieve a value from a network device and pass that value onto a user suppliedVB Script procedure. The script can modify the value as required then pass it back to this control forstorage. Other controls on the schematic can then use the modified value for display purposes.

When the schematic is open the script will be called every time that the schematic is refreshed.

If no network information is entered on the network tab, the script will be passed an empty value.

The user written VB Script procedure must have TWO parameters - ControlID as Integer, "Value asString".

The Script control is invisible at run-time.

4.1.15.2 General

· Control Name


· Script Function


02 July 2009

When this field is <Clicked> a list of user created VBScripts is displayed from which you canmake a selection.

· Clear

This clears the Script Function field.

· OK


· Help


4.1.15.3 Network

· Device Driver



Digital object to read - Consult 'Adding a control' topic for further information.

· Device


· Network



Appendix B 171

02 July 2009




02 July 2009


· Get Data From


4.1.16 Scrolling Chart


The Scrolling Chart control is a real-time chart that can display up to eight values which can be eitheranalogue or digital. Data is sourced from other controls on the schematic.

Data from shown by this control is only valid while the schematic is open, content is not saved whenthe schematic is closed. Use the Data Logging feature of <%PROD_ID%> for persistent data.

Appendix B 173

02 July 2009

4.1.16.2 General

· Control Name


· Chart Title

A description that is displayed at the top of the chart.

· Legend

Whether to display legends for the chart traces and if so, which part of the chart to displaythem on.

· Colours

Colours to use for the chart border and chart background.

· View 3D

If ticked, shows digital traces as 3D lines.

· Gradient

If enabled, shows a colour gradient on the chart border area. This overrides the chart bordercolour.


02 July 2009

· Direction

Which direction the gradient should run.

· Bevel

Controls the look of the edge of the chart control.

· OK


· Help


4.1.16.3 Configuration

The configuration tab is were each of the eight chart traces can be set-up.

· Data Source

Select the control from which this trace should source its data.

· Line Title

A description of this item. This is displayed as a legend if the option is enabled on the general

Appendix B 175

02 July 2009

tab.

· Line Colour

Select the colour in which this trace should be drawn.

· Digital

If this box is ticked, the value is read as a digital value. This will enable some extra propertiesas shown in the following figure and described below.

· Step Value

This value sets over what vertical height on the chart that a ON to OFF transition is drawn.

· Step Height

This value sets the vertical height on the chart that will be used to draw the OFF state.


02 July 2009

4.1.16.4 Settings

If the following properties are not set auto scaling will be used for the axis.

· Upper Y Axis

Allows the upper value for the Y axis to be set.

· Lower Y Axis Value

Allows the lower value for the Y axis to be set.

· Minutes of Data on View

Sets the scale of the X axis.

Appendix B 177

02 July 2009


· Left/Right


· Up/Down


· Size



02 July 2009

4.1.16.6 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered

Appendix B 179

02 July 2009




4.1.17 State Switch


The State Switch control is an object that is used to read data from and write data to a device and thendisplay a picture to show the status of the data.

In order to achieve this, a bitmap is created containing a number of equally sized pictures (calledframes) placed side by side, much like a strip of movie film.

Which frame is displayed is dependent on the data received by the control. For example, if theincoming data were to be 3 then frame 3 would be displayed. If the incoming data were to be 0 thenframe 0 would be displayed (the first frame in the strip is frame 0). Some example bitmaps are shownin the 'Network' section about this control.

4.1.17.2 General

· Control Name



02 July 2009

· Picture


The bitmap should consist of a strip of equal size picture frames. Here is an example:

· Clear

Unloads the current picture.



· No: Switch States

Tells the control how many individual picture frames are contained in the loaded bitmap andhow many different values can be sent to the driver. The above examples contain 3 switchstates. The switch may have a maximum of 20 positions.

· Use End Stops

If ticked this will stop the control from going any further than the start or stop position (i.e. it willnot rotate through 360 degrees).

· OK


· Help


· Hint


· Show Hint


Appendix B 181

02 July 2009

4.1.17.3 Network

· Device Driver




· Device


· Network


· Access Level


· Tick If Item Is Numeric

If ticked the control will send the switch position to the driver (i.e. 0, 1, 2). If un-ticked it will sendwhatever you enter into the fields on the Values tab.

· Password


02 July 2009





Appendix B 183

02 July 2009

4.1.17.4 Position

· Left/Right


· Up/Down


This control automatically sizes to fit the size of a single picture frame (as contained in the loadedpicture).


02 July 2009

4.1.17.5 Values

· 1.... to 20

If the checkbox 'Tick If Item Is Numeric' is un-ticked on the general tab, the values enteredhere are what will be sent to the driver.

Appendix B 185

02 July 2009

4.1.17.6 Pop-up

· Schematic


· Device


· Network


· Description


· Code Index


· Open Centered


02 July 2009




broadsword programming tool - aeiuk.com€¦ · open system solutions limited welcomes you to the...

Documents