0% found this document useful (0 votes)

133 views

GEI - Mark VIe Control Legacy Block Library

Uploaded by

testvsptest

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

133 views

GEI - Mark VIe Control Legacy Block Library

Uploaded by

testvsptest

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 81

GEI-100681K

Mark* VIe Controller

Legacy Block Library
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.
Public – This document is approved for public disclosure.
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.
GE provides the following document and the information included therein as is and without warranty of any kind,
expressed or implied, including but not limited to any implied statutory warranty of merchantability or fitness for
particular purpose.
For further assistance or technical information, contact the nearest GE Sales or Service Office, or an authorized GE Sales
Representative.

Revised: June 2017

Issued: June 2006

© 2006 – 2017 General Electric Company.

___________________________________
* Indicates a trademark of General Electric Company and/or its subsidiaries.
All other trademarks are the property of their respective owners.

We would appreciate your feedback about our documentation.

Please send comments or suggestions to [email protected]

For public disclosure

Document Updates
Revision Update Description
Changed the OUTXFER block Reason for No Replacement column content to reference the MOVE
K Replacement Blocks
block with similar functionality

J DALIP00 Updated with a better description of the FTBL input array

Updated Legacy Status to explain that these blocks are supported but not recommended for use in
any new controller applications. They are legacy because no new development is to be done to add
H Replacement Blocks any new functionality to these blocks. In many cases there is a newer block that is preferred for use
as a replacement for these blocks, as listed in the table. Updated this table to explain why there are
or are not replacement blocks.

Contents
Introduction......................................................................................................................................................3
Changing Variant Block Data Types ...................................................................................................................5
Replacement Blocks .......................................................................................................................................6
Analog to Word Conversion (ANA_TO_WD) .........................................................................................................8
Bit Counter (BIT_CNTR_UDI) ............................................................................................................................9
Boolean Filter (BFILT) ..................................................................................................................................... 10
Combine (COMBINE_SD)................................................................................................................................ 11
Combine (COMBINE_SR) ................................................................................................................................ 12
Compare with Hysteresis (COMPHYS) ............................................................................................................... 13
Count to Boolean (CNT_TO_BOOL) .................................................................................................................. 14
Counter (COUNTER)....................................................................................................................................... 15
Display State Generator for Unsigned Long (DPYSTAT1_UDI) ............................................................................... 16
Double Analog Linear Interpolation (DALIP00) .................................................................................................... 17
Exit Macro (EX_MAC) .................................................................................................................................... 18
Exit Task (EX_TSK) ........................................................................................................................................ 19
Input Conversion (IN_CVRT) ............................................................................................................................ 20
Mark VIe Monitor (MKVIE_MON) .................................................................................................................... 22
Output Conversion (OUT_CVRT)....................................................................................................................... 24
Output Transfer (OUTXFER)............................................................................................................................. 26
Override Station (OVR_ST)............................................................................................................................... 27
Permissive Toggle Action Engine (PE_Toggle)...................................................................................................... 37
PID (PID_MA) ............................................................................................................................................... 39
Preset Counter (PRESET_CNTR) ....................................................................................................................... 73
Ramp (RAMP)................................................................................................................................................ 74
Ramp with Hold (RAMPH) ............................................................................................................................... 76
Split (SPLIT_DS) ............................................................................................................................................ 78
Split (SPLIT_RS) ............................................................................................................................................ 79
Timer Unsigned Short (TIMER_UI) .................................................................................................................... 80
Word to Analog Conversion (WD_TO_ANA) ....................................................................................................... 81

2 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Introduction
Blocks are software subroutines that are included in the tasks to be run in the controller. Within the ToolboxST* application,
the connections are accomplished graphically using pins and wires to form a data flow diagram. The blocks run in the order
listed in the task. The connections between the blocks are RAM memory elements through which data is passed. These
elements are referred to as variables. Each variable has a defined data type and must be connected to pins of the same data
type. Some block pins accept multiple data types and others are capable of converting from one data type to another.
Each block entry in the library consists of the following:

• Block name and category

• Block description
• Block diagram
• Pin definitions
• Application notes (optional)
Each block has a full name and a simple name. The full name is descriptive and too long to display in a block diagram. For
this reason, all blocks have a simple name. The simple name is displayed in the ToolboxST application.
Floating point (REAL and LREAL) values conform to IEEE® 754. The standard defines certain computational exceptions that
may produce non-standard results, such as divide by zero. These non-standard values include infinities and Not a Numbers
(NaNs), which, if used in subsequent calculations, produce additional non-standard results. The software has been designed to
prevent the production and proliferation of such values. Function block descriptions may include additional details concerning
floating point exception handling where needed.
Block Libraries also contain rubber blocks, which are sized according to the number of pins used. Within the library, the
blocks are grouped functionally to simplify the task of converting ideas into blocks. For example, the Controller Monitor
(CTRLR_MON) block is a member of the System category.

Note Pin names are given modifiers that provide additional information about the pin.

A graphical representation of the software for each block is provided in the form of a block diagram that includes the simple
block name and block configuration pins and variable pins, which transfer data in and out of the block. The pins are located
on the block diagram according to their usage. All input pins (pins read by the block) and block configuration pins are listed
on the left. All output pins (pins written by the block) and state pins (pins read and written by the block) are listed on the
right. The pin name is listed beside each pin inside the block diagram border.

Pin Name Modifiers Description

^ prefixed with a carat (^ONREQ) Pin is rising-edge sensitive
Pin expects a variable that is an array of the size indicated
[ ] suffixed with square brackets (STATE[4])
within the brackets

Instruction Guide GEI-100681K 3

For public disclosure
Block Data Type

Note The Block Data Type is set in the block Property Editor.

The pin data type identifier is listed beside the pin outside of the block diagram border. The basic data types used in the block
libraries are BOOL, INT, UINT, REAL, LREAL, DINT and UDINT. Blocks with data types ANY_NUM and ANY must have
the Block Data Type set to match the intended data type of the block output.

Note The default value of Boolean inputs is False unless the input is a block Enable, in which case the default is True and
the default value of inputs with data types INT, UINT, DINT, UDINT, REAL and LREAL is 0, until otherwise specified.

The block content provides tables to define the input and output pins. Each entry includes the block name for the variable,
basic data type, typical scaling units, and a description of the variable. Typical scaling units are supplied for reference only;
specific applications may use other scaling units as appropriate.

Data Type Identifier Basic Data Type Description

A Any (ANY) Any data type
B Boolean (BOOL) 8-bit Boolean
I Integer (INT) 16-bit Signed Integer
DI Double Integer (DINT) 32-bit (Long) Signed Integer
R Real (REAL) 32-bit Floating Point
LR Long Real (LREAL) 64-bit (Long) Floating Point
UI Unsigned Integer (UINT) 16-bit Unsigned Integer
UDI Unsigned Double Integer (UDINT) 32-bit (Long) Unsigned Integer
N Numeric (ANY_NUM) Any data type except Boolean
S Analog or Boolean (Simple) Any simple data type

Data Type Identifier Type Definition Modifier Description

# m Build time constant

4 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Changing Variant Block Data Types
There are few blocks that support more than one data type as an input and/or output.

➢ To change the block data type

1. Select the block for which to change the data type.
2. From the Block Properties window, expand the General section.
3. From the Property Editor, select the Block Data Type.
4. From the Block Data Type drop-down box, select a valid data type for the block.

From the Block Data Type

drop down list , select a valid
data type for the block.

Instruction Guide GEI-100681K 5

For public disclosure
Replacement Blocks
These blocks are supported but not recommended for use in any new controller applications (ControlST V05.02 or later).
They are legacy because no new development is to be done to add any new functionality to these blocks. In many cases there
is a newer block that is preferred for use as a replacement for these blocks, as listed in the following table.

Legacy Block Rationale

