Geh 6700D
Geh 6700D
Geh 6700D
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.
Revised: 070514
Issued: 040120
Fax No.
Your Company’s Name and Address Job Site
Phone No.
GE Requisition No.
E-mail
Your Job Function / How You Use This Publication Publication No.
Address
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 ____________________________________________
____________________________ Place
stamp
____________________________ here.
____________________________
GE Energy
Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Index I-1
The ControlST* CD includes the ToolboxST* application and support packages for
the various components. Before you install the software:
®
• It is recommended that you exit all Windows programs.
• All products are installed under a common folder on your hard disk. You can
define this location the first time you install the CD, but any subsequent releases
will be installed to the previously defined location.
• No license key is required to install this product, but to run the ToolboxST
application after installation, a valid hardware key (dongle) plugged into any
Universal Serial Bus (USB) port is required. Refer to the section, Licensing.
System Requirements
The following are minimum hardware and operating system requirements needed to
run the ToolboxST application.
Processor ®
1 GHz Pentium IV
Operating System ® ®
Microsoft Windows 2000
Memory 1024 megabytes (MB) RAM
Hard drive 20 gigabytes (GB)
Monitor XGA display (1024 x 768 x 64K colors)
Drive CD-ROM or DVD-ROM drive
Network Ethernet network adapter
Note If the installation does not start automatically, use Windows Explorer to
navigate to your CD-ROM drive and run GEControlST Install.exe.
2 The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.
3 To continue the installation, you must accept this agreement. Select Agree.
4 Click Next. The User Information dialog box displays. Enter information for
this dialog box as appropriate.
5 Click Next. The Destination Folder dialog box displays. If this is the first
time the ToolboxST application has been installed on this computer, the browse
button allows you to change the default install location (C:\Program
Files\GE Energy\). If this is a subsequent installation, this dialog box
displays where this version of the product will be installed.
6 Click Next. The Select Features dialog box displays and allows you to select
which features to install or not install. All components will be installed by
default.
7 Once your selections are made, click the Next button until the installation starts.
Click the Finish button when the installation has completed successfully.
You can install multiple versions of the ToolboxST application. If a new version is
included, the desktop and Start menu update to reflect the most recently installed
version.
The Add/Remove Programs option lists all installed versions. Once you install a
newer version, you can remove previous versions of the product from your computer
unless you need to retain them for compatibility.
Note Always install new versions of the ToolboxST application before removing
older versions to preserve your personal settings.
Upgrading
To upgrade the ToolboxST application
Install the new version. Refer to the section, Installation. The icons on your
desktop and in your Start menu will be updated to start the most recently
installed version.
The GE ControlST CD supports a variety of control equipment. These products
include updated firmware for the equipment and configuration tools that are
available as component editors inside the ToolboxST application. When you install a
new version of the CD, newer versions of some components may be installed as
well. To use the new versions, you must upgrade each component separately.
Click Next.
- /EGDAction:MODIFY /EGDDevice:
• Go To Variable
• Go To Hardware Diagnostic
• Go To Locator
• -NoSplash
• Archive a ToolboxST System
Note If the ToolboxST application is already opened, starting it again with the
/variable option sends a message to the already running ToolboxST application to
cause it to navigate to the appropriate location.
EMT
The EMT opens a ToolboxST application and navigates to the EGD configuration
tab of a component. It can also add a device with a specified producer ID.
Note If EMT command line arguments are used, the /Variable, /VariableDevice,
/Hardware Diagnostic, and /Navigate to Locator arguments are ignored.
/<keyword>:<value>
where
<keyword> defines the operation or action (the <, > are not used).
<value> defines the value to be used in the operation or action (the <, > are not
used).
Go To Variable
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST application is opened.
Note If the EMT command line arguments are used, the /Variable and
/VariableDevice arguments are ignored.
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST application is opened.
<deviceName>.<variableName>
Examples
Go To Hardware Diagnostic
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST system is opened.
Examples
/HardwareDiagnostic:Marky
This causes the last opened system to be opened, the Marky controller to be opened,
and the Device Diagnostic window to display (View/Diagnostics/Controller
Diagnostics item).
/HardwareDiagnostic:Marky.23GROUP
This causes the last opened system to be opened, the Marky controller to be opened,
and the Hardware tab 23GROUP hardware group to be selected.
Go To Locator
This argument opens any locator string displayed in the Find Results tab.
If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST system is opened.
To open a ToolboxST component and navigate to a desired point, use the Finder to
search for a string in a component. Then, from the Find Results tab, select one of the
locator text strings, as shown in the window below.
-NoSplash
If the text –NoSplash is contained in an argument, the splash screen does not display
when the ToolboxST application starts.
This argument opens the most recent ToolboxST system, creates a system archive,
then exits the system. Archiving the most recent ToolboxST system can be
overridden by using the first argument to specify the path to the desired system.
The target file name is optional. If not specified, the file name is the ToolboxST
system name plus the creation date and time. If the target file name is a directory, the
archive file is placed in that directory with the file name of the ToolboxST system
name plus the creation date and time.
Examples
ToolboxST /Archive
The most recent system is opened. An archive.zip file, with the opened system name
and date/time, is created. The archive is placed in the parent folder for the
ToolboxST system. If the parent folder cannot be opened, the archive is placed in the
ToolboxST system’s working folder.
The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system
name and date/time, is created. The archive is placed in the parent folder for the
ToolboxST system. If the parent folder cannot be opened, the archive is placed in the
ToolboxST system’s working folder.
ToolboxST c:\MySystem.tcw
/archive:c:\MyArchiveFolder\MySystemArchive.zip
The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system
name and date/time, is created. The archive is placed in the specified folder.
Licensing
To use the GE ControlST system software, you must purchase a license. The license
includes a hardware key, called a Universal Serial Bus (USB) Protection Device
(UPD). Hardware keys are also known as dongles.
The UPD must be installed in an empty USB port on your computer. Each UPD is
programmed at the factory with one or more application keys that control access to
software products produced by GE. The ToolboxST application will only function if
your UPD contains a valid ToolboxST application key.
Only one UPD may be installed at a time. If you have valid licenses for more than
one product, your UPD must contain a valid application key for each product.
Note If you install the UPD before installing the ToolboxST application, the device
may appear to be installed, but it is not associated with the correct drivers.You can
correct this after the application is installed.
System Editor
When you start the ToolboxST application, the first window that displays is an
empty System Editor.
Before you can begin using the ToolboxST application, you must create or open a
system. Systems contain components, which are the basic unit representing devices
or tools in the system. A system is stored in its own folder on disk, which contains
both a .tcw configuration file and a collection of supporting files and folders
representing the system components. Refer to the section, Configuration Files.
2 Specify the working directory to contain the new system by typing in a path or
by clicking the Browse button. (If you enter a path that does not exist, the
ToolboxST application creates it for you.)
3 Enter a name for the system. Some characters are prohibited; if you enter an
invalid character, a small red exclamation mark displays.
4 Click OK to create the new system. The new system is created, and opens in the
System Editor.
When a system is open, the System Editor displays overview information about
the components in the system. The window consists of three major areas as
displayed.
The Property
Editor allows
you to edit the
selected
component.
A list of common components and the icon that represents them in the Tree View is
as follows:
Icon Component
System
Group of Components
Printer
Library Container
Network
Trender Window
External Device (not associated with an application)
You can add components to the root component of a system (represented by the
icon) or a group (represented by a icon). Some components display a wizard or
dialog box that prompts you for additional information when you add them to the
system.
To add a component
In the Tree View, right-click a parent component (either a system or a group),
select Insert New, then select the desired component type.
Select Upload from Controller if you do not have Click Next to continue.
the configuration for a particular controller, but know
its IP address. Enter the address in the IP Address
field.
Grouping Components
The ToolboxST application provides a special component called group to help you
organize system components. Groups are similar to file folders in that they can
contain one or more other components (including additional groups). You can use
groups to create any organizational system that you like, including division by
physical component location and a variety of logical divisions.
Groups
The cursor changes to one of the following cursors during a drag-and-drop operation
to indicate the predicted outcome of the operation:
• indicates that the item being dragged cannot be dropped at the location
currently beneath the cursor.
• indicates that the item being dragged will be moved to the location beneath
the cursor.
• indicates that the item being dragged will be copied and the copy will be
placed at the location beneath the cursor
Most components can be moved and copied in the Tree View, with a few exceptions:
Tip You can import components and Library Containers from either another copy
of the ToolboxST application or from the Windows file system using drag-and-drop
operations. (To import from the file system, drag the Device.xml or Library.xml file
that represents the component.)
If the configuration for the external device is stored in a file with a special extension,
you can specify the path to the configuration file and omit the path to the external
application. The ToolboxST application automatically opens the application
associated with the configuration file. In all other cases, you must specify the exact
application to be run for the external device.
To configure an external device
1 From the Tree View, select an External Device to configure. (External
devices that have not been configured are represented by a question mark
icon.)
2 In the Property Editor, select the App Path item. Click the ellipsis button
at the right side of the text field to display the Open dialog box.
3 Locate the application executable file used to configure the device, and then
click Open. The App Path property is updated to reflect the new path.
• If the External Device requires a specific configuration file, select the Doc
Path item and provide the location of the file.
• If the External Device application requires switches (provided for the external
application on the command line before the contents of Doc Path), configure the
Switches property.
• If the External Device application requires a specific working directory (which
is the folder assumed when no path is specified), configure the Start Directory
property.
• If the External Device supports Ethernet Global Data (EGD), set the Enable
EGD Editor property to True.
• If the external component does not have a configuration file that is associated
with a particular application, select the App Path item. Click the ellipsis button
to display the Open dialog box.
Saving Systems
When you make changes to a system, the changes are stored in memory. Save your
work to prevent your changes being lost.
In the ToolboxST application, Save commands affect only the data in the current
editor. As such, the Save command in the System Editor only saves changes to the
system itself. If you have made changes in any other component editors (like a
controller or a library container), you must select the Save command in each of those
editors, as well.
To save changes to the current system
From the File menu, select Save System. (Or, click the button on the
toolbar.)
Configuration Files
Folder Structure
Each system is saved in its own folder. Inside the main system folder is a set of sub-
folders and configuration files. The folder structure depends on the components in
the currently opened system. A typical system and its associated file structure is as
follows:
Tools Folder contains definitions for all tool components in a system. A folder for
each type of tool is contained inside the tools folder. In the example, the system
contains a Trender window, so a TrendRecorder folder is stored inside the tools
folder. Inside the folders for each tool type are additional folders for each instance of
the tool. Since the example system has one Trender window named Trender1, a
single Trender1 folder is stored inside the TrendRecorder folder.
Library Container Folders are created for each library container in the system. In
the example system, the library container named Libraries is stored in a folder
correspondingly named Libraries. Objects in this folder include:
File Formats
All configuration data for the ToolboxST application is stored in eXtensible Markup
Language (.xml) format.
Configuration files can be both compressed and encrypted. If you select the
Compress When Saving option in the System Options dialog box, the configuration
data is stored in a compressed format that is not readable with a text editor but
occupies much less disk space. Some portions of .xml configuration files may be also
stored in encrypted format to prevent unauthorized users from viewing the design of
password-protected system components.
The ToolboxST application provides a variety of settings that change the way
various functions operate. While you can also configure settings from inside the
component that they affect, settings for all available components display when the
Settings dialog box is opened from the System Editor.
To open the Settings dialog box
From the System Editor, select the Options menu, and then select Settings
to display the Settings dialog box.
In the Settings dialog box, categories are listed in a Tree View on the left side of the
dialog box.
The System Options category includes options that affect the system as a whole.
It is available in addition to any other component settings that may display in the
Tree View.
Show Boot Loader, when set to True, displays the boot loader in the Download
wizard.
Show Diagnostic Icons, when set to True, displays diagnostic icons for modules
in the Tree View and serves as a permissive to display more enhanced diagnostic
icons in the Tree View and the Summary View.
Show More Enhanced Diagnostic Icons, when set to True, displays more
enhanced diagnostic icons for modules in the Tree View and the Summary View
(Show Diagnostic Icons must be set to True.).
From the System Editor, double-click the System item in the Tree
View.
The following properties are available in the Property Editor when an Alarm Class is
selected:
Name displays the name of the Alarm Class. Limited to five characters if using an
SDB.
Description displays the Alarm Classes description. Only the first 50 characters are
stored in an SDB.
Alarm Foreground Color displays the foreground color for an alarm in the Alarm
state.
Alarm Background Color displays the background color for an alarm in the
Alarm state.
Blink Background Color displays the background color for the blink state of the
active unacknowledged alarm.
Blink Foreground Color displays the foreground color for the blink state of the
active unacknowledged alarm.
Normal Foreground Color displays the foreground color for an alarm in the
Normal state.
Normal Background Color displays the background color for an alarm in the
Normal state.
The Engineering Min and Max values for both format specifications control the
conversions that take place when a measurement system is selected at an HMI. For
example, if a temperature variable is assigned to the Celsius format specification and
the measurement system in use on the HMI is Metric, no conversion is performed on
the HMI displayed value. If the HMI’s measurement system is changed to U.S., the
value of the variable is converted from Celsius to Fahrenheit using the linear
equation defined by the Engineering Min and Max of the Celsius and Fahrenheit
format specifications. Variables are scaled as follows by the HMI:
Note In the previous example, the minimum value for Fahrenheit (32) and the
minimum value for Celsius (0) represent the same temperature, the freezing point of
water.
The following properties are available in the Property Editor when a Format
Specification Set is selected:
Format Spec Set displays the Format Specification Set that contains the selected
format specification.
Engineering Max displays the maximum value of the range used for unit
conversions.
Engineering Min displays the minimum value of the range used for unit
conversions.
Units displays the text that identifies the format specification unit.
Name displays a unique name for the format specification. If the system data is Put
to an SDB, a limit of 12 characters is enforced for the Name.
Measurement Systems
Each format specification is assigned to a measurement system. Within a format set,
which represents a particular type of measurement (like temperature), only one unit
per measurement system can be created. (For example, you could not add both
Celsius and Kelvin within the Metric system as units of temperature.) You can select
the two measurement systems that are stored in the SDB in the System Information
Editor.
To select the measurement systems used by the SDB
1 In the System Information Editor Tree View, select Format
Specification Sets.
2 Click SDB Meas Sys 1 or SDB Meas Sys 2 in the Property Editor, then
select a measurement system from the drop-down list.
HMI Resources
An HMI (Human-Machine Interface) allows you to organize and customize access to
alarms and live data. Variables have an HMI resource property that can be set to one
of the HMI resources defined here. Each resource has a name and an optional
description.
The ToolboxST configuration for alarm classes and format specifications can be
stored, or put, to an SDB from the System Information Editor.
To put the system configuration to an SDB
1 Open the System Information Editor. From the System menu, select Put
System to SDB. (Refer to the section, System Information Editor.) A dialog
box displays to confirm the destination SDB Host and Path.
2 Click OK. When the process is complete, the results display on the Log tab of
the InfoView.
The EGD Configuration Server maintains a group of .xml files for each EGD
producer device. The EGD Configuration Server also maintains a
MasterSymbolTable.xml file that contains format specifications, alarm classes, and
other system-level information.
The .xml files are stored in folders for each producer ID. The protocol used to get
and put these .xml files to and from the EGD Configuration Server is a published
HTTP protocol. This protocol is available for other tools, and is currently used by
GE Fanuc’s CIMPLICITY ME. The ToolboxST application uses the EGD
Configuration Server if it has been enabled in the System Editor.
Base Path is the URL on the EGD Configuration Server where EGD files reside.
This is normally /EGD.
Host Name is the Host Name or IP address of the host running the EGD
Configuration Server.
Use IE Proxy selects the Internet Explorer proxy settings, if set to True. If set to
False, no proxy is used. The default is false and it is recommended not to use a
proxy.
When the EGD Configuration Server is enabled, a status bar indicates the
Online/Offline status. Right-click the status bar to obtain a shortcut menu, which
allows you to toggle between the two modes. If Work Offline is selected, the server
is bypassed when components are opened, built, or saved. This means that any
component saved results in a difference between the EGD Configuration server and
the ToolboxST application.
View Differences displays a difference report for any consumed or produced data
file that exists in both the server and the local system.
View Local File allows you to view the local version of a selected document.
Send Local To Server sends a local copy of a selected document to the EGD
Configuration Server. If the device’s tree node is selected, all documents under the
device are sent to the server.
Refresh Display compares the local system to the EGD Configuration Server and
updates the display.
Note If the EGD Configuration Server option is enabled for the system, the EGD
configuration will also be put to the EGD Configuration server.
Chapter 3 Software
There are two system components for creating downloadable application software,
controllers and library containers. Controller components contain the application
software that is downloaded to a particular controller. Library containers contain user
block libraries of reusable blocks that can be referenced and used by controller
components.
Controller application software consists of function blocks that perform logical and
mathematical operations on the block variables. This network of blocks and
connected variables controls a particular machine through physical inputs and
outputs.
Function blocks arranged and connected within a software element are called Tasks.
Tasks are grouped into other software elements called Programs.
User-defined blocks called user blocks are created using existing function blocks, as
well as other user blocks. These user blocks can be used in a task in the same manner
as function blocks.
Program groups can be used to add a level above programs; and together with user
blocks, the levels of hierarchy can be four or more as shown here:
Blocks have input and output variables, which can be connected to other variables,
Turbine I/O, or EGD variables. Each instance of a block has a name that is unique in
that block’s context. The combination of the variable name with the block’s name
and context give each variable a unique name within the controller. Blocks in the
same user block can reference each other’s variables using the block name and
variable name separated by a period.
Blocks are typically added to a user block in either a controller component or a user
block library by dragging them from the library palette to the user block’s block
diagram. For more information about editing blocks, refer to the section, Block
Diagram Editor.
Library definitions can contain tasks and/or user blocks created from other
definitions within the same library container. When a library definition is being
created or edited in the library container, the User Blocks tab on the right side of the
block diagram shows all task and user block definitions that exist in the library
container.
Programs, tasks, and user blocks in a controller component can be created from
library definitions. Once the controller component has referenced one or more user
block libraries, the Add Program, Add Task, and Add User Block dialog boxes allow
selection from the library definitions.
The process of updating programs, tasks, or user blocks with current library
definitions is called Instancing.
To instance a single item
From the Software tab Tree View, right-click on a program, then select
Instance to update all software within that program.
To instance an entire system component
From the Software tab Tree View, right-click on the Programs item, then
select Instance All.
Note Definitions can contain user blocks or tasks that were created from other
definitions in a library. To be certain that ALL current definitions have propagated to
all necessary places in a controller component:
• Perform an Instance All command in the library container, then save the library
container.
• Perform an Instance All command in the controller component.
Unlink Property
All programs, tasks, and user blocks generated from a library definition have a
Boolean property called Unlink, which is False by default. In this state, they are
called linked.
Linked programs, tasks, and user blocks, with very few exceptions, cannot be
changed. They are updated with the current library definition when the Instance
command is performed.
Unlinked programs, tasks, and user blocks are disassociated from the library
definition, and can be modified. They are NOT updated with the current library
definition when the Instance command is performed.
Note Programs, tasks, and user blocks that do not come from a library definition are
called Embedded, and they do not have the Unlinked property.
9 From the Tree View tab, select a Program or right-click to add a new
Program.
11 In the Add Task dialog box, select the Select Library Block checkbox to
show library blocks.
12 Insert a linked user block by selecting the user block definition from the dialog
that displays.
- or -
Insert an embedded user block, then drag the linked user block from the library
palette onto the block diagram for that embedded user block.
To update a linked user block in either a library or controller
component
1 From the System Editor, open a library component.
2 From the Tree View, navigate to the user block to update.
3 Edit the user block using the Summary View or the Property Editor.
4 Save and close the library.
5 From the System Editor, open a library or controller component.
6 From the Tree View, right-click the user block to be updated, then select the
Instance command from the shortcut menu.
User block definitions are the source of both linked and unlinked user blocks. Each
user block has a version and description to help manage reusable application
software.
Instance scripts and text substitution allow user blocks to use a set of code in
multiple situations. These work with the ToolboxST automation interface and the
user attributes that belong to either the user block or the controller component.
User Attributes
User attributes are named values that allow you to specialize user block definitions.
They consist of a name, a data type, a description, a value, and a PromptforInput
property.
The PromptforInput property displays a dialog box that allows you to verify the
attribute value when the user block that owns the user attributes is inserted. Named
attributes can be used to change the variable names and connections by substituting
strings specified in user block attributes. User attributes for a user block can be
changed at the Instance command. Refer to the section, Working with User Blocks.
Device Attributes
Device attributes are similar to user attributes. They are named values that consist of
a name, a data type, a description, and a value. However, device attributes are
defined within a device configuration, and can be referenced by any application
software within the device. Device attributes do not have a PromptforInput property.
Refer to the section, Application Software Examples.
Instance Scripts
Instance scripts run when a user block is either inserted or instanced. Their primary
purpose is to exclude particular blocks or user blocks from a user block definition.
Text Substitution
Certain text fields such as variable names, descriptions, and block connections can
have some portion of the text replaced when the user block is inserted or instanced.
To use substitution within a text field, embed a pair of braces {} within the text and
enclose the name of an attribute within the braces. For user attributes, the syntax is
attributeName and for device attributes, the syntax is device.attributeName. Refer to
the section, Application Software Examples.
The following window displays the major parts of the Library Container Editor and
the terminology used when referring to the editor.
The Component InfoView displays The Summary View is used for editing the
information about the currently selected user block selected in the Tree View .
tab.
Tip Different versions of the controller component can be used as the basis for a
library component. A software block library is always included that contains basic
function blocks, such as Move and Average. There are also optional libraries, which
contain more specialized blocks that can be included in the library container.
When new versions of the controller software are installed, library containers
continue to use their current configuration until they are upgraded. (If the old version
is uninstalled, the library container must be upgraded before it can be opened.)
Select the
desired version and
click Finish. Verify that
the upgrade completed
successfully by viewing
the Log tab in the
Component InfoView.
You will be informed if
new versions are
unavailable.
Note Each library is contained in an .xml file, and can be imported into other library
containers.
Tip The Summary View for the Libraries item displays names and locations of
all the function block and user block libraries defined in this library container. The
version of the function block library used by this library container can be determined
by looking at the Directory field and observing the path to the library.
Protection properties control the right to View, Modify Data, or Modify Design
of this library. Refer to the section, Security.
The Summary View shows the name, version, category, and description of all User
Blocks in the currently selected Library.
Adjust determines whether the table's Z values and limits can be adjusted both in
configurations and online. The Adjust flag is read on import; if it is false, the table
data cannot be changed without another import.
Maximum Z value is the Maximum Z value used to limit the values that can be
entered in the live or initial values.
Minimum Z value is the Minimum Z value used to limit the values that can be
entered in the live or initial values.
3 Select the .csv table definition file (.csv) from the browser window and click
Save.
Double-click a value in
the Data Grid Editor.
This feature allows you to edit the table data values in the controller. Once the table
Add Undefined Variables allows you to add all undefined variables in the User
Block Definition to the variables of the User Block Definition. Undefined variables
are variables that have been referenced in a User Block Definition but have not yet
been defined as part of the user block variables or user block.
User Attributes are named values that allow specialization of User Block Definitions.
They consist of a name, a data type, a description, a value and a PromptforInput
property.
The PromptforInput property causes a dialog box to display so that you can verify
the attribute value when the user block that owns the user attributes is inserted.
Named attributes can be used to change the variable names and connections by
substituting strings specified in user block attributes. User Attributes for a user block
can be changed at the instance. Refer to the section, Application Software Examples
for examples on how to use attributes.
To add a user attribute to a user block definition
1 From the Tree View, right-click the User Block Definition and select Add
User Attribute to display the Add User Attribute dialog box.
Instance Scripts
Instance scripts run when a user block is either inserted or instanced. Their primary
purpose is to exclude blocks from a user block definition based on user attributes
defined in the controller component. Refer to the section, Application Software
Examples.
To add an Instance Script
From the Tree View, right-click the User Block Definition and select Add
Instance Script.
Instance
Select this command to get a new copy of the User Block Definition from the library.
In addition to updating the user blocks, this command causes the instance scripts and
text substitutions for all of the top-level user blocks to run. It is not possible to undo
this command.
To instance a User Block Definition
From the Tree View, right-click the User Block Definition and select
Instance.
Validate
This command checks the selected User Block Definition for errors. Validate checks
connection compatibility, data types, and equations. Validation status displays in the
Log tab. Double-click the error in the Log tab to locate the application software that
caused the problem.
To check a User Block Definition for errors
From the Tree View, right-click the User Block Definition and select
Validate.
Property Editor
Summary View
Most of the work in creating a User Block Definition involves inserting different
types of blocks and connecting them together to perform a function using the Block
Diagram Editor. Refer to the section, Block Diagram Editor.
Active Alarm(s)
Note Place the mouse over the icon to display detailed messages regarding the
problem.
Additional editing tools display on the toolbar, and a sidebar called the Library View
displays on the right side of the Summary View to allow you to make changes to a
user block.
Note If the user block is read-only or linked, an error message displays. If the user
block is protected, you are prompted to enter the appropriate password.
Append Sheet adds a new drawing sheet at the end of the drawing.
Insert Sheet inserts a sheet immediately before the current sheet in manual mode.
Zoom adjusts the zoom level to either a preset zoom level or a custom value.
View Settings contains options to toggle the rulers, library view, and print border.
Layout Modes
When blocks and wires are added to a diagram, they are arranged according to the
rules of the current layout mode. By default, diagrams are created in Classic Layout
mode, where the blocks are arranged in order with a focus on optimal use of space.
Toolbox Classic Layout mode automatically places wires and creates new sheets
as necessary, making it appropriate for small-to-medium sized diagrams.
List Layout mode arranges blocks in execution order in one column, with inputs
and outputs lined up on the edges of the sheet. All Rung blocks appear as Rung
diagrams instead of as blocks. This mode is ideally suited for sequencing and can be
used to simplify very large diagrams where wiring becomes confusing.
Manual Layout mode does not arrange blocks or wires, but leaves all layout tasks
to the user. It is ideal for users familiar with a sheet-oriented approach to design or
for applications where very specific documentation standards must be met.
Instance Name displays a unique identifier that allows the block (as well as its
attributes and pins) to be referenced from other places in the ToolboxST application.
Selected Pin displays the pin currently highlighted in the Edit View.
Block Type displays the name of the library block that this block was created from
read-only.
Block Data Type displays the name data type for variant pins on the currently
selected block.
Execution Order determines when the block is executed. Setting this property
automatically renumbers other blocks in this User Block. (Execution begins with
block zero and proceeds in increasing order.)
Show Description, when set to True, displays the description text for this block on
the diagram.
Top displays the location of the top of the block in the diagram.
Left displays the location of the left of the block in the diagram.
Version displays the version number of the source for this block instance read-only.
Block Help shows reference documentation on the selected block type in a help
window.
Show Description on Diagram toggles the display of description text for the
block. This text is the most effective way to document a block, as the text stays
attached to the block when the diagram is rearranged.
Edit Block Pins displays the Edit Block Connections dialog box.
Add Pin Group adds the next group of pins in a block with a configurable number
of inputs. For example, on a rung block, this would add the next available pin unless
all 16 are in use.
Remove Empty Pin Groups removes empty pins from the end of a rubber block.
This command does not remove empty pin groups in the middle of the block (for
example, pins A through D cannot be removed if Pin E is used).
Show Boolean Logic as Rung toggles the display of a rung block between a
rung diagram alone and a block containing a rung graphic.
Edit Ladder Logic displays the Rung Editor for a rung block.
Send to Front and Send to Back reorder blocks, causing them to appear above
or below all other blocks and shapes on the diagram when overlap occurs.
Creates a new
variable in the
user block.
Click a pin to
select it for editing.
In the Edit Block Connection dialog box, a prefix letter and a colon indicate the type
of connection. These prefixes allow the connection type to be specified just like the
option buttons on the Connect Pin dialog box, except prefixes can be typed quickly
and pasted from the clipboard. The following are valid prefixes:
Prefix Type
N: Number or Boolean value
E: Enumeration value
L: Local variable
G: Global variable
Select an option to
select a True or False
value for the variable.
Click here to send the Next Click here to invert the current
Value to the controller and value and immediately send it
close the dialog box. to the controller without closing
the dialog box.
Numerical Values
Displays the
current value of
the variable.
Enter a value to
be added to or
subtracted from
the variable.
Click to increase or Click here to send the Click here to send the Next
decrease the variable by the Next Value to the Value to the controller without
delta value and send the controller and close the closing the dialog box.
result to the controller. dialog box.
Double-click an element of
the array to display the
associated Send Value
dialog box.
The Variable Tool is only useful in Manual Layout mode as a way to clarify a
variable connection. It inserts a variable reference that can be wired to a block pin
and moved around freely. It is useful for creating diagrams that conform to specific
design standards. For example, all input and output variables could be drawn on the
left and right side of the diagram sheet, clarifying data flow for the user block. The
shape created by the variable tool has the following properties:
The Text Tool allows you to enter text anywhere on the diagram. While this tool is
useful in Manual Layout mode, the Description property of each block may be a
more appropriate way to add text when working in one of the two automatic layout
modes.
Filled, if set to True, causes the text shape to use the Fill Color as a background
color.
Fill Color displays the background color shown behind the text if Filled is set to
True.
Filled when set to True, causes the shape to be filled with the color specified in the
Fill Color property.
Fill Color displays the color the shape is filled with when Filled is set to True.
The Image Tool inserts a Windows Metafile (.wmf) or Enhanced Metafile (.emf)
into the diagram.
To use the Image Tool
Click the desired upper left corner of the shape, drag to the desired lower right
corner, and release the mouse button.Then, in the Browse for Image dialog
box, provide the path to the .wmf or .emf file that contains the image and click
OK. The image is added as a shape to the drawing.
Note The image file is not embedded in the diagram. All images must be distributed
separately from the .xml files for the diagram.
Metafile Path displays the path to the .wmf or .emf file containing the image that is
displayed.
Tip To ensure that images can be found when the diagram is moved on the hard
disk, avoid hard-coded path names or mapped drive names. Relative names, such as
..\Metafiles\bom1.wmf are best.
Tip You can have as many detached views as desired, which can be convenient for
moving pins from one drawing to another drawing.
Alignment Tools are available when multiple drawing shapes are selected (either
by drawing a selection rectangle around multiple shapes using the Pointer tool or by
holding the CTRL key while selecting additional shapes). The tool modifies the
location, width, or height of each shape to match the selected aspect of the primary
selected object (denoted with green selection handles). The Top, Bottom, Left, and
Right alignment tools affect location, while Width and Height adjust size. Arrange
Horizontal and Arrange Vertical equally space all of the selected shapes along the
Horizontal or Vertical axis.
Diagram Settings
The Diagram Settings dialog box contains options that change how the Diagram
Editor operates, as well as style options such as paper size. In most situations, these
settings are consistent across all diagrams in a system, but occasionally a particular
drawing may need custom settings. The diagram settings are arranged hierarchically
with system level settings in effect unless other settings are configured. These
settings can be overridden by the device or library settings, which take effect at the
Component Editor level. The user settings, saved on a per user basis, override the
device or library settings, and finally the diagram settings are saved per diagram and
override all other settings.
Diagram
User
Device or Library
System
For example, if the system settings specify the paper size as Letter, the library and
user settings specify Use Parent Setting, and the diagram settings set the paper size to
Legal, that diagram would be shown on legal-size paper while all other diagrams
would be shown on letter-size paper.
The Edit Diagram Settings dialog box allows you to edit the following options:
Landscape, when checked, makes the longest dimension of the paper, the
horizontal dimension, creating a drawing that is wider than it is tall.
Show Wired Pin Connection Text, when unchecked, hides the connection text
for wired pins, reducing clutter on the drawing.
Tip Selecting the Default to parent setting or a dimmed check box indicates that
you have no preference at the current level. The diagram uses the settings from the
next level down in the hierarchy.
The Rung block controls variable values using Boolean logic equations. While you
can specify a Boolean logic equation directly by connecting it to the EQN pin of the
rung block, a graphical RLD Editor is also available to simplify the process.
Contacts
1 Select the contact tool that matches the type of contact you want
to add. The mouse cursor changes to reflect the selected contact type.
2 Click a cell to add a new contact.
Wires
Wires are used to connect contacts to the coil and to each other.
To add a wire
Select the Wire tool , and then click a location on the grid.
Wires can only be drawn vertically or horizontally, as demonstrated below:
Up to 16 rows or columns can be added to the grid to provide enough space for large
logic diagrams.
To add or remove rows or columns
Drag the boundary between any row or column. Blue text will display indicating
the result of the action.
You can create rung diagrams in the RLD Editor that do not convert to compatible
Boolean logic functions. Typical errors include not connecting a contact to a
variable, creating a wire or contact that is not connected to power and ground, or
creating a short circuit. If you make one of these mistakes, text will display on the
status bar to help you resolve the error. (When the output equation is displayed on
the status bar, the diagram is correctly drawn and no errors are detected.)
Application Documentation
For documentation purposes, the ToolboxST application can print detailed
information about a component's entire configuration. However, if you select a
Program or User Block in the Software tab, only the selected item is printed.
Note In some locations, including Reports and the Block Diagram Editor, shortcut
menus contain commands that allow single pages or reports to be printed.
Page Options tab allows you Print Settings tab allows Print Profile tab manages
to change the paper size, you to change the saved print settings. It stores all
margins, and orientation. destination printer and its the settings from both the
associated settings. Options and Page Option tabs.
3 On the Product Version page, click Finish to accept the default library
version and optional libraries.
A new library container is added to the system and the Tree View updates to
reflect the change.
4 From the Tree View, double-click the Libraries item to open the Library
Editor.
From the
Libraries tab,
scroll to select
the Memory
Move category.
7 Save the library container by clicking the Save button on the toolbar and
close the editor by clicking the Exit button in the upper right corner.
When Specify Controller Information is selected, you must enter a Enter a Name for the new controller
Name for the new controller, then select the Application and Version. (up to 32 alpha/numerical
The default Application is General Purpose. The Version always characters).
defaults to the latest.
Select Upload from Controller if you do not have Click Next to continue.
the configuration for a particular controller, but know
its IP address. Enter the address in the IP Address
field.
4 Right-click the Programs item again and select Add Program from the
shortcut menu. The Add New Program dialog box displays.
6 Save the changes by clicking the Save button on the toolbar, and close the
editor by clicking the Close button .
3 Change the data type to BOOL by clicking the Type cell on the Attr1 row and
then selecting BOOL from the drop-down list.
Click OK to accept
the new value.
5 Save the changes by clicking the Save button on the toolbar, then close the
editor by clicking the Close button .
Right-click the
MOVE_2 block item
to display the block
shortcut menu and
select Add
Instance Script.
The block icon
changes to display
a blue S, indicating
that a script has
been added.
6 Save the library container by clicking the Save button on the toolbar, then
close the editor by clicking the Close button .
7 Open the controller component by double-clicking it in the System Editor.
8 Click the General tab. From the Tree View, select the Attributes item. From
the Summary View, click the Value cell of the Attr1 row, then click the
ellipsis button to display the Modify Value dialog box.
9 Change the value to True using the drop-down box, then click OK.
10 Click the Software tab. From the Tree View, locate the Prog1 item. If it is
collapsed, click the plus symbol to expand it.
14 Save the component by clicking the Save button on the toolbar, then close
the editor by clicking the Close button .
1 Open the System Editor for the test system created in the previous examples.
2 From the System Editor, open the Library Container Editor by double-
clicking the Libraries item in the Tree View.
3 From the Tree View, expand the item Lib1 and right-click the Lib1Usb1 user
block to display the shortcut menu.
4 From the shortcut menu, select Add User Attribute to display the Add New
User Attribute dialog box.
7 Change the Attr1_u data type to STRING by clicking the Type cell (which
currently contains UNDEFINED), then selecting STRING from the drop-down
list.
14 Save the library container by clicking the Save button on the toolbar, then
close the editor by clicking the Close button .
15 To see the text substitution in action, open the Component Editor for the
controller by double-clicking G1 in the System Editor.
16 Click the Software tab. From the Tree View, locate the Prog1 item. If it is
collapsed, click the plus symbol to expand it.
17 From the Tree View, right-click the user block Lib1Usb1, then select
Instance from the shortcut menu to update the user block. An Attributes item
is added to the Tree View.
18 From the Tree View, click the Attributes item. The attribute Attr1_u created
in step 5 displays in the Summary View.
19 Click the Initial Value cell of the Attr1_u row. Click the Ellipsis button to edit
the value, then enter the text ABCDEFG to be substituted. Click OK to close
the Modify Value dialog box.
21 To verify that the variable name substitution has occurred, click the Variables
item under the user block Lib1Usb1. The ABCDEFG_thing variable displays
in the Summary View.
22 Save the component by clicking the Save button on the toolbar, then close
the editor by clicking the Exit button .
The Component
InfoView displays
feedback information on
the currently selected tab.
Property Editor
The Property Editor allows you to view and edit the properties of the selected item.
Properties are named values associated with the selected item. The configuration
item displays in the left field and the value displays in the right field.
Click the Ellipsis button to change the value from a dialog box.
Click the drop-down list button to change the value from a drop-down list.
If no button displays, edit the value directly in the corresponding text box on the
right side of the Property Editor.
The Component InfoView contains several tabs that provide status information.
(Depending on the open component type, additional tabs may also be available.)
Log tab displays messages related to user commands or system events issued in the
ToolboxST configuration.
Tip If there is a build problem, the error is listed on the Log tab. Double-click the
error. The input focus goes to the location in the component configuration where the
error occurred.
Status tab displays operating state and equality information about the Mark* VIe
component.
History tab keeps a navigation history for each user session and allows you to return
to different places in the editor. Each time an item is selected in the Tree View or
Summary View, the name of that item is added to the top of this list.
Where Used tab tracks variables in the Tree View or Summary View and displays
all other places in the controller where they are used.
Tip From the Where Used tab, double-click the desired item. The input focus
goes to the view represented by that line and the item is selected.
The write icon that displays at the beginning of some lines indicates that the
variable is being written at that location.
Info tab displays context-sensitive descriptions for the selected Tree View or
Summary View item.
• Modify Data allows you to make changes to data values associated with an
object without changing how it works. For example, it protects the initial value
of a variable defined in a controller. The purpose of this right is generally to
keep unauthorized persons from making unsafe changes to settings.
• Modify Design allows you to change the way a protected object works. For
example, this protects block creation and editing of connections within a library
block diagram. The purpose of this right is to limit the ability to change how the
system works to authorized persons.
A protected object can have one or more of these access rights (refer to the section
Protected Objects). Each right can have a different password set. Some objects can
be protected if they are contained in another parent object, which is protected by its
own password(s).
Passwords
Whenever you attempt to perform an operation on a protected object, the Enter
Password dialog box displays.
Protected Location
indicates which object is
protected within the system.
Although some object(s)
may not be protected, the
object can be contained
within another protected
object. It is important to
know which object is asking
you to enter a password.
Note Passwords are case-sensitive – secret and Secret are not considered to be the
same password.
Password Caching
The security system caches passwords that were previously entered so that once you
enter a unique password, you don’t have to enter that password again. Separate
caches are maintained for the system and each major component (such as a Library
Container). A cached password remains until the component is closed.
Note From the Device menu, select Restore Password Protection to clear all
passwords and protect the component.
Tip If you have performed an operation in the ToolboxST application that requires
entering a password, it is recommended to close the protected component when you
are done so that an unauthorized user does not gain inappropriate access.
There are four possible status indications for each access right:
No password has been set on this object and none
is required
A password has been set on this object and has
not been entered
A password has been set on this object, but has
already been entered
A password has been set on this object’s parent,
but has not been entered
System can only have a Modify Design password. If present, it prevents you from
adding or deleting system components.
Device can have Modify Data and Modify Design passwords. Modify Data prevents
you from saving changes or changing initial values for variables defined in the
component's application software. Modify Design prevents you from modifying any
aspect of the hardware or software configuration for the component.
User Block Library can have passwords for all three access rights. They have no
direct effect on the block library, but are inherited by all block definitions within that
library.
User Block Definition can have passwords for all three access rights. If block
passwords are not applied, the passwords on the library container apply to the
definition.
User Block Instanced in a program can be given its own passwords for Modify
Data, Modify Design, or View Design. If none are assigned, it takes on the Modify
Data and Modify Design protection for the parent component. The passwords
assigned to an instance of some block in a user block library are initially set to the
passwords that were in force in the definition of that block. Once instanced though,
any changes to the protection on the block definition do not propagate to instances of
that block.
Note Some Data Grids, especially those without an Append Row, may not support
all features described in this chapter.
Row
headers
Currently
selected row
Append
row
Selected cell
Editing Data
To... Do this:
Add selected
column to the
data grid.
Move the
selected
column up or
down in the
Remove selected column order.
columns from the
data grid.
Remove all
columns from the
data grid.
Add a variable to a block diagram, Arrange windows on screen so both the source grid and a
Trender window or Watch Window destination block diagram, Trender window or watch window are
from a data grid visible. Then, drag the row header for the variable to the destination
window.
Tip You can copy and paste rows between different data grids if the columns
match by following the above procedures and navigating to a different data grid
before pasting the data.
Tip Cells in a data grid can also be copied to and pasted from Microsoft Excel. The
copied data is stored in .csv format, which contains no information about column
names. To make sure pasted data is placed into the proper columns, do not change
column ordering and always select the exact destination range in the ToolboxST
configuration before pasting data from Excel.
Property Editor
allows you
to edit the item
currently selected in the
Tree View .
The following properties are available in the Property Editor when the General item
is selected in the Tree View:
Frame Period determines the frame period in milliseconds. A frame is the basis for
Mark VIe scheduling; the frame period determines the fastest scan time, the rate at
which first class I/O is scanned, and the fundamental frequency for the scheduling of
all tasks.
Major Revision is the time of the build performed after the most recent major
change. (Major changes require the controller to be restarted after download.)
Name reflects the name of the current controller as set in the System Editor. It is
read-only in the Mark VIe Component Editor and must be changed from the System
Editor.
NTP Configuration Mode determines how the Network Time Protocol client
synchronizes the controller time. Valid options are:
Platform is the type of hardware on which the Mark VIe control code is executed.
Product Version is a read-only property that reflects the version of the Mark VIe
product associated with the selected component. The version number is set when the
configuration is first created and is updated with each Upgrade operation.
Profiler Enabled determines if the controller load profiler is enabled. This feature
is not yet implemented.
Modify Data permits modification of data values and the forcing of variables.
The name of
the attribute
being modified
The value of
the attribute
If checked, the
attribute values
are restricted to
an enumeration
(a predefined set
of allowable
values).
To add a value to the enumeration, enter the Name, The Data Type
Value, and (optionally) a Description, then click OK. of the attribute
When a Network Adapter item is selected in the Tree View, the following properties
display in the Property Editor:
Host Name is the Internet Protocol (IP) host name for the selected network adapter.
Network sets the network connected to the selected adapter. (Available networks
are determined in the System Editor.)
Subnet Mask controls which portions of the IP address are deemed significant.
(This property is usually unavailable; for I/O networks, the subnet mask is always a
fixed value, and for other networks defined at the system level, the subnet mask is
configured in the System Editor.)
Hardware Tab
The ToolboxST application manages I/O packs and terminal boards through a logical
unit called an I/O module. An I/O module consists of up to three I/O packs
connected to a main terminal board and (optionally) one or more auxiliary terminal
boards. The configuration is known as a simplex configuration when one I/O pack is
present, dual if two I/O packs are present, and TMR if three I/O packs are present.
(The configuration of module redundancy is independent of the network redundancy
and controller redundancy settings.)
To help with identification and version management, each I/O pack has an I/O
compatibility code and a configuration compatibility code. These codes identify the
I/O map layout and the configuration area for a pack. For each compatibility code
set, there are multiple hardware forms used to identify physical characteristics of the
pack. Each I/O pack module that can be added to a Mark VIe controller is identified
by both its hardware form factor and its compatibility codes. For example,
PDOA_2_2 represents the discrete output module with I/O compatibility code 2 and
configuration code 2.
Click Next.
Note If the module being added does not have an auxiliary terminal board, the
window shown below will not display.
Click Next.
the mouse pointer changes to a symbol, release the mouse button to move
the module.
Special Modules
Calibrating PSVO Valve Circuits
PSVO valve calibration allows you to configure the valve circuits of the PSVO
module I/O pack. The Calibrate Valve dialog box provides an automated sequence
as well as a verification mechanism to configure and maintain PSVO values for each
valve circuit.
8 Click the Calibration Mode button to enable all command buttons and to start
the calibration command in each I/O pack. A Trender window displays dynamic
signals.
Note Do not make any changes to the regulator configuration during valve
calibration. Each calibration command is monitored by the ToolboxST application to
verify performance.
1 Click Minimum End to stroke the actuator to the minimum end position.
2 Click Fix Minimum End to read the voltage at the minimum end position.
3 Click Maximum End to stroke the actuator to the maximum end position.
4 Click Fix Maximum End to read the voltage at the maximum end position.
5 Click Calibrate to use the calculated values.
6 Click Save to save the calculated values.
Note Only one command state can be active at any one time.
The calculated values are saved to the application code area of each I/O pack, and to
the current configuration loaded in the ToolboxST application.
Verification Commands
Verification commands, which are not performed in any sequence, are as follows:
Note LVDT Voltages are the values that represent the minimum and maximum
actuator positions stored in the I/O pack. These values are not live data. They display
after the Save button is selected.
PROFIBUS
The PROFIBUS master gateway (PPRF) is a PROFIBUS DPV0, Class 1 master that
maps I/O from PROFIBUS slave devices to Mark VIe controllers on the I/O
Ethernet. There are two redundancy options:
Note Only one I/O pack can be actively communicating with its associated
PROFIBUS network.
Select the
module type.
Click Next .
Click to view
information about
the currently selected
module version.
Click Next.
Note The GSD Manager is not available until a PPRF module has been added.
Slave device
Slave Device
view
Note Any changes made in the PROFIBUS Network tab cannot be undone through
the ToolboxST Undo option under Edit.
If a change is made,
click the Apply
button, then click
OK to return to the
Hardware tab.
Click to enable
Watchdog Control,
which allows this device
to enter fail-safe mode if
an error occurs. The
Interval is the time period
that elapses before fail-
safe mode. The default
time interval is 200 ms.
Click theOK
button to return
to the Hardware
tab.
5 From the Tree View, click the Parameters item to configure parameters for
this module.
Select a
parameter,
then use the
drop-down
list to set
the value.
Click the OK
button to
return to the
Hardware
tab.
For descriptions of
values, click the
Help button.
8 From the Tree View, click the DPV1 item to display the screen below.
Click the OK
button to return to
the Hardware tab.
For detailed
information, click
the Help button.
10 From the Tree View, click the GSD item to display the contents of the GSD
file(s).
Select a master
device profile from
the drop-down list.
Bus Parameters
displays PROFIBUS
network properties.
Bus Monitoring
displays how the
PROFIBUS network
will be monitored by
the gateway.
Note If any changes are made to the master device configuration and the OK button
is clicked, the pack must be restarted after the controller and the pack are
downloaded.
PROFIBUS slave
addresses are
changed here.
The Variables data grid displays the PROFIBUS configuration, which is defined as a
number of module input and output bytes or words. By default, slave inputs are
followed by slave outputs. Successive rows may be grouped as necessary to create
actual point values that span multiple rows. Packed Boolean values are expanded
into a separate data grid as shown so that Boolean MarkVIe variables can be attached
to the individual bits.The Variables tab contains the following columns.
Fieldbus Point Data Type displays the data type of the slave device I/O point. If
the size of the point spans multiple rows of input or output bytes or words,
subsequent rows display Continued. The default byte data type for rows associated
with configuration bytes must be changed to a supported data type shown in the table
below.
Note The Direction, Module, and Fieldbus Point Offset columns are read-only.
Raw Min, Raw Max, Eng Min, and Eng Max are values used to calculate scaling
from raw units (the PROFIBUS point) to engineering units (the MarkVIe variable).
Boolean transfers are expanded into individual bits, and displayed in the Booleans
tab below the Variables tab.
Input Event Enabled, if set to True, enables input event scanning on a Boolean
transfer.
PROFIBUS Diagnostics
To display diagnostics
If any PROFIBUS device causes a diagnostic, the ProfibusDiag variable will have
a value of True. For applications that require diagnostic support, attach a defined
variable to the ProfibusDiag.
Note The system must be running, and the ToolboxST application must be able to
connect to the Mark VIe component.
Viewing Modules
Group Layout
When you select a module from the Tree View, several tabs display in the Summary
View. Each module contains four common tabs (Summary, Parameters, Variables,
and Diagnostics). Many modules also contain custom tabs that configure available
I/O capabilities. For information about the settings configured by I/O pack-specific
tabs, refer to the I/O pack documentation.
For example, the following set of tabs (taken from a PDOA module) contains the
base set, as well as two other tabs, Inputs and Outputs.
Parameters Tab
The Parameters tab allows you to configure all module-specific parameters. After a
parameter is changed, updated psuedocode files must be downloaded to the I/O
packs, but the download operation is done online and does not require a reboot of
either the controller or the I/O packs.
Note Some infrequently used parameters are classified as Advanced and are hidden
by default. To display Advanced parameters, click the Show/Hide Advanced
button on the toolbar.
The Variables tab displays available variables from the module that have no physical
endpoint. These variables exist only internally in the module, and can be connected
to another variable for use in code.
Inputs/Outputs Tabs
This tab contains I/O points (with associated screws in sub-tabs) that have no
meaning to software or firmware, such as those used for excitation.
ExtraCircuits Tab
This tab contains input/output variables found on the module terminal boards, which
can be associated with the application software. For some modules, these tabs are
split into more module-specific input/output tabs that better define their function.
Diagnostics Tab
The Diagnostics tab allows you to check the I/O pack alarms and errors that exist on
I/O packs. Each pack has a unique set of diagnostic signals that can be monitored.
For more information about the fault codes used in an I/O pack, refer to the
Diagnostics section of the I/O pack documentation.
The state
of the fault.
Active Alarm(s)
The Status tab allows you to check the I/O pack version and network communication
status.
Working Online
Downloading Parameters
After modifying parameters in a module, you must download to the module before
the new settings take effect. Downloads to a module are separate from downloads to
a controller.
To download parameters to a module
From the Hardware tab Tree View, right-click the module to be downloaded
and select Download Parameters.
The I/O Diagnostic viewer provides a utility to interrogate I/O pack faults, version,
and diagnostic communication data. Diagnostic I/O pack reports can be generated on
a pack, module, or component level.
Normal
Active Alarm(s)
Note Place the mouse over the icon to display detailed messages regarding the
problem.
Software Tab
The Software tab in the Component Editor contains all application software
downloaded to that controller.
Programs Item
The Programs item holds all programs in the controller. Its shortcut menu contains
actions that affect all programs, such as changing library references and instancing
all linked user blocks. The shortcut menu also contains commands to add a new or
existing program to the controller.
• Function block libraries that describe software that comes as part of the
controller firmware
• User block libraries that combine these function blocks into user blocks
To reference a user block library
1 From the Tree View, right-click the Programs item, then select Library
References. The Library References dialog box displays all block libraries
in two tabs.
2 From the User Block Libraries tab, select the check box next to libraries that
you want to reference in this controller. Clear check boxes for libraries that
should not be referenced.
Instance All
The Instance All command creates a new copy of all linked user blocks from the
referenced user block libraries. In addition to updating the user blocks, this command
causes the instance scripts and text substitutions to run.
Note The Add Task and the Add User Block dialog boxes are identical except for
the title bar, which shows how the new user block is used.
A user block can either be linked from a user block library, or embedded, acting as a
container for function and user blocks.
Instancing a user block updates it to the latest version from the user block library.
Embedded and unlinked user blocks are disconnected from the library, so instancing
goes through the blocks in that user block and instances the linked user blocks.
To instance a user block
The Programs Property Editor has two properties that control how instancing works.
Preserve control constant initial values, if set to True, allows the Initial Value
property of a variable that is a control constant to be modified at the instance and not
overwritten when re-instanced.
Remove Unused Variables removes the unused variables for all linked user
blocks in this device when the user block is instanced.
The Program Property Editor allows you to edit the name, description, and execution
order of the program selected in the Tree View.
Description allows you to describe the program. Click Description and then click
to enter text.
Execution Order sets the order of execution of this program in the controller.
BlockType is the name of the user block definition in the library from which this
user block started.
Protection expands to show the access rights for this user block definition.
Frame Multiplier is the number of frames at which the user block runs.
Schedule Offset is the offset from beginning of frame at which the user block
runs.
Block Data Type is the data type for variant pins on this block instance.
Instance Script causes the script to run when the block is instanced.
User block and task variables are local by default, and display under the associated
user block item in the Tree View.
Variables can be edited in the Data Grid and Property Editors. The Data Grid is used
to view or edit variable definitions, and can be configured to display a subset of the
variable properties. Refer to the section, Data Grids.
Note Variables can also be added in the Summary View by directly editing the last
row of the variable grid.
Alarm, if set to True, enables the variable as an alarm. Alarms are used for problems
that require the operator’s attention and acknowledgement. The alarm queue consists
of a list of time-tagged alarm state transitions.
Alarm Class selects a System Configured Alarm Class, used by the HMI to
classify and colorize alarms.
Alarm On Zero, if set to True, causes the alarm on a 1-to-0 transition. Requires that
the Alarm be set to True.
Event, if set to True, enables the variable as an Event. Events are stateless messages
that are not queued within the controller. When an event occurs, a time-tagged
transition message is sent to any HMIs that have signed up for events.
Hold, if set to True, enables the variable as a Hold, which is similar to an alarm. The
hold queue contains a list of time-tagged hold states in the turbine startup sequence.
Display High Limit is the default upper limit for displays on the HMI (for
example, bar-graph or trending displays). If a Format Spec has been specified and
this display-high attribute is not specified, the Format Spec Engineering Max is used.
Display Low Limit is the default lower limit for displays on the HMI (for example,
bar-graph or trending displays). If a Format Spec has been specified and this display-
low attribute is not specified, the Format Spec Engineering Min is used.
Entry High Limit is the default upper limit for setpoint entry on HMI (for example,
bar-graph or trending displays). If a Format Spec has been specified and this entry-
high attribute is not specified, the Format Spec Engineering Max is used.
Entry Low Limit is the default lower limit for setpoint entry on HMI (for example,
bar-graph or trending displays). If a Format Spec has been specified and this entry-
low attribute is not specified, the Format Spec Engineering Min is used.
Precision determines the number of digits to show to the right of the decimal point.
This is the default for precision when displaying the number on HMI. If a Format
Spec has been specified and this precision attribute is not specified, the Format Spec
Precision is used.
Units are engineering units. If a Format Spec has been specified and this Units
attribute is not specified, the Format Spec Units is used. If you are using the SDB
version of the HMI device, this attribute is not used. Only the format specification's
Units string is used.
Full Name is the fully qualified name of the variable. For example, a variable name
gas_fuel_opt in a user block named Config under the Program CORE would have a
full name of CORE.Config.gas_fuel_opt.
Initial Value allows array length, data type, and enumeration editing.
EGD Page is used to assign the variable to an Ethernet Global Data Page. Enter the
name of the EGD page to which this variable belongs.
Global Name Prefix is the variable's global name prefix type (None, Full, Block,
Program, Task). This controls the form of the global name that displays on the EGD
page. For example, the name for variable IGVA in user block VG_Health in task
Task1 in program CORE would display (depending on the Global Name Prefix) as:
None IGVA
Full CORE.VG_Health.IGVA
Block VG_Health.IGVA
Program CORE.IGVA
Task Task1.IGVA
Scope is the variable's scope (Global, Local.) If a variable is local, it can only be
used in the program or user block in which it is created. If it is global, it can be used
in other programs and user blocks. A variable must be global to be used on EGD.
Output pins are shown on the right side of the user block.
State pins are shown on the right side of the user block.
Virtual HMI Point, if set to True, imports the variable into the HMI as a virtual
point.
Tables with a single independent array are sometimes called univariant tables and
consist of X and Z linear arrays of the same length. Tables with two independent
arrays are sometimes called bivariant tables and consist of X and Y linear arrays and
a Z two-dimensional array. Bivariant table definitions display in the Summary View
as follows:
Program Variables
Program variables are global variables associated with a particular program. The
variables display under the Programs item in the Tree View. Undefined variables for
a program are global variables that have been referenced in a controller, but have not
been defined as part of a program or user block.
To add a variable to a program
1 From the Software tab, expand the Programs item.
2 Enter the new variable name in the Add New Variable dialog box and click
OK. The new variable is added to the list in the Summary View.
Note Variables can also be added in the Summary View by directly editing the last
row of the variable grid.
The Property Editor allows you to edit the name, description, and execution order of
the program selected in the Tree View.
Description allows you to describe the program. Click Description and then click
to enter text.
Execution Order sets the order of execution of this program in the controller.
Summary View
The Summary View displays all user blocks and associated scheduling information
in that program. The Frame Multiplier and Schedule Offset fields can be changed
from this view (see below). The available columns are as follows:
Frame Multiplier is the number of frames at which the user block runs.
Schedule Offset is the offset from beginning of frame at which the user block
runs.
Period, in milliseconds, is the period at which this user block runs. Calculated by
multiplying the frame multiplier by the controller’s frame period, which is set on the
General tab.
Note Since the schedule offset depends on the frame multiplier, it is possible to
select a frame multiplier for which the current schedule offset is invalid. This will
cause a validation error when you build the application.
User Block
The user blocks of a controller program display in the Tree View below the
Programs item under tasks, or other user blocks.
User Block
Instancing a user block updates it to the latest version from the user block library.
Embedded and unlinked user blocks are disconnected from the library, so instancing
goes through the blocks in that user block and instances the linked user blocks.
User block variables are considered local to a user block, and display under the
associated user block item in the Tree View. The variables can only be modified if
the user block is either embedded or unlinked, and not locked with password
protection. Undefined variables for an embedded or unlinked user block are local
variables that have been referenced in the user block.
To add a variable to a user block
1 From the Software tab, expand the User Block item to display the Variables
item.
2 Enter the new variable name in the Add New Variable dialog box and click
OK. The new variable is added to the list in the Summary View.
Note Variables can also be added in the Summary View by directly editing the
append row of the variable grid.
User block attributes only display on linked or unlinked user blocks whose user
block definition contained attributes in the library. They can be modified so that
when their parent user block is instanced, the modified attributes are used in the
scripts and text substitutions that access them. Refer to the section, Working with
User Blocks.
The Property Editor for a user block displays slightly different information
depending on whether it is a task or just a user block inserted under another user
block. Tasks contain scheduling information, but a user block contained within
another user block does not.
BlockType is the name of the user block definition in the library from which this
user block started.
Protection expands to show the access rights for this user block definition.
Frame Multiplier is the number of frames at which the user block runs.
Schedule Offset is the offset from beginning of frame at which the user block
runs.
Configuring DDR
To configure a DDR
From the System Editor, double-click the Mark VIe Component. The
Component Editor displays.
Appearance
Name is the user-defined description for this DDR, which is used for the filename.
DataRecorder Setup
Auto Enable, if set automatically, enables the capture buffer, then re-enables it 60
seconds after it is uploaded.
Normal causes the DDR to collect pre-samples before a trigger event and
thereafter continue collecting until Enable transitions False or the collection fills
the buffer.
Circular causes the DDR to collect data indefinitely until Enable transitions
False. The buffer will be filled with the newest samples. No trigger is used.
Only causes the DDR to evaluate the trigger each execution and only collect data
when the trigger condition is satisfied. Data will be collected until Enable
transitions False or the collection fills the buffer.
Frame Period Multiplier extends the sampling period by this multiple. The base
sampling period is the frame period.
Post Trigger Samples are the number of samples collected after the trigger
including the trigger sample.
Pre-trigger Samples are the number of samples collected before the trigger.
Setup Variables
Trigger Setup
EQ is the value of the trigger variable, which must be equal to the trigger value.
GT is the value of the trigger variable, which must be greater than the trigger
value.
GE is the value of the trigger variable, which must be greater than or equal to
the trigger value.
LT is the value of the trigger variable, which must be less than the trigger value.
LE is the value of the trigger variable, which must be less than or equal to the
trigger value.
NE is the value of the trigger variable, which must not be equal to the trigger
value.
Trigger Comparison Value is the value compared to the value of the trigger
variable to determine the presence of a trigger. For Boolean trigger variables, the
only valid values for the trigger value are 1.0 for TRUE and 0.0 for FALSE. Note
that if an analog trigger variable of a different data type is configured, it may be
possible to specify a trigger value that cannot be exactly represented by the trigger
variable. Users should be aware of this limitation when specifying the EQ trigger
condition.
Trigger Type
Adding Variables
Variables can be added to a DDR. When a trigger occurs, these variables are
collected by the buffer and are subsequently uploaded by the Recorder and/or
Trender. Each variable is sampled for the total number of samples configured. This
means that if the DDR is set up to record 100,000 samples with three variables
assigned, 300,000 items will be acquired. Up to 96 variables can be assigned to each
DDR.
Note There is a 12 MB size limit on the memory that can be allocated to the DDRs.
If this memory allocation is exceeded, an error is reported during validation.
To add a variable
1 From the Component Editor, select the Dynamic Data Recorders tab to
display the DDR list.
Updating DDR
DDRs are updated separately from the application code download.
To update a DDR
1 From the Component Editor, select the Dynamic Data Recorders tab and
click the desired DDR.
2 Click the Build button.
3 From the Device menu, select Download, and then select Update Dynamic
Data Recorder. Or, click the Update Dynamic Data Recorder button
2 From the Import File dialog box, select the .xml file that corresponds to the
DDR you wish to import. Click Open.
Note If the .xml file being imported contains the formatting flags %n, it is replaced
by the Mark VIe component Design Memo (DM) number. This is a GE Power
Systems project number and can be edited by selecting the General tab and
Requisition Info.
5 Create a User Block in the program, and add two FuncGen blocks. These are
in the Data Collection section. Set up the pins on the two blocks as shown
below. FuncGen1 is set up as a Sine wave generator and FuncGen2 is set up
as a Triangle wave generator.
11 Set the value of the DDRTrigger variable equal to or greater than 5, then send
to the controller. The status indicates the Capturing state.
12 The Trender is used to upload the capture buffer. From the View menu, select
Trenders to add a new trend. The Trender window displays.
EGD Configuration
To configure EGD for a controller
1 From the System Editor, double-click on a Mark VIe component to display
the Component Editor.
2 From the Component Editor, select the EGD tab.
3 In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.
The following properties display in the Property Editor when Ethernet Global Data is
selected in the Tree View:
Collection controls the Collection to which this EGD component belongs when
viewed in the EGD management tool (EMT). This information is published to the
EGD Configuration server in the GUI component document, GUIDevice.xml.
Producer ID sets and displays the EGD Producer ID for this component. This is
assigned when the component is created. The Property Editor displays the EGD
Producer ID formatted as an unsigned integer, but dotted and hexadecimal
representations are available by clicking the ellipsis button.
Produced Pages
Produced Pages are data samples configured to be available to other components on
the network.
To add a new Produced Page
1 From the Tree right-click the Produced Pages item, and then select Add
Page.
2 Enter a unique name for the new page in the Page Name dialog box and select
OK.
Note When the first Produced Page is created, it automatically becomes the Default
page.
Tip Any variable defined with $Default as the EGD page name will automatically
be placed on the currently selected Default page.
To delete a page
From the Tree View, right-click the page you wish to delete and select Delete.
The following properties are available for configuration when a Produced Page is
selected in the Tree View:
Mode, when set to Broadcast, sends the page to all EGD nodes. When set to
Unicast, the page is only sent to a single destination.
Default Page can be set to True if the selected page is the Default Page. To change
the default page, refer to the section, Produced Pages.
Layout Mode, if set to Auto, automatically assigns exchange numbers and offsets
assigned at build time. If set to Manual, exchange numbers and offsets can be
entered manually.
Minimum Length sets the minimum length of the exchanges on this page. Some
components look only at the length of the exchange. This property can be set to a
value larger than the current size of the exchange so that as variables are added, the
component continues to receive the exchange.
Period Multiplier multiplies the value by the Controller frame period to obtain the
EGD page period. (The results display in the Period property.)
Skew is used to prevent exchanges with the same period from being produced at
exactly the same instant. The skew for the first exchange in the page is set to this
value, and each additional exchange skew differs from the previous exchange’s skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchange’s skew is two, the second exchange’s skew is four and
the third exchange’s skew is six. (The skew property is measured in nanoseconds.)
Starting Exchange ID is used for the first exchange on this page. Each additional
exchange will be incremented from this number. When this property is changed, all
exchanges are renumbered.
Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.
Variables
To add a variable to an EGD page
1 From the Component Editor, select the EGD tab.
2 From the Tree View, right-click the desired page, and then select Add
Variable to display the Variable Browser.
Note To edit exchange signatures and configuration time, set Layout Mode to
Manual.
3 Review the warning about manual Exchange Signature editing, then click
OK.
4 Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.
Due Time is the time that a consumer data packet must be received for an exchange
to remain valid
Missed Count is the number of data production packets missed since initialization.
A missed packet occurs when a data production message is received that has a
request ID greater by more than one than the last message received (accounting for
counter roll-over).
Refresh Errors are the number of times a refreshment fault has occurred. A
refreshment fault occurs when a subsequent data production packet (or initial packet
at startup time) does not arrive at a consumer within a pre-defined update period.
Note The EMT provides a detailed view of the configuration server contents.
The Filter Toggle button defaults to a filtered state. It displays nodes that have
the same name but have a different Producer ID as the open component.
The Delete button deletes the selected node or nodes. If the nodes were saved
as part of the configuration, they can be added again.
The EGD configuration server uses the producer ID to store all the documents for an
EGD node. If you open two systems, then point to the same configuration server and
save a device of the same name with two different producer IDs to that server, you
can end up with two producer ID nodes with the same device name.
The Referenced Devices item on the EGD tab also has a Compare command that
compares the consumed variable information for the open component against the
EGD configuration server’s content.
Referenced Devices
The EGD variables defined in other components can be added to the current
component’s variable list by adding a reference. References can only be created to
EGD-capable devices that are producers of pages.
To select referenced devices
From the Tree View, right-click the Referenced Devices item, and then
select Select Devices to display the Select Devices dialog box.
Note When EGD configurations are edited in remote devices, you must refresh the
configuration to ensure that the latest variable information is used.
This feature can be implemented using the existing controller (referred to as Mark
VIe integrated Modbus) or an additional controller (referred to as Mark VIe gateway
Modbus).
Using the existing controller allows for a direct Modbus interface, but would expose
the controller to the extra loading and burden of serial interrupts when serial
communication paths are needed. Because a serial interrupt is critical, the Modbus
slave feature supports both serial and Ethernet/TCP capability on Mark VIe gateway
Modbus, while only Ethernet/TCP capability is supported on Mark VIe integrated
Modbus.
Mark VIe gateway Modbus is always run in simplex controller mode without
sequencing blocks.
Modbus Overview
Ethernet
Connection Timeout specifies the time in minutes that the slave remains
connected to the master over Ethernet when no requests are being received. The valid
range is one to 10.
Interface
Shared (both Ethernet and serial) is only supported on Mark VIegateway Modbus.
Baud Rate specifies serial communication rate (bits per second). The valid choices
are 2400, 4800, 9600, 19200, 38400, and 57600.
Data Bits specifies number of bits per character. Only eight bits is supported.
Parity specifies check character. The choices are None, Odd, Even, Mark, and
Space.
Station specifies the slave address associated with the serial port. The valid range is
1 to 255.
Stop Bits specifies serial stop-bits. The valid choices are 1 and 2.
Command Limit limits the number of commands processed per second. This is
based on commands that have changed, not commands that are identical to
previously received commands. The valid range is 0 to 25.
Data Swapped changes the transmission order if the data is greater than 16 bits
when set to True. Refer to the example below.
Settings Example
If set to True 32-bit example: 0x01234567 would be transmitted as 0x45 0x67 0x01
0x23
64-bit example: 0x0123456789ABCDEF would be transmitted as 0xCD
0xEF 0x89 0xAB 0x45 0x67 0x01 0x23
If set to False 32-bit example: 0x01234567 would be transmitted as 0x01 0x23 0x45
0x67
64-bit example: 0x0123456789ABCDEF would be transmitted as 0x01
0x23 0x45 0x67 0x89 0xAB 0xCD 0xEF
NAK Code specifies the Negative Acknowledge code to be used if data is requested
from a controller that is incapable of receiving the Modbus request. Code options are
4, 6 or None. None is selected only if the master needs no reply when
communication fails between the Mark VIegateway Modbus and the target
processor.
The Modbus Slave tab contains four pages that are used to exchange data with a
Modbus Master. The pages differ by the access the master receives to the data (read-
only or read/write) and the type of data (a Boolean or a 16-bit word) as follows:
Data Types
The ToolboxST application allows you to specify the variables on each page using a
Data Grid. When you add a variable to a page, both the Modbus slave and the
selected page are enabled on the controller. As you add and remove variables, the
controller is updated so that only pages containing variables are enabled. To
completely disable the Modbus slave, remove all variables on all pages or select
None as the Interface in the Property Editor.
Connected Variable is the variable that is read or written from the device or the
referenced device. A variable must be on an EGD page before it can be added to a
Modbus slave page. A connected variable must be added before the other columns
become active.
Point Data Type determines the variable data type and the registers used to
transmit the variable data over a Modbus connection as follows:
• BOOL is one bit of a 16-bit word. (This is the only option if the connected
variable is a BOOL.)
• INT is a signed 16-bit word that takes one register
• UINT is an unsigned 16-bit word that takes one register
• DINT is a signed 32-bit word that takes two registers
• UDINT is an unsigned 32-bit word that takes two registers
• REAL is a signed 32-bit float that takes two registers
• LREAL is a signed 64-bit float that takes four registers
Address specifies the register address. When a variable is created, the address is
automatically set to a value adjacent to the highest address previously on the page,
but the automatic value can be modified. Any data types that are 32 bits or more
(DINT, UDINT, REAL, and LREAL) should be placed on odd addresses. The valid
range for addresses is 1 to 65534. When specifying an address for a BOOL variable,
the bit 0-15 within the 16-bit word is represented by a decimal. For example, 1.00
selects register address 1 and bit 0, and 10423.7 selects register address 10423 and
bit 7.
Name is a read-only identifier automatically generated from the register page name,
the address, and, if necessary, an added unique number.
Creating Reports
To create a report
Open a Mark VIe Component Editor. From the View menu, select Reports,
then select the desired report type from the drop-down list. Refer to the section,
Report Types. The I/O Report displays in a new window.
Viewing Reports
To change the zoom level of a report
From the Report View menu, select Zoom, then select the desired zoom value
from the submenu.
The report filter feature applies rules to a report to display a specific subset of the
original report.
To apply a report filter
From the Report window, select the Report menu, then click Apply Filter to
open the Edit Report Filter dialog box.
Lists available
comparison and
Boolean operators
(double-click an
operator to add it to
Lists available the equation).
columns (double-
click a column to
add it to the
equation).
Click to add
parentheses to
your equation.
In this box,
enter the filter
equation to be
used.
Click OK to accept the Click Clear to erase the Click Cancel to cancel the
filter equation as shown. current filter equation. equation without changing
the current filter settings.
• When using the LIKE operator, you must include a wildcard * at the beginning
and/or end of the right-hand value. For example, [Day Name] LIKE ‘T*’
would select Tuesday and Thursday.
• You can use as many groups of parentheses as necessary to define an
expression.
• Any string values must be enclosed in single quotes: 'string'
To remove a report filter
From the Report window, select the Report menu, then click Remove Filter.
The filter is removed and all available rows display.
The report Find feature allows text searches to be performed within the report.
To find text within the report
From the Report window, select the Report menu, then click Find to display
the Find dialog box.
If selected, the
capitalization in the
report and the
search string must
exactly match.
The Mark VIe component supports automated importing of data from a previously
generated I/O report.
Global Variables
The Global Variables window displays all controller variables that have been
configured as Global in one central location.
To display the Global Variables window
Open a Mark VIe Component Editor. From the View menu, select Global
Variables.
The Global Variables window is particularly useful when you want to modify a
property for multiple variables. For example, to move multiple variables onto an
EGD page, select the rows for the desired variables and then change the EGD Page
property in the Property Editor. Refer to the section, Data Grids.
Because only existing global variables can be changed, new variables cannot be
added from the Global Variables window. You cannot make any change that affects
the name of the global variable (like Name or Global Name Prefix). Finally,
variables from an instanced library user block can only be modified if the Merge
Variables at Instance property of the Programs item on the Software tab is set to
True.
Double-click a
name in the list to Click to access the
open an existing selected Watch Window.
Watch Window. Click to create a new
Watch Window.
Note If this is the first time the Watch Windows dialog box has been opened for the
selected component, the list will be empty. Create or import a new Watch Window.
Managing Variables
Once a Watch Window is created, variables can be managed with the following
commands.
• A block pin from the Block Diagram Editor, and drop it into a Watch Window.
• A variable in the Watch Window to a block pin on the Block Diagram Editor,
forming a connection.
• A variable from one Watch Window to another Watch Window, copying the
selected variable into the target window.
A Watch Window can be saved to an xml file, which can then be imported into
another components. This allows you to use a previously selected collection of
variables.
To export a Watch Window to an .xml file
1 In the Watch Windows dialog, select the desired Watch Window, then click
the Export button.
2 The Export Watch Windows dialog displays. Select the desired destination,
then click Save.
All control constants display in the Control Constants window, where the constants
can be reviewed and the Initial Values can be modified.
To display the Control Constants window
Open a Mark VIe Component Editor. From the View menu, select Control
Constants.
NAME,VALUE,TYPE,UNITS,DESCRIPTION,FORMAT SPECFICATION
ControlConstant3,6.234,REAL,,,
ControlConstant2,55,DINT,,,
ControlConstant6[0],true,BOOL,,,
ControlConstant6[1],false,BOOL,,,
ControlConstant6[2],true,BOOL,,,
ControlConstant6[3],false,BOOL,,,
ControlConstant6[4],true,BOOL,,,
ControlConstant4,8769.876,LREAL,,,
ControlConstant5[0],20.1,REAL,,,
ControlConstant5[1],23.2,REAL,,,
ControlConstant5[2],34.5,REAL,,,
ControlConstant5[3],40.6,REAL,,,
ControlConstant5[4],55.5,REAL,,,
ControlConstant1,1,BOOL,,,
The Mark VIe component is used for control, protection, and monitoring of turbine
and driven load equipment. Vital subsystems, such as servo control, vibration
protection, and synchronization are embedded in the I/O with on-board processors to
optimize performance.
The ToolboxST configuration is the maintenance software tool for Mark VIe
components. The system has a CompactPCI controller with networked I/O. The I/O
processors are located on the terminal boards instead of in centralized board racks.
This configuration digitizes the signals on the terminal boards, which can be
mounted local or remote, individually or in groups.
Connecting to a Controller
Many actions in the Mark VIe Component Editor require an active connection to a
controller.
To connect to a controller
From the System Editor, open a Mark VIe Component Editor. From the
Device menu, select Online or from the System Editor, open a Mark VIe
Component Editor. From the toolbar, click the Online button.
If you are connecting to a simplex controller, a connection is automatically
established with the R controller. In a dual or Triple Modular Redundant (TMR)
configuration, a dialog box displays to select either a redundant controller (either R,
S, or T) or the controller currently designated as the supplier of initialization data.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-1
Status Tab
When the ToolboxST application is connected to a Mark VIe component, operating
state and equality information is available from the Status tab of the Component
InfoView window. When used in a redundant controller configuration, the status is
shown individually for each controller in the redundant set.
Color Conditions
Green All controllers functioning normally.
- Control state is controlling
- Controller Equality equal
- DDR Equality equal
Yellow One or more of the following:
- Control state not controlling
- Controller equality not equal
- DDR equality not equal
- Frame Idle time < 20%
Red One or more of the following:
- Control state is failed
- Controller equality has a major difference
5-2 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
The following example displays the unequal state for a dual redundant control. The
DDR Equality attribute text is orange to indicate that DDR Equality is not equal, and
the Controller Equality attribute text is red to indicate that a major difference exists.
Since the Controller Equality attribute takes precedence over the DDR Equality
attribute as indicated in the above table, the Status tab is red.
Controller Attributes
Control State indicates the current state of the controller. When a controller is turned
on, it transitions through several states before arriving at the normal controlling state.
Valid Control States are as follows:
State Description
Powerup Power up controller
Master initialization Initialize controller
Designated controller determination Determine which controller is designated in a redundant controller
configuration
Data initialization Perform initialization of non-designated controllers with NVRAM,
command variables, and constants
Inputs enabled Wait in this state for all required I/O packs to start transmitting inputs
Input voting Check voting inputs prior to execution of application code
Exchange initialization Populate redundant controllers with dc state variables prior to voting
Exchanging Exchange state variables so that a controller joining a running system
won’t have a step in its initial calculations
Sequencing Turn on the application code and execute each task at least once
before driving outputs
Controlling Turn on outputs
Loading Online load is in progress
Load complete Online load has finished. Wait for re-synchronization of redundant
controllers
Fail Failure has occurred.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-3
If the indicated Control State is not Controlling, the ToolboxST application can
provide additional information as follows:
DDR Equality indicates whether equality exists between the Dynamic Data
Recorder configuration in the ToolboxST application and the configuration currently
running in the controller. Valid states are Equal and Not Equal.
Frame Idle Time is the percentage of CPU time left in the controller after the
critical control functions of input, compute, and output have been completed. If there
is less than 20% idle time, the status is shown in yellow.
System Idle is the percentage of CPU time left in the controller after all functions
have been completed. It accounts for the critical control functions, as well as
background processing and toolbox communication overhead.
Heart Beat indicates whether the controllers are exchanging the Control state
variables. If the number shown is incrementing, the Control state variables are being
exchanged.
5-4 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
Downloading to a Controller
The ToolboxST application is used to configure both a Mark VIe component and its
distributed I/O modules. Both the component and the I/O modules have four items of
software that can be downloaded:
Boot Loader starts the operating system for the controller and modules, much like
the BIOS on a desktop computer. Changes to the boot loader are very infrequent.
Base Load contains the operating system for the controller and I/O modules. While
changes to the base load are more likely than changes to the boot loader, they still
occur infrequently.
Firmware provides the functionality of the controller and I/O modules. It can be
updated over the lifetime of the controller to incorporate new features and bug fixes.
Download Command
The Download item in the Device menu displays a submenu of commands. Besides
the Controller Initial Setup and Download Wizard commands, the following
commands are available:
Controller Flash Boot Loader is used to install the controller's boot loader on a
CompactFlash™ memory card. To use this command, you must have a compatible
CompactFlash reader attached to your computer.
Update Dynamic Data Recorders updates the standalone data collectors that
can be reconfigured without affecting any of the control code.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-5
Controller Setup
The Controller Setup wizard prepares a controller for use by configuring its IP
address and redundancy information. A controller cannot communicate on a network
until these setup tasks are complete.
To set up a controller using the Controller Setup wizard
1 Connect a serial cable from the main board of the controller to a free serial port
on your computer.
2 Open the Mark VIe Component Editor for the controller to be configured.
3 From the Device menu, select Download, and then Controller Setup. The
first of the Controller Setup Wizard screens displays. Click Next to
continue.
Click Next.
5-6 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
Configure Network Address is
selected by default. Click Next to
continue.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-7
Note If the controller is configured as either simplex or dual, some channels may not
be available.
Download Wizard
The Download Wizard is the primary method of transferring software to a Mark VIe
component and its distributed I/O modules over an Ethernet connection. The wizard
can automatically examine the configuration of the system to locate out-of-date
software, or you can manually select individual items to download.
5-8 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
Click Next.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-9
Shows status of individual
Displays overall progress. download operations.
4 When the download has completed, click Finish to close the wizard. In the
Component InfoView, click the Log tab and review the status messages to
check for potential warnings or errors that may have occurred during the
download.
Upload Wizard
The ToolboxST application can retrieve existing configuration information from a
Mark VIe component using the upload wizard. When a configuration is uploaded, it
is stored as a new Mark VIe component in the currently open system. The uploaded
configuration is useful as a reference for comparisons with other components and for
retrieval of existing code.
To upload the configuration from a Mark VIe component
1 Open a Mark VIe Component Editor. From the Device menu, select
Upload to display the Upload Controller wizard.
5-10 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
2 Click Next to advance past the introductory page of the Upload Controller
wizard. If the Mark VIe is configured as a redundant component, the following
page displays with an option button for each available redundant component.
Select a controller
and then click Next.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-11
3 When the upload completes, click Next to display the final page of the wizard.
Diagnostics Views
Controller Diagnostics View
The Controller Diagnostics View displays diagnostic messages for a controller
component. Diagnostic messages are errors or warnings that occur in the hardware
component and could cause the component to function improperly. Retrieving these
messages should be one of first steps in diagnosing any problems with hardware,
communications, or other related ToolboxST subsystems.
To open Controller Diagnostic View for Controller
1 From the Main menu, select View.
2 From the View menu, select Controller Diagnostics.
5-12 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
The Controller Diagnostic dialog box displays.
Click this button to clear Click this button to Select this check box to show
diagnostic messages with the manually retrieve diagnostic messages with status
status of 0. Only these inactive diagnostic messages. of 1 only. Clear this box to show
messages may be reset. all messages.
In a Duplex or TMR
configuration, use this
drop-down list to
select the desired
redundancy
component for which
to retrieve diagnostic
messages.
Displays the
timestamp of the
message.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-13
Administer Totalizers
Each Mark VIe controller maintains a set of 64 counters in non-volatile RAM
(NOVRAM) known as Totalizers. Each Totalizer counts the number of times that a
particular event has occurred. Events are assigned to Totalizers by configuring a
Totalizer block. Only one Totalizer block is allowed per controller. Any user may
view the current values of the Totalizers, but to protect data integrity, a special
password from GE is required to change them.
The name of the Totalizer The name of the The current value of the Click here to
block pin connected to the variable connected to counter. The values displayed close the dialog
totalizer. (If blank, the Totalizer a configured pin. are retrieved live from the box.
has not been configured.) controller and are updated
once per second as long as the
dialog box is open.
5-14 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
Totalizer Passwords
All users can view Totalizer values, but modifying the values requires a temporary
password obtained from GE Energy.
Note Totalizer passwords are specific to the connected redundant controller (R, S, or
T) and cannot be used on other controllers.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-15
4 Follow the directions at the top of the file to contact GE Energy with the
information contained in the file. GE will reply with a new Totalizer_ID.txt that
contains a password customized to your installation:
5 Highlight the 28-character password and press CTRL+C to copy the password to
the Windows clipboard, and then return to the View/Set Totalizers dialog box
in the ToolboxST application.
6 Right-click inside the Password box and select the Paste command to
transfer the 28-character password from the clipboard. If the password is valid, a
new countdown timer displays below the Password box indicating the time
remaining before the password expires. (Totalizer passwords are usually valid
for 24 hours from the time of creation.)
5-16 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
Modifying Totalizer Values
Once you have entered a valid password, you can modify Totalizer values. (For
assistance with Totalizer passwords, refer to the section, Totalizer Passwords.)
To modify a Totalizer value
Open the View/Set Totalizers dialog box and enter a valid password.
GEH-6700D ToolboxST Chapter 5 Working Online With a Mark VIe Component • 5-17
Notes
5-18 • Chapter 5 Working Online With a Mark VIe Component GEH-6700D ToolboxST
CHAPTER 6
Chapter 6 Finder
The Finder is a separate window in the toolbox, which contains several useful tools.
It can help you find items, such as text, overrides, differences, and variable usage
from the different types of components.
To open the Finder
When a search is completed, the results display on the Find Results tab of the
Component InfoView. To jump directly to a location, double-click it in the list.
Anywhere finds the specified text anywhere within a searchable text string.
Begins with finds the specified text only at the beginning of a searchable text
string.
A search for matches but does not match:
abc abc xyzabc
abcde abdc
ab
bc
Ends with finds the specified text only at the end of a searchable text string.
A search for matches but does not match:
abc abc abcde
abdc
xyzabc ab
bc
Match Exactly finds the specified text only when it is exactly equal to an entire
searchable text string.
A search for matches but does not match:
abc abc abcde
xyzabc
abdc
ab
bc
abc cde
Match Whole Word finds the named text only when it is exactly equal to an entire
word of a searchable text string, meaning it is surrounded on both sides by either
punctuation or white space.
A search for matches but does not match:
abc abc abcde
abc cde xyzabc
spell your abc's. abdc
ab
bc
spell your abcs.
Regular Expressions processes the text entered in the Find box as a regular
expression (sometimes abbreviated regex). A regular expression is an advanced
system of wildcards used to match a specific set of text. The ToolboxST
configuration supports a standard set of regular expression commands similar to
many popular third-party tools. While a detailed discussion of regular expression
syntax is out of the scope of this document, there are many excellent books and
online resources available with details about regular expressions.
A search for matches but does not match:
[cvrm]at cat sat
cats bat
vat
rat
mat
(Mon|Tues|Wednes|Thurs|Fri)day Monday Saturday
Tuesday Sunday
Wednesday Fries
Thursday
Friday
Fridays
var[0-9]+ var0 varx
var9 var7a
var7 var
var48
var[a-zA-Z]* var var5
variable var!
varZZZZ
Chapter 7 Trender
The Trender is a tool used to capture and display trend graphs of variables in the
system. It can collect and display values in real time from controllers and other
sources, and can display data collected by high-speed coherent data collection
systems, such as capture buffers and dynamic data recorders. The Trender also can
display previously captured data from a saved data file.
Note While Trender windows opened from the Component Editor are associated
with one particular component for storage purposes, they are not restricted to
observing only that component and may be used to monitor any variables.
Graph View
contains the trend
graphs, which
display the values
represented by
each trace.
Property Editor
allows you to change
settings that affect the
capture and display of
data.
Data Toolbar
contains commands
that manipulate the
current data.
Traces tab Sources tab User Note tab Events tab lists Auxiliary View Mode Indicator
displays traces displays sources allows you to save all events that contains tabs that displays the
currently being where data is comments, have occurred display current mode
monitored by the collected. instructions, and during the information about (Live or Replay).
Trender window. notes about the current Chapter. the current data.
current Chapter.
Create new
Trender Window
Data Toolbar
Note The buttons available on the Data toolbar may vary according to the current
trace source type.
Working in Trender
Acquiring Data
Before you can analyze data, you must import it into a Trender window. Variables
can be added to the Trender window live, from capture buffers or from static files.
While you may add as many variables as you like to a given Trender window, all of
them must come from the same type of data source. (For example, you cannot
display both live and static file variables simultaneously.)
Adding Traces
The Trender represents each variable with a trace. (The term trace is used since the
Trender works similarly to a digital storage oscilloscope, which displays data by
tracing a line across the screen as values are acquired.) As you add traces to a
Trender window, the new traces display in the Traces Tab. (Refer to the section,
Traces.)
Select the Online button on the Trender toolbar. (If any of the source
controllers are redundant controllers, the Trender prompts you to select a
redundant channel before opening the connection.)
To begin capturing a trend from live traces
On the Data toolbar, select the Record Data button. The Trender
switches to Live mode, and the Graph View continuously scrolls the time axis
to display the latest incoming data while recording.
To freeze the display while capturing a trend from live traces
On the Data toolbar, select the Record Data button. The Trender
returns to Replay mode.
To retrieve data from a capture buffer
Trender Concepts
Chapters
When working with live, or capture buffer, or some historical sources, the Trender
can record more than one set of data. The basic unit of data capture in the Trender is
a chapter. A chapter represents one acquisition session, which is either a single
upload for a capture buffer source or a single period between clicks of the Record
Data button for a live source. Chapters are organized chronologically, so the first
acquisition session is always the first chapter and the most recent session is always
the last chapter.
A Trender window only displays one chapter of information at a time. Each chapter
maintains its own traces and events. The Events tab only displays events applicable
to the currently displayed data. Similarly, the user data field is unique to each
chapter, so comments about a data set are stored alongside each chapter.
To navigate between Chapters
Tip When selecting a range of values, there is no left or right cursor – you may
arrange the cursors in whichever way is most convenient. The Trender automatically
identifies the leftmost and right most cursors.
Tip While there are always two cursors on the Graph View, it may appear that
there is only one cursor on the Graph View if both cursors are set to the same time
value.
Value ScreenTips
Event Indicator
To jump to an event
From the Event tab, double-click on the description of the desired event.
In addition to events added by the controller, you can add your own User Events. If
added during Live mode, the User Event is placed at the time of the most recently
received sample at the instant the Add User Event command is selected. During
Replay mode, new User Events are added at the time indicated by the active cursor.
(Refer to the section, Cursors.)
To add a user event
1 Select an active cursor.
2 From the Edit menu, select Add User Event. (Or, press the shortcut keys
CTRL+M.)
3 Enter a name for the new event, and select OK.
Note In Single Graph mode, the vertical axis markings correspond to the trace listed
first on the Trace Tab. Each trace is drawn according to its own scale and, as such,
traces other than the first trace may not correspond to the displayed axis markings.
Grid Lines
The Trender can display grid lines that correspond to major axis divisions on the
Graph View. These lines, which only display when the Trender is in Replay mode,
can be useful when the exact trace values are important.
Sample Markers
When exact values at each sample reading are important, the Trender can display
Sample Markers at each sample collection point. By default, Sample Markers display
when the current Graph View contains ten or fewer samples. If desired, you can
change the Sample Marker threshold.
Click the Zoom In (to reduce the duration) or Zoom Out (to
increase the duration) buttons on the Data toolbar / Click on the time axis and
edit the Duration property in the Property Editor.
The Zoom In and Zoom Out commands behave differently depending on the current
mode. In Live mode, the Zoom In command sets the duration to one third of the
current value and the Zoom Out command sets the duration to three times the current
value. In Replay mode, the Zoom Out command still sets the duration to three times
the current value, but the Zoom In command sets the duration to the exact region
selected by the two cursors. (For more information on selecting a range, refer to the
section, Cursors.)
Tip To quickly change the range of an axis, you can click any point on the axis
and drag it to a new location. This operation works for both the value and time axes
and is frequently the most effective way to change the displayed set of data.
Traces
The Trender window maintains separate settings for each trace. These settings,
which include trace color, sample capacity, and pen width, are accessed through the
Property Editor when a trace is selected on the Trace tab. In addition, Value
(vertical) Axis settings managed through each trace allow an appropriate scale and
range to be determined for each item.
Auto-Range Trace
To display a set of collected samples in the Graph View, an appropriate Value Axis
scale and range must be selected. For most data sets, an optimal scale and range
would display all collected samples in the selected time range with minimal wasted
space. The Auto-Range Trace feature sets the range of the Value Axis for the
currently selected trace(s) to the optimal values. Even if you decide to further refine
the range of the trace, the Auto-Range Trace feature provides a convenient starting
point.
To auto-range a trace
From the Traces tab, select one or more traces, then select the Auto-Range
Trace Colors
The Trender assigns each new trace a color from a set of eight colors stored in the
Settings window. After eight traces are created, these colors are reused. You may
wish to change the color of a trace, especially when multiple traces display on a
single graph.
To change the color assigned to a trace
1 From the Traces tab, select a trace.
2 In the Property Editor, locate the Pen category and select the Color
property.
3 Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
4 Click the square that corresponds to the desired trace color. The trace updates
automatically.
To modify the default trace colors
1 From the Options menu, select Settings.
2 Locate and select the Trender item in the Settings window.
3 In the Property Editor, select the number of the trace (for example, 2nd Trace)
to be changed.
4 Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
5 Click the square that corresponds to the desired trace color.
6 When you have finished changing trace colors, click OK.
Hiding Traces
In some situations, especially with capture buffers, a Trender window contains more
traces than you want to monitor at a particular time. Traces in a Trender window can
be hidden. They still collect data, but they do not display in the Graph View or the
Trace tab.
To hide traces
1 From the Traces tab, select one or more traces.
2 From the Edit menu, select Hide Selected Traces, or right-click on the
selected traces and select Hide Selected from the context menu.
To show or hide a trace
From the Edit menu, select Show Traces. Select and clear the check boxes
next to the trace names as desired, then click OK.
4 Click the Add button to move the statistics to the Selected list.
5 When you have finished enabling statistics, select OK.
Controls whether a
column containing Controls the text
timestamps is added exported when no
to the output. data is available
for a trace at a
given point in time.
Controls whether a
column containing
increasing integers is
added to the output. Selects the precision
of the exported
timestamp.
If selected, only the
time range selected
by the cursors is
exported.
Printing Graphs
The Trender can print the currently displayed graph to any printer attached to the
system. Printed graphs reflect the current appearance of the Graph View, including
displayed traces, colors, and axis boundaries.
To preview the results of a print command
From the File menu, select Print Preview.
To print the current Graph View
From the File menu, select Print. Adjust printing options as desired and click
OK.
The EGD Component Editor for external devices allows you to configure Ethernet
Global Data (EGD) for an external or third-party device. The EGD protocol allows
controller components (sometimes known as nodes) to share information in a
networked environment. EGD allows one controller device, referred to as the
producer of the data, to simultaneously send information to any number of peer
controller devices (consumers) at a fixed periodic rate. This network supports a large
number of controller devices capable of both producing and consuming.
Network Adapters
The General tab configures Ethernet adapters for an external EGD-capable device.
One adapter is created by default, and up to four adapters can be added.
To add a network adapter
1 From the System Editor, right-click an external device, then select Edit EGD.
(If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False. The EGD Component Editor opens.)
2 From the Component Editor, select the General tab.
3 From the Tree View, right-click the Network Adapters item, then select
Add Adapter.
To remove a network adapter
1 From the System Editor, right-click an external device, then select Edit EGD.
(If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False. The EGD Component Editor opens.)
2 From the Component Editor, select the General tab.
3 From the Tree View, right-click the network adapter to be removed, then select
Delete Adapter.
Host Name is the Internet Protocol (IP) host name for the selected network adapter.
Subnet Mask is the subnet mask associated with the connected network.
These properties are available for configuration when Ethernet Global Data is
selected in the Tree View:
Collection controls the Collection to which this EGD component belongs when
viewed in the EMT tool. This information is published to the EGD Configuration
server in the GUI component document, GUIDevice.xml.
Producer ID sets and displays the EGD Producer ID for this component. This is
assigned when the component is created. The Property Editor displays the EGD
Producer ID formatted as an unsigned integer, but dotted and hexadecimal
representations are available by clicking the ellipsis button.
Produced Pages
Produced Pages are data sets configured to be available to other components on the
network.
To add a new Produced Page
1 From the Tree View, right-click the Produced Pages item, then select Add
Page.
2 Enter a unique name for the new page in the Page Name dialog box, then click
OK.
To delete a Produced Page
From the Tree View, right-click the page you wish to delete, then select
Delete.
The following properties are available for configuration when a Produced Page is
selected in the Tree View:
Ethernet 0, if selected, broadcasts EGD on Ethernet 0. (If more than one Ethernet
Adapter has been configured for EGD, additional Ethernet properties displays.)
Allow Editing when False, a variable's exchange ID and offset for variables on a
manual page cannot be edited. A page compress will also be disabled. This prevents
you from inadvertently editing a page with manual selected as Layout mode.
Skew is used to prevent exchanges with the same period from being produced at
exactly the same instant. The skew for the first exchange in the page is set to this
value, and each additional exchange skew differs from the previous exchange’s skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchange’s skew is two, the second exchange’s skew is four and
the third exchange’s skew is six.
Note The Skew property will not be visible if it is not supported in the
implementation profile configuration. (The skew property is measured in
nanoseconds.)
Destination IP Address sets the IP address to which the exchanges on this page
are unicast or multicast. (If the Mode property is set to Broadcast, this property is
not available.)
Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.
Note To edit exchange signatures and configuration time, set Layout Mode to
Manual.
3 Review the warning about manual Exchange Signature editing, then click
OK.
4 Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.
The EGD configuration for the selected devices is loaded and the variables display in
the Summary View.
When EGD configurations are edited in remote devices, you must refresh the
configuration periodically to ensure that the latest variable information is used. This
is automatically done during a Bind and Build operation as well as when a
configuration is saved.
To refresh the configuration of a referenced device
In the Tree View, right-click the device to be refreshed, and then select
Refresh.
Multiple Producer IDs indicates device support for multiple producer IDs.
Data Types allows you to configure supported data types. (Clicking the ellipsis
button will open an editor window.)
Double Word Alignment indicates that the offset of a DWORD length variable
must be evenly divisible by this number.
Word Alignment is set to True if the device requires that all WORD length
variables be aligned on an even boundary.
Broadcast is set to True if the device supports broadcast destinations for EGD data
or command packets and False otherwise.
Max Coherent Data returns the maximum size in bytes of a variable that still is
guaranteed coherent transfer. If the attribute is not present then all data is guaranteed
coherent transfer regardless of size. It is optional and is initialized to 0.
Max String returns the maximum size string supported by the device. If the
attribute is not present then the device has no set maximum size for strings. It is
optional and is initialized to 0.
Multicast is set to True if the device supports multicast destinations for EGD data
or command packets and False otherwise.
Skew is a Boolean value representing the capability of the producer to support the
skewing of produced exchanges with respect to time.
Unicast is a Boolean value that is set to True if the device supports unicast
destinations for EGD data or command packets. Otherwise, it is set to False.
Device Class Name is name of the class of device to which this device belongs.
The generic editor uses CMP to display live data values on a produced or referenced
device summary grid view. The Connection Toolbar button sends the CMP message
to the device to obtain the data.
Due Time is the time that a consumer data packet must be received for an exchange
to remain valid.
Length is the value for a produced exchange. This length may be the highest
variable offset in the exchange or the highest offset of a variable, which may have
been removed. For a consumed exchange, the value may be the highest variable
offset used or the length of the produced exchange, depending on the bind algorithm
of the individual tool.
Refresh Errors are the number of times a refreshment fault has occurred. A
refreshment fault occurs when a subsequent data production packet (or initial packet
at startup time) does not arrive at a consumer within a pre-defined update period.
Note The EMT provides a detailed view of the configuration server contents.
The Filter Toggle button defaults to a filtered state. It displays nodes that have
the same name but have a different Producer ID as the open component.
The Delete button deletes the selected node or nodes. If the nodes were saved
as part of the configuration, they can be added again.
The EGD configuration server uses the producer ID to store all the documents for an
EGD node. If you open two systems, then point to the same configuration server and
save a device of the same name with two different producer IDs to that server, you
can end up with two producer ID nodes with the same device name.
Chapter 9 Configuration
Management System (CMS)
The CMS Administrator tool allows you to perform the following administrator tasks
on the CMS server:
Note To run the Administrator tool, you must have administrative permissions on
your computer.
To create a new repository, select the Create a new Repository option and click
OK.
Main menu
User List
Permissions
Repository Menu
Restore ends the component editing session and returns to the main System Editor.
The user who creates the repository becomes the default administrator.
2 From the drop-down list, select a repository, then click Open. The CMS
Administrator window displays with all users.
Enter the folder path and the name of the repository you would like to create and
click OK.
Deleting a Repository
To delete a repository
1 From the Repository menu, click Delete. The Delete Repository dialog
box displays.
2 From the drop-down list, select the repository to be deleted, then click OK.
Restoring a Repository
To restore a repository
1 From the Repository menu, click Restore. The Restore Repository dialog
box displays.
Users Menu
Adding a User
To add a user
1 From the Users menu, select Add or right-click the User list and select Add
User. The Add User dialog box displays.
Deleting a User
To delete a user
1 Highlight the user to be deleted.
2 From the Users menu, select Delete, or right-click the User list and select
Delete. The CMS Administrator confirmation window displays.
Editing a User
To edit a user's permissions
1 Highlight the user to be edited.
2 From the Users menu, select Edit, or right-click the User list and select Edit.
The Edit User dialog box displays.
Tools Menu
Starting the Server
To start the CMS server
From the Tools menu, select Server. The CMS Server dialog box displays.
The status of the server changes to Running, and the button displays Stop Server.
If there are any existing repositories with current user types, use this dialog box to
back up all existing repositories in the CMS server.
Click OK to back up
the repositories.
2 When the Server Details dialog box displays, type the IP address of the
machine on which the server is installed.
4 Type the name of the working folder, or click Browse… to locate and select
the working folder. Click OK. The Configuration Management System
window displays:
2 The Server Details window displays again. Re-enter the IP address, then when
the LogIn window displays, repeat the logon steps.
Adding a System
A system must be added to begin version control. The working folder must be set,
and you must have modify permission.
To add a system
From the File menu, select Add System, or in the System View, right-click
the repository, then select Add System.
Deleting a System
You must have modify permission to delete a system. This command deletes the
system, but not the system folder. A system folder can only be deleted by an
administrator.
To delete a system
From the File menu, select Delete System, or in the System View, right-
click the repository, then select Delete System.
Source Menu
Retrieving a Configuration
To retrieve a system or device configuration
1 From the System View, select a system, or from the Device View, select a
device.
2 From the Source menu, select Get Latest Version, or from the selected
system or device, right-click to select Get Latest Version.
The most recent configuration, in read-only mode, is placed in the working folder
you specified.
2 From the Source menu, select Check In to save the changes. The CheckIn
dialog box displays.
3 If desired, enter a comment in the Comments text field, then click OK.
To revert your changes back to the previous version
From the Source menu, select Undo Checkout.
Labeling a Configuration
You can mark a copy of the configuration being modified with a comment(s).
To label a system or device configuration
From the Source menu, select Label. This label can be used for retrieving the
configuration at a later date.
The Tree File Importer is a companion application that converts software tree files
from the Control System Toolbox application to the new .xml file format used by the
ToolboxST application.
2 Click the Browse button. From the Open Workplace window, locate and
select the system .tcw file you created in Step 1, then click Open. Click Next to
continue to Page 2 of the Wizard. The ToolboxST application opens the system
selected in Step 1 and displays a list of available controller and library container
components.
6 After reviewing the log, click Next to save the updated system and complete the
wizard.
7 Click Finish to exit the wizard.
Chapter 11 Reference
Paste places the contents of the clipboard into the currently selected item.
Bookmarks allows you to mark major items in the Outline View by using the
Toggle Bookmark option and then move between these items easily by using Go
to Next Bookmark.
Build converts the current configuration into binary files that can be
downloaded to a controller.
Download
Controller Setup opens a wizard that performs basic configuration
tasks on the controller.
Controller Flash Boot Loader... installs the controller bootloader
onto a CompactFlash card connected to your computer.
Download Wizard... downloads base load, firmware and application
code to the controller and Distributed I/O modules.
Update Dynamic Data Recorder allows you to update the DDR.
Update Dynamic Data Recorder exchanges updated information
with the DDRs in the controller.
View/Set Time... displays a dialog box that controls the controller time.
Upload retrieves configuration information from the controller and uses it to
create a new controller component in the system.
Put Device to SDB stores the component configuration to a System
Database (SDB).
Compress Variables rearranges variables to minimize the amount of space
used.
Administer Totalizers opens the View/Set Totalizers dialog box.
Restore Password Protection allows you to clear all passwords and
protect the component.
application code
Software that controls specific machines or processes.
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.
baud
A unit of data transmission. Baud rate is the number of bits per second transmitted.
bit
Binary Digit. The smallest unit of memory used to store only one piece of
information 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).
block
Instruction blocks contain basic control functions, which are connected together
during configuration to form the required machine or process control. Blocks can
perform math computations, sequencing, or continuous control. The ToolboxST
application 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
ToolboxST application, it is a data type for logical signals.
bus
An electrical path for transmitting and receiving data.
byte
A group of eight binary digits (bits) operated on a single unit.
collection
A group of signals found on the same network. The Trend Recorder can be
configured by adding collections.
Control Constant
Control Constant is a signal with an initial value that is read and never written.
device
A configurable component of a process control system.
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.
fault code
A message from the controller to the HMI indicating a controller warning or failure.
Finder
A subsystem of the ToolboxST application 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 flash memory.
flash
A non-volatile programmable memory device.
font
One complete collection of letters, punctuation marks, numbers, and special
characters with a consistent and identifiable typeface, weight, posture, and size.
forcing
Setting a variable signal to a particular value, regardless of the value blockware or
I/O is writing to that signal.
gateway
A device that connects two dissimilar LANs or connects a LAN to a wide-area
network (WAN), PC, or a mainframe. A gateway can perform protocol and
bandwidth conversion.
health
A term that defines whether a variable is functioning as expected.
hexadecimal (hex)
Base 16 numbering system using the digits 0-9 and letters A-F to represent the
decimal numbers 0-15. Two hex digits represent 1 byte.
I/O
Input/output interfaces that allow the flow of data into and out of a device.
initialize
To set values (addresses, counters, registers, and such) to a beginning value prior to
the rest of processing.
instance
Update an item with a new definition.
logical
A statement of a true sense, such as a Boolean.
node
In a local network, a component that is connected to other components and is capable
of communicating with other network devices. In a tree structure, a location on the
tree that can have links to one or more nodes below it.
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 ToolboxST application 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.
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.
reboot
To restart the controller.
register page
A form of shared memory that is updated over a network. Register pages can be
created and instanced in the controller and posted to the SDB.
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
configuration plays an important role in the CIMPLICITY system by routing alarms
to specific users and filtering the data users receive.
runtime
See product code.
ToolboxST
A Windows-based software package used to configure controllers.
trend
A time-based plot to show the history of values.
Trender
A subsystem of the ToolboxST application that monitors and graphs signal values
from a controller.
validate
Makes certain that items or devices do not contain errors and verifies that the
configuration is ready to be built into application code.
variable
The basic unit for variable information. Variables are the placeholders for memory
locations in the toolbox’s different platforms.
word
A unit of information composed of characters, bits, or bytes. It is treated as an entity,
and can be stored in one location. Also, a measurement of memory length, usually 32
bits in length, but can also be 4, 8, or 16 bits long.