Professional Documents
Culture Documents
PID
A/D
RAM
F
GLOBAL
SUPPLIERS
OF
TURBINE
ID
AND
COMPRESSOR
CONTROL
SYSTEMS
TrainTools
Series 5 OPC Server
User Manual
Web: www.cccglobal.com
© 2004-2005, Compressor Controls Corporation. All rights reserved.
This manual is for the use of Compressor Controls Corporation and is
not to be reproduced without written permission.
Air Miser, Guardian, Recycle Trip, Reliant, Safety On, SureLink, TTC,
Total Train Control, TrainTools, TrainView, TrainWare, Vanguard,
Vantage, WOIS, and the TTC and impeller logos are registered trade-
marks; and COMMAND, TrainPanel, and the Series 3++ and Series 5
logos are trademarks of Compressor Controls Corporation. Other
company and product names used in this manual are trademarks or
registered trademarks of their respective holders.
The control methods and products discussed in this manual may be
covered by one or more of the following patents, which have been
granted to Compressor Controls Corporation by the United States
Patent and Trademark Office:
4,949,276 5,347,467 5,508,943 5,609,465
5,622,042 5,699,267 5,743,715 5,752,378
5,879,133 5,908,462 5,951,240 5,967,742
6,116,258 6,217,288 6,317,655 6,332,336
6,494,672 6,503,048
Many of these methods have also been patented in other countries,
and additional patent applications are pending.
The purpose of this manual is only to describe the configuration and
use of the described products. It is not sufficiently detailed to enable
outside parties to duplicate or simulate their operation.
The completeness and accuracy of this document is not guaranteed,
and nothing herein should be construed as a warranty or guarantee,
expressed or implied, regarding the use or applicability of the
described products. CCC reserves the right to alter the designs
or specifications of its products at any time and without notice.
TrainTools Series 5 OPC Server 3
Document Scope
The TrainTools Platform Communication Servers software package is a collection
of programs that allow OPC Online Data Access and TrainTools Alarm and Event
clients and Modbus Masters to access controller information. Brief descriptions of
the programs in and installation instructions for each TrainTools software package
can be found in the TrainTools Product Overview and Setup manual [UM5500].
This manual tells how to use the Series 5 OPC Server gateway program, which
provides the OPC data access server, alarm and event server, and time synchroni-
zation service for Series 5 Vanguard and Reliant Controllers:
Chapter 1 introduces the Series 5 OPC Server program and its components.
Chapter 2 describes the S5_OPC program’s operator interface and OPC/DA
server component.
Appendix A tells how to connect a Windows PC to the ethernet ports of Series 5
Vanguard Controllers.
Appendix B tells how to connect a Windows PC to the S5P serial communication
ports of Series 5 Reliant Controllers.
Detailed information concerning the data available from the Series 5 Controller
operating system and each TrainWare Machine Control Application can be found in
the user manuals listed on page 5 of the user manual for any Series 5 product.
Additional information can be found in the following documents:
TN29 Series 5 Control System Time Synchronization
TN46 TrainTools Networking Recommendations
Documentation Conventions
The document title appears in the header of each odd-numbered
page, while the chapter or appendix title appears in the header of
even-numbered pages. Odd-page footers list the document number
and revision level [UM5505 (1.1.0)], while even-page footers provide
the publication date (April 2007).
Acronyms are defined in the sections of this manual that discuss the
corresponding subjects, by placing them in parentheses following
the spelled-out terms they represent. As an example, a three-letter
acronym (TLA) is a way to represent a three-word subject by com-
bining and capitalizing the initial letters of those three words. Most
are also listed under Symbols and Acronyms on page 10.
Cross-references to other documents specify a section and chapter,
while cross-references between chapters of this document specify a
page number. References that do not specify a location are internal
to the chapter in which they appear. In computerized versions of this
manual, all such references are hot-linked to their target locations
and appear in green. Entries in the tables of contents, illustration
and table lists, and index are also hot-linked but are not green.
Attention may be drawn to information of special importance by
using this text styling or one of the following structures:
Table of Contents
Document Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
TrainTools Documentation Road Map . . . . . . . . . . . . . . . . . . . . . . . . . 4
Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Table of Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
List of Figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Symbols and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Series 5 HMI Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Series 5 OPC Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
S5_OPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
S5_AES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Controller Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 2 Program Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Automatic Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Server Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Connection Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Data Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Data Item States. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Data Item Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Server Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Controller Connection Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
OPC Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Fully-Qualified ItemIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Browsing the Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . 22
MPU Status Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Simulated Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
General Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Times Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Browse Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Message Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
View Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Program Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Program Shutdown. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
List of Figures
Figure 1-1 TrainTools Series 5 Communication . . . . . . . . . . . . . . . . . . . . . . . . . 11
Figure 1-2 Series 5 Protocol Communication Links . . . . . . . . . . . . . . . . . . . . . . 12
Figure 1-3 Series 5 Controller Alarm and Event Communication . . . . . . . . . . . . 14
Figure 2-1 Series 5 Controller OPC/DA Communication. . . . . . . . . . . . . . . . . . . 15
Figure 2-2 Hierarchical Controller Software and Server Configuration . . . . . . . . 20
Figure 2-3 Series 5 OPC Server Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Figure 2-4 Series 5 OPC Program Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Figure 2-5 Series 5 OPC Program Object Listing . . . . . . . . . . . . . . . . . . . . . . . . 28
Figure A-1 Vanguard Controller Ethernet Ports . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Figure B-1 TrainTools to Reliant Controller Connection . . . . . . . . . . . . . . . . . . . 37
Figure B-2 Reliant Controller PPP Serial Ports . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Figure B-3 Connecting to an RS-232 Workstation Port . . . . . . . . . . . . . . . . . . . . 39
Figure B-4 Communication FTA used in Four-Wire PPP Connection . . . . . . . . . 40
Figure B-5 Example Four-Wire PPP Connection With CFTAs . . . . . . . . . . . . . . 41
Figure B-6 Using Repeaters with Surge Suppression CFTAs . . . . . . . . . . . . . . . 42
List of Tables
Table 2-1 Optional OPC/DA Version 2.0 Custom Interfaces . . . . . . . . . . . . . . . 15
Table 2-2 Simulated Data Item Names and Types . . . . . . . . . . . . . . . . . . . . . . 23
Table B-1 Commonly Used Connection Components . . . . . . . . . . . . . . . . . . . . 38
Table B-2 TrainTools Workstation RS-485 Adapters . . . . . . . . . . . . . . . . . . . . . 39
Table B-4 DB9-to-Pigtail Stub Cable Conductor Assignments . . . . . . . . . . . . . . 41
Table R-1 Manual and Product Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 1 Overview
This chapter introduces the Series 5 OPC Server program and its
components, which provide OPC data access, alarm and event
messages, and time synchronization datagrams for Vanguard and
Reliant Controllers.
Third-Party Third-Party
OPC/DA Clients Modbus Master
PC network
TrainTools
Gateway PPP serial links
PC
A
POWER
HEALTHY
R
FAULT
A
POWER
HEALTHY
IN CONTROL
ALARMS
R
FAULT
Series 5 HMI As discussed in more detail in the Series 5 Controller Operation and
Configuration manual [UM5402], the application software of each
Communication Series 5 Controller is a collection of function blocks, each of which:
see UM5402 • defines a set of HMI variables through which its operation can
be monitored and controlled; and
• incorporates alarm and event blocks that post AE notices to the
controller’s notification object service (NOS). Each such block
can also be monitored via a standard set of HMI variables.
Although a subset of the HMI variables can be accessed via each
controller’s Modbus RTU serial ports, most HMI communication is
via TrainTools Series 5 OPC Server programs that employ a client-
server Series 5 Protocol over TCP/IP connections:
• Each Vanguard Controller supports such communication with
approximately four PCs via either or both TMPU ethernet ports
(see Appendix A). To minimize the load on each such controller,
we recommend connecting them to only a few gateway PCs
using an isolated ethernet network. Additional network interface
cards (NICs) should be installed in those PCs if they need to
communicate with other computers.
• Each Reliant Controller can communicate with no more than two
PCs via Point-to-Point Protocol (PPP) serial port connections
(see Appendix B).
The system-level HMI variables and alarms and events common to
all Series 5 Controllers are listed and described in UM5402. The
information available from the machine control function blocks are
documented in the application software manuals listed on page 5 of
any Series 5 product manual.
S5_OPC This program’s OPC server component provides OPC Online Data
Access to variables defined by the controller application software:
• Each controller’s tags are defined and scaled using information
from an extended attributes (EA) file that is downloaded from
that device when this program first connects to it.
• The program can be set up to connect to specified controllers
on startup. Otherwise, it will connect to a controller and down-
load its EA file the first time any client tries to access its data.
• The server will subscribe to (rather than periodically poll) the
controller variables that clients have created active data items
for. All reported changes are timestamped by the controller,
rather than the gateway PC.
• Any parameter can be set only if the server’s access level at
least equals the variable’s access level property.
• Duplex controller parameters are read from the active MPU by
default, but clients can specifically monitor those of either MPU.
All changes are written to both MPUs.
• In addition to implementing all interfaces required by version
2.05 of the OPC Data Access standard, this program supports
the optional IOPCBrowseServerAddressSpace interface that
allows clients to obtain a list of its available data tags.
Compared to Modbus, OPC provides the following benefits:
• Only changed data is communicated, so less bandwidth is
required (especially important for Reliant Controllers).
• Each controller can be monitored and controlled by multiple host
programs, without having to directly communicate with more
than one program of each gateway PC.
Extended Attributes
Configuration
Transit File
Data Tags
Overview The Series 5 OPC Server program uses our Series 5 Protocol (S5P)
to communicate with Vanguard and Reliant Controller MPUs, and
shares its access to their HMI variables with programs incorporating
version 2.0 OPC/DA client components. All of the DCOM interfaces
required by that protocol are implemented, along with the optional
interfaces indicated in Table 2-1.
As discussed under Automatic Operation on page 16, this program
starts automatically when any client connects to it, and then adds
tag sets to its OPC Server Configuration (see page 20) that include
all of the HMI variables of each controller any client tries to obtain
data from.
This program’s User Interface (see page 24) can be used to monitor
its operation, force it to add tag sets for specified controllers each
time it starts up, or reconfigure its time-synchronization and certain
other features.
Automatic As with any other, this OPC server operates primarily in response to
client requests. In a run-time environment, such a client would:
Operation
1. Connect to the server. It could then query the Server Status
(see page 17) and browse the OPC Server Configuration (see
page 20) at any time.
2. Create, modify, delete, activate, and inactivate Data Groups
(see page 17) as needed.
3. Create, modify, delete, activate, and inactivate Data Items (see
page 18) within each group. Each active item provides access
to one of the data tags in the server configuration, each of which
is mapped to an HMI variable of a Series 5 MPU.
4. Read the states of the data items in its active data groups, and
ask the server to periodically report any changes to them. This
program will then subscribe to the mapped HMI variables, and
convey their reported changes to subscribed OPC/DA clients
5. Write new values to specific data items. The server will then try
to set the corresponding controller variable, reread its value,
and report that to any subscribed clients. This will succeed only
for commands, configuration parameters, and certain AE block
variables whose required access levels are no greater than this
program’s current Server Access Rights (see page 19).
6. Disconnect from the server if shut down. Unless other clients
were connected, an automatically-started server would then
shut itself down as well.
If this program is not running and any client tries to connect to its
host PC’s TrainTools Series 5 OPC Server, the operating system
will automatically launch it with its User Interface (see page 24)
minimized. It will then connect to and add tag sets for user-specified
controllers (see Browse Tab on page 26).
Subsequently, this server will connect to and create a tag set for any
other Series 5 Controllers its clients try to add data items for (see
Fully-Qualified ItemIDs on page 21). Thus, you can manually launch
this program to define devices and tags for its clients to browse, but
usually do not need to.
If any controller stops running its application software, perhaps while
new software is being loaded or other maintenance is under way,
this program will automatically detect and adapt to any changes in
its HMI variable set. Neither the server nor its client programs will
need to be restarted.
Server Status This server maintains and will report most but not all of the server
status information a client can request by invoking the GetStatus()
call of the IOPCServer interface. In particular:
• The BandWidth will always be zero (0.0).
• The GroupCount reports the number of private data groups the
server is currently maintaining for the requesting client.
• The LastUpdateTime will always be zero (0), which corresponds
to 12:00 a.m., January 1, 1601.
• The VendorInfo string is:
“Compressor Controls Corp., Series5 OPC Server”.
Data Groups Data groups provide a convenient way to manage access to multiple
controller variables, such as those required for a particular operator
interface picture:
• This server implements all private group interfaces mandated by
version 2.0 of the data access standard.
• This server does not implement the public group interface.
The following points should be considered when adding groups:
• The requested UpdateRate data group property should usually
be set to zero to specify updating as often as possible.
• All floating-point variable changes are reported regardless of the
PercentDeadband property’s value, because the associated EU
Type data item attribute is not implemented.
• The localization (LcID) feature supports only the default locale.
Because Reliant Controller PPP links communicate over (at best)
115 kilobaud serial connections, the frequency at which this server
can obtain data from them is limited. It can be maximized by:
• connecting only one controller to each serial port (as discussed
in Appendix B), and
• activating groups only when their data is needed.
Data Items Data items are connections via which controller variables can be
read and changed. Multiple data items can be created for any given
variable, generally in different data groups.
When adding data items to an existing data group, a Series 5 OPC
Server client must provide their Fully-Qualified ItemIDs (see page
21) and the suggested access path should be a null character string.
Data Item States Each data item has a state consisting of the following properties,
which are communicated each time a data item is read or updated:
• Its value represents the associated equipment or process condi-
tion (for example, a fluid temperature).
Although this server does not implement the EU Type property
for floating-point/analog variables, their values are scaled to
appropriate units that can be identified via the EU fields of the
associated analog inputs (see Appendix B of the Series 5 Con-
troller Operation and Configuration manual [UM5402]).
• The basic, two-bit quality (good/ bad/ uncertain) is indicated for
each data item. The limit field is not used, and the substatus
field is set only if the quality is bad:
0 : non-specific 5 : Last Known Value (comm failure)
2 : Not Connected 6 : Comm Failure, value cleared
3 : Device Failure 7 : Out of Service (loops not running or
tag no longer exists)
The quality of a field I/O signal will be reported as bad if the
corresponding signal fail variable is set.
• Its timestamp indicates when the value or quality last changed.
Although the standard provides methods for communicating other
item properties, none are defined by this server. However, some of
the information that could be provided in that fashion is available via
related controller parameters.
Data Item Attributes Each data item also has a number of standard attributes that clients
can request from the server. This program will report all such
attributes, with the following caveats:
ItemID: all fields of the associated fully-qualified ItemID
AccessPath: null string (access paths are not supported)
AccessRights: always Read-Write (3), even if the OPC Server
does not have sufficient Server Access Rights (see page 19)
EU Type: none (0)
EUInfo: VT_EMPTY (not used for type 0)
Server Access The ability of OPC clients to change the value of any data item
Rights depends on the current access level of the server’s connection to
the controller, which must be equal to or greater than the target HMI
variable’s access level attribute. In addition, variables that are set by
the controller’s application software (all Status variables, most AE
fields, and some Commands) can not be changed regardless of the
server’s access rights.
In order of decreasing security, the possible access levels are:
3 : system (highest)
2 : engineer
1 : operator (lowest)
For example, if a configuration parameter’s access level attribute is
set to engineer, it’s value can be changed by clients of a server
whose access level is system or engineer.
Each controller’s firmware defines a default access level (usually
operator) and a password for each available level, which can only
be changed by CCC technicians. The current access level for each
communication session can be monitored and changed via the fol-
lowing global variables:
• Access_Level and Level_Access report the server’s current
access level as a string and integer, respectively.
• Setting Password equal to one of the access level passwords
will change the server’s rights accordingly. The default operator
level access would then be automatically restored an hour later.
All clients of any given Series 5 OPC server share the same write
Caution: access level, so any Access_Level change made by any of them will
affect all of them.
OPC Server An OPC server’s configuration (or address space) is basically a list
of its available ItemIDs (also called tags), which are the names of
Configuration controller variables for which data items can be created. The config-
uration of an S5_OPC server includes ItemIDs for every variable
defined in the extended attribute (EA) transit files of every controller
it has communicated with since it was most recently started.
This program also maintains a list of all controllers it has ever con-
nected to and copies of their EA files. If a client tries to create a data
item for a tag not currently included in the server configuration, this
program first determines whether or not it has an EA file for the con-
troller specified in the tag’s Fully-Qualified ItemID (see next page):
• If so, it sends a request to the specified IP address asking that
controller to return the modification date of its EA file. If that date
indicates the cached EA file is current, a set of tags is created
using the information from that file.
• Otherwise, a new EA file is downloaded to the program cache
and used to create a set of tags for its controller.
In either case, the server will then create the requested data item.
Fully-Qualified To add a data item to a data group, a client must provide the fully-
ItemIDs qualified ItemID of the corresponding controller HMI variable. This
consists of several case-sensitive fields concatenated by periods:
IP#.program.application.group[.subgroup…].variable
where the first field (IP#) is the dotted-quad IP address of the target
controller’s primary MPU, the last is the name of the desired vari-
able, and the intervening fields specify the hierarchy of that
variable’s parent objects in one of the MPU’s application software
tasks. As shown in Figure 2-2 and discussed in Chapter 2 of the
Series 5 Controller Operation and Configuration manual [UM5402],
each such task consists of one or more programs that are com-
prised of nested function blocks:
• The highest-level function blocks are usually instances of Train-
Ware machine control applications.
• Each input or output of each application is a structured variable
whose fields can be accessed via a group with the same name
as the input or output.
• The HMI variables of those applications are all defined within
nested blocks named AE, Status, Command, and Config; thus
separating the alarms and events, status variables, commands,
and configuration parameters into groups.
• Those variables are divided into lower-level groups using
nested function blocks and structured data types.
For example, the fast task of a Vanguard Controller with IP address
10.9.1.100 might include a program named Prog1 that incorporates
a gas turbine fuel control block named GT1. That application’s fuel
control valve signal is in its Status variable group’s Operator sub-
group and is named FCV. Thus, its fully-qualified ItemID would be:
10.9.1.100.Prog1.GT1.Status.Operator.FCV
For duplex controllers, data will be read from the active MPU unless
you specify the desired source by prefixing an “A.” for the primary or
“B.” for the backup MPU. To specifically read the FCV variable from
the backup MPU, a data item should be created using the tag:
B.10.9.1.100.Prog1.GT1.Status.Operator.FCV
In any event, any variable value changes are written to both MPUs.
The MPU’s global variables are represented by a pseudo-program
named @GV whose variable groups all represent structured data.
For example, the ItemID of the global variable that indicates whether
or not duplex hardware is installed is:
10.9.1.100.@GV.Redundant_Enable
If a specified tag is not in the server’s configuration, the requested
data item will still be created but its quality will be reported as bad.
MPU Status The server also provides several synthesized status variables for
Variables each controller that are not included in its HMI variable set. The tags
for all such variables consist of the controller IP address followed by
a period and finally the variable name, which begins with an excla-
mation point. For example, the tag for the variable reporting the
controller type of the MPU with IP address 10.9.1.100 would be:
10.9.1.100.!CTYPE
The following variables are available for each controller, none of
which are included in the server’s browsable configuration:
!CTYPE: is an integer that indicates the controller type:
0 : Series 5 Emulator running on a PC
1 : Vanguard Controller
2 : Reliant Controller
3 : Vantage Controller
!MPU_TYPE: is a string that indicates the MPU type (MPU-555,
MPU-750, MPU-1002, PCOS-NT).
Simulated Data This server can also provide simulated data items for client testing
Items and development purposes. The fully-qualified ItemIDs for these
data items must be “0.0.0.0.” followed by a case-sensitive item
name from Table 2-2. For example, 0.0.0.0.sine(5,90) would specify
a sine wave varying between -1.0 and +1.0, a period of 5.0 seconds,
and a phase angle of 90 degrees.
Name Function
const(value) value of data item always equals specified value
ramp(period) value ramps from 0 to 100 every period seconds
rand random value in the range 0.0 to 1.0
sine function with specified period (in seconds) and
sine(period,phase)
phase angle (in degrees)
square wave, alternately 1.0 for s_on seconds, then 0.0
flip-flop(s_on,s_off)
for s_off seconds
1 Random values are used for any omitted arguments.
2 Items with same name do not necessarily represent a single signal.
Menus
Toolbar
Messages Pane
Status Bar
Figure 2-3 Series 5 OPC Server Main Window
User Interface This program’s main window is displayed (but can be minimized)
when it is launched from the Windows user interface. If it is automat-
ically launched in response to an OPC or AE client request, that
window is initially minimized but can be opened from the taskbar:
• Various actions can be initiated by selecting a command from
the Menus along the top of the main window.
• The Toolbar provides an iconic button for executing the Help ->
About S5_OPC command (none of the other command buttons
are currently implemented). It can be hidden (or displayed) by
invoking the View -> Toolbar command.
• The Messages Pane displays brief descriptions of program and
server events and errors (see Message Log on page 27). It can
be alternately hidden or displayed by invoking the View -> Out-
put command or Alt + 2 key combination.
• The Status Bar, which is not used, can be alternately hidden or
displayed by invoking the View -> Status Bar command.
This window can be resized, moved, minimized, maximized, or
closed using standard Windows techniques.
Times Tab The Times tab includes fields specifying the timeout settings for S5P
communications with Vanguard and Reliant controllers:
Both fields should be set to zero (0) unless you are instructed to
change them by CCC support personnel. Changing either would not
affect existing controller connections, but the new value will be used
for any subsequently-opened connections.
Browse Tab The Browse tab can be used to edit the list of Series 5 Controllers
this program will automatically connect to at startup, which are listed
in the large, initially blank lower-left field:
Message Log The Message Pane (see Figure 2-3) displays brief descriptions of
various server events and errors, along with their dates and times of
occurrence:
• starting and stopping of the server program
• starting and stopping of the time synchronization datagrams
• creation and deletion of each controller’s tag set (device)
• creation and deletion of each OPC server and data group object
• failed attempts to add requested data items
• controller connection failures
• starting and stopping of each connected controller
Those messages are also recorded in a text file named S5_OPC.log
stored in the TrainTools\Log folder. That file can be viewed in a
Windows NotePad window (see Figure 2-4) by invoking the View ->
Log file… command. It can also be opened by any other program
that can use ASCII text files. If that log file is not present when the
server program is started, a new one is created. If it exceeds a hard-
coded maximum size, it is renamed S5_OPC_1.log (replacing any
earlier file with that name) and a new one is started.
View Objects Invoking the View -> Objects command causes this program to gen-
erate and open an extended markup language (XML) file describing:
• the properties of all data groups and items being maintained for
each OPC/DA client,
• the properties of each S5P connection and the controller HMI
variables being monitored via that link, and
• the properties of all alarm and event message objects being
maintained for the AE clients of each controller.
This file, which is named S5_OPC_Objects.xml, is stored in the
TrainTools\Log folder. It can be viewed using any program that can
open text files, including web browsers. However, it does not include
the XML schema such programs would need to format the data.
Program Version To determine which version of this program is installed, select the
Help -> About S5_OPC… command or click on the About button
( ) to display the following information window:
Program You can shut down this server program by invoking its File -> Exit
Shutdown command. If you do so while clients are connected, the following
alert window will be displayed, thus forcing you to leave the program
running until those clients have been disconnected:
Introduction The S5 OPC Server program can communicate with any Vanguard
Controller via an Internet Protocol (IP) connection to any of its three
twisted-pair ethernet ports (see Physical Connection on page 32):
• Only the two ports whose connectors (E1 and E2) are located
on the MPU’s back-panel termination module (TMPU) should be
used for permanent connections:
• Because both are provided by the MPU’s Ramix daughter
card and the E1 connector is above that labelled E2, they are
called the Ramix_Top (E1) and Ramix_Bottom (E2) ports.
• Because their IP parameters are configurable, they can be
used to network multiple controllers and workstations.
• Each MPU’s front-panel ethernet port should only be used for
temporary maintenance connections. Its IP address and subnet
mask are always 10.5.1.1 and 255.255.0.0, which means only
one MPU front-panel port can be connected to any network.
The IP configuration of each Ramix port should be set once (using
the Series 5 Configurator utility) and then never changed, so each
PC you need to connect must be given compatible TCP/IP Settings
(see page 32). Because the front port’s configuration is fixed, you
can always use it to determine the Ramix port settings (see Control-
ler Port Settings on page 35).
The MPUs of a duplex controller, which are assigned consecutive IP
addresses, must both be connected to the same network. If a Series
5 OPC Server running on that PC connected to either MPU, it would
detect that it was for a duplex controller and automatically read data
from the active module and write new values to both.
In order to limit the MPU communication load, the controller operat-
ing system supports only 10Base-T communication. In addition,
permanent gateway PC connections should use isolated networks
that include no other devices (as illustrated in Figure 1-2) so extra-
neous network traffic cannot degrade the controllers’ process
control capacity. If that PC needs to be connected to another local
area network, it should be equipped with multiple ethernet cards and
configured for multi-homing (as discussed in the TrainTools Work-
station Networking Recommendations technical note [TN46]).
Tx Rx Tx Rx
Tx Rx Tx Rx
E2
E1
TMPU-750
P3
P1
2 TX –
P4
P2
3 RX +
4
5 MPU-750 Service Port Connectors (Front Panel)
6 RX –
BFL CPU
CPCI CPI
7
RST
ABT
8 PCI MEZZANINE CARD 10/100 BASE T COM 1 USB 1 USB 0
Physical The RJ-45 jacks for all Vanguard Controller ethernet ports comply
with the EIA/TIA 568B pin-out specifications:
Connection
• When connecting such a port to an ethernet hub or switch, use
standard category 5 RJ-45 to RJ-45 cables whose plugs both
have the pinouts shown in Figure A-1.
• To temporarily connect a PC to a single MPU, use a crossover
cable that has each plug’s transmit pins connected to the other’s
receive pins (1 to 3, 2 to 6, 3 to 1, and 6 to 2).
TCP/IP In order for the Series 5 OPC Server program to communicate with
any Vanguard Controllers physically connected to its host PC, the
Settings TCP/IP properties of that PC’s network interface card (NIC) must be
compatible with those of the workstation port. In general, all such
PCs and controllers should be assigned unique host IDs on the
same subnet, so no router will be needed (in which case each
device’s default gateway setting is unimportant):
• The PC’s subnet mask must match that of the controller port.
We recommend setting all subnet masks to 255.255.0.0, so the
subnet number will be the first two bytes of the IP address.
• The subnet portion of the PC’s IP address must match that of
the controller, while the remainder must be unique.
For example, a typical controller IP address and subnet mask might
be 10.8.103.2 and 255.255.0.0. To communicate with it, a PC must
be assigned the same subnet mask and a unique IP address begin-
ning with 10.8.
If you know a Ramix port’s IP address and subnet mask, all you
need to do is configure the PC accordingly (see Gateway PC Set-
tings on page 33). Otherwise, you must first connect via the front
port and use the Configurator utility to determine the needed Ramix
port settings (see Controller Port Settings on page 35).
Step 4: Click on the Use the following IP address option. If this con-
nection will be used solely for PC-to-Vanguard communication,
leave the Default gateway and DNS server fields blank.
Step 5: Type a unique IP address compatible with the controller’s
subnet into that field, as discussed on page 32 (as an example,
enter 10.9.201.2 by typing 1-0-period-9-period-2-0-1-period-2).
Step 6: Type the controller’s Subnet mask into that field.
Step 7: Click the OK buttons of this and the connection dialogs, then
close the Network and Dial-up Connections window.
Verifying the Use the following procedure to verify the workstation’s network con-
Connection nection to a Vanguard Controller:
Step 1: Select Run from the Start menu, type “command” in the Run
dialog’s Open field, and click its Run button.
Step 2: After the resulting command prompt, type ping followed by
the controller’s IP address, then press the Return key to see
whether or not that controller replies:
Step 3: Type “Exit” and press the Return button to close the window.
Controller Port The Ramix port TCP/IP settings can be determined by running the
Settings Configurator utility via a connection to the front-panel ethernet port:
Step 1: Connect the PC to that jack using an RJ-45 crossover cable.
Step 2: Configure the PC’s local area connection to use the subnet
mask 255.255.0.0 and IP address 10.5.1.2.
Step 3: Start the Series 5 Configurator program.
Step 4: Right-click in its controller list (left pane) and select its Add
Controller shortcut command to open this dialog:
RS-485 RS-485
or
RS-232 CTS A
TX+ =
TX– =GW RX+RX
RX–==RB
RTS
TX
F1 F2 F3 F4 F5
POWER
HEALTHY
R %
FAULT ENTER
MEMU
CLEAR
SCROLL
P2R+
P2R–
P3R+
P3R–
P4R+
P4R–
P5R+
P5R–
P2T+
P2T–
P3T+
P3T–
P4T+
P4T–
P5T+
P5T–
INST
P1+
P1–
1
TX+
2 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
TX–
P2
P4
P6
3
Reliant DN Controllers
4
RX–
P2AR+
P2AR–
P2BR+
P2BR–
P5AR+
P5AR–
P5BR+
P5BR–
P2AT+
P2AT–
P2BT+
P2BT–
P5AT+
P5AT–
P5BT+
P5BT–
P3R+
P3R–
P4R+
P4R–
P3T+
P3T–
P4T+
P4T–
INST
P1+
P1–
5
RX+
P1
P3
P5
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
Ethernet Serial Another way to connect Reliant Controllers to gateway PCs is to use
Port Hub ethernet-to-serial port hubs (such as the HUB-SE-C-2 described by
the Ethernet to Serial Port Hub data sheet [DS5017]) to route PPP
connections over an ethernet network.
Part Number
Description (3) Reference
Advantech 2-Port RS-485 PCI Adapter 45-000220-004
DB9 to one pigtail cable 20-305391-###
DS5503
Advantech 4-Port RS-485 PCI Adapter 45-000220-005
DB25 to four pigtail cables 20-305390-###
3) ### is cable length in feet (10, 25, 50, 100, 250, or 500).
Part Number
Description (3) Reference
AEG RS-232 to RS-422 Converter 50-200100-004 TN14
HUB-SE-C-2-AC
Ethernet to Serial Port Hub DS5017
HUB-SE-C-2-DC
3) ### is cable length in feet (10, 25, 50, 100, 250, or 500).
T1
6 S1+ (Tx+, to DB9 pin 1)
1
7 S1– (Tx–, to DB9 pin 2)
2
8 ISO Gnd (unused cable ground, to DB9 pin 3)
3
9 S2– (Rx–, to DB9 pin 4)
4
10 S2+ (Rx+, to DB9 pin 5)
5
S Cable Shield (to DB9 shell)
S
G GND (to surge suppression circuits)
S
4 WIRE
Instrument
Workstation Reference
RS-485 Port G
S Ground
S
S 5
4
2
7
1
6
SW3 OFF Termination Disabled
2
7
1
6
SW3 OFF Termination Disabled
Cable Shield For best results, the serial cable’s shield should be connected to an
Grounding instrument reference grounding block. For safety reasons, it must
not be grounded at any other point. Surge suppressors can be inde-
pendently grounded when isolated from the network cable.
Surge Suppression The CFTA with built-in surge suppression or a separate surge pro-
tection device should be installed when the connecting cable passes
between buildings, near inductive equipment or high-voltage lines,
through an area with known power or grounding problems, or when
more than 100 feet of cable is outside of metal cabinets or other
shielded environments.
The surge suppression CFTA protects only the device wired to its
Caution: P1 DB9 connector.
Instrument
Safety Reference
Ground Ground
Suppression CFTA
Reliant SC
S
G
S
S
K
A
5 Rx+ 5 Rx+
G
D
4 Rx–
4
2
Rx–
Tx–
1 Tx+
2
H
E
7 Tx–
1
B
L
6 Tx+
Up To 1600 feet
Termination Disabled
Shielded Area
5 Rx+ 5 Rx+
G
D
4 Rx– 4
Rx–
2 Tx–
1 Tx+
H
E
2 Tx–
7
B
1
L
6 Tx+
RS-485 Repeaters RS-485 line repeaters can be used to increase the allowable length
of a Reliant PPP connection by dividing it into segments, each of
which complies with the cable length limits of its own devices. The
repeaters available from CCC can communicate with:
• each other over up to 2000 feet (600 meters) of cable, or
• Reliant PPP ports over up to 1000 feet (300 meters) of cable.
PPP Before the Series 5 OPC Server program can communicate with a
Reliant Controller, a PPP connection must be opened between its
Connections host PC and that controller:
• If a Reliant Controller connection has already been defined, all
you need to do is activate it.
• If not, you must create the connection as described in Chapter 3
of the Series 5 Communication Interfaces manual [UM5010].
When the Windows XP and 2000 instructions differ, those for 2000
Note: will appear first or to the left.
Step 2: Double-click the icon for the desired Reliant PPP connection
(for example, the icon named Reliant in the examples above) to
open its Connect dialog:
Step 3: Type “ppp” in the User name field and “kallekula” in the
case-sensitive Password field, then click the Connect button.
You can eliminate the first step or even set your PC to automatically
initiate this procedure by creating an appropriate shortcut to this
connection, as discussed in Appendix C of the TrainTools Product
Overview and Setup manual [UM5500]). You can also bypass the
login dialog using the following procedure:
Step 1: Enable its Save password option.
Step 2: Click its Properties button and select the Options tab of the
resulting Direct Connection Properties dialog:
Verifying a PPP Any time a PPP connection between a PC and a Reliant Controller
Connection is open, its integrity can be verified using the following procedure:
Step 1: Select Run from the Start menu, type “command” in the Run
dialog’s Open field, and click its Run button.
Step 2: After the resulting command prompt, type ping followed by
the controller’s IP address, then press the Return key. The PC
will then send a series of queries to the controller to see whether
or not it replies:
If the results indicate these queries are timing out (no replies are
being received), check for a break in the physical connection or
a problem with the controller.
Step 3: Type “Exit” and press the Return button to close the window.
Revision History
This appendix lists and describes the changes incorporated into each version of
this manual and the Series 5 OPC Server program.
Manual TrainTools
Version Release Revised Software Features
1.0.0 4.0 reference version
5.0 changed Lost Connection Message from event to alarm
added support for Online AE Changes
1.1.0 added support for Series 5 Emulator Program
6.1
added Time Sync Alarm
added support for Vanguard MPU-1002
TrainTools The initial version of this manual documented the Series 5 OPC
Server program included in the TrainTools Release 4.0 Platform
Releases Communication Servers software package. The following sections
of this publication describe only the subsequent major changes to
Release 4.0 that package.
Release 5.0 TrainTools Version 5.0 introduced the following changes to the
Series 5 OPC Server program relative to Release 4.0:
Lost Connection Loss of communication with a specific controller now triggers the
Message posting of a Lost Connection event, rather than the alarm that was
previously posted.
Release 6.1 TrainTools Version 5.0 introduced the following changes to the
Series 5 OPC Server program relative to Release 5.0:
Online AE Changes This version will recognize and begin using any alarm and event
attributes changed by downloading a revised AE definitions file to a
running controller.
Series 5 Emulator This version added the ability to communicate with emulated MPUs
Program running on a single PC via different TCP ports.
Time Sync Alarm This version will post an alarm to any AES clients for any controller
whose reported clock setting differs from that of this program’s host
PC by more than one-half second.
Vanguard MPU-1002 Support was added for the new Vanguard MPU-1002.
Manual Version 1.0.0 of this manual, which was released in April of 2007,
documented the Series 5 OPC Server program in the TrainTools
Revisions Release 4.0 Platform Communication Servers software package.
This section describes changes made subsequent to that release.
Version 1.1.0 Revision 1.1.0 of this manual documented the new, revised, and
previously undocumented features of the Release 5.0 and Release
6.1 versions of the Series 5 OPC Server program:
• A paragraph mentioning the new Time Synchronization Lost
alarm was added to the Controller Time Synchronization section
of Chapter 1.
• The Connection Status and MPU Status Variables sections
were added to Chapter 2.
• The Document Scope (page 3) and Appendix A now reference
the new TrainTools Networking Recommendations technical
note [TN46].
Index
A Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18, 19
AccessPaths (not implemented) . . . . . . . . . . . . . . . . . . . . . . . . 18
Address Space, OPC Server — see: OPC Server
AE Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Alarm and Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Alarm and Event Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . 12, 14
Attributes, Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Automatic Server Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
B Browsing Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 22
H HMI Variables
Access Rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Machine Control Applications . . . . . . . . . . . . . . . . . . . . . . . . . 3
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
I IP Addresses, Vanguard Gateway PCs . . . . . . . . . . . . . . . . . . 33
ItemIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20–22
L Localization (default only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
M Main Window, Server Program . . . . . . . . . . . . . . . . . . . . . . . . . 24
Message Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24, 27
MPU Status Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
N Network Connections
Setting IP Address in PC . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Verifying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34, 45
Notification Object Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
O OPC Server
Automatic Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Browsing Address Space . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Configuration (Address Space) . . . . . . . . . . . . . . . . . . . 20–22
Controller Connection Status . . . . . . . . . . . . . . . . . . . . . 17, 23
Fully-Qualified ItemIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Simulated Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Status Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Viewing Current Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
see also: Series 5 OPC Program
OPC/DA Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15, 17
P Password, S5P Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
PercentDeadband (not supported) . . . . . . . . . . . . . . . . . . . . . . 17
Point-to-Point Protocol . . . . . . . . . . . . . . . . . . . . . . . . . 37, 43–44
Preferences, Server Program . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Program Shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Program Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Public Data Groups (not implemented). . . . . . . . . . . . . . . . . . . 17
Q Quality, Data Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
R Reliant Controllers
Activating PPP Connections . . . . . . . . . . . . . . . . . . . . . . 43–44
Communication Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . 12, 19
PPP Serial Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37–38
RS-232 Converters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
RS-485 Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
RS-485 Repeaters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
S Serial Ports (Reliant Controllers) . . . . . . . . . . . . . . . . . . . . . 37–38
Series 5 Emulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Series 5 OPC Program
AE Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Automatic Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–14
Main Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Preferred Controller Connections . . . . . . . . . . . . . . . . . . . . . 26
Shutting Down. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
see also: OPC Server
Series 5 Protocol . . . . . . . . . . . . . . . . . . . . . . . . 12, 19, 26, 31, 37
Server Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Simulated Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
State, Data Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Surge Suppression, Reliant Serial Ports . . . . . . . . . . . . . . . . . . 42
T TCP/IP Settings, Vanguard Controllers . . . . . . . . . . . . . 31–32, 35
Time Out Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14, 25
Timestamps
Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Data Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
U User Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
If you have questions or comments concerning the information provided in this user manual or
in any of our technical documents please contact CCC’s Technical Documentation Department:
E-mail: TechDocsMgr@cccglobal.com
Which Series of Controllers do you have, and are you using our TrainTools software?
Yes No
2. Did you find what you were looking for? ❒ ❒