Vous êtes sur la page 1sur 261

GE Energy

Control System Toolbox


For EX2100 Excitation Control
GEH-6414D

g
These instructions do not purport to cover all details or variations in equipment, nor to
provide for every possible contingency to be met during installation, operation, and
maintenance. The information is supplied for informational purposes only, and GE makes
no warranty as to the accuracy of the information included herein. Changes,
modifications and/or improvements to equipment and specifications are made
periodically and these changes may or may not be reflected herein. It is understood that
GE may make changes, modifications, or improvements to the equipment referenced
herein or to the document itself at any time. This document is intended for trained
personnel familiar with the GE products referenced herein.
GE may have patents or pending patent applications covering subject matter in this
document. The furnishing of this document does not provide any license whatsoever to
any of these patents.

This document contains proprietary information of General Electric Company, USA and
is furnished to its customer solely to assist that customer in the installation, testing,
operation, and/or maintenance of the equipment described. This document shall not be
reproduced in whole or in part nor shall its contents be disclosed to any third party
without the written approval of GE Energy.
GE provides the following document and the information included therein as is and
without warranty of any kind, expressed or implied, including but not limited to any
implied statutory warranty of merchantability or fitness for particular purpose.

If further assistance or technical information is desired, contact the nearest GE Sales or


Service Office, or an authorized GE Sales Representative.

2000 - 2006 General Electric Company, USA. All rights reserved.

CompactFlash is a registered trademark of SanDisk Corporation.


EX2100 is a trademark of General Electric Company, USA
IBM is a registered trademark of International Business Machines Corporation.
Intel is a registered trademark of Intel Corporation.
Pentium is a registered trademark of Intel Corporation.
Series 90 is a trademark of GE Fanuc Automation North America, Inc.
Windows and Windows NT are registered trademarks of Microsoft Corporation.
g
To:

Reader Comments GE Energy


Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Fax: 1-540-387-8651
(GE Internal DC 8-278-8651)

We welcome comments and suggestions to make this publication more useful.


Your Name Todays Date If needed, how can we contact you?

Fax No.
Your Companys Name and Address Job Site
Phone No.
GE Requisition No.
E-mail
Your Job Function / How You Use This Publication Publication No.
Address

Publication Issue/Revision Date

