TriStation 1131

Turbomachinery Control Software

Functions Library General Information

Rev. 3
February 3, 2005

Webster, Texas
 Contents i

Contents
Contents .................................................................................................................... i
ILLUSTRATIONS ..............................................................................................................................I
Introduction to the Turbomachinery Control Function Libraries ....................... 1
CONVENTIONS................................................................................................................................ 1
PROGRAM EXECUTION ORDER .................................................................................................. 1
Warnings .................................................................................................................. 2

Installation ................................................................................................................ 3
INSTALLATION INSTRUCTIONS ................................................................................................. 3
Inter-Connecting Words (ICWs).............................................................................. 4
INTRODUCTION TO ICWS............................................................................................................. 4
What are ICWs? ............................................................................................................................. 4
Enable/Disable Vs. Auto/Manual................................................................................................... 4
Enable/Disable Control.............................................................................................................. 4
Auto/Manual Control.................................................................................................................. 5
Setting up ICWs in a Program........................................................................................................ 6
DESCRIPTION OF ICW BITS.......................................................................................................... 7
How an ICW Breaks Down Into Status Bits .................................................................................. 7
ICW Status Bit Description............................................................................................................ 8
Revision Discussion................................................................................................ 9

APPENDIX A: INVENSYS SYSTEMS INC. / TRICONEX TMC LIBRARIES

SOFTWARE SITE LICENSE AGREEMENT ........................................................... 10

Illustrations
Figure 1. Function Blocks vs. Functions ............................................................................................... 1
Figure 2. ICW Usage Example.............................................................................................................. 6
Figure 3. ICW Status Bits...................................................................................................................... 7

February 3, 2005 Rev. 3

 Introduction to the Turbomachinery Libraries 1

Introduction to the
Turbomachinery Control Function Libraries
Conventions
Throughout this manual there are descriptions of various function blocks which combine a series of
Boolean values into a numerical two-byte integer (of type DINT) to be used as inputs or outputs. The
individual bits of these status words represent Boolean values TRUE (0) and FALSE (1). It is
important to note that though these status bits represent Boolean values, they are actually stored as
bits in a numerical integer value. As such, they must be converted to or from Boolean values to be
used by the programmer. Furthermore, the convention in this manual refers to the bits as bit zero (the
least significant bit or LSB) to bit fifteen (the most significant bit or MSB).
Also, in this manual a distinction is made between functions and function blocks. This distinction is
illustrated in the figure below:

NOTES:

1.
1 Input Function 1 Output

2.
Function
Multiple Inputs Multiple Outputs
Block
Last?

3. True = On = 1
False = Off = 0 Function/ Setpoint
Function
Block ICW

Last? Last?
CI CO

Setpoint AM
Setpoint Function/ Setpoint Function/ ICW
Function Function Setpoint
ICW Block ICW Block Last?
ICW

CI (Enables/Disables CO CI CO
Function/Block) Function/ Setpoint
Function
AM Block ICW
AM (If Function/Block is enabled,
places in Auto or Manual)
CI CO

AM

Figure 1. Function Blocks vs. Functions

Program Execution Order

As with most TS1131 programming, programs using these functions are HIGHLY sensitive to
program execution order. Each function block MUST be executed AFTER all of its inputs have been
processed for it to work correctly. If the function is calculated before one of its inputs, processing
may be delayed for a scan, and back calculation and tracking features will not function.

February 3, 2005 Rev. 3

 Warnings 2

Warnings
• Equip the engine, turbine, or other type of prime mover with an overspeed (overtemperature or
overpressure, where applicable) shutdown device that operates totally independently of the prime
mover control device. This protects against a run-away condition or damage to the engine,
turbine, or other prime mover, or personal injury or loss of life, should the mechanical-hydraulic
or electronic governor, actuator, fuel control, driving mechanism, linkage, or controlled device
fail.
• Improper use or application of the functions contained in these software libraries may result in
damage to equipment or bodily harm. It is assumed that you have a suitable level of expertise to
design software that combines these functions in a proper and safe manner. You assume the
entire risk as to the results, quality and performance of the functions contained in these libraries
and any resulting applications that use them.

February 3, 2005 Rev. 3

 Installation 3

Installation
Installation Instructions
Since installing the libraries is simply a matter of copying them to your hard drive, no automated
setup program is provided.

