GEH 6700b
GEH 6700b
GEH 6700b
These instructions do not purport to cover all details or variations in equipment, nor to
provide for every possible contingency to be met during installation, operation, and
maintenance. The information is supplied for informational purposes only, and GE makes
no warranty as to the accuracy of the information included herein. Changes,
modifications and/or improvements to equipment and specifications are made
periodically and these changes may or may not be reflected herein. It is understood that
GE may make changes, modifications, or improvements to the equipment referenced
herein or to the document itself at any time. This document is intended for trained
personnel familiar with the GE products referenced herein.
GE may have patents or pending patent applications covering subject matter in this
document. The furnishing of this document does not provide any license whatsoever to
any of these patents.
This document contains proprietary information of General Electric Company, USA and
is furnished to its customer solely to assist that customer in the installation, testing,
operation, and/or maintenance of the equipment described. This document shall not be
reproduced in whole or in part nor shall its contents be disclosed to any third party
without the written approval of GE Energy.
GE provides the following document and the information included therein as is and
without warranty of any kind, expressed or implied, including but not limited to any
implied statutory warranty of merchantability or fitness for particular purpose.
If further assistance or technical information is desired, contact the nearest GE Sales or
Service Office, or an authorized GE Sales Representative.
To:
Reader Comments
GE Energy
Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Fax: 1-540-387-8651
(GE Internal DC 8-278-8651)
Todays Date
Job Site
GE Requisition No.
Publication No.
Address
General Rating
Excellent
Contents
{
Organization
{
Technical Accuracy {
Clarity
{
Completeness
{
Drawings / Figures {
Tables
{
Referencing
{
Readability
{
Good
{
{
{
{
{
{
{
{
{
Fair
{
{
{
{
{
{
{
{
{
Poor
{
{
{
{
{
{
{
{
{
Additional Comments
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
____________________________________________________________
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 ____________________________________________
____________________________
____________________________
____________________________
GE Energy
Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Contents
Chapter 1 About the ToolboxST Application
1-1
2-1
Chapter 3 Software
3-1
GEH-6700J ToolboxST
Contents i
Unlink Property..............................................................................................................................3-4
User Block Definitions...................................................................................................................3-7
Library Container Editor ...........................................................................................................................3-8
Adding Libraries ..........................................................................................................................3-11
Library Property Editor ................................................................................................................3-13
Library Summary View................................................................................................................3-13
Library Help Files ........................................................................................................................3-14
Table Definition Property Editor..................................................................................................3-15
Exporting a Table Definition........................................................................................................3-16
Online Display and Changes ........................................................................................................3-17
Using Table Definitions in Software Application Code...............................................................3-18
User Block Definitions.................................................................................................................3-20
User Block Variables ...................................................................................................................3-21
Working with User Blocks ...........................................................................................................3-22
Application Documentation.....................................................................................................................3-28
Application Software Examples ..............................................................................................................3-29
User Block Definition ..................................................................................................................3-29
Linked User Block .......................................................................................................................3-34
Device Attribute ...........................................................................................................................3-40
Block Exclusion with an Instance Script......................................................................................3-43
Text Substitution with an Attribute ..............................................................................................3-44
4-1
ii Contents
GEH-6700J ToolboxST
5-1
6-1
GEH-6700J ToolboxST
Contents iii
iv Contents
GEH-6700J ToolboxST
7-1
Chapter 8 Finder
8-1
Find Methods.............................................................................................................................................8-2
Replace Options ........................................................................................................................................8-4
Chapter 9 Trender
9-1
GEH-6700J ToolboxST
Contents v
10-1
Network Adapters....................................................................................................................................10-1
EGD Configuration .................................................................................................................................10-3
Produced Pages........................................................................................................................................10-3
Editing Produced Pages................................................................................................................10-4
Page Compression ...................................................................................................................................10-6
Variables..................................................................................................................................................10-6
Editing Exchange Signatures and Configuration Time ...........................................................................10-7
Referenced Devices .................................................................................................................................10-8
Implementation Profile............................................................................................................................10-9
Viewing Live Data Values ....................................................................................................................10-11
EGD Diagnostics........................................................................................................................10-12
EGD Configuration Server Tab.............................................................................................................10-13
External Device Menus .........................................................................................................................10-14
11-1
Chapter 12 TreeFileImporter
12-1
13-1
vi Contents
GEH-6700J ToolboxST
Glossary of Terms
13-35
Index
13-39
GEH-6700J ToolboxST
Contents vii
CHAPTER 1
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 is the recommended hardware and operating system requirements
needed to run the ToolboxST application.
Recommended
CPU
OS
Windows XP Professional
Memory
HD
40 GB (or more)
Video
Drive
DVD
Network
Ethernet 10/100 mb
USB
Note Windows 2000 Professional is supported for legacy systems only. Windows
Server 2003 is supported using a single user configuration. Windows 64-bit
Operating Systems are not supported.
For assistance, contact the nearest GE Sales or Service office, or an authorized GE
sales representative.
GEH-6700J ToolboxST
Installation
To install the software
1
Note If the installation does not start automatically, use Windows Explorer to
navigate to your CD-ROM drive and run setup.exe. The Alarm Viewer is part of the
GE WorkstationST option.
GEH-6700J ToolboxST
Select the installation options to install, then click the Install button.
The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.
To continue the installation, you must accept this agreement. Select Agree.
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.
Click Next. The Select Features dialog box displays and allows you to select
which features to install or not install. All components are installed by default.
Note The WorkstationST Alarm Viewer can be installed by itself for use on a
remote computer.
GEH-6700J ToolboxST
To select a component
not to be installed, click
the icon next to the
component name, then
select the red X.
Once your selections are made, click the Next button until the installation starts.
Click the Finish button when the installation has completed successfully.
GEH-6700J ToolboxST
Go To Variable
Go To Hardware Diagnostic
Go To Locator
-NoSplash
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.
GEH-6700J ToolboxST
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.
Standard Action Arguments
/EGDAction:ADD /EGDDevice allows a device to be added.
Note Using /EGDAction:ADD requires no /EGDDevice identifier. The application
started determines the ProducerID(s) and device names(s) to be used.
/EGDAction:MODIFY /EGDDevice:<producer ID> allows the device-assigned
Producer ID to be modified.
/EGDCollection:<collection name> is defined for tools that can manage collections
of device configurations. Collection names are defined in the GuiDevice.xml file.
EMT Argument Rules
The following rules apply to EMT arguments:
GEH-6700J ToolboxST
Do not use spaces around colons (:) and after slashes (/).
Go To Variable
/Variable:<variableName> [/VariableDevice:<deviceName>] searches a
ToolboxST application for the first write occurrence of the specified variable. If
never written, the first read-only location is used. If the variable is not found, a
message box displays.
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.
Opening a ToolboxST System
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.
Opening a ToolboxST Component and Navigating to a Variable
The format for ToolboxST variable names is
<deviceName>.<variableName>
The search for the variable uses the deviceName component of the system. The
/VariableDevice keyword can also be used to specify a particular device to search.
This is useful for third-party interfaces where you may want to control the device
that is searched (see the third example below). A message displays if nothing is
found in the component.
Examples
ToolboxST /Variable: G1.Var - the G1 component of the most recently loaded
ToolboxST system will be searched.
ToolboxST c:\site\mySystem\mySystem.tcw /Variable: G1.Var - the G1 component of
the c:\site\mySystem\MySystem.tcw system will be searched.
ToolboxST /Variable:ext1.myPermissive /VariableDevice: G2 - the G2 component of
the most recently loaded ToolboxST system will be searched. In this example, G2
references an external EGD device variable. Use the /VariableDevice option to open
the G2 component.
GEH-6700J ToolboxST
Go To Hardware Diagnostic
/HardwareDiagnostic:<devName> [.HardwareGroup] - navigates to either the
Device Diagnostics window or the Hardware Module Group.
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.
/NavigateToLocator:<locator string shown in Find results>
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.
Copy the selected Find results to the clipboard to
use as a locator command argument. ToolboxST
opens the component, then navigates to the
specified location in the configuration.
GEH-6700J ToolboxST
-NoSplash
If the text NoSplash is contained in an argument, the splash screen does not display
when the ToolboxST application starts.
GEH-6700J ToolboxST
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.
Install the ToolboxST application (refer to the section, Installation (on page
2)).
Plug the UPD into any empty USB port on your computer.
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.
Reinstalling UPD
To reinstall the UPD
1
From Windows, click Start, Settings, and then select Control Panel.
Reinstall the UPD. Windows should now detect the UPD and reinstall it with the
correct drivers.
GEH-6700J ToolboxST
To make sure that the UPD is correctly installed and your ToolboxST
installation is correctly licensed, start the application. If the installation is not
correct, the following dialog box displays.
EMT
EU
Engineering Units
HMI
Human-Machine Interface
NVRAM
OPC
SDB
System Database
SOE
Sequence of Events
TMR
UDH
UDP
UPD
USB
xml
GEH-6700J ToolboxST
Notes
GEH-6700J ToolboxST
CHAPTER 2
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 .
GEH-6700J ToolboxST
From the File menu, select New System to display the New System dialog
box.
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.)
Enter a name for the system. Some characters are prohibited; if you enter an
invalid character, a small red exclamation mark displays.
Click OK to create the new system. The new system is created, and opens in the
System Editor.
Locate the .tcw configuration file for the system and select Open. The system
displays in the System Editor.
The Property
Editor allows
you to edit the
selected
component.
GEH-6700J ToolboxST
Components
System
Group of Components
Mark VIe component
Mark VI component
EX2100ST component
WorkstationST
Printer
Library Container
Network
Trender
Watch Windows
LiveView
External Device (not associated
with an application)
Network Switch
Network Time Server
GEH-6700J ToolboxST
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.
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
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:
When a group is copied, a new group is created. The contents of the old group
remain in place and are not copied to the new group.
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.)
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Status
Indicates
Healthy
Component Diagnostics No
NTP Diagnostics No
EGD Diagnostics No
I/O Diagnostics No
Number of Forced Variables 0
DDR Equality Equal
Configuration Equality - Equal
Unhealthy
NTP Diagnostics No
EGD Diagnostics No
I/O Diagnostics No
Number of Forced Variables 0
DDR Equality Equal
Configuration Equality major
difference
Warning
GEH-6700J ToolboxST
In the Property Editor, select the App Path item. Click the ellipsis
at the right side of the text field to display the Open dialog box.
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.
button
Optional procedures:
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 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
toolbar.)
GEH-6700J ToolboxST
button on the
Configuration Files
Folder Structure
Each system is saved in its own folder. Inside the main system folder is a set of subfolders 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:
System Folder is the top-level folder that contains all others. It always has the
same name as the system. (In the example for this section, the system folder is
named System1.) Files in the folder include:
GEH-6700J ToolboxST
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.
The .xml files used by the ToolboxST application should
NEVER be modified by ANY other application.
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.
Some controller components offer a Build command that produces files to be
downloaded directly to the controller. These files, which are stored in the Output
folder of a component, are in a binary format, and are not human-readable.
GEH-6700J ToolboxST
System Options
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 view system options
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 the Tree View.
GEH-6700J ToolboxST
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.
Main Font is the font used for most application text.
Build, when set to True, prompts for confirmation before each build.
Developer Mode, when set to True, allows the developer access to the application
on the GE Salem Intranet.
Force Enable UPD, when set to True, makes the UPD a requirement when on the
GE Salem Intranet with privileges.
Auto Backup, when set to True, creates backup copies of configuration files during
the Save command.
Controller Backup Option determines how controller backup files are handled in
the Build and Download commands, as well as the status control.
Manual mode does not create a device.zip file so there is no option to download
back-up files from the Download Wizard.
Command
Use to
File
New System
Open System
Close System
Save System
Save System
As
Archive
System
Recent Files
Exit
Delete
Insert New
Edit
GEH-6700J ToolboxST
View
Cut
Copy
Paste
Paste the copied item in the Tree View into the Summary View
System
Information
Selected
component
Display the Component Editor for the item currently selected in the Tree
View
By Type
By Group
Track
EGD
Configuration
Server
Online
Work online
Options
Settings
Window
Cascade
Tile
Close All
CMS
Help
Contents
Release Notes Display current information about your ToolboxST software version.
Send Problem
Report
GEH-6700J ToolboxST
Alarm Classes
Alarm classes are groups or collections of related alarms that share a common
priority and color scheme.
To edit Alarm Classes
1
GEH-6700J ToolboxST
Open the System Editor. From the Edit menu, select System Information.
From the Tree View, select Alarm Classes. A data grid with the existing
Alarm Classes displays in the Summary View.
GEH-6700J ToolboxST
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.
Priority shows alarm class priority (1 to 99 where 1 is the highest priority).
Ack Foreground Color shows foreground color for an alarm in the
Acknowledged state.
Ack Background Color shows background color for an alarm in the
Acknowledged state.
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 Enabled, if set to True, enables blinking ability.
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.
Sound Reference is the sound definition to select when an active alarm displays
in the WorkstationST Alarm Viewer.
Diagnostic Translations
The Diagnostic Translations option allows you to display alarm diagnostic text in a
second language.
Note The second Language option must be selected in the System Editor Property
Editor.
GEH-6700J ToolboxST
From the System Editor Tree View, double-click the system item. The
System Information Editor displays.
Note The Export Product Diagnostics option creates a .csv file that contains
diagnostics for all I/O packs installed on this computer. The default file name is
All_Product_Diagnostic Translations.csv. It can be opened in Notepad or in an .xml
spreadsheet.
2
From the Tree View, right-click the Diagnostic Translations item to select
the .csv file just created.
GEH-6700J ToolboxST
Note Expand the Diagnostic Translations item to display each I/O pack in the
system, as well as packs for Mark VIe and certain diagnostics grouped as Common.
Translations for common diagnostics only need to be entered once.
GEH-6700J ToolboxST
Note Selecting the Diagnostic Translations item exports all pack items beneath to a
single .csv file. However, if an individual pack is selected, the diagnostics for that
pack only are exported.
Validate Diagnostics
If you are using CMS, perform a Get Latest for all controllers on your computer. The
Validate Diagnostics option verifies the I/O packs attached to a particular system,
then checks to see that a translation has been entered for each I/O pack in the list of
required packs.
Any errors or warnings occurring from the Validation display in the Component
InfoView. Double-click an error or warning to be connected to that diagnostic.
The Validation option applies to all translations entered into a system. Even if you
have Common selected when you start to validate, all translations are validated.
Warnings and errors do not prevent controllers from running the Build and
Download commands, but rather ensure that all second-language diagnostic text
displays correctly at run time. If there is no second-language translation for a
particular diagnostic, the text displays in English. .
Delete Diagnostics
Only I/O packs used on your job need to have translations entered. Unused I/O packs
can be selected from the Tree View and deleted. You have the opportunity to cancel
the Delete command before its performed. However, once its performed, it cannot
be Undone.
Note This command only deletes these translation records. If a diagnostic occurs
whose translation record was deleted, it still displays in English.
GEH-6700J ToolboxST
From the Tree View, select a pack, add the translated text in the Second
Language Message Text column, then click Save.
Open all controllers that use the I/O pack with the missing translation and
perform a Save command.
GEH-6700J ToolboxST
From the
WorkstationST
component Tree
View, select the
General tab and
the General item.
Or
GEH-6700J ToolboxST
From the WorkstationST tray icon, rightclick to display Regional Settings and
select User Second Language.
Note When you select Use Second Language from Regional Settings, that becomes
your permanent default setting, regardless of what is configured in the General tab in
the ToolboxST application.
The WorkstationST Alarm Viewer provides a means to override this setting. For
more information, refer to GHT-200009, How to Configure a Second Language for
the ToolboxST Application and HMIs.
The option Select Active Measurement System allows you to specify either English
or metric measurements. Refer to GHT-200016, How to Configure a Measurement
System for Use by ControlST HMI Applications.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Sound Options
Use the System Information Editor to define sound options that can annunciate
certain sounds within the Alarm Viewer. A specific sound definition is assigned to
an alarm class.
To configure sounds
From the System Editor, select the Edit menu, then select System
Information.
From the Tree View,
select Sounds.
In the Data Grid, enter a
sound Name, for example,
Chimes. Right-click the
Sound Type column, then
select from the drop-down
list (for example, Wave File).
From the Wave File column,
click the ellipsis button to display
a Windows Open screen.
GEH-6700J ToolboxST
To edit sounds
From the System Editor, select the Edit menu, then select System
Information.
From the Tree View,
select Sounds .
The following properties are available in the Property Editor when a sound is
selected in the Data Grid.
Delay displays the time lapse between sounds (from 100 to 10,000 ms). The Repeat
Quantity property must be 1 or more.
Duration displays the sounds duration (from 100 to 10,000 ms).
Frequency displays the sounds frequency (range is 100 to 500 Hz).
Name is the sounds name.
Repeat Quantity displays the number of times the sound is repeated.
Sound Type displays the type of sound annunciated. The options are Tone, Wave
File, and Text to Speech.
Wave File, if selected as the Sound Type, displays the name of the Wave File.
When the system information is saved, the wave files are published to the Master
WorkstationST.
GEH-6700J ToolboxST
Plant Areas
Plant areas are locations that represent a plant or facility within the control system.
These locations are selected from the Plant Area property of all variables defined in
each system component. One or more variables can use the same location. These
locations are used for filtering the alarms that display in the Alarm Viewer.
To edit plant areas
From the System Editor, select the Edit menu, then select System
Information.
Right- click any plant area to display a
drop- down menu with additional options.
GEH-6700J ToolboxST
Format Specifications
Format specifications control how variables are presented in an HMI. Format
specifications are grouped into sets, which establish a relationship between different
measurement systems for a particular type of data. For example, a Format
Specification Set for temperature could contain two specifications for temperature
one for degrees Fahrenheit in the U.S. measurement system and one for degrees
Celsius in the International System of Units (commonly referred to as the Metric
system).
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 HMIs 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:
Val
fs 2
Val
=
fs 2
+ fs 2 min
Val fs1
fs1max
fs 1min
Val o F =
Within a Format Specification Set, all Engineering Min values must represent the
same physical value and all Engineering Max values must represent the same
physical value.
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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.
Precision displays the number of digits to display to the right of the decimal point
(for example, a precision of two displays the fraction 1/3 as .33).
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.
Measurement System displays the measurement system (for example, Metric or
U.S.) to which the unit belongs. (Refer to the section, Measurement Systems )
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
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.
GEH-6700J ToolboxST
HMI Screens
HMI screen files are managed from a master location and downloaded to the HMI
WorkstationSTs. These screen files can be managed from either the System Editor or
from any of the HMI WorkstationST components that use them. HMI screen file
management consists of the following functions:
Adding and deleting screen files to the system (only from the System
Information Editor)
GEH-6700J ToolboxST
Open the System Editor. From the Edit menu, select System Information.
From the Tree View, select HMI Screens. HMI WorkstationSTs and HMI
screen files display in the Summary View.
Different views of HMI screen files can be obtained by selecting any one of the
WorkstationST component items in the Tree View.
Open the System Editor. From the Edit menu, select System Information.
From the Tree View, right-click the HMI Screens item (or any item under it,
or in the Summary View) and select Add HMI screen file from the short-cut
menu. An Open file window displays.
GEH-6700J ToolboxST
From the Open file window, select the screen file or files you wish to add, then
click Open.
The screen file(s) is added to the system and displays in the Summary View.
To delete an HMI screen file from the system
Either right-click the screen file and select Delete or from the toolbar, click the
Delete icon, or from the Edit menu, select Delete.
Archiving Files
A project (or system) can be archived into a zip file from the System Editor,
however, the archive does not retrieve the files stored in the Master location. Also,
when a archived system is unzipped to a specific location, the files in the archive do
not automatically get distributed to the Master location.
When an archive is unzipped, the HMI screen files are located in a subdirectory
relative to the location of the systems .tcw file. For example, if the system is called
abcSystem, and is stored in C:\Site, the .tcw file is located at
C:\site\acbSystem\abcSystem.tcw. The HMI Screen files are located at
C:\site\abcSystem\HMIScreens. This is the system location of the HMI
screen Files.
To copy files from the system to the Master location or from the
Master location to the System:
1
Open the System Editor. From the Edit menu, select System Information.
To copy to the Master location, from the System menu, select Copy Local
to Master.
To copy from the Master location to the system, from the System menu,
select Copy Master to Local.
Note If files already exist in the Master location when copying from the system to
the Master location, a warning dialog displays to ask if you wish to overwrite the
existing files.
GEH-6700J ToolboxST
Open the System Editor. From the Edit menu, select System Information.
From the Summary View, select a screen, then in the WorkstationST column
(HMIws1 in the example below), select True to enable HMIws1 to use that
screen or False to disable use.
GEH-6700J ToolboxST
When a particular WorkstationST is selected in the Tree View, the Use property can
also be changed from both the Summary View and the Property Editor.
GEH-6700J ToolboxST
To download HMI screen files from the Master location to all HMI
WorkstationSTs
1
Open the System Editor. From the Edit menu, select System Information.
From the Summary View, select one or more HMI screen files.
GEH-6700J ToolboxST
Open the System Editor. From the Edit menu, select System Information.
From the Tree View, expand the HMI Workstations item, then select a
WorkstationST component.
GEH-6700J ToolboxST
Open the System Editor. From the Edit menu, select System Information.
From the Tree View, select the HMI Screens item, or an HMI
WorkstationST item or a WorkstationST component.
From either the Tree View or the Summary View, right-click to select
Refresh HMI screen data from the short-cut menu.
The size and date of both the master and the local HMI screen file display in the
Property Editor.
GEH-6700J ToolboxST
From the Summary View, right-click to select Edit selected HMI screen
from the short-cut menu.
The process of editing an HMI screen file is different, depending on whether CMS is
enabled.
Editing an HMI screen file with CMS enabled
When CMS is used, the CMS repository is the source of the HMI screen files. When
editing is completed, the screen file is checked back into the CMS repository, then
copied, at the users discretion, to the master location so it can be used by all the HMI
Workstations that are configured to use it.
GEH-6700J ToolboxST
If the HMI screen file is not checked out, you are prompted to check it out.
If you click Yes, the file is checked out and the screen file is opened in the
appropriate editor.
If you click No, you are asked if you wish to edit without CMS. If you click No,
editing does not take place. If you click Yes, the screen file opens in the
appropriate editor. Because the file is read-only, perform a Save As..
Once you save the file and exit the editor, this message displays
If you click Yes, the HMI screen file is copied to the master location. All HMI
WorkstationSTs that have the Auto Download option set to True get the
modified file next time the file status is checked.
If you click No, the HMI screen file remains on the computer from which the
editing occurred.
Check the file back into CMS. Once this is done, you again have the option to
copy the HMI screen file to the master location.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
You are either allowed do a Check In, which saves the file to the master location or
you are not. If you are not allowed (either the file is being edited by someone else or
you choose to edit only the system file), the following dialog displays.
GEH-6700J ToolboxST
A Second Language
must be selected before
diagnostic text can be
translated in the System
Information Editor.
This property must be set
to True before other SDB
properties can be
configured.
The host name where
the SDB is located.
The path where the
SDB is located.
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.
Click OK. When the process is complete, the results display on the Log tab of
the InfoView.
GEH-6700J ToolboxST
Master File
Files that are used by multiple WorkstationST runtimes are stored in a defined
Master location. These files include HMI screen files, sound files, and alarm help
files.
The WorkstationST
where the master
files are located.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Enable, if set to True, enables the interface to the EGD Configuration Server. If this
is enabled, the EGD configuration is sent to the server when a device is saved. An
EGD configuration for referenced devices is obtained from the EGD Configuration
Server if the configuration time is newer in the server than in the ToolboxST
application's local directory for that referenced device. For example, if your
ToolboxST system was located at C:\MySystem and a device was referencing a
device Dev1, the EGD configuration for Dev1 would be obtained from the EGD
Configuration Server if that configuration had a newer timestamp than the
configuration at c:\MySystem\Dev1. Otherwise the local c:\MySystem\Dev1
configuration would be used.
Host Name is the Host Name or IP address of the host running the EGD
Configuration Server.
Port is the server port value. The default is 7938.
Note This should not be changed unless the system administrator has installed a
custom EGD Configuration Server.
Timeout is the server connection timeout in milliseconds.
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.
GEH-6700J ToolboxST
Viewing Differences
Use the System Editor View menu or right-click the status bar shortcut menu to
compare the local configuration to the server configuration.
Or
GEH-6700J ToolboxST
View Differences displays a difference report for any consumed or produced data
file that exists in both the server and the local system.
View Server File allows you to view the server version of a selected document.
View Local File allows you to view the local version of a selected document.
Equalize Server to Match all Local System nodes makes equal any node that
is marked Not Equal by publishing the local configuration to the EGD Configuration
Server.
Empty Server, then Send all Local System nodes causes all EGD
configuration server content to be removed before the local system nodes are
published.
Note If a component in a .tcw file is not the latest configuration (for example, if the
most current configuration is on another computer), publishing the local EGD
configuration sends the old configuration to the server.
Send This Node Local To Server sends a local copy of a selected document to
the EGD Configuration Server. If the devices tree node is selected, all documents
under the device are sent to the server.
Delete This Node in Server allows you to delete a selected device in the server.
Refresh Display compares the local system to the EGD Configuration Server and
updates the display.
GEH-6700J ToolboxST
If the external device does not already exist as a ToolboxST component, create
External Device component to represent it. Refer to the section,
an
Components.
Select the external device in the System Editor Tree View. The component
properties display in the Property Editor.
Right-click the external device in the Tree View and select Get EGD from
SDB. A dialog box displays confirming the destination SDB Host and Path.
Click OK to proceed with the Get EGD from SDB operation. When it is
complete, the results display on the Log tab of the InfoView.
Note If the EGD Configuration Server option is enabled for the system, the EGD
configuration will also be put to the EGD Configuration server.
GEH-6700J ToolboxST
In this example, one of the ToolboxST.exe versions exactly matches the .tcw file
version so that entry is the default selection. Click the OK button to start
ToolboxST.exe v03.03.11B. Open the SystemConfigSample.tcw system
configuration after logging on to CMS. The Browse button allows you to locate and
start a version of ToolboxST.exe that is not installed.
GEH-6700J ToolboxST
SecurityST
The SecurityST feature is embedded within the WorkstationST or SecurityST tray
icon. A list of Users and a list of Roles can be configured for a ControlST system
using the system information editor. Each user is assigned a role and an optional set
of resources. User names correspond to Windows users, (work groups or domain
users). The diagram that follows displays how ToolboxST, CimView and CimEdit
authenticate with the Security function.
Remote computer
CIMPLICITY
Communication
Processes
OPC DA Private Security
CimView/
CimEdit
WorkstationST
OPC DA Server
CIMPLICITY
Communication
Processes
CimView /
CimEdit
Authentication UI
- Right-click allows for logon
or change of user (logout /
logon)
- UI displays to request
logon if users are configured
and a user is not already
logged on.
-The current user and role
display
ToolboxST
Logon Changed
Intercom Message **
Tray Icon
Security Login
Application
WorkstationST
Alarm Viewer
For more specific details regarding the security function, including configuration,
refer to GEH-6706, ToolboxST* User Guide for WorkstationST*.
GEH-6700J ToolboxST
The following property is associated with the Users and Roles item.
Auto LogOff Timeout is the time, in minutes, after which a user who has
temporarily logged on over the existing user, is automatically logged off. If set to 0,
auto logoff does not occur. When the temporary user is logged off, the previous user
is again active.
User settings include the following:
Name is the user name. In Windows Domains, the name can be the
Domain/UserName.
Role is the role associated with the user, which defines the users access privileges.
HMI Resources are the HMI resources associated with a user. They are configured
in the System Information Editor, with assigned variables. Users who have a
resource that matches a variables resource can write to live data for that variable if
that privilege is assigned. If a variable does not have a resource, it defaults to
allowing the user to modify the data if the users role supports that privilege. Users
with an empty list of resources are only allowed to modify variables without an HMI
resource defined.
Role settings include the following:
Name is the role name, which can be assigned to a user with all the privileges of
that role.
Live Data Modify Privilege allows you to modify live values.
Live Data Force Privilege allows you to force live values.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Logging On
From within the SecurityST User Logon Manager, you can:
The user selected replaces the current user. The previously defined user
privileges take effect.
To temporarily override the current user
GEH-6700J ToolboxST
The user Maint is now logged on over the current user (or now sub-user) operator.
The previously defined user privileges for maint take effect.
icon.
In the Property
Editor, enter the Auto
LogOff Timeout in
minutes.
If the temporary user remains inactive through the timeout period, that user is logged
off and this message displays.
GEH-6700J ToolboxST
Logging Off
To log off the Current User
Right-click the WorkstationST or SecurityST icon in the taskbar notification
area to display the shortcut menu.
The current user is now logged off. If the current user was the temporary user, the
sub-user now becomes the current user and previously defined user privileges take
effect.
GEH-6700J ToolboxST
Notes
GEH-6700J ToolboxST
CHAPTER 3
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:
GEH-6700J ToolboxST
Variables
Variables can be defined within programs, tasks, and user blocks. Task and user
block variables can be either global or local, but all program variables are global. A
variable must be global to be connected to either Turbine I/O or Ethernet Global
Data (EGD). A local variable is restricted in scope to its task or user block, meaning
it cannot be accessed from other locations. Global variables are referenced through
their Global Name Prefix property.
GEH-6700J ToolboxST
Function Blocks
The basic unit of application software in the controller is the function block. Each
function block corresponds to software on the controller and is represented in the
ToolboxST application by block libraries. These libraries are part of the installation
of a particular type of controller.
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 blocks context. The combination of the variable name with the blocks name
and context give each variable a unique name within the controller. Blocks in the
same user block can reference each others 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 blocks block
diagram. For more information about editing blocks, refer to the section, Block
Diagram Editor.
GEH-6700J ToolboxST
Instancing
If a library definition is changed, programs, tasks, or user blocks associated with the
definition are NOT automatically updated. This is true within a library container as
well as in a controller component.
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.
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.
GEH-6700J ToolboxST
Right-click the Libraries item and select Add Library. The Add New
Library dialog box displays.
In the Add New Library dialog box, type a name for the library, then click
OK.
Make sure the new library displays in the Summary View. If not, right-click
the Programs node in the Tree View, and then select Library References.
From the Tree View tab, select a Program or right-click to add a new
Program.
GEH-6700J ToolboxST
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
Edit the user block using the Summary View or the Property Editor.
From the Tree View, right-click the user block to be updated, then select the
Instance command from the shortcut menu.
GEH-6700J ToolboxST
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 .
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.)
GEH-6700J ToolboxST
From the File menu, select Upgrade to display the Upgrade Wizard.
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.
Adding Libraries
From the System Editor, double-click the Library Containers item to display the
editor window. Multiple libraries can be added to a library container to break up the
application software into separate pieces. These can be referenced individually in the
controller component.
GEH-6700J ToolboxST
From the Tree View, right-click the Libraries item, then select Add Library.
The Add New Library dialog box displays.
Note Each library is contained in an .xml file, and can be imported into other
library containers.
To add an existing library to the library container
1
From the Tree View, right-click the Libraries item, then select Add Existing
Library to display the Select Existing User Block Library dialog box.
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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Helpfiles contain
Block3.mht
Block4.htm
Search Order
The ToolboxST application first searches for a .chm file that corresponds to the
Library name. If this is not found, it searches in the HelpFiles directory for a help file
that matches the block name. The search order is: .mht, then htm, then .txt.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Expand the Table Definitions item and select the table definition to be
exported, such as
below.
Select the .csv table definition file (.csv) from the browser window and click
Save.
GEH-6700J ToolboxST
This feature allows you to edit the table data values in the controller. Once the table
data values are correct, click
capture the values in the ToolboxST configuration.
GEH-6700J ToolboxST
Build and download the application code. The output of the block displays as
shown below.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Build and download the application code. The output of the block displays as
shown below:
From the Tree View, right-click the library item and select Add User Block
Definition to display the Add New User Block Definition dialog box.
GEH-6700J ToolboxST
Add Variable allows a variable to be added to the selected User Block. Once the
new variable is added, properties become available in the Summary View. Refer to
the section, Property Editor .
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.
GEH-6700J ToolboxST
From the Tree View, right-click the User Block Definition (for example,
Lib1Usb1) and select Add User Attribute to display the Add User
Attribute dialog box.
Click the Attributes item in the Tree View to display properties in the
Summary View. The properties can be modified.
GEH-6700J ToolboxST
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 (for example,
Lib1Usb1) 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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Note When Update All Uses is selected, you are prompted to save changes if the
system determines that changes have not been saved. Once changes are saved, the
Controllers to Update dialog box displays.
Note The Enter Password dialog box displays if any password-protected actions are
requested.
GEH-6700J ToolboxST
The search results display in the Find Results tab of the Component InfoView.
GEH-6700J ToolboxST
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 Chapter 4, Block Diagram Editor.
GEH-6700J ToolboxST
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.
To print a component configuration
Open the Component Editor for the component to be printed. From the File
menu, select Print to display the Print Options dialog box.
Page Options tab allows you
to change the paper size,
margins, and orientation.
Page Numbering
options control page
number assignment.
Linear pages number
sequentially start with
page one.
Hierarchical page
numbers are same as
linear pages but also
numbers each section
and sub-sections, such
as 1., 1.1, 1.2.1 and so
on.
Prints a summary of
configuration settings
for the component.
Includes a list of
sections and page
numbers.
Includes a symbol
quick reference
guide.
Prints all software
programs in the
component.
Prints a reference to
all variables in the
component.
GEH-6700J ToolboxST
Device attribute
Open the ToolboxST application. From the File menu, select New System to
display the New System dialog box.
Enter a name for the new system, then click OK to display the System Editor.
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
With the Lib1Usb1 item highlighted in the Tree View, the Libraries tab
displays on the right side of the block diagram.
GEH-6700J ToolboxST
Drag a MOVE block from the Type Conversion category to the Block
Diagram Editor to add it to the user block. Repeat this process once more until
two MOVE blocks display on the block diagram.
GEH-6700J ToolboxST
Open the System Editor for the test system created in the previous procedure.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Enter the IP
Address.
Click Next
to continue.
GEH-6700J ToolboxST
Click the Software tab, then right-click the Programs item in the Tree View
to display the Programs shortcut menu.
Select Library References
to display the Library
References dialog box.
GEH-6700J ToolboxST
Right-click the Programs item again and select Add Program from the
shortcut menu. The Add New Program dialog box displays.
GEH-6700J ToolboxST
Right-click the Prog1 item in the Tree View to display the Program shortcut
menu.
Click Add Task to display
the Add Task dialog box.
GEH-6700J ToolboxST
Device Attribute
To add a device attribute
1
Open the System Editor for the test system created in the previous examples.
From the System Editor, open the controller Component Editor by doubleclicking the controller in either the Tree View or the Summary View.
GEH-6700J ToolboxST
Click theName
cell on the
append row
(indicated by
an asterisk*)
and typeAttr1
to name the
new attribute.
GEH-6700J ToolboxST
Change the data type to BOOL by clicking the Type cell on the Attr1 row and
then selecting BOOL from the drop-down list.
Change the initial value to False by clicking the Value field of the Attr1 row,
then clicking the ellipsis button
to display the Modify Value dialog box.
Click OK to accept
the new value.
GEH-6700J ToolboxST
Open the System Editor for the test system created in the previous examples.
From the System Editor, open the Library Container Editor by doubleclicking the Libraries item in the Tree View.
From the Tree View, select the MOVE_3 block item in the Tree View. In the
Property Editor, select the Instance Script field and click the ellipsis button
. The Edit Text dialog box displays with the default Instance Script:
Block.Include = Device.Attribute("Attr1").BoolValue
Add the text NOT between the equal sign and the word Device in the script to
negate the expression as follows: Block.Include = NOT
Device.Attribute("Attr1").BoolValue
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.
Change the value to True using the drop-down box, then click OK.
Right-click the
Move_2 block
item to display the
block shortcut
mentu, then
select Add.
10 Click the Software tab. From the Tree View, locate the Prog1 item. If it is
collapsed, click the plus symbol to expand it.
11 From the Tree View, right-click the user block Lib1Usb1, then select
Instance from the shortcut menu to update the user block. The user block
contents display in the Summary View with MOVE_1 and MOVE_2 blocks.
The block MOVE_3 was excluded by the instance script created in step 8
because Attr1 is set to True.
12 Click the General tab. From the Tree View, select Attributes. As before,
button. In the
click the Value cell in the Attr1 row, then click the ellipsis
Modify Value dialog box, set the attribute value to False and click OK.
GEH-6700J ToolboxST
13 Return to the Software tab. Right-click the user block Lib1Usb1 and select
Instance from the shortcut menu. This is the same operation that was
performed before, but since Attr1 is now set to False, the instance scripts
causes the block MOVE_2 to disappear and the block MOVE_3 to display on
the diagram instead.
14 Save the component by clicking the Save button
the editor by clicking the Close button .
Open the System Editor for the test system created in the previous examples.
From the System Editor, open the Library Container Editor by doubleclicking the Libraries item in the Tree View.
From the Tree View, expand the item Lib1 and right-click the Lib1Usb1 user
block to display the shortcut menu.
From the shortcut menu, select Add User Attribute to display the Add New
User Attribute dialog box.
GEH-6700J ToolboxST
From the Tree View, select the Attributes item. The Summary View
displays a list of attributes.
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.
Now that the attribute has been created, create a user block variable with text
substitution in its name. From the Tree View, click Variables.
10 From the Summary View, click the Name cell in the Append row (indicated
by an asterisk *) and {Attr1_u}_thing as shown below. Leave the data type set
to the default value, BOOL.
GEH-6700J ToolboxST
12 In the Summary View, double-click the enable pin of the block MOVE_1.
The Connect Pin dialog box displays.
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.
GEH-6700J ToolboxST
20 From the Tree View, right-click the Lib1Usb1 user block , then select
Instance. The value entered for Attr1_u is substituted into the variable
{Attr1_u}_thing and into the MOVE_1 ENABLE pin connection, creating a
variable named ABCDEFG_thing.
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.
GEH-6700J ToolboxST
Notes
GEH-6700J ToolboxST
CHAPTER 4
Click for a
wiring tool.
Click to
Click for shapezoom in
drawing tools.
and out.
Click to display
Detached
View.
Select a user
block in the Tree
View. The Block
Diagram Editor
displays in the
Summary View.
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.
GEH-6700J ToolboxST
Auto-Layout Mode controls how the blocks on the diagram are arranged. Refer to
the section, Layout Modes .
Diagram Settings... displays the Diagram Settings.
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.
Delete Sheet deletes the current sheet in manual mode.
Rename Sheetsopens the Rename Sheets dialog box.
Print Sheet... prints the current sheet.
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.
Paste inserts the contents of the clipboard at the selected location.
GEH-6700J ToolboxST
Renaming Sheets
Individual sheets can be renamed to follow any standard naming convention needed
for a particular system. The sheet names are used in page numbering and cross
references, and must be unique within a particular device.
To rename sheets
From the Tree View, right-click the Programs item or right-click anywhere in
the empty portion of the diagram. The Rename Sheets dialog box displays.
Software path and sheet number
Sheet Names
For a particular sheet, you can enter a complete sheet name or use certain
substitution characters to automatically number or letter the sheets within a particular
diagram.
Substitution
Character
Represents
Sheet number
Sheet letter
Example
{AttributeName} Attribute
GEH-6700J ToolboxST
Select Border or
Footer Options
Display a
preview of
selected
options
Edit
the
footer
Select Export or
Import to allow the
reuse of the border.
GEH-6700J ToolboxST
Border Options
Border Name and Border Description are text fields to describe the border.
Coordinates, when selected, draws the grid of letters and numbers on the border.
Outer Line, when selected, draws a rectangle around the outer edge of the border.
Inner Line, when selected, draws a rectangle around the inner edge of the border.
Footer, when selected, draws the footer. When unchecked the Footer Options and
Footer Block section of the dialog is grayed out.
Footer Height is the total vertical space allocated to the footer.
Footer Rows is the number of rows in the footer; each row is allocated vertical
space equal to the footer height divided by the number of rows.
Footer Columns is the number of columns in the footer; each column is allocated
horizontal space equal to the border width (which is paper size- dependent) divided
by the number of columns.
Preview
The Preview section allows you to display what the border looks like with the
current options. You can scroll the preview and zoom in and out. The footer cell
being edited in the Footer Block section is highlighted in the preview, and you can
left-click a footer block to select it for editing. You can also press and hold the left
mouse button and drag a footer block to move it around the footer.
GEH-6700J ToolboxST
Footer Block
The currently selected cell in the footer can be modified in the Footer Block section.
Next Cell selects the next cell in the footer (list is sorted in Z order back to front)
Previous Cell selects the previous cell in the footer (list is sorted in Z order back to
front)
Delete Cell removes the current cell from the footer. The button is only visible if a
cell is selected.
Create Cell adds a new cell to the footer at the current Row and Column. The
button is only visible if no cell is currently selected. Clicking an empty spot on the
footer in the Preview makes the Create Cell visible and preset the Row and Column
fields to where you clicked in the preview.
Row is the top-most Footer row for the current cell. It does not need to be within the
footer boundaries, which allows special effects like non-rectangular footers.
Column is the left-most Footer row for the current cell.
Height is the number of rows taken up by the current cell.
Width is the number of columns taken up by the current cell.
Empty, when selected, causes the cell to show no content.
Text allows you to enter custom text into the cell.
Sheet Information allows you to display a pre-defined cell.
Image allows you to display an image in the cell.
Export saves the current border from the editor to a specific .xml file.
Import loads a specific border .xml file into the editor.
Cancel closes the editor without saving changes.
OK saves the editor to the .xml file for the current device. The border .xml file is
always named SheetBorder.border.xml, and is saved in the same location as the
device .xml file.
GEH-6700J ToolboxST
Custom Text
Select this option to edit the following:
Caption is text displayed in a smaller font on first line of the cell
Text is text displayed in a larger font on the second line of the cell.
For both fields, text is clipped to the size of the cell (no wrapping), and both support
Attribute substitutions. For example if the custom Text for a border cell is Custom
Text with {Attr1} substitution, the {Attr1} is replaced with the current value of the
User Attribute Attr1 in whatever context the border is drawn. If Attr1 is not defined,
it is removed from the text. These attribute substitutions allow you to customize
footer contents for specific programs, tasks, or user blocks; you can also define
attributes at the device level.
GEH-6700J ToolboxST
Sheet Information
Select this option to edit the following:
Information Type provides a drop-down list of different pre-defined cells
Requisition information from the system and device includes:
Customer Site
Customer Name
Drawing Number
Engineer
Requisition Number
Process Application
DM Number
Serial Number
Machine Size
Last Modified
Print Date
ToolboxST Version
Component Name
Software Path
Sheet Number
There is also a special automatically generated cell called Title. This cell displays the
Description text associated with the User Block or Task. If that Description is blank,
Title looks for the first block contained in the User Block or Task that has a
Description that is not blank. If no block Description is found, Title looks for the first
Text Shape drawn in the User Block or Task.
Certain user blocks and library blocks are designed to be dragged from the
ToolboxST Software tab to the CIMPLICITY application. This screen-building
software allows you to create graphical objects to represent a block, as well as
automatically configure the graphical objects to use global variables defined by the
block.
GEH-6700J ToolboxST
An example of
bad status
An example of
good status
GEH-6700J ToolboxST
Bad status
flows through
the Add block.
Certain blocks, such as the analog input (AI) block always use status. Pins that have
status contain a small slash, which indicates that more than one value is represented
by the line. Status pins can be connected to each other or connected to non-status
pins or immediate values. If a non-status variable or immediate is connected to a
status input pin, the pin always has the default status value.
Live value in
(paranthesess)
Status value
Combined is an
AnalogWithStatus
GEH-6700J ToolboxST
Block Shapes
Blocks can have powerful animated graphical representations. Block shapes, which
are defined for each block in the standard block library and in certain optional
libraries, greatly enhance readability of blockware diagrams as displayed in the
examples below.
GEH-6700J ToolboxST
Some complex blocks have functional groups of input and output pins.
Grouped
input pins
Certain blocks automatically hide pins that do not apply to the configured mode of
operation, as shown below.
Note Pins hidden by animations always display if they are connected to a variable.
GEH-6700J ToolboxST
MODE_OPT
set to NONE
MODE_OPT
set to AUTO
displays Auto
mode pins
GEH-6700J ToolboxST
Auto
mode
pins
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.
Managing Blocks
To add a block from the Library View
Select the category in the Library View that contains the desired block, then
drag the block to the Block Diagram Editor. The block displays on the Block
Diagram.
Or,
From the Tree View, right-click a task, a user block, or a block, then select
Add Block. The Select Block to Insert dialog box displays. Select the
desired block and click OK to add it to the Block Diagram .
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Destination (a
new rubber pin)
Color
Normal
Black
Poor
Magenta
Red
False
Gray
Forced True
Orange
Forced False
Blue
GEH-6700J ToolboxST
Note While using the zoom tool, hyperlinks in the diagram are active.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Block Help shows reference documentation on the selected block type in a help
window.
Add To Trend allows you to open a new Trender window. The block is
automatically added to the new Trender.
Add to Watch allows you to open a new Watch Window. The block is
automatically added to the Watch Window.
Go To Definition allows you to locate the variable definition.
Compare To Definition allows you to display a difference report that compares
the userblock instance and its library definition.
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.
Unhide all Pins causes the pins to display.
Copy allows you to copy a block. Paste displays to allow you to paste the copy to
the Block Diagram Editor.
Cut allows you to cut a block from the Block Diagram Editor.
Delete allows you to delete a block from the Block Diagram Editor.
Bring 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.
Paste After allows you to insert whatever is on the clipboard but sets the execution
order of the blocks to be immediately after the right-clicked block.
GEH-6700J ToolboxST
Connecting Pins
To connect a single pin
From the Block Diagram Editor, double-click a pin. The Connect Pin
dialog box displays.
This tab is a quick reference
showing the variables
connected to the selected pin.
Creates a new
variable in the
user block.
Option buttons
specify the type of
connection.
GEH-6700J ToolboxST
The Connection
column can be edited.
Sorted
columns
Pins represent inputs and outputs of a block. Parameters are a special type of Pin that
are always Inputs, and are usually constant values that control block operation. Most
Parameters are drawn on the Blockware diagram under the block; typically, they do
not display if they are left to their default initial value.
Tip Pressing Enter while entering text selects the next pin on the block, allowing
rapid entry of connections.
GEH-6700J ToolboxST
Toolbar
Button
Displays:
Variable only:
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Boolean Values
Numerical Values
Current value
of the variable
Enter new
variable value.
Enter a value to
be added to , or
subtracted from ,
the variable.
Click to increase or
decrease the variable
by the delta value and
send to the controller.
GEH-6700J ToolboxST
Array Values
When you are finished
changing values, click here
to close the dialog box.
Double-click an element of
the array to display the
associated Send Value
dialog box.
GEH-6700J ToolboxST
Inputs
GEH-6700J ToolboxST
Local
input
Global
variable
Undefined
variable
EGD
variable
Pin
callout
Note For each variable on the rail, cross references to other variable usages display.
From the Block Diagram Editor, select the Variable Rail drawing tool.
Press and hold the left-mouse button on the blockware diagram sheet, then drag
the mouse until the size and location of the new variable rail displays. Release
the mouse button when you are satisfied with the location of the rail.
To define a rectangular
area for the rail, click
and drag the cursor.
Note Clicking in the right or left two inches of the sheet docks the rail to the sheets
edge.
GEH-6700J ToolboxST
OR
Drag a pin or variable
from a block to the rail.
OR
Right-click the
rail to add
either a Global
Variable, a
Local Variable
or select from a
list of recently
used variables.
GEH-6700J ToolboxST
Note Variables from other windows (Watch Windows, Trenders, and such) can be
dragged and dropped into a variable rail, as well.
Click to select a desired variable, then drag the variable from the rail and drop it
onto a Block pin to form a wired connection.
GEH-6700J ToolboxST
Go To Where Used displays a list of all places that the selected variable is used
(hardware I/O, EGD page, and such)
Add To Trend add the selected variable to a defined Trender.
Add To Watch adds the selected variable to a defined Watch Window.
Go To Definition navigates to the location where the variable is defined. It
automatically selects the Where Used tab in the Component InfoView.
Change Live Value displays the Change Live Value dialog box (you must be
online to use this menu option).
Add To EGD allows you to set the EGD page for the selected variable.
Text Tool
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.
GEH-6700J ToolboxST
Rectangle/Ellipse Tools
The Rectangle and Ellipse Tools draw simple geometric shapes with
configurable line and fill colors.
GEH-6700J ToolboxST
Image Tool
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.
Image shapes have the following properties:
Metafile Path displays the path to the .wmf or .emf file containing the image that is
displayed.
Left displays the left location of the shape.
Top displays the top location of the shape.
Width displays the width of the shape.
Height displays the height of the shape.
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.
GEH-6700J ToolboxST
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
GEH-6700J ToolboxST
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.
To configure diagram settings
1
Right-click an open area of a diagram while in Edit mode and select Diagram
Settings. A dialog box displays with the available scopes.
GEH-6700J ToolboxST
The Edit Diagram Settings dialog box allows you to edit the following options:
Size selects the paper size.
Landscape, when checked, makes the longest dimension of the paper, the
horizontal dimension, creating a drawing that is wider than it is tall.
Font Sizes controls the font sizes in the diagram.
Hide Unused Pins, when checked, hides unconnected pins.
Show Block Drawings, when checked, graphically displays block operation
whenever possible.
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.
Rung Editor
Boolean logic functions are added to a block diagram inside special blocks called
rung blocks. Rung blocks are named after a component of a Relay Ladder Diagram
(RLD). In a RLD, one or more contacts (which function similarly to a mechanical
relay switch) are connected as a control network for a single coil, or output. As the
diagram is formed with two vertical buses, one representing power and one
representing ground, the completed diagram resembles a ladder, with each coil and
associated contacts resembling a ladder rung. Rung blocks, like the rungs in a relay
ladder diagram, control a single output.
GEH-6700J ToolboxST
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.
To open the RLD Editor
From a Block Diagram, double-click a Rung Block.
or,
Right-click a Rung Block. From the shortcut menu, select Edit Ladder
Logic.
The RLD Editor window consists of both a 16x16 or smaller grid of cells that can
contain contacts or wires and a set of tools used to edit the contents of the cells.
Wiring tools
Drag separators to
add or remove rows.
GEH-6700J ToolboxST
Contacts
Each contact represents a virtual relay switch that is controlled by a Boolean
variable. Contacts that either represent a variable directly
or the negation of the
variable are added to a ladder diagram using the contact tools.
To add a contact
Double-click inside the cell above the newly inserted contact to open the
Connect Contact dialog box.
Wires
Wires are used to connect contacts to the coil and to each other.
To add a wire
A good wire
GEH-6700J ToolboxST
A bad wire
Coils
The diagram always has one coil.
To connect the coil to a variable
Double-click the coil to open the Connect Contact dialog box. (Refer to the
section, Contacts .)
Errors
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.)
GEH-6700J ToolboxST
CHAPTER 5
Creating an SFC
To create an SFC
1
From the Mark VIe Component Editor, select the Software tab, then rightclick the Programs item and select Add Program to add a program.
Right-click Prog1, then select
Add Special Task and Add
Sequential Function Chart
from the drop-down list. The
Add Sequential Function
Chart dialog box displays.
GEH-6700J ToolboxST
From the Add a Sequential Function Chart dialog box, add an SFC, then
click OK. The new SFC displays in the Tree View.
From the logic editor, you can define and edit the SFC.
Note When the SFC is created, the Initial Step is already defined.
The following properties are available in the Property Editor when the SFC item is
selected in the Tree View:
Description provides a description of the SFC.
Name is the name of the SFC.
EGD is the EGD page that contains all published variables from the SFC.
New Transition Condition Options sets the default contents of the Transition
condition logic.
Protection provides access rights.
Put Action of Interest Status on EGD, if set to True, publishes the Action of
Interest status variables on the EGD page.
Put Step Active Times on EGD, if set to True, publishes the Active Time
variable for each Step on the EGD page.
Put Transition Progression Status on EGD, if set to True, publishes the
Transition progression status variable for each Transition on the EGD page.
Version is the user-defined version of an SFC.
GEH-6700J ToolboxST
Editing an SFC
To edit an SFC
From the toolbar, click the Edit SFC
button.
Toolbar Buttons
Button
Use to
Toggle between editing and viewing modes
Edit SFC
Run the SFC
Run SFC
Pause the SFC
Pause SFC
Reset a paused SFC (if the SFC is running, Reset is disabled)
Reset the SFC
Place a Hold on every Transition in the SFC
Single Step
SFC Status
(Offline) indicates that the ToolboxST application is not online with the controller
PAUSED indicates that the SFC is not running (Action and Transition condition
logic is not running)
RUNNING indicates that the SFC is active (Action logic in active Steps is running,
and Transitions are being evaluated
SINGLE STEP indicates that the SFC is active, but a Hold was placed on all
Transitions.
COMPLETE indicates that the END Transition was reached and the SFC is
complete
Change the zoom level of the SFC logic editor
Zoom In, Zoom Out
Select Steps and Transitions
Select Tool
Create a new Step
Step Tool
Create a new Transition
Transition Tool
Create a new END Transition
END Transition Tool
Align multiple selected shapes
Alignment Tool
GEH-6700J ToolboxST
To add a Step
From the SFC toolbar, click the Step button
To add an Action
From the SFC toolbar, click the Select button
The Edit actions for step dialog box displays.
Click the Add Action
button to add an action.
GEH-6700J ToolboxST
Action Qualifiers
Qualifier
Description
The Action runs for a specific number of milliseconds while the Step is
Active, indicated by the Time value, then stops running.
The Action does not run until the number of milliseconds indicated by the
Time value has been reached, after which the Action runs every frame the
Step is Active.
The Action runs only once and is triggered by a rising edge on the Actions
Pulse Input.
L and D Action Qualifiers: A Time value, either a reference variable or an
immediate value, must be specified in the Time column for the Action.
P Action Qualifier: A Pulse Input Boolean value must be specified in the Pulse
Input column for the Action.
By default, a PERMIT block is automatically created in a new Transition. The output
of the PERMIT is connected to the Transition_Condition_Value, and any conditions
for the Transition can be connected to the PERMITs inputs.
The PERMIT standardizes the Transition conditions so that HMI screens have a
common method to display information about Transitions.
Note The Active and Finished fields indicate the status of the Action.
To define an Actions logic
From the SFC toolbar, click the Select button, then double-click a step. The
Edit actions for step dialog box displays.
An Action can be authored in Terms of Blockware in the logic sheet.
Note Always connect the Action_Finished local variable to a Boolean expression.
The Action_Finished variable enables the Actions of Interest feature to know that the
Action has finished its operation. This is recommended even if the application does
not use Actions of Interest.
GEH-6700J ToolboxST
Adding a Transition
To add a Transition
From the toolbar, click the Transition button
, then move the cursor to the
sheet and click. The Add Transition dialog box displays.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Move the cursor to the SFC logic sheet to place the End Transition. The Add
Transition dialog box displays. Enter a name, then click OK.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the toolbar, click the Select button, then click the Step or Transition to
be moved.
GEH-6700J ToolboxST
Variable Connections
There are several required variable connections when defining SFCs in the
ToolboxST application. When defining a Transitions Transition Condition, always
connect the Boolean expressions output to the Transition_Condition_Value local
variable. This enables the Transition to progress.
When defining a Steps Action Logic, always connect a Boolean expression to the
Action_Finished local variable. This enables Actions of Interest Control to be used in
the SFC by having the Action state when it has finished. This is recommended even
if Actions of Interest Control is not being used in the application. It makes using the
Actions of Interest Control feature in the application much easier later in
development if needed.
From the Mark VIe Component Editor, click the Go On/Offline icon to go
online with the controller.
From the Software tab Tree View, select the SFC item to open the logic sheet
.
Click OK to
continue.
To pause the SFC, click the Run button to display the Pause SFC dialog box,
then click OK.
GEH-6700J ToolboxST
To place the SFC back into Free Running mode, click the Mode button again to
display the Free Running mode SFC dialog box, then click OK.
Note When the SFC is placed into Single Step Mode, all Implicit Holds are removed
from Transitions, and previously set Operator Holds are restored.
To apply or remove Operator Holds
1
From the logic sheet, right-click the Transition, then select Apply HOLD to
Transition to display the Apply HOLD to Transition dialog box.
Click Yes to
acknowledge
the Hold.
Note If the Transition Condition for Trans1 was set to True at the time the HOLD
was acknowledged, the SFC would continue.
GEH-6700J ToolboxST
Run
Reset
Transition Hold
In addition, the SFCs Step Active Flags, Transition Active Flags, and Transition
Condition Value are placed onto EGD automatically.
The user has an option to place items from the SFC Monitor Interface on EGD.
These items include Action of Interest Status, Transition Progression Status, and
Step Active Times variables. By default, the Step Active Times are automatically
placed on EGD in the ToolboxST application.
To place an SFC and its Control Interface on EGD
1
From a Mark VIe Component Editor, select the Software tab, then from the
Tree View, select an SFC.
From the Property Editor, select EGD
Page. From the drop-down list, select
the EGD page on which the SFC and its
control interface will be published.
GEH-6700J ToolboxST
To remove the SFC from EGD, use the same drop-down list and select the blank
entry.
GEH-6700J ToolboxST
CHAPTER 6
GEH-6700J ToolboxST
Enter the IP
Address.
Click Next
to continue.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
The Mark VIe component editor displays in the Tree View and in the Summary
View.
GEH-6700J ToolboxST
The Component
InfoView displays
feedback information on
the currently selected tab.
Summary View
The information displayed in the Summary View depends on the item selected in the
Tree View. There are many types of summary views ranging from the block
diagram, which is specialized to edit application software, to simple lists of
referenced files where no editing is possible.
GEH-6700J ToolboxST
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.
The Min-max button
allows you to quickly
resize the Tree View and
the Property Editor
within their shared view.
Double-click on the
double bar to view the
Property Editor in a
separate detached
window.
If no button displays, edit the value directly in the corresponding text box on the
right side of the Property Editor.
GEH-6700J ToolboxST
Component InfoView
The color on the Status
tab indicates the overall
state of the controller.
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.
Find Results tab displays the results of the Finder.
Info tab displays context-sensitive descriptions for the selected Tree View or
Summary View item.
GEH-6700J ToolboxST
Log Tab
When the Log tab is selected, three buttons display in the toolbar at the bottom of the
Component Editor.
Click each of the buttons to hide the corresponding
items (for example, click the Warning button to hide
the warnings in the Log tab).
Each time a Build command is performed, the Log tab is updated with current errors,
warnings, and general information. Concurrently, with each Build command, a file is
generated in the component folder that reflects the contents of the Log tab. This file,
called Build.log, remains until the next Build command then is updated.
The build.log is generated each
time a Build command is performed.
GEH-6700J ToolboxST
Data Grids
Data Grids are used to view or edit many of the configuration properties available in
ToolboxST component editors. While each Data Grid contains different columns and
properties, several features are common to all Data Grids, including column resizing,
clipboard operations, and multi-row editing.
Note Some Data Grids, especially those without an Append Row, may not support
all features described in this chapter.
Click to select
entire grid.
Sort indicator
Drag borders to
resize columns
Column
headers
Row
headers
Currently
selected row
Append
row
Selected cell
Editing Data
To...
Do this:
GEH-6700J ToolboxST
Left-click the row header for the first row to be edited. Then, while pressing the CTRL
key, left-click added row headers. After selecting all desired rows, use the Property
Editor to change properties for all selected rows. (Some properties are omitted when
a group of rows is selected, and properties with conflicting values will display no
value in the property editor.)
Organizing Columns
The columns of a Data Grid can be customized. You can select the columns that
display, the column order from left to right, the column width, and the sort criteria.
To...
Do this:
Resize a column
Drag the vertical bar on the right of the column header to a new location.
Sort by a column
Right-click any column header and select Organize Columns to display the
Organize Columns dialog box.
Add selected
column to the
data grid.
Remove selected
columns from the
data grid.
Move the
selected
column up or
down in the
column order.
Remove all
columns from the
data grid.
GEH-6700J ToolboxST
Do this:
Right-click the header for the source row and select Copy Selected/Current Rows to
place the source row on the clipboard. Then, right-click the header for the append
in the destination grid and select Paste Row(s) to insert the row into its
row
new location.
Left-click the row header for the first source row. Then, while pressing the CTRL
key, left-click added row headers. After selecting all desired rows, continue to hold
down the CTRL key and right-click any selected header. From the shortcut menu,
select Copy Selected/Current Rows to place the rows on the clipboard. Then, rightin the destination grid and select Paste
click the header for the append row
Row(s) to insert the rows into their new location.
Click the top left cell of the desired range and drag to the bottom right cell. Rightclick the selected region and select Copy Selected/Current Rows to place the cells
on the clipboard. Then, click the top left cell of the destination range and drag to
select the same number of columns and rows that were copied to the clipboard.
Right-click inside the destination region and select Paste Row(s).
Arrange windows on screen so both the source and destination grid are visible. (An
entry in a Tree View is acceptable as a destination) Left click the row header for
the first row. Then, while pressing CTRL, click any added row headers to be moved.
Release the CTRL key and drag a row header to the new data grid.
Arrange windows on screen so both the source grid and a destination block
diagram, Trender window or watch window are 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.
GEH-6700J ToolboxST
Component Options
The ToolboxST application provides settings that change the way various functions
within the component operate.
To open the Settings dialog box
From the Component Editor, select the Options menu, then select Settings
to display the Settings dialog box.
Note In the Settings dialog box, categories are listed in a Tree View on the left side
of the dialog box.
GEH-6700J ToolboxST
Security
The security provided in the ToolboxST application is based on passwords entered
by the user. Passwords ensure that only authorized persons can view or make
changes to system components.
The two types of protection available are called Access Rights.
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.
The title bar indicates which access right is protected.
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.
GEH-6700J ToolboxST
Select the desired access right, such as Modify Design, and then click the
button. If there is already a password on that access right and it has
Ellipsis
not yet been entered, you are first asked for the password before being allowed
to change it. The Change Modify Design Password dialog box opens.
Click OK to apply
the change.
Password Caching
The security system caches passwords that were previously entered so that once you
enter a unique password, you dont 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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Protected Objects
Specific actions governed by each access right depend on the specific component
type. Examples of protected objects are:
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.
GEH-6700J ToolboxST
General Tab
The General tab allows you to configure general properties and attributes of a Mark
VIe controller, including redundancy (simplex, dual, or Triple Modular Redundant
(TMR)) and frame rate (its basic scheduling rate).
To configure Mark VIe general features
From the System Editor, double-click the Mark VIe Component to display
the Mark VIe Component Editor. The General tab is selected by default.
Property Editor
allows you
to edit the item
currently selected in the
Tree View.
GEH-6700J ToolboxST
The following properties are available in the Property Editor when the General item
is selected in the Tree View:
Command Event Log stores information about alarm transitions, event
transitions, variable set commands, and such on the controller file system. This data
can be viewed for analysis by an external client through a web interface.
% Command Size specifies the maximum size (as a percentage) of both the
command and event portions of the Command and Event log.
% Event Size specifies the maximum size (as a percentage) of the event portions of
the Command and Event log.
Log to Disk specifies whether Command events should be logged to the
CompactFlash on the controller.
Time specifies the number of days that the Command and Event log is kept if the
allocated space is not exceeded.
Compressed Data Log activates the compressed data logging, which causes
selected variables to be collected in the controller data log file.
Note The Compressed Data Log property is only available when the application
running is a 1.5 MW Wind Turbine.
GEH-6700J ToolboxST
% Size specifies the maximum size (as a percentage) of the Compressed Data log.
Average Interval Time specifies the interval in minutes over which the data is
averaged and stored.
Enable Compressed Data Log, when set to True, activates the Compressed Data
Log. This causes selected variables to be collected in the controller data log file.
Time specifies the number of days the Compressed Data log will be kept so long as
the allocated space is not exceeded.
Controller Web Pages, when set to True, enables access to controller web pages
if they are provided by the controller or another product. The controller can provide a
set of default pages as part of the firmware download. Product web pages can also be
downloaded to the controller. For example, the 1.5MW Wind Turbine uses productspecific web pages that are downloaded separately.
Enable Controller Web Pages, when set to True, activates the Web server on the
controller. It also displays the Web Page Tab.
Password allows you to create or change a password.
Web File Path is the directory used as the web page source when downloading
product web pages to the controller.
Application reflects the application type.
Controller Backup Option determines how backup files are handled during the
Build and Download commands.
Automatic, the default, creates backup files in a device.zip file during a Build
command, and provides an option in the Download Wizard to download the
device.zip file.
Manual mode does not create a device.zip file so there is no option to download
backup files from the Download Wizard.
Enable Auto-Reconfiguration, if set to False, disables the AutoReconfiguration feature (the default is True).
Enable Incremental Build, if set to False, disables the Incremental Build feature
(the default is True).
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.)
Minor Revision is the time of the build performed after the most recent minor
change (minor changes do not require a controller restart).
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 can only be changed from the
System Editor.
NTP Configuration Mode determines how the Network Time Protocol client
synchronizes the controller time. Valid options are:
GEH-6700J ToolboxST
Unicast The client uses the specified servers to obtain the time.
Modify Data permits modification of data values and the forcing of variables.
Logic forcing procedures can result in personal injury or death, if
not strictly followed. Only adequately trained personnel should
modify any programmable machine. Forcing of control logic for
an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly enforced in
conjunction with this procedure.
TMR a triple module redundant configuration where there are three controllers
that vote on decisions for reliability.
GEH-6700J ToolboxST
Note he two properties below are only available when the application running is a
1.5 MW Wind Turbine.
Enable Wind Farm Management System, when set to True, allows a wind
turbine to be controlled by the wind farm controller.
Wind Farm Management Server IP Address displays the IP address of the
Wind Farm Management Server.
Note The four properties below are only available when the application running is a
Wind Control.
Max Wind Farm Turbines is the maximum number of wind turbines for this
Wind Control. If this number is reduced after the turbines have connected, those
turbines are disconnected from Wind Control when the timeout parameter set in the
Wind Turbine Timeout (sec) property is reached.
Wind Farm Master Number is the master plant number for this Wind Control.
Wind Farm Update Time (ms) is the time, in milliseconds, to update all wind
turbines.
Wind Turbine Timeout (sec) is the time, in seconds, at which timeout data is
received from the wind turbines.
GEH-6700J ToolboxST
Attributes
Attributes are device-level values that affect how the configuration is generated.
When the Attributes item is selected in the Tree View, those controller attributes can
be edited in the Summary View data grid.
GEH-6700J ToolboxST
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).
GEH-6700J ToolboxST
Network Adapters
The network adapters that are present in the controller display as items in the Tree
View. The number of adapters depends on the controllers hardware type and
configuration. In most applications, Mark VIe controllers have four network
adapters. The first adapter provides connectivity to the Unit Data Highway (UDH),
and any additional adapters are used for I/O networks. Some adapter properties may
be disabled in certain configurations.
GEH-6700J ToolboxST
When a Network Adapter item is selected in the Tree View, the following properties
display in the Property Editor:
Enabled, if set to False, disables the selected network adapter.
Host Name is the Internet Protocol (IP) host name for the selected network adapter.
IP Address is the IP Address for the selected network adapter.
Wire Speed is the speed of the network to which the selected adapter is connected.
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.)
GEH-6700J ToolboxST
Auto-Reconfiguration
The ToolboxST application provides a feature called Auto-Reconfiguration, which
allows you to replace a pack and have the necessary configuration files downloaded
when that I/O pack is replaced. It requires no user interaction once power is restored
to the pack after replacement. The Auto-Reconfiguration feature can be disabled
from the Property Editor. This feature is available with GE ControlST release
V03.05 or higher.
Note The Auto-Reconfiguration feature applies only to I/O packs; it is not available
for controllers or terminal boards. Refer to GEH-6721, Vol II, Mark VIe Control
System Guide for a list of I/O packs.
GEH-6700J ToolboxST
Upgrading
To upgrade the ToolboxST application
Install the new version. Refer to the section, Installation (on page 2). The icons
on your desktop and in your Start menu are 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.
To upgrade a component
1
Install new software for the component type that you want to upgrade by
installing the latest version of the ToolboxST application.
Start the ToolboxST application and open the system file. Double-click a
component to open its Component Editor.
From the File menu, select Upgrade. The Product Upgrade Wizard
displays.
Click Next.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Compare To Controller
This feature allows you to generate a report that compares the configuration in the
ToolboxST software to the controller configuration.
To generate a Compare to Controller report
1
From the System Editor Tree View, double-click the Mark VIe component
to display the Mark VIe Component Editor.
The report displays configuration differences in areas such as hardware and software.
Differences are arranged in appropriate groups and sub-groups.
GEH-6700J ToolboxST
Compare Devices
This feature allows you to compare the configurations of two different components.
To generate a Compare Devices report
GEH-6700J ToolboxST
Command
Use to
File
Save
Upgrade
Compare to
Controller
Compare Device by
Program(s)
Compare Devices Compare ToolboxST component configurations
Edit
View
Import
Import an I/O Variable Report, a global Variables Report or a Block Pin Report from a .csv
file
Close
End the component editing session and return to the System Editor
Undo
Redo
Cut
Copy
Paste
Paste the copied item in the Tree View into the Summary View
Delete
Display the System Information Editor (refer to the section System Information Editor)
Find
Display the Component Editor for the item currently selected in the Tree View
Bookmarks
Go Back
Return to the view that immediately preceded the current view in the history
Go Forward
Return to the view that immediately follows the current view in the history
Forced Variables
Trenders
Watch Windows
Display a list of Watch Windows for this component (refer to the section, Watch Windows)
Live Views
GEH-6700J ToolboxST
Reports
Variable generates a report of all global or configuration variables in the component. You
can also generate a Web variable report, a Compressed Data Log variable report, or an
EGD point list report.
I/O Diagnostics generates a report of all faults, revisions, communication, and hardware
issues.
Coding Practices generates a list of unwritten variables, a list of multiple writes, and a
list of unused I/O variables.
Auto Config generates either a Configuration report or a Difference report.
Device
Control Constants
Diagnostics
Profiler
EGD Management
Tool
Start the EGD Management Tool (refer to GEI-100619, EGD Management Tool (EMT).
Online
Build
Convert the current configuration into binary files that can be downloaded to a controller
Download
Controller Setup opens a wizard that allows you to perform basic configuration tasks.
Download Wizarddownloads base load, firmware, and application code to the
controller and distributed I/O modules.
Update Dynamic Data Recorder exchanges updated information with the DDRs in
the controller.
Retrieve configuration information from the controller and uses it to create a new controller
component in the system.
Restore Password
Protection
Options
Settings
Help
Contents
Controller Help
Distributed IO Help
Release Notes
About
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
Network Redundancy
A controller can have one, two or three I/O networks in a simplex, dual or TMR
configuration. The configuration of network redundancy is separate from controller
redundancy and module redundancy.
To change the network redundancy
From the Hardware tab Tree View, select the Distributed I/O item.
GEH-6700J ToolboxST
Adding Modules
To add a module to a component configuration
From the Hardware tab, right-click the Distributed I/O item in the Tree
View and select Add Module to display the Add Module Wizard.
GEH-6700J ToolboxST
Click Next.
Note If the module being added does not have an auxiliary terminal board, the
window shown below does not display.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Organizing Modules
Modules can be organized into groups.
To create a group
From the Hardware tab Tree View, right-click the Distributed I/O item and
select Add Group. The Add Group dialog box displays.
Select the Type (Cabinet or General)
from the drop-down list. Selecting
General changes the icon to a folder
labeled I/O.
Enter a
Description of
the group
(optional).
Select the Icon to
display in the Tree
View.
Click OK.
GEH-6700J ToolboxST
Modifying Modules
To modify an existing module
From the Tree View, right-click the module to modify, then select Modify...
from the shortcut menu to display the Modify: [module name] dialog box.
Viewing Modules
Group Layout
GEH-6700J ToolboxST
Network Layout
Click the folder
icon to select
network 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.
GEH-6700J ToolboxST
Summary Tab
The Summary tab displays a graphical overview of the selected module.
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 Adva
nced and are
hidden by default. To display Advanced parameters, click the Show/Hide
Advanced button on the toolbar.
GEH-6700J ToolboxST
Variables Tab
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.
Inputs/Outputs Tabs
These tabs contain input/output variables found on the module terminal boards,
which can be associated with the application software.
Note For some modules, these tabs are split into more module-specific input/output
tabs that better define their function.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
If the variable name entered is a defined variable, it continues to display and the
cursor moves to the next field.
If the variable name entered is undefined, the Undefined Variable dialog box
displays. Click Yes to select the desired software item, as shown above.
ExtraCircuits Tab
This tab contains I/O variables (with associated screws in sub-tabs) that have no
meaning to software or firmware, such as those used for excitation.
GEH-6700J ToolboxST
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
Status Tab
The Status tab allows you to check the I/O pack version and network communication
status.
Prod ID
Exch ID
EGD exchange ID
Health
Period
Size
Port
Recv Cnt
Missed Cnt The number of times the exchange was not received
Late Cnt
GEH-6700J ToolboxST
Upgrading Modules
It is possible to perform an upgrade to the runtime and the I/O firmware
simultaneously. The component and specific I/O modules can be upgraded to a
newer version of the runtime and firmware, as well.
To perform a unified upgrade
From the File
menu, select
Upgrade. The
Mark VIe Product
and IO Pack
Version Upgrade
Wizard displays.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Click a new
module version
to upgrade the
module.
GEH-6700J ToolboxST
Note When the ToolboxST V3.05 application is installed, the Upgrade option
allows you to upgrade Mark VIe-related packs to work with the AutoReconfiguration feature (refer to the section, Auto-Reconfiguration). After a
component has been upgraded, you cannot undo the upgrade. You also cannot
upgrade a component to its current or a previous revision. Only newer revisions
display in the drop-down list of revision options in the Upgrade Wizard.
Diagnosing Modules
When a problem with a module is detected, symbols display in the Summary tab. All
symbols provide ToolTips.
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.
Note You must be online to view diagnostics (except for reports).
GEH-6700J ToolboxST
Note Place the mouse over the icon to display detailed messages regarding the
problem.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Each report contains configuration or diagnostic details about the I/O hardware in a
component.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.
Comparing Parameters
While making changes to a modules configuration, it is often useful to compare the
downloadable configuration items currently stored in the pack with the current
configuration of the same items in the ToolboxST application.
As module parameters directly affect the operation of the
controller and associated I/O modules, always check the
Compare Parameters dialog box before downloading new
parameter values to a component to reduce the risk of improper
operation or damage to the unit.
To open the Compare Parameters dialog box
From the Hardware tab Tree View, right-click a module to compare and select
Compare Parameters. The Differences dialog box displays.
The differences between the controller
and the ToolboxST configuration are
displayed in a hierarchical tree view.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
To submit an SCR
File
Type
Provides
.txt
.txt
.txt
.txt
.xml
GEH-6700J ToolboxST
Software Tab
The Software tab in the Component Editor contains all application software
downloaded to that controller.
The Tree View displays an
outline of the application
software. When Programs is
expanded, all programs in the
controller display.
Under the Programs item are
tasks, which can be scheduled.
Each user block contains
variables, attributes, and blocks.
The Summary View displays
all software files associated
with this controller, including
function block library DLLs,
user block libraries and
program files.
The Programs item at the top of the Tree View 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.
GEH-6700J ToolboxST
Adding a Program
The Programs item allows you to add programs to a controller.
To add a program
From the Tree View, right-click the Programs item to display the Programs
shortcut menu.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Library References
A controller has two types of libraries:
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
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.
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.
GEH-6700J ToolboxST
From the Tree View, right-click the Programs item, then select Library
References. The Library References dialog displays all available user
block libraries.
From the Optional Libraries tab, select the check box next to libraries that
you want to reference 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 It is not possible to undo this command.
GEH-6700J ToolboxST
Overridable Properties
It is possible to select properties to be overridden.
To select overridable properties
The Protection
property defines
access rights to
the overridable
properties list.
GEH-6700J ToolboxST
Adding a Task
Tasks can be inserted within a program:
To add a task
From the Tree View, right-click on an embedded or unlinked program name to
display the shortcut menu.
Right-click the
program name,
then select Add
Task to display
the Add Task
dialog box.
GEH-6700J ToolboxST
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
GEH-6700J ToolboxST
The Summary View of a user block displays the block diagram for either the user
block selected in the Tree View or its container.
If the task is selected, the block
diagram displays the contents of
the task, as follows.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Unlink Permanently
A program that is linked to a library container can be permanently unlinked from the
component.
To unlink a program
From the Tree View, right-click a program item, then select Unlink
Permanently.
The linked icon next to the item in the Tree View changes and the program is
unlinked from the library.
Note Linked tasks and user blocks can also be unlinked permanently.
GEH-6700J ToolboxST
Property Editor
The Property Editor displays different properties, depending on which item is
selected in the Tree View.
Remove Unused Variables removes the unused variables for all linked user
blocks in this device when the user block is instanced.
GEH-6700J ToolboxST
Description allows you to describe the program. Click Description and then click
to enter text.
Library Type is only used for legacy Mark VI software conversion.
Name allows you to name the program.
Protection expands to show the access rights for this program.
Execution Order sets the order of execution of this program in the controller.
GEH-6700J ToolboxST
BlockType is the name of the user block definition in the library from which this
user block started.
Description is the description of this user block.
Name is the name of this user block.
Protection expands to show the access rights for this user block definition.
Version is the user-defined version of a user block.
Execution Order sets the order of execution in the program.
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 Type is the name of the library block that the selected block is an instance
of.
GEH-6700J ToolboxST
Instance Name is a unique identifier that allows the block to be referenced from
other locations in ToolboxST.
Instance Script causes the script to run when the block is instanced.
Height is the height of the selected block in the diagram.
Left is the location of the left of the selected block.
Selected Pin is the pin currently highlighted in the diagram.
Show Description, when set to True, displays the description of the selected
block.
Top is the location of the top of the selected block.
Width is the width of the selected block.
Block Data Type is the data type for variant pins in the selected block instance.
Detached Summary File is the backsheet for the selected block.
Enable, when set to True, enables variables for the selected block.
Version is the version number for the source of the selected block instance.
Execution Order determines when this block is started.
GEH-6700J ToolboxST
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. Undefined variables for tasks and
user blocks are local variables that have been referenced within the task or user
block.
To add a variable to a program
From the Software tab, expand the Programs item.
User block and task variables are local by default, and display under the associated
user block item in the Tree View.
GEH-6700J ToolboxST
Editing Variables
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.
Click a program or task variable to
display and edit a list of variables
and their properties in the Data
Grid Editor.
GEH-6700J ToolboxST
Alarm Severity is the value assigned to an alarm in the active state. The valid
range is 1through 1000, where 1 is the least severe.
Alarm, if set to True, enables the variable as an alarm. Alarms are used for problems
that require the operators 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.
Normal Severity is the value assigned to an alarm in the normal state. The valid
range is 1through 1000, where 1 is the least severe.
Plant Area places variables into logical plant groupings for display in the
WorkstationST Alarm Viewer.
SOE Description cannot be modified. It is automatically entered from the
hardware library if the hardware point is defined as a Sequence of Event (SOE).
SOEs are similar to event messages except they are associated with I/O transitions,
instead of application-variable transitions. They are also typically timestamped to a
much finer resolution (1ms) than alarms or events.
Visibility determines when the pin is shown on the block diagram.
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 property 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 displaylow property is not specified, the Format Spec Engineering Min is used.
Display Screen is the default HMI screen for this variable.
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 entryhigh property 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 entrylow property is not specified, the Format Spec Engineering Min is used.
Format Spec can be assigned to a variable. These are system-owned format
specifications unique for each measurement system and grouped into sets. (For
example, a temperature set may contain a format specification for English in degrees
Fahrenheit and one for metric in degrees Celsius.
HMI Resource allows access and visibility of variable and alarm data to be
customized.
GEH-6700J ToolboxST
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.
Array is the number of elements in this array variable.
Connection allows a variable to be connected to another variable.
Description is the variable description.
Enumerations are values represented in separate .csv files.
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.
Name is the variable name.
Nonvolatile indicates that the variable should be saved in non-volatile RAM.
Type is the variable data type.
Historian Deadband enables the automatic collection by the Historian when:
Boolean and set to Logged on Change
Analog and set to 0 or higher
Historian Deadband Definition defines the deadband value as either engineering
units or percent of range.
Recorder Deadband enables the automatic collection by the Recorder when:
Boolean and set to Logged Continuous or Logged on Change
Analog and set to 0 or higher
Recorder Deadband Definition defines the deadband value as either engineering
units or percent of range.
Control Constant allows a variable to be configured as a setting that is initialized
at startup to its initial value. Control constants can be viewed from the toolbar by
clicking View\Control Constant.
Download Info, if set to True, downloads extended information to the controller
that is used by the web server, as well as other processes.
EGD Page is used to assign the variable to an Ethernet Global Data Page.
External Access is used primarily for EGD.
GEH-6700J ToolboxST
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.
Usage defines the behavior of pins on a user block.
Input pins are shown on the left of the user block.
Output pins are shown on the right side of the user block.
State pins are shown on the right side of the user block.
Constant entry is a number. No live data is provided for this pin.
Virtual HMI Point, if set to True, imports the variable into the HMI as a virtual
point.
Controller Collected, if set to anything other than Not Logged, logs the value to
the Compressed Data Log in the controller.
Note The Controller Collected property is only available when the application
running is a 1.5 MW Wind Turbine.
Override Properties, if set to True, allows certain properties of a linked variable
to be modified. The allowable properties are defined in the Overridable Properties
dialog box.
Note The Override Properties property is only available for global variables that are
contained within a linked program, task, or user block.
Override Value, if set to True, allows the Initial Value of a linked variable to be
modified.
Note The Override Value property is only available for control constants that are
contained within a linked program, task, or user block.
GEH-6700J ToolboxST
Table Definitions
Many complex mechanical interactions can be modeled using lookup tables. The
controller implements these tables using table definitions. A table definition is
similar to a signal definition, as both are similarly named and are used in instruction
blocks. Table definitions are added under the Programs item in the Tree View. Refer
to the section, Importing Table .csv Files.
A table definition consists of a name, note, identification string, revision string,
engineering units (EUs), data array dimensions, adjust flag, minimum and maximum
Z values, and data. The data consists of one or two independent arrays (X and Y) and
a dependent array (Z).
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:
GEH-6700J ToolboxST
Right-click the program name and select Import Table.csv file from the
shortcut menu to display the Table Definition dialog box.
Select the desired table definition file and click Open. The Table Definition file
is inserted into the program.
GEH-6700J ToolboxST
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
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.
GEH-6700J ToolboxST
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:
Execution Order sets the order of execution in the program.
Task Name is the name of this task.
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 controllers frame period, which is set on the
General tab.
Description is the description of this user block.
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.
GEH-6700J ToolboxST
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.
To instance a user block
GEH-6700J ToolboxST
From the Software tab, expand the User Block item to display the Variables
item.
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 Attributes
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 .
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Configuring DDR
To configure a DDR
From the System Editor, double-click the Mark VIe Component. The
Component Editor displays.
From the Component Editor, click
the Dynamic Data Recorder tab.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Appearance
Name is the user-defined description for this DDR, which is used for the filename.
Setup
Auto Enable, if set to True, automatically re-enables the DDR after 60 seconds
once it is uploaded.
Buffer Control
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 is 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.
Upload Type
Manual allows the user to manually upload the DDR.
Automatic is an automatic upload by the data collection.
Trip is an automatic upload by the data collection, then added to the trip log.
Enable is the setup variable that enables the DDR.
Trigger is the setup variable that triggers the DDR.
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
Enable enables the DDR.
Trigger triggers the DDR.
Trigger Setup
Trigger Comparison Type
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.
GEH-6700J ToolboxST
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
Edge is triggered on the rising edge of the trigger variable.
Level is triggered on the true condition of the trigger variable.
Status Variables
Status variables, which indicate the status of the associated DDR, are used to
determine when to upload the data. Status variables are always integers, and are
automatically defined and placed on the EGD status page.
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.
GEH-6700J ToolboxST
To add a variable
1
From the Component Editor, select the Dynamic Data Recorders tab to
display the DDR list.
Right-click the desired
DDR and select Add Variable.
Updating DDR
DDRs can be updated separately from the application code download.
To update a DDR
From the Device menu, select Download, and then select Update Dynamic
Data Recorder. Or, click the Update Dynamic Data Recorder button
.
Note DDRs cannot be downloaded if there is a major difference in the device. In
this case, the application code must be downloaded.
GEH-6700J ToolboxST
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.
To export a DDR to a .xml file
GEH-6700J ToolboxST
From the File menu, select Export, and Selected Item. Or, right-click a DDR
in the list and select Export Configuration from the shortcut menu.
DDR Setup
This procedure explains how to set up a DDR to capture two variables.
1
Right-click the Prog1 item and select Add Variable. In the Add New
Variable dialog box, enter DDREnable (Boolean), which is used to enable
the DDR.
From the Add New Variable dialog box, add a variable DDRTrigger (Real),
which is used to trigger the DDR.
From the Add New Variable dialog box, add two variables TriangleOut and
SineOut, which are connected to the output of the function blocks. These
variables are added to the DDR variable collection.
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.
Add the two variables SineOut and TriangleOut to the DDR. Set the Frame
Period Multiplier to 3, which means a sample is collected every 120 ms. The
base frame period is typically 40 ms. Set the PreTrigger samples to 20 and the
Post Trigger samples to 100, so that the entire capture takes 14.4 seconds.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
The DDR is enabled with the DDREnable variable and the Trigger uses the
DDRTrigger variable. The DDR is triggered when the DDREnable is True
and the DDRTrigger is greater than or equal to 5.
Go Online to the controller. From Prog 1, select the Variables item. Doubleclick the green live data for the DDREnable variable. Set to True and send to
the controller.
The status of the DDR can be checked on the EGD page. When the DDREnable is
True and the DDR is not triggered, it is in the Waiting state, as shown below.
GEH-6700J ToolboxST
10 Set the value of the DDRTrigger variable equal to or greater than 5, then send
to the controller. The status indicates the Capturing state.
GEH-6700J ToolboxST
When the capture is complete, the status indicates Done, and the DDR can be
uploaded.
11 The Trender is used to upload the capture buffer. From the View menu, select
Trenders to add a new trend. The Trender window displays.
GEH-6700J ToolboxST
12 Select + and the Trender wizard displays. Select Capture Buffer to select the
DDR to upload. The uploaded DDR variables are shown below.
GEH-6700J ToolboxST
EGD Configuration
To configure EGD for a component
1
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
From the Tree View, right-click the Produced Pages item, then select Add
Page. The Page Name dialog box displays.
Note When the first Produced Page is created, it automatically becomes the Default
page.
GEH-6700J ToolboxST
From the Property Editor, select the Default Page Property, then select the
desired page from the drop-down list.
Tip Any variable defined with $Default as the EGD page name is automatically
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 properties
for the selected
page display in
the Property
Editor.
GEH-6700J ToolboxST
The following properties are available for configuration when a Produced Page is
selected in the Tree View:
Ethernet 0, if selected, causes EGD to be broadcast on Ethernet Adapter 0. (If more
than one Ethernet Adapter has been configured for EGD, additional Ethernet
properties display.)
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.
Exchanges indicates the number of exchanges in the selected page. It is updated
after a build.
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.
Name renames the selected page.
Period indicates the transmission period of the page in milliseconds.
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 exchanges skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchanges skew is two, the second exchanges skew is four and
the third exchanges 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.
Status Page is used by WorkstationST to provide standard variable information.
GEH-6700J ToolboxST
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. A page compression causes an exchange major signature. Consumers can
mark the exchange variables as unhealthy until the consumed configuratuion can be
rebound.
To compress a single page
From the Tree View, right-click the page to compress, and then select
Compress.
GEH-6700J ToolboxST
Variables
To add a variable to an EGD page
1
From the Component Editor Tree View, right-click the desired page, and
then select Add Variable. The Select a Variable dialog box displays.
GEH-6700J ToolboxST
Tip If the variable to be added to the EGD page is already in use on the Software
tab, you can add the variable without using the EGD tab. To add a variable from the
Software tab, select the desired variable(s) in the Summary View, and then set the
EGD Page property using either the Summary View or the Property Editor.
To delete a variable from an EGD Page
From the Summary View, right-click the variable to delete, and then select
Delete Selected Row(s).
GEH-6700J ToolboxST
From the EGD tab, select the Configuration tab, then select a Produced
Page in the Tree View.
Review the warning about manual Exchange Signature editing, then click
OK.
Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.
GEH-6700J ToolboxST
EGD Diagnostics
The EGD protocol includes a command mechanism that obtains the status of a Class
2 or higher EGD device. Mark VIe is a Class 3 EGD device. When any EGD item in
the Tree View other than a referenced device is selected, the EGD Statistics from
[Device] tab displays the statistics from the open component. When a Referenced
Devices item is selected, the statistics are obtained from that referenced device, and
the name of the tab page changes accordingly.
Note You must be online to view diagnostic information.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
Referenced Devices
The EGD variables defined in other components can be added to the current
components 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.
The EGD configuration for the selected devices are loaded and the variables display
in the Summary View.
Note When EGD configurations are edited in remote devices, you must refresh the
configuration to ensure that the latest variable information is used. The configuration
is automatically refreshed when a component is opened, and when a Build is
performed in the component.
To refresh the configuration of a referenced device
From the Tree View, right-click the device to be refreshed, and select
Refresh.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
The Modbus slave feature allows a Modbus master to read and/or write data
directly from the Mark VIe, using the Modbus protocol over Ethernet or serial ports.
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
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.
Ethernet Port specifies the Ethernet port to be used for slave-Ethernet
communication. The valid port choices are 502 and 503.
Interface
Interface sets the interface type:
Serial is only supported on Mark VIe gateway Modbus.
Ethernet is supported on both.
Shared (both Ethernet and serial) is only supported on Mark VIegateway Modbus.
None indicates that the slave feature is not available.
Serial Settings
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.
Inter-Character Timeout (ICT) specifies the timeout period expressed as
character time X 10. For example, 35 represents 3.5 character times, or 0.0036
seconds at 9600 baud, 1 start bit, no parity, 1 stop bit. The valid range is 35 to 1000.
Parity specifies check character. The choices are None, Odd, Even, Mark, and
Space.
Port specifies the serial communication port (COM2).
Response Delay is an additional delay time in milliseconds before the slave
responds to a master request. The valid range is 0 to 999.
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.
These additional settings apply to both Ethernet and serial communications.
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.
GEH-6700J ToolboxST
Settings
Example
If set to True
If set to False
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 (readonly or read/write) and the type of data (a Boolean or a 16-bit word) as follows:
Data Types
GEH-6700J ToolboxST
Page
Data Type
Access
Holding Register
16-bit Register
Read/Write
Coil
Single Bit
Read/Write
Input Register
16-bit Register
Read-only
Input
Single Bit
Read-only
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.
When a variable is added, the following columns display:
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.)
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.
Raw Min, Raw Max, Eng Min, and Eng Max are columns that convert Modbus
slave variable data into engineering units. The Raw Min and Raw Max columns
control the minimum and maximum for the raw data. The Eng Min 0 and Eng Max
columns control the minimum and maximum engineering units to which the raw data
will be scaled. (The BOOL data type cannot be scaled.)
Name is a read-only identifier automatically generated from the register page name,
the address, and, if necessary, an added unique number.
For more information, refer to the following links:
For Modbus resources, go to: http://www.modbus.org http://www.modbus.org
For Modbus protocol, go to: http://www.modicon.com/techpubs/toc7.html
http://www.modicon.com/techpubs/toc7.html
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
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.
To sort a column
From the Report window, click any column heading to apply a sort to the
associated column. The first click sorts the column ascending; a second click
switches the column to a descending sort.
To change report columns
From the Report menu, select Change Columns to display the Select E1
Attribute Values Report Columns dialog box.
GEH-6700J ToolboxST
Filtering Rows
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
the equation).
Lists available
columns (doubleclick 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.
>
<=
>=
<>
LIKE
Expression to the left of the operator must match the wildcard expression to the right of the
operator.
AND
Expressions to the left and right of the AND operator must both be True.
OR
Either the expression to the left or to the right of the operator must be True.
NOT
GEH-6700J ToolboxST
When using the LIKE operator, you can prefix or suffix a wildcard character
like * to the right-hand value. This wildcard character * can stand for any
number of alphanumeric characters, including zero. The wildcard character *
can only be present at the beginning and/or the end of the right-hand value (for
example, *value or value* or *value*)
GEH-6700J ToolboxST
The filter expression shown below selects all contact and input digital I/O points
[IOVariable] LIKE Contact* AND [ModuleName] LIKE PDIA*
GEH-6700J ToolboxST
Finding Data
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.
Click to locate and highlight
the next instance of the
search text in the report.
Enter the
search text.
If selected, the
capitalization in the
report and the
search string must
exactly match.
From the File menu, select Import, then select I/O Variable Report to
display the Open Report... dialog box.
From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.
GEH-6700J ToolboxST
From the File menu, select Import, then select I/O Configuration Report to
display the Open Report... dialog box.
From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.
To import a Global Variable report
From the File menu, select Import, then select Global Variable Report to
display the Open Report... dialog box.
From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.
To import a Block Pin report
GEH-6700J ToolboxST
From the File menu, select Import, then select Block Pin Report to display
the Open Report... dialog box.
From the Open Report... dialog box, select a report, then click Open to
import the data. Any data that cannot be imported is highlighted when the
imported report displays.
GEH-6700J ToolboxST
Unwritten Variables are used in blockware logic, but have no assigned values.
Multiple Writes are variables used in multiple locations, such as blockware logic,
EGD, or I/O point configuration.
Multiple Output Assigned Variables displays all variables attached to more
than one output.
Unused I/O are connected I/O values that are not used anywhere.
Spares are unconnected and unused I/O values.
An example of a Coding Practices report is as follows:
GEH-6700J ToolboxST
Auto-Reconfiguration Reports
The Auto-Reconfiguration reports include: Configuration and Difference. If one or
more I/O packs are configured in the Hardware tab, the Configuration report displays
details about what files are downloaded for the packs. Each pack must have a unique
barcode (configured in the Add Module Wizard when the pack is added) or it is not
included in the report.
Note The contents of both types of reports can be exported to a .csv file.
Configuration Report
To generate an Auto-Reconfiguration Configuration report
From the View menu, select Reports, Auto-Reconfiguration, and
Configuration. The Auto-Reconfiguration Configuration Report screen
displays.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Difference Report
An example of a Difference report is as follows.
The Item column
displays each
configured pack.
GEH-6700J ToolboxST
If Difference Report is selected from the View menu, but no differences exist
between the ToolboxST configuration and the Auto-Reconfiguration server, the
following message displays.
GEH-6700J ToolboxST
Status Tab
The Status tab at the bottom of the Component Editor displays four different states.
Equal displays if there are no differences between the ToolboxST configuration and
the Auto-Reconfiguration server.
Unequal displays if there are differences between the ToolboxST configuration and
the Auto-Reconfiguration server.
Disabled displays if the Auto-Reconfiguration property is set to False in the
General tab Property Editor.
Downloading displays if a download is occurring.
GEH-6700J ToolboxST
Forced Variables
Forced variables are variables and I/O points whose value is permanently overridden
with a specific value. They are managed using the Forced Variables window while
connected to a controller.
Logic forcing procedures can result in personal injury or death, if
not strictly followed. Only adequately trained personnel should
modify any programmable machine. Forcing of control logic for
an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly enforced in
conjunction with this procedure.
To open the Forced Variables window
Open a Mark VIe Component Editor. From the View menu, select Forced
Variables to display the Forced Variables window.
GEH-6700J ToolboxST
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 Property Editor displays
properties for the currently
selected row in the data grid.
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.
GEH-6700J ToolboxST
Watch Windows
A Watch Window is a collection of variables that display, along with their attributes
and live values, in a stand-alone window. The Watch Windows feature can also be
accessed from the ToolboxST System Editor, as well as from the individual
Component Editors. Once a Watch Window is created, it can be exported to .xml and
.csv files.
To open a stand-alone Watch Window
From the Start menu, select All Programs, GE ControlST, ToolboxST,
and Watch Window.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Export button
Note If this is the first time the Watch Windows dialog box has been opened for
the selected component, the list is empty. Add or import a new Watch Window.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the Watch Window dialog box, either add a new Watch Window or
double-click to open an existing one.
Adding a Variable
Use the Add Wizard to add a variable to a Watch Window.
To add a variable
1
From the Edit menu, select Add Variable and Using Add Wizard
GEH-6700J ToolboxST
GEH-6700J ToolboxST
If you selected
System Component
in the previous
screen, select the
desired component
from the drop- down
list, then click Next.
GEH-6700J ToolboxST
To remove a
variable, select it
and click the
Remove button.
When all variables
have been added,
click Finish.
GEH-6700J ToolboxST
Managing Variables
Once a variable has been added to a Watch Window, right-clicking the variable
allows you to perform the following actions.
Add Variable allows you to add additional variables.
Select All selects all variables for removing, pasting, or copying to the clipboard.
Remove Variable(s) removes selected variables.
Go to Definition allows you to display the variable definition from its location.
Change Live Value allows you to change the live value when the Watch Window
is online with the controller.
Copy to Clipboard allows you to copy the selected variable to the clipboard.
Paste allows you to paste a variable to another location, such as a Trender.
Add to Trender allows you to add selected variables to a Trender.
From the Watch Window, double-click the live value of a selected variable.
The Send Value dialog box displays.
Enter the desired value, select the Force Value check box, then click Send
and Close.
GEH-6700J ToolboxST
Select the check box next to the correct value to synchronize the constant, then
click OK.
For constants in which the Initial Value was checked, the Initial Value is sent to
the controller, making the Live Value equal to the Initial Value.
For constants in which the Live Value was checked, the Initial Value is set equal
to the Live Value.
Drag-and-Drop
Variables can be moved to other windows and editors using the drag-and-drop
feature. For example, you can drag:
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 either an .xml or a .csv file, which can then be
imported into another component. This allows you to use a previously selected
collection of variables.
To export a Watch Window to an .xml file
1
From the Watch Windows dialog box File menu, select Save As. The Save
Watch Window File dialog box dipslays.
In the Watch Windows List dialog box, select the desired Watch Window,
then click the Export button. The Export Watch Windows dialog box
displays.
In the Watch Windows List dialog box, click the Import button. The Import
Watch Windows dialog box displays.
GEH-6700J ToolboxST
From the Watch Windows List dialog box File menu, select Add Existing.
The Add Existing Watch Window dialog box displays.
LiveView
LiveView allows you to display a graphical representation of live data from various
sources in the system. LiveViews can be added to a ToolboxST system or
component. Once added, they can be edited.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
To start a LiveView
From the Tree View, double-click the LiveView item. The LiveView
displays.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the View menu, select LiveViews. The LiveViews dialog box displays.
Right-click the desired LiveView, then select View. The LiveView displays.
From the View menu, select LiveViews. The LiveViews dialog box displays.
Right-click the desired LiveView, then select View. The LiveView displays.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Standard Toolbar
The standard toolbar contains the following buttons.
Stop the
running
LiveView
Delete
Save
Cut
Redo
Copy
Paste
Undo
Run the
Liveview
Layout Toolbar
Additional layout buttons are as follows.
Make Control Width
Equal
Align Rights
Align Centers
Center Vertically
The selected controls are
centered vertically to the
panel
Align Lefts
Tab Order
Full Screen
Toggles between full
screen and normal
mode
Advanced Mode
Toggles between
Simple and
Advanced Mode
Align Centers
The selected controls
Horizontal center are aligned
to the horizontal center of the
Primary selection
Send to Back
Bring to Front
Align Tops
The selected controls Top are
aligned to the top of the
Primary selection
Align Bottoms
Center Horizontally
GEH-6700J ToolboxST
LiveView Controls
The General controls are as follows.
Label is a convention
label control.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Attaching a Variable
Use the Add LiveView Item Wizard to add a variable to a LiveView.
To attach a variable
1
From the Tools window, either double-click or drag Var:Live onto the design
surface.
GEH-6700J ToolboxST
Or
GEH-6700J ToolboxST
The Attach Variable Wizard displays. From the welcome screen, click Next.
The data source of the variable is selected from the next wizard screen .
Click Next
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the Select a Variable dialog box, select the desired variable, then click
OK. The variable displays in the wizard screen.
Once variables have been attached to a LiveView by using the wizard, additional
variables can be attached directly from the system component.
To attach additional variables
Right-click the variable property, then
select Attach Variable and From G1.
The Select a Variable dialog box displays.
Note You can also attach a variable by entering the variable name in the variable
property.
GEH-6700J ToolboxST
Saving a LiveView
To save a LiveView
Variable Definitions
It is possible to find and display a variable definition.
To display a variable definition
GEH-6700J ToolboxST
Control Constants
Control constants are special read-only variables that are important to key control
algorithms. Control constants must always have a Global scope.
To convert a variable to a control constant
1
From the Software tab, locate and select the variable to convert to a control
constant.
From the Property Editor, locate the Scope property and verify it is set to
Global.
From the Property Editor, change the value of the Control Constant
property to True.
From the Property Editor, assign an Initial Value and edit to Property
Editor. (Optional)
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
I/O CheckOut
The I/O CheckOut feature allows you to verify the operation of each I/O point.
To display the I/O CheckOut points
From the Hardware tab Tree View, right-click a board.
From the View menu, select I/O
CheckOut . The I/O CheckOut for
[component name] screen displays.
GEH-6700J ToolboxST
Notes
GEH-6700J ToolboxST
CHAPTER 7
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.
GEH-6700J ToolboxST
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.
The color on the Status
tab indicates the overall
state of the controller.
Color
Conditions
Green
Yellow
Red
GEH-6700J 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
Data initialization
Inputs enabled
Wait in this state for all required I/O packs to start transmitting inputs
Input voting
Exchange initialization
Exchanging
Sequencing
Turn on the application code and execute each task at least once
before driving outputs
Controlling
Turn on outputs
Loading
Load complete
Fail
GEH-6700J ToolboxST
If the indicated Control State is not Controlling, the ToolboxST application can
provide additional information as follows:
Select the Control State.
GEH-6700J 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.
Application Code contains the configuration of the controller as created in the
ToolboxST application. Whenever a change is made to the configuration, the
application code must be downloaded. There are two types of application code
download, online and offline. An online download, which is common, changes the
configuration without interrupting control; the new configuration takes effect
between control frames. An offline download requires a controller restart, and is
much less frequent. The type of download needed is determined by the types of
changes that have been made to the controller configuration.
Boot loader, base load, firmware, and offline application code
downloads all require the target device to be restarted. Before
downloading new code to a controller, take necessary steps to
secure the controlled equipment to prevent equipment damage
and/or personal injury.
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.
View / Set Time is used to set the time on a controller.
GEH-6700J ToolboxST
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
1
Connect a serial cable from the main board of the controller to a free serial port
on your computer.
Open the Mark VIe Component Editor for the controller to be configured.
From the Device menu, select Download, and then Controller Setup. When
the Welcome window displays, click Next to continue.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.
Boot loader, base load, firmware, and offline application code
downloads all require the target device to be restarted. Before
downloading new software to a controller, take necessary steps to
secure the controlled equipment to prevent equipment damage
and/or personal injury.
To download software to a controller
1
Open a Mark VIe Component Editor. From the Device menu, select
Download, and then Download Wizard to display the Download Mark VIe
Controller wizard.
If you have changed configuration settings since the last Build operation, a
message box displays indicating that the software is out of date. Click Yes to
build the current configuration. The Download Mark VIe Controller wizard
opens.
GEH-6700J ToolboxST
Click the Next button to advance past the wizards introductory page.
If the Scan I/O checkbox is selected, the scan
command determines whether I/O module
software needs to be downloaded.
Click Next.
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Note During this time period, the controller Editor window displays to allow you to
confirm that the code changes being downloaded are functioning properly. You can
navigate the configuration, as well as access the Trender, Watch Windows and
LiveView features.
GEH-6700J ToolboxST
If you are not satisfied with the code changes during the two-minute time period,
click the Revert button. This causes the second controller to become the
designated controller and causes the first controller to revert its running
configuration to the previous version.
If you initiate a
download after
performing the
revert function, the
second controller
displays as the
designated
controller.
Note If you do not click either the Accept or Revert buttons during the two-minute
time period, the revert function is automatically invoked.
GEH-6700J ToolboxST
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.
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-6700J ToolboxST
GEH-6700J ToolboxST
When the upload completes, click Next to display the final page of the wizard.
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.
The status of
the message
(0-inactive,1- active).
The human
readable description
of the message.
GEH-6700J ToolboxST
From the View menu, select Diagnostics, then I/O Diagnostics. The I/O
Diagnostics View displays.
GEH-6700J ToolboxST
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.
Note Before modifying Totalizer values in a redundant controller, connect to the R
controller and make sure all other redundant controllers are healthy and
communicating.
To view Totalizer values
1
From the Device menu, select Administer Totalizers to open the View/Set
Totalizers dialog box.
Click here to
close the dialog
box.
GEH-6700J 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.
To request a Totalizer password
1
From the Device menu, select Administer, and then Totalizers to open the
View/Set Totalizers dialog box.
Under Totalizer Identifier and Password, click the Request button. A file
named Totalizer_ID.txt is created in the same folder as the controller
configuration files on your disk. Open the file in Notepad.
To obtain a password,
follow the appropriate
directions.
Paste the password in the Password: text box. If the password is valid, a
countdown timer displays to indicate the time remaining before the password
expires.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
CHAPTER 8
Chapter 8 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
From the toolbar, click the
Finder button.
Enter text to
search for
Select a
search type
Click to display
available wildcards
Click Find to
begin search
process
Click Replace
for options to
replace text
Select to
include variable
descriptions in
the search
Select Entire
System to search
every component in
the System Editor
Select to include
libraries in the
search if a library
editor is open
Select to
include block
diagram items
in the search
Select to search inside
blocks below the current
location. If not selected, only
the current level is searched.
Select Open
Components to
search all those
open in the
System Editor
Select to keep
Select to search
Finder open
inside the current
between searches component
Select to search
inside the currently
selected item
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.
GEH-6700J ToolboxST
Find Methods
A variety of find methods are available that control how the text entered in the Find
box is matched to text in the ToolboxST application.
Anywhere finds the specified text anywhere within a searchable text string.
A search for
matches
abc
abc
abdc
abcde
ab
xyzabc
bc
zabcz
Begins with finds the specified text only at the beginning of a searchable text
string.
A search for
matches
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
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
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
abc
abc
abcde
abc cde
xyzabc
abdc
ab
bc
spell your abcs.
GEH-6700J ToolboxST
Wildcards is similar to Match Exactly, except any single letter can substitute for a ?
character and any sequence of zero or more letters can substitute for a * character.
A search for
matches
a?c
abc
abdc
adc
bc
abc cde
abcde
xyzabc
a*
abc
bc
adc
cde abc
abcde
abdc
ab
abc cde
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
[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
GEH-6700J ToolboxST
Replace Options
Besides performing simple searches, the Finder also supports search-and-replace
operations.
To display the Replace options
In the Finder window, click the Replace button. The window expands to
include new options.
In the Replace With:
text box, add the text
to be substituted
GEH-6700J ToolboxST
CHAPTER 9
Chapter 9 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.
GEH-6700J ToolboxST
Graph View
contains the trend
graphs, which
display the values
represented by
each trace.
X-Axis markers
designate alarm
and event times.
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
displays traces
currently being
monitored by the
Trender window.
Auxiliary View
Mode Indicator
contains tabs that displays the
display
current mode
information about (Live or Replay).
the current data.
GEH-6700J ToolboxST
Trender Toolbar
Note The Trender toolbar may have fewer buttons if the current Trender window
was opened from the ToolboxST application.
Open existing
Trender window
Save current
Trender
Undo
Redo
Create new
Trender Window
Print
Print Preview
Go Online
Data Toolbar
Note The buttons available on the Data toolbar may vary according to the current
trace source type.
Record data from
live source
Pause
GEH-6700J ToolboxST
Add traces
Remove
selected traces
Zoom In &
Zoom Out
Auto-range
selected traces
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 .)
To add traces
1
From the Edit menu in the Trender window, select Add Traces. If there are
currently no traces on the Trender, the Trender Add Trace Wizard
Welcome screen displays. From the Welcome screen, click Next to continue.
From the following wizard screen, select the data type you wish to trend.
Historical data is stored in all
Historians associated with the
currently configured controller.
From the next wizard screen, select the data source from which to add the
variables to trend.
From the next wizard screen, select the specific component from which to select
the variables to trend.
GEH-6700J ToolboxST
From the next wizard screen, select the time period at which the variables will
trend.
GEH-6700J ToolboxST
Select a variable,
then click OK.
If there are already traces on the Trender, you can add additional traces from the
same component.
GEH-6700J ToolboxST
From the Edit menu, select Add Traces. The Select a Variable dialog box
displays available variables for that component.
Note You can add traces from the currently selected component or add traces from
a new component by selecting Add using Add Trace Wizard from the drop-down
list.
The selected variable displays in the Traces tab in
the Trender windows Auxiliary View.
Live Trends
When a Trender window contains live trends, it displays the incoming data onscreen
in real time. Live trends are useful for monitoring systems in continuous operation.
To add one or more traces from a live source
GEH-6700J ToolboxST
If the Trender window to which you would like to add the trace is not already
open, refer to the section, Accessing a Trender Window .
From the Edit menu, select Add Traces. (or click the Add Traces button on
the data toolbar). If there are already traces on the trender, the Select a
Variable dialog box for the current data source displays, which you can use to
select the variables to monitor. If there are no traces on the trender, the Add
Trace Wizard displays. If there are traces and you would like to add traces for
a different live data source, you can also invoke the Add Trace Wizard by
clicking the drop-down list attached to the Add Traces button.
If this is the first trace added to the Trender window, the Add Trace Wizard
prompts you for the type of trend to configure. Select Live, then click Next.
If you did not open the current Trender window from the ToolboxST
application, the Add Trace Wizard prompts you for the name of the system
file that contains the source component. Click the Browse button to locate the
system file, then select Next.
Select the component from which you wish to trend variables, then click Next.
Select the sampling period you wish to use, then click Next. (The sample period
represents the time in milliseconds between samples, so larger numbers result in
fewer samples.)
From the next wizard screen, click the Add button to display the Select a
Variable dialog box, then select one or more variables to monitor. When you
are finished, click OK in the Select a Variable dialog box, then click Finish
in the wizard screen. The newly created traces display in the Traces tab.
From the File menu, select Properties or click the Trender Properties
button. The Settings dialog box displays.
GEH-6700J ToolboxST
If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.
From the Edit menu, select Add Traces. The Add Trace wizard displays.
If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Capture Buffer /
Dynamic Data Recorder, and then click Next.
Select the component from which to trend variables, then click Next. A list of
all available capture buffers displays.
Select one capture buffer, and then click Finish. All of the variables from the
selected buffer convert into traces and the Trace tab is updated to reflect the
changes.
GEH-6700J ToolboxST
If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.
From the Edit menu, select Add Traces. The Add Trace wizard displays.
If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Static, and then click
Next.
Select the type of data source to import from and click Next to display an Open
dialog box.
The Select Variables wizard page displays. Click the Add button to display
the Select a Variable dialog box. The ToolboxST application analyzes the
selected file and displays a list of available variables. Select one or more
variables to convert to traces. When you are finished, click OK in the Select a
Variable dialog box, then click Finish in the wizard. The newly created traces
display on the Trace tab.
Obtaining Data
As they depend on the presence of a controller, live and capture buffer traces do not
initially contain any data. (The data from static file traces is automatically imported
and displays as soon as the trace is added.) Once connected to the controller, the
procedure for obtaining data depends on the type of traces present. Data from live
traces is captured in much the same way that a video recorder operates (with record
and pause buttons), while data from a capture buffer is uploaded from the controller
in a single operation.
To connect to the controller
button on the Trender toolbar. (If any of the source
Select the Online
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
button. The Trender
On the Data toolbar, select the Record Data
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
button. Data continues to be
On the Data toolbar, select the Pause
collected but the Trender switches to Replay mode until the Pause button is
selected again.
To stop capturing a trend from live traces
On the Data toolbar, select the Record Data
returns to Replay mode.
button.
GEH-6700J ToolboxST
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
or Next
Chapter button on the Data
Click the Previous Chapter
toolbar. (If these options are disabled, there are no other chapters available.)
Cursors
In Replay Mode in the Graph View, two cursors individually select values of time
and together select ranges of time. The cursors are used by a number of functions in
the Trender, such as trace statistics, user events, and data export. The time
represented by each cursor is displayed in the status bar at the bottom of the Trender.
Cursor
Active cursor
Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired left boundary location.
Place the mouse pointer over the diamond at the top of the other cursor and drag
the diamond to the desired right boundary location.
GEH-6700J ToolboxST
Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired value.
If the diamond for the cursor that represents the time value you wish to select is
not colored white, click the diamond to select it as the active cursor.
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
If you place the mouse pointer over
an axis or a trace in the Graph
View, the Trender displays the
exact value in a ScreenTip. The
ScreenTip remains as long as the
pointer is over the selected item.
Events
During real time monitoring of the controller, certain events may occur such as
alarms and diagnostics. As these events occur, they display in the Trender as a small
triangle on the time axis. All events in the current Chapter appear on the Events tab,
which displays the time and description of each event.
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
From the Edit menu, select Add User Event. (Or, press the shortcut keys
CTRL+M.)
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.
From the Property Editor, locate the category Grid Lines and set the values
for Horizontal and Vertical to either True or False.
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.
From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.
In the Property Editor, under the category General, enter a new value for
Sample Markers.
GEH-6700J ToolboxST
Time Axis
The Time Axis controls the range of samples that display in the Graph View. All
traces share a single Time Axis, even when Stacked Trace Mode is enabled.
To change the range displayed on the Time Axis
Click the Reverse or Forward
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
Selected Traces
GEH-6700J ToolboxST
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
In the Property Editor, locate the Pen category and select the Color
property.
Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
Click the square that corresponds to the desired trace color. The trace updates
automatically.
To modify the default trace colors
In the Property Editor, select the number of the trace (for example, 2nd Trace)
to be changed.
Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
GEH-6700J ToolboxST
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 Edit menu, select Hide Selected Traces, or right-click on the
selected traces and select Hide Selected from the context menu.
-or
Select the check box next to the variable name in the Traces tab or the
Auxiliary View to hide or show the trace on the graph.
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.
-or
Select the check box next to the variable name in the Traces tab or the
Auxiliary View to hide or show the trace on the graph.
Statistical Calculations
The Trender can calculate a set of basic one variable descriptive statistics for
collected data while in the Replay mode. These statistics, which are calculated only
on data in the time range selected by the two cursors, include average, standard
deviation, minimum, maximum, and difference (calculated as final initial). The
calculated values display as columns on the Trend tab when enabled.
GEH-6700J ToolboxST
Locate and expand the Trender item in the Settings window. Under the
Trender item, select Replay Columns.
In the Available list, select one or more columns to enable. (To make multiple
selections, hold down the CTRL key while selecting additional items.)
Select OK when you have finished selecting options. A Save dialog box
displays.
Controls whether a
column containing
timestamps is added
to the output.
Controls whether a
column containing
increasing integers is
added to the output.
Selects the
precision
of the exported
timestamp.
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.
GEH-6700J ToolboxST
Spectral Analysis
The Trender provides the ability to perform a spectral analysis on a dataset.
To perform a spectral analysis
From the View menu, select Spectral Analysis.
A digital spectrum analysis of a waveform changes this time domain data into
frequency domain data, also called a frequency spectrum of the dataset. This is also
referred to as a Fast Fourier Transform (FFT).
The effect of an FFT on a sample dataset is shown below. The first is an input
dataset showing actual generator speed (RPM) and PWA accelerometer Y/Z
direction data (force in Gs).
Note The spectral analysis of this data is able to quickly isolate the most common
frequencies at which this data is varying.
GEH-6700J ToolboxST
In the example above, analyzing the input waveform (top) produces the frequency
spectrum below it, where three distinct groupings display at frequencies centered on
0.1, 0.35, and 0.9.
GEH-6700J ToolboxST
FFT Options
The Fast Fourier Transform (FFT), activated by the Spectral Analysis option, is
configurable.
To access FFT settings
GEH-6700J ToolboxST
None
Hann
Hamming
Barlett
Welch
Notes
GEH-6700J ToolboxST
CHAPTER 10
Network Adapters
The General tab configures Ethernet adapters for an external EGD-capable
components. 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
Selected Component. (If Edit Selected Component is not available, the
EGD Editor Enable property of the component may be set to False.) The
EGD Component Editor opens.
From the Tree View, right-click the Network Adapters item, then select Add
Adapter.
GEH-6700J ToolboxST
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.
From the Tree View, right-click the network adapter to be removed, then select
Delete Adapter.
The following properties are available for configuration when a Network Adapter is
selected in the Tree View:
Host Name
This is the Internet Protocol (IP) host name for the selected network adapter.
IP Address
Wire Speed
Network Name
Subnet Mask
Network Switch
Port Number
This is the network switch port the network adapter is attached to.
GEH-6700J ToolboxST
EGD Configuration
To configure EGD for an external device
1
From the System Editor, right-click an external device component and 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.)
In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.
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
button.
representations are available by clicking the ellipsis
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.
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.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
The following properties are available for configuration when a Produced Page is
selected in the Tree View:
Destination Category
Destination IP
Address
This 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.)
Ethernet 0
If set to True, EGD is broadcast on Ethernet 0. (If more than one Ethernet
Adapter has been configured for EGD, additional Ethernet properties display.)
Mode
Exchanges
Layout Mode
This determines whether the exchange numbers and offsets are assigned
automatically at build time or are entered manually.
Name
Period
Skew
This 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
exchanges skew by exactly this value (in nanoseconds). For example, if you
have three exchanges in a page and a skew value of 2, the first exchanges
skew is two, the second exchanges skew is four and the third exchanges
skew is six.
Note The Skew property will not be visible if it is not supported in the
implementation profile configuration.
Starting
Exchange ID
GEH-6700J ToolboxST
This sets the Exchange ID used for this page. Each additional exchange will
be incremented from the number.
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. A page compression causes an exchange major signature. Consumers can
mark the exchange variables as unhealthy until the consumed configuratuion can be
rebound.
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 a produced page
From the Tree View, select a Produced Page to display a Data Grid in the
Summary View.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the EGD tab, select the Configuration tab, then select a Produced
Page in the Tree View.
Review the warning about manual Exchange Signature editing, then click
OK.
Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.
Referenced Devices
The EGD variables defined in other components can be added to the current
components variable list by adding a reference. References can only be created to
EGD-capable devices that are consumers of Produced Pages, and as such only EGDcapable devices are available for referencing.
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.
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.
GEH-6700J ToolboxST
Implementation Profile
Each EGD node type has a set of supported EGD features. For example, a device
might have an EGD implementation that only supports broadcast-produced data. The
implementation profile contains details about the EGD implementation of a
particular device.
GEH-6700J ToolboxST
Data Types
This allows you to configure supported data types. (Clicking the ellipsis
button will open an editor window.)
Double Word Alignment The offset of a DWORD length variable must be evenly divisible by this
number.
This is set to True if the component requires that all WORD length variables
be aligned on an even boundary.
Word Alignment
This is set to True if the component supports broadcast destinations for EGD
data or command packets and False otherwise.
Masked Write
This is set to True if the component supports the MaskedWrite command and
False otherwise.
This 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 Exchanges
Max String
This returns the maximum size string supported by the component. If the
attribute is not present, then the component has no set maximum size for
strings. It is optional and is initialized to 0.
Multicast
This is set to True if the component supports multicast destinations for EGD
data or command packets and False otherwise.
Skew
Unicast
This is a Boolean value that is set to True if the component supports unicast
destinations for EGD data or command packets. Otherwise, it is set to False.
General Category
Device Class
This is the class of the device as defined in the EGD Protocol Specification:
Class Description
0
2
Supports all class 1 services, plus at least acts as a responder for the
command port, and the commands associated with that port.
3
Supports all class 2 services, plus the configuration port, and the required
commands associated with that port. Such devices support responding to
configuration requests but do not dynamically bind their consumed variables.
4
Supports all class 3 services, plus dynamically binding consumed
variables.
Device Name
This is the name of the class of device to which this device belongs
GEH-6700J ToolboxST
GEH-6700J ToolboxST
EGD Diagnostics
A CMP can be used to obtain the status of a Class 2 or higher EGD device. When
any EGD tree node other than a Referenced Device is selected, the EGD Statistics
from [Device] tab displays the statistics from the open component. When a
Referenced Device tree node is selected, statistics are obtained from that referenced
device, and the name of the tab page changes accordingly.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Command
Use to
File
Save
Import and Export Transfer produced data, consumed data, symbols, implementation
profiles, and GUI device EGD configuration files to and from a variety
of file formats
Edit
View
Print the summary grid view with the column selection, order, and width
currently visible in the view
Close
Undo
Redo
Cut
Copy
Paste
Paste the copied item in the Tree View into the Summary View
Delete
Find
Display the Component Editor for the item currently selected in the
Tree View
Go Forward
Return to the view that immediately follows the current view in the
history.
Help
Online
Put Device to
SDB
Release Notes
Display the release notes for the current version of the application.
About
GEH-6700J ToolboxST
CHAPTER 11
Chapter 11 Configuration
Management System (CMS)
Installing the CMS Server
A CMS server must be installed separately on a single master computer and
configured for a specific site. A user must have administrator privileges to control
access to the systems and perform certain tasks.
The CMS server uses a repository to track system changes, and to control client
access. Each repository contains a list of CMS users and permissions for the
repository. The repository maintains the revision change history for ToolboxST
systems that are added to the repository. A CMS server can have one or more
repositories, and each repository can contain one or more ToolboxST systems.
To install the CMS server
1
Place the CD in the CD-ROM drive. The installation starts automatically. The
Setup dialog box displays.
GEH-6700J ToolboxST
The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.
To continue the installation, you must accept this agreement. Select Agree.
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 is installed.
Continue to click the Next until the installation starts. Click Finish when the
installation has completed successfully.
Note For the CMS server to work correctly, the Use Simple File Sharing option
check box must be cleared.
Right-click Start and select Explore. From
the Tools menu, select Folder Options to
display the Folder Options dialog box.
GEH-6700J ToolboxST
From the Start menu, select Control Panel, Administrative Tools, and
Computer Management. The Computer Management screen displays.
GEH-6700J ToolboxST
Note When creating accounts specifically for CMS use in a workgroup, select the
options User cannot change password, and Password never expires.
GEH-6700J ToolboxST
From the Computer Management screen, right-click the new user and select
Properties. The Properties dialog box displays.
GEH-6700J ToolboxST
Select
Administrators
then click OK.
The dialog box closes and the previous Select Groups dialog box displays again,
with the Administrators group displayed in the object name text box.
2
Click OK. The User Properties dialog box displays again with the Member
Of tab selected.
From the Member Of tab, select the Administrators group, click Apply and
OK.
GEH-6700J ToolboxST
Command
Repository Select
Users
Tools
Use to
Select a repository to store and maintain files.
Create
Delete
Backup
Restore
Add
Add a new user. Enter the user ID and configure Permissions. If you select
User can modify system, that user cannot access the CMS Administrator.
Delete
Edit
Server
Settings
Select the User Type depending on the Windows security model for your
site. Changing this option will delete all repositories on the server. You will
be prompted to backup all repositories.
Note: If you select Domain Users you must know the Administrator domain
name and password.
GEH-6700J ToolboxST
From the Start menu, select All Programs, GE Control ST, and CMS
Server. Click Administrator Tool.
When the CMS Administrator Tool is started for the first time, the CMS Settings
dialog box displays.
Note To run the Administrator Tool and log in, you must have administrative
permissions on your computer. The first time you start the CMS Administrator Tool,
you must select the user type (before login). This determines the security model to be
used with the CMS server.
GEH-6700J ToolboxST
If there are any existing repositories with current user types, use this dialog box to
back up all existing repositories in the CMS server.
The repositories
to be backed up
display in the list
box.
GEH-6700J ToolboxST
Enter a Name and Password, then click OK. The CMS Administrator
dialog box displays.
The Create New Repository dialog box displays. Enter the path or click
Browse to find the repository location. To create a new repository folder, click
Browse to open the Browse For Folder and select Make New Folder.
Enter the folder and the name of the repository and click OK. The CMS
Administrator screen displays.
Working Folder
CMS has two types of working folders:
Repository working folders are the root folder location for systems from the
repository
System working folders have a folder location for each system configuration
added to the repository, or obtained from the repository.
Note Working folders are specific to a particular user. Different users cannot
designate the same working folder.
If a user attempts to use a working folder already selected by another user, the
following message displays:
GEH-6700J ToolboxST
GEH-6700J ToolboxST
If the user is adding the system to the repository, that users system working
folder is set to the current location of the system configuration.
If a new user performs a Get Latest command on a system that was not added by
them, the system working folder defaults to a location under the repository
working folder (and the Get Latest command places a copy of the system
configuration in that location).
The system working folder is not the repository working folder. Typically, the
system working folder is located in the repository working folder (but it can also be
in any folder). This location can also be changed from within the Stand-alone client
(but is not recommended).
The users system working folder is shown in the Stand-alone client when a system
name is selected.
GEH-6700J ToolboxST
For the Integrated client, the current folder location of the system (.tcw file) is
assumed to be the working folder for that user. The CMS logon fails, and an invalid
working folder dialog box displays if a different user is associated with the system in
that location.
A copy of the system is placed in the repository. This serves as the starting point
to begin CMS revision tracking for all CMS users.
The users system working folder is set to the current location of the system
configuration.
Changes are made to the system in the system working folder for use by CMS.
A CVS folder (hidden) is added at the system level and in each component in the
system
System and component configuration files (cf.dat and .xml ) are made Read-only
Once a system configuration is added to the repository, any user can log on to the
CMS Server to begin using CMS . After log on, the user obtains the current copy of
the configuration (Get Latest), modifies a component (Check Out), then saves the
changes (Check In).
GEH-6700J ToolboxST
Recommendations
Use only one CMS user and one working folder for all workstations. This user
should have administrator privileges.
When accessing a system through CMS for the first time, use the Stand-alone
client to log on and assign the working folder.
Do not add system to a different repository through the Integrated client. Do not
add a system through the Integrated Client. If you choose to do this, make sure
to first save the desired systems .tcw file to the working folder and add it to the
selected repository from that location.
The following are recommended settings to enable auto log in to the CMS
Integrated Client when a system configuration is opened in the ToolboxST
application.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Note The repositories available are those that were created using the CMS
Administrator.
GEH-6700J ToolboxST
From the File menu, select Add System. The Add System dialog box
displays.
Locate and select the system to be added, then click OK. The system displays in
the Tree View.
Or
From the Tree View,
right-click the
Repository item and
select Add System.
The Add System
dialog box displays.
Locate and select the
system to be added
then click OK. The
system displays in the
Tree View.
Note When a system is added to a repository, the current folder where the system is
located becomes the working folder for that system.
Note Once a system is added, all CMS operations are enabled.
GEH-6700J ToolboxST
If a component is checked
out, the Overwrite
Components dialog box
displays. Select any
components to overwrite,
then click OK.
Note A Recursive Get command retrieves a copy of the system, as well as all
configured components.
GEH-6700J ToolboxST
Command
Use to
Log In
Log Out
Add System
Add a new system to the CMS Stand-alone client. Enter a name for the
system, then browse to the configuration file, for example, a .tcw file.
File
Note: Select the repository item to display the system in both the
Systems and the Component View; select the system item to display the
component(s) in the Component View.
View
Delete System
Set Working
Folder
Change the path to the destination folder for checking out and checking
in system configuration files.
Refresh/System
Repository
Get the current system status. The status conditions include: Equal,
Checked Out, Unknown, or Missing.
Get Latest Version Retrieve the last checked-in version of the configuration files from the
Attention: When you perform a Get Latest Version, all files that you
currently have checked out are overwritten.
Check In
Check Out
Label
Mark the current repository component with a text label. If the label is
assigned to the system component, the system and all components in
the system are assigned the same text label. The label displays in the
History screen when you select Show History. The label can be used for
specific version identification, as well as for future file retrievals.
Show Differences
Display the differences between the master copy in the repository and
the local copy in the working folder
Tools
Note: From the Show History window, you can select a version and
click the Diff button to compare the selected version in the repository
with the local copy in the working folder. You can also select two
versions and click the Diff button to compare the two selected versions
in the repository.
Show History
Note: From the Show History window, you can select a version and
click the Diff button to compare the selected version in the repository
with the local copy in the working folder. You can also select two
versions and click the Diff button to compare the two selected versions
in the repository.
Help
Contents
About
GEH-6700J ToolboxST
User comments
entered at check in.
Label is
additional text
to identify a
specific
version.
Sequential
version
numbers
assigned to
each change at
check in.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
GEH-6700J ToolboxST
If you clicked Cancel, you are not logged into CMS. One of three scenarios occurs,
depending upon your local ToolboxST settings.
An empty ToolboxST window displays, a local system opens, or a Read-Only
system opens.
To access a system file
Select File and Open System. Browse to the working folder you created, then
select the ToolboxST system .tcw file. The .tcw file opens in Read-Only mode.
From the ToolboxST CMS menu, click Connect to Server. The CMS
Server Details dialog box displays.
When the CMS LogIn dialog box displays, enter your User Name (if not
displayed), Password, and Repository, then click OK.
GEH-6700J ToolboxST
Note If a question mark icon displays next to the system item in the ToolboxST
System Editor Tree View, perform a Get Latest Version.
Use to
Connect to
Server
Login
Logout
Work
Disconnected
Refresh
Add System to
Repository
Add System to
Different
Repository
Get Latest
Version
Retrieve the last check-ed in version of the configuration files from the
repository. Components under CMS control will always be Read-Only until
the component is Checked Out.
Attention: When you perform a Get Latest Version, all files that you
currently have checked out are overwritten.
Check Out
Check In
Label
Mark a checked-out copy of the file with identifying text. The label can be
used for future file retrievals.
Show History
Note: From the Show History window, you can select a version and click
the Diff button to compare the selected version in the repository with the
local copy in the working folder. You can also select two versions and click
the Diff button to compare the two selected versions in the repository.
Show Differences Display the differences between the master copy in the repository and the
local copy in the working folder.
Note: From the Show History window, you can select a version and click
the Diff button to compare the selected version in the repository with the
local copy in the working folder. You can also select two versions and click
the Diff button to compare the two selected versions in the repository.
GEH-6700J ToolboxST
Troubleshooting
If any of the following issues occur, perform the Clean Get procedure below.
Message box displays informing you of CVS issues and states cvs [server
aborted]: correct above errors first!
GEH-6700J ToolboxST
CHAPTER 12
Chapter 12 TreeFileImporter
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.
The Tree File Importer helps the conversion process by
providing a baseline for further revision and refinement. As
configuration files produced by the converter may contain
errors and/or omissions, all converted components and
library containers must be thoroughly reviewed and verified
before use. A failure to thoroughly verify any software or
configuration may result in equipment damage and/or
malfunction and subsequent bodily harm or loss of life.
To use the Tree File Importer
1
From the Control System Toolbox, export the tree files for a particular
device using the Export All command on the File menu. Make sure the device
is valid before proceeding.
From the ToolboxST application, create a system, add a library container, and
then add an empty component corresponding to the device type that you
exported from the Control System Toolbox. (The ToolboxST application
uses the term component in place of the older term device from the Control
System Toolbox.)
Run the Tree File Importer. Select the system and library container you
created in Step 2, then select the project file from Step 1 to import the macro and
module library tree files. Each use of the Tree File Importer imports a single
file; importing a project file includes all tree files for a device and is the quickest
way to perform a conversion. Refer to the section, Running the Tree File
Importer .
From the ToolboxST System Editor, open the controller and add a reference
to the libraries that were imported in Step 3.
Exit the ToolboxST application and return to the Tree File Importer. Select
the system and device you created in Step 2, then select the project file from
Step 1 to import the function tree files.
Note Information from Control System Solution toolbox system files (files ending
in .syb) are not imported. This includes scales, enumerations, and resources. Use the
toolbox SDB browser to display this information in the ToolboxST system
information editor.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Click the Browse button. From the Open Workplace window, locate and
select the system .tcw file containing the component to receive the imported
configuration, then click Open. Click Next to continue to Page 2 of the Wizard.
The ToolboxST application opens the system and displays a list of available
controller and library container components.
GEH-6700J ToolboxST
From the Select Project or Tree File screen, locate and select a source .prj or
.tre file, and then click Open. When you have selected a source file, click Next
to begin the import process.
GEH-6700J ToolboxST
The Application Code Conversion Type dialog box opens. Unless you are
certain another setting applies, select Straight variable name conversion,
then click OK.
When the import process is completed, Page 4 of the wizard displays with a log of
errors and warnings that occurred. Warnings are minor problems that do not prevent
the import from being saved (for example, a function block that cannot be imported).
Errors are major problems that prevent the import from completing (for example, a
missing library reference.)
Errors and Warnings displayed by the Tree File Importer are
designed to provide helpful information about the import
process. They are by no means complete, and the lack of any
errors or warnings does not necessarily indicate that a fully
functioning and correct component was created by the
import. Before using any application code or settings
imported by the wizard, thoroughly review every aspect of the
system for errors, omissions and/or inconsistencies.
GEH-6700J ToolboxST
After reviewing the log, click Next to save the updated system and complete the
wizard.
Notes
GEH-6700J ToolboxST
CHAPTER 13
Valve calibration
Multicasting
From the Summary View, select the Variables tab, and then click the
On/offline button on the taskbar to go online.
GEH-6700J ToolboxST
10 Click the Calibrate button. The Calibrate Valve dialog box displays.
11 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.
12 To exit calibration mode, click the Calibration Mode button again.
Auto Calibrate commands occur in the following sequence:
13 Click Minimum End to stroke the actuator to the minimum end position.
14 Click Fix Minimum End to read the voltage at the minimum end position.
15 Click Maximum End to stroke the actuator to the maximum end position.
16 Click Fix Maximum End to read the voltage at the maximum end position.
17 Click Calibrate to use the calculated values.
18 Click Save to save the calculated values.
Note Only one command state can be active at any one time.
GEH-6700J ToolboxST
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, which are not performed in any sequence, are as follows:
Click Send to send the value in the SetPoint textbox to the I/O pack.
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.
The ToolboxST application monitors the calibration permissive and calibration
command. If the permissive is lost, all calibration and verification buttons on the
dialog box are disabled. If the calibration command cannot be activated or is lost, all
calibration and verification buttons, with the exception of the Calibration Mode
button, are disabled.
Availability
This function is available with the following packs:
GEH-6700J ToolboxST
Multicasting
A ToolboxST function called power load unbalance (PLU) allows you to configure a
multicast connection between a PGEN I/O pack and a PDOA I/O pack on the same
IONet.
To configure multicasting
1
From the Tree View, right-click the Distributed I/O item and select Add
Module to display the Add Module Wizard.
From the
Module
Redundancy:
list, select TMR.
From theSelect
Type: list, select
PGEN, then
click Next.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the Hardware tab Tree View, right-click the Distributed I/O item and
select Add Module to display the Add Module Wizard.
GEH-6700J ToolboxST
Availability
This function is available with the following packs:
GEH-6700J ToolboxST
From the Summary View, click the Parameters to configure PHRA module
for an Asset Management System (AMS), if applicable.
From the Summary View, click the Inputs and Outputs tabs. Enable and
configure each input and/or output needed for the HART devices.
GEH-6700J ToolboxST
Availability
This function is available with the HART Enabled Analog I/O (PHRA).
GEH-6700J ToolboxST
PROFIBUS Communications
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
(refer to GEI-100614, PPRF PROFIBUS Master Gateway). There are two
redundancy options:
HotBackup provides dual I/O packs, with one active gateway and one backup.
Note Only one I/O pack can be actively communicating with its associated
PROFIBUS network.
To add a PPRF module
1
From the Tree View, right-click the Distributed I/O item and select Add
Module. The Add Module Wizard dialog box displays.
Select the
PPRF module,
then click Next.
GEH-6700J ToolboxST
If the Module
Required check
box is selected,
the module must
be present and
functioning for
the controller to
go online.
Click Next to
preview
configuration
information.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
From the Component Editor Tree View, right-click the Distributed I/O
item, then select GSD Manager.
Note The GSD Manager is not available until a PPRF module has been added.
GEH-6700J ToolboxST
From the Hardware tab, Tree View, highlight the PPRF module, then click
the PROFIBUS Network tab in the Summary View to configure the
network.
Slave device
Slave Device
view
From the Device view, insert the slave device into the network by selecting and
dragging the device to the purple-colored line in the PROFIBUS Network
view.
Note Any changes made in the PROFIBUS Network tab cannot be undone through
the ToolboxST Undo option under Edit.
GEH-6700J ToolboxST
Note If any changes are made to the slave device configuration and the OK button
is clicked, the pack is restarted after the controller and pack are downloaded.
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 failsafe mode. The default
time interval is 200 ms.
Click theOK
button to return
to the Hardware
tab.
GEH-6700J ToolboxST
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.
From the Tree View, click the Groups item to add the slave device to an I/O
group.
GEH-6700J ToolboxST
From the Tree View, click the Extensions item to configure advanced values
for this device.
For descriptions of
values, click the
Help button.
From the Tree View, click the DPV1 item to display the screen below.
Note This screen is only active if DPV1 is supported by this device, but this feature
is not supported by the PPRF.
Click the OK
button to return to
the Hardware tab.
For detailed
information, click
the Help button.
GEH-6700J ToolboxST
From the Tree View, Device Description, click the Device or the GSD
items to display information about the slave device.
10 From the Tree View, click the GSD item to display the contents of the GSD
file(s).
GEH-6700J ToolboxST
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.
GEH-6700J ToolboxST
PROFIBUS slave
addresses are
changed here.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
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.
Connected Variable displays the connection to other defined variables in the
ToolboxST application.
Var Data Type displays the data type of the variable configured in the MarkVIe
component. Space can be reserved for unused inputs and outputs, enabling
subsequent online loads when variables are added.
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.
PROFIBUS Point
Data Type
Boolean
Boolean
Integer16
Integer
Scaling
Float
Integer32
Double integer
Float
Unsigned16
Unsigned integer
Float
Unsigned32
Float
GEH-6700J ToolboxST
Note The connected variable may be added, changed, or removed and loaded
without restarting the controller or I/O pack.
GEH-6700J ToolboxST
The values that display in the Standard Diagnostics tab are the standard portion of a
PROFIBUS diagnostic message (the first six octets). Except for the Master_Addr
(master address) and Ident_Number (identification number) values, which are UINT
types, the remaining values are BOOL types. The connected values must have
matching data types.
Note The last value in the Standard Diagnostics tab, Station_Diagnostic, is not part
of the PROFIBUS standard diagnostic message. It provides a station diagnostic
present indication. It is set to True if the slave device generates a non-status only
diagnostic. For applications that require station diagnostic presence indication, attach
a defined Boolean-type variable to the Station_Diagnostic.
GEH-6700J ToolboxST
GEH-6700J ToolboxST
The Device Diagnostics tab, which is initially empty, is used to connect variables to
data fields within the Device-related portion of a diagnostic message. Entries in the
Diagnostic Byte Off, Diagnostic Bit Off, and Diagnostic Number Of Bits columns
identify bits, bit fields, and analog values within the Device-specific diagnostic,
which is exclusively defined on a per-device basis.
To specify a bit-wide diagnostic value
Enter the byte and bit offset values, then enter 1 in the Diagnostic Number of
Bits column.
You can also connect a Boolean-type variable to the specified diagnostic bit. (If the
connected variable is not provided, it may be added and downloaded. However, since
the ToolboxST configuration assumed an integer type because of the blank variable
field, the I/O pack is restarted.)
To specify a bit field diagnostic value
Enter the byte and bit offset values and the Diagnostic Number of Bits
value.
The specified bit field must fit within an 8-bit boundary and may extend from 1 to 8
bits. You can also connect an integer variable (not a BOOL or FLOAT).
A connected variable can be added and downloaded later without restarting.
To specify an analog diagnostic value
Enter the byte offset value, then enter 0 for the bit offset and number of bits.
The analog value, which must fit within a 32-bit boundary, is treated as a Big Endian
(high byte followed by low byte) value. You can also connect an analog variable to
define the data type of the diagnostic value. (A connected variable can be added and
downloaded later without restarting.) No type conversions are performed.
Note The I/O pack must be restarted if lines are added or removed from the Data
Grid, or if an existing entrys connected value is changed from a Boolean to an
analog-type or vice versa. All other changes to existing entries can be made and
downloaded without restarting the controller or I/O pack.
Note To add a line without specifying the connected variable, you must enter a
space in the Connected Variable field to enable the other fields for data entry.
GEH-6700J ToolboxST
The Identifier Diagnostics tab, which is initially empty, is used to connect variables
to bits within the Identifier-related portion of a diagnostic message. Each bit, which
corresponds to a module in the slave device, is set to True to indicate a problem.
To specify an identifier diagnostic
Enter the Identifier Number and (optionally) connect a BOOL-type variable.
Note If lines are added or removed from the Data Grid, the I/O pack must be
restarted after being downloaded. Existing Data Grid modifications (adding,
removing, or changing connected variables, changing the Identifier Number and
such) can be downloaded without restarting the controller or the I/O pack.
Note To add a line without specifying the connected variable, you must enter a
space in the Connected Variable field to enable the other fields for data entry.
GEH-6700J ToolboxST
Channel Diagnostics
The Data Type for the
Connected Variable must
be an UINT.
.
The Channel Diagnostics tab, which is initially empty, is used to connect variables to
the type octet of the Channel-related portion of a diagnostic message. The channel
diagnostic type octet contains two fields, a 3-bit channel type, and a 5-bit error type,
whose values are defined in the PROFIBUS standard. (The error type field values of
16-31 are manufacturer-specific).
To specify a channel diagnostic
Enter the Identifier Number, Channel Number, Channel Direction, and
Diagnostic Type, and optionally connect a UINT-type variable. (A connected
variable can be added and downloaded later without restarting.)
Note If lines are added or removed from the Data Grid, the I/O pack must be
restarted after it is downloaded. Existing Data Grid modifications (adding, removing,
or changing connected variables, changing the Identifier Number and such) can be
downloaded without restarting the controller or the I/O pack.
Note To add a line without specifying the connected variable, you must enter a
space in the Connected Variable field to enable the other fields for data entry.
To display advanced diagnostics
From the Hardware tab Tree View, right-click the PPRF, then select
Troubleshoot Module and Advanced. The Advanced Diagnostics
Commands window displays.
Note The system must be running, and the ToolboxST application must be able to
connect to the Mark VIe component.
GEH-6700J ToolboxST
Availability
This function is available with the PROFIBUS Master Gateway (PPRF).
GEH-6700J ToolboxST
Mark Ve Retrofit
The Mark Ve PMVE control I/O pack (based on the UCSx processor board) is an I/O
subsystem that communicates and controls one or more I/O agents across the highspeed serial link (HSSL). The PMVE currently supports the MVRA and MVRF
boards in a TMR configuration, as well as an MVRC board in a simplex
configuration. Refer to GEI-100689, PMVE Control I/O Pack.
Availability
This function is available with the Control I/O Pack (PMVE).
GEH-6700J ToolboxST
GEH-6700J ToolboxST
Variables tab
Note Each configured PCNO module supports up to five GS16 or GS6 fuel
valves. CANopen devices cannot be mixed.
GEH-6700J ToolboxST
The Variables tab contains a list of counters that provide an indication of CANopen
message transmission and reception. Each time the pack sends a message to a slave
device, the corresponding RPDO count is incremented. Each time the pack receives a
message from a slave device, the corresponding TPDO count is incremented.
A connected variable can be changed with an online load. Adding or removing
CANopen devices requires an offline load.
GEH-6700J ToolboxST
Notes
GEH-6700J ToolboxST
Glossary of Terms
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.
GEH-6700J ToolboxST
configure
To select specific options, either by setting the location of hardware jumpers or
loading software parameters into memory.
Control Constant
Control Constant is a signal with an initial value that is read and never written.
designated controller
In a Mark VIe dual controller system, the designated controller (DC) is the controller
to which the I/O packs listen for outputs when they have the option to listen to
multiple controllers. In a TMR system, the DC is the controller that initilizes the
other controllers.
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.
GEH-6700J ToolboxST
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.
heartbeat
A signal emitted at regular intervals by software to demonstrate that it is still active.
hexadecimal (hex)
Base 16 numbering system using the digits 0-9 and letters A-F to represent the
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.
GEH-6700J ToolboxST
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.
Rubber block
A block that can extend to include a variable number of pins.
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 toolboxs 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.
GEH-6700J ToolboxST
Index
A
acronyms and abbreviations 13
alarm classes 13
application
documentation 27
software examples 28
Auto-reconfiguration 26
reports 125
B
Block
block shape shortcut menu 18
diagram editor 1
shapes 11
border options 5
C
CMS
accessing CMS administrator tool 7
configuring 6
creating user accounts 3
installing 1
CMS recommendations 14
CMS stand-alone client
menus 18
opening 16
CMS troubleshooting 25
CMS working folder
repository 10
system 12
command
download 5
command line arguments 5
Component Infoview 7
components
grouping 4
moving and copying 4
configuring
Dynamic Data Recorder 88
HART I/O device 8
control constants 36
window 161
D
data grids
copying 10
editing 9
organizing 9
DDR setup 94
diagnostic views
controller 17
I/O 18
download command 5
Dynamic Data Recorder tab
configuring 88, 93
updating 92
E
editor
attribute value 23
library container 8
rung 35
system information 13
EGD configuration server reports 109
Ethernet 99, 36
Ethernet Global Data Configuration server
configuring an external EGD device 47
viewing differences 46
Ethernet Global Data tab
EGD configuration 99
page compression 103
produced pages 100
referenced devices 110
F
filtering rows 119
find methods 2
forced variables 131
format specifications 26
function blocks 3
G
General tab 17
global variables 132
grid lines 14
H
Hardware tab 33
HMI resources 28
I
I/O diagnostic
report 54
viewer 53
implementation profile 9
installation 2
L
library container editor
property editor 15
licensing 11
Live trends 8
LiveView 143
editor features 149
M
Measurement systems 28
menus 18
Modbus Slave register pages 115
mode
layout 14
modifying totalizer values 21
modules
adding 35
diagnosing 51
modifying 40
organizing 39
upgrading 48
viewing 40
N
network
adapters 24
P
page compression 103
Parameters tab 42
passwords 13
PCNO 31
pins
connecting 20
wiring block 16
produced pages 100, 3
PROFIBUS 9
property editor 6
protected objects 16
R
reports
creating 117
saving, retrieving and printing 117
viewing 118
running the tree file importer 27
S
security
passwords 13
Software tab
table definitions 82
variable editors 78
Status tab 46, 2
summary view 6
40
Index
system database 42
system editor
configuration files 8
opening and creating systems 1
saving systems 7
system information editor
alarm classes 13
format specifications 26
HMI resources 28
measurement systems 28
System Requirements 1
T
tab
diagnostics 46
Dynamic Data Recoder 87
EGD configuration server 108
Ethernet Global Data 99
General 17
Hardware 33
Modbus Slave 112
Software 61
Summary 42
variables 43
time axis 15
Totalizers
administer 19
passwords 20
Tree File Importer
running 27
Trender
adding traces 4
capture buffer trends 9
concepts 12
cursors 12
events 13
exporting to a file 18
hiding traces 17
live trends 8
obtaining data 11
printing graphs 18
trace colors 16
Trender concepts 12
Trender window features
data toolbar 4
Trender toolbar 4
U
UPD
installing 12
reinstalling 12
user block
definitions 7
libraries 3
user block definition
adding 19
sorting 19
V
variable editors 78
variables
adding 91
forced 131
global 132
status 91
W
Wizard
download 9
upload 15
Index
41
GE Energy
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
1 540 387 7000
www.geenergy.com