Beruflich Dokumente
Kultur Dokumente
GEH-6700
ToolboxST
for Mark VIe Control
ToolboxST
for Mark VIe Control
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. All license inquiries should be directed to the address below. If
further information is desired, or if particular problems arise that are not covered
sufficiently for the purchasers purpose, the matter should be referred to:
GE Energy
Post Sales Service
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Phone: + 1 888 GE4 SERV (1 888 434 7378, United States)
+ 1 540 378 3280 (International)
Fax: + 1 540 387 8606 (All)
(+ indicates the international access code required when calling from outside the
USA)
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.
Note General ToolboxST commands, such as those in the File and Edit menus have
the same basic characteristics as Microsoft products. Only commands specific to
the ToolboxST products will be defined.
Fax No.
Your Companys Name and Address Job Site
Phone No.
GE Requisition No.
E-mail
Your Job Function / How You Use This Publication Publication No.
Address
General Rating
Excellent Good Fair Poor Additional Comments
Contents { { { { ____________________________________________________________
Organization { { { { ____________________________________________________________
Technical Accuracy { { { { ____________________________________________________________
Clarity { { { { ____________________________________________________________
Completeness { { { { ____________________________________________________________
Drawings / Figures { { { { ____________________________________________________________
Tables { { { { ____________________________________________________________
Referencing { { { { ____________________________________________________________
Readability { { { { ____________________________________________________________
Specific Suggestions (Corrections, information that could be expanded on, and such.)
Page No. Comments
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
Other Comments (What you like, what could be added, how to improve, and such.) ________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
Overall grade (Compared to publications from other manufacturers of similar products, how do you rate this publication?)
{ Superior { Comparable { Inferior { Do not know Comment ____________________________________________
____________________________ Place
stamp
____________________________ here.
____________________________
GE Energy
Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Index I-1
Introduction
The ToolboxST control system software includes a configuration application
and support packages for the Mark VIe controller and distributed I/O packs.
Before you install the software:
System Requirements
The following are minimum hardware and operating system requirements
needed to run ToolboxST.
Processor 500 MHz Pentium III
Operating System Microsoft Windows 2000
Memory 512 megabytes (MB) RAM
Hard drive 20 gigabytes (GB)
Monitor XGA display (1024 x 768 x 64K colors)
Drive CD-ROM or DVD-ROM drive
Network Ethernet network adapter
GE Energy
General Electric Company
Post Sales Service
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Phone 1 888 GE4 SERVE (888 434 7378, United States)
+1 540 378 3280 (international)
Fax +1 540 387 8606 (All)
Note If the installation does not start automatically, from the Start menu run
the program GE ToolboxST Install.exe.
7 Once your selections are made, click the Next button until the installation
starts. Click the Finish button when the installation has completed
successfully.
From the Start menu, select Settings, Control Panel, and then
Add/Remove Programs.
Click Change to
add or remove
features from the
installation. Click
Remove to
uninstall.
Upgrading
You can install multiple versions of ToolboxST. When you install a new
version, the icons on the desktop and Start menu update to reflect the most
recently installed copy of ToolboxST.
1 Install the new version of ToolboxST. Refer to the section, Installation. The
icons on your desktop and in your Start menu will be updated to start the
most recently installed version.
2 From the Start menu, select Settings, Control Panel, and then
Add/Remove Programs.
1 Install new component software for the component type that you want to
upgrade by installing the latest version of ToolboxST.
2 Start ToolboxST and open the system file. Double-click a component to
open its component editor.
3 From the File menu, select Upgrade.
Click Next.
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. ToolboxST will only function if
your UPD contains a valid ToolboxST application key.
Only one UPD may be installed at a time. If you have valid licenses for more
than one product, your UPD must contain a valid application key for each
product.
Note If you install the UPD before installing ToolboxST, the device may appear
to be installed, but it will not be associated with the correct drivers. You can
correct this after ToolboxST is installed with the Reinstall UPD procedure.
Reinstall UPD
To reinstall the UPD
There are three different kinds of protection available called Access Rights.
Modify Data allows you to make changes to data values associated with an
object without changing how it works. For example, Modify Data protects
the initial value of a variable defined in a Mark VIe controller. The purpose
of this right is generally to keep unauthorized persons from making unsafe
changes to settings.
View Design allows you to view the internal design of a protected object.
For example, View Design protects the internal design of a library block.
The purpose of this right is to protect intellectual property from
unauthorized persons.
Modify Design allows you to change the way a protected object works.
For example, Modify Design 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. Each right can
have a different password set on it. 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 an object that is protected, the
Enter Password dialog box displays.
Note Passwords are case-sensitive 'secret' and 'Secret' are not considered to be
the same password.
There are four possible status indications for each access right:
No password has been set on this object and none is
required
A password has been set on this object and has not
been entered
A password has been set on this object, but has
already been entered
A password has been set on this objects parent, but
has not been entered
System can only have a Modify Design password. If present, it prevents you
from adding or deleting system components.
Device can have Modify Data and Modify Design passwords. Modify Data
prevents the user from saving changes or changing initial values for variables
defined in the component's application software. Modify Design prevents the
user 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 will 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 will
initially be 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
will not propagate to instances of that block.
Password Caching
The security system caches passwords that have been 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 or a Device). A cached password remains until the
component is closed.
System Editor
When you start ToolboxST, the first window that displays is an empty System
Editor.
Before you can begin using ToolboxST, 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. (For more information about the folder
structure of a system, refer to the section, Configuration Files.)
1 From the File menu, select New System to display the New System
dialog box.
Tree View
displays a list of Summary View
all components displays a graphic
in the system.
representation of all
Click the + and
system components
- symbols to
and their network
expand and
connectivity.
collapse groups.
Property Editor
allows you to edit
settings for the
selected
component.
A list of common components and the icon that represents them in the Tree
View is as follows:
Icon Component
System
Group of Components
Printer
Library Container
Network
Trender Window
External Device (not associated with an application)
You can add components to the root component of a system (represented by the
icon) or a group (represented by a icon). Some components display a
wizard or dialog box that prompts you for additional information when you add
them to the system.
In the Tree View, select a component. Then, from the Edit menu, select
Selected Component.
Or,
Grouping Components
ToolboxST 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:
Library Containers can not be contained inside groups, so they can only be
copied to the system item and can never be moved.
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.
No drag-and-drop operations are supported for networks.
Tip You can import components and Library Containers from either another
copy of ToolboxST or from the Windows file system using drag-and-drop
operations. (To import from the file system, drag the Device.xml or Library.xml
file that represents the component.)
If the configuration for the external device is stored in a file with a special
extension (for example, .m6b for a Mark VI device), you can specify the path to
the configuration file and omit the path to the external application. ToolboxST
will automatically open the application associated with the configuration file. In
all other cases, you must specify the exact application to be run for the external
device.
2 In the Property Editor, select the App Path item. Click the ellipsis
button at the right side of the text field to display the Open dialog box.
3 Locate the application executable file used to configure the device, and then
click Open. The App Path property is updated to reflect the new path.
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 (which are provided to
the external application on the command line before the contents of Doc
Path), configure the Switches property.
If the External Device application requires a specific working directory
(which is the folder assumed when no path is specified), configure the Start
Directory property.
If the External Device supports Ethernet Global Data (EGD), set the Enable
EGD Editor property to True.
In ToolboxST, 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.
From the File menu, select Save System. (Or, click the button on
the toolbar.)
Configuration Files
Folder Structure
Each system is saved in its own folder. Inside the main system folder is a set of
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:
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:
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.
System Options
ToolboxST 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.
From the System Editor, select the Options menu, and then select
Settings to display the Settings dialog box.
In the Settings dialog box, categories are listed in a Tree View on the left side
of the dialog box. Each category contains one or more settings that display in the
Property Editor on the right side of the dialog box.
Menu Reference
File Menu
New System creates a new system.
Edit Menu
Delete removes the item currently selected in the Tree View.
View Menu
By Type automatically organizes the Tree View by component
type.
By Group enables manual organization of the Tree View with
group components.
Track keeps selections in the Tree View and Summary View
synchronized.
Launch EMT opens the Ethernet Global Data (EGD) Management
Tool (EMT).
Window Menu
Cascade arranges open Component Editor windows in a layered
style.
Help Menu
Contents displays the online product documentation.
Release Notes displays up-to-date information about your version
of ToolboxST.
Send Problem Report lets you send problems and suggestions to
the ToolboxST team.
About displays version and copyright information.
From the System Editor, select System Information from the Edit
menu.
Or,
From the System Editor, double-click the System item in the Tree
View.
1 Open the System Editor. From the Edit menu, select System
Information.
2 From the Tree View, select Alarm Classes. A data grid with the existing
Alarm Classes displays in the Summary View.
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:
The following properties are available in the Property Editor when a Format
Specification Set is selected:
Format Spec Set: The Format Specification Set that contains the selected
format specification.
Precision: 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: The maximum value of the range used for unit conversions.
Engineering Min: The minimum value of the range used for unit conversions.
Units: The text that displays to identify the format specification unit.
Measurement System: The measurement system (for example, Metric or
U.S.) to which the unit belongs. (Refer to the section, Measurement Systems.)
Name: 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.
1 Open the System Information Editor. From the System menu, select
Put System to SDB. (For more information on opening the System
Information Editor, refer to the section, System Information Editor.)
2 A dialog box displays confirming the destination SDB Host and Path. Click
OK. 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.
Property Editor
provides an easy and
consistent means to edit
the item selected in the
Tree or Summary View
Component InfoView
displays specific feedback
information of the currently
selected tab.
From the Component Editor, click an item in the Tree View. The
configuration information for that item displays in the Summary View and
Property Editor.
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.
From the Property Editor, select an item by clicking its value field. The
field can display several options:
Click the ellipsis button to change the value from a dialog box.
Click the drop-down list button to change the value from a drop-down list.
If no button displays, edit the value directly in the corresponding text box on the
right side of the Property editor.
The Component InfoView always contains the following five 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 issued in ToolboxST. For
example, if you prepare to download a controller and click the Build command,
messages describing the results of the Build process display in this tab page.
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 code that caused the error to occur.
The Summary View displays the block diagram and the block variable with
the problem highlighted.
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. Refer to the section,
Finder.
Info tab displays context-sensitive descriptions for the selected Tree View or
Summary View item.
Note Some Data Grids, especially those without an Append Row, may not
support all features described in this chapter.
Row
headers
Currently
selected row
Append
row
Selected cell
Editing Data
To... Do this:
Remove all
columns from the
data grid.
Add a variable to a block Arrange windows on screen so both the source grid and a destination block
diagram, Trender window or diagram, Trender window or watch window are visible. Then, drag the row
Watch Window from a data header for the variable to the destination window.
grid
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 (comma separated value) 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 ToolboxST before pasting data from Excel.
-or-
When a search is completed, the results are displayed on the Find Results tab of
the Component InfoView. To jump directly to a location, double-click it in the
list.
Anywhere finds the specified text anywhere within a searchable text string.
A search for matches but does not match:
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 but does not match:
abc abc xyzabc
abcde abdc
ab
bc
Ends with finds the specified text only at the end of a searchable text string.
A search for matches but does not match:
abc abc abcde
abdc
xyzabc ab
bc
Match Exactly finds the specified text only when it is exactly equal to an
entire searchable text string.
A search for matches but does not match:
abc abc abcde
xyzabc
abdc
ab
bc
abc cde
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 but does not match:
a?c abc abdc
adc bc
abc cde
abcde
xyzabc
a* abc bc
adc cde abc
abcde
abdc
ab
abc cde
In the Finder window, click the Replace button. The window expands to
include new options.
The Trender is a tool that is 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.
1 If the Trender application is not already open, select the Windows Start
button, then Programs, GE ToolboxST, ToolboxST, and then select
Trender.
2 From the File menu, select New to create a new Trender window.
-or-
From the File menu, select Open and locate an existing trend file.
-or-
Click Add, enter a name, and then click OK to create a new Trender window.
From the Trender toolbar, select the Save button. If you opened the
current Trender window from within ToolboxST, the Trender window
saves automatically. If you opened the Trender window from the Start
menu, the Trender window saves to a file.
Graph View
contains the trend
graphs, which
display the values
represented by
each trace.
Property Editor
allows you to change
settings that affect the
capture and display of
data.
Data Toolbar
contains commands
that manipulate the
current data.
Traces tab Sources tab User Note tab Events tab lists Auxiliary View Mode Indicator
displays traces displays sources allows you to save all events that contains tabs that displays the
currently being where data is comments, have occurred display current mode
monitored by the collected. instructions, and during the information about (Live or Replay).
Trender window. notes about the current Chapter. the current data.
current Chapter.
Create new
Trender Window
Data Toolbar
Note The buttons available on the Data toolbar may vary according to the
current trace source type.
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. (For more
information about managing traces from the Traces tab, refer to the section,
Traces .)
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.
1 If the Trender window you would like to add the trace to is not already
open, refer to the section, Accessing a Trender Window .
2 From the Edit menu, select Add Traces. The Add Trace Wizard
displays.
3 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, and then
click Next.
4 Select System Component, and then click Next.
5 If you did not open the current Trender window from ToolboxST, the Add
Trace Wizard prompts you for the name of the system file that contains
the source component. Click the Browse button and locate the system file,
and then select Next.
6 Select the component from which you wish to trend variables, and then
click Next.
7 Select the sampling period you wish to use, and then click Next. (The
sample period represents the time in milliseconds between samples, so
larger numbers result in fewer samples.) The Select Variables wizard
page displays.
8 Click the Add button to display the Variable Browser, then select one or
more variables to monitor. When you are finished, click OK in the
Variable Browser, then click Finish in the wizard. The newly created
traces display in the Trace tab.
1 If the Trender window to contain the new trace is not already open, refer to
the section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. The Add Trace Wizard
displays.
3 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, and then click Next.
4 Select the component from which to trend variables, then click Next. A list
of all available capture buffers displays.
5 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.
1 If the Trender window to contain the new trace is not already open, refer to
the section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. The Add Trace Wizard
displays.
3 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.
4 Select the type of data source to import from and click Next to display an
Open dialog box.
5 Select the desired static file source, and then click Open.
6 The Select Variables wizard page displays. Click the Add button to
display the Variable Browser. ToolboxST 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 Variable Browser, and
then click Finish in the wizard. The newly created traces display on the
Trace tab.
Select the Online button on the Trender toolbar. (If any of the
source controllers are redundant controllers, the Trender prompts you to
select a redundant channel before opening the connection.)
On the Data toolbar, select the Record Data button. The Trender
switches to Live mode, and the Graph View continuously scrolls the time
axis to display the latest incoming data while recording.
On the Data toolbar, select the Record Data button. The Trender
returns to Replay mode.
Cursors
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.
1 Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired left boundary location.
2 Place the mouse pointer over the diamond at the top of the other cursor and
drag the diamond to the desired right boundary location.
1 Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired value.
2 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
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
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. (For more information about designating an active cursor,
refer to the section, Cursors.)
Note In Single Graph mode, the vertical axis markings correspond to the trace
listed first on the Trace Tab. Each trace is drawn according to its own scale and,
as such, traces other than the first trace may not correspond to the displayed axis
markings.
1 From the Options menu, select Settings. The System Options dialog
box displays with Trender selected in the Tree View.
2 From the Property Editor, locate the category Grid Lines and set the
values for Horizontal and Vertical to either True or False.
3 Click OK to close the Settings dialog box.
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.
1 From the Options menu, select Settings. The System Options dialog
box displays with Trender selected in the Tree View.
2 In the Property Editor, under the category General, enter a new value
for Sample Markers.
3 Click OK to close the Settings dialog box.
Click the Zoom In (to reduce the duration) or Zoom Out (to
increase the duration) buttons on the Data toolbar.
The Zoom In and Zoom Out commands behave differently depending on the
current mode. In Live mode, the Zoom In command sets the duration to one
third of the current value and the Zoom Out command sets the duration to three
times the current value. In Replay mode, the Zoom Out command still sets the
duration to three times the current value, but the Zoom In command sets the
duration to the exact region selected by the two cursors. (For more information
on selecting a range, refer to the section, Cursors.)
Tip To quickly change the range of an axis, you can click any point on the
axis and drag it to a new location. This operation works for both the value and
time axes and is frequently the most effective way to change the displayed set of
data.
Traces
The Trender window maintains separate settings for each trace. These settings,
which include trace color, sample capacity, and pen width, are accessed through
the Property Editor when a trace is selected on the Trace tab. In addition, Value
(vertical) Axis settings managed through each trace allow an appropriate scale
and range to be determined for each item.
Auto-Range Trace
To display a set of collected samples in the Graph View, an appropriate Value
Axis scale and range must be selected. For most data sets, an optimal scale and
range would display all collected samples in the selected time range with
minimal wasted space. The Auto-Range Trace feature sets the range of the
Value Axis for the currently selected trace(s) to the optimal values. Even if you
decide to further refine the range of the trace, the Auto-Range Trace feature
provides a convenient starting point.
To auto-range a trace
From the Trace tab, select one or more traces, then select the Auto-Range
From the Trace tab, select one or more traces, then adjust the Bottom
Value and Top Value properties under Range in the Property Editor.
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.
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.
From the Edit menu, select Show Traces. Select and clear the check
boxes next to the trace names as desired, then click OK.
4 Click the Add button to move the statistics to the Selected list.
5 When you have finished enabling statistics, select OK.
Controls whether a
column containing Controls the text
timestamps is added exported when no
to the output. data is available
for a trace at a
given point in time.
Controls whether a
column containing
increasing integers is
added to the output. Selects the precision
of the exported
timestamp.
If selected, only the
time range selected
by the cursors is
exported.
Printing Graphs
The Trender can print the currently displayed graph to any printer attached to the
system. Printed graphs reflect the current appearance of the Graph View,
including displayed traces, colors, and axis boundaries.
From the File menu, select Print. Adjust printing options as desired and
click OK.
Overview
The EGD Device Editor for External Devices allows you to configure Ethernet
Global Data (EGD) for an external or third party device. The EGD protocol
allows controller devices (sometimes known as nodes) to share information in a
networked environment. EGD allows one controller device, referred to as the
producer of the data, to simultaneously send information to any number of peer
controller devices (consumers) at a fixed periodic rate. This network supports a
large number of controller devices capable of both producing and consuming.
Network Adapters
The General tab configures Ethernet adapters for an external EGD-capable
device. One adapter is created by default, and up to four adapters can be added.
Host Name: The Internet Protocol host name for the selected network
adapter.
IP Address: The Internet Protocol (IP) Address for the selected network
adapter.
Network Name: The name of the connected network.
Subnet Mask: The subnet mask associated with the connected network. (If
working inside a ToolboxST system, this property will be read-
only.)
Wire Speed: The speed of the connected network. (This property is only
available when working inside a ToolboxST system.)
These properties are available for configuration when Ethernet Global Data is
selected in the Tree View:
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.
1 From the Tree View, right-click the Produced Pages item, and then
select Add Page.
2 Enter a unique name for the new page in the Page Name dialog box and
select OK.
Note When the first Produced Page is created, it automatically becomes the
Default page.
1 From the EGD tab, select Produced Pages in the Tree View.
2 Select the Default Page Property from the Property Editor, and then
select the desired page from the drop-down list.
Tip Any variable defined with $Default as the EGD page name will
automatically be placed on the currently selected Default page.
To delete a Page
From the Tree View, right-click the page you wish to delete and select
Delete.
From the EGD tab Tree View, expand Ethernet Global Data.
Under Produced
Pages, select the
desired page.
The page
properties display
in the property
editor.
The following properties are available for configuration when a Produced Page
is selected in the Tree View:
Ethernet 0 If selected, EGD will be broadcast on Ethernet Adapter 0. (If
more than one Ethernet Adapter has been configured for EGD, additional
Ethernet properties are displayed.)
Mode - This property can be set to Broadcast, Unicast or Multicast, depending
on the modes supported by the device's EGD implementation profile.
Exchanges This property indicates the number of exchanges in the
selected page. It is updated after a build.
Name Use this property to rename the selected page.
Period This read-only property indicates the transmission period of the page
in milliseconds.
Skew 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.)
Destination IP Address - This property 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.)
From the Tree View, right-click the page to compress, and then select
Compress.
From the Tree View, right-click Produced Pages, and then select
Compress All.
Variables
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).
From the Summary View, right-click a variable, and then select Copy
Selected/Current Row(s). The data is copied in Comma Separated Value
(CSV) format.
1 From the EGD tab, select a produced page in the Tree View.
2 Right-click an exchange in the Summary View and select Edit
Exchange Signatures and Configuration Time.
3 Review the warning about manual Exchange Signature editing and click
OK.
4 Make any desired changes to the signatures and configuration time, and then
click OK to close the dialog box.
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.
Grayed Exchanges
are not available to
this device.
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.
In the Tree View, right-click the device to be refreshed, and then select
Refresh.
Word Alignment: True if the device requires that all WORD length variables be aligned on an even
boundary.
Broadcast: Set to true if the device supports broadcast destinations for EGD data or
command packets and false otherwise.
Masked Write: Set to true if the device supports the MaskedWrite command and false otherwise.
Max Coherent Data: This unsigned integer 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: This unsigned integer returns the maximum number of exchanges supported by
the device. It is optional and is initialized to 0.
Max String: This unsigned integer returns the maximum size string supported by the device.
If the attribute is not present then the device has no set maximum size for strings.
It is optional and is initialized to 0.
Multicast: This value is set to true if the device supports multicast destinations for EGD data
or command packets and false otherwise.
Skew: This Boolean value represents the capability of the producer to support the
skewing of produced exchanges with respect to time.
Unicast: This boolean is set to true if the device supports unicast destinations for EGD
data or command packets and false otherwise.
Device Class: The Class of the device as defined in the EGD Protocol Specification:
Class Description
0 Supports only the configuration port.
1 Supports the data port and the Data Production PDU.
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 Class Name: The name of the class of device to which this device belongs.
Edit Menu
Undo returns the editor to the state it was in before the last action
was performed.
Redo performs an action again after an undo command.
Cut moves the currently selected portion of the data grid to the
clipboard.
Copy transfers a duplicate of the currently selected portion of the
data grid to the clipboard.
Paste transfers the contents of the clipboard into the data grid.
Find opens the Finder dialog box. For more information, refer to the
section, Finder.
View Menu
Go Back returns to the view that immediately precedes the current
view in the history.
Go Forward returns to the view that immediately follows the current
view in the history.
Help Menu
Contents opens this help document.
Overview
The Tree File Importer is a companion application that converts software tree
files from the GE Control System Toolbox to the new .XML file format used by
ToolboxST.
Before using the Tree File Importer, you must complete the following steps:
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.
2 From ToolboxST, 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. (ToolboxST uses the term component in
place of the older term device from the Control System Toolbox.)
3 Run the Tree File Importer. Select the system and library container you
created in Step 2, and 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. (For details on the
operation of the Tree File Importer wizard, refer to the section, Running the
Tree File Importer.)
4 From ToolboxST, open the controller and add a reference to the libraries
that were imported in Step 3.
5 Exit ToolboxST and return to the Tree File Importer. Select the system
and device you created in Step 2, and then select the project file from Step 1
to import the function tree files.
7 After reviewing the log, click Finish to save the updated system and
complete the wizard.
The Mark VIe control system is used for control, protection, and monitoring of
turbine and driven load equipment. Vital subsystems, such as servo control,
vibration protection, and synchronization are embedded in the I/O with on-board
processors to optimize performance.
ToolboxST is the configuration and maintenance software tool for Mark VIe
controllers. The system has a CompactPCI controller with networked I/O. The
I/O processors are located on the terminal boards instead of in centralized board
racks. This configuration digitizes the signals on the terminal boards, which can
be mounted local or remote, individually or in groups.
Connecting to a Controller
Many actions in the Mark VIe Component Editor require an active connection to
a controller.
To connect to a controller
From the System Editor, open a Mark VIe Component Editor. From
the Device menu, select Online.
-or-
From the System Editor, open a Mark VIe Component Editor. From
the toolbar, click the Online button.
Color text is used throughout the Status tab to display state information at a
glance. Both the tab and the text are green, indicating the normal state for the
control.
Color Conditions
Green All controllers functioning normally.
- Control state is controlling
- Controller Equality equal
- DDR Equality equal
Yellow One or more of the following:
- Control state not controlling
- Controller equality not equal
- DDR equality not equal
- Frame Idle time < 20%
Red One or more of the following:
- Control state is failed
- Controller equality has a major difference
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 State are as follows:
State Description
Power up Power up controller
Master initialization Initialize controller
Designated controller Determine which controller is designated in a redundant controller
determination configuration
Data initialization Perform initialization of non-designated controllers with NVRAM,
command variables, and constants
Inputs enabled Wait in this state for all of the I/O packs to start transmitting inputs
Input voting Check voting inputs prior to execution of application code
Exchange initialization Populate redundant controllers with dc state variables prior to voting
Exchanging Exchange state variables so that a controller joining a running system
wont have a step in its initial calculations
Sequencing Turn on the application code and execute each task at least once
before driving outputs
Controlling Turn on outputs
Loading Online load is in progress
Load complete Online load has finished. Wait for re-synchronization of redundant
controllers
Fail Failure has occurred. Refer to the section, Controller Diagnostics.
DDR Equality indicates whether equality exists between the Dynamic Data
Recorder configuration in ToolboxST and the configuration currently running in
the controller. Valid states are Equal and Not Equal. Refer to the section,
Dynamic Data Recorder.
Frame Idle Time is the percentage of CPU time left in the controller after the
critical control functions of input, compute, and output have been completed.
System Idle Time is the percentage of CPU time left in the controller after all
functions have been completed. It accounts for the critical control functions as
well as background processing and communication overhead. (System Idle
Time is always less than or equal to frame idle time.)
Heart Beat indicates whether the controllers are exchanging the control state
variables. If the number shown is incrementing, the control state variables are
being exchanged.
Controller Time shows the current wallclock time that the controller is using
for timestamping. Refer to the section, View/Set Time.
1 Boot Loader is software that 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.
2 Base Load is software that 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.
3 Firmware is the software that 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.
4 Application Code contains the configuration of the controller as created in
ToolboxST. 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 will take 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.
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.
1 Connect a serial cable from the main board of the controller to a free serial
port on your computer.
2 Open the Mark VIe Component Editor for the controller to be
configured.
3 From the Device menu, select Download, and then Controller Initial
Setup.
4 From the first page of the wizard, click Next to display the second wizard
page.
1 Open a Mark VIe Component Editor. From the Device menu, select
Download, and then Download Wizard to display the Mark VIe
Download Wizard.
2 If you have changed configuration settings since the last Build operation, a
message box will display indicating that the software is out of date. Click
Yes to build the current configuration. The Mark VIe Download Wizard
opens.
3 Click the Next button to advance past the wizards introductory page.
If checked, software
that was identified as
up-to-date by the scan
operation is displayed.
Reboot Required
indicates that an
offline download is
required to update
the application code.
4 When the download has completed, click Finish to close the wizard. In the
Component InfoView, click the Log tab and review the status messages to
check for potential warnings or errors that may have occurred during the
download.
1 Open a Mark VIe Component Editor. From the Device menu, select
Upload to display the Mark VIe Upload Wizard.
2 Click Next to advance past the introductory page of the Upload Wizard.
If the Mark VIe is configured as a redundant controller, the following page
displays with an option button for each available redundant controller.
Select a
controller, and
then click Next.
3 When the upload completes, click Next to display the final page of the
wizard.
Open a Mark VIe Component Editor. From the View menu, select
Controller Diagnostics.
Timestamp when
the message
occurred.
The name of the TOTALIZER The name of the The current value of the Click here to
block pin connected to the variable connected to counter. The values displayed close the dialog
totalizer. (If blank, the totalizer a configured pin. are retrieved live from the box.
has not been configured.) controller and are updated
once per second as long as the
dialog box is open.
Note Totalizer passwords are specific to the connected redundant controller (R,
S, or T) and cannot be used on other controllers.
4 Follow the directions at the top of the file to contact GE Energy with the
information contained in the file. GE will reply with a new Totalizer_ID.txt
that contains a password customized to your installation:
Open the View/Set Totalizers dialog box and enter a valid password.
The General tab configures general properties and attributes of a Mark VIe
controller. Some items that can be configured on the General tab include the
redundancy of the controller (simplex, dual, or TMR) and the frame rate of the
controller (its basic scheduling rate).
General Features
To configure Mark VIe General Features
Property Editor
provides a consistent
way to edit the item
currently selected in the
Tree View .
Component InfoView
displays feedback
information about the
currently selected item.
From an attribute Data Grid, click a Value Cell, and then click the ellipsis
button.
Overview
ToolboxST manages I/O packs and terminal boards through a logical unit called
a module. A 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 that are used to identify physical
characteristics of the pack. Each I/O pack module that can be added to a Mark
VIe controller device 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.
From the Hardware tab Tree View, select the I/O Hardware item.
1 From the Hardware tab, right-click the I/O Hardware item in the Tree
View and select Add Module to display the Insert Module Wizard.
Select Next.
Select Next.
Configuration settings
and Ethernet
connections for each I/O
pack are set individually
in this area.
Select Next.
Select Next.
Organizing Modules
Modules can be stored in units called groups for organizational purposes.
To create a group
From the Hardware tab Tree View, right-click the I/O Hardware item
and select Add Group from the menu. Type a name for the group and press
ENTER.
From the Hardware tab Tree View, drag a module to the desired group.
When the mouse pointer changes to a symbol, release the mouse button to
move the module.
From the Tree View, right-click the module to modify, and then select
Modify Module from the shortcut menu to display the Modify Module
dialog box.
For example, the following set of tabs (taken from a PDOA module) contains
the base set of tabs as well as two other tabs, Outputs and Inputs.
Summary Tab
The Summary Tab displays a graphical overview of the selected module.
Note Some infrequently used parameters are classified as Advanced and are
hidden by default. To display Advanced parameters, click the Show/Hide
Advanced button on the toolbar.
Timestamp when
the message
occurred.
Reporting
Create I/O Report
ToolboxST can generate an I/O report that contains configuration details about
the I/O Hardware in a system.
1 From the Hardware tab Tree View, right-click I/O Hardware and select
Create I/O Report.
To upgrade a module
From the Hardware tab Tree View, right-click the module to be upgraded
and select Upgrade Module. The Upgrade Wizard displays.
For the example module shown below, there are two module versions available:
a PDOA with compatibility code set 2,2 and a PDOA with compatibility code
set 3,3.
From the Device menu, select Download, and then select Download
Wizard. (For more information on the Download Wizard, refer to the
section, Download Wizard.)
Compare 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 ToolboxST.
From the Hardware tab Tree View, right-click a module to compare and
select Compare Parameters.
Software Overview
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.
Function blocks can be grouped together into user blocks. These user blocks can
be used in other user blocks or in a program. When a program contains a user
block, that user block can be scheduled to run periodically. This period is a
multiple of the controllers frame period and can be offset from the beginning of
its period in order to balance the processor load within the controller.
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 user
block, meaning it cannot be accessed from other locations. Global variables are
referenced using the variable name, program name dot variable name
(Prog1.VarName), or block name dot variable name (USB1.VarName)
according to the Global Name Prefix (GNP) property.
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 ToolboxST 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.
User blocks can be used both to store code for reuse and to break code up into
more understandable sections. There are three types of user blocks:
Linked user blocks are defined as user block definitions in a user block library
and are then inserted into a program or another user block. Linked user blocks
cannot be changed at the instance (with a few exceptions), but they can be
updated with a new version from the user block library. They are shown on the
Tree View as a linked chain .
Unlinked user blocks allow the user to edit the user block in the controller
component and prevents updates from the original user block definition when all
of the user blocks in a controller are instanced. Once linked user blocks are
inserted into a program or another user block, they can be unlinked by setting
the Unlink property to True. They are shown on the Tree View as an unlinked
chain .
Embedded user blocks can be inserted into a program and are not based on
user block definitions. Like function blocks, they are shown as a normal block
with inputs and outputs .
Like function blocks, user blocks can have variables that act as the inputs and
outputs of that user block. Once a linked user block has been added to a
program, that user block can become out of date if the user block definition from
which it came is modified. Use the Instance command to update that user
block. For information about the interaction between user blocks and user block
definitions, refer to the section, Managing Blocks.
- or -
Insert an embedded user block and then drag the linked user block from the
library palette onto the block diagram for that embedded user block.
The Programs item properties allow the user to specify particular behavior when
a linked user block is inserted or instanced. From the Property Editor, the
Merge Variables At Instance property applies to the variables of a user
block. If this property is set to True, some of the properties of the instance can
be modified. If there is no default value set in the user block definition, that
property is left intact. If the Merge Variables At Instance property is set to
false, then the variable properties are always updated when the user block is
instanced.
The Remove Unused Variables property helps to keep the variable list short
for user block definitions that use instance scripts to remove particular blocks
from the user block instance. If this property is set to True, any variables in a
user block that are not used are removed when the user block is inserted or
instanced.
User block definitions are the origin of both linked and unlinked user blocks.
Each user block has a version and description to help manage reusable
application software.
To specialize user blocks so that a set of code can be used in multiple situations,
instance scripts and text substitution are provided. These two constructs
work with the ToolboxST automation interface and user attributes that belong to
either the user block or the controller component.
The PromptforInput property causes a dialog box to display so that you can
verify the attribute value when the user block that owns the user attributes is
inserted. Named attributes can be used to change the variable names and
connections by substituting strings specified in user block attributes. User
Attributes for a user block can be changed at the instance. For more information
about user attributes, refer to the section, Working with User Blocks.
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 specify that substitution should occur, place the name of a user
attribute with a data type of string between braces {}. For more information,
refer to the section, Application Software Examples.
Each library is contained in an XML file and can be ported to other library
containers using the Add Existing Library command of the user block
libraries item.
The following window displays the major parts of the Library Container Editor
and the terminology that is used when referring to the editor.
User Block
Libraries is the top
item in the Library
Container.
Property Editor
provides a consistent
way to edit the
currently selected
item.
Component InfoView
displays specific
information about the
currently selected tab.
From the System View, right-click the system name and select Insert
New, Library Container as shown below to display the Library
Container Creation Wizard.
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 the version they were previously configured with until they are
upgraded. (If the old version is uninstalled, the library container must be
upgraded before it can be opened.)
From the Tree View, right-click the User Block Libraries item, and then
select Add Library to display the Add New Library dialog box.
Note Each library is contained in an XML file and can be imported into other
library containers.
From the Tree View, right-click the User Block Libraries item, and then
select Add Existing Library to display the Select Existing User Block
Library dialog box.
Tip The Summary View for the User Block Libraries item displays
names and locations of all the function block and user block libraries that are
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.
From the Tree View, right-click the library item and select User Block
Definition to display the Add New User Block Definition dialog box.
Right-click the Library item and select Sort User Block Definitions.
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.
For more information on setting variable properties, refer to the section,
Property Editor.
Add Undefined Variable allows you to add all of the 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.
The PromptforInput property causes a dialog box to display so that you can
verify the attribute value when the user block that owns the user attributes is
inserted. Named attributes can be used to change the variable names and
connections by substituting strings specified in user block attributes. User
Attributes for a user block can be changed at the instance. Refer to the Overview
section of Application Software Design for examples on how to use
attributes.
From the Tree View, right-click the User Block Definition 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 as required.
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 that are defined in the controller component. For examples of instance
scripts in use, refer to the section, Application Software Design.
From the Tree View, right-click the User Block Definition and select
Add Instance Script.
Instance
Select this command to get a new copy of the User Block Definition from the
library. In addition to updating the user blocks, this command causes the
instance scripts and text substitutions for all of the top-level user blocks to run.
It is not possible to undo this command.
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.
From the Tree View, right-click the User Block Definition and select
Validate.
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. For more information, refer to the section, Block
Diagram Editor.
Programs Item
The Programs Item is a container that holds all programs in the controller. Its
shortcut menu contains actions that affect all programs in the controller, such as
changing library references and instancing all top user blocks. The shortcut
menu also contains commands to add a new or existing program to the
controller. For more information on adding programs, refer to the section,
Creating a Program.
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
Instance All
The Instance All command creates a new copy of the top-level user blocks
from the referenced user block libraries. 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.
Remove Unused Variables removes the unused variables for all linked user
blocks in this device when the user block is instanced.
Creating a Program
The programs item allows you to add programs to a controller.
To add a program
Note The Add Existing Program command reads an XML file from another
system or controller into the current controller.
3 Enter the new program name or select an existing XML file from the
Select Existing Program dialog box.
A User Block can be either linked from a user block library or embedded acting
as a container for function and user blocks.
2 Enter the new variable name in the Add New Variable dialog box and
click OK. The new variable is added to the list in the Summary View.
Note Variables can also be added in the Summary View by directly editing the
last row of the variable grid.
Property Editor
The Property Editor allows you to edit the name, description, and execution
order of the program selected in the Tree View.
Note Since the schedule offset depends on the frame multiplier, it is possible to
select a frame multiplier for which the current schedule offset is invalid. This
will cause a validation error when you build the application.
User Block
The user blocks of a controller program display in the Tree View below the
Programs item.
User Block
Instance
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.
2 Enter the new variable name in the Add New Variable dialog box and
click OK. The new variable is added to the list in the Summary View.
Note Variables can also be added in the Summary View by directly editing the
append row of the variable grid.
User 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. For more information about
adding and modifying attributes, refer to the section, Working with User Blocks.
Schedule Offset: Offset from beginning of frame at which the user block
runs.
Frame Multiplier: The number of frames at which the user block runs.
Version: Version is the user-defined version of a user block.
Protection: Expand to show the access rights for this user block
definition.
Unlink: Unlinks the user block from the definition.
Execution Order: Sets the order of execution in the program.
Name: The name of this user block.
Description: The description of this user block.
BlockType: The name of the user block definition in the library
from which this user block started.
Finally, if the selected block is a function block, then the block diagram displays
the contents of the container user block with the function block selected in the
Summary View as follows:
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:
2 Select the CSV table definition file (.csv) from the browser window and
click Open.
3 Select the CSV table definition file (.csv) from the browser window and
click Save.
Double-click a value in
the Data Grid. .
This feature is useful to tune up the table data values in the controller. Once the
View Mode
Initially, the user block displays in View mode. In View mode, you cannot
modify the diagram. You can navigate and print the diagram, and you can also
select blocks and pins to display additional information.
Note If the user block is read only or linked, an error message displays if you
attempt to switch to Edit mode. (For more information about linked user blocks,
refer to the section, User Blocks) If the user block is protected, you will be
prompted to enter the appropriate password.
Auto-Layout Mode controls how the blocks on the diagram are arranged.
Refer to the section, Layout Modes.
Diagram Settings displays the Diagram Settings dialog box.
Insert Sheet inserts a sheet immediately before the current sheet in manual
mode.
Delete Sheet deletes the current sheet in manual mode.
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.
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 by execution order with a focus on
optimal use of space. The 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 and leaves all layout
tasks to the user. It is ideal for users that are familiar with a sheet-oriented
approach to design or for applications where very specific documentation
standards must be met. Manual mode gives you complete freedom to arrange
diagrams, but can be more time consuming to use than the auto-layout modes.
Select the category in the Library View that contains the desired block,
then drag the block to the Edit View. The block displays on the Block
Diagram.
Or,
Press the Insert key to display the Pick Block to Insert dialog box. Select
the desired block and click OK to add it to the Block Diagram.
Click a block in the Edit View. The block is selected and its properties
display in the Property Editor.
Block Help shows reference documentation on the selected block type in a help
window.
Show Description on Diagram toggles the display of description text for the
block. This text is the most effective way to document a block, as the text stays
attached to the block when the diagram is rearranged.
Edit Block Pins displays the Edit Block Connections dialog box.
Add Pin Group adds the next group of pins in a block with a configurable number
of inputs. For example, on a rung block, this would add the next available pin
unless all 16 are in use.
Remove Empty Pin Groups removes empty pins from the end of a rubber
block. This command does not remove empty pin groups in the middle of the block
(for example, pins A through D cannot be removed if Pin E is used).
Show Boolean Logic as Rung toggles the display of a rung block between a
rung diagram alone and a block containing a rung graphic.
Edit Ladder Logic displays the Rung Editor for a rung block.
Send to Front and Send to Back reorder blocks, causing them to appear above
or below all other blocks and shapes on the diagram when overlap occurs.
From the Block Diagram Editor, double-click a pin. The Connect Pin
dialog box displays.
Creates a new
variable in the
user block.
Tip Pressing Enter while entering text will select the next pin on the block,
allowing rapid entry of connections.
In the Edit Block Connections dialog box, a prefix letter and a colon
indicate the type of connection. These prefixes allow the connection type to be
specified just like the option buttons on the Connect Pin dialog box, except
prefixes can be typed quickly and pasted from the clipboard. The following are
valid prefixes:
Prefix Type
Boolean Values:
Select an option to
change the current
value.
Click here to send the Next Click here to invert the current
Value to the controller and value and immediately send it
close the dialog box. to the controller without closing
the dialog box.
Numerical Values:
Displays the
current value
of the variable.
Enter a value to be
added to or subtracted
from the variable.
Check this box to
prevent programs
from overwriting your
selected value. Click to increase or Click here to send the Click here to send the Next
decrease the variable by the Next value to the value to the controller
delta value and send the controller and close the without closing the dialog
result to the controller. dialog box. box.
Double-click an element of
the array to display the
associated Send Value
dialog box.
Click at the desired upper left corner of the text field, drag to the desired
lower right corner and release the mouse button. Enter the text in the dialog
box that displays and click OK. The new shape is added to the drawing.
The shape created by the text tool has the following properties:
Text displays the text displayed by the text shape.
Text Font displays the font used to display the text.
Foreground Color displays the color of the text.
Filled if set to true, the text shape will use the Fill Color as a background color.
Fill Color displays the background color shown behind the text if Filled is set to true.
Top displays the top location of the text shape.
Left displays the left location of the text shape.
Height displays the height of the text shape.
Width displays the width of the text shape.
Click the desired upper left corner of the shape, drag to the desired lower
right corner and release the mouse button. The new shape is added to the
drawing.
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.
Tip To ensure that images can be found when the diagram is moved on the
hard disk, avoid hard-coded path names or mapped drive names. Relative
names, such as ..\Metafiles\bom1.wmf are best.
Tip You can have as many detached views as desired, which can be
convenient for dragging pins from one drawing to another drawing.
Alignment Tools are available when multiple drawing shapes are selected
(either by drawing a selection rectangle around multiple shapes using the Pointer
tool or by holding the CTRL key while selecting additional shapes). The tool
modifies the location, width, or height of each shape to match the selected aspect
of the primary selected object (denoted with green selection handles). The Top,
Bottom, Left, and Right alignment tools affect location, while Width and Height
adjust size. Arrange Horizontal and Arrange Vertical equally space all of the
selected shapes along the Horizontal or Vertical axis.
Diagram Settings
The Diagram Settings dialog box contains options that change how the
diagram editor operates, including paper size and other stylistic options. 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
The Edit Diagram Settings dialog allows you to edit the following options:
Size selects the paper size.
Landscape when checked, the longest dimension of the paper becomes the
horizontal dimension, creating a drawing that is wider than it is tall.
Font Sizes controls the size of fonts in the diagram.
Hide Unused Pins when checked, unconnected pins are hidden.
Show Block Drawings when checked, blocks are drawn using graphical
representations of their operation whenever possible.
Show Wired Pin Connection Text when unchecked, the connection text
for wired pins is hidden, reducing clutter on the drawing.
Tip Selecting Default to parent setting or a gray check box indicates that
you have no preference at the current level. The diagram will use the settings
from the next level down in the hierarchy.
The Rung block controls variable values using Boolean logic equations. While
you can specify a Boolean logic equation directly by connecting it to the EQN
pin of the rung block, a graphical relay ladder diagram editor is also available to
simplify the process.
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 Use the Delete tool Drag separators to add or Click OK to save or cancel
to remove wires and remove columns. to discard changes .
contacts.
Contacts
Each contact represents a virtual relay switch that is controlled by a boolean
variable. Contacts which can 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
1 Select the contact tool that matches the type of contact you
want to add. The mouse cursor will change to reflect the selected
contact type.
2 Click a cell to add a new contact.
Wires
Wires are used to connect contacts to the coil and to each other.
To add a wire
Select the Wire tool , and then click a location on the grid.
Coils
The diagram always has one Coil.
Double-click the coil to open the Connect Contact dialog box. (For more
information, refer to the section, Contacts .)
Drag the boundary between any row or column. Blue text will display
indicating the result of the action.
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.)
Note In some locations, including Reports and the Block Diagram Editor,
shortcut menus contain commands that allow single pages or reports to be
printed.
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 Print Settings tab allows you Print Profile tab manages
you to change the paper to change the destination saved print settings. It stores
size, margins, and printer and its associated all the settings from both the
orientation. settings. Options and Page Option
tabs.
Prints a summary of
configuration settings Page Numbering
for the component. options control page
number assignment.
Linear pages number
sequentially start with
Includes a list of page one.
sections and page Hierarchical pages
numbers. number the same as
linear pages but also
Includes a symbol numbers each section
quick reference and sub-sections,
guide. such as 1., 1.1, 1.2.1
and so on.
1 Open ToolboxST. From the File menu, select New System to display
the New System dialog box.
2 In the Name box, enter test. Click OK to display the System Editor.
3 In the Tree View, right-click the system item to display the system
shortcut menu.
4 From the second shortcut menu, select Library Container. The Library
Container Creation Wizard opens.
5 On the Product Version page, click Finish to accept the default library
version and optional libraries.
6 Make sure the Lib1Usb1 item is highlighted in the Tree View, then click the
Edit button on the Block Diagram Editor toolbar. The Block Diagram
Editor switches to Edit mode and the Library View displays on the right
side of the block diagram.
7 Drag a MOVE block from the Library View to the Block Diagram
Editor to add it to the user block. Repeat this process two more times until
a total of three MOVE blocks display on the block diagram.
1 Open the System Editor for the test system created in the previous
procedure.
2 From the Tree View, right-click the system item to display the system
shortcut menu.
Click Next to
continue.
4 Right-click the Programs item again and select Add Program from the
shortcut menu. The Add New Program dialog box displays.
Click OK to accept
the default name.
5 Right-click the Prog1 item in the Tree View to display the Program
shortcut menu.
1 Open the System Editor for the test system created in the previous
examples.
2 From the System Editor, open the controller Component Editor by
double-clicking the controller in either the Tree View or the Summary
View.
3 Change the data type to BOOL by clicking the Type cell on the Attr1 row
and then selecting BOOL from the drop-down list.
Click OK to accept
the new value.
1 Open the System Editor for the test system created in the previous
examples.
2 From the System Editor, open the Library Container Editor by
double-clicking the Libraries item in the Tree View.
Right-click the
MOVE_2 block item
to display the block
shortcut menu and
select Add
Instance Script.
The block icon
changes to display
a blue S, indicating
that a script has
been added.
1 Open the System Editor for the test system created in the previous
examples.
2 From the System Editor, open the Library Container Editor by
double-clicking the Libraries item in the Tree View.
3 From the Tree View, expand Lib1 and right-click the user block Lib1Usb1
to display the shortcut menu.
4 From the shortcut menu, select Add User Attribute to display the Add
New User Attribute dialog box.
7 Change the Attr1_u data type to STRING by clicking the Type cell (which
currently contains UNDEFINED) and then selecting STRING from the
drop-down list.
Configure DDR
To configure a DDR
From the System Editor, double-click the Mark VIe Component. The
Component Editor displays.
Name - User defined description for this DDR. This name is used by the
Recorder for the filename.
DataRecorder Setup
Auto Enable - If set, the capture buffer is automatically enabled and then re-
enable 60 seconds after it is uploaded.
Buffer Control
Normal - Data recorder will collect pre-samples before a trigger event and
thereafter continue collecting until Enable transitions false or the collection
fills the buffer.
Only - Data recorder will evaluate the trigger each execution and only
collect data when the trigger condition is satisfied. Data will be collected
until Enable transitions false or the collection fills the buffer.
Frame Period Multiplier - Extends the sampling period by this multiple. The
base sampling period is the frame period.
Post Trigger Samples - The number of samples that are collected after the
trigger including the trigger sample.
Pre-trigger Samples - The number of samples that are collected before the
trigger.
Setup Variables
Trigger Setup
EQ - The value of the trigger variable must be equal to the trigger value.
GT - The value of the trigger variable must be greater than the trigger value.
GE - The value of the trigger variable must be greater than or equal to the
trigger value.
LT - The value of the trigger variable must be less than the trigger value.
LE - The value of the trigger variable must be less than or equal to the
trigger value.
NE - The value of the trigger variable must not be equal to the trigger value.
Trigger Type
Status Variables
Status variables, which indicate the status of the associated DDR, are used by
the Recorder to determine when to upload the data. Status variables are always
integers and are automatically defined and placed on the default EGD page.
Add Variables
Variables can be added to a DDR. When a trigger occurs, these variables are
collected by the buffer and are subsequently uploaded by the Recorder and/or
Trender. Each variable is sampled for the total number of samples configured.
This means that if the DDR is set up to record 100,000 samples with three
variables assigned, 300,000 items will be acquired. Up to 96 variables can be
assigned to each DDR.
Note There is a 12 MB size limit on the memory that can be allocated to the
DDRs. If this memory allocation is exceeded, an error is reported during
validation.
To add a variable
1 From the Component Editor, select the Dynamic Data Recorder tab
to display the DDR list.
Update DDR
DDRs are updated separately from the application code download.
To update a DDR
1 From the Component Editor, select the Dynamic Data Recorders tab
and click the desired DDR.
2 Click the Build button.
3 From the Device menu, select Download, and then select Update
Dynamic Data Recorder. Or, click the Update Dynamic Data
Recorder button .
2 From the Import File dialog box, select the .xml file that corresponds to
the DDR you wish to import. Click Open.
Note If the .xml file being imported contains the formatting flags %n, it will be
replaced by the Mark VIe component Design Memo (DM) number. This is a GE
Power Systems project number and can be edited by selecting the General tab
and Requisition Info.
5 Create a User Block in the program, and add two FuncGen blocks. These
are in the Data Collection section. Set up the pins on the two blocks as
shown below. FuncGen1 will be set up as a Sine wave generator and
FuncGen2 will be set up as a Triangle wave generator.
The DDR will be enabled with the DDREnable variable and the Trigger will
use the DDRTrigger variable. The DDR will be triggered when the
DDREnable is True and the DDRTrigger is greater than or equal to 5.
10 Now set the value of the DDRTrigger variable equal to or greater than 5
and send to the controller.
11 When the capture is complete, the status will indicate Complete and the
DDR can be uploaded.
13 Select + and the Trender wizard displays. Select Capture Buffer to select
the DDR to upload. The uploaded DDR variables are shown below.
The Ethernet Global Data (EGD) protocol allows you to share information
globally between controller components (sometimes known as nodes) in a
networked environment. EGD allows one controller component, referred to as
the producer of the data, to simultaneously send information to any number of
peer controller components (consumers) at a fixed periodic rate. This network
supports a large number of controller components capable of both producing and
consuming information.
EGD Configuration
To configure EGD for a controller
The following properties display in the Property Editor when Ethernet Global
Data is selected in the Tree View:
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.
1 From the Tree right-click the Produced Pages item, and then select
Add Page.
2 Enter a unique name for the new page in the Page Name dialog box and
select OK.
Note When the first Produced Page is created, it automatically becomes the
Default page. When a new Mark Vie is created, the Produced Page Default is
automatically created
1 From the EGD tab, select Produced Pages in the Tree View.
2 Select the Default Page Property from the Property Editor, and then
select the desired page from the drop-down list.
Tip Any variable defined with $Default as the EGD page name will
automatically be placed on the currently selected Default page.
To delete a page
From the Tree View, right-click the page you wish to delete and select
Delete page.
From the EGD tab Tree View, expand Ethernet Global Data.
Under Produced
Pages, select the
desired page.
The following properties are available for configuration when a Produced Page
is selected in the Tree View:
Ethernet 0 If selected, EGD will be broadcast on Ethernet Adapter 0. (If more
than one Ethernet Adapter has been configured for EGD, additional Ethernet
properties are displayed.)
Mode - When this property is set to Broadcast, the page is sent to all EGD
nodes. When set to Unicast, the page is only sent to a single destination.
Destination IP Address When Mode is set to Unicast, this property controls
the IP address that receives the exchanges.
Exchanges This property indicates the number of exchanges in the selected
page. It is updated after a build.
Default Page This read-only property is set to True if the selected page is the
Default Page. To change the default page, refer to the section, Produced Pages.
Page Compression
When a page compress operation is performed, the variable locations are
optimized. The variables are located in increasing size order, starting with
Booleans, then Words, Double Words, and finally all other variables.
From the Tree View, right-click the page to compress, and then select
Compress.
From the Tree View, right-click Produced Pages, and then select
Compress All.
In the Variable
Browser, select one
or more variables to
add to the page,
then click OK.
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.
From the Summary View, right-click the variable to delete, and then select
Delete Selected Row(s).
From the Summary View, right-click a variable, and then select Copy
Selected/Current Row(s). The data is copied in Comma Separated Value
(CSV) format.
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.
Grayed Exchanges
are not available to
this component.
The Modbus Slave feature on the Mark VIe controller allows a Modbus
Master to read and/or write data directly from the Mark VIe using the Modbus
protocol over Ethernet.
From a Mark VIe Component Editor, click the Modbus Slave tab.
Interface sets the Modbus Slave Interface type. Only Ethernet is currently
supported, but other interfaces like Serial may be supported in future releases.
Command Limit limits the number of commands processed per second. The
command limit is based on commands that have changed, not commands that are
identical to previously received commands.
Data Swapped changes the transmission order of each 16 bit word when set to
True. For example, if Data Swapped is set to true, 0x01234567 would be
transmitted as 0x45 0x67 0x01 0x23 and 0x0123456789ABCDEF
would be transmitted as 0xCD 0xEF 0x89 0xAB 0x45 0x67 0x01
0x23.
Serial Settings are provided for future use if Serial support is added to
ToolboxST. They are disabled in versions that only support Ethernet interfaces.
The Modbus Slave tab contains four pages that are used to exchange data with a
Modbus Master.The pages differ by the access the master receives to the data
(read-only or read/write) and the type of data (a Boolean or a 16-bit word) as
follows:
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
Connected Variable is the variable that is read or written from the Mark VIe or
the referenced device. A variable must be on an EGD page before it can be
added to a Modbus Slave page. You must specify a Connected Variable before
the other columns become active for a point.
Point Data Type determines the data type of the point and the registers used to
transmit the point 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.)
Point Address specifies the address of the register. When a point is created, the
Point Address is automatically set to a value adjacent to the highest point
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 register addresses. Valid ranges for Point Address are 1 to
65534. When specifying a Point 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 point raw data into engineering units. The Raw Min and Raw
Max columns control the minimum and maximum for the raw data and the Eng
Min and Eng Max columns control the minimum and maximum Engineering
units that the raw data will be scaled to. (The BOOL data type cannot be
scaled.)
Reports
Reports provide a variety of controller information in a viewable format.
Reports are displayed in a separate window and can be viewed, printed, and
saved for later use. When viewing a report on screen, you can also sort, filter,
and search the report to quickly locate information.
Report Types
Note For linked user blocks, internal block pins are not listed.
I/O Report
The I/O report provides a list of all hardware inputs and outputs points for the
controller. For every I/O point, the following columns are available for inclusion
in the report:
Entry Counts the number of items in the report. Sort by this column to
place the data in its original order.
Name Name of the point.
Description Describe the I/O point.
Device Tag ID of device attached to the screw.
Screw Name Name of the screw on the terminal board.
Screw Number Number of the screw on the terminal board.
Cable Number ID of the cable attached to the screw.
Wire Number ID of the wire attached to the screw.
Interposing TB ID of the terminal board junction, if any, between the Mark VIe
and the actual I/O.
Wire Jumpers External wire jumper.
Screw Note Additional information about the screw on the terminal board.
Alarm Report
The Alarm report creates a spreadsheet displaying all the variables marked as
alarms. For every variable, the report lists the variable name, description, alarm
ID, alarm class, display screen, and a status if it alarms on a zero condition.
Variables are marked as alarms in the variable Property Editor.
Hold Report
The Hold report creates a spreadsheet displaying all the variables marked as
hold variables. This report lists the variable name, description, and the hold ID
for each variable. Variables are marked as holds in the variable Property Editor.
Event Report
The Event report creates a spreadsheet displaying all the variables marked as
events. This report lists the variable name, description, and the event ID for each
variable. Variables are marked as events in the variable Property Editor.
NovRam Report
The NovRam report creates a spreadsheet displaying all the variables marked as
non-volatile. This report lists the variable name and description for each
variable. Variables are marked as NovRam in the variable Property Editor.
1 Open a Mark VIe Component Editor. From the View menu, select
Reports, and then select the desired report type from the submenu. (For
more information about the available reports, refer to the section, Report
Types.)
2 From the Select Report Columns dialog box, select and arrange the
columns you want to include in your report. When you are finished, click
OK.
From the File menu, select Save Report. In the Save Report dialog box,
enter a file name and click Save.
From the File menu, select Open Report. In the Open Report dialog
box, locate the report in .csv format and click Open.
To print a report
From the File menu, select Print. In the Print dialog box, verify the
settings are correct, and then click OK.
Viewing Reports
To change the zoom level of a report
From the Report View menu, select Zoom, and 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 will sort the column ascending; a second
click will switch the column to a descending sort.
A triangle in a column
header indicates that the
rows are sorted based on
the data in that column.
From the Report menu, select Change Columns to display the Select
Report Columns dialog box.
From the Report window, select the Report menu, and then select Apply
Filter to open the Edit Report Filter dialog box.
Click to add
parentheses to your
equation.
When using the LIKE operator, you must include a wildcard * at the
beginning and/or end of the right-hand value. For example, [Day Name]
LIKE T* would select Tuesday and Thursday.
You can use as many groups of parentheses as necessary to define an
expression.
Any string values must be enclosed in single quotes: 'string'
From the Report window, select the Report menu, select Remove Filter.
The filter will be removed and all available rows will be displayed.
From the Report window, select the File menu, select Save Filtered
Report.
From the Report window, select the Report menu, and then select Find to
display the Find dialog box.
If checked, the
capitalization in the
report and the
search string must
exactly match.
3 In the Open Report dialog box, select a report and then click Open. The
data will be imported. If a part of the data cannot be imported, it will be
highlighted when the imported report is displayed.
Open a Mark VIe Component Editor. From the View menu, select
Forced Variables to display the Forced Variables window.
Open a Mark VIe Component Editor. From the View menu, select
Global Variables.
The Global Variables window is particularly useful when you want to modify a
property for multiple variables. For example, to move multiple variables onto an
EGD page, select the rows for the desired variables and then change the EGD
Page property in the Property Editor. For additional information, refer to the
section, Data Grids.
The Global Variables window has some restrictions on the operations that are
available. Only existing global variables can be changed, so you can not add
new variables 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.
Open a Mark VIe Component Editor. From the View menu, select
Watch Windows.
The Watch Windows dialog box displays a list of the windows that have been
configured for the component.
Note If this is the first time the Watch Windows dialog has been used for the
selected component, the list will be empty and a new Watch Window will need
to be created or imported.
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.
1 In the Watch Windows dialog, select the desired Watch Window and
then click the Export button.
2 The Export Watch Windows dialog displays. Select the desired
destination and click Save.
1 From the Software tab, locate and select the variable to convert to a
control constant.
2 From the Property Editor, locate the Scope property and verify it is set
to Global.
3 From the Property Editor, change the value of the Control Constant
property to True.
4 From the Property Editor, assign an Initial Value and edit to Property
Editor. (Optional)
Open a Mark VIe Component Editor. From the View menu, select
Control Constants.
Enter a new value into the Initial Value Click to display the
box. Initial Value is the only column that Modify Value dialog box.
can be modified from the Control
Constants window.
NAME,VALUE,TYPE,UNITS,DESCRIPTION,FORMAT SPECFICATION
ControlConstant3,6.234,REAL,,,
ControlConstant2,55,DINT,,,
ControlConstant6[0],true,BOOL,,,
ControlConstant6[1],false,BOOL,,,
ControlConstant6[2],true,BOOL,,,
ControlConstant6[3],false,BOOL,,,
ControlConstant6[4],true,BOOL,,,
ControlConstant4,8769.876,LREAL,,,
ControlConstant5[0],20.1,REAL,,,
ControlConstant5[1],23.2,REAL,,,
ControlConstant5[2],34.5,REAL,,,
ControlConstant5[3],40.6,REAL,,,
ControlConstant5[4],55.5,REAL,,,
ControlConstant1,1,BOOL,,,
Open the Control Constants window. From the File menu, select
Export to CSV. In the dialog box that displays, select a location for the
exported data and click Save.
Open the Control Constants window. From the File menu, select Import
from CSV. In the dialog box that displays, select a location for the
imported data and click Save.
Menus
File Menu
Save saves changes to the current component.
Edit Menu
Undo returns the component to the state it was in before the last
action was performed.
Redo performs an action again after an undo command.
Paste places the contents of the clipboard into the currently selected
item.
Delete removes the currently selected item.
Insert opens the Insert Block dialog box while in the Block Diagram
Editor.
Build converts the current configuration into binary files that can be
downloaded to a controller.
Download
Controller Initial Setup opens a wizard that performs basic
configuration tasks on the controller.
Controller Flash Boot Loader installs the controller
bootloader onto a CompactFlash card connected to your
computer.
Download Wizard downloads base load, firmware and
application code to the controller and Distributed I/O modules.
Update Dynamic Data Recorder exchanges updated
information with the DDRs in the controller.
View/Set Time displays a dialog box that controls the controller
time.
Upload retrieves configuration information from the controller and
uses it to create a new controller component in the system.
Put Device to SDB stores the component configuration to a System
Database (SDB).
Pack Variables rearranges variables to minimize the amount of
space used.
Administer Totalizers opens the View/Set Totalizers dialog box.
Options Menu
Settings displays a dialog box with controller settings.
Help Menu
Release Notes
application code
Software that controls specific machines or processes.
ASCII
American Standard Code for Information Interchange. An 8-bit code used for
data.
attributes
Information, such as location, visibility, and type of data that sets something
apart from others. In signals, an attribute can be a field within a record.
baud
A unit of data transmission. Baud rate is the number of bits per second
transmitted.
BIOS
Basic input/output system. Performs the boot-up, which includes hardware self-
tests and the file system loader. The BIOS is stored in EEPROM and is not
loaded from the ToolboxST.
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 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, it is a data type for logical signals.
bumpless
No disrupt to the control when downloading.
byte
A group of eight binary digits (bits) operated on a single unit.
CMOS
Complementary metal-oxide semiconductor.
collection
A group of signals found on the same network. The Trend Recorder can be
configured by adding collections.
COM port
Serial controller communication ports (two). COM1 is reserved for diagnostic
information and the Serial Loader. COM2 is used for I/O communication.
configure
To select specific options, either by setting the location of hardware jumpers or
loading software parameters into memory.
Control Constant
Control Constant is a signal with an initial value that is read and never written.
dead band
A range of values in which the incoming signal can be altered without changing
the outgoing response.
device
A configurable component of a process control system.
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 for searching and determining the usage of a
particular item in a configuration.
flash
A non-volatile programmable memory device.
font
One complete collection of letters, punctuation marks, numbers, and special
characters with a consistent and identifiable typeface, weight, posture, and size.
forcing
Setting a variable signal to a particular value, regardless of the value blockware
or I/O is writing to that signal.
gateway
A device that connects two dissimilar LANs or connects a LAN to a wide-area
network (WAN), PC, or a mainframe. A gateway can perform protocol and
bandwidth conversion.
health
A term that defines whether a variable is functioning as expected.
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.
I/O drivers
Interface the controller with input/output devices, such as sensors, solenoid
valves, and drives, using a choice of communication networks.
I/O mapping
Method for moving I/O points from one network type to another without
needing an interposing application task.
instance
Update an item with a new definition.
logical
A statement of a true sense, such as a Boolean.
model
Interactive setup data (recipe) that automatically adjusts to the process. This
function is usually used with hot mills or cold mills.
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 when it is communicating with the
system for which it holds the configuration. Also, a download mode where the
device is not stopped and then restarted.
pcode
A binary set of records created by the ToolboxST, which contain the controller
application configuration code for a device. Pcode is stored in RAM and Flash
memory.
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.
PLC
Programmable Logic Controller. Designed for discrete (logic) control of
machinery. It also computes math (analog) function and performs regulatory
control.
reboot
To restart the controller.
register page
A form of shared memory that is updated over a network. Register pages can be
created and instanced in the controller and posted to the SDB.
Resources
Also known as groups. Resources are systems (devices, machines, or work
stations where work is performed) or areas where several tasks are carried out.
Resource configuration plays an important role in the CIMPLICITY system by
routing alarms to specific users and filtering the data users receive.
runtime
See product code.
sample set
Set of values taken when signals are being trended together with the Trender.
sampling rate
The period that values are collected to put in a sample set.
simulation
Running a system without all of the configured I/O devices by modeling the
behavior of those devices in software.
skew offset
A property of blocks that allows a user block to run at a different time slice than
other blocks within the same module.
Status_S pages
Devices share data through Status_S pages. They make the addresses of the
points on the pages known to other devices through the system database.
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 that monitors and graphs signal values from a
controller.
TrueType
Scaleable font technology that renders printer and screen fonts. Each TrueType
font contains its own algorithms for converting the outline into bitmaps.
Tuning Variable
Tuning Variable is a signal with upper and lower limits, which define the
bounds of the initial value and when making runtime changes.
validate
Makes certain that items or devices do not contain errors and verifies that the
configuration is ready to be built into pcode.
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, that is treated as an
entity and can be stored in one location. Also, a measurement of memory length,
usually 32 bit in length but van also be 4, 8, or 16-bits long.