Each library consists of two files: an export library file (.LT2) and a library specification file (.LSP).
Additionally, there is a user manual .PDF file for each library.

Copy each library’s .LSP and .LT2 file from the CD to the library repository on your hard drive. For
Tristation 1131 Version 4, the default directory location of the libraries is as follows:

C:\Documents and Settings\<user>\My Documents\Triconex\TriStation 1131 4.1\Data

where <user> is your Windows logon user name.

Once you have copied the library files to your hard drive, you may then import them into your 1131
application. In Tristation 1131 Version 4, follow these steps:

• Right click Library Documents in the Workspace tree view, then click Manage on the resulting
pop-up menu.
• Click the Add… push button
• Choose the just-copied library from the list on the window, then click OK
• Click Yes on the Confirmation dialog box

February 3, 2005 Rev. 3

 ICWs 4

Inter-Connecting Words (ICWs)

Introduction to ICWs
What are ICWs?
An Inter-Connecting Word (ICW) is a double integer word composed of status bits that are used to
connect commoned features of function blocks. Its variable type in TS1131 is always DINT.
(Several inputs and outputs of function blocks have associated ICWs.) The ICW is used to transfer
status information, both upstream to the function blocks providing inputs, and downstream to any
function blocks receiving output(s).
To understand the way this works, it is useful to think of a value that travels down a chain of function
blocks which start (upstream) with an input from the process, and travel (downstream) function by
function to an output to the process. Each function block will process the value and manipulate it as
appropriate until it reaches the output. It is vitally important that the function blocks be executed in
order from upstream to downstream in order for the whole loop to operate properly.
The ICW information is used to easily facilitate anti-wind-up reset, setpoint tracking, etc., without a
large effort on the part of the programmer.
In general, the ICW status bits are set by one function block in response to a condition or event, and
reset by the block that requires that status information (the block that will react to the information),
regardless of which direction the status bit is passed. This strategy enables ICWs to be handled
properly between functions that are executed with different timing. For example, it may be desirable
to schedule a program function block to function only once every second instead of every scan. This
strategy will let the status bit remain set until the scheduled function block executes. There are
exceptions to this general rule, so it is necessary to read the description of each status bit to determine
if this is the case.
In addition, there are special rules that determine how the status bits are passed through function
blocks which have multiple inputs or outputs. For example: a HIGH_SEL_ICW function block has
6 inputs. In the event that these function blocks are used, it is necessary to understand exactly how
the bits are passed through the function block.

Enable/Disable Vs. Auto/Manual

It is important to understand that, where ICWs are concerned, there are generally at least two ways to
control the way most function blocks operate:
Enable/Disable Control
When a function block is enabled (by setting its CI input to TRUE) it will perform some function and
manipulate its outputs and ICWs accordingly. ICW status bits will be passed on to the next function
block (both upstream and downstream) and/or acted upon as appropriate. If the function block is
disabled it will stop all processing, including ICW flags, and its inputs and ICWs will remain in their
current states indefinitely with NO CHANGES. An exception to this is that the function block will
set its ENAB bit to FALSE in its output ICWs. This enable/disable type of control is used if the
programmer wants to cause the function block to operate only under certain conditions, or only at
certain intervals.

February 3, 2005 Rev. 3

 ICWs 5

Auto/Manual Control
The auto/manual status of a function block is not nearly as clear cut and consistent as that of the
enable/disable method of control. In fact, it differs from the latter in a fundamental way.
Auto/manual control is generally used to place the function block in one of two modes of operation,
rather than causing it to cease processing altogether. Inputs and outputs will generally continue to be
processed according to the purpose of the function, and ICWs will continue to be acted upon or
passed as appropriate. Regardless of the auto/manual status of the function block, the block must be
enabled for this processing to occur. Thus, the auto/manual status of a function block is irrelevant if
the block is disabled.
Every function block has the enable/disable method of control, and most function blocks have
auto/manual control, but there can be exceptions to the latter.
Some function blocks perform very complex functions, and may have several other modes of control
which operate when the block is in automatic control. Generally, these function blocks will revert to
one mode of operation (usually Tracking) when they are in manual mode.

February 3, 2005 Rev. 3

 ICWs 6

Setting up ICWs in a Program