Replacement
Legacy Block Description Reason for No Replacement
Block

This block was intended to process special I/O

ANA_TO_WD None Real, Double, Long, etc. to 16-bit integer
types. I/O packs perform this function if needed.

BFILT ON_OFF_DELAY Boolean Filter, On and Off Delays

Counts the number of input booleans that

BIT_CNTR_UDI BIT_CNTR are True, Outputs unsigned double
integer

Unsigned integer input decoded to one of

CNT_TO_BOOL None
32 booleans

Concatenates two unsigned integers to This block was intended to process special I/O
COMBINE_SD None
make an unsigned double integer types. I/O packs perform this function if needed.

Concatenates two unsigned integers to

COMBINE_SR None
make a real

COMPHYS COMPARE Compare with hysteresis

The CTU (Count Up) and CTD (Count Down)

COUNTER None Count UP to a maximum and set at count blocks perform this function but can only preset
to 0.

DALIP00 None Double analog linear interpolation INTERP_DL performs a similar function.

Display State Generator, input # of 1st

DPYSTAT1_UDI DPYSTAT1 True boolean is unsigned double integer
out

EX_MAC None Exit macro It exists (for upgrades only) in the Mark VIe
controller. The block cannot be added from the
ToolboxST application after V03.06.09C. The
EX_TSK None Exit task
functionality is provided by Enable pins.

Convert coded (BCD,GRAY,BINARY) This block was intended to process special I/O
IN_CVRT None
decimal booleans to a long integer types. I/O packs perform this function if needed.

Mark VIe Monitor, power_up, sig_forced,

MKVIE_MON CTRLR_MON
overtemp. More in Controller Monitor.

Convert coded (BCD,GRAY,BINARY) This block was intended to process special I/O
OUT_CVRT None
long integer into booleans types. I/O packs perform this function if needed.

Moves a value into an input point of this

OUTXFER None MOVE block performs a similar function.
controller for simulation

6 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Legacy Block Rationale (continued)

Replacement
Legacy Block Description Reason for No Replacement
Block

Override Station for DCS/BOP PID

OVR_ST OVR_ST_ENH_V2
controllers. Enhanced controller up to 3.

Used only for Exciter upgrade efficiency. Not

PE_TOGGLE None Permissive Engine toggle action
planned for future.

Operator station for PID control for

PID_MA PID_MA_ENH_V2
DCS/BOP

The CTU (Count Up) and CTD (Count Down)

Counts input pulses with ability to preset
PRESET_CNTR None blocks perform this function but can only preset
the current count
to 0.

RAMP FUNGEN Ramp Up/Down to a final value

Ramp Up/Down to a final value with Hold

RAMPH FUNGEN
feature

Split one unsigned double integer into two This block was intended to process special I/O
SPLIT_DS None
unsigned integers types. I/O packs perform this function if needed.

Convert one real input into two unsigned This block was intended to process special I/O
SPLIT_RS None
integers types. I/O packs perform this function if needed.

TIMER_UI TIMER Timer unsigned short

Converts up to 32 unsigned integer inputs This block was intended to process special I/O
WD_TO_ANA None
to analog type outputs types. I/O packs perform this function if needed.

Instruction Guide GEI-100681K 7

For public disclosure
Analog to Word Conversion (ANA_TO_WD)
Block Category: ANA_TO_WD, Type Conversion
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Analog to Word Conversion (ANA_TO_WD) block is a rubber block that transfers the values on 1 to 32 input pins to
corresponding output pins. The inputs are analog data types and the outputs are unsigned integer types. Long Real, Real,
Double Integer, Integer input values are clamped to 65535 and 0 (if negative). Integer and unsigned integer inputs are
transferred without modification.

ANA_TO_WD Block

Inputs
Name Data Type Description
ENABLE Boolean Enables block execution
IN1 Numeric Analog input value1
↓ ↓ ↓
IN32 Numeric Analog input value2

Outputs
Name Data Type Description
OUT1 Unsigned integer Converted output variable
↓ ↓ ↓
OUT32 Unsigned integer Converted output variable

8 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Bit Counter (BIT_CNTR_UDI)
Block Category: BIT_CNTR_UDI, Legacy BIT_CNTR
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Bit Counter (BIT_CNTR_UDI) block is a rubber block that counts the number of input bits that are currently set to True.
The block can handle from 1 to 32 input Boolean signals. The resulting count is in placed in the Unsigned Double Integer
COUNT.

BIT_CNTR_UDI Block

Inputs
Name Data Type Description
IN1 Boolean Boolean signal 1
↓ ↓ ↓
IN32 Boolean Boolean signal 32

Output
Name Data Type Description
OUT Unsigned Double Integer Number of Boolean bits set to True

Instruction Guide GEI-100681K 9

For public disclosure
Boolean Filter (BFILT)
Block Category: BFILT, Boolean Operations
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Boolean Filter (BFILT) block passes a rising True value on the IN pin to the OUT pin if IN remains True for PU_DEL
time (in milliseconds). The block passes a falling False value on the IN pin to the OUT pin if IN remains False for DO_DEL
time (in milliseconds).

BFILT Block

Inputs
Name Data Type Description
PU_DEL Unsigned Double Integer Pick-up delay in milliseconds
IN Boolean Identifies the variable to filter
DO_DEL Unsigned Double Integer Drop-out delay in milliseconds

Output
Name Data Type Description
OUT Boolean The filtered output

State
Name Data Type Description
PREVOUT Boolean This is the last filtered output, a hidden pin, It can be viewed or
changed by right-clicking the block and selecting Edit Block Pins.
Writing to this variable is not recommended, but can be used to
preset block states.

10 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Combine (COMBINE_SD)
Block Category: COMBINE_SD, Type Conversion
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Combine (COMBINE_SD) block concatenates smaller variables into larger variables by forming an Unsigned Double
Integer variable from two unsigned integers. The merging of the signals is strictly mechanical, meaning there is no attempt to
interpret the data or perform any clamping, scaling, data type conversion, or sign extension.

COMBINE_SD Block

Inputs
Name Data Type Description
ENABLE Boolean Block enable - Default is True
HIWORD Unsigned Integer The high order 16 bits of data to be concatenated

LOWORD Unsigned Integer The low order 16 bits of data to be concatenated

Output
Name Data Type Description
OUTPUT Unsigned Double Integer The combined unsigned double integer output

Instruction Guide GEI-100681K 11

For public disclosure
Combine (COMBINE_SR)
Block Category: COMBINE_SR, Type Conversion
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Combine (COMBINE_SR) block concatenates smaller variables into larger variables byforming a Real variable from two
unsigned integers. The merging of the signals is strictly mechanical, meaning there is no attempt to interpret the data or
perform any clamping, scaling, data type conversion, or sign extension.
Floating Point Exception Handling
The COMBINE_SR block does not allow a NAN to pass through it. If the given inputs combine to form a NAN, the output is
replaced with either the most positive or most negative number, based on the sign of the NAN.

COMBINE_SR Block

Inputs
Name Data Type Description
ENABLE Boolean Block enable - Default is True
HIWORD Unsigned Integer The high order 16 bits of data to be concatenated

LOWORD Unsigned Integer The low order 16 bits of data to be concatenated

Output
Name Data Type Description
OUTPUT Real The combined real output

12 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Compare with Hysteresis (COMPHYS)
Block Category: COMPHYS, Comparison
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Compare with Hysteresis (COMPHYS) block compares two floating point values and sets an output Boolean reflecting
the result. Hysteresis. Sensitivity settings are provided to prevent toggling around a boundary condition. The supported
functions include: greater than (gt), greater than or equal to (ge), equal to (eq), less than (lt), or less than or equal to (le).
Sensitivity refers to the thickness of the equality relationship. That is, IN1 is equal to IN2 if it is numerically within the band
defined by IN2 ± SENS. Hysteresis applies for all relationships. Once any relationship evaluates to True it must exceed the
normal specification by the HYST amount before it evaluates to False.
Floating Point Exception Handling
If a NaN is present on an input pin, the COMPHYS block replaces it internally with the most positive or most negative
representable number based on its sign, for the purpose of the comparison.