General Rating
Excellent Good Fair Poor Additional Comments
Contents { { { { ____________________________________________________________
Organization { { { { ____________________________________________________________
Technical Accuracy { { { { ____________________________________________________________
Clarity { { { { ____________________________________________________________
Completeness { { { { ____________________________________________________________
Drawings / Figures { { { { ____________________________________________________________
Tables { { { { ____________________________________________________________
Referencing { { { { ____________________________________________________________
Readability { { { { ____________________________________________________________

Specific Suggestions (Corrections, information that could be expanded on, and such.)
Page No. Comments
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________

Other Comments (What you like, what could be added, how to improve, and such.) ________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________

Overall grade (Compared to publications from other manufacturers of similar products, how do you rate this publication?)
{ Superior { Comparable { Inferior { Do not know Comment ____________________________________________

Detach and fax or mail to the address noted above.


........................................................................ Fold here and close with staple or tape ..........................................................................................

____________________________ Place
stamp
____________________________ here.

____________________________

GE Energy
Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA

.......................................................................................... Fold here first ........................................................................................................


Safety Symbol Legend

Indicates a procedure, condition, or statement that, if not


strictly observed, could result in personal injury or death.

Indicates a procedure, condition, or statement that, if not


strictly observed, could result in damage to or destruction of
equipment.

Indicates a procedure, condition, or statement that should be


strictly followed in order to optimize these applications.

Note Indicates an essential or important procedure, condition, or statement.


This equipment contains a potential hazard of electric shock
or burn. Only personnel who are adequately trained and
thoroughly familiar with the equipment and the instructions
should install, operate, or maintain this equipment.

Isolation of test equipment from the equipment under test


presents potential electrical hazards. If the test equipment
cannot be grounded to the equipment under test, the test
equipments case must be shielded to prevent contact by
personnel.

To minimize hazard of electrical shock or burn, approved


grounding practices and procedures must be strictly followed.

To prevent personal injury or equipment damage caused by


equipment malfunction, only adequately trained personnel
should modify any programmable machine.
Contents
Chapter 1 Overview 1
Before Beginning ........................................................................................................ 2
How To Use This Manual .................................................................................... 2
Conventions.......................................................................................................... 3

Chapter 2 Using the Toolbox 1


Computer Requirements.............................................................................................. 1
Installation ................................................................................................................... 2
Start the Toolbox ......................................................................................................... 3
Work Area............................................................................................................ 3
Accessing Online Help ................................................................................................ 6
Privilege/Password ...................................................................................................... 6
Change Password or Default Password Directory................................................ 8
Toolbox Options.......................................................................................................... 9
General ................................................................................................................. 9
Startup ................................................................................................................ 10
Database ............................................................................................................. 11
Libraries ............................................................................................................. 12
Print.................................................................................................................... 13
Block Diagram ................................................................................................... 14
Controller ........................................................................................................... 15
EX2100 .............................................................................................................. 16
AVDV Series Drive ........................................................................................... 17
Tosvert Series Drive........................................................................................... 18
Static Starter Drive ............................................................................................. 19
OC2000 .............................................................................................................. 20
AcDcEx2000 ...................................................................................................... 21
Trend Recorder................................................................................................... 22
Innovation Series Drive...................................................................................... 23
Connect the Toolbox ................................................................................................. 24
EX2100 .............................................................................................................. 24
Remote Connection ............................................................................................ 25

Chapter 3 Basic Configuration 1


Create an EX2100 ....................................................................................................... 3
Product Version.................................................................................................... 4
Enter User Identification ...................................................................................... 5
Configure the Exciter .................................................................................................. 6
General Tab .......................................................................................................... 7
Memory Tab......................................................................................................... 8
NTP Tab ............................................................................................................... 9
Alarm Scanner Tab............................................................................................. 10
Customer Information Tab ................................................................................. 11
Note Tab............................................................................................................. 12
Ethernet Setup .................................................................................................... 13
Working with Files and Menus ................................................................................. 14
Configuration Files............................................................................................. 14

GEH-6414D Toolbox for an EX2100 Contents i


Product Definition Files .....................................................................................15
Open and Close Files..........................................................................................16
Save Files ...........................................................................................................16
Export Configuration Files .................................................................................16
Upgrade Configuration.......................................................................................18
Work with Project Files......................................................................................19
Menu Commands ...............................................................................................21
Concepts ....................................................................................................................29
Configuration.............................................................................................................30
Parameters ..........................................................................................................30
Application Settings ...........................................................................................32
Toolbox/Exciter Communications......................................................................34
Download Product Code To The Exciter...................................................................35
Download the DSPX Product code ....................................................................35
Download the DSPX Parameter values ..............................................................36
Download ACL Product Code (Runtime) Software ...........................................37
Application Code................................................................................................39
Block Diagram...........................................................................................................40
Links to Other Pages ..........................................................................................41
Modify Parameters from Diagram......................................................................41
Parameter Jumpers .............................................................................................42
Live Data Display...............................................................................................43
Drag-and-Drop Variables ...................................................................................44
Print Diagrams....................................................................................................44
Exciter Controls.........................................................................................................45

Chapter 4 Advanced Configuration 1


Blockware Concepts ....................................................................................................2
Blocks and Block Pins..........................................................................................3
Macros, Macro Definitions, and Macro Pins........................................................3
Tasks and Scheduling ...........................................................................................4
Modules, Module Definitions and Module Pins...................................................7
Functions ..............................................................................................................8
Libraries ...............................................................................................................8
Edit Function ........................................................................................................9
Configuration.............................................................................................................11
Create/Delete Blockware....................................................................................11
Functions ............................................................................................................11
Type Definitions.................................................................................................13
Scale Definitions ................................................................................................15
Signal Definitions...............................................................................................16
Module Definitions and Modules .......................................................................20
Module Pins........................................................................................................23
Macro Definitions...............................................................................................25
Macro Pins..........................................................................................................27
Tasks...................................................................................................................29
Blocks and Macros .............................................................................................32
Block Flow Diagram ..........................................................................................39
Instance Module and Macro Pins .......................................................................40
Device Menu Commands ..........................................................................................45
Database Commands ..........................................................................................45
Validate ..............................................................................................................46
Build Pcode and Symbols...................................................................................46
Software Setup...........................................................................................................48
Device Setup.......................................................................................................48
Serial Loader ......................................................................................................49
Initializing the Flash ...........................................................................................49
Configure TCP/IP...............................................................................................51

ii Contents GEH-6414D Toolbox for an EX2100


Software Modifications ............................................................................................. 52
Modify Application Code................................................................................... 52
Monitoring................................................................................................................. 56
Going Online/Offline ......................................................................................... 56
Watch Windows ................................................................................................. 59
Control Constant View .............................................................................................. 61
Control Constant Work Area.............................................................................. 61
Application Documentation....................................................................................... 64
Block Diagrams.................................................................................................. 64
Block Diagram Tab ............................................................................................ 67

Chapter 5 Finder 1
Use the Finder ............................................................................................................. 2
Finder Window..................................................................................................... 3
Target Finds ......................................................................................................... 4

Chapter File Checkin/Checkout 1


Initialization................................................................................................................. 1

Chapter 7 Configuring System Information 1


Working with System Information Files ..................................................................... 1
Concepts ...................................................................................................................... 2
Scale Definitions .................................................................................................. 2
Type Definitions................................................................................................... 2
Measurement System ........................................................................................... 2
System Overview ................................................................................................. 3
Configuration............................................................................................................... 3
Create/Modify System Information...................................................................... 3
Insert/Modify Scale Definitions ........................................................................... 4
Resource Type Definitions................................................................................... 5
Enumerations........................................................................................................ 6
Alarm Classes....................................................................................................... 7
Measurement System ........................................................................................... 8
System Overview ................................................................................................. 9
Put Data into Database ....................................................................................... 11

Chapter 8 Graphics Window 1


Graphics Window Objects........................................................................................... 2
Create Graphics Window ..................................................................................... 3
Menu Bar.............................................................................................................. 4
Drag-and-Drop Data............................................................................................. 8
Properties Toolbar ................................................................................................ 8
View Signal Summary................................................................................................. 9
Settings ...................................................................................................................... 10
Frame Size and Options ..................................................................................... 10
Pen Color and Pen Width ................................................................................... 10
Brush Color and Use Brush................................................................................ 11
Text Font ............................................................................................................ 12
Select Controls ................................................................................................... 13
Draw Commands....................................................................................................... 15
Insert Object ....................................................................................................... 17
Insert Picture ...................................................................................................... 17
Animate Objects ........................................................................................................ 18
Value and Enable Return.................................................................................... 18
Numeric Animation............................................................................................ 22
Bar Graph ........................................................................................................... 23

GEH-6414D Toolbox for an EX2100 Contents iii


Trend ..................................................................................................................24
Text.....................................................................................................................25
Color...................................................................................................................26
Property ..............................................................................................................27
Input Fields................................................................................................................28
Numeric ..............................................................................................................28
Setpoint...............................................................................................................29
Initial Value........................................................................................................29
Text.....................................................................................................................30
Toggle Command ...............................................................................................30
Event Input .........................................................................................................31
Hyperlinks ..........................................................................................................32
Use Graphics Window Objects..................................................................................33
Signal Substitution .............................................................................................38
Forced Signals ....................................................................................................39
String Substitutions ............................................................................................40

Chapter 9 Hardware and I/O 1


I/O and Network Interface ...........................................................................................1
I/O Points..............................................................................................................2
Insert I/O and Network Interfaces ........................................................................3
Dual Port Memory Interface........................................................................................5
EGD Interface..............................................................................................................6
Edit EGD ..............................................................................................................6
EGD Exchanges ...................................................................................................7
EGD Points.........................................................................................................10
Main Board................................................................................................................12
Non-volatile Random-Access Memory ..............................................................12
NOVRAM Points ...............................................................................................15
Register Network.......................................................................................................16
Ethernet SRTP....................................................................................................17
Serial/Ethernet Modbus ......................................................................................18
Modify Page Settings .........................................................................................21
Modify Point Settings.........................................................................................22

Chapter 10 Signals and the Database 1


Signal Concepts ...........................................................................................................1
EX2100 Signals....................................................................................................2
Signal Selector......................................................................................................7
SDB ...........................................................................................................................10
Put Into Database................................................................................................11
Get From Database .............................................................................................12

Contents i

Glossary of Terms 5

Index 13

iv Contents GEH-6414D Toolbox for an EX2100


Chapter 1 Overview

Introduction
This manual describes the GE Control System Solutions products and the Control
System Toolbox, which is micro-processor-based software used to configure and
maintain Innovation Series control equipment. The toolbox is a Windows-based
application, which runs on a Pentium 166 or higher, personal computer (pc). Major
products that are configured with the toolbox include:
EX2100 Excitation Control
Innovation Series drives
Innovation Series and Speedtronic Mark VI Turbine controllers
Operator Console 2000 (OC2000)
AC/DC2000 Digital Adjustable Speed Drive & EX2000 Digital Exciter
(AcDcEx2000)
Tosvert Series Drives
LS2100 Static Starter Control
Primary functions of the toolbox include:
The toolbox software configures Graphic-based editor for configuring application code
various control equipment.
Therefore, each product package Block macros and module library support
can consist of the toolbox, Live data block flow diagrams
product files for the controller or
drive, Trend Recorder, Data Online code change
Historian, and product files for Online Help files
the System Database (SDB). To
order the toolbox software and I/O configuration and monitoring
specific product support files
refer to the Product Catalog, Signal management and signal trending
GEP-9145. Multi-user file management
Report generation
Batch operation mode
Target firmware upgrades

GEH-6414D Toolbox for an EX2100 Chapter 1 Overview 1-1


Before Beginning
Windows-based screen borders This manual describes the features of the toolbox and presents step-by-step
may vary in appearance. procedures for using the applications provided. It presumes that the user has already
installed Windows and possesses at least a medium-level knowledge of Windows.
Hardware requirements and instructions for installing the products are in Chapter 2.

How To Use This Manual


This manual provides the user with information on installing the toolbox and other
products used to configure control equipment. It also describes other features
provided in the toolbox software. This manual is organized as follows:
Chapter 1 Overview. This chapter defines available products and features of the
toolbox, as well as the contents of this manual and conventions used.
Chapter 2 Using the Toolbox. This chapter provides basic installation and startup
procedures for using the toolbox to configure a product.
Chapter 3 Basic Configuration. This chapter describes how to use the toolbox to
configure an EX2100.
Chapter 4 Advanced Configuration. This chapter provides instructions for
configuration and use of advanced features of the EX2100.
Chapter 5 Finder. This chapter defines the features of the Finder, which searches
the device in the toolbox for items such as text and signals.
Chapter 6 File Checkin/Checkout. This chapter describes the Checkin/ Checkout
utility, which allows users to share files contained in a master file.
Chapter 7 System Information. This chapter describes the System Information
device which configures information global to a project, making it available to other
interfaces.
Chapter 8 Graphics Window. This chapter describes the Graphic Window, which
creates custom graphics interfaces for customer and process requirements.
Chapter 9 Hardware and I/O. This chapter describes the networks and I/O used in
the toolbox.
Chapter 10 Signals and the Database. This chapter defines signals and their
sources. It also defines the topological information in the database.
Glossary The Glossary provides definitions of terms and toolbox concepts.
Refer to the Table of Contents for the organization of these chapters.

1-2 Chapter 1 Overview GEH-6414D Toolbox for an EX2100


Conventions
The following conventional terms, text formats, and symbols are used throughout
this documentation for the toolbox.

Convention Meaning
Bold Indicates that the word is being defined.

Arial Indicates the filename or filepath to be used.


Arial Bold Indicates the menu, the actual command or option that is chosen
from a menu, a button, or title of a dialog box.
Italic Indicates new terms, margin notes, and the titles of figures,
chapters, and other books in the toolbox package.
UPPERCASE Indicates a directory, filename, or block name. Lowercase letters
can be used when typing names in a dialog box or at the
command prompt, unless otherwise indicated for a specific
application or utility.
Monospace Represents examples of screen text or words and characters that
are typed in a text box or at the command prompt.
Indicates a procedure.
Indicates a procedure with only one step.
Indicates a list of related information, not procedural steps.

The following list presents some basic guidelines for working with menus:
When a menu is displayed, press the up/down arrow keys to highlight a command
name. Then press Enter to choose the menu command. The menu can also be
selected by clicking with a cursor-positioning device (CPD), such as a mouse.
When a command ends in an ellipsis (), the application displays a dialog box that
asks the user to supply more information.
If a command turns a feature on and off, a checkmark (9) is displayed by the
command name when the feature is on.
When a command ends with an arrow ( ), the menu cascades to display more
command names.
If a command name is grayed out, it indicates that the command does not apply to
the current situation or there is another selection or action before choosing the
command.

Related Documents
GE provides system instruction documents for the different components of each
product. For questions or additional documentation, contact the nearest GE sales
office or authorized GE sales representative.

GEH-6414D Toolbox for an EX2100 Chapter 1 Overview 1-3


Notes

1-4 Chapter 1 Overview GEH-6414D Toolbox for an EX2100


Chapter 2 Using the Toolbox

Introduction
Setting options should be This chapter provides basic instructions for using the toolbox. It defines the toolbox
determined before starting a menu commands, including the Options menu, which has a Settings dialog tab for
configuration. each product. Methods of communication and toolbox connections are also
available.

Section Page

Computer Requirements...........................................................................................2-1
Installation ................................................................................................................2-2
Start the Toolbox ......................................................................................................2-3
Accessing Online Help .............................................................................................2-6
Privilege/Password ...................................................................................................2-6
Toolbox Options.......................................................................................................2-9
Connect the Toolbox ..............................................................................................2-24

Computer Requirements
The selected product combination and the pc topology configuration determines the
minimum requirements for CSS products:
300 MHz processor (Pentium II 500 or higher recommended)
A cursor-positioning device is Microsoft Windows
highly recommended.
95/98 (with 64 MB RAM), or
NT (with 64 MB RAM), or
2000 (with 128 MB RAM), or
XP (with 256 MB RAM)
SVGA display (800 x 600 x 256 color or gray scale)
Serial port for direct connection to a controller or drive
PCA198 (ARCNET) board (required if DLAN+ Devcom or Driver is
installed)
Network adapter (required for communication with the toolbox over a LAN)
Printer (with appropriate Windows driver installed)

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-1


Installation

Control System Solutions installs various products for control systems as selected in
the setup program. It is recommended that you exit all Windows programs before
beginning. A dialog box will prompt you for a license key, which can be found on
the actual CD. You must agree to the standard Software License Agreement for these
products.
To install the product
1. Place the Control System Solutions CD in the disk drive. The Setup program runs
automatically, or run the program setup.exe.
2. Follow the instructions from each screen. For more help press F1.

Note If technical assistance is required beyond the instructions provided in the


documentation, contact the nearest GE Sales or Service Office or an authorized GE
Sales Representative.

2-2 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Start the Toolbox
The toolbox is started from the Windows NT or 95 Workstation.
To start the toolbox
1. Click Windows Start button, Programs, GE Control System
Solutions, and Control System Toolbox.
To create a device, refer to 2. Click the toolbox icon. The toolbox Work Area displays. It is blank until a
Chapter 3. device is created or opened.

Work Area
If more than one device is open A device's runtime action is configured using the toolbox. From the File menu, begin
in the Work Area, each device a New configuration or Open a previously saved configuration file. The toolbox
will have a screen with an Work Area is the main screen and contains the following:
Outline View and Summary
Outline View displays the configuration in a hierarchy, with the device name as the
View.
first item and other configuration items listed in levels below it.
Summary View displays information based on the item highlighted in the Outline
View. For example, in a controller configuration, the item taskname displays a block
diagram. In a configuration, the item Diagram displays block diagrams (which can
be configured from this view). The Tracking command controls what displays in the
The Tracking button Summary View. When Tracking is on, it tracks or displays the item selected
toggles the command on and (highlighted) in the Outline View. When Tracking is off, it freezes the Summary
off. View of the last selected item.
Detached Summary View is a separate window from the Work Area window and
Click to display the displays a copy of the Summary View. Option settings for the Detached Summary
Detached Summary View. View are separate from the Summary View (see the section, Toolbox Options). This
window can be sized, configured, and edited.
Find the cause of an error by Log View displays configuration data for the item that is highlighted. This data
double-clicking on the error. compiles during toolbox functions, such as file imports, validations, builds, or errors.
For information on each Work Area commands can be accessed through the menu bar or the toolbar,
command, see Chapter 3. depending on the selected product file.

Note The following screen represents a basic toolbox Work Area format. Menu
commands, toolbar button, and Outline View items vary with the product installed.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-3


Double-click on the Note Note can be created when most items are inserted into the device. Select an item,
icon to edit the note. then select Edit and Insert First. If the item dialog box has a Note text box and a note
is entered, the Note icon displays beside the item in the Outline View (as shown).
Highlight an item containing a Note icon. The note displays in the Summary View
and on the Status Bar at the bottom of the Work Area.
Bookmark items display this Bookmark enables you to mark major items in the Outline View and then return to
icon . them easily using the Bookmark commands in the Edit menu. The Toggle
Bookmark command turns the icon on and off. The Goto Next Bookmark command
jumps to the next item marked with the .
It can be toggled on and off Status Bar displays information across the entire bottom of the screen. When online,
from the View menu. the left side displays a description of various toolbox commands or notes entered by
the user. To display a menu command description, click on the menu command and
move the pointer over the command. The right side displays device information for
the device selected, such as idle time, connection status or EEPROM values.

2-4 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


EX2100 Status Bar Information

Status Description Displays Background


Field
Device Run Shows the current run state of the Not Ready gray
State Static Starter control Ready gray
Running gray
Fault Status Shows the fault status of the gray
connected EX2100 control. Alarms yellow
Trips red
Double-click the fault text in the
status bar to bring up the Fault
Status dialog.
Parameter Shows the equality of the DSP = gray
Equality parameters red

Double-click the equality text in the


status bar to bring up the equality
report .
Edit Shows the read state of the loaded white
configuration file READ yellow
Control Displays the current run state of Control green
State the ACL controller Boot yellow
UNKN yellow
Fail red
Connection/ Shows the equality status of the Offline gray
Revision code running in the Static Starter Equal green
controller. Minor Diff yellow
Double-click the controller state Major Diff red
text on the status bar to bring up
the Controller State dialog .
Idle time Shows the amount of idle time % Idle Time gray
remaining on the controller

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-5


Accessing Online Help
To obtain Help for the dialog Specific dialog box Help is available by pressing the F1 function key, when a dialog
box is displayed. Help can also be accessed using the following methods:
box on the screen, press F1 .
To obtain Help on . . Do this . . .
Menu commands Highlight the command and press F1
Dialog boxes Press F1 when the dialog box displays on the screen
Block information Click on the desired block with the right mouse button
and select Item Help
Help contents Click on the Help menu and select Contents
Help Click on the Help menu and select Using Help
Specific word(s) Click on the Help menu, select Contents, and click the
tab Find, then enter the word(s) to search

Privilege/Password
Refer to the next section to The privilege/password system assigns different levels of access to the devices.
change the password. Then, passwords can be established for the different privilege levels, so that each
user can access a device at the level necessary for the job that person is assigned.
To set a privilege level
From the Options menu, select Privilege.

Enter a three-character
ID, such as your initials.

Click OK.

Privilege Level Functions


A password can be assigned to each of the toolbox privilege levels defined below.
(Each successive level allows all the functions of the previous level.)

2-6 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Level Functions
0: Read-only Modify Level 0 password
View device configuration (parameters and application
code)
Use the Finder
Create/modify/run trends
View/print diagrams
Generate/print reports
Change attributes under Options \ Settings
1: Change parameters, All level 0 capabilities
controller variables and
signals Modify Level 1 password
Modify DSP menu parameters, DSP parameter
upload/download
Force UC application code signals
Change UC application code variable values
2: Change application All Level 0, 1 capabilities
code
Modify Level 2 password
Modify UC application code, UC application code
download
Upgrade product release version
Product firmware downloads
Put to SDB, get from SDB
Upload/download device configurations
Change location of password file
3: Change control options All Level 0,1,2 capabilities
Modify Level 3 password
View/import/export/modify ordering drawing
Import generator data
View/modify control options
4: Full access (reserved All Level 0, 1, 2, 3 capabilities
for GE personnel
Modify Level 4 password
View/modify/search DSP non-menu parameters
Modify UC hardware and I/o definitions

To change the password


1. From the Options menu, select Password. The Changing password dialog
box displays.
2. Select the privilege level to change.
3. Click OK. The Changing password dialog box displays to enter the new
password.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-7


Change Password or Default Password Directory
Information for changing your password is shown below.

Enter the new password


and press the Tab key.

Enter the old password


and press the Tab key.

Enter the new password


again to verify that it is
correct.

When a password is created, it is encoded in the file UCPASSWD.ini in the


Windows installation directory. This default directory can be changed, if the user has
a privilege level 2.
To change the default password file directory
From the Options menu, select Settings, and then click the tab General.

Enter a directory or select a directory


from Browse

Enter three characters that identify the current user. You


will not be prompted for initializations when values change.

Note It is recommended that the password file be kept on the local pc to avoid loss
of access in the case of downtime on a remote node.

2-8 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Toolbox Options
Option settings are saved in the The toolboxs working environment can be defined for each application. This section
users Windows registry when describes each tab that can be set to customize the toolbox device, database, block
the toolbox is closed. diagrams, and such. These tabs are located in the Options menu under Settings.
To customize the toolbox settings
1. From the Options menu, select Settings. The Settings dialog box displays.
Click on a tab to bring it to the front and select options.
2. Click OK to apply the changes and close the dialog box. Click Cancel to exit
and not change any settings.

General
The General tab applies to all devices as noted and described below.
Select a font for the Finder.

Select a font for the Outline


View. The default font is
System Bold.

Select from the following file


options:

Use compact export format


compresses the .tre files
produced by exporting. Less
hard disk space is used and it
is easier to read and edit.

Save Bookmarks in files saves


bookmarks between closing and
reopening files.

Backup files before save makes


a backup copy of files before
saving new information. This
includes .ucb, .dcb, .icb, and
.ocb.

Compress files when saving


saves and stores files in a
compressed format, which
saves disk space.

Auto-Save files every * minutes


automatically saves the files at
the set increment. The default is Enter three-character Enter the directory for the Expert Mode
fifteen minutes. initials for use in the password file. A local allows extra data
privilege and directory is recommended. to be seen, which
password. You will not Click Browse... to search is useful to a
be prompted for the directory and select a Power User.
initialization when location.
values change.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-9


Startup
The Startup tab defines the default directory structure for installed products . Only
enter directory paths where applicable.

Select one of the following


file options:

None dictates that no file


is automatically loaded on
toolbox startup.

Load last file loads the


files that were in use when
the toolbox was exited.

Select file allows you to


select the file that loads
when the toolbox starts.
Click Browse... to locate
the file.

2-10 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Database
The Database tab defines the database and any required network information. It
applies to all devices as listed.

Select the SDB


database (SDB
is the system
database used
on a Windows
pc).

Note: USDB is
not used by
Static Starter
Control

Enter the name


of the host to
the database.
The server
name is not
case-sensitive.
If a name
server is not
available, the
IP address
must be used.

Enter the location of the SDB sub-directory on the server where the
data files are stored. The name must include the drive letter and at
least one sub-directory. The SDB cannot be located at the root of a
drive. For a USDB, the name is specified in the GEBHOST
environment variable on the LynxOS pc, such as ustst_usdb.

Note USDB is not used by the EX2100.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-11


Libraries
The Libraries tab defines the block and module libraries automatically imported
when a new controller (or OC2000) is created.

Note Existing controller libraries are referenced in the .prj file and override these
default libraries.

Select the product library


to define.

Default libraries are listed.


Use the command buttons
to enter and edit the library
list.

Up and Down rearrange


the order of the list.

Change inserts the edited


library back into the list.

Add inserts the new library


from the text box.

Remove deletes the


selected library from the
list.

Browse... allows you to


search the directory
structure and select an
existing directory.

2-12 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Print
The Print tab allows you to set print options for the current device. It applies to
devices as listed.

The Block Diagram Where Used Scope applies only to controllers. Specify
the scope of the signal cross-refrencing in the active block diagram.

Select the font for the


text displayed
immediately over the
blocks in the diagram.
The default font is
Courier New.
Select the font for the
Signal Definitions and
Where Used Lists at the
end of each block
subsection. The default
font is Courier New.

Select the font for the


text at the top of each
new section and block
subsection. The default
font is Arial.
Select the font for all
text not listed above,
including block names
and pins. The font
side directly affects
the number of blocks
that display on a page
diagram. The default
font is Arial Narrow.

Select this check box to


use old-style printing.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-13


Block Diagram
The Block Diagram tab allows you to specify how the block diagram displays in the
Summary View and Detached Summary View.

Display the blocks in a list with no


connections or connected to each
other or the Summary View and
Detached Summary View.

Check to show all List block


diagram pins. This command
disregards the text box Visibility,
if it is checked in the Edit Macro
Pin Definition dialog box. Font
size changes the font size of all
text on the block diagram.

Check the following options for


interconnected block diagrams:
Show all pins displays all
block pins. This command
disregards the text box
Visibility, if checked in the
Edit Macro Pin Definition
dialog box.
Reorder pins rearranges the
pins to minimize crossing the
connections on the diagram.
Show input or Show output
connections displays the
connection names and values.

Font size changes the font Change the Summary View tracking feature to display various levels
size of all text on the block of the hierarchy, when they are selected in the Outline View. Select
diagram. the item to display on the lowest level. The default is Task/Macro.

2-14 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Controller
The Controller tab allows you to select options specific to the controller.

Select this check box


to allow Boolean
Engine (BENG)
blocks to be edited
using a Relay
Ladder Diagram
(RLD). If this box is
not checked, modify
the block using the
Edit Block
Connections dialog
box.
Select to enable
revision tracking,
which allows you to
enter information
about a change to a
document (file)
when it is saved.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-15


EX2100
The EX2100 tab allows you to select options specific to the excitation control.

Select the
communication
port from the
drop-down menu.

Select this box to


be prompted to
add another
language to the
keyboard.

Select to enable
revision tracking,
which allows you
to enter
information about
a document when
it is saved.

2-16 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


AVDV Series Drive
The AVDV Series Drive tab allows you to select the communications port.

Select a
communications
port from the
drop-down list.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-17


Tosvert Series Drive
The Toshiba Series tab allows you to select options specific to an Tosvert Series
device.

Select a
communications
port from the
drop-down menu.

2-18 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Static Starter Drive
The Static Starter Drive tab allows you to select options specific to the drive.

Select this box to


be prompted to
add another
language to the
keyboard.

Select to enable
revision tracking,
which allows you
to enter
information about
a change to a
document (file)
when it is saved.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-19


OC2000
The OC2000 tab allows you to select options specific to the OC2000 device as listed.

Check to scale the


OC2000 operator panel
for the Summary View
and Detached Summary
View.
Check to maintain
proportions in the
operator panel and fit in
the Summary View and
the Detached Summary
View.

Click to select a font for


the OC2000 printed
overlay. The default is
Courier New.

Enter an IP address, such


as 3.29.3.33, for the
default controller serving
the OC2000.

2-20 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


AcDcEx2000
The AcDcEx2000 tab allows you to select options specific to an AcDcEx2000
device as listed.

Check to display the


EE address of items
in the Block Area in
the Outline View.

Select the Default


Communication
Settings:

Serial requires a
Baud Rate and
Com Port.
TCP/IP requires
either an IP address
or a host name in the
Gateway box. Host
names can be used
when a name server
is present.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-21


Trend Recorder
The Trend Recorder tab allows you to select specific options as follows.

Select any of the following


options:

Horizontal Grid Lines


displays the horizontal grid
lines when in replay mode.
Vertical Grid Lines display
the vertical grid lines when
in replay mode.
Right Vertical Axis
displays the vertical axis on
the right side.
Dual Vertical Axis displays
the outer Y-axis.

Check to automatically configure


the recorder with predefined
signals. (This option only works
with Innovation Series Drives and
when performing Mark VI I/O board
calibrations.)

Check to zoom in the Trend


Recorder, using the mouse to drag-
and-drop a rectangle on the screen.

Check for a Yes/No confirmation


prompt to display before the zoom
takes place.

Select the default pen width ((in


pixels) used to draw the signal
traces. Check to Enter the amount of memory Click Default Colors to
display the the Easy-Drive reserves for change the colors used
amount of storing traces. The default to draw the traces. Click
reserved value of 2 MB allows 4 signals Columns to select the
memory that to be captured at 32 ms headings to be
was used. intervals for about 14 minutes displayed in the Lower
before the oldest data is Signal View.
overwritten.

2-22 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Innovation Series Drive
The Innovation Series Drive tab allows you to select options specific to the drive.

Select the
communication port
from the drop-down
list.

Select this option to


program the keyboard
with an additional
language. This prompt
occurs when Keypad
Menus is selected
from Download to the
DSP in the Device
menu.

If you select this option and then go


online, the Device ID Verification
dialog box displays with additional
information for the toolbox and the
device. It is normally checked.

Note The default communication setting can be changed for all devices using the
default. The settings must be changed using the Modify Device dialog box.

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-23


Connect the Toolbox
The toolbox must communicate with a device to configure or monitor it. There are
two methods of communication available:
See Windows Help Topics: TCP/IP is used to inter-network dissimilar systems. To use TCP/IP, the proper
Windows Setup Help for network software must be installed and configured.
installing and configuring
Direct Serial is available only with exciters. The toolbox communicates directly
TCP/IP.
with the exciter using the PC serial port. No special network software is required.

EX2100
The toolbox can be directly connected to a controller using Ethernet.

Control System EX2100 Control Rack


Toolbox
Serial

Windows PC

Toolbox connected directly to an exciter

Control System EX2100 Control Rack


Toolbox
TCP/IP
A
C
L
A
Windows PC
Toolbox Connection to EX2100 Device Using TCP/IP Communication

2-24 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Remote Connection
For more information, refer to Windows can make TCP/IP connections remotely, such as connecting the toolbox to
the Windows documentation on a remote controller, using modems, as shown below.
Remote Access Service and
Dial-up Networking.

Modem/Ethernet
TCP/IP Gateway
Control System
Toolbox TCP/IP
Modem Modem

Ethernet
Windows PC EX2100 Control Rack

Remote Toolbox Connection

GEH-6414D Toolbox for an EX2100 Chapter 2 Using the Toolbox 2-25


Notes

2-26 Chapter 2 Using the Toolbox GEH-6414D Toolbox for an EX2100


Chapter 3 Basic Configuration

Introduction
For information on configuring This chapter provides basic instructions for using the GE Control System toolbox to
features not covered in this configure and monitor an EX2100 Excitation Control (exciter). It also contains
section, see Chapter 4, information on using other features of the toolbox specific to the exciter.
Advanced Configuration.
The EX2100 is represented as a unified device in the toolbox. The configuration has
a single binary file, even though physically there can be up to five separate
processors.

Section Page

Create an EX2100 ....................................................................................................3-3


Configure the Exciter ...............................................................................................3-6
Working with Files and Menus ..............................................................................3-14
Concepts .................................................................................................................3-29
Configuration..........................................................................................................3-30
Download Product Code To The Exciter................................................................3-35
Block Diagram .......................................................................................................3-40
Exciter Controls......................................................................................................3-45

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-1


The following diagram shows an example of the Warm Backup configuration. It
contains two ACL controllers and three DSPX processors.

Ethernet

ACL1 ACL2

DSPX1 Serial
DSPX3 DSPX2

Keypad1 Keypad2

M1: Consists of ACL1, C: Consists of M2: Consists of ACL2,


DSPX1 and DSPX3 DSPX2 and
Keypad1 Keypad2

EX2100 Warm Backup Hardware Configuration

3-2 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Create an EX2100
When the toolbox starts, the toolbox Work Area displays (refer to the section
Configure the Exciter). The Work Area is used to maintain the exciter configuration
file in the toolbox. You must create a new exciter configuration file (.ecb) or open an
existing one.
To create an EX2100
From the File menu, select New. The New dialog box contains all installed
Or click . toolbox products. Select the exciter as follows:

Select the Drives &


Exciters tab.

Select EX2100
Exciter.

Click OK.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-3


Product Version
The Choose the EX2100 Product Version dialog box allows you to select the
Product type and Version.

After the version is selected, all the tree files required to create the basic
configuration file are automatically imported into the new exciter configuration.

Select Control Type


The Select Control Type dialog box is illustrated below.

Select the
control type.

Click OK.

3-4 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Enter User Identification
To view these configuration If the Enter_User ID dialog box displays, enter an ID to identify the user about to
changes with User ID, select make configuration changes.
Reports from the View menu.

Enter a three-character
ID, such as your initials.

Click OK.

To avoid the Enter - User ID


dialog box, select Settings
from the Options menu, then
click the General tab.

Enter your three-character


user ID. Click OK.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-5


Configure the Exciter
For details of the toolbox work The toolbox Work Area is the main screen of an EX2100 configuration. This area
area, refer to Chapter 2, the is used to configure the exciter.
section Work Area.
When a new exciter is created (or an existing file is opened), the Outline View
displays the exciter name and three items: Main Menu, Block Diagram and
Advanced Settings.

The default device name is


EX1. Additional new devices
are incremented by one.
This name should be
modified to more accurately
refer to the device being
configured. The name is
limited to five characters.
(Other components in the
system might further limit
this name length.)

To modify a device
1. Click the device name to highlight it.
Or double-click the device 2. From the Edit menu, select Modify. The Device Properties dialog box
name. displays.
The following sections describe each tab in the dialog box.

3-6 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


General Tab
The General tab is illustrated below.

Name identifies this exciter when communicating with the SDB. EX1 is the default
name. The name is saved in the .prj file.
Platform specifies the hardware platform on which the ocnfiguration operates. This
field is important for proper control execution records and for selecting hardware and
I/O. For more information on selecting the appropriate platform, refer to Chapter 9,
Hardware and I/O.
Select the interval (in milliseconds) that the I/O Mapper task runs. The I/O mapper
task transfers signals between different I/O points if the signals are not used in
blockware code.
Communications specifies the method that the toolbox uses to communicate with
the exciter.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-7


Memory Tab
The Memory tab is illustrated below.

System is the amount of memory used to store the configuration in the controller.
This number should not be increased above 2048, unless required. For example, a
110 error received during an online download indicates that the runtime does not
have enough memory available to keep two copies in memory, as is necessary to
perform an online download. Memory not allocated here is used by non-continual
processes, such as sending live data to toolbox sessions to to support diagnostic
explanations.
Capture Buffer is the amount of memory to be reserved for data storage by capture
buffer blocks. Set this value to zero if the configuration does not contain capture
buffers.

3-8 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


NTP Tab
The Network Time Protocol (NTP) tab is illustrated below.

The NTP tab defines how to configure its NTP client. NTP is used to synchronize the
devices clock with that of another computer on the Ethernet.
NTP Client Disabled prevents the exciter from using NTP.
Broadcast starts the NTP Client and listens for broadcasts from an NTP server.
The Unicast option allows you to start the NTP Client and request time from the
servers specified as Primary Server and Backup Server.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-9


Alarm Scanner Tab
The Alarm Scanner tab is illustrated below.

Specify a Boolean signal that is set by the alarm system when one or more alarms are
present in the queue.
Specify an integer signal that the system will populate with the number of active
alarms currently in the queue.
Horn Driver specifies an output that can be attached to an external alarm horn
contact output.
Horn Silence specifies an input Boolean signal that can be used to turn off the
alarm horn with a discrete pushbutton.
Acknowledge specifies an input Boolean signal that can be used to acknowledge
alarms with a discrete pushbutton.
Alarm Reset specifies an input Boolean signal that can be used to reset alarms with
a discrete pushbutton.

3-10 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Customer Information Tab
Enter customer information in the fields below.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-11


Note Tab
Use the Note tab to enter configuration information for this exciter.

3-12 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Ethernet Setup

For more detailed information Ethernet 1 is the only available network for all platforms earlier than the ACLE. A
on multiple Ethernet, refer to second Ethernet board can be configured for controllers with a ACLE platform.
the Mark VI Runtime Additional Ethernet selections display in the drop-down list. To make an additional
documentation in the Help Ethernet configurations available, the Enable option box must be selected
menu
Specify the Addressing Information , such as IP Name, Address and Subnet
Mask for this controller. Select the check box to use the Use Default Gateway.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-13


Working with Files and Menus
An EX2100 is configured using different types of files described in the following
sections. Menu commands are also described.

Configuration Files
Exciter configuration file (.ecb) is a binary working file that contains an exact copy
of the EX2100 configuration used by the toolbox. Users generally work from exciter
configuration files. When the file is saved, the prior name.ecb is renamed to a
Backup of name.ecb file and used as a backup file. To restore the backup copy,
rename the file to name.ecb file.

Back up all files often to avoid loss of data.

Tree files (.tre) are text files that transport device menu, parameter, software and
hardware configurations to different versions of the toolbox.
Project files (.prj) are text files that keep track of the order of .tre files and hold
some device configuration information. They can be used in conjunction with other
tree files to transport configurations between different versions of the toolbox.
Note The .tre and .prj files are not normally used by users.
Configuration files generate output that can be downloaded to the exciter. Output
files include:
Exciter Keypad database files (.icd) describe the configuration for the keypad. This
file is downloaded to the exciter.
Pcode files (.pcd) are application files and describe the configuration for the device.
This file can be downloaded to the device.
Symbol files (.sym) describe the signals used by diagnostics to the device. This file
can be downloaded to the device.

3-14 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Product Definition Files
The EX2100 can be loaded with different product definitions. A product definition is
defined by the following collection of files used by the toolbox:
Runtime files (.arc) are binary files that contain the runtime image downloaded to
the exciter.
Diagram files (.wmf) are drawing files that contain the toolbox block diagrams.
Help files (.hlp) provide pattern specific help from within the toolbox.
Upgrade files (.dll) are binary files that provide an intelligent pattern specific
upgrade from previous pattern versions.
The following diagram shows the relationship between these files and the toolbox.

Programmer Workstation

Product Definition Files

*.ecb file
Save
hardware,
Export
library, and File New Documentation
function .tre files
Import Open Print
Open

*.prj file Export Get from


(.tre) database Build
Windows NT or *.pcd & *.sym
The .prj files (Open/Export) list Windows 95 files
all .tre files that should be running toolbox
imported for this controller. Download

Put into database


SDB Note The default installation directory is EX2100
C:\Program Files\GE Control System
Solutions\ToolBox.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-15


Open and Close Files
Opening an exciter configuration file (.ecb) reads a previously saved exciter
configuration into the toolbox.
To open a file
1. From the File menu, select Open. The Open dialog box displays.
Or click .
2. Select the file name and click OK.

Note If an older version toolbox is used to open a exciter configuration file (.ecb)
that was saved with a newer version, a Warning box is displayed. Install the version
of toolbox the exciter configuration file (.ecb) was saved with.

To close a file
From the File menu, select Close.
Closing a file removes the configuration from the toolbox. If the configuration has
not been saved, a dialog box displays to prompt you to save the file.

Save Files
Saving a file writes the entire contents of the configuration to an exciter
configuration file (.ecb). The prior exciter configuration file (.ecb) is renamed to
Backup of .ecb file and used as a backup file.
To save a file
1. From the File menu, select Save. If the file has not been saved previously, the
Save As dialog box displays.
2. Enter the file name and click OK. (Once a configuration has been saved, the
Save button saves the new file without asking for a file name.)

Tip The Save button also indicates that a change was made to the configuration
by highlighting (red) and becoming enabled. If the computer fails when the button is
red, all changes since the last save is lost, so save files often.

Export Configuration Files

This option is normally not required, but is provided if a


newer version of the toolbox makes a change to the format of
the exciter configuration file (.ecb) that is not backward-
compatible.
The .tre files can be exported Normally, newer versions of the toolbox load exciter configuration files created by
selectively or for the entire older versions. However, if a major change in functionality of the toolbox occurs, the
device. toolbox may not be able to load the exciter configuration file. In this case, it is
necessary to first export the exciter configuration file with the old version of the
toolbox to a project file and then open the project file with the new version of the
toolbox.

3-16 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


To export a single file
1. From the Outline View, select the item to be exported.
2. From the File menu, select Export, then Selected Item. The Export dialog
box displays.
3. Specify the file name and click Save. The file is exported to the named .tre file.
To export the entire device
From the File menu, select Export, then select All. The Export All Options
dialog box displays.

Click the desired option button


and save the .tre and .prj files.

If Use specified folder for all


files is selected, a specific
folder can be entered or
Browse. . . can be used to
search for a folder.

Selecting either original or


specified folders displays all
available files in the Checked
files will be exported dialog
box.

Only files that are


checked will be
exported.

If no source file is
defined for the file
export, the user is
prompted to name
a .tre file before this
dialog box displays.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-17


Upgrade Configuration
Refer to Chapter 2, Using the This command upgrades the current configuration file to include the features of the
Toolbox. new exciter product version. For example, the current exciter configuration file
(.ecb) is version V03.00.00B. The application requires the features of version
V03.01.00B. Upgrade the exciter configuration file as follows:
To upgrade a file
1. Make sure the new required version is installed (refer to chapter 2).
2. From the current exciter configuration file (.ecb), such as version V03.00.00B
described above, from the File menu, select Upgrade. The following message
box displays.

If you select Yes, the Select Upgrade Version dialog box displays all newer
installed versions. Select a new version to upgrade.

The following message displays. Refer to the section, Download Product Code To
The Exciter for details on upgrading firmware in the device.

3-18 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Work with Project Files
The project file also includes A project (.prj) file is a text file that contains configuration information including the
device information, which is names of all .tre files necessary to recreate a configuration. Project files allow you
entered in the Device Edit to export and import a device configuration without having to know about all the
dialog box. files.
To create a project file
From the File menu, select Export, and select All.
If the import fails because Once a project file exists, it can be used to create a device configuration (.ecb file).
something is undefined, the From the File / Open command, select a .prj file. This creates a device and starts a
order may be incorrect. To series of file imports. The toolbox imports the files listed in the .prj file, including
change the order of the .prj file, the standard library files, in the order that they display. Refer to the next section,
edit the file with any text editor. Files in the .prj.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-19


Files in the .prj
To view a list of files included in the project
From the Outline View, select the device name. Make sure Tracking is on.
Or click . The information displays in the Summary View.

Summary View Information

Toolbox
Revision

Exciter
properties

Files included
in this project

Validate Exciter
Also, any items in the hierarchy Validation checks for errors that might prevent successful operation of the exciter. If
that had problems during the configuration needs to be validated, the Outline View displays the items in red.
validation will display red after
the validation.
To validate the exciter configuration
From the Device menu, select Validate.
Or click .
The validation results display in the Log View at the bottom of the toolbox work
area.

3-20 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Menu Commands
The toolbox work area contains the following Menu bar:

File Menu
The File menu provides the following commands:

Or click. . New creates a new file.

Or click . Open displays an existing file.

Close exits an existing device or file.

Or click . Save/Save As preserves an opened file to a specified name.

Or click . Import retrieves a file from the specified source. The values in the current
configuration are replaced with the imported values.
Import Generator Data retrieves an Electronic Datasheet file from the specified
source. The values in the current configuration are replaced with the imported
values.
Export sends specified items (such as parameters and files) to a designated file.
Compare Devices compares the currently open file with another, user-specified
file.
Upgrade automatically makes the required changes to upgrade a configuration to a
newer product version.
Print Setup allows you to select a printer and printer connection.
Tip The block diagram is designed to print best in Landscape Orientation. Refer
to the section, Block Diagrams/Printing Diagrams.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-21


Or click . Print provides a paper copy of a specified file or page.

Print Preview displays the page as it would be printed.


Send To opens email and provides a copy of the currently opened file to send (you
must have Window messaging, such as Exchange).
File 1, 2, 3... lists and opens the most recently used files.
Exit closes the toolbox.

Edit Menu
The Edit menu allows you to modify the device with the commands listed.

Modify edits the item that is highlighted in the Outline View.

Or click . Delete removes the item highlighted in the Outline View.

Or click . Cut removes the highlighted item and places it on the clipboard.

Or click . Copy duplicates the highlighted item and places it on the clipboard.

Or click . Paste places the highlighted item from the clipboard into the current file.

Insert First inserts the first new item under the item highlighted in the hierarchy of
the Outline View.
Insert Next inserts the next new item under the item highlighted in the hierarchy of
the Outline View.
Instance updates a single item or select All to update the entire device/file.
Renumber changes the numbers of the highlighted blocks.
Or press Ctrl+F2 to toggle the Bookmarks allows you to mark major items in the Outline View by using the
mark and F2 to go to the next Toggle Bookmark option and then move between these items easily by using
bookmark. Goto Next Bookmark.

3-22 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


View Menu
Some of these commands can The View menu allows you to manage the exciter with the following commands:
be toggled on and off. A check
mark ( ) displays next to the
command name when the
feature is on and it displays in
the toolbox.

Toolbar displays or hides the Toolbar.


Status Bar displays or hides the Status bar.

Or click . Tracking toggles the tracking feature of the Summary View on and off.

Close Outline reduces the hierarchy list of items displaying in the Outline View to
just the device level.

Or click . Detached Summary creates a detached window of the Summary View.

Or click . Zoom In enlarges the view of the block diagram area (Summary View).

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-23


Or click . Zoom Out reduces the view of the block diagram area (Summary View).

Go Back and Go Forward allows you to return to earlier selections in the


Or click . Outline View.
Finder starts the Finder view to search text.
Or click .
Watch Windows creates a customized, quick-reference list of signals and their
online values.
SDB Browser starts the SDB Browser window to search the System Database
(refer to the document, GEI-100506).
Force Lists displays forced signals and I/O points that can be edited.
Trend Recorder starts the Trend Recorder application (refer to the document,
Or click . GEH-6408). Select Tile Horizontal or Tile Vertical from the Window menu to view
both the Trend Recorder and toolbox Work Area simultaneously (or use <Ctrl><
Tab> to toggle between screens).
Exciter Control starts the Exciter Controls view, which can be used to start and
Or click . stop the exciter.
Control Constants displays a separate window to edit control constants, which
can be viewed and compared as a group, exported to .csv files for manipulation
outside of the toolbox, and merged back into the configuration.
Configuration Statistics opens the Device Metrics window to display memory
usage.
Exciter Fault List displays all active faults and alarms. Each fault is time stamped
so that the order of events can be determined.
Exciter Fault History List displays a fault history list.
ACL Status Commands is a separate window, which displays the current
statistics of items in a drive.
Reports contains the following options:
Alarm List displays all signals that have the alarm attribute set.
Event List displays all signals that have the event attribute set.
Signal Report lists all the signals in the controller. For every signal, the report
shows signal name, data type, and token number. Signals listed in the
configuration, but not used by any blocks have a blank token.
Signal Cross Reference lists all the locations in the blockware where named
signals are used. Named signals are defined by the user, usually either in a signal
definition or as module pins. Automatic signals are generated by the toolbox.
They connect block pins, when neither pin is connected to a named signal.
The first part of the signal cross-reference is an index of the items in the drive.
In the cross-reference, an item is considered down to the level of an item that
contains blocks, which could be a task, a macro, or a macro definition. The code
corresponding to one of these items shows the level of the item.

3-24 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


An example of the index is as follows:
Index of sections for controller uc2k-9
01 Functions
02 tmr_test
02:01 ........\MacroDefs
02:01:01 ........\.........\my_macro
02:02 ........\Pump
02:02:01 ........\....\PumpTask
02:03 ........\Entry\Pump1@Pump
03:01 ........\................\PTask

The second part of the signal cross-reference is the actual cross-reference list.
Each signal-referenced location is listed for every signal. Each reference
consists of a section code for the task macro or macrodef, the block number, and
a flag (*) to show whether the signal is being written on the block. Examples
from a cross reference report are as follows:
Entry\Pump1\PumpEngine------------:

Signal Entry\Pump1\PumpEngine is not used anywhere in the blockware.


Entry\Pump1\sinout----------------: 02:03:01:0020*

Signal Entry\Pump1\sinout is written to on block 20 of task Ptask, in module


Entry\Pump1@Pump, in function tmr_test.
Entry\Pump1\Start-----------:02:03:01:0030 02:03:01:0030*

The signal Entry\Pump1\Start displays on two pins (one read, one write) on
block 30 of the same task.
Control Options displays control options and their values.
Version and Hardware Info displays the version of the exciter ACL and
DSPX processor cards and bar code information of the boards installed in the
control rack.
Parameters Differences displays all parameters whose values in the toolbox
are not the same as in the exciter.
Parameter Overrides lists settings in the exciter that are overridden from
their calculated state.
Change History displays changes made to the exciter configuration file.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-25


Device Menu
The Device menu allows you to manage the EX2100 with the commands listed.

Validate makes certain that items or functions do not contain errors


Or click .

Or click . Build generated the required files for download of the ACL.
Pack signals reassign address tokens when signals become fragmented.
Download ACL
Application Code sends the values of all the parameters from the loaded
exciter configuration files to the current exciter.
Product Code sends the exciter ACL firmware configuration to the current
exciter.
Reboot Command restarts the ACL processor.

A reboot command stops the EX2100. No safeguards are


taken.

View/Set Time allows time in controller to be set to pc time.


View/Set Totalizers displays the totalizer information.
Download DSPX
Parameter Values sends the values of all the parameters from the loaded
exciter configuration files to the current exciter.
Product Code (Runtime) sends the exciter DSPX firmware configuration to
the current exciter.
Keypad Menus sends the menu structures and other data to the exciter keypad.
This is only required when an alternative language is desired.
Keypad Runtime sends new keypad firmware to the current exciter.
Reset Command performs a hard reset on the exciter rack.

A hard reset immediately stops all exciter control and


disables all bridge output power.

3-26 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Or click . Online/offline toggles to initiate communication to the device.

Upload Parameter Values from Exciter reads all the parameter values from the
connected exciter and provides the option of replacing the values in the currently
loaded exciter configuration file in the toolbox.
Put Symbols Into Database places diagnostic symbol information into the
database.
Put Into Database places device information into the database.
Get From Database reads and gets information from the database.
Create Undefined Signals produces a signal definition for signals not defined.
Options Menu
The Options menu allows you to manage general options for toolbox operation.

Settings allows you to set general toolbox options.


Privilege sets the privilege level for a session.
Passwords sets the password for a privilege level.
Logout User closes the current user from the current session and sets the privilege
level back to 0.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-27


Window Menu
The Window menu arranges multiple views of open documents in the exciter
window with the following commands:

Cascade arranges the windows in an overlapped style.


Tile Horizontal arranges the windows horizontally in non-overlapped tiles.
Tile Vertical arranges the windows vertically in non-overlapped tiles.
Arrange Icons arrange the icons of closed windows.
Close All closes all open windows.
Help Menu
The Help menu offers the following Help items:

Contents displays Help files for the toolbox. It also contains the Find tab with a
work list to search for specific topics.
Using Help displays general instructions on how to use Help.
Item Help displays help for the item selected in the Outline View.
Product Help displays the Help file for the currently loaded product. The file
contains help on parameters, faults, diagrams, and wizards.
Release Notes provides product changes in the toolbox.
Send Problem Report allows you to submit a system change request for the
toolbox.
Goto Toolbox Web Site takes you to the toolbox home page. (This feature is only
available if you have a connection to the GE intranet.)
About Toolbox displays the version number of the toolbox.

3-28 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Concepts
The following section defines items and features used when configuring an EX2100.
When an exciter is created, the work area displays.

The exciter name can


be modified.

Main Menu and


Advanced Settings
contain the
configurable items. Block Diagram
displays a drawing of
the block diagram and
signal flow.

Parameters allow you to configure the exciter. Each parameter has a name with up
to 20 characters, which identifies it and helps to convey its use. A parameter also can
have units, such as RPM, displayed with the toolbox and keypad. The unit field is
limited to five characters. Each parameter contains a value, which can be a number
or a setting. The value is adjusted to modify the exciter performance.
Rules process inputs from parameters and produce values for other parameters that
the user does not normally edit.
Variables, similar to parameters, have a 20-character name and a 5-character unit
field. You cannot change variables. They are changed by the exciter as a result of the
product code performance.
Main menu structure in the toolbox represents the same information contained on
the keypad located on the front of the exciter.
Block diagrams provide an overall diagram of signal flow, sequencing, and
regulator control in the exciter. While communicating with the exciter, the diagrams
display exciter variables and their real time values. Contact and coil states are also
indicated. Certain exciter parameters can be modified from this view (refer to the
section, Block Diagrams).

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-29


Configuration
Configuration of the EX2100 is discussed in the following sections.

Parameters
For detailed information about The exciter contains a set of parameters whose values, together with the product
a parameter, click the definition files and version, define the exciter performance. In the Outline View,
parameter (to highlight it) and parameters display as follows:
press F1.

To modify a parameter
Use the Finder to easily locate 1. From the Outline View, select the parameter to modify.
a specific parameter.
2. From the Edit menu, select Modify.
Or, double-click the parameter. The Edit Parameter dialog box displays (refer to
the next section).

Tip If you know the name of the parameter (or partial name), select the Finder
and enter the name in the text box. Click Find and a list of parameters and variables
display. Double-click the parameter to modify.

3-30 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Edit Parameter
The Edit Parameter dialog box is shown below.

Enter a new value.

This button is enabled if


the parameter is a selector
type parameter (used to
select a variable).

Item Help displays


detailed help for this
parameter.

Send the new value to the


device.
This button is enabled if
the parameter values have
multiple units. It affects
the displayed value and
not the device control.

Enter a note for the


parameter, if desired.

If the Browse for Var button is clicked, the Variable Selector dialog box
displays.
Click the Menus tab if you do not know
any part of the variable name.

Click this tab to


search for a
variable name.

Enter any part


of the name in
this text box.

Select an
option to
specify an
exact search.

Click Begin
Search.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-31


Application Settings
The Application Settings item allows you to build a customized list of parameters
and variables to simplify the configuration maintenance. All important application
settings are in one place, where they can be frequently adjusted or accessed for
information (refer to the following sections).

3-32 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Insert Custom Applications
To create a customized application
1. From the Outline View, select Application Settings.
2. From the Edit menu, select Insert First.
Or, click the right-mouse button and select Insert First. The Application Menu
Edit dialog box displays.

Enter a name for the


application. This name
becomes the item
name and replaces
Application Settings in
the Outline View.

Enter a note, if
desired, and click OK.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-33


Insert Items in a Custom Application
To add items to a customized application
1. From the Outline View, select the new application name.
2. Select Insert First. The Insert Item on Application Menu dialog box
displays, as shown below.

Click on the type of item


you want to insert. A list of
available items displays.

Click on an item(s) and


click OK. It is inserted
under the customized
application previously
inserted.

Tip Another item can be inserted by following the same steps, but select Insert
Next.

Toolbox/Exciter Communications
The toolbox can communicate with the exciter through a serial port or an Ethernet
connection.
To modify the serial communication settings.
1. From the Options menu, select Settings.
2. Click the tab, EX2100.
3. Modify the Serial Port Communication settings, as desired.

3-34 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Download Product Code To The Exciter
After upgrading to a new version of the EX2100 runtime product, it is necessary to
download new Product Code to the exciter. Follow these steps:
1. Download the DSPX Product code (Runtime)
2. Download the DSPX Parameter Values
3. Download the ACL Product code (Runtime)
4. Download the ACL Application Code

Download the DSPX Product code


The toolbox must be connected to the DSPX in the serial mode to upgrade the
product code.
To download the DSPX product code
From the Outline View double-click the device name. The Properties dialog
box displays. Select Serial Port.

To download the exciter DSPX Product code


1. From the Device menu, select Download DSPX
2. Select Product code (Runtime).
3. You will be prompted to confirm the action. Select Yes.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-35


4. The download begins.

When the download is complete, the control rack is reset.

Download the DSPX Parameter values


If the toolbox is not online, you To download DSPX Parameter Values.
will be asked to confirm that
1. From the Device menu, select Download DSPX.
you want to go online and then
download. 2. Select Parameter Values. You will be prompted to confirm the action. Select
Yes.

The parameters are downloaded to the EX2100.

When the download is complete, the control rack is reset.

3-36 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Download ACL Product Code (Runtime) Software
Product code is loaded over Ethernet by the toolbox.
To download the product code (runtime)
1. From the toolbox, create a new EX2100 device, or load an existing file.
2. From the Outline View double-click the device name. The Properties dialog
box displays. Ensure that Ethernet is selected and the correct IP address is
selected.
3. From the Device menu, select Download ACL, and then select Product
code (Runtime). The Download File dialog box displays.

4. Click Select.dnl and click Open. All possible files that can be
downloaded display.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-37


5. Click to uncheck any file not used by the device (to conserve flash space).
The toolbox deletes the entire directory and then downloads only the checked
items. If you are not sure which files to check, click Scan hardware for
suggestions. Files that are associated with I/O in the configuration will be
checked.
6. When you are finished with your selections, click OK. The following message
displays.

7. Select No. Do not reboot. Continue to load application code.

3-38 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Application Code
After validating and building application code, download it.
To download application code
Or click 1. From the Device menu, select Download, then select Application Code.... The
Download Application Code dialog box displays. The default screen
display with all options checked.
2. Click Download to memory to uncheck that option if performing an
upgrade of the product files.

Click this option box to


deselect it.

3. Wait until the red FLASH LED on the device has turned off.
4. Reboot the device.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-39


Block Diagram
Diagrams provide an overall picture of signal flow, sequencing and regulator control
in the exciter. While communicating with the exciter, the diagrams display exciter
variables and their real-time values. Contact and coil states are also indicated.
Exciter parameters can be modified from this view.
To access diagrams
From the Outline View, select the item Diagram. The Overview diagram
displays in the Summary View, as follows:

3-40 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Links to Other Pages
Diagram provides links to other pages, which contain information on exciter
functions.
To access diagram links
From the Summary View, place the mouse pointer over a link button, such as
on the diagram.
When the pointer turns into a hand, click the link button. Another diagram displays
with more details and links. An index is provided.

Modify Parameters from Diagram


Parameters can be modified from the diagram. In the diagram, the toolbox displays
parameter names in the color blue.
To modify a parameter
From the block diagram, move the cursor over the parameter until it changes
into a hand. Click the parameter. The Edit Parameter dialog box displays
(refer to the section Configuration).

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-41


Parameter Jumpers
In the Overview diagrams, parameter jumpers show how different parts of the block
diagram are connected together.

3-42 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Live Data Display
If the toolbox is connected to the exciter, all variables on the diagram display live
values. On the Status bar, the scan rate displays the time it takes to update all the
variables on the currently selected page.

Variables
Green values are valid numbers Variables can be monitored by the toolbox. Live values display in the color green.
received from the exciter.

Live value

Animated Contacts and Coils


Various types of animated contacts are used in the block diagrams to display the
current state of exciter sequences.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-43


Drag-and-Drop Variables
Variables in the block diagram can be copied to the Trend Recorder using the drag-
and-drop feature.
To drag-and-drop a variable in the Trend Recorder
1. From the toolbox Outline View, select Diagram to display the Overview
diagram in the Summary View.
2. Click the link buttons to locate the desired variable(s). The Diagram (Summary
View) becomes full screen.

3. From the button bar, click to open the Trend Recorder.


4. Resize and move the Trend Recorder window so that it and the block diagram
can be viewed (using regular Windows features).

Tip To view both the toolbox and the Trend Recorder, from the Window menu,
select Tile Horizontal or Tile Vertical and adjust the size of the windows.

5. From the Diagram, place the mouse pointer over the desired variable.
6. When the pointer changes to a hand, press and hold the left mouse button. The
pointer changes to the drag-and-drop cursor.
7. Continue to hold the left mouse button down and drag to the Trend
Recorderwindow. At the Trend Recorder, the cursor changes to the drop
pointer.
8. Release the mouse button and the variable will drop in the Trend Recorder.

Print Diagrams
Tip The block diagram(s) is designed to print in Landscape Orientation. From
the File menu, select Print Setup and click the option Landscape.
To print block diagrams
1. From the Outline View, select the item Diagram.
2. From the File menu, select Print. The Print dialog box displays.
Or click .
3. Select the number of copies to print and the page(s).

This field shows that there are 17


diagrams in this device.
Click OK to print all the diagrams
or enter the page number(s) to
print.

Tip To print a single block diagram, open that page, so that it displays on the
screen and click . Click OK. Live data can be printed out on the single page, if
the exciter is online.

3-44 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Exciter Controls
The Exciter Controls command enables you to operate the exciter from the
toolbox, as though you were operating it directly from the keypad located on the
cabinet door. The variables that display are the same as those that display on the
keypad.
To display the Exciter Controls view

Or click . From the View menu, select Exciter Controls. The Exciter Controls view
displays.

Click to reset faults.

Click On to put
the exciter in the
run mode.

Auto controls terminal


voltage on the
generator.

Man controls voltage


on the field.

Use Off to take the


exciter out of run
mode.
Bar Graphs and meters Click + to increase or - to
provide feedback of the decrease the voltage.
current state of the device.

The following icons display on the exciter controls and represent the exciter's health
or state. The active function of an icon depends on which button is clicked on (as
described above).
Icon Function Indicates
Comm. OK The icon line is animated to show there is
communication between the toolbox and the exciter.

Auto or Voltage Automatic controls terminal voltage on the


Man Control generator. Manual controls

Fault State Icon flashing = trip


Icon steady = alarm active
Synchronized Exciter is synchronized to the power grid when the
State icon is animated in the closed position.
Indicates the current state of the exciter control as
On or Off.
Indicates the current state of the exciter control as
Automatic or Manual.

GEH-6414D Toolbox for an EX2100 Chapter 3 Basic Configuration 3-45


Notes

3-46 Chapter 3 Basic Configuration GEH-6414D Toolbox for an EX2100


Chapter 4 Advanced Configuration

Introduction
This chapter provides instructions for using the toolbox to configure and monitor the
advanced settings of an EX2100 device. It also has information on using other
features of the toolbox specific to the device.

Section Page

Blockware Concepts.................................................................................................4-2
Configuration..........................................................................................................4-11
Device Menu Commands .......................................................................................4-45
Software Setup .......................................................................................................4-48
Software Modifications ..........................................................................................4-52
Monitoring..............................................................................................................4-56
Control Constant View ...........................................................................................4-61
Application Documentation....................................................................................4-64

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-1


Blockware Concepts
For more information on how The device software is made up of blocks that perform control logic. The software is
to configure each item, refer to referred to as blockware. These blocks correspond to a function block that exists in
the section, Configuration. the product code (runtime). The block definitions are imported as .tre files within the
block libraries.
These blocks are used to make up macros. Blocks and macros make up tasks. One or
more tasks can go into a module and any number of modules make up a function.
This hierarchy shows how the different levels of device blockware display in the
Outline View below.

There are two levels of blockware that can be reused and instanced any number of
times:
Macro(s) contain a collection of standard blocks.
Module(s) are more complex collection of tasks that have a defined scheduling
relationship.
In the toolbox, block, macro and module parameters are called pins (from their
likeness to the pins of an integrated-circuit chip). All pins have a name unique to
For more information, refer to
their block, macro or module. Pins are connected by signals, which are the basic unit
Chapter 10, Signals and the
for variable information. Signals are created with signal definitions, module pins,
Database.
and macro pins or block pins.

4-2 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Blocks and Block Pins
Standard library block names Blocks are the smallest programming element. They can perform math functions,
are preceded with an underscore solve a Relay Ladder Diagram (RLD), and perform a filter. They can also solve a
( _ ), such as _CLAMP, to differ Boolean equation. (These blocks can be compared to C-language functions, Pascal
them from macros and blocks in procedures or FORTRAN subroutines.) The product code blockware supports a
the Industry block library. function for each block that displays in the standard or Industry block libraries. For
more information about the individual blocks and how they work, see the toolboxs
Block Library Help.
For connecting information, When a block is inserted into a task, a number and colon are added before the name
refer to the section, Connect a to make the use of the block unique, such as 20:MENG. This number is used to refer
Pin. to pins of the block from other blocks in the same task or macro, such as 20:OUT.
Block pins contain signals when the block is inserted. Block pins can be connected
to one another or to other pins and signals using these signals.

Macros, Macro Definitions, and Macro Pins


A macro is a collection of blocks and other macros and contains well-defined inputs
and outputs. You can create a macro by constructing a macro definition. If the macro
definition changes, add a version number.
Once the macro is defined, insert the macro into a task or another macro. The
inserted macros internal blocks and connections cannot be changed. Macros can be
inserted in up to three levels as follows.

Macro pins have unique names and once inserted, they can be referenced just like
block pins. Macro pins are also signals that can be connected to the pins of the
constituent blocks and macros. Once inserted, these macro pins act as the parameters
of the macro whose behavior is specified based on how they are used in the code
inside the macros. The macro has one macro pin designated as an enable pin. The
enable pin is a logical or Boolean signal that makes the macros execution possible.
Macros are shown in the following Outline View. The item, Macro Definitions, is
located in both Functions and Macro and Module Libraries. The library provides a
main location for standard modules and macros. Functions provides a location for
modules and macros used in a particular function.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-3


If a macro is defined local to a function, it cannot be used outside of that function.
Therefore, if the macro is used in more than one function, it should be defined in a
macro library. Also, if the same macro is used in more than one device on a given
job or used on more than one job, it should also be in a library.
This is because the libraries only contain code definitions, not code already instanced
to run in the device. By defining the macro in a library, the library can be directly
imported into the second device without having to separate instanced code. This
makes the maintenance of that macro easier, should it ever need to be changed.
For more information on If a macro definition is changed, the inserted versions of the macro can be updated
instancing, refer to the section, by instancing the macro. Instancing a macro replaces all the blocks and macros, and
Instance Module and Macro their connections inside the macro, but keeps the connections to the macro pins of
Pins. the macro instance. Macros can only be instanced individually, if they are in a Task
(top level).

Tasks and Scheduling


For more information, refer to A task must belong to a module. Tasks divide a module into items that require
GEH-6410, Innovation Series different scheduling parameters. Each task has a period multiplier. The task period
Device System Manual. multiplier determines the rate of task execution by a binary multiple of the module
base scheduling period. This can be 1, 2, 4, or 8 times the module period or event
driven. A task can be scheduled to run based on 0.5-ms, 4-ms, or 32-ms module
periods.
See the Task Scan Scheduling To equalize CPU loading, each task a has a skew offset that shifts its scheduling
Periods Table for a list of position relative to other tasks without changing its execution frequency. The
possible combinations of skew possible values for skew offset varies between 0 and 7 as a function of the period
and period multiplier and the multiplier.
effect of each on task
scheduling. Note Care should be taken when data is shared between modules at two different
time bases. This shared data can change at any time within the slower module, when
the faster module pre-empts it.

TaskA comes before Task B and TaskB comes before TaskC. If all three tasks are
scheduled with the same module period, period multiplier, and skew offset, TaskA
always runs before TaskB and TaskB always runs before TaskC.

4-4 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


For example, the scheduler runs tasks that are scheduled to run in a 4-ms time slice.
If there is extra CPU time before the next 4-ms time slice, it will run any 32-ms
based code currently scheduled to run. If all code scheduled to run in a time slice
cannot complete in the specified time, it still executes the code that should have run
in that time slice and keeps a count of time slice overrun.

Task Scan Scheduling Periods Table


Within a time slice, the tasks are In the following table, each time slice is either .5 ms, 4 ms, or 32 ms long, based on
scheduled based on the order the scheduling period selected for that module in the Edit Module dialog box. If a
they display in the Outline View. device has several modules with the same scheduling period, all the tasks within all
these modules end up together in the same scheduling table. In the table, X
represents when a task will run based on the period multiplier and skew offset
selected for it.
Task Scan Periods at 0.5, 4, & 32 ms Module Base

Task Task Skew


PeriodMult Offset+Module
Skew Scan Period Slice 1 Slice 2 Slice 3 Slice 4 Slice 5 Slice 6 Slice 7 Slice 8

0* 0

1 0 4 or 32 ms X X X X X X X X

2 0 1, 8, or 64 ms X X X X

2 1 1, 8, or 64 ms X X X X

4 0 2, 16, or 128 ms X X
4 1 2, 16, or 128 ms X X

4 2 2, 16, or 128 ms X X

4 3 2, 16, or 128 ms X X

8 0 4, 32, or 256 ms X

8 1 4, 32, or 256 ms X
8 2 4, 32, or 256 ms X
8 3 4, 32, or 256 ms X
8 4 4, 32, or 256 ms X
8 5 4, 32, or 256 ms X

8 6 4, 32, or 256 ms X

8 7 4, 32, or 256 ms X
* A task with a 0 period multiplier is only scheduled if an Event is executed.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-5


Configure Tasks
Tasks can be enabled and disabled from the blockware by connecting the task enable
to a signal and modifying the online value. Disabling a task stops it from running,
regardless of its schedule or any Events put into the database. To prevent execution
of the blocks in that task and the inputs and outputs used in that task from being
transferred, Task enable can be forced to False using the toolbox.
Tasks can be configured to execute periodically, once whenever an Event occurs, or
a combination of the two. All of the external inputs referenced by a task are
automatically transferred from the I/O table to the signal table, just before the task
execution. This signal is frozen for the duration of the execution, as long as it is not
shared by a task in a module with a shorter scheduling period.
Tasks in modules with a 4-ms scheduling period have a higher priority than tasks in
modules with a 32-ms scheduling period. If a 32-ms base task is running when it is
time for a 4-ms base task to run, the 32-ms base task is interrupted for the 4-ms base
task to run. However, within the same module-scheduling period, one task can not
interrupt another even if it is currently scheduled to run.
For example, taskA is scheduled to run every 64 ms and taskB is scheduled to run
every 256 ms. If taskB is currently running when it is time for taskA to run, taskA
can not interrupt taskB. All control blocks are written to use absolute time. This
means that a timer block in taskA would know and adjust appropriately if more than
64 ms had passed since it last ran. It would not assume that 64 ms had passed just
because taskA was scheduled to run at that rate.
All of the external outputs referenced by the task are transferred from the signal table
to the I/O table at the end of the task execution. The I/O transfers can be over-ridden
by forcing or simulation. Even if a task is exited early, its outputs are still written.
It is sometimes useful to equalize CPU loading by skewing entire modules. Each
module contains a skew offset that shifts the scheduling position of all of its tasks by
the same amount. The module skew offset is added to each task skew offset to create
a composite skew offset for that task. The scheduling position for each task relates to
the other tasks in its module remains fixed while the scheduling position of each task
with respect to tasks in other modules changes.
Module pin signals can be internal signals, I/O signals, or Status_S signals. Module
pins have an Event option, independent of the signal attached to the pin, which
affects how blockware is scheduled.

4-6 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Modules, Module Definitions and Module Pins
Modules allow you to reuse blockware on a higher level than macros. All
downloadable blockware is found in the Outline View, under the items, Functions
and Modules.

Note There is no Modules item in Macro and Module Libraries level. However,
modules definitions are found there.

There are several types of modules:


Instanced modules are defined in the item Module Definitions under Functions
or Macro and Module Libraries, then instanced in the item Modules under
Functions. Like macros, these modules are updated by changing the definition
and then instancing that particular module (once instanced, the tasks cannot be
changed).
Inline modules are defined in the item Modules under Functions. They are not
meant to be reused.
Override modules are a combination of the instanced and inline modules. They
are created by instancing a module definition and then overriding it from the
Edit Module dialog box. Overriding a module allows you to start with a
standard module definition and then be able to modify it as an inline module.
Module pins work similar to macro pins. Module pins are primarily intended as
parameters to the module. However, a local pin can be used to share data between
tasks in the macro.
Module pins can be connected to external signals through the Module Pin
Definition dialog box. The connections owned by the module pin are kept intact
when a module is instanced. In this way, a module can be updated with a new
module definition and not lose these connections.
All modules have a region name. The complete signal name for a signal associated
with module pins is the modules region and pin name. For example, the instanced
module CM\std1\speed and module pin name, AutoMode produce the signal name
CM\std1\speed\AutoMode. In the module, the block and macro pins can reference the
module pins by using the module pin name only.
The period and skew of a The period and skew of a module can be overridden in an instanced module, without
module are discussed in the actually overriding the entire module definition. This permits users to maintain the
section Tasks and Scheduling. inter-relation of modules in the same scheduling chart, while incorporating changes
made to a module definition.
To determine if a Module Module Definitions include a revision field. If the definition of the module changes,
Definition should be under the update the revision. When a module definition is instanced, the instance shows
item Module Library or which revision it was instanced from. This helps determine if a module has been
Function, refer to the section re-instanced after a change was made to the module definition.
Macro Definition.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-7


Functions
Functions are also associated Functions, which are at the highest hierarchy level, are used primarily to group
with a .tre file in that each inter-related modules. All the data types scale factors, signals, module definitions,
function is exported as a macro definitions and instances for a given function can be independently associated
separate .tre file. with a function, which allows you to move a function from one device to another.

Libraries
The device has three types of libraries:
Block libraries provide a description of the runtime blocks.
Hardware Module libraries describe the different types of I/O that can be wired
into a device.
Macro and Module libraries provide a central location for standard macros and
modules.
The macro and module library .tre files have the same basic format as function .tre
files, except for the file descriptor at the beginning; there is also no Modules item,
only Macro and Module Definitions. Macro and module libraries can be imported
again, as needed.
For more information, refer to For block libraries, the .tre file must be imported and the runtime standard or
the section, Monitoring. industry software must be downloaded to the device. A mismatch of .tre file libraries
and the corresponding runtime software cause the device to stop running when the
device is downloaded. To import a new block library, you must export the entire
configuration, then import it with the new library .tre files located where the old files
used to be.

4-8 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Edit Function
To edit the Functions or Macro and Module Libraries
In the Outline View, double-click the item name. The associated Edit
Function dialog box displays.

Click to enter a new password (refer to the


section, Change Password for Locked Items.

Modify the
function or
library Name.
Enter the
directory
related to the
function or
software
library.
Check if the
file is not to
be exported

Check to
enable
password
protection.

Enter a note
associated with
this function or
library.

Note If Password Protection Enabled is checked, the Enter password for


<item> dialog box displays. You must enter the proper password to access the item.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-9


Password Protection

When a function or macro/module library


has password protection enabled, a lock
icon displays beside the name.

The name of the locked


item you are attempting to
open displays in the title of
the dialog box.

Any attempts to edit or use


any item within a locked
function or library requires
you to enter the proper
password for this item.

The contents of a locked icon can be used within other items of the toolbox without
unlocking the icon by entering the correct password. However, to view contents of a
locked icon item, you must select that item and enter the password to unlock the
icon. Anytime a locked icon is accessed from the Outline View, the Enter
password dialog box displays.

4-10 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Configuration
A device configuration is constructed by using the toolbox or by importing .tre files
containing blockware. To build the configuration using the toolbox:
Create a device
Import the necessary libraries
Insert blockware
Refer to the section, Blockware Blocks correspond to a function block that exists in the runtime. These blocks are
Concepts. used to make up macros. Blocks and macros make up tasks. A task(s) can be inserted
into a module and any number of modules makes up a function. All of these items
are inserted into a configuration the same way.

Create/Delete Blockware
To insert blockware into a configuration
1. From the Outline View, select a blockware item.
Once an item exists, another item 2. From the Edit menu, select Insert First.
can be inserted by following the
Or, right-click and select Insert First. Depending on the item being configured, a
same steps, but select Insert
dialog box displays to name and define the item.
Next.

Note If a command name is grayed, it indicates that the command does not apply to
the current situation or that you need to make a selection or complete another action
before selecting the command.

To delete a block(s) from a configuration


1. From the Outline View, select the desired item.
Or click . 2. From the Edit menu, select Delete.
Or, press the Delete key.

Functions
A function is used to group inter-related modules. Each function can be exported to a
.tre file with the default name, funcname.tre.
To insert a function into a configuration
Once a function exists, another 1. From the Outline View, select Functions.
function can be inserted by
2. From the Edit menu, select Insert First.
following the same steps, but
select Insert Next. Or, right-click and select Insert First. The Function Name dialog box
displays (refer to the next section, Function Name).

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-11


Function Name

Enter a name and


click OK. The
function is
inserted into the
Outline View.

Function items
display in the
Outline View.

These items are


described in the
following sections.

4-12 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Type Definitions
Type definitions are enumerated data types, which can be used by pin or signal
definitions. An advantage of using type definitions is that the pin of a block, macro,
or module can be limited in scope to particular values or a range of values. Also, you
can select another device name, instead of using the device drop number.
To insert type definitions into a configuration
Or right-click and select Insert 1. From the Outline View, select Type Definitions.
First.
2. From the Edit menu, select Insert First. The Type Definition dialog box
displays to define the data type.

Note Once a type definition exists, another can be inserted by following the same
steps, but select Insert Next. The item can also be deleted.

The Type Definition dialog box is also used to edit existing type definitions.
To edit a type definition
Or double-click the type 1. From the Outline View, select the type definition name.
definition name.
2. From the Edit menu, select Modify. The Type Definition dialog box displays.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-13


Enter a name of up to 12
characters.
Enter a description of up
to 50 characters.
Select the basic data type that
this type definition is based on
(refer to the list below). Type
definitions are always based on
another data type.

Select the data entry restriction.


If Range, assign a minimum
and maximum range definition.
If Enumeration, define the
Value name and value.
To add an enumeration, enter a
name and value, then click
Add.
To modify, select the
enumeration, make changes,
and click Add.
To remove, select the
enumeration and click
Remove.

Basic Data Types


Bool - 8-bit Boolean (0 to 1)
Int - 16-bit signed integer (-32, 768..32,767)
Lint - 32-bit signed integer (-2,147, 483,648...2,147,483,647)
Float - 32-bit IEEE floating point (-3.4 + 38 to 3.4E + + 38)
Lfloat - 64-bit IEEE floating point (-1.8E + 380 to 1.8E + 308)
Collection Data Types
Analog includes all basic data types, except Boolean
Simple includes all basic data types
String is zero-terminated ASCII string (1 to 255 characters)
(Strings must be an array whose length equals the maximum
number of characters + 1 for the terminating zero.

Predefined Type Definitions


Type definitions are used extensively with database settings. Some type definitions
obtain information specific to a particular process by getting it from the database.
To locate predefined type definitions

Or click 1. From the File menu, select Import.


2. From the Import dialog box, import the file Sysdata.tre.

3. From the Outline View, click the symbols next to the item System Data
and again next to Type Definitions to display the predefined type definitions
from the database.

4-14 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Scale Definitions
Scale definitions can be associated with signals. They are used primarily to scale raw
I/O into engineering units used internally by the blockware. For the device, scales
can be created in the toolbox and put into the database.
On many large processes, scales are defined in System Information. If a scale needs
to be edited, System Information eliminates having to know which binary working
files to open.
To insert scale definitions into a configuration
1. From the Outline View, select Scale definitions.
Or right-click and select Insert 2. From the Edit menu, select Insert First. The Scale definition dialog box
First. displays.
This dialog box is also used to edit existing scale definitions.
To edit a scale definition
Or double-click the scale 1. From the Outline View, select the scale definition name.
definition.
2. From the Edit menu, select Modify.

Note Both scale and type definitions can be defined locally to a signal or pin and
display as -Custom- in the Signal Definition or Module Pin dialog list boxes.
These local definitions do not have names and do not display in the list boxes for
other signals (also, they cannot be put into the database because they do not have a
name).

Define Scale Definition

Scale Names are defined in the Measurement System dialog box. If


multi-scales are desired, enter the primary scale name in the textbox
for System 1. Refer to the section, Measurement System.

Enter the Minimum


and Maximum values
of each system and
Raw to provide the
conversion informaton.

Enter a description of
the scale definition
(50-character limit).

Enter the Unit names for each system (five-character


limit). Select the Precision from the list boxes.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-15


Signal Definitions
Signal definitions are used to define signals associated with a Function or Macro and
Module Library.
To insert signal definitions into a configuration
1. From the Outline View, expand of either Functions or Macro and Module
Libraries.
Click

Signal
Definitions

2. Click Signal Defintions.


3. From the Edit menu, select Insert First. The Edit Signal Definitions dialog
box displays. This dialog box is also used to edit the signal definition (refer to
the next section, Define Signal Definition).
To edit a signal definition
1. From the Outline View, select the signal definition name.
Or double-click the signal 2. From the Edit menu, select Modify. Edit the signal from the Edit Signal
definition name. Definitions dialog box.
Signal definitions also display when you update the database. When you put signal
information into the database, the three items that hold lists of signals are inserted
For more information, refer to
under the System Data item:
Chapter 10, Signals and the
Database. External Signal Definitions
Undefined Signal Definitions
Network Signal Definitions

4-16 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Define Signal Definition
Define the signal definition below.
Enter the name of the signal
with at least one and up to
three regions followed by a
signal name. Separate the Enter a scale definition for this device. From the dropdown list,
region(s) and name with a select Custom to create a locally defined scale. Click Edit... to
backslash, such as reg1/ view predefined scales.
signal_name. The Region
can be six characters,
maximum; the signal name
can be 12 characters,
maximum.

Enter a descriptive Note


with up to 50 characters.

Type lists all the type


definitions and simple types
for this device. From the
dropdown list, select
Custom to create a locally
defined data type. Click
Edit... to add the specific
information for that locally
defined data type.

FALSE is the default, if this


is not a Control Constant.
Select TRUE for signal
definitions and module pins
that can be viewed as a
group and exported to a .csv
file. Select READ to restrict
online changes to this Enter the length of the signal, if Connection allows you to Select these options to make
module pin (althought it is it is an Array and the initial connect signal definitions to the module pin a Hold,
still viewed as a normal Value for the elements. If the other signals. Enter the name Event, I/O or Network. If the
control constant). Array size is greater than one, of the signal in the text box or pin is connected to a
a list box of the initial values click Browse... . Status_S signal and used in
for the array elements displays When one signal is connected a task, that task is scheduled
above Value. to another, they share the when the value of the signal
same place in memory. changes, as well as at the
normally scheduled
execution times.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-17


Alarm Tab
The Alarm tab is illustrated below.
Check to select the
Alarm (only available
with a Boolean signal).

The Alarm Class


dropdown lists
available alarm
classes. PRC is the
default.

Enter the full path in


CIMPLICITY Screen
or click Browse... to
select an alarm in
CIMPLICITY.

4-18 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Limits Tab
The Limits tab is shown below.

Display Limits are defined


in the Scale definition as
the Native System
maximum and minimum.
You can override the Scale
definition display limits by
enabling the Signal display
limits and entering new
limits in the Signal.

Setpoint Limits(high and


low) are used in
CIMPLICITY to limit the
maximum and minimum
values that can be set for
that signal in a
CIMPLICITY screen.

Click to select and set the


Deadband value.

Note All values entered are in the signal's native


Measurement System. If the native system is Metric, the
Setpoint Limits for a signal measuring cylinder stroke
length may be from 2 cm to 25 cm.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-19


Module Definitions and Modules
Module Definitions and Modules are items in the hierarchy that can be used to divide
blockware and as a tool to reuse blockware.

Instanced and
override modules
are defined under
Module Definitions

Insert Module Definitions and Modules


When a module is inserted, the type must be specified as defined or inline. Defined
types are existing Module Definitions and inline modules are determined at a later
time. Module definitions are reusable and have a revision number to keep track of
changes to the modules.
Both configuration items are inserted using the same steps (described below). When
both are inserted, they contain another level item called Pins (refer to the section,
Pins). Also, on the same level as Pins, you can insert all of the Tasks for the Module
Definition or Module (refer to the section Tasks).
To insert a module definition or module into a configuration
1. From the Outline View, select Module Definitions (found under the item
Functions or Macro and Module Libraries) or Modules (found under the item
Functions).
Orright-click and select Insert 2. From the Edit menu, select Insert First. The Module Definition Name or
First. New Module dialog box displays (refer to the next sections, Name Module
Definition or Name Module).

4-20 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Name Module Definition

Enter a name for the item you are


inserting. Click OK.

The name displays under the item


you are inserting in the Outline View.

Name Module

Check Inline to
Select an existing module insert an empty
definition. inline module and
define it later.

Enter a note for the module.

Enter a name with up to three


regions separated by backslashes.
(The pins, inserted under the item
Pins, use this same region as a full
name.)

Edit Module Definitions and Modules


Once a module is inserted, it can be edited. The same dialog box is used for a module
definition or module.
To edit a module definition or module
1. From the Outline View, select the name of the module or module definition.
2. From the Edit menu, select Modify. The Edit Module or Edit Module
Or right-click. Definition dialog box displays. The appropriate fields for the particular module
type are enabled (refer to the sections, Edit Module Definition or Module Dialog
Box).

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-21


Check to change an instanced module to an over-ride module. An instanced
module has a colon ( : ) between the region names, such as reg\reg:module.
The over-ride module has an at symbol @, such as reg\reg@module. The
Over-ride checkbox can toggle to change an edited module definition back
to the original. Remove the X and perform an instance. Any custom changes
made to the module when it was overridden is deleted. Revision tracks changes to the
module definition. The form of
the revision must be
V##.##.##A, where ## is at least
two decimal digits and the final A
can be any alphabetic character.
If the format entered is incorrect,
the toolbox replaces the revision
string with V??.??.???.
Select the module scheduling
base period. The associated
over-ride check box is only
enabled for instanced modules.
Check this box makes the fields
behave like the connection of a
module pin (the information of
the module instance is not
replaced when it is re-instanced).
Select the module scheduling
base skew. The associated Over-
ride check box is enabled only
when the module is instanced.

Enter a name for the Help File


associated with this module.
Select the module definition or
instance in the outline and then
click Item Help from the right-
click pop-up menu to display the
Help file entered here.
Enter a description of the module.

Enter a name for the Graphic Window or Windows metafile associated


with this module. This is accessed by selecting a module in the Outline
View, then selecting the Detached Summary View.

4-22 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Module Pins
Module pins are the parameters for a module. They are inserted under the item Pins.
(Pins is automatically created when the item Module is inserted.)
To insert a pin into a Module
1. From the Outline View, under the items Modules or Module Definitions, click
beside a module to display the item Pins.
2. Select Pins to highlight it.
Or right-click and select Insert 3. From the Edit menu, select Insert First. The Module Pin Name dialog box
First. displays.

Enter a name for the item you are inserting.


The name must begin with an alphabetic
character and contain a maximum of 12
characters. Click OK.

The name displays under the item you are


inserting in the Outline View.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-23


Edit Module Pin
To modify a module pin
1. From the Outline View, select the name of the module pin.
Or right-click. 2. From the Edit menu, select Modify. The Edit Module Pin dialog box
displays.

Note For instanced pins, only the field, Connection is active.

The same dialog box is used for both Module Pin and Macro Pin.
Refer to the section, Modules Inserting and editing module pins is limited to module definitions, inline modules,
Definitions and Modules. and override modules. Module pins are referenced in the modules blockware using
only the pin name. By maintaining the use of this name exclusively, the modules can
be re-used. This same method is used to make macro definitions re-usable.

Note Only the pin connection, period, and skew of an instanced module can be
changed from the module definition. Also, the module definition notes are not copied
to the instanced module. An instance specific note can be added to the instanced
module.

Enter a Name (12-


character limit, initial
character: alphabetic).
Module pin names do
not include regions. The
regions for signals
associated with module
pins have the same
region as the module.

Enter a description (up


to 50 characters) of the
pin.

FALSE is the default


value. Select TRUE for
signal definitions and
module pins that can be
viewed as a group and
exported to a .csv file.
Select READ to restrict
online changes to this
module pin (althought it
is still viewed as a
normal control constant).

Select this box to Enter the Select these options to make the module pin a Hold,
mark the pin as a connection an Event, an I/O, or a Network. If the pin is connected
DLAN+ event. path for the to a Status_S signal and used in a task, that task is
pin. scheduled when the value of the signal changes, as
well as at the normally scheduled run times.

4-24 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Macro Definitions
Macros provide a way to re-use blockware on a lower level than modules. Macros
are only instanced and never inline or override. Therefore, all macros must be
inserted under the item Macro Definitions to be used in blockware.
To insert a macro
1. From the Outline View, select Macro Definitions.
Or right-click and select Insert 2. From the Edit menu, select Insert First. The Macro Definitions Name
First. dialog box displays.

Enter a name for the item you are inserting.


The name must begin with an alphabetic
character and contain a maximum of 12
characters. Click OK.

The name displays under the item you are


inserting in the Outline View.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-25


Edit Macro Definition
To edit a macro definition
1. From the Outline View, select the macro definition name.
2. From the Edit menu, select Modify. The Edit Macro Definition dialog box
displays.

Revision allows you to keep track of changes to the macro definition. The
form of the revision must be V##.##.##A, where ## is at least two decimal
digits and the final A can be any alphabetic character. If the format is
entered incorrect, the toolbox replaces the revision string with V??.??.???.
Edit the name that was created
in the MacroDef Name dialog
box. It must not have more than
12 characters.
Enter the name of the pin that
enables the macro or select
from a list of defined pins in the
drop-down list box.

Enter the name of the Windows


Metafile associated with this
macro. This is accessed by
selecting a macro in the outline
view and then selecting the
Detached Summary View.

Enter a name for the help file


associated with this macro or
click Browse to search.
Selecting the macro definition
or instance in the Outline
View and then clicking Item
Help in the right-click pop-up Displays the default access level of this macro.
menu displays the same help Use - the user can use this macro in code, but not view or change it
file entered here. View - the user can use this macro as well as view its contents
Change - the user has total access to this macro

4-26 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Macro Pins
Macro pins are the parameters for a macro. They are inserted under the item Pins.
(Pins is automatically created when the item Macro is inserted.)
To insert a pin into a Macro

1. From the Outline View, under the item Macro Definitions, click beside
a module to display the item Pins.
2. Select Pins.
Or click the right-mouse button 3. From the Edit menu, select Insert First. The Macro Pin Name dialog box
and select Insert First. displays.

Enter a name for the item you are inserting.


The name must begin with an alphabetic
character and contain a maximum of 12
characters. Click OK.

The name displays under the item you are


inserting in the Outline View.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-27


Edit Macro Pin
To define a macro pin
1. From the Outline View, select the name of the module pin.
Or right-click. 2. From the Edit menu, select Modify. The Edit Macro Pin dialog box displays.

Note For instanced pins, only the Connection field is active.

Change the name that was created in the Macro Pin Name dialog box. It can
Select from a list of data types, be up to seven characters long and must begin with an alphabetic character.
made up from all of the type Macro pins are not named with regions included.
definitions and basic types for this The text box below the name allows you to enter up to 50 characters to
controller. To create a locally describe the pin. Note: Sometimes this text box is used by HMI to describe
defined data type, select Custom diagnostic messages.
from the drop-down list. Then click
Editto add the specific
information for that locally defined
data type.

Select how the pin is used in the


macro: Input, Output, Local (not
intended to be used anywhere
outside of this module), Const and
State (read and write). Usage is
not verified during validation.
Usage also indicates if the pin
displays on the left or right of the
macro block. An Input or Const
display on the left of the macro
block and Local, Output or State
display on the right.

Visibility specifies the conditions


that the pins are viewed on block
flow diagrams. Always (pin is
always shown), Never (pin is never
shown), Used (pin is shown when
connected to anything ) and Wired
(pin is shown only if connected to
another signal). This option is not
always applicable (see the Option Array size and Value define the array length of Enter the name of the signal,
menu, Block Diagram). the signal (if it is an array) and the initial value which the pin will be
for the elements. If the array length is greater connected to or click
than one, a list box of the initial values for the Browse to select from the
array elements displays above the Value list Signal Selector dialog box.
box. To edit this box, click on a value in the box
and then enter a value in the Value list box or
select from the drop-down list.

For more information, see the Note For Used and Wired pins, if just a macro instance is selected in the Outline
section, Macros, Macro View with tracking on, the Summary View displays all pins regardless of their
Definitions, and Macro Pins. visibility status.

4-28 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Tasks
Refer to the section, Tasks and Tasks are both the basic scheduling unit and a blockware grouping mechanism in the
Scheduling. device. Tasks are inserted into modules and can be modified.
To insert a task into a Module
1. From the Outline View, under the item Modules or Module Definitions, select
a module name.
Or right-click and select Insert
First. 2. From the Edit menu, select Insert First. The Task Name dialog box
displays.

Enter a name for the item you are inserting.


The name must begin with an alphabetic
character and contain a maximum of 12
characters. Click OK.

The name displays under the item you are


inserting in the Outline View.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-29


Edit Task
To edit a task
1. From the Outline View, select the task name.
Or right-click. 2. From the Edit menu, select Modify. The Edit Task dialog box displays.

Enter a unique name with up


to 12 characters.

Enter a description of the task.

Change the execution time


slice that this task executes.
This can distribute the
execution of different tasks,
so that overruns do not
occur. The possible values
in the drop-down box
depend on the value
selected as the Period Mult.

Period Mult determines how


often a task runs. The period
multiplier times the modules
period equals the period that
this task executes, which is
Event, 1, 2, 4, or 8. (Event Enable option buttons select a value for the task enable.
generates a multiplier of zero
and the task only runs if an Always makes the enable True.
Event occurs). Never makes the enable False.
Pin enables the drop-down list box to select the names of this
modules pins.
Signal changes the drop-down list box to displays the Signal
Selector dialog box to select a signal.

Tip When either Pin or Signal is selected in the Enable options, a module pin or
signal name can also be typed in.

4-30 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Enable or Disable Task
The following screen displays tasks in the Outline View and with Tracking on, how
the tasks can be displayed in the Summary View.

To enable or disable a task

Or click . 1. From the Device menu, select Online.


2. From the Outline View, double-click the task name. The Send Value dialog
box displays to enable or disable the task.
3. Select the desired value for the enable and click Send. The live enable value is
reflected, provided it is not being written to blockware.

Enter the Value to


enable or disable
the task.

Select this box to


prevent blockware
from overwriting
the Value.

Toggle Value inverts the current


value and sends it to the controller
without closing the dialog box.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-31


Blocks and Macros
Blocks are the basic programming construction for blockware. Macros can group
blocks so that they look like a single block. Once a macro is defined, blocks and
macros are connected similarly to make tasks or other macros. The following
sections describe how block and macros can be connected to create functional device
software.

Insert and Delete


The hierarchy for block and macros can be seen in the Outline View shown below.

Macro

Task

Block

Macro

A macro in the item Macro Definitions displays as mac2. When the macro is inserted
in a task or another macro, it displays as a block because the name is preceded with a
block number and a colon (40:mac2). The pins display directly under the macro
name in its instanced form, instead of under the item Pins under the macro name.
Also, the item Blocks displays on the same level but below the instanced macro
items. Only one block or macro can be inserted at a time.
To insert a block or macro into a task
1. From the Outline View, select a task name.
Or right-click and select Insert 2. From the Edit menu, select Insert First. The Select Block/Macro Type
First. dialog box displays.
3. From the list, Category, select a block category, then select a block from the
block library. (The center text block displays either the Library or the Function
name.) Or, from the list Macros, select a macro.
4. Click OK or double-click the block/macro. The item is inserted under Task
name.
To delete a block or macro from a configuration
1. From the Outline View, select the desired item.

Or click 2. From the Edit menu, select Delete. Or, press the Delete key.

Note Blocks or macros that cannot be deleted (those that belong to either a macro
or an instanced module) disable the delete commands when they are selected in the
Outline View.

4-32 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Select Block Type
Macros list box is selected in the same way as
the Block categories.

This number identifies the block


within the task or module, which
it is being inserted into. The
number can be modified as long
as it is greater than the previous
block and less than 89999.

This list displays the standard or


industry block library, which are
grouped into similar functions.
Select one or more categories
and the list box on the right
changes to display all the blocks
in that category(s).
The All button displays all the
blocks. The None button displays
none of the blocks.

The blocks that display in this list


box can be inserted into the task.
Select the block and click OK or
double-click the name of the
desired block.
Note is a read-only field that displays a description of the block or
macro selected. It can be scrolled down by clicking the box so that
the cursor displays in the note text and then use the Page Up/Page
Down or arrow keys.

Rubber Blocks
When a block in inserted, all the block pins are included, except blocks with a
variable number of pins, known as rubber blocks, which insert only the first set of
pins. The block pins that are active only when they display are called rubber pins.
These blocks are handled differently because their functions can act on a number of
sets of pins, depending on how may pins are present. By showing only the active
pins, the diagrams are less cluttered and both the toolbox and runtime require less
memory.
An example of a rubber block with rubber pins is the _BENG block that is a relay
ladder diagram (RLD). The RLD can have from 1 to 16 different signals used in the
ladder. The block is a rubber block because it can stretch from using only one input
to using up to 16 inputs.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-33


Connect a Pin
For more information, refer to To connect the pins of a block or macro use the Connect Block Pin dialog box or
the section, RLD Editor. the Edit Block/Macro Connections dialog box. Boolean engine blocks can also
be connected using the Relay Ladder Diagram (RLD) editor, which is the default for
Boolean engine blocks.
To connect/edit a pin
1. From the Outline View, select a block or macro. The block diagram displays in
the Summary View.
2. From the Summary View, double-click the desired pin. The Connect Block
Pin dialog box displays.

From displays the selected block number and pin name,


the Type, and the Usage of the pin being connected.

Enter the value this block or


instanced macro pin will be
connected to.

The following command buttons


select the pin connection. (The
Pin buttons all display the Pin Select
dialog box, described below.)

Signal displays theSignal


Selector dialog box to select a fully
qualified signal.
Module Pin is only enabled when editing
a task in a Module or Module Definition.
The name is a pin name only, so the
full signal name uses the module
region as its region.
Macro Pin is only enabled when editing
a macro definition. It lists macro pins, which can be connected to this pin.
Block Pin is always enabled. This command provides a list of all
possible block pins that are on the same level of blockware (either in the
same task or macro definition). The names display as block number,
colon, pin name (100:IN).
Inv places a tilde (~) in front of the pin. A ~ placed before any signal
inverts the signal for the connection being made. This command is only
enabled for Boolean pins.
Create Pin allows you to create a macro or module pin that is not in the
Pin Select list. It invokes the Edit Module Pin Definition dialog box with
the name and type preset to the values matching the current pin being
connected. Clicking OK in Edit Module Pin Definition creates a module pin
if the block/macro pin is in a Task or creates a macro pin if the block/
macro pin is in a Macro Definition.
The drop-down list provides enumerated data types (including Boolean
variables). Inserting an enumeration in the To text box gives the pin an
initial value. Initial values can also be connected to block and macro pins
by entering a valid numerical value for pins with a simple numerical data
type or type definitions based on a numerical data type.

4-34 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Edit Block/Macro Connections
The Edit Block and Edit Macro Connections dialog box allows you to edit and
connect block and instanced macro pins for the entire block or macro. The dialog
box accepts inputs on a pin-by-pin basis. This means that once you enter the
connection text and either press Enter or select another pin, the text is applied to the
pin.
To edit all pins in a block or macro
1. From the Outline View, select the block or macro pin. The block diagram
displays in the Summary View.
2. From the Summary View, double-click the desired block or macro.. The Edit
Block Connections (or Macro Connections) dialog box displays.

This is a list of all the pins of the block


being edited. Click on the pin to be This is the instance name Enter a description for every
connected/edited. The pin name of the block or macro. instance of the block.
displays in the read-only box below the
pin names.

This text box allows you to enter the


pin to connect. The command buttons
can also be used to select the pin.
Or, when a single pin is selected for
connecting, it displays in the text box
below the Connection list box. Based
on the pin type, specific help is then
displayed beneath the text box. For
example, for the equation (EQUAT)
pin on a Math block, the help lists all
the mathematical operations that can
be performed, such as +, -, *, / ABS,
or SQR. Also, the drop-down list in the
bottom right-hand corner displays the
required data type for that pin, such
as Float or Boolean.

Signal displays the Signal Selector


dialog box to select a fully qualified
signal.
Module Pin is only enabled when
editing a task in a Module or Module
Definition. The name is a pin name
only, so the full signal name uses the
module region as its region.
Macro Pin is only enabled when editing a macro Block Pin is always enabled. This command
definition. It lists macro pins, which can be provides a list of all the possible block pins that are
connected to this pin. on the same level of blockware (either in the same
Create Pin allows you to create a macro or task or macro definition). The names display as
module pin that is not in the Pin Select list. It block number, colon, pin name (100:IN).
invokes the Edit Module Pin Definition dialog Inv places a tilde (~) in front of the pin. A ~ placed
box with the name and type preset to the before any signal, inverts the signal for the
matching the current pin being connected. connection being made. This command is only
Clicking OK in Edit Module Pin Definition creates enabled for Boolean pins.
a module pin if the block/macro pin is in a Task
or creates a macro pin if the block/macro pin is in
a Macro Definition.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-35


Relay Ladder Diagram
From the Options menu, select Boolean engine blocks can be connected differently than other blocks and macros.
Settings/Device and click the These blocks perform logical operations on inputs to set the output to some value.
option, Use RLD editor. The operation is determined by a Boolean equation, which uses symbolic pin names
as operants. The relay ladder diagram (RLD) editor transforms the Boolean equation
into a relay ladder diagram, where symbolic relay contacts are arranged so that
power flows to the symbolic output coil on the right from the power bus on the left
when the relay contacts in between make a complete connection.
Arranging the contacts on the drawing area using the mouse creates Boolean
equations. Select a drawing mode and place the elements on the grid by clicking the
mouse in that square. Contacts that are connected horizontally are logically ANDed
and those line connected vertically are logically ORed. The names of signals or pins
are connected with contacts in either select mode or one of the contact modes by
double-clicking the contact or coil that receives a name.

RLD Editor
To connect a block using the RLD editor
Or double-click the block name. 1. From the Summary View, select a Boolean block.
2. From the Edit menu, select Modify. The RLD editor displays.

4-36 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


RLD Editor Toolbar Commands

Click To
Start the edit mode, where contacts can be moved, copied, and deleted.
Select a square, place the cursor over a grid square and click the left-mouse button.
Connect a contact to a signal or pin, double-click a contact. The Connect Contact dialog box
displays.
Move a contact, click the contact and drag-and-drop to the desired grid square.
Copy a contact, press and hold the Ctrl key, click the contact, and drag and drop to the desired
grid square.
Delete a contact or line segment, click a grid square and press Delete.

Start the drop mode, where a normally open contact can be dropped onto the grid square.
Connect a contact to a signal or pin, double-click a contact. The Connect Contact dialog box
displays.

Start the drop mode where a normally closed contact can be dropped onto the grid square.

Connect contacts, where as the cursor moves through the grid area, a green tracer segment
indicates where a line segment can be added. A red tracer segment indicates where a line
segment or a contact can be deleted (contacts cannot be moved or copied in this mode).

Validate and compress the RLD. Errors are identified with row and column numbers in the grid
square(s).

Insert a row at the currently selected grid square.

Insert a column at the currently selected grid square.

Select a pin and edit the note and connect any non-RLD related pins. This button displays the
Edit Block Connections dialog box.

Tip The drop-down list RLD Size provides different font sizes that enlarges or
reduces the RLD editor Work Area. If the Work Area is larger than the RLD window,
scroll bars display in order to access and view the entire workspace.

Renumber and Rename, using Window Methods


To maximize productivity, the Starting at the bottom of the device hierarchy, blocks and macro instances can be
toolbox uses many standard cut-and-pasted whenever it is possible to insert one or the other. The number
Windows methods, such as cut- associated with each block or macro is automatically applied by the toolbox. The
and-paste or drag-and-drop. default increment (Step by:) is 10 for blocks or macros pasted at the end of a task.
However, when a block or macro is pasted between two existing blocks or macros, it
is assigned a number halfway between the numbers of the two existing blocks or
macros. Blocks in a task or macro definition can also be renumbered in groups.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-37


Renumber
To renumber a block(s)
1. From the Outline View, select a block, or select a group of blocks by pressing
and holding the Shift key as you click the block names.
2. From the Edit menu, select Renumber. The Renumber Block(s) dialog box
displays.

Enter a new starting


number for the block
or block group. Enter the difference
between the new block(s)
numbers. For example,
Click OK. Start at 40 and Step by 10,
produces the numbers 40,
50, 60, and so on.

Note If the new numbers overlap with existing blocks, a dialog box displays to state
the overlap.

Rename and Copy Blocks


Tasks, modules, and macro and module definitions can be cut and pasted. If a name
is repeated, the Rename dialog box, as shown below, displays to allow you to give
the item a different name. This happens most often when one of these items is copied
to the same name space, such as when a module is copied to the same device or
when a task is copied in the same module.

Pins can be effectively copied from one module type to a different module type or
from macro definition to macro definition. Currently, there is no way to transfer a
macro pin to a module or the reverse.
Another useful method using cut-and-paste is when two different devices are opened
in the same toolbox. The blockware items can be moved or copied from one device
to another. This makes moving entire functions very easy.
Also, portions of the blockware can be cut and pasted in a text editor, such as
Notepad using the Windows paste buffer. The text can be modified using the editor
and pasted back into the blockware (assuming none of the import rules are broken).

4-38 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Block Flow Diagram
The block flow diagram displays the links that connect blocks and macros in a task, a
macro definition, and the block level of a macro instance. The diagram is viewed in
the Summary View (and also in the Detached Summary View, a stand-alone version
shown below). Block connections and editing can be performed from both views.
The block diagram has several viewing options.
Refer to the section, To select block flow diagram viewing options
Application Documentation.
From the Options menu, select Settings, then select the tab Block
Diagram. These settings determine how the blocks display in the Summary
View.
Edit the display or connect blocks from this view as follows:
To From the Block Flow Diagram
Display the Block Details
Click the details icon on the block if it exists
Display the RLD editor Double-click the Boolean engine block name
Display the Edit Block Connection dialog box Double-click the block or macro name
Display the Connect Block Pin dialog box for Double-click the pin of a block
that pin
Highlight the connection of a pin to another pin Click the pin itself or the area adjacent to the pin name reserved for
the pin connection
Connect a module pin already connected to a Click the module pin, drag-and-drop it on the pin to connect it to.
block pin

Tip Instead of using the Connect Block Pin dialog box, click a pin inside the
block work area. Drag-and-drop the pin.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-39


Instance Module and Macro Pins
To instance a module or macro means to update the instance with a new definition.
Instancing occurs automatically whenever a function .tre file is imported.
To instance a single macro or module
1. From the Outline View, select the macro or module.
2. From the Edit menu, select Instance.
3. Select Selected to instance a single item. Or, select All to instance the entire
device (every instanced macro and module will be updated).
Module pins are intended as parameters to the module. However, a local pin can be
used to share data between tasks in the macro. Module pins can be connected to
external signals through the Edit Module Pin dialog box. The connections owned
by the module pin are kept intact when a module is instanced. In this way, a module
can be updated with a new module definition and not lose the connections.
Connecting instanced macro
To edit the connection of a module pin
pins is described in the section,
Blocks and Macros under From the Outline View, double-click the module pin name. The Edit Module
Connect and Edit. Pin dialog box displays.

Enter a Name (12-


character limit, initial
character: alphabetic).
Module pin names do
not include regions. The
regions for signals
associated with module
pins have the same
region as the module.

Enter a description (up


to 50 characters) of the
pin.

FALSE is the default


value. Select TRUE for
signal definitions and
module pins that can be
viewed as a group and
exported to a .csv file.
Select READ to restrict
online changes to this
module pin (althought it
is still viewed as a
normal control constant).

Select this box to Enter the Select these options to make the module pin a Hold,
mark the pin as a connection an Event, an I/O, or a Network. If the pin is connected
DLAN+ event. path for the to a Status_S signal and used in a task, that task is
pin. scheduled when the value of the signal changes, as
well as at the normally scheduled run times.

4-40 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Alarm Tab
The Alarm tab is illustrated below.

Check to make the


Alarm a signal (only
available with a
Boolean signal).

The Alarm Class


dropdown lists all
available alarm
classes. You must
first use the
command, Get from
Database. PRC is
the default.

To select an alarm in
CIMPLICITY, enter
the full path or the
file name (256-
character limit) in
CIMPLICITY Screen
or click Browse... .

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-41


Limits Tab
The Limits tab is shown below.

Display Limits are


defined in the Scale
definition as the
Native System
maximum and
minimum. You can
override the Scale
definition display
limits by enabling the
Signal display limits
and entering new
limits in the Signal.

Click to select and


set the Deadband
value.

Note All values entered are in the signal's native


Measurement System.

Both macros and modules can be used to substitute specific portions of blockware at
instance time. This feature is called string substitution (refer to the next section,
String Substitution).

4-42 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


String Substitution
Portions of blockware in macro or module instances that cannot be affected through
macro and module pin connections can be changed using string substitutions. Also,
even if the macro or module pins affect the blockware, string substitutions might be
used within the pin connections. For example, a particular module may always
interface to a single device. The pins of the module are consistently connected to
signals of the device that all have the same region. In the module definition, a string
substitution can be made, so that the devices region is only specified once and the
pins are connected properly for every instance.
String substitution allows you to substitute strings in blockware or pin connections
for standardization. Specify macro or module pins used exclusively for substitution.
Then special characters, such as %0 or %9 or ^ are put in the blockware or other pin
connections. When the macro or module is inserted, the special characters are
replaced with the substitution text.
Special pins in the macro and module definitions, which receive substitutions,
indicate string substitutions. The data type of these pins is StrSub. The pin names
display as Subn, where n = 0 through 9 or ^. Default values for the substitutions are
entered in the Value field of the Edit Module Pin dialog box and hold the actual
substituted values for module or macro instances.

In the main part of the module definition, sub-strings to be substituted are keyed with
a %n where n = 0 through 9 or ^. Substitutions are most commonly made in the pin
connections to the macro or module with the substitution or connections of the
constituent blocks. Substitutions can also be made in notes or names like macros or
scales, although the normal rules of validation must not be broken.

Note When substitutions occur in the pin connections of the macro or module
definition, the pins must be disconnected at the inserted macro or module. Otherwise
the substitutions, as they are defined in the connections to the definition pins, will
not occur. This is because of the rule that all connections to macros and modules
must be respected. This also allows you to change these particular connections and
override them at the instance, if necessary.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-43


In some cases, only a single character is used in the code to be replaced. A special
pin called Sub^ is provided. This pin works like the others, except only the ^ is
required in the definition blockware without the leading %. This allows code to still
follow the validation rules even though it has the string substitution special character
in it. For example, Stand1\speed is a valid signal name. Stand%4\speed is not valid
since the region can only have six characters.

String Substitution Connection Dialog Box


When a pin is inserted, they are scanned for substitute pins. If the SubStr pins are not
connected, you are prompted for the initial connections to be made to the
substitution. The String Substitution Connection dialog box displays for each
substitution pin with the definition pins initial value as a default.

Enter the initial substitution values that are applied as the module or macro is
inserted. To change the values that are substituted, reconnect the substitution pin and
instance the module or macro again. The result is shown in the following screen.

4-44 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Device Menu Commands
This section describes the following Device menu commands:
Put Into Database and Get From Database let devices share signals with
other devices on the network.
Validate confirms that a configuration is ready to build Pcode.
Build creates a Pcode and a symbol table file for the configuration.
Download sends configuration components to the device.

Database Commands
For more information, see Put Into Database writes signal and topology information to the database. Get
Chapter 10, Signals and the From database reads other devices information from the database and includes it in
Database. the device configuration. Both commands can be performed as Full or Incremental.
The toolbox must also put diagnostic symbol information into the database for other
devices in the system.
To put into database or get from database
If this command is not 1. From the Device menu, select Put Into Database or Get From Database.
available, verify the database
2. Select Full to include all information or Incremental for specific information.
and server name entered in the
Database options dialog box The Put Into database and Get From database commands allow devices to
(refer to Chapter 2, Using the share signals with other devices and drives on the network. The following table
Toolbox). defines the information that can be changed in either the device or the database by
these commands.
EX2100 Device Database Interface
Get from Put Topology Put Symbols
Information database into Database into Database

Ethernet Signals yes yes N/A


Signal Symbols no no Yes
Device Name no yes N/A
Device Number yes yes (assigns if = 0) N/A

Network Name yes yes N/A


Network Number yes yes (assigns if = 0) N/A

Scales yes yes N/A


System data type yes no N/A
definitions

Note The toolbox can put diagnostic symbol information into the database. This is
signal information used by the HMI.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-45


Validate
Validate confirms that a configuration is free of errors. Validation status displays in
the Outline View by the color of the text. Valid items are in black text and invalid
items are in red text. When an item is invalid the item that owns the invalid item is
also in red text. This status expands up each level, so that the drive/device (name)
item of an invalid configuration is always red.
In the device, validating checks connection compatibility, data types, equations,
hardware, and such, which must be correct to build and download a device.
To validate an item
1. From the Outline View, select an item(s).
Or click 2. From the Device menu, select Validate.
3. Select All to validate the entire drive/device or select Selected to validate the
highlighted item and all items in the levels below.
If an error(s) is found, it displays in the Log View located below the Outline View.
Double-click an error to go to the item in the configuration that was not validated.

Build Pcode and Symbols


When a device item is valid, a Pcode file (.pcd) and symbol table file (.sym) can be
built (created). Both are built by the toolbox and can be downloaded to the device to
change the configuration.
A symbol table is required to place signal information in block diagnostic messages
for the HMI. This table consists of a list of the signal names with the address token
and a description. This is the same information that goes into the database when
putting diagnostic information into the database, excluding block notes for the
diagnostic detail.
To build Pcode for a device

Or click From the Device menu, select Build. The Build options dialog box displays.

Build application control code


writes the .pcd file. Enter a file
name in the text box or click
Browse to select a .pcd file
already created.

Build application diagnostic


symbolic table will write the
.sym file. Enter a file name in
the text box or click Browse
to select a .sym file already
created.

Click OK.

Note Errors sometimes occur during a build and like validation errors, the error
messages will display in the Log View.

4-46 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Pcode Report
The Pcode report is a text file (.pcd) created from the build command. The .pcd file
can be interpreted by the toolbox and described in a report.
To create a Pcode report
1. From the File menu, select Open.
2. From the Files of type drop-down list, select Pcode Files (*.pcd).
3. Select the correct directory and .pcd file from the list of files or enter a .pcd file
name in the File name text box. The Create Pcode Report dialog box
displays.

Click View Pcode Report to


display the report in the toolbox
window. Use this option for short
reports only (writing to the
window takes much longer than
writing to a file and then viewing
the file).

Click Create Pcode Report Text


File to write the report to a file.
Click Continue (below) to name
the file and save as a Pcode
Report text file (.txt).

Check either Module or Task.


Then select one or all modules or
tasks from the drop-down list box.

Select the check boxes to


specify the desired record
types to display in the report.

Click Continue to generate the


report.
Click Mark All to receive the Click UnMark All to clear all record
entire .pcd file. type boxes that are checked.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-47


Software Setup
The following sections describe how to setup the software portion of the device for
the first time.
Downloading occurs when a configuration component is sent to the device.
Flash is a non-volatile memory technology that contains the real-time operating
system, the file system, and the TCP/IP software. These are installed with the Serial
Loader, so the remaining runtime and configuration can be downloaded more
efficiently over Ethernet.
The device is shipped with the Basic I/O system (BIOS) performs the boot-up, including hardware self-tests and
BIOS, the real-time operating the Serial Loader.
system, and the runtime
Product code (runtime) software converts Application code (Pcode) configurations
software installed; however, to
to executable code (software) and schedules them.
insure that the latest software is
loaded perform the device Application code (Pcode) (.pcd) file, created by the toolbox, contains the device
setup, described in the next configuration.
section..
Symbols table file (.sym), created by the toolbox, contains signal names and
descriptions for diagnostic messages. The information is read into RAM as needed,
making updating the file in permanent storage sufficient.
Ethernet or UDH Cable

Toolbox and
Serial Loader
Software
COM1 EX2100

RS-232C Serial Loader Cable

Device Setup
The following steps define how to set up the device for the first time. It is assumed
that the toolbox and device are already installed in the pc.
To set up the device
1. Load the flash and configure TCP/IP with the Serial Loader over a serial cable
(see the section, Loading the Flash File System).
A soft reboot from the toolbox 2. Cycle power to activate the new IP settings.
is not sufficient.
3. From the toolbox, load the product code (runtime).
4. Then, load the application code (Pcode) and symbol files to permanent storage
only.
5. Cycle power again.

Note The remaining sections define each of these steps.

4-48 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Serial Loader
The RS-232C cable can be The Serial Loader initializes the device flash file system and sets its TCP/IP address
ordered through your local GE to allow it to communicate with the toolbox over Ethernet. It requires an RS-232C
authorized distributor, as part serial cable. The cable specifications are as follows.
number 336A3582P1.

Controller PC
Pin Pin
Adapter Cable DCD 1 1 DCD
to Controller DSR 6 6 DSR
RD 2 2 RD
COM1 Port
RTS 7 7 RTS
TD 3 3 TD
CTS 8 8 CTS
DTR 4 4 DTR
RI 9 9 RI
GND 5 5 GND

9-Pin Plug 9-Pin 9-Pin 9-Pin Plug


Subminiature D Subminiature D
Receptacle Receptacle

A short adapter cable is required to plug into the device COM1 Micro-D size
connector. This cable can be ordered as part number 336A4929G1. The Serial
Loader can load the Flash File System and configure the TCP/IP software in the
device.
To connect the Loader serial cable
1. Connect the end of the cable to COM1 (9-pin connector) on the device.
2. Connect the end of the serial cable labeled UC2000 connector to the converter
cable.
3. Connect the end of the serial cable labeled pc COM Port to one of the pc COM
ports.

Initializing the Flash


The Flash File System is loaded using the Serial Loader during installation of the
system.
To start the Serial Loader
1. From the Start menu, click Programs, GE Control Systems Solutions,
EX2100 Excitation Control, Vxx.xx.xx.C and Serial Loader. The Serial
Loader dialog box displays.
2. Enter the correct setting as defined in the following Serial Loader dialog box.
3. Click Start Command(s).

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-49


TCP/IP Settings include Computer Name, IP Address, Subnet Mask, and
Router IP. (Obtain this information from your network administrator.) Click
this button to display the dialog box to enter this network data (see the
section, Configuring TCP/IP).

Select the correct platform


from the drop-down list.

Click to define the PC COM


port. Make sure this port
matches the hardware
cable port (usually COM2
or COM3).

Click Load Flash File


System.

Click Display Summary


Information to display
information in this status
window.

Click
to start the selected
commands.

When the load completes, the following message box displays.

4-50 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Configure TCP/IP
Obtain the Computer Name, IP Address, Subnet Mask, Broadcast Mask, and Router
Click in the IP from your network administrator. Enter this data into the proper fields below:
Serial Loader dialog box.

Enter the Internet Protocol (IP) host


name. For Ethernet networks with a
global name server, the host name
can be used interchangeably with
the IP Address when
communicating to a controller.

IP Address is used to identify a


node on a network and specify
routing information on an Internet.

Enter the 32-bit value used by the


IP software to extract the network
ID and host ID from the IP
address. To be valid, the mask
must contain a 1 for all of the
network bits of the IP address
class (shown above).

This field is calculated


automatically.
Enter the 32-bit value used Click to load or save
by the IP software to route these settings (.ssf file)
external network messages. to the local PC.

Tip All IP addresses and masks are represented in dotted decimal notation,
within each of the four bytes of the address, separated with periods, such as
3.29.22.27. To determine the correct IP addresses and masks, see your network
administrator.

To change only the TCP/IP from its initial setting


1. Modify the TCPIP Settings dialog box.
2. In the Serial Loader dialog box, check Configure TCP/IP and
Display summary Information.
3. Click Start Command(s).
4. After the command completes, reboot the device.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-51


Software Modifications
The following sections describe how to modify the application code in the device
and how to upgrade the product code software to a newer version.

Modify Application Code


The device executes the application code from RAM. Each time the device is
rebooted, the application code is copied from permanent storage in the flash into the
RAM. This allows the user to try out new application code by downloading it into
RAM and then restore the original configuration by rebooting. Alternately, the new
code may be made the default by writing it to permanent storage.
Some application code changes, including editing, inserting, or deleting blockware,
may be downloaded to RAM without stopping the control process. This is known as
an online download.
Some application code changes, including modifications to I/O, scales, or variable
addresses, may only be downloaded to RAM by stopping and restarting the control
process. This is known as an offline download.
Still other application code changes, including modifications to system memory
sizes, cannot be downloaded to RAM but must be downloaded to permanent storage
only and the device rebooted. Any change that may be implemented with an online
or an offline download may also be performed this way. Refer to the section, Major
and Minor Differences.
Pcode is written when the menu To change the application code in the device
command, Build application
1. From the toolbox, modify the application code.
control code is selected. This
file contains all the application
software for the current device. 2. Select Validate and Build.
3. From the Device menu, select Download, then select Download
Application Code.
4. Select the desired download from the Download application code dialog
box.

4-52 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Check Download to memory to replace the current running configuration with the new
application code. Then, select from Memory Download Mode:
Offline - Restart controller stops the controller execution before expanding and loading new
Downloads to .pcd. All contents are initialized. Use this mode when there is a major configuration change.
RAM Online - Init all constants to replace the running configuration without stopping for a fast
download. Since all constants are initialized, the process increases.
Online - Init only new constants to replace the running configuration without stopping for a
fast bumpless download.

Check to download the new


application code (.pcd file) to
flash memory to be used when
the controller is rebooted. This
does not change the current
running configuration.
Downloads to Enter the correct .pcd file name
Flash or click Browse...

Check to download the .sym


file to permanent storage. This
changes the active symbol
table in the controller.
Enter the correct .sym file
name or click Browse...

Note When all options are selected, the symbol table downloads first. The
application code is then downloaded to memory. If the download to memory
succeeds, the code is downloaded to permanent storage. If it fails, the download to
permanent storage is cancelled.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-53


Major/Minor Differences
The toolbox keeps track of both the changes made to the configuration using revision
differences between the configuration currently in the toolbox and the downloaded
configuration. The revision in the toolbox and the runtime is stored as two date and
time values. These values are cleared in the toolbox when a major or minor change
occurs and set when the configuration is built (Pcode). When the toolbox is online
with a device, the major/minor revision of the downloaded configuration in the
Target Device is compared with the current configuration in the Tool Device.

Major and minor differences are


indicated in the Summary View.

The device application files consists of Pcode files and diagnostic symbol table files.
Pcode can be downloaded to either the active RAM to replace the configuration that
is running, or to permanent storage. Permanent storage is flash memory for the
device and VME device.
Pcode can be downloaded to the device RAM in either an online mode, where the
configuration is switched over quickly, or offline where the device is completely
stopped and then restarted. It is usually beneficial to use the online download, but the
amount of configuration change could make this impossible.
A major difference means that the major revision in the toolbox is different from the
major revision in the device. A minor difference means that the minor revisions
differ, but the major revisions are the same. Equal means that both major and minor
revisions are the same. These differences all display in the Status Bar.
A bumpless download does not It is not always possible to download online. For example, when a change is made to
disrupt the control as a result the configuration that prevents the download from being bumpless, such as
of the download. numerous changes to signals in regard to their address tokens, or changes to scales or
I/O. In the toolbox, a major change is one that does not allow an online download.
These include changes caused by additions of hardware modules, or packing signals.
Packing involves reclaiming unused tokens (this does not include connecting signals
to points). Minor changes are any other changes to the configuration including
editing, inserting, or deleting blockware.
The status of changes to the configuration can be seen from the Summary View, as
shown below. The first example shows a configuration just built, the second has
minor changes, and the third has major changes.

4-54 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-55
Monitoring
Once a device has been configured and downloaded, the live signal values can be
viewed. This section defines how to go online to monitor these values and certain
Summary Views when the device is being monitored. These views are displayed
when the Tracking button is on and an item is selected in the Outline View.

Going Online/Offline
To see the live data from the Summary Views, it is necessary to be online
(communicating to an running device).
To go online
From the Device menu, select Online. Online blockware information can be
Or click monitored from the Status bar and the Summary View.

Status Bar
When online is initiated, it is indicated on the status bar in the lower right-hand
corner of the Device Window, shown below. The difference status and idle time of
the device replaces the word Offline when the device and toolbox are
communicating. The status bar also displays the enable value and heartbeat of any
tasks or blocks of tasks in the block flow diagram (Summary View) when the
diagram is active.

4-56 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Module View
For information on how to The Summary View for a module item displays the task list with the module
configure and view a modules scheduling information. When monitoring live data, the task list also shows the
graphics window, refer to enable value and heartbeat, as shown below. When the toolbox is offline, the
Chapter 8, Graphics Window. heartbeat and enable value are replaced with a hyphen. The Detached Summary
View for a module item with graphic window file is called a Graphics Window.

Task, Macro, and Block View


For more information, refer to The Summary View (right side) for tasks, macro definitions, macros, blocks, and the
the section, Block Flow block items of a macro instance is called the block flow diagram. When a block or
Diagram. macro instance is highlighted in the Outline View and Tracking is on, the Summary
View displays that single item. When the device is online, the block flow diagram
displays live data values (in green) next to the block or macro pin.
To modify the live data values
From the Summary View, double-click the values. One of the following dialog
boxes displays

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-57


Modify Boolean Value

Use this dialog box to


change or force the live value
of a Boolean signal. Forcing
the value keeps the
blockware from writing over
the forced value, whereas an
unforced value can be over-
written in blockware.

Modify Numerical Value


Use this dialog box to enter a
value to be sent to the controller.
These values cannot be forced,
so values that are written in
instruction blocks do not change
to the value being sent.

Current is the live value of the


signal. Enter the Next value and
click Send.

Delta is the value to be added or


subtracted from the current value.
Click here and increment Click here and decrement
Token is the logical address of the Current value by the the Current value by the
the signal. Delta amount and send it Delta amount and send it
to the controller. to the controller.

Modify Array Value

Click on the
element to
change.
Click Modify.

The Boolean or
Numeric Send
Value dialog
displays with
this element.

4-58 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Watch Windows
The Watch Windows function creates a quick reference list containing names,
values, units, and description of the online values of signals. Each controller
document can contain multiple, uniquely named watch windows. These are saved,
then exported to or imported from the controller's project file.
To select a Watch Window
From the toolbar, click View, then select Watch Windows. The Select
Watch Window dialog box displays.

All Watch Window


names are listed here.

To create a Watch Window


1. Click the New button. The New Watch Window dialog box displays.

2. Type a unique name. Click OK to view Watch Windows.


Click a column header
to change the order of
the headings.

Right-click on the
window to access the
following shortcut
menu.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-59


View Signal Usage
displays the Finder with
the selected signal in the
Signal/Variable Usage
tab.

Trend Signal adds the


selected signal to a new
or already open Trend
Recorder document.

To insert a signal
1. From the Outline View, right-click on a signal to display a shortcut menu.
2. Select Insert Signal to open the toolbox Signal Selector dialog box.
3. Select a signal and click OK.
To delete a signal
From the Outline View, right-click on the signal, then select Delete Signal.
Or, select the signal and press the Delete button.

Note Signals can also be dragged-and-dropped into Watch Window from other
Watch Windows or the Outline View. Dragging an I/O point into a Watch Window
will display the point's attached signal, not the point.

4-60 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Control Constant View
In the toolbox, a constant is a signal with an initial value that is read and never
written. Control constants are specific constants that you might want to consider
A flag indicates the existence or
separate from other constants because of their importance to key control algorithms.
status of a particular condition.
You can flag signal and module definition pins that have this property. Once
flagged, constants can be viewed and compared as a group, exported to .csv files for
manipulation outside of the toolbox, and merged back into the configuration.

Control Constant Work Area


To use the Control Constant View
1. Create or open a binary working file (.ecb).
2. From the View menu, select Control Constants. A separate window
displays, called the Control Constant View. The following sections describe the
menu commands and work area specific to the Control Constant View.

File Menu

Close exits the Control Constant View.


Save/Save As preserves on open file. Save As prompts you for a new file name.
Merge in .CSV reads the saved and modified .csv file and overwrites the initial
value of the signals in the configuration with the new value specified.
Export to .CSV writes the signal information to a .csv file. The form of the file
name is DEVICEControlConst.csv, where DEVICE is the actual device name. The
information includes the name, value, scale, type, and a note.
Print provides a paper copy of the Control Constant View.
Print Preview displays the page as it would be printed.
Print Setup allows you to select a printer and print connection.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-61


Edit Menu

Modify allows you to edit the selected signal.


Find allows you to search the Control Constant View for text in the signal names.

Device Menu

Online toggles the device online/offline to view live data values and enables the
Save Values command.
Save Values obtains the live values displaying in the Control Constant View and
puts them in the device configuration. Make these changes permanent by going to
the device window and saving the binary file.
Modes of Operation
The Control Constant View has two modes of operation, online and offline. The
offline view displays the Signal Name, Initial Value, Type, Scale, and Note for all
signals that are control constants.
To edit a control constant
Double-click a signal name. The Signal Edit dialog box displays.

In the online mode, the live Value displays (second column). Signal Names that have
differences between the live Value and Initial Value are marked with a red not-
equals symbol ().

4-62 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


To modify the live value
Double-click a signal name. The Send value dialog box displays.

Use this dialog box to enter a


value to be sent to the controller.
These values cannot be forced, so
values that are written in
instruction blocks do not change to
the value being sent.

Current is the live value of the


signal. Enter the Next value and
click Send (or click Send & Close
to exit the dialog box).

Delta is the value to be added or


subtracted from the current value. Click to either Increment or Click here to send the value entered
Decrement the Current in the Next box to the controller. This
Token is the logical address of the value by the Delta amount is the default setting, so typing a
signal. and send it to the controller. value and pressing Enter also sends
the value and closes the dialog box.

Note In a control constant view, the live values can be saved to the configuration
online from the Device menu.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-63


Application Documentation
The application documentation assists you in understanding and maintaining the
system by providing online data, which can be printed. This documentation contains
block diagrams and reports. Block diagrams provide information about device
blockware and reports contain information about signals and Pcode.

Block Diagrams
There are two types of block diagrams in the toolbox for a device configuration. The
annotated block diagram provides a large amount of information, such as a detail
description of the block, a diagram including pin names and data type, and
application notes. The block flow diagram can help you debug and troubleshoot the
system. This diagram can be used in an online mode together with other diagnostic
features in the toolbox.

Annotated Diagrams
The annotated diagram provides formal blockware documentation. The diagram can
be generated at many levels ranging from top level Function items to an individual
task or macro.
To create an annotated diagram
1. From the Outline View, select the desired Function, Module, Task, or Macro
for the diagram.
2. From File menu, select either Print (for a hard copy) or Print Preview (to
view from the screen).
The annotated diagram usually contains many items. Each function, module, module
definition, macro, macro definition, and task in the device will be identified as an
item. An item can contain other items or blocks on a lower level. For example, an
item with other items could be a function or module. A block that has other items
would be a task or macro definition. The number of items in a diagram depends on
the amount of code under the item, when selected from the Outline View.
Each item is assigned one or more sheets in the diagram. Each sheet has a unique
code for that particular item. The first page(s) of the diagram list all the items in the
If there are more than 26
diagram and their associated sheet codes. In each item, the sheets are designated A to
sheets, the code will designate
Z. The sheet codes display in the bottom right-hand corner of each sheet and all have
them AA to ZZ.
the same structure as follows:
Code Meaning
02:01A Sheet A of the first module in the second function.
05:02:03B Sheet B of the third task in the second module in the fifth function.
02:04:08CD Sheet CD of the eighth task, the fourth module in the second function.

The Comment block can be An item containing blocks can be logically divided into smaller items with a
found in the block library, Comment block (__COMMENT). This block causes a break in the block diagram,
Sblib.tre. which functionally creates level items in the task or macro definition level. All
blocks in the item after the Comment block display on a different sheet. If a note is
placed on the Comment block, it displays at the top of the new sheet. The block itself
does not display in the diagram.

4-64 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


At the end of each of these lower levels are two lists:
The scope limit allows you to The signal definition list contains all the signals in the lower level. For each signal,
select a range for the signal it lists the signal name, data type, default value, and description.
where used.
The where used list shows all locations in the configuration, within a scope limit,
where the signal in the signal definition list is referenced.

Where Used Scope


To set a scope limit
1. From the Options menu, select Settings.
2. From the Settings dialog box, click the tab Print.

Select the font for the


text displayed
immediately over the
blocks in the diagram.
The default font is
Courier New.

Select the font for the


Signal Definitions and
Where Used Lists at
the end of each block
subsection. The default
font is Courier New.

Select the font for the


text at the top of each
new section and block
subsection. The default
font is Arial.

Select the font for all


text not listed above,
including block names
and pins. The font side
directly affects the
number of blocks that
display on a page
diagram. The default
font is Arial Narrow.

Specify the scope of the signal cross-referencing in the


active block diagram

Tip Many of the default printer settings can be edited before printing, such as
page orientation, resolution, margins, and paper sources. The type of printer and the
version of printer driver(s) installed determine editing choices. For more
information, see your printer or printer driver manual.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-65


Block Flow Diagram
For more information, refer to The block flow diagram can be captured and viewed (Summary View or the
the section, Block Flow Detached Summary View ) or printed to a hard copy (paper) form. The diagram
Diagram. displays the item (task, macro, or macro definition) currently highlighted in the
Outline View.
To view a block flow diagram
1. From the Outline View, click the desired item (in the hierarchy list) to
highlight it.
Or click to view the 2. View the diagram from the Summary View or select Detached Summary
Detached Summary View. View from the Edit menu.
Or, from the File menu, select Print Preview to view the diagram online or
Or click to print a hard select Print to create a hard copy.
copy.

Page breaks divide the report The Block Flow diagram uses the Comment block to force page breaks. The pages of
information into orderly pages. the diagram are numbered in a row/column format. (This format makes it easy to
assemble the report on a wallboard.) The size and characteristic of the blocks can be
edited in the Block Diagram tab.
To edit the Block Diagram
1. From the Options menu, select Settings.
2. From the Settings dialog box, click the tab, Block Diagram.

4-66 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Block Diagram Tab

Display the blocks in a list with no


connections or connected to each
other or the Summary View and
Detached Summary View.

Check to show all List block


diagram pins. This command
disregards the text box Visibility,
if it is checked in the Edit Macro
Pin Definition dialog box. Font
size changes the font size of all
text on the block diagram.

Check the following options for


interconnected block diagrams:
Show all pins displays all
block pins. This command
disregards the text box
Visibility, if checked in the
Edit Macro Pin Definition
dialog box.
Reorder pins rearranges the
pins to minimize crossing the
connections on the diagram.
Show input or Show output
connections displays the
connection names and values.

Font size changes the font Change the Summary View tracking feature to display various levels
size of all text on the block of the hierarchy, when they are selected in the Outline View. Select
diagram. the item to display on the lowest level. The default is Task/Macro.

GEH-6414D Toolbox for an EX2100 Chapter 4 Advanced Configuration 4-67


Notes

4-68 Chapter 4 Advanced Configuration GEH-641D Toolbox for an EX2100


Chapter 5 Finder

Introduction
This chapter defines the features of the Finder. The Finder is a separate window in
the toolbox, which contains several useful find tools. It can help you find items, such
as text, overrides, differences, and signal/variable usage from the different types of
devices.

Note The SDB Browser is another window that finds items, such as signal usage,
system topology, signals on the SDB, and more (refer to GEI-100506).

Section Page

Use the Finder ..........................................................................................................5-2

GEH-6414D Toolbox for an EX2100 Chapter 5 Finder 5-1


Use the Finder
To use the Finder
1. From the View menu, select Finder. The Finder window displays (see the next
Or click . section, Finder Window).
2. Select a target from the drop-down Target List. (All loaded targets are listed.
The default target is the current device.)
3. Select a tab according to the type of search desired.
4. Enter each field of the tab (described in the next section).

5. Click . Once the search completes, the Output View and Status
bar display the results.

Tip By default, the Finder closes when the Find button is clicked or when you

click any part of the screen outside the Finder Window. Click to keep the
Finder open.

5-2 Chapter 5 Finder GEH-6414D Toolbox for an EX2100


Finder Window
Title bar Target list

Toolbar

To resize the window:


Tabs 1. Click the window to
highlight it.
2. Place the cursor on
any side of the window
until the double arrow
displays.
3. Click the arrow and
drag-and-drop the
window to the desired
size.

Output View

Status bar

The Finder target determines the device and area of the search. When the Finder is
activated, it automatically selects the current device as the target and displays it in
the Title bar. A target performs various finds, as follows:
Target Can find

SDB Signals
OC2000 Text

AcDcEx2000 Text, variable usage, override,


difference
Innovation Series drive Text

Innovation Series controller, Mark VI Text, signal usage


controller, EX2100 Excitation Control
and System Information

GEH-6414D Toolbox for an EX2100 Chapter 5 Finder 5-3


Located below the Title bar is the toolbar.
Click To
Hold the Finder Window open. If this pushpin displays, the Window closes when the area outside
the Finder Window is clicked. Click the pushpin to keep the Finder on top of the Device Window,
even when you click outside the Finder Window.
Close the Finder Window. This pushpin displays when the pushpin above is clicked on. The Finder
Window remains opens when the pushpin is in this position (even when working in another
window).
Goto an item in the Outline View. Highlight an item in the Output View, then click this button to
find it in the Outline View. Double-click an item to edit it.

Hide the tabs and make the Finder window display only the Output View.

Target Finds
The Finder contains tabs that display according to the device selected in the drop-
down box, Target List and the tab selected (type of find). The following sections
describe each tab.
Refer to the SDB Browser in The Text/Address tab allows you to search for all text and address usage. It is
GEI-100506. available on all targets, except the SDB. The Signals/Variables tab allows you to
search for signals/variables in a controller, AcDcEx2000, EX2100, Mark VI or
Signals apply to a controller or
System Information. The Override tab and Differences tab displays only when the
System Information target.
target is an AcDcEx2000 device.
Variables apply to an
To perform a find
AcDcEx2000.
1. From the Outline View, click an item to search.

2. From the toolbar, click . The Finder displays to begin your search. Click
the desired tab as described in the following sections.

5-4 Chapter 5 Finder GEH-6414D Toolbox for an EX2100


Text/Address
Select the target from the drop-down list
(can be any target except the SDB).

Enter the text to find.


(wildcards such as
* and ? are not supported).
The drop-down list box allows
you to access previous finds.

Click here to include all note


message boxes in the find.

Click Find to start the find.

All text that is found displays


in the Output View.

Status bar

Method allows you to qualify the find by selecting one of the following
from the drop-down box:
Anywhere In matches items that contain the find text anywhere within
their text.
Begins with matches items whose text begins with the find text.
Exact matches items whose text is exactly as the find text.
Address is for the AcDcEx2000 and matches items whose address is
the same as the find text. This method is also useful for finding
controller signal names related to token numbers, such as diagnostic
that have an out of date symbol file.

GEH-6414D Toolbox for an EX2100 Chapter 5 Finder 5-5


Signal/Variable Usage

Select the target from the drop-down list.


Click this button to keep the
Finder window displayed in the
Select the tab, Signal/Variable Usage.
Outline View.

The Track
Item box is already
checked. This means
that the current
highlighted item in the
Outline View is the
signal/variable to find.

The signal/variable
items that are found
display in the Output
View.

INC is the current


highlighted item.

Note When a different item is selected in the Outline View, the Find is performed
again. Click the option Track Highlighted Item to clear it and prevent the find
from performing each time the Outline View item changes.

5-6 Chapter 5 Finder GEH-6414D Toolbox for an EX2100


Chapter File Checkin/Checkout

Introduction
This chapter describes the Checkin/Checkout utility, which allows you to share files
contained in a master directory. The files in the Master Directory are checked out
into the specified Local Directory in either Share read (read-only) or Exclusive
(read/write) mode.

Initialization
Note This utility does not prevent the File Manager from overwriting the files in the
Master or Local Directory.

To initialize the Master Directory


1. From the File Manager, select a directory to maintain the Master files.
2. Copy all desired files into this Master directory.
3. From the Program Manager, double-click on the Checkin/Checkout icon.
The Checkin/Checkout Utility dialog box is displayed.
4. Select the Master Directory and Local Directory.
When the utility is run for the first time, a lock (.lck) file and text (.txt) file are
created in the specified Master Directory. The user.lck file keeps the current lock
state of all files processed by this utility. The userlock.txt keeps track of all the files
in the Lock File Data screen.
The Checkin/Checkout dialog box contains two directories to manage shared
files. The fields and commands are as follows:
Local Directory and Master Directory display a list of files and the current lock
status of each file, based on the List of Files Type list box. Browse allows the
user to select a drive and directory for both the Master and Local Directory.
List of Files Type provides a choice of filenames to display, based on the filename
extensions in parentheses. The default extension is All Files (*.*).

GEH-6414D Toolbox for an EX2100 Chapter File Checkin/Checkout 6-1


Click Checkout to copy the highlighted file(s) Details displays the current Lock File
in the Master Directory list to the Local Data (File, Lockstate, Computer: User,
Directory list. Directory access must be Date/Time) of all files that are processed
Shared read file(s) are
granted. by this utility.
copied to the Local
Directory as read only files.
These file(s) are displayed
with an R after the file
name. The file(s) can be
copied, even if locked by
another user. Any attempt
to write to the file causes a
Permission denied error
message.
Exclusive files(s) are
copied to the Local
Directory as read/write
files. This denies anyone
else access to check the
file out in Exclusive mode.

Click to copy the highlighted


file(s) in the Local Directory
to the Master Directory.
Directory access must be
granted.
Note: The highlighted file
must be in Exclusive mode
or it must not exist in the
Master Directory. The file is
set to read only (R) in the
Master and Local
directories after copying. Select the type of file(s) to Access forces the lock of the selected Master Directory to
Other users can now check display in the Master Directory you. Use this only if no other users are using this utility and
out this file. list. the lock is granted to another user. This will happen if the box
is turned off or the task is terminated while running the utility.
Unlock removes the lock on the currently highlighted file(s) in
the Master Directory. This removes the file(s) from being
controlled by the utility. Unlock makes the master copy and
the local copy of the file accessible.

Note The Unlock command is unconditional (the file is not copied or changed in
any way). The user is responsible for managing the file. The read attribute is left
enabled on the master file.

6-2 Chapter File Checkin/Checkout GEH-6414D Toolbox for an EX2100


Chapter 7 Configuring System
Information

Introduction
TXTV is the variable number of This chapter provides instructions for using the toolbox to configure System
parameters in the alarm Information. System Information is used to configure information global to a project.
message (TXT=text message This information includes data such as scale factors, DLAN+ groups,
V=variable). CIMPLICITY Human-Machine Interface (HMI) resource names, enumerations,
and broadcast (TXTV) alarm messages.
Once the configuration for System Information is defined, the data is put into the
System Database (SDB). This makes the global data available to other devices and
interfaces.

Section Page

Working with System Information Files ..................................................................7-1


Concepts ...................................................................................................................7-2
Configuration............................................................................................................7-3

Working with System Information Files


System Information is configured using two types of files:
Binary working files (.syb) contain an exact copy of the configuration used by the
toolbox. Users generally work from .syb files.
Project files (.prj) are text files containing property and system configuration
information. The files transport the System Information to different versions of the
toolbox.

GEH-6414D Toolbox for an EX2100 Chapter 7 Configuring System Information 7-1


Concepts
There is no hardware item for System Information in the toolbox. System
Information is used primarily to configure and manage global project information.
This information includes Scale Definitions, DLAN+ Groups, and resource names
(Type Definitions). System Information puts this information into the database to
make it available to other devices.

Scale Definitions
Scale definitions are scale factors associated with signals. They are used to
Scale raw I/O into engineering units used internally by the blockware in a
controller or CIMPLICITY HMI system
Provide unit, precision, and limit information for a signal
The ownership of scale definitions, those of System Information as well as of other
devices, is maintained in the database.

Alarm Classes
An alarm class, which defines the attributes for a classification of alarms, is created
for each group of related alarms that share a common priority and color scheme.

Type Definitions
Resource Names
Resource names are stored within a special Type Definition named Resource. Any
signal put into the database can be associated with one resource name (just like a
signal can be associated with a scale definition). This Resource name groups signals
used by the CIMPLICITY HMI system. When some systems import signals into
CIMPLICITY, the resource name is used to determine which signals get imported.
(For example, you can import all the signals that have a resource name of Entry.)
The Resource name can also be used as a filter for displaying alarm/event data on a
CIMPLICITY HMI.
System Information defines and puts resource names into the database. This makes
the resource names available to other devices that can then assign them to
appropriate signals.

Enumerations
Type definitions defined as enumerations are stored in the system database when a
Put into Database command is started. These enumerations are global, and can be
used by other devices after they perform a Get from Database command. These
enumerations will be imported into CIMPLICITY and any enumerations associated
with signals will also be associated with the corresponding CIMPLICITY point.

Measurement System
The Measurement System defines the names of the two measurement systems. The
names are used for dual scales when creating a scale definition. Measurement
System 1 should be the primary measurement system used in the project. The default
name for System 1 is US, and the default name for System 2 is Metric.

7-2 Chapter 7 Configuring System Information GEH-6414D Toolbox for an EX2100


System Overview
The System Overview provides the ability to access various configuration files and
other executables through an animated drawing interface. Requisition engineering
provides the Overview drawing in a metafile format to be used by the Toolbox.

Configuration
The following sections discuss System Information configuration.

Create/Modify System Information


To create System Information
Or click
1. From the File menu, select New. The New dialog box displays.
2. From the System Configuration tab, select System Information and click
OK. The System Information window is created with a temporary name,
such as sys1. The Outline View displays as follows:

To modify the System Information name


1. Click on the name to highlight it.
Or double-click the name. 2. From the Edit menu, select Modify. The System Device Name dialog box
displays.

Enter a new name of up to


five characters. Click OK.

Click to select Turbine


System if this information
will be used in a turbine
project.

GEH-6414D Toolbox for an EX2100 Chapter 7 Configuring System Information 7-3


Insert/Modify Scale Definitions
Scale definitions can be associated with signals. They are used primarily to scale raw
I/O into engineering units used internally by the blockware. For the EX2100, scales
can be created in the toolbox and then put into the database.

Tip On many large processes, scales are defined in System Information, allowing
all controllers to use the global scale. To modify a scale, you can immediately open
the system information file instead of searching all the controllers to find the scale.

To insert scale definitions


1. From the Outline View, select Scale Definitions.
Or use the shortcut keys, Shift 2. From the Edit menu, select Insert First.
+ Insert.
Or, click the right-mouse button and select Insert First. The Scale definition
dialog box displays.
To modify a scale definition
Or double-click on the scale 1. From the Outline View, select the scale definition name.
definition.
2. From the Edit menu, select Modify. The Scale definition dialog box
displays.

Note Both scale and type definitions can be defined locally to a signal or pin and
display as -Custom- in the Signal Definition or Module Pin dialog boxes. These
local definitions do not have names and do not display in the list boxes for other
signals. Also, a locally defined scale cannot be put into the database.

Scale Names are defined in the Measurement System dialog box. If


multi-scales are desired, enter the primary scale name in the textbox
for System 1. Refer to the section, Measurement System.

Enter the Minimum


and Maximum values
of each system and
Raw to provide the
conversion informaton.

Enter a description of
the scale definition
(50-character limit).

Enter the Unit names for each system (five-character


limit). Select the Precision from the list boxes.

7-4 Chapter 7 Configuring System Information GEH-6414D Toolbox for an EX2100


Resource Type Definitions
Refer to Chapter 4, the section Resources are defined as type definitions. The resource type definition allows the
Type Definitions. CIMPLICITY HMI to group signals. System Information puts the resource name
into the SDB for other devices to get the resource names and associate them with
signals.
ASCII string (1 to 255 Resource is always of Basic Data type: String. When resource names are first
characters). Strings must be an defined, it is not necessary to assign a Value to the Value name (refer to the
array whose length equals the Resource Name Values dialog box). This is done automatically when System
maximum number of characters Information puts the data into the database. For example, the following list displays
+ 1 for the terminating zero. a set of resources entered without a value.

DEFAULT (0)
PASSLINE2 (0)
PASSLINE1 (0)
EXIT (0)
PROCESS (0)
ENTRY (0)

After System Information puts its configuration into the SDB, values for each
resource name are assigned automatically by the database, as follows:

Values for each resource name are


assigned automatically by the database.

GEH-6414D Toolbox for an EX2100 Chapter 7 Configuring System Information 7-5


Enumerations
Enumerations are defined as type definitions. Properly defined enumerations are
stored in the SDB when a System Information Put Into Database command is
performed. To qualify as an enumeration, the Type Definition must be Enumeration
with a Base Datatype of Int. For each enumerated field, the Note field must be filled
out with not more than 32 characters. The reason for this rule is that the Note field is
multilingual and is used as the enumerated text field in CIMPLICITY.
The following is an example of an enumeration.

The enumerations are placed in the database with the Put into Database
command, which makes them available for use as a datatype by signals.
The HMI configuration will import all enumerations in the SDB into the
CIMPLICITY system. Any signals on EGD that use one of the global enumerations
as a datatype will have the corresponding CIMPLICITY point associated with the
CIMPLICITY enumeration.

7-6 Chapter 7 Configuring System Information GEH-6414D Toolbox for an EX2100


Alarm Classes
To insert an alarm class
From the Outline View, select Alarm Classes.
From the Edit menu, select Insert First. Or, click the right-mouse button and select
Insert First. The Edit Alarm Class dialog box displays.

Enter the alarm class


Name (five-character
limit).

Enter the alarm class


Priority (0 through 9,
with 0 being highest).

Enter a Description of
up to 50 characters, if
desired.

Select Foreground
and Background
colors for the Normal
State, the Alarm State,
and the Acknowledge
State.

GEH-6414D Toolbox for an EX2100 Chapter 7 Configuring System Information 7-7


Measurement System
To insert a measurement system
1. From the Outline View, select the device name.
2. From the Edit menu, select Modify. The System Information Name dialog
box displays.
3. Click to select the Turbine System option. Click OK.
An item called Measurement System displays in the Outline View.
To modify a Measurement System
1. From the Outline View, select the measurement system name.
2. From the Edit menu, select Modify. Or, click the right-mouse button and select
Modify. The Measurement System dialog box displays.

Enter the names of


System 1 and System 2
(12-character limit).

The default for System 1


is U.S. The default for
System 2 is Metric.

7-8 Chapter 7 Configuring System Information GEH-6414D Toolbox for an EX2100


System Overview
The System Overview is used to graphically access the configuration files and
programs used in a system. The hyperlinks on the drawings display the associated
binary configuration files.

GEH-6414D Toolbox for an EX2100 Chapter 7 Configuring System Information 7-9


Configure System Overview Settings
To configure System Overview settings
1. From the Outline View, select the System Overview item. The Edit Overview
Settings dialog box displays.

Select the metafile


to be associated
with the System
Overview.

Click Add to enter


target information
into the Edit
Overview Target
Settings dialog
box.

2. Click the Add button to display the Edit Overview Target Settings dialog
box.

The target
Name is the
name as it
appears on the
windows
metafile.
Two lines of
text can be
entered to
describe each
target.
Enter the
executable or
binary
configuration
file to be
associated with
the target.

The Summary View then displays the metafile with the target text. The command
associated with the target can be run by double-clicking the hyperlink in the metafile.

7-10 Chapter 7 Configuring System Information GEH-6414D Toolbox for an EX2100


Put Data into Database
To make configuration information available to other devices through the system
database, you must use the Put into Database command.
To put data into the database
From the Device menu, select Put Into Database. A warning message box
displays to confirm the operation.

GEH-6414D Toolbox for an EX2100 Chapter 7 Configuring System Information 7-11


Notes

7-12 Chapter 7 Configuring System Information GEH-6414D Toolbox for an EX2100


Chapter 8 Graphics Window

Introduction
This chapter describes the Graphics Window, which is used to create custom
graphics interfaces for customer and process requirements. It describes how to draw
the graphic objects and then attach animation and input data to the objects.
Section Page

Graphics Window Objects........................................................................................8-2


View Signal Summary..............................................................................................8-9
Settings ...................................................................................................................8-10
Draw Commands....................................................................................................8-15
Animate Objects .....................................................................................................8-18
Input Fields.............................................................................................................8-28
Use Graphics Window Objects...............................................................................8-33

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-1


Graphics Window Objects
A graphics window is created by drawing graphics objects and then attaching
animation and/or inputs to the objects, as follows:
Object Animation produced
Line Color and Property
Rectangle Bar graph, Trend, Color, and Property
Circle Color and Property
Ellipse Color and Property
Polygon Color and Property
Polyline Color and Property
Text Property, Numeric, Text, and Color
Insert Object Property, Numeric, Text, and Color
All drawing objects can be attached to the following input type(s) for entering data:
Numeric
Set point
Initial value
Text
Toggle
Hyperlinks
In addition, inserted ActiveX Control objects can have Event inputs.

8-2 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Create Graphics Window
To create a Graphics Window
The Graphics Window displays 1. From the File menu, select New. The New dialog box displays.
as a detached view that can be
2. Click on the tab Utilities, select Graphics Window and click OK. The
moved and sized.
Graphics Window displays and creates a graphic file (.grw). Both the
configuration file and the .grw must be opened for the Graphics Window to
function. Therefore, a message displays if there are no devices loaded.

Note If more than one device is open, you must select the one to configure for the
current Graphics Window.

Select Device
The default file name, Change the current device within the Graphics Window by selecting Device from
graphics_.grw can be changed the Draw menu.
when it is saved.

This dialog box lists all


open devices.

Click on the desired device


for this graphic.

Click OK.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-3


Menu Bar
The File, Options, Window, and Create custom graphics and animation in the Graphics Window work area using the
Help menus are the same as the Menu bar or toolbar. Some menu commands are different from the regular toolbox
toolbox. menus and are described in the following sections.

Edit Menu
The Edit menu commands allow you to modify graphic objects, and select animated
and input objects.

Or click . Cut removes the selected object and places it on the clipboard.

Or click . Copy duplicates the selected object and places it on the clipboard.

Or click . Paste inserts the object from the clipboard into the current file.

Or click . Delete removes the selected objects from the current file.

Or click . Push Back sends the selected object(s) behind other overlapping objects.

Or click . Pull Forward sends the selected object(s) in front of other overlapping objects.

Align contains the following options:


Top, Bottom, Left, Right move the objects to align the top, bottom, left, or right
edge with the corresponding edge of the selected object.
Vertically Space evenly spaces the objects within the area of the top of the
highest selected object and the bottom of the lowest selected object. The top-to-
bottom order of the spaced objects remains the same.
Horizontally Space evenly spaces the objects within the area of the left of the
left-most selected object and the right of the right-most selected object. The left-
to-right order of the spaced objects remains the same.

8-4 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Match Width, Match Height resizes all selected objects to match the size of the
last object selected.
Group creates a single object from all selected objects. You can perform all normal
operations on this single persistent object. When a group object is selected,
Ungroup will convert the group back into multiple individual drawing objects.
Select Animated highlights all animation objects in the Graphics Window.
Select Input highlights all input objects in the Graphics Window.
Signal Substitutions creates an alias for signal names used in animation/
inputs.
Allow Editing allows you to make changes to the Graphics Window. This option is
enabled by default (indicated by a checkmark next to the option). Unchecking this
option also allows hyperlinks to operate while the device is offline. The setting for
this option is saved for each Graphics Window individually.

View Menu
The View menu allows you to toggle the Toolbar and Status Bar.

Toolbars contains buttons to provide quick access to many commands and features.
There are five toolbars: Main, Drawing, Animation, Input, and Properties.
Status Bar displays information about a command, operation, or insertion point.
Online Substitution displays the current signal name aliases while connected to
a device (refer to the section, Signal Name Substitutions).
View Signal Summary displays a list of signals in use in the Graphics Window,
allowing quick changes.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-5


Draw Menu
The Draw menu allows you to draw with the following:

Select selects an object(s). Click the object or press and hold the mouse button to
draw a box around the desired object(s). Multiple objects can also be selected by
Or click . pressing the Ctrl key while clicking on the objects. Then use one of the commands
listed below to create objects and backgrounds for the graphic interface.
Or click . Line creates a single line.

Or click . Rectangle creates a box-shaped object.

Or click . Circle creates a round object.

Or click . Ellipse creates an oval object.

Or click . Polygon creates a closed object with three or more sides.

Or click . Polyline creates an open object with three or more sides.

Or click . Text creates numbers, letters, and symbols.

Or click . Insert Object creates ActiveX controls.

Insert Picture inserts a Windows metafile (.wmf) into the currently selected
Or click . rectangle object.
Device allows you to select the device for this graphic file (refer to the section,
Select Device).
Online connects the Graphics Window to the device over the network.

8-6 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Animation Menu
The Animation menu commands allow you to use graphics objects to display signal
information.

Or click . Numeric displays the value of a signal in numerical form.

Or click . Bar Graph displays the value of a signal in bar graph form.

Or click . Trend displays the recent records of up to eight signals on a trend graph.

Or click . Text displays text strings based on the value of the source signal.

Or click . Color changes the color of the attached object based on the value of the source
signal.
Or click .
Property changes any property of the attached object based on the value of the
source signal.

Input Menu
The Input menu commands allow you to use graphics objects to change data online.

Or click . Numeric enters numerical data into a signal.

Or click . Setpoint sets a signal to an assigned value.

Or click . Initial Value makes the current signal value the initial signal value for all the
signals specified.
Or click .
Text selects a text string to define the value sent to the signal.
Or click .
Toggle inverts a signal from 0 to 1 or 1 to 0 (toggles state True/False).
Or click .
Event sets a signal as a result of an ActiveX Control event.
Or click .
Hyperlink... opens other applications, toolbox files, or help files.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-7


Settings Menu
The Settings menu allows you to set the following options to draw objects and
backgrounds.

Frame Size and Options allows you to set the height, width, background color,
and background image of the current screen. No objects can be drawn outside the
frame. Additional options include drawing a alignment grid, snapping objects to the
alignment grid, and suppressing undefined signal warnings when going online.
Or click . Pen Color sets the current pen color. This color is used for drawing the lines in all
objects. This includes the outside border around rectangles, circles, ellipses,
polygons, polylines, and text.
Or click . Pen Width sets the current width of all lines drawn (all objects except text).

Or click . Brush Color sets the current brush color and fills all objects used with the brush
command (also the background color for text).
Or click . Use Brush is a toggle command used to fill rectangles, circles, ellipses, and
polygons with the color selected in Brush Color.
Or click . Text Font selects the current font to use when drawing text.
Select Controls allows you to select which ActiveX objects can be inserted into
the Graphics Window with the Insert Object drawing tool.

Drag-and-Drop Data
The toolbox work area includes The drag-and-drop feature allows you to perform operations in the Graphics
the Outline and Summary Window by dragging objects on the screen with the mouse. For example, you can
Views. drag-and-drop a signal or pin from the toolbox work area to a Graphics Window.
Both the device and Graphics Window must be open.
To drag-and-drop a signal or pin to the Graphics Window
1. From the Graphics Window, select (highlight) an object with animation
attached, such as a rectangle.
2. From the Outline or Summary View, click a signal or pin and drag (hold the
mouse button down) it on top of the rectangle in the Graphics Window and drop
(release the mouse button).
Or, create a new numeric animation automatically by dragging the signal or pin onto
an empty space in the Graphics Window.
These objects can be moved, In the Graphics Window, the name of the signal or pin displays as a text object, and
sized, and modified. the value defaults to numeric animation, which displays the signal/pin data.
Properties Toolbar
Use the Properties toolbar to When you select an object, the properties toolbar is filled with named attributes of
quickly modify any drawing that object. This allows quick changes to drawing objects and inserted ActiveX
object. Controls. The following properties are common to all controls:

8-8 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Name allows you to identify an object for Event Inputs.
Height, Top, Width, and Left allow you to set the position and size of the
selected object.
Line Width allows you to set line attributes.
Pen Color and Brush Color allow you to change the drawing colors.
Double-click these properties to bring up a Select Color dialog box.
There are other properties specific to particular drawing objects and ActiveX
controls. When you double-click properties such as font, color, and picture, custom
dialogs display. If you double-click a true or false value, it toggles the value.

View Signal Summary


The View Signal Summary option within the View menu allows you to make
quick changes to signal names used in the Graphics Window. For example, if a
signal name is changed in a device, the Signal Summary can be used to change the
signal names in the Graphics Window in one operation, rather than changing each
object individually.
Select a signal, then
click on it once to
change it. If you
double-click on a
signal, the object to
which it is attached is
selected with the
Select tool.
The Object Type
provides a quick
description of the
drawing, animation,
or input that the
signal is attached to.

Type the full or partial


name of the signal that
you want to replace.

Type the full or partial


name of the new
signal and then click
Replace to change all
instances of the
signal.
Click the Export List button to save
the signal summary to a text file.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-9


Settings
The Settings menu contains commands that control the way an object is drawn.
Before an object is created with the Draw command, these settings must be defined
as shown in the following sections.

Frame Size and Options


Frame size allows you to set the Width and Height values to determine the size of
the Graphics Window. No objects can be created outside the frame.
To set the frame size
From the Settings menu, select Frame Size and Options. The Frame Size
and Options dialog box displays.

Check Show Grid to show


an alignment grid on the
Graphics Window in Edit
mode. Enter the Width and Height
values. The integers must
Check Snap to Grid to be between 30 and 10000.
force objects to positions
along the alignment grid. Click OK to accept the
changes.
Check Show Undefined Click Cancel to ignore
Signals Warning to be the changes.
notified of missing signals
in the attached device.

Click Change (upper button) to open a standard Color


dialog and select the screen's Background Color.

Click Change (lower button) to open a standard Insert


Picture dialog and select the screen's background .wmf or
.emf.

Pen Color and Pen Width


Pen Color sets the current pen color for drawing the lines in all objects. This
includes the color of the outside border around rectangles, circles, ellipses, polygons,
polylines, and the color of text. Pen Width sets the current width of all lines drawn
(all objects except text). These settings can be edited for each new object to provide
a variety of graphics.
To select a pen color

Or click . 1. From the Settings menu, select Pen Color. The Color palette box displays.
2. Click the desired color and click OK.
Or, create a custom color by clicking one of the custom color squares, and click
Define Custom Colors >>.

8-10 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


To select a pen width

Or click . From the Settings menu, select Pen Width. The Pen Width dialog box
displays.

Enter an integer
between 1 and 10.
Click OK.

The object(s) is drawn


in this width until it is edited.

Brush Color and Use Brush


Use Brush can be toggled on Brush Color sets the current fill color for objects drawn when Use Brush is
selected. Objects that can be filled include rectangles, circles, ellipses, polygons, and
and off by clicking .. text background. The color can be the same as the Pen Color command or a new
color.

Note If the Brush Color (fill) and Pen Color are the same when text is added,
only the background will display. The text blends into the background.

To select a brush color

Or click . 1. From the Settings menu, select Brush Color. The Color palette box
displays.
2. Click the desired color.
Or, create a custom color by clicking on one of the custom color squares, and click
Define Custom Colors >>.
To fill an object with color
A check mark ( Use Brush) 1. From the Settings menu, select Use Brush.
displays beside the command
2. From the Draw menu, select the desired object. The object will be filled with
when it is active.
the color selected in Brush Color.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-11


Text Font
Text Font allows you to select the font and size for all the text in the Graphics
Window. The text can be entered with or without a separate background color. The
area of the text background is determined by the font size.
To select a font

Or click . From the Settings menu, select Text Font. The Font dialog box displays.

Select a Font, a
Font style, and a
Size.

Your selected
font displays in
the Sample text
box.

Click OK.
The text displays
in the Graphics
Window. It can be
selected and
moved, or edited.

Note To add a text background color, refer to the section, Brush Color and Use
Brush. Use Brush must be checked to show a background color.

8-12 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Select Controls
The Add ActiveX Controls to Graphics Window dialog box allows you to
select the third-party ActiveX controls to use in the current Graphics Window.
ActiveX controls are generic objects that can be used in many different applications.
They can provide new and improved functionality to any existing software program
that supports them. Many ActiveX controls are available from third party software
companies.
Because ActiveX controls are provided by a third party, they may not always work
properly. Graphics Windows support a wide variety of ActiveX controls, but not all
controls work well in Toolbox. In addition, there is no guarantee that a particular
ActiveX control is installed on all computers using a Graphics Window. Providing
these controls to end users is the responsibility of the Graphics Window user, and is
beyond the scope of this document.

Note ActiveX controls are frequently designed for a particular container. Such
controls may not work in Graphics Windows as expected, and may even cause the
toolbox to fail. The recommended use of ActiveX Graphics Window screens is for
custom functionality, such as alarm windows.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-13


To add an ActiveX Control to Graphics Window
From the Settings menu, select Select Controls. The Add ActiveX
Controls to Graphics Window dialog box displays.

Select the appropriate


controls. If an item is
checked, selecting it will
uncheck it. Checked controls
are available in the Insert
Object dialog. If you do not
have a design time license
for a particular control, you
will not be able to use that
control. A control must be
installed on your computer
for it to appear in the list. Be
sure to only use controls that
have been tested and will
also be installed on client
computers.

Click OK to update the


available controls for the
current Graphics Window.
By default, no controls are
checked.

Note When a new Graphics Window is created, only the controls distributed with
toolbox are checked by default.

8-14 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Draw Commands
All pictorial objects created with the Draw commandsare made up of individual
lines, filled objects, or text. The objects are defined by straight and curved lines,
which are, in turn, defined by a set of points.
To create an object
1. From the Draw menu, select a command.
2. In the Graphics Window, click where you want to anchor the object.
3. Click and hold the left-mouse button. Drag the mouse to draw the line or shape.
Release the mouse button to end. Refer to the following table.
Refer to the section, Using Shapes such as rectangles and ellipses are drawn with the setting selected in Pen
Graphics Window Objects. Color and filled with the settings selected in Brush Color. Text is created using
the currently selected font, color, and brush.
Draw Commands

From the
Draw menu, Then,
select. . . Or click. . . click and hold the left-mouse button,
Line Drag to the desired line length and release the button. The line is drawn in the
current pen color and pen width.
Rectangle Move the mouse to the opposite corner of the rectangle and release the
button. The rectangle is drawn with the current pen color and pen width and
filled with the brush color*.
Circle At the center of the circle, drag the mouse to the outside radius, and release
the button. The circle is drawn with the current pen color and pen width and
filled with the brush color*.
Ellipse At the center of the ellipse, drag the mouse to the outside X and Y radius, and
release the button. The ellipse is drawn with the current pen color and pen
width and filled with the brush color*.
Polygon At the first vertex, release the mouse, and move to the next vertex and click
the button. Move the mouse to each of the other vertexes and click the button.
When the last vertex is drawn, click the right-mouse button. A line will be
drawn between the last vertex and the first vertex. The polygon is drawn with
the current pen color and pen width and filled with the brush color*.
Polyline At the first vertex, release the mouse and move to the next vertex and click the
button. Move the mouse to each of the other vertexes and click the button.
When the last vertex is drawn, click the right-mouse button. A polyline cannot
be filled with the brush color because it is not a closed object.
Text At the text location, release the mouse and enter text. Press Enter or click the
left-mouse button to end. The text is drawn using the current font and color.
The brush color will be used for the background (if selected).

Insert Object Use this tool in the same manner as the Rectangle tool. The ActiveX Control
will be inserted into the rectangular area you select. When you release the left-
mouse button, the Insert ActiveX Control dialog will appear to let you select
which object to insert.

* The Use Brush command must be selected to fill an object with the color selected
in the command Brush Color.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-15


Handles Objects can be moved, resized, and the settings edited using the Select command.
When an object is selected, handles appear around the edges to drag-and-resize or
drag-and-drop to move the entire object.
To edit an object
From the Draw menu, select Select.
Click the object or draw a box around the object. Handles appear around the edges
Or click . of the object to highlight it.
The blue dashed line indicates that the object was the last one selected. This is the
object that the alignment tools will use to match sizes and edge alignment.

Once the object is highlighted, it can be edited several ways:


Select a new setting, such as Pen Color or Text Font.
Click a handle and hold the mouse button to drag and resize the object.
Click the middle of an object and hold down the mouse button to drag-and-drop
and move the entire object.

Note Refer to the next step to move ActiveX controls.

To group multiple objects

Or select multiple objects by 1. Click to select the draw tool and draw a box around all desired objects. The
pressing the Ctrl key while box must include all portions of all objects. All selected objects have handles.
clicking on the objects.
2. Click . A group outline box appears around the entire group.
3. Once the object has been grouped, it can be moved and resized just like any
other drawing object. Click the Group button again to ungroup the object.

8-16 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Insert Object
The Insert Object command allows you to insert ActiveX controls into a Graphics
Window.
To insert an ActiveX Control
1. From the Draw menu, select Insert Object.
2. Draw a rectangle for the control. The rectangle serves as a frame for the control.
Control options will vary
The Insert ActiveX Control dialog box displays.
depending upon the controls
selected.

Select the desired


control.

Click OK.

Note The controls must be selected in the Select ActiveX Controls dialog.

Insert Picture
The Insert Picture command allows you to insert a custom graphic created in
Visio Technical. Use the following guidelines:
All drawings must be created using Visio Technical (Version 4.1 minimum).
Drawings must not include Visio text fields at the top of the drawing. The
Graphics Window inserts these text fields incorrectly.
Save the drawing as a Windows metafile (.wmf).
The .wmf must be inserted into a rectangle created in the Graphics Window.

Note Windows metafile images from other sources may not work.

To insert a picture
1. Draw a rectangle using the Graphics Window drawing tools. The rectangle
serves as a frame for the picture.
2. Click the rectangle to select it.

Or click . 3. From the Draw menu, select Insert Picture. The Insert Picture dialog box
displays.

Enter the full path of the .wmf


or click Browse... to enter the
path.

Click OK. The picture displays


inside the rectangle.
Resize the picture, if desired,
by clicking and dragging one of
the rectangle handles.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-17


Animate Objects
Animated objects display signal information. The following types of animation can
be assigned to an object:
Numeric animation displays the live value of a signal in numerical form.
Bar Graph animation displays the live value of a signal in a bar graph.
Trend animation displays the recent records of up to eight signals on a trend
graph.
Text animation displays different text strings, depending on the value of the
source signal.
Color animation changes the color of the object, depending on the value of the
source signal.
Property animation changes any named aspect of an object, such as Height or
Caption. This is particularly useful when applied to inserted ActiveX controls.
In addition, more than one property can be animated at a time.
To animate an object
1. Select the object.
2. From the Animation menu, select the type of animation for that object (as
described above). The animation dialog box for that type of animation displays.

3. Click Value Return and select a Return (value) for this object to
display a value of a signal (refer to the next section, Value and Enable Return).

4. Click Enable Return and select a Return (value) for this object
to enable and disable the object based on a value (refer to the next section, Value
and Enable Return).
5. Configure each object as directed by the field definition of the dialog box.

Value and Enable Return


Refer to the section, Use Value Return is used to obtain signal values for the animation. Enable Return is
Graphics Window Objects. used to obtain signal values that turn the objects on and off. From an animation
dialog box, click or . The following dialog box displays
with six different returns (described in the following sections). Each animation must
select a Return.

8-18 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Signal
The Signal Return produces a value from a signal selected from the Signal
Selector dialog box. This is the most important return in the device.

Check to attach the


input field to the object.
Uncheck to detach the
signal.

Enter the name of the


signal value to obtain.
Click Browse to find a
signal if a device is
already selected.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-19


Math
The Math Return performs a mathematical function on other returns and fixed
values. It can also be used to generate a fixed value for other returns.

Check to attach the input


field to the object. Otherwise
the input field will not exist.

This formula generates the


produced value for this
return. It can contain any of
the following math functions:
add(+), subtract (-), multiply
(*), divide (/) or (|), and (&),
logical or (||), logical and
(&&), absolute value (abs),
and square root (sqrt). A
number preceded by a pound
sign (#), refers to the value of
one of the eight Value
Returns.

Returns #1 - #8 are used in


the above formula. These
can be any of the returns,
including other Math returns.

Compare
The Compare Return produces a value related to the first comparison that is True.
This is most useful in the text and color animation.

Check to attach the input field


to the object. Otherwise the
input field will not exist.

Default value is returned


if none of the following
comparisons are true.

Type can be Off, Equal, Not


Equal, or Greater Than.
Compare groups are
evaluated starting with
Group1 through Group 4.
The value for the first one that
is True is returned. If the drop
down box is set to Off, then
that comparison is not used.
Otherwise the top Return
value is compared to the
bottom Return value using the
selected compare type. To
compare a signal value to a
fixed value, use the math
return with the formula being
just the fixed number.

8-20 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Maximum
The Maximum Return produces the maximum value of the Returns that are attached
to it.

Check to attach the


input field to the object.
Otherwise the input field
will not exist.

Return is used to
produce a value to this
Maximum Return.

Minimum
The Minimum Return produces the minimum value of the Returns that are attached
to it.

Check to attach the


input field to the object.
Otherwise the input field
will not exist.

Return is used to
produce a value to this
Minimum Return.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-21


Average
The Average Return produces the average value of the Returns attached to it.

Check to attach the


input field to the object.
Otherwise the input field
will not exist.

Return is used to
produce a value to this
Average Return.

Numeric Animation
Numeric animation displays the live value of a signal. It must be attached to a text
object.

Click to attach and detach animation to the


object. A checked box contains animation.
Note: If you detach (uncheck) this option
and click OK, the animation is deleted
unless you previously saved the .grw file.
Value Return allows you to enter the value
for the animation.

Enable Return uses the value of a supplied


signal to enable the animation.
0 = disable

Rate defines how fast the signal data is


collected for the animation.

Define the text colors for the corresponding


alarm limits.
Off does not use the alarm limit.
On uses the value text box as the alarm limit.
Auto uses the alarm limit defined in the
scale data for the signal. The number is
normally displayed in the standard colors
unless an alarm limit is exceeded.

Note Brush colors (fill) only apply if the object is drawn with the Use Brush
setting active or if the Use Brush setting is active when the object is selected.

8-22 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Bar Graph
Refer to the section, Use Bar graph animation displays the live value of a signal in a bar graph. It must be
Graphics Window Objects. attached to a rectangle object.

Click to attach and detach animation to the


object. A checked box contains animation.
Note: If you detach (unchecked)
this option and click OK, the Value Return allows you to enter
animation is deleted unless the value for the animation.
you previously saved Specify the direction of the bar
the .grw file. Enable Return uses the value of from the low limit to the high limit.
a supplied signal to enable the Specify how the bar is drawn.
animation. 0 = disable Unidirectional starts the bar at the low
value and draws toward the high value.
Bidirectional starts the bar at the center
value and draws toward either the high or
low value.

Specify the signal values that correspond


to the ends (and possibly the center) of
the bar graph. Auto uses the values from
the scale data for the signal. Left/Top or
Right/Bottom displays the limit values
next to the bar graph. If the bar graph
flows up/down, the limits are displayed on
the left side or right side of the bar graph.
If the bar graph flows left/right, the limits
are displayed on the top or bottom of the
bar graph.

The values are drawn in the color


indicated in this Color box.

Define the text colors for the


corresponding alarm limits.
Off does not use the alarm limit.
On uses the value text box as
the alarm limit.
Auto uses the alarm limit defined
in the scale data for the signal.
The number is normally displayed
Rate defines how fast Select the color for the in the standard colors unless an
the signal data is background of the bar alarm limit is exceeded.
collected. graph.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-23


Trend
Trend animation displays the recent records of up to eight signals on a trend graph. It
must be attached to a rectangle object.

Click to attach and detach animation to the


object. A checked box contains animation.
Note: If you detach (uncheck) this option Pixels per Sample uses the number of pixels in the
and click OK, the animation is deleted text box for each data sample. When the number is
unless you previously saved the .grw file. increased, the graph widens and less time is covered.
Samples per Pixel uses the number of data samples
Define how fast the signal in the box for each pixel on the graph. When the
Displays the total amount data is collected for the number is increased, the graph becomes narrower
of time covered by the animation. and more time is covered.
Trend graph using the
size of the graph, Rate,
and Pixels per Sample -
Samples per Pixel.
Set the number of grid
Samples after Disable lines drawn in the
controls how many horizontal and vertical
samples are collected after direction. One grid line
the Enable signal goes is always drawn in the
False. A zero means the center on the graph
trend will stop immediately. (always given an odd
Time displays the amount number of horizontal
of time corresponding to grid lines). Enter the
the Samples after Disable. color to draw the grid
lines.
Select the the Background
Color of the trend graph. Select the graph line
Set the Direction the to assign and view
rectangle is drawn from. signal information and
(If Left is selected, the line attributes.
trend starts at the left of
the rectangle and drawn
toward to the right.) Define the text colors
for the corresponding
Enable Return uses the alarm limits.
value of a supplied signal Off does not use
to enable the animation. the alarm limit.
0 = disable. On uses the value text
Set the Block Size (size box as the alarm limit.
of the block to display). Auto uses the alarm
Define the Enable and limit defined in the
Disable colors that display scale data for the
in the top corner of the signal. The number is
trend as a block. normally displayed in
the standard colors
Enter the value used by unless an alarm limit
Specify the signal values that correspond to
this signal on the trend. is exceeded.
the top (High Limit) and bottom (Low Limit)
of the trend graph.
If Auto is checked, the values from the scale
data for the signal is used.
If L (left) or R (right) is checked, the limit values are
displayed next to the trend on the side selected. The
limit values are drawn in the color in the Color box.

8-24 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Text
Text animation displays different text strings depending on the value of the source
signal. It must be attached to a text object.

Click to attach and detach animation to the object. A checked box contains animation.
Note: If you detach (uncheck) this option and click OK, the animation is deleted unless
you previously saved the .grw file.

Value Return allows


you to enter the value
for the animation.

Enable Return uses the


value of a supplied signal
to enable the animation.
0 = disable

Rate defines how fast the


signal data is collected
for the animation.

Define the Text Strings


for each Value Return
and the text colors. The
default string displays if
the Value Return does
not match any of the
value entries that are
turned on. There are
entries for values 0 to 63.
Click Next and Previous
to scroll through all the
possible values.

Note Brush (fill) colors only apply if the object is drawn with the Use Brush
setting active or if the Use Brush setting is active when the object is selected.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-25


Color
Color animation changes the color of the object, depending on the value of the
source signal. It can be attached to any type of object.

Click to attach and detach animation to the object. A checked box contains animation.
Note: If you detach (uncheck) this option and click OK, the animation is deleted unless
you previously saved the .grw file.

Value Return allows


you to enter the value
for the animation.

Enable Return uses the


value of a supplied signal
to enable the animation.
0 = disable

Rate defines how fast the


signal data is collected
for the animation.

Define the Colors of


the base object for each
Value Return. Default
displays the base object
if the Value Returns
value does not match
any of the value entries
that are turned on. There
are entries for values
0 to 63. Click Next and
Previous to scroll
through all the possible
values.

Note Brush colors (fill) only apply if the object is drawn with the Use Brush setting
active or if the Use Brush setting is active when the object is selected.

8-26 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Property
Property animation changes any named property of any type of object, depending on
the value of the source signal.

Click to attach and detach animation to the object. A checked box contains animation.
Note: If you detach (uncheck) this option and click OK, the animation is deleted
unless you previously saved the .grw file.

Rate defines how fast the


signal data is collected for
the animation.

All properties that are


animated are listed here,
along with a description of
the value return block.
Click Add to insert a new
property to be animated.
The Property Animation
(Numeric) dialog box
displays (see figure below).
Click Remove to delete a
property from the list.
Double-click a listed
property to edit the
animation.

Property selects which aspect


of the selected object is to be
animated.

Value Return allows you


to enter the value for the
animation.
Enable Return uses the
value of a supplied signal
to enable the animation.

Click OK to add the property to


the list of animated properties
for the selected object.
Click Cancel to discard the animation.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-27


Input Fields
Refer to the section, Use Input fields allow you to change signal values in a device. When online, a Graphics
Graphics Window Objects. Window object can assign values to a signal in the device by using an input field
described in this section.
To configure an input field
1. Select the object.

Tip To select an object, click or select Select from the Draw menu.

Or click the associated Input 2. From the Input menu, select an input to assign to the object.
button located on the Input
Toolbar.
To edit an input value
Double-click the input object. The assigned input dialog box displays to edit.

Numeric
The Numeric input field enters numerical data into a signal in the controller from the
object selected in the Graphics Window.

Check to attach the input field


to the object. Uncheck to detach the signal.

Enter the name of the


signal value to obtain.
Click Browse to find a
signal if a device is
already selected.

Enter the value to use


when live data mode
dialog box increment or
decrement button is
active.

High Limit and Low Limit are used to set the maximum and minimum
value that is sent by this input field.
Off does no limit check.
On uses the values entered into high limit and low limit.
Auto uses the values from the scale data for signal.

8-28 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Enter Value
The Enter Value dialog box displays when the Graphics Window is online and a
numeric input is selected.

Enter a new value for the signal.


Click Send to send this value.

Increment adds this value to the


value in the Input Numeric
dialog box.
Decrement: subtracts this value
from the value in the Input
Numeric dialog box.

Setpoint
The Setpoint input field sets a signal in the device to the assigned value of the object
selected in the Graphic Window.

Check to attach the input field to the object.


Uncheck to detach the signal.

Enter the name of the signal value to obtain.


Click Browse to find a signal if a device is
already selected.

Enter the value that is sent to the signal when


this input field is selected. Check Confirm
before send to display the Send Setpoint
dialog box to confirm that the Graphics
Window is sending a setpoint to the device.

Initial Value
The Initial Value input field makes the current signal value the initial value for all
the signals specified.

Check to attach the input


field to the object. Uncheck
to detach the signal.

A list of all the signals whose


initial values are set when
this input field is selected
displays. Check Confirm
before send to display a
dialog box to verify that you
really want to send this value.

Click the Add, Browse,


and Delete buttons to
edit the signal list.

Click OK to send or click


Cancel to exit.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-29


Text
The Text input field allows you to create and then select a text string to define the
value sent to the signal in the controller.
Check to attach the input field to
the object. Uncheck to detach the
signal.
Enter a signal (the value is set to
this field). Click Browse to find a
signal if a device is ready.
A list of all the text strings in the
Select Text Value dialog box
displays. The strings are in
double quotes, followed by a
dash and the value sent to the
signal ("Stop" = 0).
They are displayed in the same
order as in this list box.

Edit the list box using the


following buttons:
Up moves the selected entry up
by one.
Down moves the selected entry
down by one.
Add allows you to add a new
string and value to the end of the
list.
Delete removes the selected The Select Text dialog
entry. box displays when the
Modify allows you to change the Graphics Window is
selected entry. online and a text input
object is selected. Select
the appropriate text
string.
Click OK to send the
corresponding value to
the signal in the device.
Click Cancel to exit the
dialog box.

Toggle Command
The Toggle command performs a Boolean inversion, converting the signal from
True to False or False to True.

Check to attach the input field


to the object. Uncheck to
detach the signal.

Enter the desired signal


name.

Check Confirm before send


to display a dialog box to
verify that you really want to
send this value.
Click OK to toggle or
Cancel to exit.

8-30 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Event Input
Event Inputs can only be attached to ActiveX controls created by the Insert Object
drawing tool. ActiveX controls have a list of events corresponding to user actions,
such as Click or Change. The Event Input allows signals to be changed when these
events occur.

Check to attach the event


input to the object.
Uncheck to delete the
inputs.
Click on the name to
select an event from the list.

Then click Attach to


connect a signal to it or
modify an existing attached
signal. The Event Handler
dialog box displays (see
figure below).

Click Remove to delete a


signal attachment.

Name of the event.

Name of the object.


If unnamed, type of object.

Enter the desired signal name.

Select Send Property to send


a property value from an object
to the signal.

Select the property to send.

Select which object properties


to send. The Selected Object
is the default, but any named
object can be used (see
procedure below).

The Event Handler can send any property from any named object. An object is
Named if its Name property has been set.
To name an object
1. Select an object in the Graphics Window.
2. Make sure that the Property Toolbar is visible. If it is not visible, from the View
menu, select Toolbars, and Properties.
3. In the Properties toolbar, for the Name, click in the edit field (in the Values
column). Type a name of up to 32 characters.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-31


Hyperlinks
The Hyperlink command allows you to link to a variety of file types to objects in
the Graphics Window.

Note Hyperlinks cannot be used in conjunction with Animations.

To create a hyperlink
1. Select an object.
Click , then select Select
from the Draw menu. 2. From the Input menu, select Hyperlink. The HyperLink dialog box displays.
Or click .
Launches Program creates a hyperlink that runs a file type external to
toolbox, such as spreadsheets and drawings. It also allows hyperlinks to
execute DOS command lines, including processing switch parameters.

Open Toolbox File creates a hyperlink that opens only toolbox file types,
such as Trend Recorders (.trd) and Graphics Windows (.grw).

Open Help File creates a hyperlink that runs the Windows Help engine
and opens the help file.

Check to attach the hyperlink to the Automatically close source Graphics Window causes the current
object and uncheck to detach. screen to close before executing the hyperlink.

Enter the Command Line


(Launched Program), Filename
(Toolbox), or Help File (Help) to
execute an application or to open
a file. Substitution characters are
also supported in this field to
replace any part or all of a path,
such as c:\%2\ work.xls. These
characters must be defined in a
controller, the Graphics Window
default Substitution list, or the
Hyperlink Substitution list.

Help Section ID jumps to a


particular section of the Help
file specified in the path.
Click to display the Edit Hyperlink Substitutions Display as PopUp displays the Help
dialog box and enter signal substitutions specific to file in a small pop-up window. If this
this hyperlink. These signals substitutions function box is not checked (default), the Help
as the controller substitutions, except that the file displays as a main window.
hyperlink always inherits the online memory buffer
of its parent Graphics Window, then overwrites any
corresponding signals (refer to Signal Substitution).

Tip If Launches Program is selected, you can enter a document file registered in
Windows. The associated application that opens the file will then run.
When entering the Command Line, you must place the switches and/or parameters in
double quotes to be recognized by DOS. (c:\acdcex.exe "/s /p /w /c:\directory")

8-32 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Use Graphics Window Objects
The following section shows how to construct basic Graphics Window objects and
add animation or input values. The following examples are created:
Signal's numeric value
Signal trend
Signal bar graph
Object's numeric value

Display a Signals Numeric Value


To display a signals numeric value
1. From the Draw menu, select Text.
Enter text here . 2. Click the drawing area where the numeric value will display. A character-sized
box with a cursor displays.
3. Type the text that will display in the Graphics Window while offline.
Or click . 4. From the Draw menu, select Select.
Select object. 5. Click the text that was entered. A dotted line surrounds the text object.
6. From the Animation menu, select Numeric. The Numeric Animation
Or click Numeric dialog box displays.
Animation from the Animation
Toolbar.

7. Click Value Return to obtain a signal value for the animation. The Select
Return dialog box displays.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-33


8. Click Signal to produce a value from a signal in the current device. Click OK.
The Signal dialog box displays.

9. Enter the signal name or click Browse for signals in the current device.
10. Click OK to complete the signal, and click OK to complete the animation.
11. Place the device online to view the live values.
Click to go online.

Create a Signal Trend


To create a signal trend

Or click . 1. From the Draw menu, select Rectangle.


2. Draw a rectangle. (Click the drawing area where one corner of the trend will
display. Press and hold the mouse button and drag the cursor to the opposite
corner of the trend. Release the mouse button to complete the rectangle.)
Or click . 3. From the Draw menu, select Select.
4. Click the rectangle that was drawn. Handles display on the corners and the
middle of the rectangle to indicate that the rectangle was selected.
Or click . 5. From the Animation menu, select Trend. The Trend Animation dialog box
displays.

8-34 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


6. Click Value Return to obtain a signal value for the animation. The Select
Return dialog box displays.
7. Click Signal to produce a value from a signal in the current device.
8. Click OK to complete the signal.
9. Verify the high and low limits for the value. If necessary, change these limits.
10. To assign additional signals, click one of the option buttons next to
Information for Signal.
11. Click OK to complete the trend.
12. Place the device online to view the live values on the trend graph.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-35


Create a Signal Bar Graph
To create a signal bar graph
1. Draw a rectangle by performing steps 1 through 5 as described for the previous
signal trend.
2. From the Animation menu, select Bar Graph. The Bar Graph dialog box
displays.

3. Verify the high and low limits for the value. If necessary, change these limits.
4. Verify the direction. If necessary, change these settings.
5. Change the standard Alarm Colors to be different from the background color.
6. Place the device online to see the live values on the bar graph.

8-36 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Create an Object to Input a Numeric Value
To create an object to input a numeric value
1. Draw a rectangle performing steps 1 through 5 as described in the previous
sections for a signal trend and bar graph.
Or click Input Numeric 2. From the Input menu, select Numeric. The Input Numeric dialog box
from the Input Toolbar. displays.

3. Enter the signal name to be modified and click OK.


4. From the Draw menu, select Online.
5. Modify the value online by clicking on the object when the cursor shape
changes to a hand shape. The Enter Value dialog box displays.

6. Modify the value and click Send to leave the dialog box active, or click OK to
close the dialog box.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-37


Signal Substitution
Signal Substitutions can only be When configuring animation or input return strings, a signal substitution can be
edited while offline. used instead of the full signal name or value. Then, when going online to a
controller, the substitution character(s) are replaced with the signal name. The
substitution characters are %N, where N is an integer between 0 and 9 or ^ . The
Graphics Window can have a total of 11 characters.
To create signal substitutions
1. From the Edit menu, select Signal Substitutions. The Signal
Substitutions dialog box displays.

2. Enter the desired value or signal name into each substitution field. Click OK.
When configuring animation or input return strings, enter the substitution
character(s) for the desired signal. When the controller goes online, the substitution
character(s) are replaced with the value(s) or signal name(s) entered in the dialog box
above.

Note Any number of characters (defined above) can be used in the Return
Value/Signal dialog box to form the signal name.

8-38 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Forced Signals
Graphics Window does not display forced signals any differently than non-forced
signals. Additionally, Graphics Window has no concept of I/O Points, so it cannot
directly change or display the forced status of a point. However, pressing the Ctrl
key while clicking an Input online will bring up a summary dialog of the signal
attached to the input, including the I/O points it is connected to.

Double-click the live value to modify a live signal or point. For Boolean signals and
all points, this dialog box includes a checkbox to force the signal.

GEH-6414D Toolbox for an EX2100 Chapter 8 Graphics Window 8-39


String Substitutions
The Graphics Window supports string substitution module pins as supported by the
controller. The substitutions specified by these pins have a higher priority than those
defined in the Graphics Window. When a modules Detached Summary View
displays, the substitution signals defined in the Graphics Window (known as
defaults) are loaded into an online memory buffer called Online Substitutions.
Then, the substitutions specified by module pins overwrite their corresponding
default values in that buffer.
For example, a Graphics Window has defined default signal substitutions at
characters %1, %3, and %5. A module in a controller has defined two substitution
pins, SUB1 and SUB7, which reference specific signals. When you select a
The purpose of Online modules Detached Summary View from the toolbox, the default signals load
Substitutions is to serve as a into Online Substitutions. Next, the substitution of module SUB1 overwrites the
clipboard for signals that are online substitution %1, while the substitution of SUB7 overwrites the empty online
used by the Graphics Window substitution %7. It is important to remember that only the online substitution is
while connected to a controller. overwritten, not the default signals saved with the Graphics Window. The defaults
are permanent unless otherwise modified.
To view signal substitutions
From the toolbox, while in the Graphics Window, select the View menu and
Online Substitutions.

Note This is the same dialog box used to enter substitutions, except it cannot be
edited (refer to the previous section, Signal Substitutions).

8-40 Chapter 8 Graphics Window GEH-6414D Toolbox for an EX2100


Chapter 9 Hardware and I/O

Introduction
This chapter defines the device networks and I/O used in the toolbox. It includes
configuring a network interface, and signal and I/O connections used in blockware.

Section Page
I/O and Network Interface........................................................................................9-1
Dual Port Memory Interface.....................................................................................9-5
EGD Interface...........................................................................................................9-6
Main Board.............................................................................................................9-12
Register Network....................................................................................................9-16

I/O and Network Interface


The configuration can be divided into two sections: blockware and I/O. I/O items,
also known as hardware modules, can be found in the Outline View under the item,
Hardware and I/O Definitions. These items define the I/O or network interfaces and
connect I/O with signals to be used in blockware. Also, many items monitor the live
data of specific I/O points and their associated signals, so you can see the transfer
from I/O to the signal or from the signal to I/O occur. All hardware modules are
composed of points. Sometimes, between the points and network interface level there
is a further division of points into pages or blocks.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-1


I/O Points
Points are the inputs and outputs must be associated with signals to be accessed in
blockware. This point-signal association is very important for proper function.
I/O points also represent a buffer separate from the signals used by blockware. This
memory is modified directly by drivers that handle the various interfaces as well as
by blockware. Blockware reads and writes these I/O points through I/O transfers,
which transfer data from the input points to their signals at the beginning of the
execution of tasks that use those signals. Transfers of data from signals to their
associated output points occur at the end of the execution of tasks that use those
signals, as shown below. For any signal connected to an I/O point, the direction of
point determines whether it is considered an input or an output.

Note A point can never be both an input and an output.

Inputs written to
signal space before
a task runs

Network 1 Innovation Series Network 2


I/O Points Controller Signals I/O Points

Outputs written
from signal space
after a task runs

A signal can be connected to more than one point. If one of the points is an input and
one is an output, the device transfers the value of the point from the input to the
output through the signal. This I/O transfer occurs regardless of whether the signal is
used in a task. The runtime process that performs this function periodically in the
background (during idle time) is called the I/O mapper, since it maps inputs to
outputs.

9-2 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Insert I/O and Network Interfaces
I/O and network interfaces are inserted in the Outline View of the toolbox under the
level, Hardware and I/O Definitions.

To insert I/O and network items, the correct platform must be selected from the
device properties.
To edit device properties
1. From the Outline View, double-click the device name. The Device
Properties dialog box displays.
2. Select the Platform from the drop-down list. Click OK.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-3


To insert I/O or network interface
Or click the right-mouse button 1. From the Outline View, click Hardware and I/O Definitions.
and select Insert First.
2. From the Edit menu, select Insert First.
For device properties, right-
The New I/O or Network Interface dialog box displays. The items that
mouse click the device name
display in this dialog box depend upon the product selected in the device
and select Modify.
properties. This example displays items for the VME platform product.
3. Click an I/O or network item and click OK.

9-4 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Dual Port Memory Interface
The Dual Port Memory Interface contains signals that are exchanged between the
ACL_ board and the DSPX board. The signals are either received from the DSPX or
sent to the DSPX from the controller. The signals in the Dual Ported Memory
Interface are defined by the product designers and only the Alarm and Event
attributes can be modified.

To modify the Alarm and Event Attributes


1. Expand the item, Dual Ported Memory Interface,
2. Select the desired mode and double-click to display the Signal Edit dialog box.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-5


EGD Interface
Addresses of the points on the Ethernet Global Data (EGD) is a control network, as well as a protocol for the
exchanges are made known to Innovation Series Device. EGD uses Ethernet as the physical and data-link layer of
other devices through the SDB the network. It can send directed or broadcast messages. Devices share data through
EGD exchanges (pages).

Note Exchange is a CIMPLICITY term that means the same as the term page in
the toolbox. Exchanges provide a way to share live signals (variables) over Ethernet.

To insert the EGD Interface network


1. From the Outline View, click Hardware and I/O Definitions.
2. From the File menu, select Insert First. The New I/O or Network Interface
dialog box displays.
Select EGD Interface and click OK. The network is inserted into the Outline
View as shown below.

The network is assigned a default name (EGD1), number (0) and IP address. To edit
the settings, refer to the next section, Edit EGD.

Edit EGD
The dialog box displays a default name (EGD1), number (0) and IP address.
A default name is assigned when the EGD
is inserted. For the SDB, put the controller
name into the database to make it
available to other controllers (Refer to the
SDB Browser in the View menu).

Number is also found in the database. If


the Value is selected, this number is
assigned when it is put into the database.

ProducerID default s to the IP address/IP


name, or enter a unique IP address/name.
Refer to the IP address in the Device
Properties dialog box (by double-clicking
on the device name).

Enter a note to describe the network with


up to 50 characters. Click OK and the
network displays in the Outline View under
the item Hardware and I/O Definitions.

9-6 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


EGD Exchanges
Exchanges (pages) provide a way to share live signals over EGD. These exchanges
are periodically broadcast by the owner using EGD shared RAM update messages,
known as feedback messages. The exchange broadcasts every 320 milliseconds by
default, but you can set the interval to any value not less than 10 milliseconds. An
exchange can be a maximum of 1400 bytes long and is addressed on byte
boundaries. Boolean points are packed 8 to a byte, and the bit number that describes
which one ranges from 0 to 7. A device can own up to 16 exchanges, although the
limit is five by convention.

Note Once the EGD network is inserted under Hardware and I/O Definitions in the
Outline View, the EGD exchanges must be inserted.

To insert an exchange
1. From the Outline View, click the EGD network name to highlight it.
Or right-click and select Insert 2. From the Edit menu, select Insert First.
First.
The item Exch1 is inserted under the item, EGD network. The default name of the
exchange is Exch# (where # is the number of exchanges owned by this device).

Note Once an exchange exists, another item can be inserted by following the same
steps, but select Insert Next.

These exchanges are sometimes referred to as internal exchanges in the toolbox


device. Exchanges owned by other devices are called external exchanges. Internal
exchanges can be modified using the Internal Exchange Settings dialog box.
To modify an internal exchange
1. Click a exchange to highlight it.
Or double-click the exchange. 2. From the Edit menu, select Modify. The Internal Exchange Settings
dialog box displays (refer to the next section).

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-7


Internal Exchange Settings
The Internal Exchange Settings dialog box is shown below.

Enter a name using up to five


characters.

Enter a number, 1 to 255, or enter 0


for the device to be posted to the SDB
and the next available number is
obtained from the SDB.

Enter the time between EGD feedback


transmissions on the Ethernet in
milliseconds. The default is 320 ms.
Enter a note to describe the exchange
with up to 50 characters.

Enter the dotted IP address of the


device to direct the exchange.
Click Broadcast to send the exchange
to everyone on the network.

% Allocated is the percentage of


exchange memory that is allocated.
% Free is the percentage of exchange
memory remaining.
% Lost is the amount of memory that is
lost by deleting signals in the exchange
and not compressing.
CfigSig - Configuration Signature is the
current version number of the controller.
It notifies users of modifications to the
exchange, which are monitored by other
Click to keep the Click to unlock all signals Click to reclaim all
controllers in the system. The number is
memory location of and allow the memory lost memory.
checked for consistency between the
points with signals on location of points that
exchange being broadcast by the owner
the exchange. have signals to change.
and the users copy.

Whenever a point is deleted from an exchange (in the Outline View), that space is
not reclaimed. All devices referencing that exchange must update from the database.
This loss of memory can be seen in the % Loss field of the Internal Exchange
Settings dialog box. To reclaim this lost space, compress the exchange. The
following Warning displays:

9-8 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


External Exchanges
The external exchange data displays in the Summary View (shown below). This
data includes the signal name, a list of the points on that exchange, data type, health,
and so on. When the device is monitored online, the second column, Value displays
the live data value for the point on that line.

Note External Exchanges cannot be modified. A message box displays stating that
you are not the owner.

EGD external exchanges have two built-in diagnostic mechanisms: exchange healthy
and link presence. The link presence for a device is True whenever messages are
being received from that device. When the exchange healthy for a device is True,
feedback messages are being received from that device. When the health of a
variable (signal) connected exclusively to an EGD point is used in blockware, the
exchange healthy is actually the value used.
When the device gets information from the database, exchange zero is inserted into
the network and is called LINK. This exchange holds a list of signals called link
presence bits, which are set whenever an EGD message is received from a device. If
no messages arrive for a device in 1.28 seconds, the value of the link presence signal
goes to zero. These signals can be used in blockware like any other signal. The form
of the name is NET\DEV\HEALTHY where NET is the name of the network and DEV
is the name of the device.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-9


EGD Points
A point can only be inserted EGD exchanges are made up of points, which are associated with device signals.
into an internal exchange. Each point corresponds to a complete signal, regardless of the length or amount of
memory that the point occupies in the exchange. The name has the form
EGD points are coherent, but
EGD.BYTE.BIT, where BYTE is the 8-bit byte offset into the exchange, and BIT is
EGD exchanges are not.
the bit number, which ranges from 07 (7 is the most significant bit).
To insert and modify a point
1. From the Outline View, click the EGD exchange to highlight it.
Or use the shortcut keys, 2. From the Edit menu, select Insert First. The EGD Point Settings dialog
Shift + Insert. box displays.

Enter the Name of the signal associated with


this point. This name must be provided to
create a point. Browse... allows you to select
the signal using the Signal Selector dialog box.

Select the Data Type from a drop-down list of


data types supported by the EGD. These data
types are different from the basic controller
data types and are listed below.

Click Lock to set the word offset and bit


number. (Also use the Lock All Signals and
Unlock All Signals command in the
Internal Exchange Settings dialog box.

Address is assigned by the toolbox to a point


that is Byte.BIT.

Enter Write for the controller to produce


information or Read to receive

Cimplicity Resource allows you to mark this


particular signal to be moved into the Cimplicity
database using the SDB Utility.

The health address is provided Edit Signal displays the Signal Edit dialog
for signals that need health, such box. The button is only active when the
DLAN+ and Genius. point is being inserted.

Feedback Data Types


BOOL - 1-bit value DWORD - Long (32-bits) integer
WORD - 16-bit integer REAL - 32-bit floating point number
STRING - text (Network Interface only)

Tip EGD points can be created in the Outline View by using drag-and-drop to
insert a signal definition in the exchange item. This point data type is compatible
with the data type of the signal being dropped. The direction is assumed to be a
feedback. Modify the point data type using the Internal EGD Point Settings
dialog box.

9-10 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


EGD Points in the Summary View
The Summary View displays a diagram of the point and its connection to a scale
and signal. Each connection can be edited from the Summary View.
To edit the point, signal, or scale
1. From the Outline View, click the point. A diagram of the point and its
connection to a scale and signal display in the Summary View.
2. From the Summary View, double-click the actual point, signal, or scale. The
appropriate Edit dialog box displays.
When the device is being monitored online, the Summary View displays the live
data value for the point and the signal connected to the point, as shown in the screen
below. Normally these two values should be equal. If they are not, make sure the
task that uses that signal is enabled. At least one task using that signal must be
enabled for an I/O transfer to run and copy the point value into the signal value, or
vice versa.
To modify/force a point or signal value

1. Click to go online.
2. From the Outline View, click the point. A diagram of the point and its
connection to a scale and signal display in the Summary View.
3. From the Summary View, double-click the actual point value or signal value.
The appropriate Edit dialog box displays.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-11


Main Board
The item Main Board currently holds the non-volatile memory.
To insert Main Board
1. From the Outline View, click Hardware and I/O Definitions.
Or click the right mouse button 2. From the Edit menu, select Insert First. The New I/O or Network
and select Insert First. Interface dialog box displays.
3. Click Main Board and click OK.

Select Main Board


and click OK.

The SRTP Interface


Settings dialog box
displays (refer to the
next section).

Non-volatile Random-Access Memory


Non-volatile random-access memory (NOVRAM) is memory that holds its values
even when the device loses power. This is used in the device to save values that
change over time and need to be maintained through a power loss.
Upon starting the device, the initial values specified in Pcode are written to the
signals RAM locations, followed by the values held in NOVRAM. The NOVRAM
values are not transferred into the signals when the NOVRAM major revision
changes (meaning the location of existing signals in NOVRAM changes) or for
points that were just added. Once the device is running, signals that are associated
with the NOVRAM points are written to the battery-backed memory at the end of the
task in which the signals are used. When NOVRAM is added to a device for the first
time, it is necessary to download the Pcode to permanent storage and reboot the
device since the device needs to add resources that it can only do at startup.
In the device, NOVRAM is modeled as I/O. This means that each NOVRAM
location corresponds to a signal length point. The NOVRAM values are written as
part of I/O transfers for signals after the execution of the tasks where those signals
are used.

9-12 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Insert NOVRAM
To insert NOVRAM in a Main Board hardware module
1. From the Outline View, click Main Board.
Or use the shortcut keys, 2. From the Edit menu, select Insert First.
Shift + Insert.
Or, click the right mouse button and select Insert First. The New Hardware
Module dialog box displays.
3. Click Nonvolatile RAM (NOVRAM) and click OK.

The list of signals and their corresponding NOVRAM locations must be static for the
device to restore values to the proper signals. Therefore, never move NOVRAM
points. The NOVRAM Edit dialog box displays statistics on memory space. It also
displays the option to sort the page order and the command to compress the memory
space, if required.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-13


Modify NOVRAM
To modify NOVRAM
Or double-click the item 1. From the Outline View, click NOVRAM to highlight it.
NOVRAM.
2. From the Edit menu, select Modify. The NOVRAM Edit dialog box displays.

Statistics display data on memory space as follows:


Version is a number incremented by the toolbox whenever a change takes place, such as
1.0. The first number is the major number and the second is the minor number.
% Allocated displays the amount of memory used.
% Free displays the amount of NOVRAM that can still be used.
% Lost displays the amount of NOVRAM that was lost because of the deletion of the points
that are not reclaimed so that the mapping of points are deterministic.

Page Sort Order rearranges


the list of NOVRAM points in
the Outline and Summary
Views, so that it is sorted
alphabetically by the signal
name or the point name. This
does not affect the order of
points in the NOVRAM.

Compress Page recovers unused


memory in NOVRAM that
accumulates when points are
removed without compressing.
This command increases the
major version number.

Note Only compress the page if a large % space is lost and not enough % space is
free to add the required data.

Modifications to the NOVRAM are shown in the Version number, such as 1.0. The
major number (1) increases whenever the page is compressed. The minor number (0)
increases when a point is added or deleted. This version number is used by the
runtime to know when to initialize the signal from NOVRAM when the device starts
up. If the major number changes, nothing is transferred to local memory when the
device starts. If the minor number changes, then only the points that have not
changed are transferred to local memory.

9-14 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


NOVRAM Points
When NOVRAM points are inserted, the numeric value of the highest point number
is saved and used to assign the next point number/name. If a NOVRAM point is
deleted, the memory location of the point is not reclaimed until the Compress Page
command is run.
To insert a NOVRAM point
1. From the Outline View, click the item NOVRAM to highlight it.
Or use the shortcut keys, 2. From the Edit menu, select Insert First.
Shift + Insert
Or, click the right-mouse button and select Insert First. The NOVRAM Point
Insert another item by selecting Edit dialog box displays.
Insert Next.

Enter the point to edit.

Select Input or Output.

Data Type is the named


type of the I/O point.

Enter the name of the signal related to this View the signal note to make sure
point. Click Browse... to select a signal. this is the correct signal.

Sometimes a NOVRAM point is also mapped to another input point from a network.
When the device starts up, the signal is restored to the value stored in NOVRAM. In
addition, the input point is given the same restored value so that the first I/O transfer
from the point to the signal cannot give it meaningless values.
Signals that are forced in the device are saved in NOVRAM and are not lost when
the device is restarted. These force values are not restored if the major revision of the
application code changes because it is possible that the addresses of the signals may
have all changed. The NOVRAM is divided such that using all of the 512 points
available should not infringe on the memory available for forced points.
NOVRAM points can be added to the list of points using drag-and-drop. Drag the
signal onto the item NOVRAM in the Outline View. The point name and data types
are assigned automatically based on the signal that is dragged.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-15


Register Network
Third-party HMIs and PLCs Register network interfaces allow the EX2100 to communicate with other devices
may use protocols such as that do not use the EGD protocol over Ethernet. In the PLCs, data is modeled as a set
Modbus or SRTP. of register spaces that are either words or bits. Each register space is given a type
name, such as %M (bits) or %R (words). A number identifies registers within a
space. A register page corresponds to part or all of one register space. The register
spaces defined by the Series 90-70 mostly correspond directly to hardware I/O. The
%M and %R spaces provide the only general purpose register facilities for bits and
16-bit words, respectively.
The Ex2100 interfaces with these devices using a form of shared memory that is
updated over a network. The shared memory is referred to as register pages. Pages
can be created, instanced, and then put into the SDB.
The toolbox generates the required mapping for signals into the register pages. The
toolbox can also generate appropriate text or binary files to configure other devices
to match up with the register page(s) images in the EX2100.
A device can access data over the Ethernet interface using the SRTP protocol to read
or write registers or over a serial connection to read or write blocks (pages) of the
devices shared memory.
This section describes the following register networks that provide an interface to
Innovation Series Drives:
Ethernet Service Request Transfer Protocol (SRTP)
Serial Modbus
Ethernet Modbus
Custom Register Network

9-16 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Ethernet SRTP
The Innovation Series Drive communicates with the CIMPLICITY HMI through
SRTP. The SRTP driver responds to the protocols' commands to read and write
register pages.
To insert a Ethernet SRTP
1. Click the item Hardware and I/O Definitions.
Or click the right-mouse button 2. From the Edit menu, select Insert First. The New I/O or Network
and select Insert First. Interface dialog box displays.

Select Ethernet
SRTP and click OK.

The SRTP
Interface Settings
dialog box displays
(refer to the next
section).

SRTP Settings
The ETH_SRTP Network Settings dialog box is shown below.

Enter a name using up to five


characters. The name must begin
with a letter of the alphabet.

Enter a description of the interface.

Click OK.

The named Ethernet SRTP Interface is inserted.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-17


Right-mouse click on
Ethernet SRTP
Interface. Select Insert
First.

Pg1 is inserted.

To insert points, right-mouse


click on Pg1 and select
Insert First.

Note To modify the pages and points, refer to the sections, Modify Page Settings
and Modify Point Settings.

Serial/Ethernet Modbus
Serial/Ethernet Modbus interface provides communication between the EX2100 and
non-GE controllers using the Serial RS-232C connection, Ethernet or both.
RS-485 is used for multiple
Communication with the remote controller is implemented using register pages. The
devices.
register maps may be independent or shared (overlapping).
To insert a Modbus
1. Click Hardware and I/O Definitions.
Or click the right-mouse button 2. From the Edit menu, select Insert First. The New I/O or Network
and select Insert First. Interface dialog box displays.

Note The EX2100 is always a Modbus slave.

Select Serial/Ethernet
Modbus and click OK.

The Serial Modbus


dialog box displays.
Enter the correct
settings as described in
the next section.

9-18 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Modbus Settings
Make modbus settings as described below.

Baud Rate, Parity, Data Bits, and Stop


Bits define the communication settings for
Enter the communication the network and must be set to match all
mode for the network. The other controllers on the network (check this
default mode is Binary. dialog box on other controllers).

Identifies the Serial Modbus


network in the controller.
Enter up to five characters.

Enter the communication


Port used to talk to the
external controller (COM1 is
not available).
Enter the network address
of the controller. It must be
a unique number between 1
and 255.
Select the desired
physical Modbus
interface. Shared pages
can receive commands
from either the Serial or
Ethernet interfaces.

Input Enable Signal:


Inputs to this controller can
be enabled and disabled
programatically by
specifying a Boolean signal
here and manipulating it
with blockware. Enter a note to describe this This option is only available in
modbus interface. Expert Mode and at Privilege Level
4. It limits the number of
commands processed per second.

Right-mouse click on
<name> Serial Modbus
Interface. Select Insert
First.

Pg1 is inserted.

To insert points, right-mouse


click on Pg1 and select
Insert First.

Note To modify the pages and points, refer to the sections, Modify Page Settings
and Modify Point Settings.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-19


Custom Register Network Dialog Box
The Custom Register Network dialog box is shown below.

Default name can be


edited using up to five
characters.

Select the network


type(s) that this
network supports.

Select the network


configuration
parameter to edit.
Change the value of
the parameter.

Right-mouse click on
Register Network.
Select Insert First.

Pg1 is inserted.

To insert points, right-mouse


click on Pg1 and select
Insert First.

Tip To modify pages and points, refer to the following sections, Modify Page
Settings and Modify Point Settings.

9-20 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Modify Page Settings
To modify a page, double-click the page name to display the Custom Register
Page Settings dialog box.

Enter the page name


using up to five
characters.

Enter the page length


for the defined
address.
First Address cannot
be outside of
available memory.

Select the registry/


coil.

Sort the list of pages


by name or by
address.

Toggle the page


options on and off,
as desired. Page
version and heartbeat
functionality requires
client support and is
generally not
applicable.

% Allocated is the
percentage of page
memory that is
allocated.
% Free is the Click to keep the Click to unlock all signals and Click to reclaim all
percentage of page memory location of allow the memory location of lost memory.
memory remaining. points with signals points that have signals to
% Lost is the amount on the page. change.
of memory that is lost
by deleting signals in
the page and not
compressing.

GEH-6414D Toolbox for an EX2100 Chapter 9 Hardware and I/O 9-21


Modify Point Settings
Register pages consist of individual register points (much like Status_S pages).
To modify the point
Double-click the point to display the Point Settings dialog box.

Enter the page name


or select Browse...

Enter the number of


the register that the
signal is connected to.

Enter the data type of


the register. This field
is only enabled for
word-type register
pages. Bit-type pages
must be a bit-by-
definition. The four
data types supported
are Bit, Short, Long
and Float. (Long
integer and Float point Click to restrict the Click to allow the Click to edit the signal
are double word-type signal address. The signal to be scaled for connected to the point.
and occupy two point can not be non-bit data types.
registers on the page.) moved if you perform
a page compress.

9-22 Chapter 9 Hardware and I/O GEH-6414D Toolbox for an EX2100


Chapter 10 Signals and the Database

Introduction
This chapter defines signals and their sources. It also defines the topological
information in the database. The database is a collection of signals, scales, and other
topological information, which all devices in a system share for communication.
Devices place information into the database with the command Put Into Database.
and obtain information with Get From Database. There are two databases:
System and Unified System.
System Database (SDB) is a Windows-based client/server database, which uses .dbf
files for storing data.
Unified System Database (USDB) is an Informix SQL relational client/server
database, which runs on a LynxOs-based PC.

Note The USDB is not used by the EX2100 Configuration.

Section Page

Signal Concepts......................................................................................................10-1
SDB ......................................................................................................................10-10

Signal Concepts
Signals are the placeholders for memory locations in the toolboxs different
platforms. Signals also connect both the pins in blockware and blockware to the
points in hardware. They are created by signal definitions and pins as part of
blockware. Every block, macro, or module that is inserted has a signal associated
with its pins.
For more information, refer to Signals exist in the database only when they are mapped (connected) to a network
the section, SDB. I/O point and the device configuration command, Put Into Database is used.
When a signal is put into the database, it is made available to other devices to get.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-1
Signals can be created by:
Inserting a signal definition
Get From Database command
Inserting an item of blockware in a controller

EX2100 Signals
In the Outline View, controller signal definitions are inserted under the item Signal
Definitions (under the items Functions or Macro and Module Libraries). Signal
definitions are also placed under the item System Data, under the items External
Signal Definition and Undefined Signal Definition, using the command, Get From
Database. Also, in the item System Data, a list of LINK_OK signals are placed
under the item Network Signal Definitions.

Signal definitions can


be inserted under the
following items.

System Data

Macro and
Module Libraries

Functions

10-2 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Macro Pin vs. Module Pin
An EX2100 signal is defined in a macro pin or module pin before instancing. The
following table provides guidelines on how and when to define a pin.

When to use a macro pin: Guidelines for Macro Definition Pin


For any signal that needs to be accessed outside this Limit name to seven characters.
macro.
Can attach a 50-character note.
For signals that will help with debugging, especially if it will
avoid having to look inside the macro. When a macro is instanced, the macros pin names are
combined with the instance number to automatically make
the signal name.

Use a module pin when: Guidelines for Module Definition Pin


Signal is used in more than one task. Name is limited to 12 characters.
Signal is a Status_S or I/O signal (do not use fully qualified Can attach a 50-character note.
signal name, such as R1/R2/R3/name).
Can attach a scale factor to the signal.
One or more tasks in the module need to be event started
on the rising edge of this signal. Inserting a module pin makes it obvious which signals are
inputs/outputs.
Signal is not used elsewhere, but needs a custom signal
description. (A custom signal description is needed for any The pins on blocks and macros in the module definition can
signal that might end up as a permissive that could be be written to point to this module pin, no matter what region
diagnosed, such as an input to a BENG or a BENG D prefixes were specified when the module was instanced.
block).

Signal/Pin Connection
Signals are created by signal definitions or for pins as part of blockware. Every
block, macro, or module that is inserted has a signal associated with its pins. When a
signal is created:
A block pin or instanced macro pin is automatically named based on the pin
name and block number. They are referenced from pins on other blocks using
# :pin_name (# is the block number : name of pin). There is no signal
description associated with this signal. This signal can only be used within the
same level of code. If the block is in a macro, it can only be used within that
macro and if the block is in a task, it can only be used within that task.
A module instanced pin or inline module pin are global to the device. They
can be connected to a Status_S variable or an I/O point. The signal name is in
the form R1\R2\R3\module_pin_name, where R1\R2\R3 was specified when the
module was instanced.
A signal definition is also global to the device. It can be connected to a
Status_S variable or an I/O point. The signal name is in the form
R1\R2\R3\signal_name. A scale factor can be attached to the signal.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-3
Pins are connected to other pins or signals to make blockware function in a
prescribed way. A connection is generally indicated in the Outline View by a name
in parentheses following the pin name, such as:

For more information, refer to Pin connections display in a hierarchy that can be seen in the Finder under the
Chapter 5, Finder. Signal/Variable Usage tab, as shown.

The hierarchy reflects the way pins and signals are connected. Each item in the list
references the item in the level above it. A signal hierarchy, excluding I/O points, is
represented in Pcode by a single address token. This means that only one initial value
or scale is used and the top level is the source of such information.
It is important to recognize the directional nature of connections to obtain the correct
data type. Pins with a collection data type, such as Analog or Simple, must reference
For a list of data types, refer to
pins with non-collection data types. Referencing incorrectly causes a validation
Chapter 2, Using the Toolbox.
error. Correct the error by reversing the direction of the connection or by creating a
pin and referencing that pin.

10-4 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Attaching Signals to I/O
I/O points found under the item Hardware and I/O Definitions can be used in
blockware only when they are connected to signals. The Summary View below
displays an example of the connected signal and scale.

The I/O mapper task is a program that transfers inputs to outputs in the controller.
The toolbox creates I/O transfer Pcode records for any signal connected to both input
and output points. Similar records are also created for tasks that have signals with
I/O points connected to block pins.
More than one point can be connected to a signal. These multiple connections direct
the mapper task to move inputs to outputs using I/O transfers, although the signal is
not used in any task. To have more than one input point results in a validation error.
However, it is possible to connect multiple output points to this signal, along with a
single input point.
Scale factors are associated with signals and not points, so that all points connected
to a particular signal will all use the same scale factor. When the input transfer
occurs, the raw counts are converted to engineering units used by the blockware.
When the output transfer occurs, the engineering units are converted to raw counts.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-5
Special Signal Properties
Properties of certain signals can be accessed in blockware and used as part of the
normal logic by preceding the name of the pin or signal, as follows:
Proceed the inverse of a Boolean signal with a tilde symbol ~.
Proceed the health of any signal connected to an I/O point, (Boolean value) with
the number symbol #.
A signals health status indicates whether the associated point is functioning as
intended. The value of the signal health varies depending on the points to which the
signal is connected.
For more information on A scale can be attached to either a signal definition or module pin definition. Any
defining scales, refer to signal can be mapped to a network page owned by the device. When the command
Chapter 4, the section, Scale Put Into Database is used, all the signals and any scales attached are put into the
Definitions. SDB. The scale is now available to other devices using the command Get From
Database. These scale definitions display under the items System Data/External
Scale Definitions, as shown below:

10-6 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Signal Selector
The Signal Selector dialog box allows you to select a signal for the various
functions in the toolbox.
To select a signal
1. In the Outline View, select Functions, Signal Definition, then right-click the
signal name and select Modify. The Edit Signal definition dialog box
displays.
2. Click the Browse... button to display the Signal Selector dialog box shown
below.
Double-click on the
region to select
signals from.

A list of available
signals displays.
Double-click to
select the desired
signal.

A description of the
selected signal
displays here.

Select the type of signal to display Select either Local or Network


in the list above, such as All Types Items, when available. The default
or Boolean. is Local.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-7
In the example above, a specific Network, a Device, and a Data Type are selected
from drop-down menus to display just those selected signals.
Another method of selecting a desired filter region is to click the Browse Region
button. The Select a Region dialog box displays.

10-8 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Click the Attributes button on the SDB Signal Browser dialog
box to define the columns displayed in the list box in the Select Signal Fields to
View dialog box.

The Add All, Add, Remove, and Remove All buttons move signals from the left
list box to the right.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-9
SDB
For more information, refer to The SDB is a client/server Windows-based database that uses .dbf files for storing
GEI-100506. data. Only the device that owns the topology and signal data can put that information
into the SDB. There is no separate import program.
Select the database from the Options menu, Settings option, and Database tab.
The SDB:
Can be created from the toolbox as long as the SDB server is running.
Is specified by a path-qualified sub-directory where the database is stored. The
SDB name must include a drive letter.
I/O points and internal signals that can be put into the database are stored in the
signal table.

10-10 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Put Into Database
The command Put Into Database provides information for other devices in the
system. The command Get From Database allows the devices to obtain this
information. All devices put the same information into the database depending on the
configuration (except the System Device). The following data can be put into the
database:
Device information (topology data), such as device name, type, and number.
Network information (topology data), such as the networks connected to the
device, pages associated with each network connection, and drop numbers when
applicable.
Signals owned by the device and mapped to pages owned by the device.
Scales owned by the device, which are attached to signals that get put into the
database.
The Put Into Database command puts the device signals that are connected to
networks into the SDB.
To put information into the database
1. From the Device menu, select Put Into Database. The toolbox displays the
message box shown below, indicating which server will be used and the
database. If any of this information is incorrect, click No to cancel the operation.

2. Click Yes to continue the command, Put Into Database. The Error Log
View displays the present state and status of the command.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-11
Get From Database
This command also allows the The Get From Database command searches for undefined signals in the database.
device to obtain the actual Then, the database server returns signal attributes and the signals are assigned
value of the signal from the owners. The owners are the external devices on the same network as the device
network interface during performing the get. The signal attributes returned by the database are used for
runtime. building the devices Pcode. Get From Database also allows the device to obtain
the actual value of the signal from the network interface during runtime.
To get information from database
1. From the Device menu, select Get From Database. The toolbox displays the
following message box, indicating which server will be used and the database. If
any of this information is incorrect, click No to cancel the command.

2. Click Yes to continue the command. The Error Log View displays the present
state and status of the command.
An example is shown below. The signals are displayed under the item External
Signal Definitions.

Tip During the command Get From Database, the toolbox creates a list of all
signals that are used and not owned by the device. It then attempts to find them in the
database. The signals that are found are placed under System Data/External Signal
Definitions. They are also shown as points in the devices external page under
Hardware and I/O Definitions.

If signals are not found in the database, a message box displays to create Undefined
Signals Definitions. If undefined signals are created, they are displayed under the
item UnDefined Signal Definitions, as shown below.

10-12 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Signals found in the
database and not
owned by the
device are compiled
here.

Signals not found in


the database are
compiled here.

Scale Results
When a scale is associated with a signal, the scale name and information is included
with the signal. Global scale definitions do not change as often as signal usage. So,
after getting topology and signals, a dialog box displays to Get Scales. Click No and
receive a warning that scales were not received and previously defined external
scales were not touched. Click Yes and the item Externally Defined Scales is
replaced with all the scales defined in the database.

Note Get scales returns all the scales in the SDB, including those owned by this
device. However, these scales are ignored by the device since it is the owner.

Global Enumerations
System Configuration can define Enumeration Type definitions, which are global.
When System Configuration performs a Put into Database command, these
enumerations are stored in the SDB. Any device that performs a Get from
Database command will get these global enumerations, along with signals, scales,
and other data. These global enumerations are stored as shown below.

GEH-6414D Toolbox for an EX2100 Chapter 10 Signals and the Database 10-13
Notes

10-14 Chapter 10 Signals and the Database GEH-6414D Toolbox for an EX2100
Glossary of Terms

AcDcEx2000
Refers to the dc drives (DC2000), ac drives (AC2000), and exciters (EX2000), which
are all referenced in the combined device type name. These three devices can use the
same application control boards and devices in the toolbox.

application code
Software that controls specific machines or processes.

ARCNET
Attached Resource Computer Network. A LAN communications protocol developed
by Datapoint Corporation. The physical (coax and chip) and datalink (token ring and
board interface) layer of a 2.5 MHz communication network which serves as the ba-
sis for DLAN+. See DLAN+.

ASCII
American Standard Code for Information Interchange. An 8-bit code used for data.

attributes
Information, such as location, visibility, and type of data that sets something apart
from others. In signals, an attribute can be a field within a record.

automatically named signals


Signals that are created as a result of inserting some instruction block(s) other than a
Signal Definition. One or more regions of such signals is of the form }00123.

baud
A unit of data transmission. Baud rate is the number of bits per second transmitted.

BIOS
Basic input/output system. Performs the boot-up, which includes hardware self-tests
and the file system loader. The BIOS is stored in EEPROM and is not loaded from
the toolbox.

bit
Binary Digit. The smallest unit of memory used to store only one piece of informa-
tion with two states, such as One/Zero or On/Off. Data requiring more than two
states, such as numerical values 000 to 999, requires multiple bits (see Word).

GEH-6414D Toolbox for an EX2100 Glossary of Terms G-1


block
Instruction blocks contain basic control functions, which are connected together dur-
ing configuration to form the required machine or process control. Blocks can per-
form math computations, sequencing, or continuous control. The toolbox receives a
description of the blocks from the block libraries.

board
Printed wiring board.

Boolean
Digital statement that expresses a condition that is either True or False. In the tool-
box, it is a data type for logical signals.

bus
An electrical path for transmitting and receiving data.

bumpless
No disrupt to the control when downloading.

byte
A group of eight binary digits (bits) operated on a single unit.

CMOS
Complementary metal-oxide semiconductor.

collection
A group of signals found on the same network. The Trend Recorder can be config-
ured by adding collections.

COM port
Serial controller communication ports (two). COM1 is reserved for diagnostic infor-
mation and the Serial Loader. COM2 is used for I/O communication

configure
To select specific options, either by setting the location of hardware jumpers or load-
ing software parameters into memory.

datagrams
Messages sent from the controller to I/O blocks over the Genius network.

G-2 Glossary of Terms GEH-6414D Toolbox for an EX2100


dead band
A range of values in which the incoming signal can be altered without changing the
outgoing response.

device
A configurable component of a process control system.

DLAN+
GE Industrial System's LAN protocol, using an ARCNET controller chip with modi-
fied ARCNET drivers. A communications link between exciters, drives, and control-
lers, featuring a maximum of 255 drops with transmissions at 2.5 MBs.

gateway
A device that connects two dissimilar LANs or connects a LAN to a wide-area net-
work (WAN), PC, or a mainframe. A gateway can perform protocol and bandwidth
conversion.

download gateway
A controller that communicates to Ethernet and DLAN+, running the special soft-
ware that can download an OC2000.

Ethernet
LAN with a 10/100 MB baud collision avoidance/collision detection system used to
link one or more computers together. Basis for TCP/IP and I/O services layers that
conforms to the IEEE 802.3 standard, developed by Xerox, Digital, and Intel.

event
A property of Status_S signals that causes a task to execute when the value of the
signal changes.

fault code
A message from the controller to the HMI indicating a controller warning or failure.

Finder
A subsystem of the toolbox for searching and determining the usage of a particular
item in a configuration.

firmware
The set of executable software that is stored in memory chips that hold their content
without electrical power, such as EEPROM.

flash
A non-volatile programmable memory device.

font
One complete collection of letters, punctuation marks, numbers, and special charac-
ters with a consistent and identifiable typeface, weight, posture, and size.

forcing
Setting a live signal to a particular value, regardless of the value blockware or I/O is
writing to that signal.

GEH-6414D Toolbox for an EX2100 Glossary of Terms G-3


function
The highest level of the blockware hierarchy and the entity that corresponds to a sin-
gle .tre file.

gateway
A device that connects two dissimilar LAN or connects a LAN to a wide-area net-
work (WAN), PC, or a mainframe. A gateway can perform protocol and bandwidth
conversion.

Get From Database


The act of retrieving configuration information from some system database.

Genius bus
GE Fanucs distributed network of intelligent I/O blocks.

Genius global data


Data that is automatically and repeatedly broadcast by a bus controller. All other bus
controllers on the same bus are capable of receiving the data, although some bus con-
trollers can choose not to. The controller can broadcast global data and receive
global data from certain devices, such as the Series 90-70 PLC and other controllers.

Graphic Window
A subsystem of the toolbox for viewing and setting the value of live signals.

groups
See Resources.

health
A term that defines whether a signal is functioning as expected.

heartbeat
A signal emitted at regular intervals by software to demonstrate that it is still active.

hexadecimal (hex)
Base 16 numbering system using the digits 0-9 and letters A-F to represent the deci-
mal numbers 0-15. Two hex digits represent 1 byte.

initialize
To set values (addresses, counters, registers, and such) to a beginning value prior to
the rest of processing.

I/O
Input/output interfaces that allow the flow of data into and out of a device.

I/O drivers
Interface the controller with input/output devices, such as sensors, solenoid valves,
and drives, using a choice of communication networks.

I/O mapping
Method for moving I/O points from one network type to another without needing an
interposing application task.

G-4 Glossary of Terms GEH-6414D Toolbox for an EX2100


insert
Adding an item either below or next to another item in a configuration, as it is
viewed in the hierarchy of the Outline View of the toolbox.

instance
Update an item with a new definition.

item
A line of the hierarchy of the Outline View of the toolbox, which can be inserted,
configured, and edited (such as Function or System Data).

logical
A statement of a true sense, such as a Boolean.

macro
A group of instruction blocks (and other macros) used to perform part of an applica-
tion program. Macros can be saved and reused.

model
Interactive setup data (recipe) that automatically adjusts to the process. This function
is usually used with hot mills or cold mills.

module
A collection of tasks that have a defined scheduling period.

GENI controller board


IC660ELB912_. An optional board for the controller that provides an interface to the
Genius I/O bus.

non-volatile
The memory specially designed to store information even when the power is off.

online
Online mode provides full CPU communications, allowing data to be both read and
written. It is the state of the toolbox when it is communicating with the system for
which it holds the configuration. Also, a download mode where the device is not
stopped and then restarted.

pcode
A binary set of records created by the toolbox, which contain the controller applica-
tion configuration code for a device. Pcode is stored in RAM and Flash memory.

period
The time between execution scans for a Module or Task. Also a property of a Mod-
ule that is the base period of all of the Tasks in the Module.

period multiplier
A property of a Task that permits the Tasks execution rate to be a multiple of its
Modules period.

GEH-6414D Toolbox for an EX2100 Glossary of Terms G-5


physical
Refers to devices at the electronic or machine level in contrast with logical. Logical
implies a higher view than the physical. Users relate to data logically by data element
name; however, the actual fields of data are physically located in sectors on a disk.

pin
Block, macro, or module parameter that creates a signal used to make interconnec-
tions.

PLC
Programmable Logic Controller. Designed for discrete (logic) control of machinery.
It also computes math (analog) function and performs regulatory control.

product code (runtime)


Software stored in the controllers Flash memory that interrupts the application con-
figuration and performs the requested activities. This includes code such as I/O driv-
ers and control block libraries.

put into database


Command in the Device menu used to add configuration information into a system
database.

realtime
Immediate response. It refers to process control and embedded systems, and fast
transaction processing systems that must respond instantly to changing conditions.

reboot
To restart the controller.

recipe
Information for process line or paper mill that provides setup data, such as speed,
length, and tension.

register page
A form of shared memory that is updated over a network. Register pages can be cre-
ated and instanced in the controller and posted to the SDB.

relay ladder diagram (RLD)


A ladder diagram has a symbolic power source. Power is considered to flow from the
left rail through a contact to the coil connected to the right.

Resources
Also known as groups. Resources are systems (devices, machines, or work stations
where work is performed) or areas where several tasks are carried out. Resource con-
figuration plays an important role in the CIMPLICITY system by routing alarms to
specific users and filtering the data users receive.

runtime
See product code.

runtime errors
controller problems indicated on the front panel by coded flashing LEDS and also in
the Log View of the toolbox.

G-6 Glossary of Terms GEH-6414D Toolbox for an EX2100


sample set
Set of values taken when signals are being trended together with the Trend Recorder.

sampling rate
The period that values are collected to put in a sample set.

Serial Loader
Connects the controller to the toolbox PC using the RS-232C COM ports. The Serial
Loader initializes the controller flash file system and sets its TCP/IP address to allow
it to communicate with the toolbox over Ethernet.

service
Functionality derived from a particular software program. For example, the Recorder
Service transmits and provides conversion of data in the SDB.

signal
The basic unit for variable information. Signals are the placeholders for memory lo-
cations in the toolboxs different platforms.

simulation
Running a system without all of the configured I/O devices by modeling the behavior
of those devices in software.

skew
A property of modules that allows a module to execute at a different time slice than
other modules with the same period.

skew offset
A property of tasks that allows a task to execute at a different time slice than other
tasks within the same module.

Status_S
GE proprietary communications protocol that provides a way of commanding and
presenting the necessary control, configuration, and feedback data for a device. The
protocol over DLAN+ is Status_S. It can send directed, group, or broadcast mes-
sages.

Status_S pages
Devices share data through Status_S pages. They make the addresses of the points on
the pages known to other devices through the system database.

symbols
Created by the toolbox and stored in the controller, the symbol table contains signal
names and descriptions for diagnostic messages.

task
A group of blocks and macros scheduled for execution by the user.

TCP/IP
Communications protocols developed to inter-network dissimilar systems. It is a de
facto UNIX standard, but is supported on almost all systems. TCP controls data
transfer and IP provides the routing for functions, such as file transfer and e-mail.

GEH-6414D Toolbox for an EX2100 Glossary of Terms G-7


time slice
Division of the total module scheduling period. There are eight slices per single exe-
cution period. These slices provide a means for scheduling modules and tasks to be-
gin execution at different times.

toolbox
A Windows-based software package used to configure controllers and drives.

trend
A time-based plot to show the history of values.

Trend Recorder
A subsystem of the toolbox that monitors and graphs signal values from a controller
or drive.

TrueType
Scaleable font technology that renders printer and screen fonts. Each TrueType font
contains its own algorithms for converting the outline into bitmaps.

validate
Makes certain that items or devices do not contain errors and verifies that the con-
figuration is ready to be built into pcode.

Windows NT
Windows New Technology. Advanced 32-bit operating system from Microsoft for
386s and above. It runs NT-specific applications as well as those written for DOS,
Windows 3.x (16 and 32-bit), OS/2 character mode (non-graphical) and POSIX. NT
does not use DOS; it is a self-contained operating system.

word
A unit of information composed of characters, bits, or bytes, that is treated as an en-
tity and can be stored in one location. Also, a measurement of memory length, usu-
ally 32 bit in length but van also be 4, 8, or 16-bits long.

G-8 Glossary of Terms GEH-6414D Toolbox for an EX2100


Graphics window
Properties toolbar 8, 31

Index Help
Menu 28

I
I/O Mapper 7
I/O Points 39, 2
Innovation Series Drive tab 23

L
A Libraries tab 12
AcDcEx2000 tab 21 License
Alarm Scanner tab 10 Agreement 2
Application Settings 32, 33
M
B Main Board
Block Diagram tab 14 Insert NOVRAM 13
Modify NOVRAM 14
NOVRAM Points 15
C Menu Commands
Checkin/Checkout utility 1 Device Menu 26
Configuration 1, 2, 14, 16, 18, 24, 30, 41 Edit Menu 22
Configure the Static Starter File Menu 21
Alarm Scanner Tab 10 Help Menu 28
Customer Information Tab 11 Options Menu 27
General Tab 7 View Menu 23
Memory Tab 8 Window Menu 28
Note Tab 12
NTP Tab 9 N
Note tab 12
D NOVRAM
Database Insert 13
SDB 7, 24, 3, 4, 1, 5, 16, 1, 6, 10, 11 Points 15
DLAN+ Interface NTP tab 9
Status_S pages 22
O
E OC2000 tab 20
EGD Interface
Edit EGD 6 P
EGD Exchanges 7
EGD Points 10, 11 Print tab 13

F R
Finder window Register network
Text/Address tab 4 Custom Register Network 16, 20
Ethernet Modbus 16, 18
Ethernet SRTP 17
G Serial Modbus 16
Get From Database command 2, 12 Reports

GEH-6414D Toolbox for an EX2100 Index I-1


Signal Cross Reference 24
Requirements 1
Resource name 2, 5

S
Settings
AcDcEx2000 21
Controller 15
Database 11, 10
EX2100 16
General 9
Innovation Series Drive 23
Libraries 12
OC2000 20
Print 13
Trend Recorder 22
Signals
Concepts 1
Pin connection 4
Status_S pages 22

T
Toolbox Options
AcDcEx2000 21
AVDV Series Drive 17
Block Diagram 14
Controller 15
Database 11, 10
EX2100 16
General 9
Innovation Series Drive 23
Libraries 12
OC2000 20
Print 13
Startup 10
Trend Recorder 22

W
Watch Windows 24
Work Area
Detached Summary View 3, 14, 40
Log View 3, 20, 11, 12
Status bar 23, 43
Summary View 3, 4, 14, 20, 23, 24, 40, 41, 44, 10, 8,
9, 11, 5

I-2 Index GEH-6414D Toolbox for an EX2100


GE Energy
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA

1 540 387 7000


www.geenergy.com

GEH-6414D
Revised 061006
Issued 000430