Every input and output of an ICW-enabled function block must be connected to function blocks
upstream and downstream of the function block. All that is required to use the ICWs is to also
connect the corresponding ICWs to the upstream and downstream function blocks. If one of the
connecting function blocks is not ICW-enabled, the ICW may generally be connected to an unused
memory variable or connected to a constant. If necessary, the programmer can break out the ICW
bits and convert them to and/or from Boolean values in order to read or manipulate their status.
However, this is not recommended unless the programmer has a very good understanding of what
each ICW flag means, and how it affects the function blocks that it is connected to. It is important to
remember that ICWs are variables of the type DINT.

Above is an example of three function blocks connected together including their

ICWs. Note that this example does not show other connections that would be
necessary to make the function blocks work. It is only intended to demonstrate the
connection of the ICWs.

Figure 2. ICW Usage Example

NOTE: Although the ICW bits represent Boolean values TRUE and FALSE, they are stored as bits
in the ICW, which is a double integer value. The programmer must convert the values to
and/or from Boolean values using standard library functions in order to properly utilize
them outside of the library function blocks. Throughout this manual the value of the ICW
status bits is referred to as TRUE or FALSE. Wherever this is done, it may be safely
assumed that the Boolean value TRUE is equivalent to a numerical (binary) value of one
and FALSE is equivalent to a numerical (binary) value of zero within the ICW word.

February 3, 2005 Rev. 3

 ICWs 7

Description of ICW Bits

How an ICW Breaks Down Into Status Bits

Decimal Value: 345

MSB 101011001 LSB (Binary)

MSB 8 7 6 5 4 3 2 1 0 LSB

FTRACK SPARE ENAB POSRMP CTLSTAT TRACK LMT ALARM AM

Figure 3. ICW Status Bits

Thus, as seen in the above example, the FTRACK, ENAB, CTLSTAT, TRACK, and AM bits represent a
Boolean value of TRUE, while the INPFAIL, POSRMP, LMT (and SPARE) bits represent a Boolean
value of FALSE.

February 3, 2005 Rev. 3

 ICWs 8

ICW Status Bit Description

The descriptions in the table below are intended as a general guide to the function of each ICW bit.
To understand exactly how the status bits will make the various function blocks perform, it is
necessary to look at the function block description. This will enable the programmer to determine
exactly how each block will be affected by and how it will set or pass the ICWs for use by other
function blocks. The discussions of each ICW-enabled function block include a detailed description
of how it handles the input and output ICWs.

ICW Bit # Name Description

0 AM Auto/Manual – Used to send Auto/Manual Status of one function block
downstream (via output ICWs) to other function blocks. This bit is both set and
reset by the same function block, and is not passed on by the next function block.
1 ALARM Steam turbine variable at H or L limit; little bit of dead band added so that can be
viewed with WonderWare before reset.
2 LMT Limit – Sent upstream (via input ICWs) to inform function blocks that a limit has
been reached in a downstream function block. This bit is set by a downstream
block and reset (after being passed upstream if appropriate) by the next upstream
block.
3 TRACK Tracking – A downstream function block will set this bit to cause upstream
function blocks to track their outputs (if appropriate) instead of performing their
normal function. Many function blocks will set this bit in their input ICWs if they
are in a Tracking Mode that requires their inputs to be set to the value of their
output. This bit is set by a downstream block and reset (after being passed
upstream if appropriate) by the next upstream block.
4 CTLSTAT Control Status – This bit is sent upstream (via input ICWs) to inform function
blocks that all downstream function blocks are in Automatic Mode. Most function
blocks require that this bit be TRUE in their output ICW(s) for them to function
normally. This would cause the last ICW enabled function block to function
incorrectly, so each ICW enabled function block includes a Boolean input called
fLAST that will set this bit in its output ICW if fLAST is TRUE. Therefore, the last
function block in the ICW chain must have a constant block with a Boolean value
of TRUE attached to the fLAST input.
5 POSRMP Position Ramp – This bit is sent downstream by certain specialized function
blocks. It is used by certain ramping function blocks to cause a turbine’s valves to
ramp to the correct position when placed in automatic.
6 ENAB Enable – Used to send Enabled/Disabled status of a function block to downstream
function blocks. This bit will typically echo the value of the CI (Enable) input of a
function block. This bit is both set and reset by the same function block, and is not
passed on by the next function block.
7 SPARE Reserved
8 FTRACK Forward Tracking – Set by an upstream block in special cases where a function
block causes a step change in its output (because of a change of status such as
auto/manual). This bit is passed downstream to a VPID function block, and
prevents proportional kick in the VPID’s output when the input has undergone an
intentional step change. This bit is set to TRUE by an upstream function block and
reset to FALSE and passed on by the next downstream function block.