Note This block is a variant block that supports the following block data types: Real and Long Real. To modify the data
type, refer to the section, Changing Variant Block Data Types.

COMPHYS Block

Inputs
Name Data Type Description
IN1 REAL, LREAL The input to compare
FUNC Constant CompFnL_T The comparison function (gt, lt, ge, le, eq). The default value is gt.
IN2 REAL, LREAL The value to compare against
HYST REAL, LREAL The hysteresis value
SENS REAL, LREAL The sensitivity value

Output
Name Data Type Description

OUT BOOL The result of the comparison

Instruction Guide GEI-100681K 13

For public disclosure
Count to Boolean (CNT_TO_BOOL)
Block Category: CNT_TO_BOOL, Boolean Operations
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Count to Boolean (CNT_TO_BOOL) block uses the value of an integer input, IN, to select one of N Boolean outputs. It
is a rubber that provides up to 32 outputs. The selected output is driven True while all others are driven False. An input value
of 0 for IN selects the first output and an input value of N-1 selects the last output, OUT (N). If the integer input contains a
value that is not within the range of 0 to N-1 then all outputs are driven False.

CNT_TO_BOOL Block

Input
Name Data Type Description
IN Unsigned Integer Selects a particular output Boolean

Outputs
Name Data Type Description
OUT1 Boolean Contains the results of the selection process
↓ ↓ ↓

OUT32 Boolean Contains the results of the selection process

14 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Counter (COUNTER)
Block Category: COUNTER, Timers and Counters
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Counter (COUNTER) block accumulates rising edges of the INC pin into CUR_CNT while the RUN is True and CUR_
CNT is less than MAX_CNT. When CUR_CNT is equal to MAX_CNT, AT_CNT transitions to True. If RUN is False then
counting is suspended, but CUR_CNT holds its value. If RESET is True then CUR_CNT is set to zero and counting is
suspended. If MAX_CNT is less than one, each rising edge of INC sets AT_CNT True and increments CUR_CNT.

COUNTER Block

Inputs
Name Data Type Description
INC Boolean Triggers another count on its rising edge
MAX_CNT Double Integer The maximum count value
RESET Boolean Zeros the counter
RUN Boolean Enables the counter

Outputs
Name Data Type Description
AT_CNT Boolean Indicates the counter has reached the maximum count value
CUR_CNT Double Integer The current count value (always ≤ MAX_CNT)

States
Name Data Type Description
LAST_CURCNT† Double Integer This is the variable that holds the current count. It is a hidden pin that
can be viewed or changed by right-clicking the block and selecting Edit
Block Pins. Writing to this variable is not recommended, but can be
used to preset block states.
LAST_ATCNT Boolean This is the variable that holds the state, indicating the counter has
reached the maximum count value. This is a hidden pin. It can be
viewed or changed by right-clicking the block and selecting Edit Block
Pins. Writing to this variable is not recommended, but can be used to
preset block states.
† Connect the LAST_CURCNT state variable to a NOVRAM variable to retain the counter value through a reboot.

Instruction Guide GEI-100681K 15

For public disclosure
Display State Generator for Unsigned Long (DPYSTAT1_
UDI)
Block Category: DPYSTAT1_UDI, Legacy
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Display State Generator for Unsigned Long (DPYSTAT1_UDI) block is a rubber block that generates an enumerated
state variable by interrogating a list of logic variables and setting the enumerated state value to the number of the first True
logic entry. It supports up to 32 inputs

DPYSTAT1_UDI Block

Inputs
Name Data Type Description
INPUT1 Boolean Input Logical 1
↓ ↓ ↓

INPUT32 Boolean Input Logical 32

Output
Name Data Type Description
OUTPUT Unsigned Double Integer Integer Output Value