February 3, 2005 Rev. 3

 Revisions 9

Revision Discussion
Each library includes two files. The files are identified by the same filename with different three-
character extensions. The filename is a unique identifier for that library, with the last two characters
being a dash and the numeric revision number. An exception is that for the initial release, the two
revision characters are not included. Furthermore, the three characters preceding the revision number
indicate the version of Tristation for which the library will function. For example, the initial release
of the Common library for Tristation 3.1.2 is named CMN312. The first revision to this library will
be named CMN312-2, the next revision, CMN312-3, etc. The number suffix “-1” will not be used to
avoid confusion with the initial release.
The two-character revision number appended to the file name is not the same and is not to be
confused with the internal revision number that Tristation stores within the library files. The product
group will always create a new file with a new revision number (e.g. CMN312-3 is revision 3 of the
library CMN312) whenever a library revision is released; therefore, the internal Tristation version
number is not required to identify the content of the library file.

February 3, 2005 Rev. 3

 Appendix A Site License Agreement 10

APPENDIX A: INVENSYS SYSTEMS INC. / TRICONEX TMC LIBRARIES

SOFTWARE SITE LICENSE AGREEMENT

Invensys Systems Inc. (hereafter referred to as Invensys or Invensys/Triconex) hereby grants you a
non-exclusive license to use the enclosed Software subject to the terms and restrictions set forth in
this License Agreement (“Agreement”). In addition, the terms and restrictions set forth in this
Agreement also cover any and all firmware embedded in Invensys/Triconex hardware products.
Proprietary Rights of Invensys/Triconex
The Invensys and Triconex logos, product names, software manuals, documentation and other support
materials are either patented, copyrighted, trademarked, or owned by Invensys/Triconex as trade
secrets and/or proprietary information. You agree not to remove any product identification or notices
of such proprietary restrictions from Invensys products. Invensys retains exclusive ownership of the
Software Product, Invensys printed materials, and Invensys patents, copyrights and trademarks. The
Software Product and any modifications or extraction thereof constitute trade secrets and/or
proprietary information of Invensys and will be protected by you.
Restrictions on Use and Transfer
Pursuant to this Agreement, you may: (a) Use the Software on a computer or computers used in
conjunction with a single Invensys/Triconex control system.; (b) Copy the Software into any
computers for back-up purposes in support of your use of the Software for a single Invensys/Triconex
control system.
You may not transfer the Software Product electronically from one computer to another over a
network which is located at a site other than the site at which the Software Product was initially
operated. You may not distribute copies of the Software Product or documentation relating thereto to
others. Neither the Software Product nor its documentation may be modified or transferred without
written permission from Invensys/Triconex. You agree to take all reasonable actions required to
ensure that the Software Product is not used, transferred or copied except as expressly provided in this
agreement.
YOU MAY NOT USE, COPY, MODIFY OR TRANSFER THE SOFTWARE PRODUCT, OR ANY
COPY, MODIFICATION, OR MERGED PORTION, IN WHOLE OR IN PART, EXCEPT AS
EXPRESSLY PROVIDED FOR IN THIS AGREEMENT. IF YOU TRANSFER POSSESSION OF
ANY COPY, MODIFICATION, OR MERGED PORTION OF THE SOFTWARE PRODUCT TO
ANOTHER PARTY, OR TO A LOCATION OTHER THAN THE SITE AT WHICH THE
SOFTWARE PRODUCT WAS INITIALLY OPERATED, THIS LICENSE IS AUTOMATICALLY
TERMINATED. YOU MAY NOT MODIFY, TRANSLATE, REVERSE ENGINEER,
DECOMPILE, OR DISASSEMBLE THE SOFTWARE, OR ANY PORTION THEREOF.

License Fee
You agree to pay a fee for the License hereunder in accordance with Invensys/Triconex’s standard
Price List. Failure to pay this fee will result in termination of this Agreement.
Term
This license is effective until terminated. You may terminate it at any other time by returning or
providing evidence of destruction of the Software Product together with all copies, modifications and
merged portions in any form. It will also terminate upon conditions set forth elsewhere in this
Agreement or if you fail to comply with any term or condition of this agreement. You agree upon
such termination to return or provide evidence of destruction of the Software Product together with all
copies, modifications, and merged portions in any form. The provisions of this Agreement which
protect the proprietary rights of Invensys shall continue in force after termination.

February 3, 2005 Rev. 3

 Appendix A Site License Agreement 11

Limited Warranty and Remedies

Invensys warrants the storage medium on which the Software in furnished, to be free from defects in
materials and workmanship under normal use for a period of ninety (90) days from the date of
delivery to you evidenced by a copy of your receipt. This warranty is limited to you and is not
transferable.
During the 90-day warranty period, Invensys will replace any storage medium not meeting the
foregoing warranty and which is returned to Invensys. Your sole and exclusive remedy in the event
of a defect is expressly limited to replacement of the storage medium as provided above.
THE FOREGOING WARRANTY DOES NOT EXTEND TO A SOFTWARE PRODUCT WHICH
HAS FAILED AS A RESULT OF ACCIDENT, MISAPPLICATION, ABUSE, OR AS A RESULT
OF SERVICE OR MODIFICATION BY ANYONE OTHER THAN INVENSYS/TRICONEX.
THE SOFTWARE PRODUCT AND DOCUMENTATION ARE LICENSED “AS IS” EXCEPT AS
EXPRESSLY SET FORTH ABOVE. NO OTHER WARRANTIES, EITHER EXPRESSED OR
IMPLIED, ARE MADE WITH RESPECT TO THE SOFTWARE PRODUCT, INCLUDING BUT
NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE. INVENSYS EXPRESSLY DISCLAIMS ALL WARRANTIES NOT
STATED HEREIN. YOU ASSUME THE ENTIRE RISK AS TO THE RESULTS, QUALITY AND
PERFORMANCE OF THE SOFTWARE PRODUCT. SHOULD THE SOFTWARE PRODUCT
PROVE DEFECTIVE, YOU - AND NOT INVENSYS - ASSUME THE ENTIRE COST OF
NECESSARY SERVICING, REPAIR, OR CORRECTION UNLESS THE ASSUMPTION OF
SUCH COST CONFLICTS WITH STATE LAW. THIS WARRANTY GIVES YOU SPECIFIC
LEGAL RIGHTS, AND YOU MAY HAVE OTHER RIGHTS THAT VARY FROM STATE TO
STATE.

Limitation of Liability
NEITHER INVENSYS NOR ANYONE ELSE WHO HAS BEEN INVOLVED IN THE
CREATION, PRODUCTION, OR DELIVERY OF THIS SOFTWARE PRODUCT SHALL BE
LIABLE FOR ANY DIRECT INCIDENTAL OR CONSEQUENTIAL DAMAGES, SUCH AS BUT
NOT LIMITED TO LOSS OF ANTICIPATED PROFITS OR BENEFITS RESULTING FROM
THE USE OF THE SOFTWARE PRODUCT OR ARISING OUT OF ANY BREACH OF ANY
WARRANTY, UNLESS SUCH EXCLUSION IS IN CONFLICT WITH STATE LAW.

General
You may not sublicense, assign, or transfer the license or the Software Product except as expressly
provided in this Agreement. Any attempt to otherwise sublicense, assign, or transfer any of the
rights, duties, or obligations hereunder will make the license null and void.
If you have any questions concerning this Agreement, including warranty service, you should contact
Invensys Systems Inc., Triconex Product Line, 15345 Barranca Parkway, Irvine, CA 92618, or by
phone at 1-866-PHON-IPS (1-866-746-6477) or Worldwide 1-508-549-2424.
YOUR USE OF THE SOFTWARE PRODUCT ACKNOWLEDGES THAT YOU HAVE READ
THIS LICENSE AGREEMENT AND AGREE TO ITS TERMS. YOU FURTHER AGREE THAT
THIS LICENSE AGREEMENT IS THE COMPLETE AND EXCLUSIVE STATEMENT OF THE
AGREEMENT BETWEEN US AND SUPERCEDES ANY PROPOSAL OR PRIOR
AGREEMENT, ORAL OR WRITTEN, AND ANY OTHER COMMUNICATIONS RELATING TO
THE SUBJECT MATTER OF THIS AGREEMENT.

February 3, 2005 Rev. 3