16 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Double Analog Linear Interpolation (DALIP00)
Block Category: DALIP00, Legacy
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Double Analog Linear Interpolation (DALIP00) block estimates a missing functional value f (x,y) from four known
functional values at neighboring points (f(X0,Y0), f(X0,Y1), f(X1,Y0), f(X1, Y1), provided X0 < x < X1 and Y0 < Y1 as
follows. Expansion checks are done to ensure that the declared size of the function array (f) is equal to the size of the input
array (x) times the size of the input array (y).

DALIP00 Block

Instruction Guide GEI-100681K 17

For public disclosure
Inputs
Name Data Type Description

X Real Input X
Y Real Input Y
XTBL Real Beginning address of X table
YTBL Real Beginning address of Y table
FTBL Real Beginning address of F table
FTBL[0] = f(XTBL[0], YTBL[0]), FTBL[1] = f(XTBL[0], YTBL[1]), FTBL[2] = f(XTBL[0], YTBL[2], …, FTBL
[nYTBL – 1] = f(XTBL[0], YTBL[nYTBL – 1], FTBL[nYTBL] = f(XTBL[1], YTBL[0], …, where nYTBL = the
number of elements in YTBL.
FMIN Real Minimum function table value
FMAX Real Maximum function table value

Output
Name Data Type Description
F Real Function output

Exit Macro (EX_MAC)

Block Category: EX_MAC, Program Control
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information. The block cannot be added from the ToolboxST
application after V03.06.09C. The functionality is provided by Enable pins.
When the Exit Macro (EX_MAC) block is enabled, the user block containing this block will exit immediately, skipping
execution of rest of the blocks. This can be used as a break statement in a user block.

EX_MAC Block

Input
Name Data Type Description
ENABLE Boolean Enable the block to exit.

18 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Exit Task (EX_TSK)
Block Category: EX_TSK, Program Control
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information. The block cannot be added from the ToolboxST
application after V03.06.09C. The functionality is provided by Enable pins.
When the Exit Task (EX_TSK) block is enabled, the task containing this block will exit immediately, skipping execution of
the remaining blocks. This can be used as a break statement in a task.

EX_TSK Block

Input
Name Data Type Description
ENABLE Boolean Enable the block to exit.

Instruction Guide GEI-100681K 19

For public disclosure
Input Conversion (IN_CVRT)
Block Category: IN_CVRT, Type Conversion
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Input Conversion (IN_CVRT) block converts Boolean inputs into a long integer based on a conversion function. This
rubber block supports up to 32 inputs and may be specified in groups of four. If the inputs contain an invalid value, the error
pin will be set to True and the last valid conversion will remain on the output pin. Binary Coded Decimal (BCD), BINARY,
and GRAY coded Booleans are decoded with this block.

IN_CVRT Block

20 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Inputs
Name Data Type Description
ENABLE Boolean Enable block execution
FCN Constant InOutCvrt_T Conversion to perform. The default value is BCD.
SIGN Boolean Sign - The sign of the Coded value (False = positive, True = negative). The
default value is False.
IN11 Boolean The first (lsb) input Boolean in the first set of four Booleans
IN12 Boolean The second input Boolean in the first set of four Booleans
IN13 Boolean The third input Boolean in the first set of four Booleans
IN14 Boolean The fourth (msb) input Boolean in the first set of four Booleans
↓ ↓ ↓
IN81 Boolean The first (lsb) input Boolean in the eighth set of four Booleans
IN82 Boolean The second input Boolean in the eighth set of four Booleans
IN83 Boolean The third input Boolean in the eighth set of four Booleans
IN84 Boolean The fourth (msb) input Boolean in the eighth set of four Booleans

Outputs
Name Data Type Description
ERR Boolean True if an invalid coding is detected or if unknown conversion is output
OUT Double Integer The numerical value of the coded Booleans

Instruction Guide GEI-100681K 21

For public disclosure
Mark VIe Monitor (MKVIE_MON)
Block Category: MKVIE_MON, System

Legacy Status — this block is not recommended for use in any new controller
applications (ControlST V05.02 or later). Refer to the section Replacement Blocks
for additional information.

Only one MKVIE_MON block can be used per controller.

The Mark VIe Monitor (MKVIE_MON) block is used for various purposes. The
block has a POWER_UP output that transitions to True 5 sec after the controller is
in control mode. SIG_FORCED turns on if there are any forced variables in the
controller, SIG_FORCED is set to False for 2 sec every time the number of forced
variables are increased. SIG_FORCED_NUM indicates the number of forced
variables in the controller.

Note In the Virtual Controller, the OVERTEMP_R, OVERTEMP_S and OVERTEMP_T are all False because there is no
temperature measurement functionality.

The block detects the current controller configuration (Simplex, Dual, or TMR). According to this configuration, over
temperature alarms OVERTEMP_R, OVERTEMP_S, OVERTEMP_T and controller online variables ONLINE_R, ONLINE_
S, and ONLINE_T are generated for R, S and T respectively. The input ONLINE_FL_T is used to delay the controller online
variables change from True to False in the event the controller heartbeat stops. MKVIE_MON creates global variables that
can be used throughout the controller application software.

Inputs
Name Description Type Initial Value Visibility Usage Interface Type
ONLINE_FL_T Online Fail Time UDINT 5000 Parameter Input Value only

Outputs
Name Description Type Initial Value Visibility Usage Interface
Type
POWER_UP Controller BOOL 0 Always Output Value Only
Powered Up
SIG_FORCED Signal Forced In BOOL False Always Output Value Only
Controller
SIG_FORCED_ Number of Forced INT 0 Always Output Value Only
NUM Signals
OVERTEMP_R R Controller Over BOOL False Always Output Value Only
Temperature
OVERTEMP_S † S Controller Over BOOL False Always Output Value Only
Temperature
OVERTEMP_T †† T Controller Over BOOL False Always Output Value Only
Temperature
† Exists only when the controller’s redundancy is DUAL or TMR.
†† Exists only when the controller’s redundancy is TMR.

Global Variables
Global Pin Name Description Alarm Alarm Event EGD External
Class Page Access
POWER_UP Controller Powered Up Not Alarmed False Read Only
SIG_FORCED Signal Forced In Controller Alarmed Diag False Read Only

22 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Global Variables (continued)
Global Pin Name Description Alarm Alarm Event EGD External
Class Page Access
SIG_FORCED_NUM Number of Forced Signals Not Alarmed False Read Only
OVERTEMP_R R Controller Over Temperature Alarmed Diag False $Default Read Only
OVERTEMP_S† S Controller Over Temperature Alarmed Diag False $Default Read Only
OVERTEMP_T †† T Controller Over Temperature Alarmed Diag False $Default Read Only
† Exists only when the controller’s redundancy is DUAL or TMR.
†† Exists only when the controller’s redundancy is TMR.

Instruction Guide GEI-100681K 23

For public disclosure
Output Conversion (OUT_CVRT)
Block Category: OUT_CVRT, Type Conversion
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Output Conversion (OUT_CVRT) block converts a Long Integer into coded booleans. Binary Coded Decimal (BCD),
BINARY, and GRAY coded booleans are decoded by this block. This rubber block supports up to 32 outputs in groups of
four. If the input cannot be represented by the specified number of booleans the nearest representable encoding will be
generated and the ERR pin is set True.

OUT_CVRT) Block

Inputs
Name Data Type Description

ENABLE Boolean Enable block execution

FCN Constant InOutCvrt_T Conversion to perform
IN Double Integer The numerical value to be encoded

24 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Outputs
Name Data Type Description
SIGN Boolean The sign of the coded decimal value (False = positive, True = negative). The
default value is False
ERR Boolean True if the number cannot be exactly represented, otherwise False
OUT11 Boolean The first (lsb) output boolean in the first set of four booleans
OUT12 Boolean The second output boolean in the first set of four booleans
OUT13 Boolean The third output boolean in the first set of four booleans
OUT14 Boolean The fourth (msb) output boolean in the first set of four booleans
↓ ↓ ↓
OUT81 Boolean The first (lsb) output boolean in the eighth set of four booleans
OUT82 Boolean The second output boolean in the eighth set of four booleans
OUT83 Boolean The third output boolean in the eighth set of four booleans
OUT84 Boolean The fourth (msb) output boolean in the eighth set of four booleans

Instruction Guide GEI-100681K 25

For public disclosure
Output Transfer (OUTXFER)
Block Category: OUTXFER, Legacy
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Output Transfer (OUTXFER) block conditionally transfers data from a local variable into an input point owned by the
device.

OUTXFER Block

Inputs
Name Data Type Description
SRCVAR Simple Input variable to be transferred
ENABLE Boolean Block enable pin

Output
Name Data Type Description
DESTVAR Simple Output value

26 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Override Station (OVR_ST)
Block Category: OVR_ST, Controls (DCS)
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.

Note This block is transparent to the HMI operator.

The Override Station (OVR_ST) block controls the output function of PID controllers used in an override control scheme. It
takes inputs from two PID controllers and sets and produces CVO as a control variable output. CVO is determined by the
selection type and/or value of control variable inputs in automatic mode and by the HMI operator in manual mode. Automatic
and manual modes are superseded by override, priority, and inhibit commands with overrides having the highest priority, then
priority commands, followed by inhibit commands. The value of CVO cannot exceed the user specified limits of high (H) and
low (L).
ToolboxST Configuration
OBQ is True when either AO_BQ is True, status of CVI1 is in the BAD range, or status of CVI2 is in the BAD range.

This block propagates quality status. Status option cannot be disabled on this block.

CVO status is based upon the following in order of priority:

• When OBQ is True, the quality status of CVO is NOT_LIMITED-BAD [0]

• The default quality status of CVO is NOT_LIMITED-GOODC, 192.
• These values are modified by US (add 1) and LS (add 2)
For further details on Relational blocks, refer to GEI-100682, Mark VIe Controller Standard Block Library, the section,
Status Monitoring (STATUS_MONITORING).

Modes of Operation (MODE_OPT) enumerations control the mode of operation of the OVR_ST block when it is in auto
mode.
MODE_OPT Enumerations
Name Description
SELECT Application code select
MIN Minimum
MAX Maximum

SELECT mode — CVI1 or CVI2 inputs are selected by user-defined logic using SEL1 and SEL2. If CVI1 is selected,
NSEL2 becomes True, and if CVI2 is selected, NSEL1 becomes True. If SEL1 and SEL2 are both False or both True, then
the value of CVI1 is written to CVO, NSEL2 becomes True, and NSEL1 becomes False.
MIN mode — the minimum value of CVI1 and CVI2 is written to CVO. If CVI1 is selected, NSEL2 becomes True, and if
CVI2 is selected, NSEL1 becomes True. If CVI1 and CVI2 are equal, then the value of CVI1 is written to CVO, NSEL2
becomes True, and NSEL1 becomes False.
MAX mode — the maximum value of CVI1 and CVI2 is written to CVO. If CVI1 is selected, NSEL2 becomes True, and if
CVI2 is selected, NSEL1 becomes True. If CVI1 and CVI2 are equal, the value of CVI1 is written to CVO, NSEL2 becomes
True, and NSEL1 becomes False.

Instruction Guide GEI-100681K 27

For public disclosure
Block Options (BLOCK_OPT) enumerations select the options of the OVR_ST block.

BLOCK_OPT Enumerations
Name Description
NONE None
LOCK Lock mode
POS Position feedback
LOCK-POS Lock mode and position feedback

NONE — the valve operates normally by the HMI operator. The options to not effect the normal operation of the block.

Note The lockout indication is provided for indication only. This action will not lockout the equipment, it will only indicate
lockout status. The Owner's lockout procedures must be followed to safely lock equipment out.

LOCK — provides software lock-out capability for the valve. Selecting the LOCK mode property will set LOCK_P to True,
and enable the LOCK_PB and UNLOCK_PB to control the lockout mode functionality. The valve output CVO must be equal
to LOCK_SC (safe condition) before the block can be set to lockout mode. Feedback to the HMI operator of this mode is
provided by LOCK. The HMI operator is prevented from energizing the solenoid operated valve from the control faceplate
when LOCK is True, and auto mode is disabled.

Note The Lock button can also be set up to use the WorkStationST Lock function. Refer to GEI-100697,
WorkstationST/CIMPLICITY Advanced Viewer Integration, the section, HMI Tagout.

POS — select for valves that provide an analog position feedback, which is used by the HMI objects and faceplates to display
the valve open percentage. When the POS enumeration is selected, the output POSFB_P is True.
Override Control
The block provides an override input enumeration, CMD_OVR and a manual reject input enumeration, MJ. When CMD_
OVR indicates Override Active, the value of CVO will be the value assigned to the OV input. The OVR_ST is rejected to
manual when either CMD_OVR or MJ indicate Override Active and the manual reject alarm, MN_REJ_A, will be activated
(delayed by 2 sec).
CMD_OVR and MJ (if used) are driven from an OVERRIDE block. Each connected input of the OVERRIDE block has the
ability (when enabled) to be blocked by the HMI operator, which is accessed from associated tab of the permit HMI screen
display. When CMD_OVR or MJ enumeration contains BLOCK, the HMI operator has blocked at least one override. OVR_
ST does not use the block information, but passes it to the HMI for display. The possible enumerations values are provided in
the following table.

Manual Reject and Command Override (MJ and CMD_OVR) Enumeration

Enumeration Override Option Description
NO_OVR-NO-BLOCK No override and no override is blocked
OVR-NO_BLOCK Override active and no override is blocked
NO_OVR-BLOCK No override and a override is blocked
OVR-BLOCK Override active and a override is blocked

Force Control
The block provides a force enumeration force command input, CMD_FRC. When CMD_FRC indicates Force Active, the
value of CVO will be the value assigned to the FV input except when CMD_OVR indicate Override Active. The OVR_ST
does not reject to manual if a force occurs. CMD_FRC (if used) is driven from a FORCE block. Each connected input of the
FORCE block has the ability (when enabled) to be blocked by the HMI operator, which is accessed from associated tab of the
permit HMI screen display. When CMD_FRC enumeration contains BLOCK, the HMI operator has blocked at least one
force. OVR_ST does not use the block information, but passes it to the HMI for display. The enumeration has the possible
values provided in the following table.

28 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Command Force (CMD_FRC) Enumeration
Enumeration Force Option Description
NO_FORCE-NO-BLOCK No force and no force is blocked
FORCE-NO_BLOCK Force active and no force is blocked
NO_FORCE-BLOCK No force and a force is blocked
FORCE-BLOCK Force active and a force is blocked

OVERRIDE, PRIORITY and INHIBIT Commands

When OVR is True, CVO is set to the value of OV. The output will be equal to OV as long as OVR is True. When priority
raise PR_INC or priority lower PR_DEC signal is True, CVO goes toward H or L value at a rate set by PR_INC_RT and PR_
DEC_RT inputs as long as the priority signal is True. In addition, the block also provides inhibit function using INH_INC and
INH_DEC inputs. When either of these inputs is True, they restrict any increase or decrease of CVO. Upon the reset of the
override, priority, and inhibit commands, the selected CVI input will be transferred to CVO at a rate defined by MR, provided
the block is in auto mode. In manual mode, when they reset CVO remains at last value.
Alarms
When OBQ, CVI1_BQ, CVI2_BQ, OVR_CMD, LOCK, or MJ becomes True and AUTO is True, the manual reject alarm
MN_REJ_A is activated for two seconds and the block reverts to manual mode.
When position feedback is used (the POS mode option selected – refer to the section, BLOCK_OPT Enumerations), an alarm,
POS_DH, is generated for deviations between the position feedback (signal attached to POS input pin) and the controller
output CVO. Use the parameters POS_DH_SP to enter the maximum acceptable deviation and POS_DH_T to set a delay time
before generating an alarm. Note that if POS_DH_T is set to 0, no alarm will be generated. Also, the alarm POS_BQ is
generated when the position feedback has bad status. Note that POS_BQ and POS_DH will only be generated if POSFB_P is
True.

Track
The track command TK is True when a priority command, override, inhibiting condition, output bad quality, or manual mode
occurs. This output is used on all PIDs connected to the OVR_ST block as a track input.

Tuning Mode

Note For tuning interface details, refer to the section, PID (PID_MA).

When the PID_MA blocks are configured with OVR_ST, the user should connect TUN_OUT of PID_MA1 and PID_MA2 to
TUN1 and TUN2 of OVR_ST, respectively. It forces the OVR_ST to select the corresponding PID_MA/CVI input while it is
in tuning mode.

Instruction Guide GEI-100681K 29

For public disclosure
ToolboxST Configuration
Inserting a OVR_ST block into the application code, for example, displays the following window.

Default Attribute Values

When the user clicks OK, the block and pin connections are configured automatically and generates global pins. For this
example, the pin names are in the form Device Value.Input_Name, where Device Value is the attribute value 00OVR_ST1000
and Input_Name is the block input/output names.

Note The description (OVR_ST Description in this example) becomes the prefix of the block input/output descriptions.

OVR_ST Block

30 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
The OVR_ST block is connected to the PID_MA block in an external reset override scheme. The outputs of the PID_MA
blocks are connected to the inputs CVI1 and CVI2 of the OVR_ST block. The output of the OVR_ST block connects to the
PID_MA input EV. NSEL1 and NSEL2 are connected to the ER inputs of the PID_MA blocks.

OVR_ST and PID_MA Reset-if Not Selected Configuration

Instruction Guide GEI-100681K 31

For public disclosure
The OVR_ST block is connected to the PID_MA block for a track override scheme. The outputs of the PID_MA blocks,
CVO, are connected to the inputs CVI1 and CVI2 of the OVR_ST block. CVO of the OVR_ST block connects to the PID_
MA input TV and NSEL1, NSEL2 and TK of the OVR_ST block connects to the TK inputs of the PID_MA blocks.

OVR_ST and PID_MA Track-if Not Selected Configuration

32 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Inputs
Name Description Data Type Initial Value Visibility Interface Type
AO_BQ OUTPUT BAD QUALITY BOOL False Always Value Only
AU_SEL AUTO MODE SELECT BOOL False Always Value Only
BLOCK_OPT BLOCK OPTIONS UINT (ENUM) NONE Always Value Only
CMD_FRC FORCE COMMAND UINT (ENUM) NO_FORCE- Always Value Only
NO_BLOCK
CMD_OVR OVERRIDE COMMAND UINT (ENUM) NO_OVR- Always Value Only
NO_BLOCK
CVI1 CONTROL VARIABLE INPUT 1 REAL 0 Always Value with Status
CVI2 CONTROL VARIABLE INPUT 2 REAL 0 Always Value with Status
FV FORCE VALUE REAL 0 Always Value Only
H {Desc} OUTPUT UPR LIMIT REAL 100 Parameter Value Only
INH_DEC {Desc} INHIBIT DEC BOOL False Always Value Only
INH_INC {Desc} INHIBIT INC BOOL False Always Value Only
L {Desc} OUTPUT LWR LIMIT REAL 0 Parameter Value Only
LOCK_PB {Desc} LOCK PUSHBUTTON BOOL False Always Value Only
LOCK_SC {Desc} LOCK SAFE CONDITION REAL 0 Parameter Value Only
MC {Desc} MANUAL SETPOINT REAL 0 Always Value Only
MJ MANUAL REJECT UINT (ENUM) NO_OVR- Always Value Only
NO_BLOCK
MODE_OPT MODE SELECTION INPUT UINT (ENUM) SELECT Always Value Only
MR MANUAL ADJUSTMENT RATE REAL 10 Parameter Value Only
MS {Desc} MANUAL MODE BOOL False Always Value Only
OV OVERRIDE VALUE REAL 0 Always Value Only
POS {Desc} POSITION FDBK REAL 0 Always Value with Status
POS_DH_SP {Desc} POSITION DEV HI SP REAL 10 Parameter Value Only
POS_DH_T {Desc} POSITION DEV HI DELAYREAL UDINT 5000 Parameter Value Only
PR_DEC {Desc} PRIORITY DEC BOOL False Always Value Only
PR_DEC_RT PRIORITY DEC RATE REAL 1 Parameter Value Only
PR_INC {Desc} PRIORITY INC BOOL False Always Value Only
PR_INC_RT PRIORITY INC RATE REAL 1 Parameter Value Only
SEL1 SELECT CVI1 IN SELECTION MODE BOOL False Always Value Only
SEL2 SELECT CVI2 IN SELECTION MODE BOOL False Always Value Only
TUN1 {Desc} PID 1 TUNING MODE BOOL False Always Value Only
TUN2 {Desc} PID 2 TUNING MODE BOOL False Always Value Only
UNLOCK_PB {Desc} UNLOCK PUSHBUTTON BOOL False Internal Value Only

Instruction Guide GEI-100681K 33

Global Pins
Global Pin Name Description Alarm Alarm Event EGD Page External
Class Access
00OVR_ST1000 OVR_ST Description Not Alarmed False $Default ReadOnly
00OVR_ST1000.AUTO OVR_ST Description AUTO Not Alarmed False $Default ReadOnly
00OVR_ST1000.CVI1_BQ OVR_ST Description Not Alarmed False $Default ReadOnly
CONTROL VARIABLE INPUT
1 BQ
00OVR_ST1000.CVI2_BQ OVR_ST Description Not Alarmed False $Default ReadOnly
CONTROL VARIABLE INPUT
2 BQ
00OVR_ST1000.CVO OVR_ST Description Not Alarmed False $Default ReadOnly
CONTROL VARIABLE
OUTPUT
00OVR_ST1000.CVO.Status OVR_ST Description Not Alarmed False $Default ReadOnly
CONTROL VARIABLE
OUTPUT STATUS
00OVR_ST1000.FRC_CMD OVR_ST Description FORCE Not Alarmed False $Default ReadOnly
COMMAND
00OVR_ST1000.FRC_CMDB OVR_ST Description FORCE Not Alarmed False $Default ReadOnly
COMMAND BLOCK STS
00OVR_ST1000.H OVR_ST Description Not Alarmed False $Default ReadOnly
OUTPUT UPR LIMIT
00OVR_ST1000.INH_DEC OVR_ST Description INHIBIT Not Alarmed False $Default ReadOnly
DEC
00OVR_ST1000.INH_INC OVR_ST Description INHIBIT Not Alarmed False $Default ReadOnly
INC

34 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Global Pins (continued)
Global Pin Name Description Alarm Alarm Event EGD Page External
Class Access
00OVR_ST1000.L OVR_ST Description Not Alarmed False $Default ReadOnly
OUTPUT LWR LIMIT
00OVR_ST1000.LOCK OVR_ST Description Not Alarmed True $Default ReadOnly
LOCKED
00OVR_ST1000.LOCK_P OVR_ST Description LOCK Not Alarmed False $Default ReadOnly
PROPERTY
00OVR_ST1000.LOCK_PB OVR_ST Description LOCK Not Alarmed False $Default ReadWrite
PUSHBUTTON
00OVR_ST1000. LOCK_SC OVR_ST Description LOCK Not Alarmed False $Default ReadOnly
SAFE CONDITION
00OVR_ST1000.MC OVR_ST Description Not Alarmed False $Default ReadWrite
MANUAL SETPOINT
00OVR_ST1000.MN_REJ_A OVR_ST Description Alarmed LVL_4 False $Default ReadOnly
MANUAL REJECT
00OVR_ST1000.MS OVR_ST Description Not Alarmed False $Default ReadWrite
MANUAL MODE SELECT
00OVR_ST1000.NSEL1 OVR_ST Description CVI1 Not Alarmed False $Default ReadOnly
NOT SELECTED
00OVR_ST1000.NSEL2 OVR_ST Description CVI2 Not Alarmed False $Default ReadOnly
NOT SELECTED
00OVR_ST1000.OBQ OVR_ST Description Not Alarmed False $Default ReadOnly
OUTPUT BQ
00OVR_ST1000.OVR_CMD OVR_ST Description Not Alarmed False $Default ReadOnly
OVERRIDE COMMAND
00OVR_ST1000.OVR_CMDB OVR_ST Description Not Alarmed False $Default ReadOnly
OVERRIDE COMMAND
BLOCK STS
00OVR_ST1000.POS OVR_ST Description Not Alarmed False $Default ReadOnly
POSITION FDBK
00OVR_ST1000.POS.Status OVR_ST Description Not Alarmed False ReadOnly
POSITION FDBK STATUS
00OVR_ST1000.POS_BQ OVR_ST Description Alarmed LVL_4 False $Default ReadOnly
POSITION FDBK BAD
QUALITY
00OVR_ST100.POS_DH OVR_ST Description Alarmed LVL_4 False $Default ReadOnly
POSITION DEV HI ALARM
00OVR_ST1000.POSFB_P OVR_ST Description Not Alarmed False $Default ReadOnly
POSITION FDBK
PROPERTY
00OVR_ST1000.PR_DEC OVR_ST Description Not Alarmed False $Default ReadOnly
PRIORITY DEC
00OVR_ST1000.PR_INC OVR_ST Description Not Alarmed False $Default ReadOnly
PRIORITY INC
00OVR_ST1000.REJ_MN OVR_ST Description Not Alarmed False $Default ReadOnly
MANUAL REJECT
00OVR_ST1000.REJ_MNB OVR_ST Description Not Alarmed False $Default ReadOnly
MANUAL REJECT BYPASS
STS
00OVR_ST1000.TK OVR_ST Description TRACK Not Alarmed False $Default ReadOnly
COMMAND
00OVR_ST1000.TUN1 OVR_ST Description PID 1 Not Alarmed False $Default ReadWrite
TUNING MODE

Instruction Guide GEI-100681K 35

For public disclosure
Global Pins (continued)
Global Pin Name Description Alarm Alarm Event EGD Page External
Class Access
00OVR_ST1000.TUN2 OVR_ST Description PID 2 Not Alarmed False $Default ReadWrite
TUNING MODE
00OVR_ST1000.UNLOCK_PB OVR_ST Description Not Alarmed False $Default ReadWrite
UNLOCK PUSHBUTTON

HMI Configuration (CIMPLICITY)

This block is transparent to the HMI operator.

36 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Permissive Toggle Action Engine (PE_Toggle)
Block Category: PE_Toggle, Sequencing
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The Permissive Toggle Action Engine (PE_Toggle) block sets its ON output to True when either the On Request (ONREQ)
input or the Toggle Request (TOGREQ) input goes True, as long as the start and run permissive inputs are True. The next
time the TOGREQ input goes high, the PE_Toggle is turned off. The PE_Toggle can also be turned on through the ONREQ
input, and turned off through the OFFREQ input.
The PE_Toggle block will start (ON input goes high) when either the TOGREQ or ONREQ inputs go from 0 to 1 while both
SPRM and RPRM inputs are True and the OFFREQ input is False. Once started, the SPRM input can go low. Additionally,
the PE_Toggle block will start (ON input goes high) when the FDBK input goes from 0 to 1 as long as the RPRM inputs is
True and the OFFREQ input is False. When the PE_Toggle block is started in this manner, the ONMSGP output will not
pulse.

PE_Toggle Block

The PE_TOGGLE will also turn on if the FDBK input becomes True, as long as the run permissive input is True and the
OFFREQ input is False. The FDBK input indicates to the PE_Toggle block that the actions that are supposed to happen when
the PE_Toggle turns on actually happened. If the FDBK does not become True within the time defined by the FBTIME input
then the PE_Toggle will turn off. The State variable CTIME contains the time since the PE_Toggle turned on. If the FBTIME
is set to negative, the PE_Toggle block will consider the FBTIME to be infinite, in which case the FDBK input never has to
become True and CTIME remains 0.
Provided the OFFPRM is high, the PE_Toggle block is turned off by setting the OFFREQ to high or by the TOGGLE input
going high after the engine has turned on. When the PE_Toggle block turns off, the ON output goes low. The PE_Toggle is
also turned off through the FDBK input going low or the RPRM signal going low. If the OFFPRM permissive is low, the PE_
Toggle block will not turn off except by loss of the run permissive, RPRPM.

Inputs
Name Data Type Description
ENABLE Boolean Enable block execution input
ONREQ Boolean Edge sensitive input used to turn engine on
TOGREQ Boolean Edge sensitive input used to turn engine on or off
OFFREQ Boolean Edge sensitive input used to turn engine off
SPRM Boolean Start permissive input

Instruction Guide GEI-100681K 37

For public disclosure
Inputs (continued)
Name Data Type Description
RPRM Boolean Run permissive input
OFFPRM Boolean Off permissive input
FDBK Boolean Start feedback (indicates we actually are running)
FBTIME Long Integer Time, milliseconds, until start feedback expected (a negative number disables the
feedback requirement)
ON Boolean On output: True = PE_Toggle block is ON
CTIME Long Integer Current feedback time in milliseconds
STATUS Unsigned Long Integer Bit encoded status output (see below)
STATE Unsigned Long Integer Bit-encoded state output (see below)
LAST_FRAME Unsigned Long Integer Last frame in microseconds (internal)
NOT 1ST PASS Boolean Always True except first pass (internal)

States
Bit Description
7 Permission to turn off is present
2 Request to turn off is received
1 Request to turn on is received
0 Request to toggle on state is received

Status
Bit Description
12 Feedback has been received before FBTIME
11 Feedback has been received
10 Run permissive received
9 Start permissive received
8 PE_Toggle block is ON
7–0 The lower 8 bits specify a code representing the current state of the PE_Toggle block
6 = ON and OK for off state
4 = ON with feedback received
3 = ON without feedback received
2 = Ready to start
1 = Not ready to start
0 = Undefined

38 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
PID (PID_MA)
Block Category: PID_MA, Controls (DCS)
Legacy Status — this block is not recommended for use in any new controller applications (ControlST V05.02 or later).
Refer to the section Replacement Blocks for additional information.
The PID (PID_MA) block is a combination of a PID controller and MA (Manual/Auto) station. The block may be configured
as a series or parallel controller with direct or reverse action. Additionally, all output calculations are superseded by override,
priority and inhibit commands. Override commands have the highest priority, followed by priority commands. Inhibit
commands have the lowest priority of the three types. The value of the output, CVO, can not exceed the user specified limits
of high (H) and low (L).
ToolboxST Configuration
OBQ is True when either AO_BQ is True or status of TV is in the BAD range.

This block propagates quality status. Status option cannot be disabled on this block.

CVO status is based upon the following in order of priority:

• When OBQ is True, the quality status of CVO is NOT_LIMITED-BAD [0]

• If one of CVI_BQ, EV_BQ, PV_BQ, or RSP_BQ is True, the value of CVO status is NOT_LIMITED-LOCAL_
OVERRIDE-GOODC [216]
• The default quality status of CVO is NOT_LIMITED–GOODC [192]
• These values are modified by US (add 1) and LS (add 2)
For further details on relational blocks, refer to GEI-100682, Mark VIe Controller Standard Block Library, the section
Status Monitoring (STATUS_MONITORING).

Instruction Guide GEI-100681K 39

For public disclosure
Modes of Operation (MODE_OPT) determine in which mode the PID_MA block is of the six modes available. Modes that
do not contain PID are not controller enabled.
MODE_OPT Enumerations
Name Description
PID PID only
MA M/A Station only
PID_MA PID with M/A station
PID_MA_EXT PID with M/A station with external setpoint
PID_MA_EXT_CASC PID with M/A station with external setpoint from cascade station
PID_MA_REM PID with M/A station with remote setpoint
PID_MA_REM_CASC PID with M/A station with remote setpoint from cascade station
MA_EXT MA Station without PID with Remote SP (RSP) with HMI SP disabled
MA_REM MA Station without PID with HMI SP enabled (using Remote/Local)
MA_MAN MA Station without PID with HMI Manual SP enabled

Block Options (BLOCK_OPT) enumerations selects the options of the OVR_ST block.

BLOCK_OPT Enumerations
Name Description
NONE None
LOCK Lock mode
POS Position feedback
LOCK-POS Lock mode and position feedback

NONE — the valve operates normally by the HMI operator. The options to not effect the normal operation of the block.

LOCK — provides software lock-out capability for the valve. Selecting the LOCK mode property will setLOCK_P to True,
and enable the LOCK_PB and UNLOCK_PB to control the lockout mode functionality. The valve output CVO must be equal
to LOCK_SC (safe condition) before the block can be set to lockout mode. Feedback to the HMI operator of this mode is
provided by LOCK. The HMI operator is prevented from energizing the solenoid operated valve from the control faceplate
when LOCK is True, and auto mode is disabled.

Note The Lock button can also be set up to use the Workstation Lock function. Refer to GEI-100697,
WorkstationST/CIMPLICITY Advanced Viewer Integration, the section, HMI Tagout.

40 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Override Control
The block provides an override input enumeration, CMD_OVR and a manual reject input enumeration, MJ. The enumerations
are provided in the following table.
When CMD_OVR indicates Override Active, the value of CVO will be the value assigned to the OV input. The PID_MA is
rejected to manual when either CMD_OVR or MJ indicate Override Active and the manual reject alarm, MN_REJ_A, will be
activated, (delayed by 2 seconds). Refer to the section, for further details about MN_REJ_A.
CMD_OVR and MJ (if used) are driven from an OVERRIDE block. Each connected input of the OVERRIDE block has the
ability (when enabled) to be blocked by the HMI operator, which is accessed from associated tab of the permit HMI screen
display. When CMD_OVR or MJ enumeration contains BLOCK, the HMI operator has blocked at least one override. PID_
MA does not use the block information, but passes it to the HMI for display.

Manual Reject and Command Override (MJ and CMD_OVR) Enumerations

Instruction Guide GEI-100681K 41

For public disclosure
Force Control
The block provides a force enumeration force command input, CMD_FRC. When CMD_FRC indicates Force Active, the
value of CVO will be the value assigned to the FV input except when CMD_OVR indicate Override Active. The PID_MA
does not reject to manual if a force occurs. CMD_FRC (Iif used) is driven from a FORCE block. Each connected input of the
FORCE block has the ability (when enabled) to be blocked by the HMI operator, which is accessed from associated tab of the
permit HMI screen display. When CMD_FRC enumeration contains BLOCK, the HMI operator has blocked at least one
force. PID_MA does not use the block information, but passes it to the HMI for display. The enumeration is provided in the
following table.

Command Force (CMD_FRC) Enumerations

Enumeration Force Option Description
NO_FORCE-NO-BLOCK No force and no force is blocked
FORCE-NO_BLOCK Force active and no force is blocked
NO_FORCE-BLOCK No force and a force is blocked
FORCE-BLOCK Force active and a force is blocked

Priority and Inhibit Commands

Note These commands apply to all modes of PID_MA.

When priority increase PR_INC or priority decrease PR_DEC signal is True, CVO goes toward H or L value at a rate set by
PR_INC_RT and PR_DEC_RT as long as the priority signal is True. In addition, the block also provides inhibit function using
INH_INC and INH_DEC inputs. When either of these inputs is True, they restrict any increase or decrease of CVO. Upon the
reset of the priority and inhibit commands, the block is released to control, provided the block is in auto mode. In manual
mode, when these commands reset, CVO remains at last value.
Alarms
When OBQ, CVI_BQ, EV_BQ, PV_BQ, RSP_BQ, TV_BQ, OVR_CMD, LOCK, RSP_OV, or MJ becomes True and AUTO
is True, the manual reject alarm MN_REJ_A is activated for two seconds and the block reverts to manual mode.

Note Refer to the table, BLOCK_OPT Enumerations.

When position feedback is used (POS mode option selected), a POS_DH alarm is generated for deviations between the
position feedback (signal attached to POS input pin) and the controller output CVO. Use the parameter POS_DH_SP to enter
the maximum acceptable deviation and POS_DH_T to set a delay time before generating an alarm.

Note If POS_DH_T is set to 0, no alarm will be generated. If the position feedback has a bad status, the alarm POS_BQ is
generated. POS_BQ and POS_DH will only be generated if POSFB_P is True.

42 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
Controller Action (CTRL_ACT) can be selected using this enumeration as follows. This enumeration is used with all block
modes except MA (M/A Station Only).

CTRL_ACT Enumerations
Name Description
DIRECT Direct action (PV-SP)
REVERSE Reverse action (SP-PV)

Controller Type (CTRL_TYPE) provides a selection of either series or parallel type of PID control implementation. This
enumeration is used with all block modes except MA (M/A station only).

CTRL_TYPE Enumerations
Name Description
SERIES Series control
PARALLEL Parallel control

The following equations are used to calculate controller's output.

Parallel:

Series:

Where: Kp = Proportional Gain (PG)

e(t) = Error (or Error x Error, if SQR_ERR input is enabled
τ = Reset time (IG)
D = Derivative Gain (DG)

Instruction Guide GEI-100681K 43

For public disclosure
Additional Controller Enabled Functions

• HMI operator output command in manual mode (MC) is only allowed to change at a maximum rate specified by MR.
The manual output is limited by H and L parameters as well as override, priority and inhibit commands.
• All controller enabled functions require the setting of the scale factor (SF). SF is used to scale the PV and SP into output
units. For example, a PV and SP in RPM of 0 – 3600 would require an SF of 0.0277 to convert the output to 0 – 100%.
External tracking is enabled by setting TK to True.
• The block output follows the track value TV while TK is True. Normal control functions resume with TV as the starting
point upon the reset of TK.
• The block provides a feed forward input (FF), which is added directly to the output in a controller enabled mode.
• The PID_MA block uses an anti-reset windup feature that is transparent to the user. When the block output reaches its
high or low limit (user defined H or L) or when a inhibit signal (INH_DEC, INH_INC) is present, the integral action is
prevented to move further in the same direction. When the direction of error signal changes or inhibit signal goes away,
the integral action is resumed for normal operation. With anti-reset windup, PID_MA block provides improved control
by decreasing delays due to reset winding.
• Setpoint control is accomplished using a few different parameters. There are two sources for the setpoint, SC (HMI
Operator Setpoint) and RSP (Logic Driven Setpoint when RS is True). SH and SL establish the high and low limits of the
setpoint regardless of source. SR sets the maximum allowed rate of change of the setpoint inputs. This rate limiter is
bypassed when RS is True and when RSP_SR_DSBL is True. The rate and value limited setpoint that is used in the PID
calculation is SP. This setpoint monitoring is disabled when the block is accepting the remote setpoint, RS is True. In
addition, SP_TRACK is used force the operator setpoint, SC, to track PV in manual mode and RSP in remote setpoint
mode.
• When set to True, the parameter INH_PDG will inhibit proportional and derivative action on setpoint change.

Note When using any modes that accept a Remote Setpoint, care should be taken in the setting of the INH_PDG
parameter (default initial value of True) to obtain the desired controller response. When INH_PDG is set to True,
continuously changing setpoints will make the controller an integral only controller. Conversely, when INH_PDG is set
to False, continuously changing setpoints will have the proportional, integral and derivative action applied to the output
based on the gains and the error generated between the moving setpoint and the process variable. This feature only
applies to parallel controllers! INH_PDG has no effect on series type controllers. The user must account for proportional
and derivative action of both the series type controller and the parallel type controller with the INH_PDG set to False by
limiting the ramp rate of the setpoint.

• PG (%/%), IG (repeats/min), (minutes) are the proportional, integral and derivative gains that are used in the PID
calculations.
• SQR_ERR allows the user to square the error which creates a faster controller response when the actual error is greater
than one and a slower controller response when the actual error is less than one.
• ERR_C enables the use of error deadband equality processing. When the absolute value of the error is less than The
controller error deadband (ERR_CDB) assumes the error is zero.
• PG_C and PG_CDB inputs to the PID_MA block are provided for a bumpless transition whenever a change to the
proportional gain is made. When PG_C is True, rate of change of PG is compared to the value set by PG_CDB
(maximum change allowed in one scan). If this value is exceeded, the controller aligns the values for that scan to remain
constant and begin controller action on the next scan without a bump in the output. PG_CDB must be set so that normal
changes in PG are ignored (variable gain) and this parameter only initiates during abrupt changes in PG. Similarly,
changes made to IG are governed by IG_CDB when IG_C is True.
• Output Bad Quality (OBQ) is designed to reject the block to manual mode when output bad quality is detected and keep
it in manual mode as long as OBQ is True.
• External Reset (ER) is used in an override control scheme. When ER is True, the PID calculation uses EV as a reset value
to begin the next calculation. This is typically used when you have two PIDs with different PVs controlling the same
output based on which one has the minimum or maximum output.
• When the block is in PID_MA_EXT_CASC or PID_MA_REM_CASC mode, RSP status is monitored to detect an
override condition in the upstream PID_MA block. If an override condition is detected, RSP_OV is set to True and the
block is rejected to manual mode.
• If PV_SP_LIM_TRK is True when the controller output reaches either the high or low limit, H or L, the controller will
track the limit value until PV crosses SP. Once PV crosses SP, the controller will resume the controlling action. The
following graph displays PV, SP, and CVO for a PID_MA block with PV_SP_LIM_TRK both True and False. Notice
that with PV_SP_LIM_TRK set to True (left of the black vertical line) CVO remains at the limit until PV crosses SP.

44 GEI-100681K Mark VIe Controller Legacy Block Library

For public disclosure
With PV_SP_LIM_TRK set to False (right of the black vertical line) CVO only tracks the limit until PV changes slope.
The graph displays PV (blue sine wave), SP (green horizontal line), and CVO (brown sine wave, capped). With PV_SP_
LIM_TRK set to True the controller behaves as shown by the data to the left of the vertical black line. With PV_SP_
LIM_TRK set to False the controller behaves as shown by the data to the right of the vertical black line.

PV_SP_LIM_TRK Slope Graph

Note Refer to the table, PID_MA Block Pins Usage by Mode.

MA mode is a MA (Manual/Auto) station (no PID action). There is no PID action. In this mode, the HMI operator is allowed
to adjust both the automatic mode setpoint and output. A remote setpoint is not allowed in this configuration. Refer to the
section, Additional Controller Enabled Functions.